Fix default section missing overview visibility area

https://community.openproject.org/wp/72671

The default custom field section was created with an empty
`display_representation` (`{}`), causing project attributes to not appear
on the project overview page even when enabled by users.

New sections correctly receive the default overview visibility area
(`"sidebar"`), but the default section was not initialized with it.

Add a migration to backfill existing default sections that have an
empty `display_representation` with the default value
`{ overview: "sidebar" }`.
This commit is contained in:
Christophe Bliard
2026-03-04 17:52:10 +01:00
parent c5dbdb9320
commit baeb6e733c
4 changed files with 85 additions and 4 deletions
+2 -2
View File
@@ -31,7 +31,7 @@
class CustomFieldSection < ApplicationRecord
OVERVIEW__SIDEBAR_KEY = "sidebar"
OVERVIEW__MAIN_AREA_KEY = "main_area"
DEFAULT_OVERVIEW_KEY = OVERVIEW__SIDEBAR_KEY.freeze
DEFAULT_OVERVIEW_KEY = OVERVIEW__SIDEBAR_KEY
acts_as_list scope: [:type]
@@ -39,7 +39,7 @@ class CustomFieldSection < ApplicationRecord
default_scope { order(:position) }
store_attribute :display_representation, :overview, :string
store_attribute :display_representation, :overview, :string, default: DEFAULT_OVERVIEW_KEY
def shown_in_overview_sidebar?
overview == OVERVIEW__SIDEBAR_KEY
@@ -0,0 +1,44 @@
# frozen_string_literal: true
#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) the OpenProject GmbH
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2013 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# See COPYRIGHT and LICENSE files for more details.
#++
class FixEmptyDisplayRepresentationOnCfSections < ActiveRecord::Migration[8.1]
def up
execute <<~SQL.squish
UPDATE custom_field_sections
SET display_representation = '{"overview": "#{CustomFieldSection::DEFAULT_OVERVIEW_KEY}"}'
WHERE display_representation = '{}'
SQL
end
def down
# No rollback: we cannot distinguish sections that originally had {}
# from ones that legitimately had the default value set.
end
end
+37
View File
@@ -0,0 +1,37 @@
# frozen_string_literal: true
#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) the OpenProject GmbH
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2013 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# See COPYRIGHT and LICENSE files for more details.
#++
require "spec_helper"
RSpec.describe CustomFieldSection do
it "uses the sidebar as default overview" do
expect(described_class.new).to be_shown_in_overview_sidebar
end
end
@@ -57,9 +57,9 @@ RSpec.describe BasicData::ProjectCustomFieldSectionSeeder do
it "creates the corresponding sections with the given attributes", :aggregate_failures do
expect(ProjectCustomFieldSection.count).to eq(2)
expect(ProjectCustomFieldSection.find_by(name: "Project Attributes"))
.to have_attributes(position: 1)
.to have_attributes(position: 1, overview: CustomFieldSection::OVERVIEW__SIDEBAR_KEY)
expect(ProjectCustomFieldSection.find_by(name: "Project Attributes Two"))
.to have_attributes(position: 2)
.to have_attributes(position: 2, overview: CustomFieldSection::OVERVIEW__SIDEBAR_KEY)
# references the section in the seed data
created_status = ProjectCustomFieldSection.last