OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub
Ruby agile-developmentangularbcfboardsbug-trackerganttgantt-chartifcissue-trackerjira-alternativekanbanopenprojectproduct-managementproject-managementproject-planningroadmaprubyscrumtimelineworkflows
Add user preferences data migration
Kabiru Mwenja2fe69725a04c
diff --git a/db/migrate/20250905204438_migrate_theme_preferences.rb b/db/migrate/20250905204438_migrate_theme_preferences.rbnew file mode 100644index 00000000000..ce00a00cc3f--- /dev/null+++ b/db/migrate/20250905204438_migrate_theme_preferences.rb@@ -0,0 +1,47 @@+# frozen_string_literal: true++class MigrateThemePreferences < ActiveRecord::Migration[8.0]+ def up+ migrate_theme_preferences_to_new_structure+ end++ def down+ migrate_theme_preferences_to_old_structure+ end++ private++ def migrate_theme_preferences_to_new_structure+ say "Migrate light_high_contrast -> light theme with increase_theme_contrast: true"+ execute <<~SQL.squish+ UPDATE user_preferences+ SET settings = settings || '{"theme": "light", "increase_theme_contrast": true}'::jsonb+ WHERE settings ->> 'theme' = 'light_high_contrast';+ SQL++ say "Migrate dark_high_contrast -> dark theme with increase_theme_contrast: true"+ execute <<~SQL.squish+ UPDATE user_preferences+ SET settings = settings || '{"theme": "dark", "increase_theme_contrast": true}'::jsonb+ WHERE settings ->> 'theme' = 'dark_high_contrast';+ SQL+ end++ def migrate_theme_preferences_to_old_structure+ say "Rollback: Convert light theme with high contrast back to light_high_contrast"+ execute <<~SQL.squish+ UPDATE user_preferences+ SET settings = (settings - 'increase_theme_contrast') || '{"theme": "light_high_contrast"}'::jsonb+ WHERE settings ->> 'theme' = 'light'+ AND (settings ->> 'increase_theme_contrast')::boolean = true;+ SQL++ say "Rollback: Convert dark theme with high contrast back to dark_high_contrast"+ execute <<~SQL.squish+ UPDATE user_preferences+ SET settings = (settings - 'increase_theme_contrast') || '{"theme": "dark_high_contrast"}'::jsonb+ WHERE settings ->> 'theme' = 'dark'+ AND (settings ->> 'increase_theme_contrast')::boolean = true;+ SQL+ end+enddiff --git a/spec/migrations/migrate_theme_preferences_spec.rb b/spec/migrations/migrate_theme_preferences_spec.rbnew file mode 100644index 00000000000..04458feef49--- /dev/null+++ b/spec/migrations/migrate_theme_preferences_spec.rb@@ -0,0 +1,116 @@+# 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"+require Rails.root.join("db/migrate/20250905204438_migrate_theme_preferences.rb")++RSpec.describe MigrateThemePreferences, type: :model do+ let(:user) { create(:user) }++ describe "up migration" do+ it "converts light_high_contrast to new structure without corrupting other settings" do+ user.pref.update(settings: {+ "theme" => "light_high_contrast",+ "comments_sorting" => "desc",+ "time_zone" => "UTC"+ })++ ActiveRecord::Migration.suppress_messages { described_class.migrate(:up) }++ user.pref.reload+ expect(user.pref.settings["theme"]).to eq("light")+ expect(user.pref.settings["increase_theme_contrast"]).to be(true)++ # Verify other settings remain intact+ expect(user.pref.settings["comments_sorting"]).to eq("desc")+ expect(user.pref.settings["time_zone"]).to eq("UTC")++ # Verify model methods work correctly for unset auto-contrast settings+ expect(user.pref).not_to be_enable_auto_light_theme_contrast+ expect(user.pref).not_to be_enable_auto_dark_theme_contrast+ end++ it "converts dark_high_contrast to new structure" do+ user.pref.update(settings: { "theme" => "dark_high_contrast" })++ ActiveRecord::Migration.suppress_messages { described_class.migrate(:up) }++ user.pref.reload+ expect(user.pref.settings["theme"]).to eq("dark")+ expect(user.pref.settings["increase_theme_contrast"]).to be(true)+ end++ it "leaves existing themes unchanged" do+ user.pref.update(settings: { "theme" => "light", "comments_sorting" => "asc" })++ ActiveRecord::Migration.suppress_messages { described_class.migrate(:up) }++ user.pref.reload+ expect(user.pref.settings["theme"]).to eq("light")+ expect(user.pref.settings["comments_sorting"]).to eq("asc")+ expect(user.pref.settings).not_to have_key("increase_theme_contrast")++ # Verify model methods work correctly for unset settings+ expect(user.pref).not_to be_increase_theme_contrast+ end+ end++ describe "down migration" do+ it "reverts light theme with contrast back to light_high_contrast" do+ user.pref.update(settings: {+ "theme" => "light",+ "increase_theme_contrast" => true,+ "comments_sorting" => "asc"+ })++ ActiveRecord::Migration.suppress_messages { described_class.migrate(:down) }++ user.pref.reload+ expect(user.pref.settings["theme"]).to eq("light_high_contrast")+ expect(user.pref.settings).not_to have_key("increase_theme_contrast")++ # Verify other settings remain intact+ expect(user.pref.settings["comments_sorting"]).to eq("asc")+ end++ it "leaves themes without contrast unchanged" do+ user.pref.update(settings: {+ "theme" => "sync_with_os",+ "disable_keyboard_shortcuts" => true+ })++ ActiveRecord::Migration.suppress_messages { described_class.migrate(:down) }++ user.pref.reload+ expect(user.pref.settings["theme"]).to eq("sync_with_os")+ expect(user.pref.settings["disable_keyboard_shortcuts"]).to be(true)+ end+ end+end