Merge branch 'mk/dry-up-verification-state-include' into 'master'

Refactor Geo::VerifiableRegistry module

See merge request gitlab-org/gitlab!56175

doc/development/geo/framework.md

@@ -319,10 +319,7 @@ For example, to add support for files referenced by a `Widget` model with a
    # frozen_string_literal: true
    class Geo::WidgetRegistry < Geo::BaseRegistry
-     include Geo::ReplicableRegistry
-     # TODO: Include VerificationState in VerifiableRegistry
-     # https://gitlab.com/gitlab-org/gitlab/-/issues/298811
-     include ::Gitlab::Geo::VerificationState
+     include ::Geo::ReplicableRegistry
      include ::Geo::VerifiableRegistry
      MODEL_CLASS = ::Widget

ee/app/models/concerns/geo/verifiable_registry.rb

 # frozen_string_literal: true
-module Geo::VerifiableRegistry
-  extend ActiveSupport::Concern
-
-  class_methods do
-    extend ::Gitlab::Utils::Override
-
-    # Overrides a method in `Gitlab::Geo::VerificationState`. This method is
-    # used by `Gitlab::Geo::VerificationState.start_verification_batch` to
-    # produce a query which must return values of the primary key of the
-    # *model*, not of the *registry*. We need this so we can instantiate
-    # Replicators.
-    override :verification_state_model_key
-    def verification_state_model_key
-      self::MODEL_FOREIGN_KEY
-    end
-    override :verification_pending_batch_relation
-    def verification_pending_batch_relation(batch_size:)
-      super.synced
-    end
-    override :verification_failed_batch_relation
-    def verification_failed_batch_relation(batch_size:)
-      super.synced
-    end
-    override :needs_verification_relation
-    def needs_verification_relation
-      super.synced
+module Geo
+  module VerifiableRegistry
+    extend ActiveSupport::Concern
+    include ::Gitlab::Geo::VerificationState
+
+    class_methods do
+      extend ::Gitlab::Utils::Override
+
+      # Overrides a method in `Gitlab::Geo::VerificationState`. This method is
+      # used by `Gitlab::Geo::VerificationState.start_verification_batch` to
+      # produce a query which must return values of the primary key of the
+      # *model*, not of the *registry*. We need this so we can instantiate
+      # Replicators.
+      override :verification_state_model_key
+      def verification_state_model_key
+        self::MODEL_FOREIGN_KEY
+      end
+      override :verification_pending_batch_relation
+      def verification_pending_batch_relation(batch_size:)
+        super.synced
+      end
+      override :verification_failed_batch_relation
+      def verification_failed_batch_relation(batch_size:)
+        super.synced
+      end
+      override :needs_verification_relation
+      def needs_verification_relation
+        super.synced
+      end
     end
-  end
-  included do
-    extend ::Gitlab::Utils::Override
-    sha_attribute :verification_checksum_mismatched
-    scope :available_verifiables, -> { all }
-    override :clear_verification_failure_fields!
-    def clear_verification_failure_fields!
-      super
-      # Note: If the return value of a `before_transition` block is `false`,
-      # then the transition is halted. Anything else, including `nil`, does not
-      # halt the transition.
-      self.checksum_mismatch = false
-      self.verification_checksum_mismatched = nil
-    end
-    # Records a checksum mismatch
-    #
-    # @param [String] checksum value which does not match the primary checksum
-    def verification_failed_due_to_mismatch!(checksum, primary_checksum)
-      message = 'Checksum does not match the primary checksum'
-      details = { checksum: checksum, primary_checksum: primary_checksum }
-      log_info(message, details)
-      self.verification_failure = "#{message} #{details}".truncate(255)
-      self.verification_checksum = checksum
-      self.verification_checksum_mismatched = checksum
-      self.checksum_mismatch = true
-      self.verification_failed!
-    end
-    private
-    override :track_checksum_result!
-    def track_checksum_result!(checksum, calculation_started_at)
-      unless replicator.matches_checksum?(checksum)
-        return verification_failed_due_to_mismatch!(checksum, replicator.primary_checksum)
-      end
-      verification_succeeded_with_checksum!(checksum, calculation_started_at)
+    included do
+      extend ::Gitlab::Utils::Override
+      sha_attribute :verification_checksum_mismatched
+      scope :available_verifiables, -> { all }
+      override :clear_verification_failure_fields!
+      def clear_verification_failure_fields!
+        super
+        # Note: If the return value of a `before_transition` block is `false`,
+        # then the transition is halted. Anything else, including `nil`, does not
+        # halt the transition.
+        self.checksum_mismatch = false
+        self.verification_checksum_mismatched = nil
+      end
+      # Records a checksum mismatch
+      #
+      # @param [String] checksum value which does not match the primary checksum
+      def verification_failed_due_to_mismatch!(checksum, primary_checksum)
+        message = 'Checksum does not match the primary checksum'
+        details = { checksum: checksum, primary_checksum: primary_checksum }
+        log_info(message, details)
+        self.verification_failure = "#{message} #{details}".truncate(255)
+        self.verification_checksum = checksum
+        self.verification_checksum_mismatched = checksum
+        self.checksum_mismatch = true
+        self.verification_failed!
+      end
+      private
+      override :track_checksum_result!
+      def track_checksum_result!(checksum, calculation_started_at)
+        unless replicator.matches_checksum?(checksum)
+          return verification_failed_due_to_mismatch!(checksum, replicator.primary_checksum)
+        end
+        verification_succeeded_with_checksum!(checksum, calculation_started_at)
+      end
     end
   end
 end

ee/app/models/geo/package_file_registry.rb

@@ -2,7 +2,6 @@
 class Geo::PackageFileRegistry < Geo::BaseRegistry
   include ::Geo::ReplicableRegistry
-  include ::Gitlab::Geo::VerificationState
   include ::Geo::VerifiableRegistry
   MODEL_CLASS = ::Packages::PackageFile