Merge branch 'pass-similar-cc-count-to-pvs' into 'master'

Add similar credit card counts to external pipeline validation service payload

See merge request gitlab-org/gitlab!96264

app/models/users/credit_card_validation.rb

@@ -21,5 +21,9 @@ def similar_records
         network: network
       ).order(credit_card_validated_at: :desc).includes(:user)
     end
+
+    def similar_holder_names_count
+      self.class.where('lower(holder_name) = :value', value: holder_name.downcase).count
+    end
   end
 end

db/migrate/20220829183356_replace_index_on_credit_card_validations.rb

+# frozen_string_literal: true
+
+class ReplaceIndexOnCreditCardValidations < Gitlab::Database::Migration[2.0]
+  disable_ddl_transaction!
+
+  OLD_INDEX_NAME = 'index_user_credit_card_validations_meta_data_full_match'
+  NEW_INDEX_NAME = 'index_user_credit_card_validations_meta_data_full_match_lower'
+  OLD_FIELDS = [:holder_name, :expiration_date, :last_digits, :credit_card_validated_at]
+  NEW_FIELDS = 'lower(holder_name), expiration_date, last_digits, credit_card_validated_at'
+
+  def up
+    add_concurrent_index :user_credit_card_validations, NEW_FIELDS, name: NEW_INDEX_NAME
+    remove_concurrent_index :user_credit_card_validations, OLD_FIELDS, name: OLD_INDEX_NAME
+  end
+
+  def down
+    add_concurrent_index :user_credit_card_validations, OLD_FIELDS, name: OLD_INDEX_NAME
+    remove_concurrent_index :user_credit_card_validations, NEW_FIELDS, name: NEW_INDEX_NAME
+  end
+end

db/schema_migrations/20220829183356

+4d8be5080046eff9c3736cd2494c02b2d2cb1eeea2753479617cb344bc5b1cbb
\ No newline at end of file

db/structure.sql

@@ -30341,7 +30341,7 @@ CREATE UNIQUE INDEX index_user_canonical_emails_on_user_id ON user_canonical_ema
 CREATE UNIQUE INDEX index_user_canonical_emails_on_user_id_and_canonical_email ON user_canonical_emails USING btree (user_id, canonical_email);
-CREATE INDEX index_user_credit_card_validations_meta_data_full_match ON user_credit_card_validations USING btree (holder_name, expiration_date, last_digits, credit_card_validated_at);
+CREATE INDEX index_user_credit_card_validations_meta_data_full_match_lower ON user_credit_card_validations USING btree (lower(holder_name), expiration_date, last_digits, credit_card_validated_at);
 CREATE INDEX index_user_credit_card_validations_meta_data_partial_match ON user_credit_card_validations USING btree (expiration_date, last_digits, network, credit_card_validated_at);

doc/administration/external_pipeline_validation.md

@@ -44,6 +44,7 @@ required number of seconds.
   "required" : [
     "project",
     "user",
+    "credit_card",
     "pipeline",
     "builds",
     "total_builds_count",
@@ -85,6 +86,17 @@ required number of seconds.
         "sign_in_count": { "type": "integer" }
       }
     },
