Draft: Save and reset pause indexing state during migrations
What does this MR do?
Related to #332602 (closed)
During Advanced Search migrations, indexing was only paused if the migration needed the indexing paused. However, this caused issues if the migration did not require pausing AND indexing was paused prior to the migrations being run. Having indexing paused in that scenario caused the migration to run forever and never finish (as indexed documents built up in the queue but were never indexed).
This change saves the pause indexing state before running the migration, unpauses or pauses indexing depending on what the migration requires, and resets it back to the initial state once the migration is completed.
How to test
Note: Make sure Elasticsearch is setup in gdk, Advanced Search is enabled and the projects/data are indexed.
- Navigate to the Admin Settings - Settings - Advanced Search Settings screen
- Pause Elasticsearch indexing, save, and verify that
Pause Elasticsearch indexing
is checked - Create a new migration file under
/ee/elastic/migrate
(see example below for what I used) - Refresh the Advanced Search Settings page and verify that
Pause Elasticsearch indexing
is checked and disabled - Open rails console
- Start a Migration Worker
Elastic::MigrationWorker.perform_async
- Refresh the Advanced Search Settings page and verify that
Pause Elasticsearch indexing
is unchecked and disabled - change the migration
completed?
to return true - Start a Migration Worker
Elastic::MigrationWorker.perform_async
- Refresh the Advanced Search Settings page and verify that
Pause Elasticsearch indexing
is checked (reset back to original setting) and enabled
example migration
# frozen_string_literal: true
class TestMigration < Elastic::Migration
batched!
throttle_delay 10.seconds
def migrate
# no op
log "Pause index setting: #{Gitlab::CurrentSettings.elasticsearch_pause_indexing?}"
end
def completed?
false
end
end
Screenshots (strongly suggested)
Does this MR meet the acceptance criteria?
Conformity
-
I have included changelog trailers, or none are needed. (Does this MR need a changelog?) -
I have added/updated documentation, or it's not needed. (Is documentation required?) -
I have properly separated EE content from FOSS, or this MR is FOSS only. (Where should EE code go?) -
I have added information for database reviewers in the MR description, or it's not needed. (Does this MR have database related changes?) -
I have self-reviewed this MR per code review guidelines. -
This MR does not harm performance, or I have asked a reviewer to help assess the performance impact. (Merge request performance guidelines) -
I have followed the style guides. -
This change is backwards compatible across updates, or this does not apply.
Availability and Testing
-
I have added/updated tests following the Testing Guide, or it's not needed. (Consider all test levels. See the Test Planning Process.) -
I have tested this MR in all supported browsers, or it's not needed. -
I have informed the Infrastructure department of a default or new setting change per definition of done, or it's not needed.
Security
Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.
-
Label as security and @ mention @gitlab-com/gl-security/appsec
-
The MR includes necessary changes to maintain consistency between UI, API, email, or other methods -
Security reports checked/validated by a reviewer from the AppSec team