Merge branch 'ph/groupSavedRepliesTable' into 'master'

Added group saved replies table

See merge request https://gitlab.com/gitlab-org/gitlab/-/merge_requests/143515



Merged-by: Tiger Watson <twatson@gitlab.com>
Approved-by: Tiger Watson <twatson@gitlab.com>
Reviewed-by: Tiger Watson <twatson@gitlab.com>
Reviewed-by: Bala Kumar <sbalakumar@gitlab.com>
Co-authored-by: Phil Hughes <me@iamphill.com>

app/models/concerns/saved_reply_concern.rb

+# frozen_string_literal: true
+
+module SavedReplyConcern
+  extend ActiveSupport::Concern
+
+  included do
+    validates namespace_foreign_key, :name, :content, presence: true
+    validates :content, length: { maximum: 10000 }
+    validates :name,
+      length: { maximum: 255 },
+      uniqueness: { scope: [namespace_foreign_key] }
+
+    def self.find_saved_reply(**args)
+      find_by(args)
+    end
+  end
+end

app/models/users/saved_reply.rb

@@ -2,18 +2,13 @@
 
 module Users
   class SavedReply < ApplicationRecord
+    def self.namespace_foreign_key
+      :user_id
+    end
     self.table_name = 'saved_replies'
 
-    belongs_to :user
-
-    validates :user_id, :name, :content, presence: true
-    validates :name,
-      length: { maximum: 255 },
-      uniqueness: { scope: [:user_id] }
-    validates :content, length: { maximum: 10000 }
+    include SavedReplyConcern
 
-    def self.find_saved_reply(user_id:, id:)
-      ::Users::SavedReply.find_by(user_id: user_id, id: id)
-    end
+    belongs_to :user
   end
 end

db/docs/group_saved_replies.yml

+---
+table_name: group_saved_replies
+classes:
+- Groups::SavedReply
+feature_categories:
+- code_review_workflow
+description: Comment templates used to populate comments
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/143515
+milestone: '16.9'
+gitlab_schema: gitlab_main_cell
+sharding_key:
+  group_id: namespaces

db/migrate/20240201112236_create_group_saved_replies_table.rb

+# frozen_string_literal: true
+
+class CreateGroupSavedRepliesTable < Gitlab::Database::Migration[2.2]
+  enable_lock_retries!
+
+  milestone '16.9'
+
+  def change
+    create_table :group_saved_replies do |t|
+      t.references :group, references: :namespaces, null: false,
+        foreign_key: { to_table: :namespaces, on_delete: :cascade }, index: true
+      t.timestamps_with_timezone null: false
+      t.text :name, null: false, limit: 255
+      t.text :content, null: false, limit: 10000
+    end
+  end
+end

db/schema_migrations/20240201112236

+8e21124a691843445077a9d6bc5541eea99f8b2f3f90e1846429ed3e2f97d72d
\ No newline at end of file

db/structure.sql

@@ -17888,6 +17888,26 @@ CREATE SEQUENCE group_repository_storage_moves_id_seq
 ALTER SEQUENCE group_repository_storage_moves_id_seq OWNED BY group_repository_storage_moves.id;
