Add latest changes from gitlab-org/gitlab@master

1 files changed, 58 insertions, 0 deletions

diff --git a/lib/gitlab/database/migration_helpers/restrict_gitlab_schema.rb b/lib/gitlab/database/migration_helpers/restrict_gitlab_schema.rb
new file mode 100644
index 00000000000..b4e31565c60
--- /dev/null
+++ b/lib/gitlab/database/migration_helpers/restrict_gitlab_schema.rb
@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module Database
+    module MigrationHelpers
+      module RestrictGitlabSchema
+        extend ActiveSupport::Concern
+
+        MigrationSkippedError = Class.new(StandardError)
+
+        included do
+          class_attribute :allowed_gitlab_schemas
+        end
+
+        class_methods do
+          def restrict_gitlab_migration(gitlab_schema:)
+            unless Gitlab::Database::GitlabSchema.schema_names.include?(gitlab_schema)
+              raise "Unknown 'gitlab_schema: #{gitlab_schema}' specified. It needs to be one of: " \
+                "#{Gitlab::Database::GitlabSchema.schema_names.to_a}"
+            end
+
+            self.allowed_gitlab_schemas = [gitlab_schema]
+          end
+        end
+
+        def migrate(direction)
+          if unmatched_schemas.any?
+            # TODO: Today skipping migration would raise an exception.
+            # Ideally, skipped migration should be ignored (not loaded), or softly ignored.
+            # Read more in: https://gitlab.com/gitlab-org/gitlab/-/issues/355014
+            raise MigrationSkippedError, "Current migration is skipped since it modifies "\
+              "'#{self.class.allowed_gitlab_schemas}' which is outside of '#{allowed_schemas_for_connection}'"
+          end
+
+          Gitlab::Database::QueryAnalyzer.instance.within([validator_class]) do
+            validator_class.allowed_gitlab_schemas = self.allowed_gitlab_schemas
+
+            super
+          end
+        end
+
+        private
+
+        def validator_class
+          Gitlab::Database::QueryAnalyzers::RestrictAllowedSchemas
+        end
+
+        def unmatched_schemas
+          (self.allowed_gitlab_schemas || []) - allowed_schemas_for_connection
+        end
+
+        def allowed_schemas_for_connection
+          Gitlab::Database.gitlab_schemas_for_connection(connection)
+        end
+      end
+    end
+  end
+end