Merge pull request #24225 from opf/implementation/fnd-130-runtime-resolution-of-linked-form-configurations

Runtime resolution of linked form configurations

Author: dfriquet

app/components/work_packages/exports/generate/modal_dialog_component.rb

@@ -59,7 +59,7 @@ def templates_default
         end
 
         def templates_options
-          work_package.type.pdf_export_templates.list_enabled
+          work_package.type.effective_pdf_export_templates.list_enabled
         end
 
         def hyphenation_default

app/models/type.rb

@@ -209,7 +209,7 @@ def replacement_pattern_defined_for?(attribute)
   end
 
   def enabled_patterns
-    patterns.all_enabled
+    effective_patterns.all_enabled
   end
 
   def pdf_export_templates

app/models/type/configuration_link.rb

@@ -30,23 +30,25 @@
 
 # A single reuse link: a type borrows one configuration aspect from a source type.
 # Absence of a row for (type, aspect) means the type owns that aspect (Independent).
-class Type::ConfigurationLink < ApplicationRecord
-  ASPECTS = [
-    PDF_EXPORT = "pdf_export",
-    PATTERNS = "patterns"
-  ].freeze
+class Type
+  class ConfigurationLink < ApplicationRecord
+    ASPECTS = [
+      PDF_EXPORT = "pdf_export",
+      PATTERNS = "patterns"
+    ].freeze
 
-  belongs_to :type, optional: false
-  belongs_to :source, class_name: "Type", optional: false
+    belongs_to :type, optional: false
+    belongs_to :source, class_name: "Type", optional: false
 
-  enum :aspect, ASPECTS.index_with(&:itself), validate: true
+    enum :aspect, ASPECTS.index_with(&:itself), validate: true
 
-  validates :type_id, uniqueness: { scope: :aspect }
-  validate :source_differs_from_type
+    validates :type_id, uniqueness: { scope: :aspect }
+    validate :source_differs_from_type
 
-  private
+    private
 
-  def source_differs_from_type
-    errors.add(:source, :must_differ_from_type) if source_id.present? && source_id == type_id
+    def source_differs_from_type
+      errors.add(:source, :must_differ_from_type) if source_id.present? && source_id == type_id
+    end
   end
 end

app/models/type/configuration_linkable.rb

@@ -32,76 +32,83 @@
 # source type. Mode is derived from link presence: a link means Linked, its
 # absence means Independent. This is the shared seam FND-101/102 extend with
 # further aspects, and the deferred resolution/copy/cycle work builds on top of.
-module Type::ConfigurationLinkable
-  extend ActiveSupport::Concern
+class Type
+  module ConfigurationLinkable
+    extend ActiveSupport::Concern
 
-  included do
-    has_many :configuration_links,
-             class_name: "Type::ConfigurationLink",
-             dependent: :destroy
-    has_many :dependent_configuration_links,
-             class_name: "Type::ConfigurationLink",
-             foreign_key: :source_id,
-             inverse_of: :source,
-             dependent: :restrict_with_error
+    included do
+      has_many :configuration_links,
+               class_name: "Type::ConfigurationLink",
+               dependent: :destroy
+      has_many :dependent_configuration_links,
+               class_name: "Type::ConfigurationLink",
+               foreign_key: :source_id,
+               inverse_of: :source,
+               dependent: :restrict_with_error
 
-    # A sub-type defaults to Linked-to-parent for every reusable aspect.
-    after_create :seed_default_configuration_links, if: :subtype?
-  end
+      # A sub-type defaults to Linked-to-parent for every reusable aspect.
+      after_create :seed_default_configuration_links, if: :subtype?
+    end
 
-  def linked?(aspect)
-    configuration_links.exists?(aspect:)
-  end
+    def linked?(aspect)
+      configuration_links.exists?(aspect:)
+    end
 
-  def source_for(aspect)
-    configuration_links.find_by(aspect:)&.source
-  end
+    def source_for(aspect)
+      configuration_links.find_by(aspect:)&.source
+    end
 
