summaryrefslogtreecommitdiff
path: root/spec/lib/gitlab/database/async_foreign_keys/foreign_key_validator_spec.rb
blob: 90137e259f5480c94dbe476b02abd7f01f62c467 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Gitlab::Database::AsyncForeignKeys::ForeignKeyValidator, feature_category: :database do
  include ExclusiveLeaseHelpers

  describe '#perform' do
    let!(:lease) { stub_exclusive_lease(lease_key, :uuid, timeout: lease_timeout) }
    let(:lease_key) { "gitlab/database/asyncddl/actions/#{Gitlab::Database::PRIMARY_DATABASE_NAME}" }
    let(:lease_timeout) { described_class::TIMEOUT_PER_ACTION }

    let(:fk_model) { Gitlab::Database::AsyncForeignKeys::PostgresAsyncForeignKeyValidation }
    let(:table_name) { '_test_async_fks' }
    let(:fk_name) { 'fk_parent_id' }
    let(:validation) { create(:postgres_async_foreign_key_validation, table_name: table_name, name: fk_name) }
    let(:connection) { validation.connection }

    subject { described_class.new(validation) }

    before do
      connection.create_table(table_name) do |t|
        t.references :parent, foreign_key: { to_table: table_name, validate: false, name: fk_name }
      end
    end

    it 'validates the FK while controlling statement timeout' do
      allow(connection).to receive(:execute).and_call_original
      expect(connection).to receive(:execute)
        .with("SET statement_timeout TO '43200s'").ordered.and_call_original
      expect(connection).to receive(:execute)
        .with('ALTER TABLE "_test_async_fks" VALIDATE CONSTRAINT "fk_parent_id";').ordered.and_call_original
      expect(connection).to receive(:execute)
        .with("RESET statement_timeout").ordered.and_call_original

      subject.perform
    end

    context 'with fully qualified table names' do
      let(:validation) do
        create(:postgres_async_foreign_key_validation,
          table_name: "public.#{table_name}",
          name: fk_name
        )
      end

      it 'validates the FK' do
        allow(connection).to receive(:execute).and_call_original

        expect(connection).to receive(:execute)
          .with('ALTER TABLE "public"."_test_async_fks" VALIDATE CONSTRAINT "fk_parent_id";').ordered.and_call_original

        subject.perform
      end
    end

    it 'removes the FK validation record from table' do
      expect(validation).to receive(:destroy!).and_call_original

      expect { subject.perform }.to change { fk_model.count }.by(-1)
    end

    it 'skips logic if not able to acquire exclusive lease' do
      expect(lease).to receive(:try_obtain).ordered.and_return(false)
      expect(connection).not_to receive(:execute).with(/ALTER TABLE/)
      expect(validation).not_to receive(:destroy!)

      expect { subject.perform }.not_to change { fk_model.count }
    end

    it 'logs messages around execution' do
      allow(Gitlab::AppLogger).to receive(:info).and_call_original

      subject.perform

      expect(Gitlab::AppLogger)
        .to have_received(:info)
        .with(a_hash_including(message: 'Starting to validate foreign key'))

      expect(Gitlab::AppLogger)
        .to have_received(:info)
        .with(a_hash_including(message: 'Finished validating foreign key'))
    end

    context 'when the FK does not exist' do
      before do
        connection.create_table(table_name, force: true)
      end

      it 'skips validation and removes the record' do
        expect(connection).not_to receive(:execute).with(/ALTER TABLE/)

        expect { subject.perform }.to change { fk_model.count }.by(-1)
      end

      it 'logs an appropriate message' do
        expected_message = "Skipping #{fk_name} validation since it does not exist. The queuing entry will be deleted"

        allow(Gitlab::AppLogger).to receive(:info).and_call_original

        subject.perform

        expect(Gitlab::AppLogger)
          .to have_received(:info)
          .with(a_hash_including(message: expected_message))
      end
    end

    context 'with error handling' do
      before do
        allow(connection).to receive(:execute).and_call_original

        allow(connection).to receive(:execute)
          .with('ALTER TABLE "_test_async_fks" VALIDATE CONSTRAINT "fk_parent_id";')
          .and_raise(ActiveRecord::StatementInvalid)
      end

      context 'on production' do
        before do
          allow(Gitlab::ErrorTracking).to receive(:should_raise_for_dev?).and_return(false)
        end

        it 'increases execution attempts' do
          expect { subject.perform }.to change { validation.attempts }.by(1)

          expect(validation.last_error).to be_present
          expect(validation).not_to be_destroyed
        end

        it 'logs an error message including the fk_name' do
          expect(Gitlab::AppLogger)
            .to receive(:error)
            .with(a_hash_including(:message, :fk_name))
            .and_call_original

          subject.perform
        end
      end

      context 'on development' do
        it 'also raises errors' do
          expect { subject.perform }
            .to raise_error(ActiveRecord::StatementInvalid)
            .and change { validation.attempts }.by(1)

          expect(validation.last_error).to be_present
          expect(validation).not_to be_destroyed
        end
      end
    end
  end
end