Merge branch '51112-add-status-illustration-in-job-api' into 'master'

Add empty state illustration information in job API

Closes #51112

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

13 files changed, 77 insertions, 31 deletions

diff --git a/app/serializers/status_entity.rb b/app/serializers/detailed_status_entity.rb
index 306c30f0323..c772c807f76 100644
--- a/app/serializers/status_entity.rb
+++ b/app/serializers/detailed_status_entity.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class StatusEntity < Grape::Entity
+class DetailedStatusEntity < Grape::Entity
   include RequestAwareEntity
 
   expose :icon, :text, :label, :group
@@ -8,6 +8,14 @@ class StatusEntity < Grape::Entity
   expose :has_details?, as: :has_details
   expose :details_path
 
+  expose :illustration do |status|
+    begin
+      status.illustration
+    rescue NotImplementedError
+      # ignored
+    end
+  end
+
   expose :favicon do |status|
     Gitlab::Favicon.status_overlay(status.favicon)
   end
diff --git a/app/serializers/job_entity.rb b/app/serializers/job_entity.rb
index 7bc1d87dea5..26b29993fec 100644
--- a/app/serializers/job_entity.rb
+++ b/app/serializers/job_entity.rb
@@ -27,7 +27,7 @@ class JobEntity < Grape::Entity
   expose :playable?, as: :playable
   expose :created_at
   expose :updated_at
-  expose :detailed_status, as: :status, with: StatusEntity
+  expose :detailed_status, as: :status, with: DetailedStatusEntity
   expose :callout_message, if: -> (*) { failed? && !build.script_failure? }
   expose :recoverable, if: -> (*) { failed? }
 
diff --git a/app/serializers/job_group_entity.rb b/app/serializers/job_group_entity.rb
index 0941a9d36be..0db7624b3f7 100644
--- a/app/serializers/job_group_entity.rb
+++ b/app/serializers/job_group_entity.rb
@@ -5,7 +5,7 @@ class JobGroupEntity < Grape::Entity
 
   expose :name
   expose :size
-  expose :detailed_status, as: :status, with: StatusEntity
+  expose :detailed_status, as: :status, with: DetailedStatusEntity
   expose :jobs, with: JobEntity
 
   private
diff --git a/app/serializers/pipeline_entity.rb b/app/serializers/pipeline_entity.rb
index 6cf1925adda..aef838409e0 100644
--- a/app/serializers/pipeline_entity.rb
+++ b/app/serializers/pipeline_entity.rb
@@ -30,7 +30,7 @@ class PipelineEntity < Grape::Entity
   end
 
   expose :details do
-    expose :detailed_status, as: :status, with: StatusEntity
+    expose :detailed_status, as: :status, with: DetailedStatusEntity
     expose :duration
     expose :finished_at
   end
diff --git a/app/serializers/stage_entity.rb b/app/serializers/stage_entity.rb
index 00e6d32ee3a..ca8fa7e7877 100644
--- a/app/serializers/stage_entity.rb
+++ b/app/serializers/stage_entity.rb
@@ -19,7 +19,7 @@ class StageEntity < Grape::Entity
     latest_statuses
   end
 
-  expose :detailed_status, as: :status, with: StatusEntity
+  expose :detailed_status, as: :status, with: DetailedStatusEntity
 
   expose :path do |stage|
     project_pipeline_path(
diff --git a/changelogs/unreleased/51112-add-status-illustration-in-job-api.yml b/changelogs/unreleased/51112-add-status-illustration-in-job-api.yml
new file mode 100644
index 00000000000..fdc75e28824
--- /dev/null
+++ b/changelogs/unreleased/51112-add-status-illustration-in-job-api.yml
@@ -0,0 +1,5 @@
+---
+title: Add empty state illustration information in job API
+merge_request: 21532
+author:
+type: other
diff --git a/spec/controllers/projects/jobs_controller_spec.rb b/spec/controllers/projects/jobs_controller_spec.rb
index 751919f9501..8b6903011c3 100644
--- a/spec/controllers/projects/jobs_controller_spec.rb
+++ b/spec/controllers/projects/jobs_controller_spec.rb
@@ -194,6 +194,18 @@ describe Projects::JobsController, :clean_gitlab_redis_shared_state do
           expect(json_response['terminal_path']).to match(%r{/terminal})
         end
       end
+
+      context 'when job passed with no trace' do
+        let(:job) { create(:ci_build, :success, :artifacts, pipeline: pipeline) }
+
+        it 'exposes empty state illustrations' do
+          expect(response).to have_gitlab_http_status(:ok)
+          expect(response).to match_response_schema('job/job_details')
+          expect(json_response['status']['illustration']).to have_key('image')
+          expect(json_response['status']['illustration']).to have_key('size')
+          expect(json_response['status']['illustration']).to have_key('title')
+        end
+      end
     end
 
     def get_show(**extra_params)
diff --git a/spec/fixtures/api/schemas/job/job.json b/spec/fixtures/api/schemas/job/job.json
index c793d93c0f6..f5d58b21e3d 100644
--- a/spec/fixtures/api/schemas/job/job.json
+++ b/spec/fixtures/api/schemas/job/job.json
@@ -25,7 +25,7 @@
     "playable": { "type": "boolean" },
     "created_at": { "type": "string" },
     "updated_at": { "type": "string" },
-    "status": { "$ref": "../ci_detailed_status.json" }
+    "status": { "$ref": "../status/ci_detailed_status.json" }
   },
   "additionalProperties": true
 }