-  def link!(aspect, source:)
-    configuration_links.find_or_initialize_by(aspect:).update!(source:)
-  end
+    def link!(aspect, source:)
+      configuration_links.find_or_initialize_by(aspect:).update!(source:)
+    end
 
-  # Switch an aspect to Independent. When a source is given, its resolved
-  # configuration is copied onto this type once (adopt) before the link is severed.
-  def make_independent!(aspect, source: nil)
-    copy_configuration_from(source, aspect) if source && source != self
-    configuration_links.where(aspect:).destroy_all
-  end
+    # Switch an aspect to Independent. When a source is given, its resolved
+    # configuration is copied onto this type once (adopt) before the link is severed.
+    def make_independent!(aspect, source: nil)
+      copy_configuration_from(source, aspect) if source && source != self
+      configuration_links.where(aspect:).destroy_all
+    end
 
-  # Walks the link chain to the type that actually owns the aspect (Independent).
-  # The visited-set guard keeps it terminating even before transitive cycle
-  # prevention lands.
-  def effective_source_for(aspect)
-    node = self
-    seen = Set.new
-    node = node.source_for(aspect) while node.linked?(aspect) && seen.add?(node.id)
-    node
-  end
+    # Walks the link chain to the type that actually owns the aspect (Independent).
+    # The visited-set guard keeps it terminating even before transitive cycle
+    # prevention lands.
+    #
+    # Guarded by the subtypes feature flag: with the flag off, links are ignored
+    # and every type resolves to its own stored configuration.
+    def effective_source_for(aspect)
+      return self unless OpenProject::FeatureDecisions.subtypes_active?
 
-  def effective_patterns
-    effective_source_for(Type::ConfigurationLink::PATTERNS).patterns
-  end
+      node = self
+      seen = Set.new
+      node = node.source_for(aspect) while node.linked?(aspect) && seen.add?(node.id)
+      node
+    end
 
-  def effective_pdf_export_templates
-    effective_source_for(Type::ConfigurationLink::PDF_EXPORT).pdf_export_templates
-  end
+    def effective_patterns
+      effective_source_for(Type::ConfigurationLink::PATTERNS).patterns
+    end
 
-  # One-time adoption: copy the source's resolved configuration for one aspect
-  # onto this type. Used when switching to Independent from a chosen source.
-  # deep_dup keeps the copy from aliasing the source's stored value.
-  def copy_configuration_from(source, aspect)
-    owner = source.effective_source_for(aspect)
-    case aspect
-    when Type::ConfigurationLink::PATTERNS
-      update!(patterns: owner.patterns.deep_dup)
-    when Type::ConfigurationLink::PDF_EXPORT
-      update!(pdf_export_templates_config: owner.pdf_export_templates_config.deep_dup)
+    def effective_pdf_export_templates
+      effective_source_for(Type::ConfigurationLink::PDF_EXPORT).pdf_export_templates
+    end
+
+    # One-time adoption: copy the source's resolved configuration for one aspect
+    # onto this type. Used when switching to Independent from a chosen source.
+    # deep_dup keeps the copy from aliasing the source's stored value.
+    def copy_configuration_from(source, aspect)
+      owner = source.effective_source_for(aspect)
+      case aspect
+      when Type::ConfigurationLink::PATTERNS
+        update!(patterns: owner.patterns.deep_dup)
+      when Type::ConfigurationLink::PDF_EXPORT
+        update!(pdf_export_templates_config: owner.pdf_export_templates_config.deep_dup)
+      end
     end
-  end
 
-  private
+    private
 
-  def seed_default_configuration_links
-    Type::ConfigurationLink::ASPECTS.each { |aspect| link!(aspect, source: parent) }
+    def seed_default_configuration_links
+      Type::ConfigurationLink::ASPECTS.each { |aspect| link!(aspect, source: parent) }
+    end
   end
 end

