Welcome to mirror list, hosted at ThFree Co, Russian Federation.

dynamic_model_helpers_spec.rb « database « gitlab « lib « spec - gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: fe423b3639b9f76e2a40042b838f58c8cc5854ed (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
153
154
155
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Gitlab::Database::DynamicModelHelpers do
  let(:including_class) { Class.new.include(described_class) }
  let(:table_name) { Project.table_name }
  let(:connection) { Project.connection }

  describe '#define_batchable_model' do
    subject { including_class.new.define_batchable_model(table_name, connection: connection) }

    it 'is an ActiveRecord model' do
      expect(subject.ancestors).to include(ActiveRecord::Base)
    end

    it 'includes EachBatch' do
      expect(subject.included_modules).to include(EachBatch)
    end

    it 'has the correct table name' do
      expect(subject.table_name).to eq(table_name)
    end

    it 'has the inheritance type column disable' do
      expect(subject.inheritance_column).to eq('_type_disabled')
    end
  end

  describe '#each_batch' do
    subject { including_class.new }

    before do
      create_list(:project, 2)
    end

    context 'when no transaction is open' do
      before do
        allow(subject).to receive(:transaction_open?).and_return(false)
      end

      it 'iterates table in batches' do
        each_batch_size = ->(&block) do
          subject.each_batch(table_name, connection: connection, of: 1) do |batch|
            block.call(batch.size)
          end
        end

        expect { |b| each_batch_size.call(&b) }
          .to yield_successive_args(1, 1)
      end

      context 'when a column to be batched over is specified' do
        let(:projects) { Project.order(project_namespace_id: :asc) }

        it 'iterates table in batches using the given column' do
          each_batch_ids = ->(&block) do
            subject.each_batch(table_name, connection: connection, of: 1, column: :project_namespace_id) do |batch|
              block.call(batch.pluck(:project_namespace_id))
            end
          end

          expect { |b| each_batch_ids.call(&b) }
            .to yield_successive_args([projects.first.project_namespace_id], [projects.last.project_namespace_id])
        end
      end
    end

    context 'when transaction is open' do
      before do
        allow(subject).to receive(:transaction_open?).and_return(true)
      end

      it 'raises an error' do
        expect { subject.each_batch(table_name, connection: connection, of: 1) { |batch| batch.size } }
          .to raise_error(RuntimeError, /each_batch should not run inside a transaction/)
      end
    end
  end

  describe '#each_batch_range' do
    subject { including_class.new }

    let(:first_project) { create(:project) }
    let(:second_project) { create(:project) }

    context 'when no transaction is open' do
      before do
        allow(subject).to receive(:transaction_open?).and_return(false)
      end

      it 'iterates table in batch ranges' do
        expect { |b| subject.each_batch_range(table_name, connection: connection, of: 1, &b) }
          .to yield_successive_args(
            [first_project.id, first_project.id],
            [second_project.id, second_project.id]
          )
      end

      it 'yields only one batch if bigger than the table size' do
        expect { |b| subject.each_batch_range(table_name, connection: connection, of: 2, &b) }
          .to yield_successive_args([first_project.id, second_project.id])
      end

      it 'makes it possible to apply a scope' do
        each_batch_limited = ->(&b) do
          subject.each_batch_range(table_name, connection: connection, scope: ->(table) { table.limit(1) }, of: 1, &b)
        end

        expect { |b| each_batch_limited.call(&b) }
          .to yield_successive_args([first_project.id, first_project.id])
      end

      context 'when primary key is not named id' do
        let(:namespace_settings1) { create(:namespace_settings) }
        let(:namespace_settings2) { create(:namespace_settings) }
        let(:table_name) { NamespaceSetting.table_name }
        let(:connection) { NamespaceSetting.connection }
        let(:primary_key) { subject.define_batchable_model(table_name, connection: connection).primary_key }

        it 'iterates table in batch ranges using the correct primary key' do
          expect(primary_key).to eq("namespace_id") # Sanity check the primary key is not id
          expect { |b| subject.each_batch_range(table_name, connection: connection, of: 1, &b) }
            .to yield_successive_args(
              [namespace_settings1.namespace_id, namespace_settings1.namespace_id],
              [namespace_settings2.namespace_id, namespace_settings2.namespace_id]
            )
        end
      end

      context 'when a column to be batched over is specified' do
        it 'iterates table in batch ranges using the given column' do
          expect do |b|
            subject.each_batch_range(table_name, connection: connection, of: 1, column: :project_namespace_id, &b)
          end
            .to yield_successive_args(
              [first_project.project_namespace_id, first_project.project_namespace_id],
              [second_project.project_namespace_id, second_project.project_namespace_id]
            )
        end
      end
    end

    context 'when transaction is open' do
      before do
        allow(subject).to receive(:transaction_open?).and_return(true)
      end

      it 'raises an error' do
        expect { subject.each_batch_range(table_name, connection: connection, of: 1) { 1 } }
          .to raise_error(RuntimeError, /each_batch should not run inside a transaction/)
      end
    end
  end
end