[#73373] Background job for migrating pre-existing data to semantic identifiers

app/controllers/admin/settings/work_packages_identifier_controller.rb

@@ -43,17 +43,10 @@ def show
     end
 
     def update
-      return render_400 unless params[:settings]
-
-      if autofix_requested?
-        call = update_service.new(user: current_user).call(settings_params)
-        call.on_success do
-          WorkPackages::IdentifierAutofix::ApplyHandlesJob.perform_later
-          redirect_to action: "show"
-        end
-        call.on_failure { failure_callback(call) }
-      else
-        super
+      case params.dig(:settings, :work_packages_identifier)
+      when Setting::WorkPackageIdentifier::SEMANTIC  then switch_to_semantic
+      when Setting::WorkPackageIdentifier::CLASSIC   then switch_to_classic
+      else                                                render_400
       end
     end
 
@@ -74,12 +67,21 @@ def status
 
     private
 
+    def switch_to_semantic
+      ProjectIdentifiers::ConvertInstanceToSemanticIdsJob.perform_later unless WorkPackages::IdentifierAutofix.job_in_progress?
+      redirect_to action: "show"
+    end
+
+    def switch_to_classic
+      call = Settings::UpdateService.new(user: current_user)
+                                    .call(work_packages_identifier: Setting::WorkPackageIdentifier::CLASSIC)
+      call.on_success { redirect_to action: "show" }
+      call.on_failure { render_400 }
+    end
+
     def check_feature_flag
       render_404 unless OpenProject::FeatureDecisions.semantic_work_package_ids_active?
     end
 
-    def autofix_requested?
-      ActiveRecord::Type::Boolean.new.cast(params[:confirm_dangerous_action])
-    end
   end
 end

app/models/setting/work_package_identifier.rb

@@ -36,5 +36,6 @@ module WorkPackageIdentifier
 
     def self.semantic? = Setting[:work_packages_identifier] == SEMANTIC
     def self.classic?  = Setting[:work_packages_identifier] == CLASSIC
+    def self.enable_semantic! = Setting.work_packages_identifier = SEMANTIC
   end
 end

app/models/work_package/semantic_identifier.rb

@@ -93,8 +93,6 @@ def allocate_and_register_semantic_id
     end
   end
 
-  private
-
   # Builds alias rows for every identifier this project has ever used at the given sequence (including the current one).
   # This also includes "ghost identifiers" -- i.e. those that weren't ever actually generated, but should work
   # as a historical alias (e.g. OLDPROJ-42 should work even if WP #42 was created after rename to NEWPROJ)

app/models/work_package_semantic_alias.rb

@@ -42,4 +42,8 @@ class WorkPackageSemanticAlias < ApplicationRecord
 
   validates :identifier, presence: true, uniqueness: true
   validates :work_package, presence: true
+
+  def self.upsert_rows(rows)
+    insert_all(rows, unique_by: :identifier) if rows.any?
+  end
 end

app/services/work_packages/identifier_autofix.rb

@@ -32,7 +32,10 @@ module WorkPackages
   module IdentifierAutofix
     def self.job_in_progress?
       GoodJob::Job
-        .where(job_class: WorkPackages::IdentifierAutofix::ApplyHandlesJob.name)
+        .where(job_class: [
+                 ProjectIdentifiers::ConvertInstanceToSemanticIdsJob.name,
+                 ProjectIdentifiers::BackfillProjectJob.name
+               ])
         .exists?(finished_at: nil)
     end
   end

app/services/work_packages/identifier_autofix/problematic_identifiers.rb

@@ -65,6 +65,15 @@ def scope
 
       delegate :count, to: :scope
 
+      # Returns a symbol classifying why the identifier violates the expected format,
+      # or nil if the identifier is format-valid. Pure in-memory check — no DB queries.
+      def format_error_reason(identifier)
+        FORMAT_RULES.each do |reason, check|
+          return reason if check.call(identifier, max_identifier_length)
+        end
+        nil
+      end
+
       # Returns a symbol classifying why the identifier is problematic.
       # Must handle all identifiers matched by #scope.
       def error_reason(identifier)
@@ -87,13 +96,6 @@ def not_fully_uppercased      = Project.where("identifier != UPPER(identifier)")
 
       def max_identifier_length = ProjectIdentifierSuggestionGenerator::IDENTIFIER_LENGTH[:max]
 
-      def format_error_reason(identifier)
-        FORMAT_RULES.each do |reason, check|
-          return reason if check.call(identifier, max_identifier_length)
-        end
-        nil
-      end
-
       def collision_error_reason(identifier)
         if in_use_identifiers.include?(identifier)
           :in_use

app/workers/project_identifiers/backfill_project_job.rb

@@ -0,0 +1,74 @@
+# 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 ProjectIdentifiers::BackfillProjectJob < ApplicationJob
+  def perform(project_id)
+    project = Project.find(project_id)
+    fix_identifier_if_needed(project)
+    backfill_work_packages(project)
+  end
+
+  private
+
+  def fix_identifier_if_needed(project)
+    detector = WorkPackages::IdentifierAutofix::ProblematicIdentifiers.new
+    # Pure format check — no DB queries. nil means the identifier is fine.
+    return unless detector.format_error_reason(project.identifier)
+
+    # Build the exclusion set fresh from the DB at job-execution time.
+    # Two concurrent jobs may occasionally suggest the same identifier, but the
+    # unique constraint on projects.identifier will reject the second writer, and
+    # the job can be retried.
+    new_identifier = WorkPackages::IdentifierAutofix::ProjectIdentifierSuggestionGenerator
+                       .suggest_identifier(project.name, exclude: detector.exclusion_set)
+    project.identifier = new_identifier
+    project.save!(validate: false)
+  end
+
+  def backfill_work_packages(project)
+    # Assign sequence numbers to any WPs that don't have one yet (oldest first).
+    WorkPackage.where(project:, sequence_number: nil).order(:id).find_each do |wp|
+      seq, identifier = project.allocate_wp_semantic_identifier!
+      wp.update_columns(sequence_number: seq, identifier:)
+    end
+
+    seed_alias_table(project)
+  end
+
+  def seed_alias_table(project)
+    slug_prefixes = project.slugs.pluck(:slug)
+    return if slug_prefixes.empty?
+
+    alias_rows = WorkPackage.where(project:).pluck(:id, :sequence_number)
+                            .product(slug_prefixes)
+                            .map { |(wp_id, seq), prefix| { identifier: "#{prefix}-#{seq}", work_package_id: wp_id } }
+    WorkPackageSemanticAlias.upsert_rows(alias_rows)
+  end
+end

app/workers/project_identifiers/convert_instance_to_semantic_ids_job.rb

@@ -0,0 +1,85 @@
+# 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 ProjectIdentifiers::ConvertInstanceToSemanticIdsJob < ApplicationJob
+  include GoodJob::ActiveJobExtensions::Concurrency
+
+  good_job_control_concurrency_with(perform_limit: 1)
+
+  # Maximum number of re-processing passes before giving up and aborting the flip.
+  # Prevents an infinite loop if work packages are created faster than they can be processed.
+  MAX_ITERATIONS = 10
+
+  # Called directly by the controller (no args) for the initial dispatch,
+  # or by GoodJob as an on_success batch callback with (batch, params).
+  def perform(_batch = nil, params = nil)
+    iteration = params.to_h.with_indifferent_access.fetch(:iteration, 0).to_i
+    remaining = project_ids_needing_backfill
+
+    return switch_instance_to_semantic! if remaining.empty?
+
+    convert_identifier_data(remaining, iteration)
+  end
+
+  private
+
+  def switch_instance_to_semantic!
+    Setting::WorkPackageIdentifier.enable_semantic!
+  end
+
+  def convert_identifier_data(remaining, iteration)
+    if iteration < MAX_ITERATIONS
+      enqueue_backfill_batch(remaining, next_iteration: iteration + 1)
+    else
+      abort_with_error(remaining.size)
+    end
+  end
+
+  def enqueue_backfill_batch(project_ids, next_iteration:)
+    GoodJob::Batch.enqueue(on_success: self.class, on_success_params: { iteration: next_iteration }) do
+      project_ids.each { |project_id| ProjectIdentifiers::BackfillProjectJob.perform_later(project_id) }
+    end
+  end
+
+  def abort_with_error(remaining_count)
+    message =
+      "#{self.class.name}: reached max iterations (#{MAX_ITERATIONS}) with " \
+      "#{remaining_count} project(s) still unprocessed — aborting flip, manual intervention required"
+
+    Rails.logger.error(message)
+    raise message
+  end
+
+  def project_ids_needing_backfill
+    problematic_ids = WorkPackages::IdentifierAutofix::ProblematicIdentifiers.new.scope.ids.to_set
+    needs_backfill  = WorkPackage.where(sequence_number: nil).distinct.pluck(:project_id).to_set
+    needs_backfill | problematic_ids
+  end
+end

spec/controllers/admin/settings/work_packages_identifier_controller_spec.rb

@@ -0,0 +1,82 @@
+# 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 Admin::Settings::WorkPackagesIdentifierController,
+               with_flag: { semantic_work_package_ids: true } do
+  shared_let(:user) { create(:admin) }
+
+  current_user { user }
+
+  describe "PATCH #update" do
+    context "when work_packages_identifier is 'semantic'" do
+      it "enqueues ProjectIdentifiers::ConvertInstanceToSemanticIdsJob and redirects" do
+        expect do
+          patch :update, params: { settings: { work_packages_identifier: "semantic" } }
+        end.to have_enqueued_job(ProjectIdentifiers::ConvertInstanceToSemanticIdsJob)
+
+        expect(response).to redirect_to(action: "show")
+      end
+
+      context "when a migration job is already in progress" do
+        before do
+          allow(WorkPackages::IdentifierAutofix).to receive(:job_in_progress?).and_return(true)
+        end
+
+        it "does not enqueue another job but still redirects" do
+          expect do
+            patch :update, params: { settings: { work_packages_identifier: "semantic" } }
+          end.not_to have_enqueued_job(ProjectIdentifiers::ConvertInstanceToSemanticIdsJob)
+
+          expect(response).to redirect_to(action: "show")
+        end
+      end
+    end
+
+    context "when work_packages_identifier is 'classic'" do
+      it "does not enqueue ProjectIdentifiers::ConvertInstanceToSemanticIdsJob" do
+        expect do
+          patch :update, params: { settings: { work_packages_identifier: "classic" } }
+        end.not_to have_enqueued_job(ProjectIdentifiers::ConvertInstanceToSemanticIdsJob)
+      end
+    end
+
+    context "when work_packages_identifier is missing or unknown" do
+      it "renders 400 without enqueuing a job" do
+        expect do
+          patch :update, params: {}
+        end.not_to have_enqueued_job(ProjectIdentifiers::ConvertInstanceToSemanticIdsJob)
+
+        expect(response).to have_http_status(:bad_request)
+      end
+    end
+  end
+end