Merge branch 'jm-feature-flag-index-circuit-breakers' into 'master'

Add feature flag for index circuit breakers

See merge request https://gitlab.com/gitlab-org/gitlab/-/merge_requests/168566



Merged-by: Terri Chu <tchu@gitlab.com>
Approved-by: Terri Chu <tchu@gitlab.com>
Reviewed-by: Terri Chu <tchu@gitlab.com>
Co-authored-by: John Mason <9717668-johnmason@users.noreply.gitlab.com>
Co-authored-by: John Mason <jmason@gitlab.com>

ee/app/services/search/zoekt/indexing_task_service.rb

@@ -28,13 +28,7 @@ def execute
         current_task_type = random_force_reindexing? ? :force_index_repo : task_type
         Router.fetch_indices_for_indexing(project_id, root_namespace_id: root_namespace_id).find_each do |idx|
-          # Note: we skip indexing tasks depending on storage watermark levels.
-          #
-          # If the low watermark is exceeded, we don't allow any new initial indexing tasks through,
-          # but we permit incremental indexing or force reindexing for existing repos.
-          #
-          # If the high watermark is exceeded, we don't allow any indexing tasks at all anymore.
-          if idx.high_watermark_exceeded? || (idx.low_watermark_exceeded? && initial_indexing?)
+          if index_circuit_breaker_enabled? && index_circuit_broken?(idx)
             IndexingTaskWorker.perform_in(WATERMARK_RESCHEDULE_INTERVAL, project_id, task_type, { index_id: idx.id })
             logger.info(
               build_structured_payload(
@@ -92,6 +86,20 @@ def random_force_reindexing?
       def eligible_for_force_reindexing?
         task_type == :index_repo && Feature.enabled?(:zoekt_random_force_reindexing, project, type: :ops)
       end
+
+      def index_circuit_broken?(idx)
+        # Note: we skip indexing tasks depending on storage watermark levels.
+        #
+        # If the low watermark is exceeded, we don't allow any new initial indexing tasks through,
+        # but we permit incremental indexing or force reindexing for existing repos.
+        #
+        # If the high watermark is exceeded, we don't allow any indexing tasks at all anymore.
+        idx.high_watermark_exceeded? || (idx.low_watermark_exceeded? && initial_indexing?)
+      end
+
+      def index_circuit_breaker_enabled?
+        Feature.enabled?(:zoekt_index_circuit_breaker, ::Project.actor_from_id(project_id), type: :ops)
+      end
     end
   end
 end

ee/config/feature_flags/ops/zoekt_index_circuit_breaker.yml

+---
+name: zoekt_index_circuit_breaker
+feature_issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/494260
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/168566
+rollout_issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/498316
+milestone: '17.5'
+group: group::global search
+type: ops
+default_enabled: false

ee/spec/services/search/zoekt/indexing_task_service_spec.rb

@@ -20,6 +20,18 @@
   end
   describe '#execute' do
+    RSpec.shared_examples 'creates a task when circuit breaker is disabled' do
+      context 'with index circuit breaker feature flag disabled' do
+        before do
+          stub_feature_flags(zoekt_index_circuit_breaker: false)
+        end
+
+        it 'creates Search::Zoekt::Task record' do
+          expect { service.execute }.to change { Search::Zoekt::Task.count }.by(1)
+        end
+      end
+    end
+
     context 'when a watermark is exceeded' do
       let(:service) { described_class.new(project.id, task_type) }
       let(:task_type) { :index_repo }
@@ -49,6 +61,8 @@
             service.execute
           end
+
+          it_behaves_like 'creates a task when circuit breaker is disabled'
         end
         context 'with force reindexing' do
@@ -67,6 +81,8 @@
               service.execute
             end
+
+            it_behaves_like 'creates a task when circuit breaker is disabled'
           end
           context 'when a repo already exists' do
@@ -75,6 +91,8 @@
               create(:zoekt_repository, project: project, zoekt_index: zoekt_index, state: repo_state)
             end
+            it_behaves_like 'creates a task when circuit breaker is disabled'
+
             context 'and is ready' do
               let_it_be(:repo_state) { ::Search::Zoekt::Repository.states.fetch(:ready) }
@@ -90,6 +108,8 @@
                 service.execute
               end
+
+              it_behaves_like 'creates a task when circuit breaker is disabled'
             end
             context 'and is not ready' do
@@ -107,6 +127,8 @@
                 service.execute
               end
+
+              it_behaves_like 'creates a task when circuit breaker is disabled'
             end
           end
         end
@@ -131,6 +153,8 @@
         it 'does not create Search::Zoekt::Task record' do
           expect { service.execute }.not_to change { Search::Zoekt::Task.count }
         end
+
+        it_behaves_like 'creates a task when circuit breaker is disabled'
       end
     end