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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe BulkImports::PipelineWorker, feature_category: :importers do
let(:pipeline_class) do
Class.new do
def initialize(_); end
def run; end
def self.relation
'labels'
end
def self.file_extraction_pipeline?
false
end
def self.abort_on_failure?
false
end
end
end
let_it_be(:bulk_import) { create(:bulk_import) }
let_it_be(:config) { create(:bulk_import_configuration, bulk_import: bulk_import) }
let_it_be_with_reload(:entity) { create(:bulk_import_entity, bulk_import: bulk_import) }
let(:pipeline_tracker) do
create(
:bulk_import_tracker,
entity: entity,
pipeline_name: 'FakePipeline',
status_event: 'enqueue'
)
end
let(:worker) { described_class.new }
before do
stub_const('FakePipeline', pipeline_class)
allow(entity).to receive(:pipeline_exists?).with('FakePipeline').and_return(true)
allow_next_instance_of(BulkImports::Groups::Stage) do |instance|
allow(instance).to receive(:pipelines)
.and_return([{ stage: 0, pipeline: pipeline_class }])
end
end
it_behaves_like 'an idempotent worker' do
let(:job_args) { [pipeline_tracker.id, pipeline_tracker.stage, entity.id] }
it 'runs the pipeline and sets tracker to finished' do
allow(worker).to receive(:jid).and_return('jid')
perform_multiple(job_args, worker: worker)
pipeline_tracker.reload
expect(pipeline_tracker.status_name).to eq(:finished)
expect(pipeline_tracker.jid).to eq('jid')
end
end
it 'runs the given pipeline successfully' do
expect_next_instance_of(BulkImports::Logger) do |logger|
expect(logger).to receive(:with_tracker).with(pipeline_tracker).and_call_original
expect(logger).to receive(:with_entity).with(pipeline_tracker.entity).and_call_original
expect(logger).to receive(:info)
end
allow(worker).to receive(:jid).and_return('jid')
worker.perform(pipeline_tracker.id, pipeline_tracker.stage, entity.id)
pipeline_tracker.reload
expect(pipeline_tracker.status_name).to eq(:finished)
expect(pipeline_tracker.jid).to eq('jid')
end
context 'when exclusive lease cannot be obtained' do
it 'does not run the pipeline' do
expect(worker).to receive(:try_obtain_lease).and_return(false)
expect(worker).not_to receive(:run)
worker.perform(pipeline_tracker.id, pipeline_tracker.stage, entity.id)
end
end
describe '.sidekiq_retries_exhausted' do
it 'logs and sets status as failed' do
job = { 'args' => [pipeline_tracker.id, pipeline_tracker.stage, entity.id] }
expect_next_instance_of(BulkImports::Logger) do |logger|
expect(logger).to receive(:with_tracker).with(pipeline_tracker).and_call_original
expect(logger).to receive(:with_entity).with(pipeline_tracker.entity).and_call_original
expect(logger).to receive(:error)
end
expect(Gitlab::ErrorTracking)
.to receive(:track_exception)
.with(
instance_of(StandardError),
hash_including(
bulk_import_entity_id: entity.id,
bulk_import_id: entity.bulk_import.id,
bulk_import_entity_type: entity.source_type,
source_full_path: entity.source_full_path,
pipeline_class: pipeline_tracker.pipeline_name,
importer: 'gitlab_migration',
source_version: entity.bulk_import.source_version_info.to_s
)
)
expect(BulkImports::Failure)
.to receive(:create)
.with(
a_hash_including(
bulk_import_entity_id: entity.id,
pipeline_class: 'FakePipeline',
pipeline_step: 'pipeline_worker_run',
exception_class: 'StandardError',
exception_message: 'Error!',
correlation_id_value: anything
)
)
expect_next_instance_of(described_class) do |worker|
expect(worker).to receive(:perform_failure).with(pipeline_tracker.id, entity.id, StandardError)
.and_call_original
allow(worker).to receive(:jid).and_return('jid')
end
described_class.sidekiq_retries_exhausted_block.call(job, StandardError.new('Error!'))
pipeline_tracker.reload
expect(pipeline_tracker.status_name).to eq(:failed)
expect(pipeline_tracker.jid).to eq('jid')
expect(entity.reload.status_name).to eq(:created)
end
context 'when pipeline has abort_on_failure' do
before do
allow(pipeline_class).to receive(:abort_on_failure?).and_return(true)
end
it 'marks entity as failed' do
job = { 'args' => [pipeline_tracker.id, pipeline_tracker.stage, entity.id] }
described_class.sidekiq_retries_exhausted_block.call(job, StandardError.new('Error!'))
expect(entity.reload.status_name).to eq(:failed)
end
end
end
context 'with stop signal from database health check' do
around do |example|
with_sidekiq_server_middleware do |chain|
chain.add Gitlab::SidekiqMiddleware::SkipJobs
Sidekiq::Testing.inline! { example.run }
end
end
before do
stub_feature_flags("drop_sidekiq_jobs_#{described_class.name}": false)
stop_signal = instance_double("Gitlab::Database::HealthStatus::Signals::Stop", stop?: true)
allow(Gitlab::Database::HealthStatus).to receive(:evaluate).and_return([stop_signal])
end
it 'defers the job by set time' do
expect_next_instance_of(described_class) do |worker|
expect(worker).not_to receive(:perform).with(pipeline_tracker.id, pipeline_tracker.stage, entity.id)
end
expect(described_class).to receive(:perform_in).with(
described_class::DEFER_ON_HEALTH_DELAY,
pipeline_tracker.id,
pipeline_tracker.stage,
entity.id
)
described_class.perform_async(pipeline_tracker.id, pipeline_tracker.stage, entity.id)
end
it 'lazy evaluates schema and tables', :aggregate_failures do
block = described_class.database_health_check_attrs[:block]
job_args = [pipeline_tracker.id, pipeline_tracker.stage, entity.id]
schema, table = block.call([job_args])
expect(schema).to eq(:gitlab_main_cell)
expect(table).to eq(['labels'])
end
context 'when `bulk_import_deferred_workers` feature flag is disabled' do
it 'does not defer job execution' do
stub_feature_flags(bulk_import_deferred_workers: false)
expect_next_instance_of(described_class) do |worker|
expect(worker).to receive(:perform).with(pipeline_tracker.id, pipeline_tracker.stage, entity.id)
end
expect(described_class).not_to receive(:perform_in)
described_class.perform_async(pipeline_tracker.id, pipeline_tracker.stage, entity.id)
end
end
end
context 'when pipeline is finished' do
let(:pipeline_tracker) do
create(
:bulk_import_tracker,
:finished,
entity: entity,
pipeline_name: 'FakePipeline'
)
end
it 'no-ops and returns' do
expect(described_class).not_to receive(:run)
worker.perform(pipeline_tracker.id, pipeline_tracker.stage, entity.id)
end
end
context 'when pipeline is skipped' do
let(:pipeline_tracker) do
create(
:bulk_import_tracker,
:skipped,
entity: entity,
pipeline_name: 'FakePipeline'
)
end
it 'no-ops and returns' do
expect(described_class).not_to receive(:run)
worker.perform(pipeline_tracker.id, pipeline_tracker.stage, entity.id)
end
end
context 'when tracker is started' do
it 'runs the pipeline' do
pipeline_tracker = create(
:bulk_import_tracker,
:started,
entity: entity,
pipeline_name: 'FakePipeline'
)
worker.perform(pipeline_tracker.id, pipeline_tracker.stage, entity.id)
expect(pipeline_tracker.reload.finished?).to eq(true)
end
end
describe '#perform' do
context 'when entity is failed' do
before do
entity.update!(status: -1)
end
it 'marks tracker as skipped and logs the skip' do
pipeline_tracker = create(
:bulk_import_tracker,
entity: entity,
pipeline_name: 'FakePipeline',
status_event: 'enqueue'
)
expect_next_instance_of(BulkImports::Logger) do |logger|
allow(logger).to receive(:info)
expect(logger)
.to receive(:info)
.with(hash_including(message: 'Skipping pipeline due to failed entity'))
end
worker.perform(pipeline_tracker.id, pipeline_tracker.stage, entity.id)
expect(pipeline_tracker.reload.status_name).to eq(:skipped)
end
end
context 'when retry pipeline error is raised' do
let(:pipeline_tracker) do
create(
:bulk_import_tracker,
entity: entity,
pipeline_name: 'FakePipeline',
status_event: 'enqueue'
)
end
let(:exception) do
BulkImports::RetryPipelineError.new('Error!', 60)
end
before do
allow(worker).to receive(:jid).and_return('jid')
expect_next_instance_of(pipeline_class) do |pipeline|
expect(pipeline)
.to receive(:run)
.and_raise(exception)
end
end
it 're_enqueues the worker' do
expect_any_instance_of(BulkImports::Tracker) do |tracker|
expect(tracker).to receive(:retry).and_call_original
end
expect_next_instance_of(BulkImports::Logger) do |logger|
expect(logger).to receive(:with_tracker).and_call_original
expect(logger).to receive(:with_entity).and_call_original
expect(logger).to receive(:info)
end
expect(described_class)
.to receive(:perform_in)
.with(
60.seconds,
pipeline_tracker.id,
pipeline_tracker.stage,
pipeline_tracker.entity.id
)
worker.perform(pipeline_tracker.id, pipeline_tracker.stage, entity.id)
pipeline_tracker.reload
expect(pipeline_tracker.enqueued?).to be_truthy
end
end
end
context 'when file extraction pipeline' do
let(:file_extraction_pipeline) do
Class.new do
def initialize(_); end
def run; end
def self.file_extraction_pipeline?
true
end
def self.relation
'test'
end
end
end
let(:pipeline_tracker) do
create(
:bulk_import_tracker,
entity: entity,
pipeline_name: 'NdjsonPipeline',
status_event: 'enqueue'
)
end
before do
stub_const('NdjsonPipeline', file_extraction_pipeline)
allow_next_instance_of(BulkImports::Groups::Stage) do |instance|
allow(instance)
.to receive(:pipelines)
.and_return([{ stage: 0, pipeline: file_extraction_pipeline }])
end
end
it 'runs the pipeline successfully' do
allow_next_instance_of(BulkImports::ExportStatus) do |status|
allow(status).to receive(:started?).and_return(false)
allow(status).to receive(:empty?).and_return(false)
allow(status).to receive(:failed?).and_return(false)
allow(status).to receive(:batched?).and_return(false)
end
worker.perform(pipeline_tracker.id, pipeline_tracker.stage, entity.id)
expect(pipeline_tracker.reload.status_name).to eq(:finished)
end
context 'when export status is started' do
it 'reenqueues pipeline worker' do
allow_next_instance_of(BulkImports::ExportStatus) do |status|
allow(status).to receive(:started?).and_return(true)
allow(status).to receive(:empty?).and_return(false)
allow(status).to receive(:failed?).and_return(false)
allow(status).to receive(:batched?).and_return(false)
end
expect(described_class)
.to receive(:perform_in)
.with(
described_class::FILE_EXTRACTION_PIPELINE_PERFORM_DELAY,
pipeline_tracker.id,
pipeline_tracker.stage,
entity.id
)
worker.perform(pipeline_tracker.id, pipeline_tracker.stage, entity.id)
end
end
context 'when export status is empty' do
before do
allow_next_instance_of(BulkImports::ExportStatus) do |status|
allow(status).to receive(:started?).and_return(false)
allow(status).to receive(:empty?).and_return(true)
allow(status).to receive(:failed?).and_return(false)
allow(status).to receive(:batched?).and_return(false)
end
pipeline_tracker.update!(created_at: created_at)
end
context 'when timeout is not reached' do
let(:created_at) { 1.minute.ago }
it 'reenqueues pipeline worker' do
expect(described_class)
.to receive(:perform_in)
.with(
described_class::FILE_EXTRACTION_PIPELINE_PERFORM_DELAY,
pipeline_tracker.id,
pipeline_tracker.stage,
entity.id
)
worker.perform(pipeline_tracker.id, pipeline_tracker.stage, entity.id)
expect(pipeline_tracker.reload.status_name).to eq(:enqueued)
end
end
context 'when empty export timeout is reached' do
let(:created_at) { 10.minutes.ago }
it 'raises sidekiq error' do
expect { worker.perform(pipeline_tracker.id, pipeline_tracker.stage, entity.id) }
.to raise_exception(BulkImports::Pipeline::ExpiredError)
end
end
context 'when tracker created_at is nil' do
let(:created_at) { nil }
it 'falls back to entity created_at' do
entity.update!(created_at: 10.minutes.ago)
expect { worker.perform(pipeline_tracker.id, pipeline_tracker.stage, entity.id) }
.to raise_exception(BulkImports::Pipeline::ExpiredError)
end
end
end
context 'when export status is failed' do
it 'marks as failed and logs the error' do
allow_next_instance_of(BulkImports::ExportStatus) do |status|
allow(status).to receive(:failed?).and_return(true)
allow(status).to receive(:error).and_return('Error!')
end
expect { worker.perform(pipeline_tracker.id, pipeline_tracker.stage, entity.id) }
.to raise_exception(BulkImports::Pipeline::FailedError)
end
end
context 'when export is batched', :aggregate_failures do
let(:batches_count) { 3 }
before do
allow_next_instance_of(BulkImports::ExportStatus) do |status|
allow(status).to receive(:batched?).and_return(true)
allow(status).to receive(:batches_count).and_return(batches_count)
allow(status).to receive(:started?).and_return(false)
allow(status).to receive(:empty?).and_return(false)
allow(status).to receive(:failed?).and_return(false)
end
allow(worker).to receive(:log_extra_metadata_on_done).and_call_original
end
it 'enqueues pipeline batches' do
expect(BulkImports::PipelineBatchWorker).to receive(:perform_async).exactly(3).times
expect(worker).to receive(:log_extra_metadata_on_done).with(:batched, true)
expect(worker).to receive(:log_extra_metadata_on_done).with(:tracker_batch_numbers_enqueued, [1, 2, 3])
expect(worker).to receive(:log_extra_metadata_on_done).with(:tracker_final_batch_was_enqueued, true)
worker.perform(pipeline_tracker.id, pipeline_tracker.stage, entity.id)
pipeline_tracker.reload
expect(pipeline_tracker.status_name).to eq(:started)
expect(pipeline_tracker.batched).to eq(true)
expect(pipeline_tracker.batches.pluck_batch_numbers).to contain_exactly(1, 2, 3)
expect(described_class.jobs).to be_empty
end
it 'enqueues only missing pipelines batches' do
create(:bulk_import_batch_tracker, tracker: pipeline_tracker, batch_number: 2)
expect(BulkImports::PipelineBatchWorker).to receive(:perform_async).twice
expect(worker).to receive(:log_extra_metadata_on_done).with(:tracker_batch_numbers_enqueued, [1, 3])
expect(worker).to receive(:log_extra_metadata_on_done).with(:tracker_final_batch_was_enqueued, true)
worker.perform(pipeline_tracker.id, pipeline_tracker.stage, entity.id)
pipeline_tracker.reload
expect(pipeline_tracker.status_name).to eq(:started)
expect(pipeline_tracker.batched).to eq(true)
expect(pipeline_tracker.batches.pluck_batch_numbers).to contain_exactly(1, 2, 3)
expect(described_class.jobs).to be_empty
end
context 'when batches count is less than 1' do
let(:batches_count) { 0 }
it 'marks tracker as finished' do
expect(worker).not_to receive(:enqueue_batches)
worker.perform(pipeline_tracker.id, pipeline_tracker.stage, entity.id)
expect(pipeline_tracker.reload.status_name).to eq(:finished)
end
end
context 'when pipeline batch enqueuing should be limited' do
using RSpec::Parameterized::TableSyntax
before do
allow(::Gitlab::CurrentSettings).to receive(:bulk_import_concurrent_pipeline_batch_limit).and_return(2)
end
it 'only enqueues limited batches and reenqueues itself' do
expect(BulkImports::PipelineBatchWorker).to receive(:perform_async).twice
expect(worker).to receive(:log_extra_metadata_on_done).with(:tracker_batch_numbers_enqueued, [1, 2])
expect(worker).to receive(:log_extra_metadata_on_done).with(:tracker_final_batch_was_enqueued, false)
worker.perform(pipeline_tracker.id, pipeline_tracker.stage, entity.id)
pipeline_tracker.reload
expect(pipeline_tracker.status_name).to eq(:started)
expect(pipeline_tracker.batched).to eq(true)
expect(pipeline_tracker.batches.pluck_batch_numbers).to contain_exactly(1, 2)
expect(described_class.jobs).to contain_exactly(
hash_including(
'args' => [pipeline_tracker.id, pipeline_tracker.stage, entity.id],
'scheduled_at' => be_within(1).of(10.seconds.from_now.to_i)
)
)
end
context 'when there is a batch in progress' do
where(:status) { BulkImports::BatchTracker::IN_PROGRESS_STATES }
with_them do
before do
create(:bulk_import_batch_tracker, status, batch_number: 1, tracker: pipeline_tracker)
end
it 'counts the in progress batch against the limit' do
expect(BulkImports::PipelineBatchWorker).to receive(:perform_async).once
expect(worker).to receive(:log_extra_metadata_on_done).with(:tracker_batch_numbers_enqueued, [2])
expect(worker).to receive(:log_extra_metadata_on_done).with(:tracker_final_batch_was_enqueued, false)
worker.perform(pipeline_tracker.id, pipeline_tracker.stage, entity.id)
pipeline_tracker.reload
expect(pipeline_tracker.status_name).to eq(:started)
expect(pipeline_tracker.batched).to eq(true)
expect(pipeline_tracker.batches.pluck_batch_numbers).to contain_exactly(1, 2)
expect(described_class.jobs).to contain_exactly(
hash_including(
'args' => [pipeline_tracker.id, pipeline_tracker.stage, entity.id],
'scheduled_at' => be_within(1).of(10.seconds.from_now.to_i)
)
)
end
end
end
context 'when there is a batch that has finished' do
where(:status) do
all_statuses = BulkImports::BatchTracker.state_machines[:status].states.map(&:name)
all_statuses - BulkImports::BatchTracker::IN_PROGRESS_STATES
end
with_them do
before do
create(:bulk_import_batch_tracker, status, batch_number: 1, tracker: pipeline_tracker)
end
it 'does not count the finished batch against the limit' do
expect(BulkImports::PipelineBatchWorker).to receive(:perform_async).twice
expect(worker).to receive(:log_extra_metadata_on_done).with(:tracker_batch_numbers_enqueued, [2, 3])
expect(worker).to receive(:log_extra_metadata_on_done).with(:tracker_final_batch_was_enqueued, true)
worker.perform(pipeline_tracker.id, pipeline_tracker.stage, entity.id)
pipeline_tracker.reload
expect(pipeline_tracker.batches.pluck_batch_numbers).to contain_exactly(1, 2, 3)
expect(described_class.jobs).to be_empty
end
end
end
context 'when the feature flag is disabled' do
before do
stub_feature_flags(bulk_import_limit_concurrent_batches: false)
end
it 'does not limit batches' do
expect(BulkImports::PipelineBatchWorker).to receive(:perform_async).exactly(3).times
expect(worker).to receive(:log_extra_metadata_on_done).with(:tracker_batch_numbers_enqueued, [1, 2, 3])
expect(worker).to receive(:log_extra_metadata_on_done).with(:tracker_final_batch_was_enqueued, true)
worker.perform(pipeline_tracker.id, pipeline_tracker.stage, entity.id)
pipeline_tracker.reload
expect(pipeline_tracker.status_name).to eq(:started)
expect(pipeline_tracker.batched).to eq(true)
expect(pipeline_tracker.batches.pluck_batch_numbers).to contain_exactly(1, 2, 3)
expect(described_class.jobs).to be_empty
end
it 'still enqueues only missing pipelines batches' do
create(:bulk_import_batch_tracker, tracker: pipeline_tracker, batch_number: 2)
expect(BulkImports::PipelineBatchWorker).to receive(:perform_async).twice
expect(worker).to receive(:log_extra_metadata_on_done).with(:tracker_batch_numbers_enqueued, [1, 3])
expect(worker).to receive(:log_extra_metadata_on_done).with(:tracker_final_batch_was_enqueued, true)
worker.perform(pipeline_tracker.id, pipeline_tracker.stage, entity.id)
pipeline_tracker.reload
expect(pipeline_tracker.status_name).to eq(:started)
expect(pipeline_tracker.batched).to eq(true)
expect(pipeline_tracker.batches.pluck_batch_numbers).to contain_exactly(1, 2, 3)
expect(described_class.jobs).to be_empty
end
end
end
end
end
end
|