+    "credit_card": {
+      "type": "object",
+      "required": [
+        "similar_cards_count",
+        "similar_holder_names_count"
+      ],
+      "properties": {
+        "similar_cards_count": { "type": "integer" },
+        "similar_holder_names_count": { "type": "integer" }
+      }
+    },
     "pipeline": {
       "type": "object",
       "required": [

lib/gitlab/ci/pipeline/chain/validate/external.rb

@@ -97,6 +97,10 @@ def validation_service_payload
                   last_sign_in_ip: current_user.last_sign_in_ip,
                   sign_in_count: current_user.sign_in_count
                 },
+                credit_card: {
+                  similar_cards_count: current_user.credit_card_validation&.similar_records&.count.to_i,
+                  similar_holder_names_count: current_user.credit_card_validation&.similar_holder_names_count.to_i
+                },
                 pipeline: {
                   sha: pipeline.sha,
                   ref: pipeline.ref,

spec/fixtures/api/schemas/external_validation.json

@@ -3,6 +3,7 @@
   "required" : [
     "project",
     "user",
+    "credit_card",
     "pipeline",
     "builds",
     "total_builds_count"
@@ -43,6 +44,17 @@
         "sign_in_count": { "type": "integer" }
       }
     },
+    "credit_card": {
+      "type": "object",
+      "required": [
+        "similar_cards_count",
+        "similar_holder_names_count"
+      ],
+      "properties": {
+        "similar_cards_count": { "type": "integer" },
+        "similar_holder_names_count": { "type": "integer" }
+      }
+    },
     "pipeline": {
       "type": "object",
       "required": [

spec/lib/gitlab/ci/pipeline/chain/validate/external_spec.rb

@@ -179,6 +179,70 @@
           perform!
         end
       end
+
+      describe 'credit_card' do
+        context 'with no registered credit_card' do
+          it 'returns the expected credit card counts' do
+            expect(::Gitlab::HTTP).to receive(:post) do |_url, params|
+              payload = Gitlab::Json.parse(params[:body])
+
+              expect(payload['credit_card']['similar_cards_count']).to eq(0)
+              expect(payload['credit_card']['similar_holder_names_count']).to eq(0)
+            end
+
+            perform!
+          end
+        end
+
+        context 'with a registered credit card' do
+          let!(:credit_card) { create(:credit_card_validation, last_digits: 10, holder_name: 'Alice', user: user) }
+
+          it 'returns the expected credit card counts' do
+            expect(::Gitlab::HTTP).to receive(:post) do |_url, params|
+              payload = Gitlab::Json.parse(params[:body])
+
+              expect(payload['credit_card']['similar_cards_count']).to eq(1)
+              expect(payload['credit_card']['similar_holder_names_count']).to eq(1)
+            end
+
+            perform!
+          end
+
+          context 'with similar credit cards registered by other users' do
+            before do
+              create(:credit_card_validation, last_digits: 10, holder_name: 'Bob')
+            end
+
+            it 'returns the expected credit card counts' do
+              expect(::Gitlab::HTTP).to receive(:post) do |_url, params|
+                payload = Gitlab::Json.parse(params[:body])
+
+                expect(payload['credit_card']['similar_cards_count']).to eq(2)
+                expect(payload['credit_card']['similar_holder_names_count']).to eq(1)
+              end
+
+              perform!
+            end
+          end
+
+          context 'with similar holder names registered by other users' do
+            before do
+              create(:credit_card_validation, last_digits: 11, holder_name: 'Alice')
+            end
+
+            it 'returns the expected credit card counts' do
+              expect(::Gitlab::HTTP).to receive(:post) do |_url, params|
+                payload = Gitlab::Json.parse(params[:body])
+
+                expect(payload['credit_card']['similar_cards_count']).to eq(1)
+                expect(payload['credit_card']['similar_holder_names_count']).to eq(2)
+              end
+
+              perform!
+            end
+          end
+        end
+      end
     end
 
     context 'when EXTERNAL_VALIDATION_SERVICE_TOKEN is set' do

spec/models/users/credit_card_validation_spec.rb

@@ -28,4 +28,15 @@
       expect(subject.similar_records).to eq([match2, match1, subject])
     end
   end
+
+  describe '.similar_holder_names_count' do
+    subject!(:credit_card_validation) { create(:credit_card_validation, holder_name: 'ALICE M SMITH') }
+
+    let!(:match) { create(:credit_card_validation, holder_name: 'Alice M Smith') }
+    let!(:non_match) { create(:credit_card_validation, holder_name: 'Bob B Brown') }
+
+    it 'returns the count of cards with similar case insensitive holder names' do
+      expect(subject.similar_holder_names_count).to eq(2)
+    end
+  end
 end