Merge branch '433179_add_params_to_member_approvals' into 'master'

Added metadata field to member approvals

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



Merged-by: Hitesh Raghuvanshi <hraghuvanshi@gitlab.com>
Approved-by: Tarun Vellishetty <tvellishetty@gitlab.com>
Approved-by: Prabakaran Murugesan <pmurugesan@gitlab.com>
Approved-by: Hitesh Raghuvanshi <hraghuvanshi@gitlab.com>
Co-authored-by: Suraj Tripathi <stripathi@gitlab.com>

app/models/members/members/member_approval.rb

@@ -17,6 +17,7 @@ class MemberApproval < ApplicationRecord
     validates :new_access_level, presence: true
     validates :user, presence: true
     validates :member_namespace, presence: true
+    validates :metadata, json_schema: { filename: "members_approval_request_metadata" }
   end
 end
 

app/validators/json_schemas/members_approval_request_metadata.json

+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "expires_at": {
+      "type": "string",
+      "oneOf": [
+        {
+          "format": "date"
+        },
+        {
+          "pattern": "^$"
+        }
+      ]
+    },
+    "member_role_id": {
+      "type": [
+        "number",
+        "null"
+      ]
+    }
+  },
+  "additionalProperties": true
+}

db/migrate/20240519141301_add_metadata_to_member_approvals.rb

+# frozen_string_literal: true
+
+class AddMetadataToMemberApprovals < Gitlab::Database::Migration[2.2]
+  milestone '17.1'
+  enable_lock_retries!
+
+  def change
+    add_column :member_approvals, :metadata, :jsonb, default: {}, null: false
+  end
+end

db/schema_migrations/20240519141301

+cd61987ea28b86a0c4280c8e0c743ecef2e1c6a45842281b4c7814ebe6e87057
\ No newline at end of file

db/structure.sql

@@ -11247,7 +11247,8 @@ CREATE TABLE member_approvals (
     old_access_level integer,
     status smallint DEFAULT 0 NOT NULL,
     user_id bigint NOT NULL,
-    member_role_id bigint
+    member_role_id bigint,
+    metadata jsonb DEFAULT '{}'::jsonb NOT NULL
 );
 CREATE SEQUENCE member_approvals_id_seq

spec/models/members/members/member_approval_spec.rb

@@ -15,5 +15,91 @@
     it { is_expected.to validate_presence_of(:new_access_level) }
     it { is_expected.to validate_presence_of(:user) }
     it { is_expected.to validate_presence_of(:member_namespace) }
+
+    context 'with metadata' do
+      subject { build(:member_approval, metadata: attribute_mapping) }
+
+      context 'with valid JSON schemas' do
+        let(:attribute_mapping) do
+          {
+            expires_at: expiry,
+            member_role_id: nil
+          }
+        end
+
+        context 'with empty metadata' do
+          let(:attribute_mapping) { {} }
+
+          it { is_expected.to be_valid }
+        end
+
+        context 'with valid expiry' do
+          let(:expiry) { "1970-01-01" }
+
+          it { is_expected.to be_valid }
+        end
+
+        context 'with empty expiry' do
+          let(:expiry) { "" }
+
+          it { is_expected.to be_valid }
+        end
+
+        context 'with not null member_role_id' do
+          let(:attribute_mapping) do
+            {
+              member_role_id: 3
+            }
+          end
+
+          it { is_expected.to be_valid }
+        end
+
+        context 'when property has extra attributes' do
+          let(:attribute_mapping) do
+            { access_level: 20 }
+          end
+
+          it { is_expected.to be_valid }
+        end
+      end
+
+      context 'with invalid JSON schemas' do
+        shared_examples 'is invalid record' do
+          it do
+            expect(subject).to be_invalid
+            expect(subject.errors.messages[:metadata]).to eq(['must be a valid json schema'])
+          end
+        end
+
+        context 'when property is not an object' do
+          let(:attribute_mapping) do
+            "That is not a valid schema"
+          end
+
+          it_behaves_like 'is invalid record'
+        end
+
+        context 'with invalid expiry' do
+          let(:attribute_mapping) do
+            {
+              expires_at: "1242"
+            }
+          end
+
+          it_behaves_like 'is invalid record'
+        end
+
+        context 'with member_role_id' do
+          let(:attribute_mapping) do
+            {
+              member_role_id: "some role"
+            }
+          end
+
+          it_behaves_like 'is invalid record'
+        end
+      end
+    end
   end
 end