+CREATE TABLE group_saved_replies (
+    id bigint NOT NULL,
+    group_id bigint NOT NULL,
+    created_at timestamp with time zone NOT NULL,
+    updated_at timestamp with time zone NOT NULL,
+    name text NOT NULL,
+    content text NOT NULL,
+    CONSTRAINT check_13510378d3 CHECK ((char_length(name) <= 255)),
+    CONSTRAINT check_4a96378d43 CHECK ((char_length(content) <= 10000))
+);
+
+CREATE SEQUENCE group_saved_replies_id_seq
+    START WITH 1
+    INCREMENT BY 1
+    NO MINVALUE
+    NO MAXVALUE
+    CACHE 1;
+
+ALTER SEQUENCE group_saved_replies_id_seq OWNED BY group_saved_replies.id;
+
 CREATE TABLE group_ssh_certificates (
     id bigint NOT NULL,
     namespace_id bigint NOT NULL,
@@ -27417,6 +27437,8 @@ ALTER TABLE ONLY group_import_states ALTER COLUMN group_id SET DEFAULT nextval('
 ALTER TABLE ONLY group_repository_storage_moves ALTER COLUMN id SET DEFAULT nextval('group_repository_storage_moves_id_seq'::regclass);
+ALTER TABLE ONLY group_saved_replies ALTER COLUMN id SET DEFAULT nextval('group_saved_replies_id_seq'::regclass);
+
 ALTER TABLE ONLY group_ssh_certificates ALTER COLUMN id SET DEFAULT nextval('group_ssh_certificates_id_seq'::regclass);
 ALTER TABLE ONLY group_wiki_repository_states ALTER COLUMN id SET DEFAULT nextval('group_wiki_repository_states_id_seq'::regclass);
@@ -29729,6 +29751,9 @@ ALTER TABLE ONLY group_merge_request_approval_settings
 ALTER TABLE ONLY group_repository_storage_moves
     ADD CONSTRAINT group_repository_storage_moves_pkey PRIMARY KEY (id);
+ALTER TABLE ONLY group_saved_replies
+    ADD CONSTRAINT group_saved_replies_pkey PRIMARY KEY (id);
+
 ALTER TABLE ONLY group_ssh_certificates
     ADD CONSTRAINT group_ssh_certificates_pkey PRIMARY KEY (id);
@@ -33970,6 +33995,8 @@ CREATE INDEX index_group_import_states_on_user_id ON group_import_states USING b
 CREATE INDEX index_group_repository_storage_moves_on_group_id ON group_repository_storage_moves USING btree (group_id);
+CREATE INDEX index_group_saved_replies_on_group_id ON group_saved_replies USING btree (group_id);
+
 CREATE UNIQUE INDEX index_group_ssh_certificates_on_fingerprint ON group_ssh_certificates USING btree (fingerprint);
 CREATE INDEX index_group_ssh_certificates_on_namespace_id ON group_ssh_certificates USING btree (namespace_id);
@@ -40693,6 +40720,9 @@ ALTER TABLE ONLY container_registry_protection_rules
 ALTER TABLE ONLY clusters
     ADD CONSTRAINT fk_rails_ac3a663d79 FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE SET NULL;
+ALTER TABLE ONLY group_saved_replies
+    ADD CONSTRAINT fk_rails_acd8e1889b FOREIGN KEY (group_id) REFERENCES namespaces(id) ON DELETE CASCADE;
+
 ALTER TABLE ONLY packages_composer_metadata
     ADD CONSTRAINT fk_rails_ad48c2e5bb FOREIGN KEY (package_id) REFERENCES packages_packages(id) ON DELETE CASCADE;

ee/app/models/ee/group.rb

@@ -84,6 +84,8 @@ module Group
       belongs_to :push_rule, inverse_of: :group
       has_many :approval_rules, class_name: 'ApprovalRules::ApprovalGroupRule', inverse_of: :group
 
+      has_many :saved_replies, class_name: 'Groups::SavedReply'
+
       delegate :deleting_user, :marked_for_deletion_on, to: :deletion_schedule, allow_nil: true
 
       delegate :repository_read_only,

ee/app/models/groups/saved_reply.rb

+# frozen_string_literal: true
+
+module Groups
+  class SavedReply < ApplicationRecord
+    def self.namespace_foreign_key
+      :group_id
+    end
+    self.table_name = :group_saved_replies
+
+    include SavedReplyConcern
+
+    belongs_to :group
+  end
+end

ee/spec/factories/groups/saved_replies.rb

+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :group_saved_reply, class: 'Groups::SavedReply' do
+    sequence(:name) { |n| "saved_reply_#{n}" }
+    content { 'Saved Reply Content' }
+
+    group
+  end
+end

ee/spec/models/groups/saved_reply_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Groups::SavedReply, feature_category: :code_review_workflow do
+  let_it_be(:saved_reply) { create(:group_saved_reply) }
+
+  describe 'validations' do
+    it { is_expected.to validate_presence_of(:group_id) }
+    it { is_expected.to validate_presence_of(:name) }
+    it { is_expected.to validate_presence_of(:content) }
+    it { is_expected.to validate_uniqueness_of(:name).scoped_to([:group_id]) }
+    it { is_expected.to validate_length_of(:name).is_at_most(255) }
+    it { is_expected.to validate_length_of(:content).is_at_most(10000) }
+  end
+end