spec/components/work_packages/exports/generate/modal_dialog_component_spec.rb

@@ -0,0 +1,49 @@
+# 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 WorkPackages::Exports::Generate::ModalDialogComponent, type: :component do
+  subject(:component) { described_class.new(work_package:, params: {}) }
+
+  let(:type) { create(:type) }
+  let(:work_package) { build_stubbed(:work_package, type:) }
+
+  describe "#templates_options", with_flag: { subtypes: true } do
+    it "lists the enabled templates of the type the PDF config is linked to" do
+      source = create(:type)
+      source.pdf_export_templates.disable_all
+      source.save!
+      type.link!(Type::ConfigurationLink::PDF_EXPORT, source:)
+
+      expect(component.templates_options).to be_empty
+    end
+  end
+end

spec/models/type/configuration_linkable_spec.rb

@@ -123,7 +123,7 @@
     end
   end
 
-  describe "#effective_source_for" do
+  describe "#effective_source_for", with_flag: { subtypes: true } do
     it "returns itself when Independent" do
       expect(type.effective_source_for(aspect)).to eq(type)
     end
@@ -146,7 +146,7 @@
     end
   end
 
-  describe "effective configuration" do
+  describe "effective configuration", with_flag: { subtypes: true } do
     let(:owner) { create(:type, patterns: { subject: { blueprint: "X {{id}}", enabled: true } }) }
 
     it "resolves patterns from the linked owner" do
@@ -160,6 +160,33 @@
     end
   end
 
+  describe "#enabled_patterns and #replacement_pattern_defined_for?", with_flag: { subtypes: true } do
+    let(:owner) { create(:type, patterns: { subject: { blueprint: "X {{id}}", enabled: true } }) }
+
+    it "resolves the subject pattern from the linked owner" do
+      type.link!(Type::ConfigurationLink::PATTERNS, source: owner)
+
+      expect(type.enabled_patterns.keys).to include(:subject)
+      expect(type).to be_replacement_pattern_defined_for(:subject)
+    end
+
+    it "reports no subject pattern when Independent and none is set" do
+      expect(type).not_to be_replacement_pattern_defined_for(:subject)
+    end
+  end
+
+  describe "feature flag gating", with_flag: { subtypes: false } do
+    let(:owner) { create(:type, patterns: { subject: { blueprint: "X {{id}}", enabled: true } }) }
+
+    before { type.link!(Type::ConfigurationLink::PATTERNS, source: owner) }
+
+    it "ignores links and resolves to the type's own configuration" do
+      expect(type.effective_source_for(Type::ConfigurationLink::PATTERNS)).to eq(type)
+      expect(type.effective_patterns).to eq(type.patterns)
+      expect(type).not_to be_replacement_pattern_defined_for(:subject)
+    end
+  end
+
   describe "#copy_configuration_from" do
     it "copies the source's subject patterns onto the type" do
       source = create(:type, patterns: { subject: { blueprint: "Copied {{id}}", enabled: true } })

spec/services/work_packages/update_service_integration_spec.rb

@@ -1801,6 +1801,29 @@
     end
   end
 
+  context "with a type whose subject configuration is linked to a source type",
+          with_flag: { subtypes: true } do
+    shared_let(:linked_type) do
+      create(:type, name: "Linked").tap do |t|
+        t.link!(Type::ConfigurationLink::PATTERNS, source: autosubject_type)
+        project.types << t
+      end
+    end
+
+    shared_let(:work_package, reload: true) { create(:work_package, type: linked_type, project:) }
+
+    let(:attributes) { { description: "new description" } }
+
+    it "generates the subject from the linked source type's pattern" do
+      expect(subject).to be_success
+
+      expect(work_package.reload).to have_attributes(
+        description: "new description",
+        subject: "##{work_package.id} by #{user.name} - #{default_status.name}"
+      )
+    end
+  end
+
   describe "replacing the attachments" do
     let!(:old_attachment) do
       create(:attachment, container: work_package)