diff --git a/ee/elastic/docs/20230911205548_remove_leftover_commits_from_main_index.yml b/ee/elastic/docs/20230911205548_remove_leftover_commits_from_main_index.yml
index 79c2676f1337389f8926415c7cf7fdff19b2573a..40f1373b3c6ae66564ca13db4a6e91fd789c2fea 100644
--- a/ee/elastic/docs/20230911205548_remove_leftover_commits_from_main_index.yml
+++ b/ee/elastic/docs/20230911205548_remove_leftover_commits_from_main_index.yml
@@ -5,6 +5,6 @@ description: This migration will remove leftover commits documents from the main
group: group::global search
milestone: '16.4'
introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/130197
-obsolete: false
-marked_obsolete_by_url:
-marked_obsolete_in_milestone:
+obsolete: true
+marked_obsolete_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/159919
+marked_obsolete_in_milestone: '17.3'
diff --git a/ee/elastic/migrate/20230911205548_remove_leftover_commits_from_main_index.rb b/ee/elastic/migrate/20230911205548_remove_leftover_commits_from_main_index.rb
index cde79591ed196d9ffff18a40297bfbdd4950f819..cf06ed51015878b370ee8ea4ee1504123342395c 100644
--- a/ee/elastic/migrate/20230911205548_remove_leftover_commits_from_main_index.rb
+++ b/ee/elastic/migrate/20230911205548_remove_leftover_commits_from_main_index.rb
@@ -62,3 +62,5 @@ def document_type
:commit
end
end
+
+RemoveLeftoverCommitsFromMainIndex.prepend ::Elastic::MigrationObsolete
diff --git a/ee/spec/elastic/migrate/20230911205548_remove_leftover_commits_from_main_index_spec.rb b/ee/spec/elastic/migrate/20230911205548_remove_leftover_commits_from_main_index_spec.rb
index 6cf441d95542f2e123869f24b89a26ad21be737a..40485a8afb407613612e1e823e72c306dbf6e314 100644
--- a/ee/spec/elastic/migrate/20230911205548_remove_leftover_commits_from_main_index_spec.rb
+++ b/ee/spec/elastic/migrate/20230911205548_remove_leftover_commits_from_main_index_spec.rb
@@ -4,155 +4,5 @@
require File.expand_path('ee/elastic/migrate/20230911205548_remove_leftover_commits_from_main_index.rb')
RSpec.describe RemoveLeftoverCommitsFromMainIndex, feature_category: :global_search do
- let(:version) { 20230911205548 }
- let(:migration) { described_class.new(version) }
- let(:helper) { Gitlab::Elastic::Helper.new }
- let_it_be_with_reload(:projects) { create_list(:project, 3, :repository) }
-
- before do
- stub_ee_application_setting(elasticsearch_search: true, elasticsearch_indexing: true)
- allow(migration).to receive(:helper).and_return(helper)
- end
-
- describe 'migration_options' do
- it 'has migration options set', :aggregate_failures do
- expect(migration.batched?).to be_truthy
- expect(migration).to be_retry_on_failure
- expect(migration.batch_size).to eq(2000)
- end
- end
-
- describe '.migrate', :elastic, :sidekiq_inline do
- let(:client) { ::Gitlab::Search::Client.new }
-
- before do
- allow(migration).to receive(:client).and_return(client)
- allow(migration).to receive(:batch_size).and_return(2)
- projects.each { |p| populate_commits_in_main_index!(p) }
- end
-
- context 'when commits are still present in the index' do
- it 'removes commits from the index', quarantine: 'https://gitlab.com/gitlab-org/gitlab/-/issues/451693' do
- expect(migration.completed?).to be_falsey
- migration.migrate
- expect(migration.migration_state).to match(documents_remaining: anything, task_id: anything)
- # the migration might not complete after the initial task is created
- # so make sure it actually completes
- 10.times do
- migration.migrate
- break if migration.completed?
-
- sleep 0.01
- end
-
- migration.migrate # To set a pristine state
- expect(migration.completed?).to be_truthy
- expect(migration.migration_state).to match(task_id: nil, documents_remaining: 0)
- end
-
- context 'and task in progress' do
- before do
- allow(migration).to receive(:completed?).and_return(false)
- allow(migration).to receive(:client).and_return(client)
- allow(helper).to receive(:task_status).and_return('completed' => false)
- migration.set_migration_state(task_id: 'task_1')
- end
-
- it 'does nothing if task is not completed' do
- migration.migrate
- expect(client).not_to receive(:delete_by_query)
- end
- end
- end
-
- context 'when migration fails' do
- context 'and exception is raised' do
- before do
- allow(client).to receive(:delete_by_query).and_raise(StandardError)
- end
-
- it 'resets task_id' do
- migration.set_migration_state(task_id: 'task_1')
- expect { migration.migrate }.to raise_error(StandardError)
- expect(migration.migration_state).to match(task_id: nil, documents_remaining: anything)
- end
- end
-
- context 'and es responds with errors' do
- before do
- allow(client).to receive(:delete_by_query).and_return('task' => 'task_1')
- allow(migration).to receive(:get_number_of_shards).and_return(1)
- end
-
- context 'when a task throws an error' do
- before do
- allow(helper).to receive(:task_status).and_return('error' => ['failed'])
- migration.migrate
- end
-
- it 'resets task_id' do
- expect { migration.migrate }.to raise_error(/Failed to delete commits/)
- expect(migration.migration_state).to match(task_id: nil, documents_remaining: anything)
- end
- end
-
- context 'when delete_by_query throws an error' do
- before do
- allow(client).to receive(:delete_by_query).and_return('failures' => ['failed'])
- end
-
- it 'resets task_id' do
- expect { migration.migrate }.to raise_error(/Failed to delete commits/)
- expect(migration.migration_state).to match(task_id: nil, documents_remaining: anything)
- end
- end
- end
- end
-
- context 'when commits are already deleted' do
- before do
- client.delete_by_query(index: helper.target_name, refresh: true,
- body: { query: { bool: { filter: { term: { type: 'commit' } } } } })
- end
-
- it 'does not execute delete_by_query' do
- expect(migration.completed?).to be_truthy
- expect(helper.client).not_to receive(:delete_by_query)
- migration.migrate
- end
- end
-
- def populate_commits_in_main_index!(project)
- client.index(index: helper.target_name, routing: "project_#{project.id}", refresh: true,
- body: { commit: { type: 'commit',
- author: { name: 'F L', email: 't@t.com', time: Time.now.strftime('%Y%m%dT%H%M%S+0000') },
- committer: { name: 'F L', email: 't@t.com', time: Time.now.strftime('%Y%m%dT%H%M%S+0000') },
- rid: project.id, message: 'test' },
- join_field: { name: 'commit', parent: "project_#{project.id}" },
- repository_access_level: project.repository_access_level, type: 'commit',
- visibility_level: project.visibility_level })
- end
- end
-
- describe '.completed?' do
- context 'when original_documents_count is zero' do
- before do
- allow(migration).to receive(:original_documents_count).and_return 0
- end
-
- it 'returns true' do
- expect(migration.completed?).to eq true
- end
- end
-
- context 'when original_documents_count is non zero' do
- before do
- allow(migration).to receive(:original_documents_count).and_return 1
- end
-
- it 'returns false' do
- expect(migration.completed?).to eq false
- end
- end
- end
+ it_behaves_like 'a deprecated Advanced Search migration', 20230911205548
end