diff --git a/spec/fixtures/api/schemas/pipeline_stage.json b/spec/fixtures/api/schemas/pipeline_stage.json
index eb2667295f0..f72988a3d3d 100644
--- a/spec/fixtures/api/schemas/pipeline_stage.json
+++ b/spec/fixtures/api/schemas/pipeline_stage.json
@@ -16,7 +16,7 @@
       "items": { "$ref": "job/job.json" },
       "optional": true
     },
-    "status": { "$ref": "ci_detailed_status.json" },
+    "status": { "$ref": "status/ci_detailed_status.json" },
     "path": { "type": "string" },
     "dropdown_path": { "type": "string" }
   },
diff --git a/spec/fixtures/api/schemas/status/action.json b/spec/fixtures/api/schemas/status/action.json
new file mode 100644
index 00000000000..99a576e6c5b
--- /dev/null
+++ b/spec/fixtures/api/schemas/status/action.json
@@ -0,0 +1,22 @@
+{
+  "type": "object",
+  "required": [
+    "icon",
+    "title",
+    "path",
+    "method"
+  ],
+  "properties": {
+    "icon": {
+      "type": "string",
+      "enum": [
+        "retry",
+        "play",
+        "cancel"
+      ]
+    },
+    "title": { "type": "string" },
+    "path": { "type": "string" },
+    "method": { "$ref": "../http_method.json" }
+  }
+}
diff --git a/spec/fixtures/api/schemas/ci_detailed_status.json b/spec/fixtures/api/schemas/status/ci_detailed_status.json
index d74248eabef..8d0f1e4a6af 100644
--- a/spec/fixtures/api/schemas/ci_detailed_status.json
+++ b/spec/fixtures/api/schemas/status/ci_detailed_status.json
@@ -1,6 +1,6 @@
 {
   "type": "object",
-  "required" : [
+  "required": [
     "icon",
     "text",
     "label",
@@ -19,28 +19,8 @@
     "has_details": { "type": "boolean" },
     "details_path": { "type": "string" },
     "favicon": { "type": "string" },
-    "action": {
-      "type": "object",
-      "required": [
-        "icon",
-        "title",
-        "path",
-        "method"
-      ],
-      "properties": {
-        "icon": {
-          "type": "string",
-          "enum": [
-            "retry",
-            "play",
-            "cancel"
-          ]
-        },
-        "title": { "type": "string" },
-        "path": { "type": "string" },
-        "method": { "$ref": "http_method.json" }
-      }
-    }
+    "illustration": { "$ref": "illustration.json" },
+    "action": { "$ref": "action.json" }
   },
   "additionalProperties": false
 }
diff --git a/spec/fixtures/api/schemas/status/illustration.json b/spec/fixtures/api/schemas/status/illustration.json
new file mode 100644
index 00000000000..9a085f5f1ee
--- /dev/null
+++ b/spec/fixtures/api/schemas/status/illustration.json
@@ -0,0 +1,19 @@
+{
+  "oneOf": [
+    { "type": "null" },
+    {
+      "type": "object",
+      "required": [
+        "image",
+        "size",
+        "title"
+      ],
+      "properties": {
+        "image": { "type": "string" },
+        "size": { "type": "string" },
+        "title": { "type": "string" },
+        "content": { "type": "string" }
+      }
+    }
+  ]
+}
diff --git a/spec/serializers/status_entity_spec.rb b/spec/serializers/detailed_status_entity_spec.rb
index 0b010ebd507..62f57ca8689 100644
--- a/spec/serializers/status_entity_spec.rb
+++ b/spec/serializers/detailed_status_entity_spec.rb
@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe StatusEntity do
+describe DetailedStatusEntity do
   let(:entity) { described_class.new(status) }
 
   let(:status) do