Put pipeline filter by source feature behind a feature flag

Move feature that let users specify `source` as a query parameter to the
pipelines API behind the feature flag named `pipeline_source_filter` so
that it can be quickly disabled if found to be causing performance
issues.
Signed-off-by: Balasankar "Balu" C <balasankar@gitlab.com>

app/finders/ci/pipelines_finder.rb

@@ -23,13 +23,15 @@ module Ci
       items = by_iids(items)
       items = by_scope(items)
       items = by_status(items)
-      items = by_source(items)
       items = by_ref(items)
       items = by_sha(items)
       items = by_name(items)
       items = by_username(items)
       items = by_yaml_errors(items)
       items = by_updated_at(items)
+
+      items = by_source(items) if Feature.enabled?(:pipeline_source_filter, project, default_enabled: :yaml)
+
       sort_items(items)
     end
 

config/feature_flags/development/pipeline_source_filter.yml

+---
+name: pipeline_source_filter
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/67846
+rollout_issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/338347
+milestone: '14.2'
+type: development
+group: group::pipeline execution
+default_enabled: false

lib/api/ci/pipelines.rb

@@ -59,7 +59,7 @@ module API
           authorize! :read_build, user_project
 
           pipelines = ::Ci::PipelinesFinder.new(user_project, current_user, params).execute
-          present paginate(pipelines), with: Entities::Ci::PipelineBasic
+          present paginate(pipelines), with: Entities::Ci::PipelineBasic, project: user_project
         end
 
         desc 'Create a new pipeline' do

lib/api/entities/ci/pipeline_basic.rb

@@ -4,9 +4,11 @@ module API
   module Entities
     module Ci
       class PipelineBasic < Grape::Entity
-        expose :id, :project_id, :sha, :ref, :status, :source
+        expose :id, :project_id, :sha, :ref, :status
         expose :created_at, :updated_at
 
+        expose :source, if: ->(pipeline, options) { ::Feature.enabled?(:pipeline_source_filter, options[:project], default_enabled: :yaml) }
+
         expose :web_url do |pipeline, _options|
           Gitlab::Routing.url_helpers.project_pipeline_url(pipeline.project, pipeline)
         end

spec/finders/ci/pipelines_finder_spec.rb

@@ -252,17 +252,26 @@ RSpec.describe Ci::PipelinesFinder do
       end
     end
 
-    context "when source is specified" do
+    context 'when source is specified' do
       let(:params) { { source: 'web' } }
-      let!(:pipeline) { create(:ci_pipeline, project: project, source: 'web') }
+      let!(:web_pipeline) { create(:ci_pipeline, project: project, source: 'web') }
+      let!(:push_pipeline) { create(:ci_pipeline, project: project, source: 'push') }
+      let!(:api_pipeline) { create(:ci_pipeline, project: project, source: 'api') }
 
-      before do
-        create(:ci_pipeline, project: project, source: 'push')
-        create(:ci_pipeline, project: project, source: 'chat')
+      context 'when `pipeline_source_filter` feature flag is disabled' do
+        before do
+          stub_feature_flags(pipeline_source_filter: false)
+        end
+
+        it 'returns all the pipelines' do
+          is_expected.to contain_exactly(web_pipeline, push_pipeline, api_pipeline)
+        end
       end
 
-      it 'returns matched pipelines' do
-        is_expected.to eq([pipeline])
+      context 'when `pipeline_source_filter` feature flag is enabled' do
+        it 'returns only the matched pipeline' do
+          is_expected.to eq([web_pipeline])
+        end
       end
     end
 

spec/requests/api/ci/pipelines_spec.rb

@@ -34,7 +34,28 @@ RSpec.describe API::Ci::Pipelines do
         expect(json_response.first['sha']).to match(/\A\h{40}\z/)
         expect(json_response.first['id']).to eq pipeline.id
         expect(json_response.first['web_url']).to be_present
-        expect(json_response.first.keys).to contain_exactly(*%w[id project_id sha ref status web_url created_at updated_at source])
+      end
+
+      describe 'keys in the response' do
+        context 'when `pipeline_source_filter` feature flag is disabled' do
+          before do
+            stub_feature_flags(pipeline_source_filter: false)
+          end
+
+          it 'does not includes pipeline source' do
+            get api("/projects/#{project.id}/pipelines", user)
+
+            expect(json_response.first.keys).to contain_exactly(*%w[id project_id sha ref status web_url created_at updated_at])
+          end
+        end
+
+        context 'when `pipeline_source_filter` feature flag is disabled' do
+          it 'includes pipeline source' do
+            get api("/projects/#{project.id}/pipelines", user)
+
+            expect(json_response.first.keys).to contain_exactly(*%w[id project_id sha ref status web_url created_at updated_at source])
+          end
+        end
       end
 
       context 'when parameter is passed' do
@@ -302,21 +323,38 @@ RSpec.describe API::Ci::Pipelines do
             create(:ci_pipeline, project: project, source: :api)
           end
 
-          it 'returns matched pipelines' do
-            get api("/projects/#{project.id}/pipelines", user), params: { source: 'web' }
+          context 'when `pipeline_source_filter` feature flag is disabled' do
+            before do
+              stub_feature_flags(pipeline_source_filter: false)
+            end
 
-            expect(response).to have_gitlab_http_status(:ok)
-            expect(response).to include_pagination_headers
-            expect(json_response).not_to be_empty
-            json_response.each { |r| expect(r['source']).to eq('web') }
+            it 'returns all pipelines' do
+              get api("/projects/#{project.id}/pipelines", user), params: { source: 'web' }
+
+              expect(response).to have_gitlab_http_status(:ok)
+              expect(response).to include_pagination_headers
+              expect(json_response).not_to be_empty
+              expect(json_response.length).to be >= 3
+            end
           end
-        end
 
-        context 'when source is invalid' do
-          it 'returns bad_request' do
-            get api("/projects/#{project.id}/pipelines", user), params: { source: 'invalid-source' }
+          context 'when `pipeline_source_filter` feature flag is enabled' do
+            it 'returns matched pipelines' do
+              get api("/projects/#{project.id}/pipelines", user), params: { source: 'web' }
 
-            expect(response).to have_gitlab_http_status(:bad_request)
+              expect(response).to have_gitlab_http_status(:ok)
+              expect(response).to include_pagination_headers
+              expect(json_response).not_to be_empty
+              json_response.each { |r| expect(r['source']).to eq('web') }
+            end
+
+            context 'when source is invalid' do
+              it 'returns bad_request' do
+                get api("/projects/#{project.id}/pipelines", user), params: { source: 'invalid-source' }
+
+                expect(response).to have_gitlab_http_status(:bad_request)
+              end
+            end
           end
         end
       end