Merge branch 'backstage/gb/improve-jobs-controller-performance' into 'master'57694-documentation-for-graphql

Improve performance of jobs controller show

Closes #60708

See merge request gitlab-org/gitlab-ce!28093

3 files changed, 79 insertions, 2 deletions

diff --git a/spec/serializers/build_details_entity_spec.rb b/spec/serializers/build_details_entity_spec.rb
index 1edf69dc290..9c2e5c79a9d 100644
--- a/spec/serializers/build_details_entity_spec.rb
+++ b/spec/serializers/build_details_entity_spec.rb
@@ -122,5 +122,29 @@ describe BuildDetailsEntity do
 
       it { is_expected.to include(failure_reason: 'unmet_prerequisites') }
     end
+
+    context 'when a build has environment with latest deployment' do
+      let(:build) do
+        create(:ci_build, :running, environment: environment.name, pipeline: pipeline)
+      end
+
+      let(:environment) do
+        create(:environment, project: project, name: 'staging', state: :available)
+      end
+
+      before do
+        create(:deployment, :success, environment: environment, project: project)
+
+        allow(request).to receive(:project).and_return(project)
+      end
+
+      it 'does not serialize latest deployment commit and associated builds' do
+        response = subject.with_indifferent_access
+
+        response.dig(:deployment_status, :environment, :last_deployment).tap do |deployment|
+          expect(deployment).not_to include(:commit, :manual_actions, :scheduled_actions)
+        end
+      end
+    end
   end
 end
diff --git a/spec/serializers/deployment_entity_spec.rb b/spec/serializers/deployment_entity_spec.rb
index 894fd7a0a12..76ad2aee5c5 100644
--- a/spec/serializers/deployment_entity_spec.rb
+++ b/spec/serializers/deployment_entity_spec.rb
@@ -10,6 +10,7 @@ describe DeploymentEntity do
   let(:build) { create(:ci_build, :manual, pipeline: pipeline) }
   let(:pipeline) { create(:ci_pipeline, project: project, user: user) }
   let(:entity) { described_class.new(deployment, request: request) }
+
   subject { entity.as_json }
 
   before do
@@ -47,6 +48,16 @@ describe DeploymentEntity do
         expect(subject[:manual_actions]).not_to be_present
       end
     end
+
+    context 'when deployment details serialization was disabled' do
+      let(:entity) do
+        described_class.new(deployment, request: request, deployment_details: false)
+      end
+
+      it 'does not serialize manual actions details' do
+        expect(subject.with_indifferent_access).not_to include(:manual_actions)
+      end
+    end
   end
 
   describe 'scheduled_actions' do
@@ -69,5 +80,35 @@ describe DeploymentEntity do
         expect(subject[:scheduled_actions]).to be_empty
       end
     end
+
+    context 'when deployment details serialization was disabled' do
+      let(:entity) do
+        described_class.new(deployment, request: request, deployment_details: false)
+      end
+
+      it 'does not serialize scheduled actions details' do
+        expect(subject.with_indifferent_access).not_to include(:scheduled_actions)
+      end
+    end
+  end
+
+  context 'when deployment details serialization was disabled' do
+    include Gitlab::Routing
+
+    let(:entity) do
+      described_class.new(deployment, request: request, deployment_details: false)
+    end
+
+    it 'does not serialize deployment details' do
+      expect(subject.with_indifferent_access)
+        .not_to include(:commit, :manual_actions, :scheduled_actions)
+    end
+
+    it 'only exposes deployable name and path' do
+      project_job_path(project, deployment.deployable).tap do |path|
+        expect(subject.fetch(:deployable))
+          .to eq(name: 'test', build_path: path)
+      end
+    end
   end
 end
diff --git a/spec/serializers/pipeline_entity_spec.rb b/spec/serializers/pipeline_entity_spec.rb
index 47f767ae4ab..6be612ec226 100644
--- a/spec/serializers/pipeline_entity_spec.rb
+++ b/spec/serializers/pipeline_entity_spec.rb
@@ -48,8 +48,8 @@ describe PipelineEntity do
       it 'contains flags' do
         expect(subject).to include :flags
         expect(subject[:flags])
-          .to include :latest, :stuck, :auto_devops,
-                      :yaml_errors, :retryable, :cancelable, :merge_request
+          .to include :stuck, :auto_devops, :yaml_errors,
+                      :retryable, :cancelable, :merge_request
       end
     end
 
@@ -64,6 +64,12 @@ describe PipelineEntity do
         create(:ci_build, :failed, pipeline: pipeline)
       end
 
+      it 'does not serialize stage builds' do
+        subject.with_indifferent_access.dig(:details, :stages, 0).tap do |stage|
+          expect(stage).not_to include(:groups, :latest_statuses, :retries)
+        end
+      end
+
       context 'user has ability to retry pipeline' do
         before do
           project.add_developer(user)
@@ -92,6 +98,12 @@ describe PipelineEntity do
         create(:ci_build, :pending, pipeline: pipeline)
       end
 
+      it 'does not serialize stage builds' do
+        subject.with_indifferent_access.dig(:details, :stages, 0).tap do |stage|
+          expect(stage).not_to include(:groups, :latest_statuses, :retries)
+        end
+      end
+
       context 'user has ability to cancel pipeline' do
         before do
           project.add_developer(user)