From aaaf5ec21424dbda1a168808faf4a4b3e19a3f23 Mon Sep 17 00:00:00 2001
From: Phil Hughes <me@iamphill.com>
Date: Wed, 5 Mar 2025 12:02:35 +0000
Subject: [PATCH] Show ready to merge badge on merge request dashboard

Updates the merge request status badge on the dashboard to show a
`Ready to merge` badge when all merge checks have passed.

https://gitlab.com/gitlab-org/gitlab/-/issues/518710
---
 .../components/merge_requests_query.vue       |  2 ++
 .../components/status_badge.vue               | 16 ++++++++++++
 .../merge_request_dashboard/index.js          |  1 +
 .../queries/assignee.query.graphql            |  1 +
 .../assignee_or_reviewer.query.graphql        |  1 +
 .../queries/merge_request.fragment.graphql    |  3 +++
 .../queries/reviewer.query.graphql            |  1 +
 app/views/dashboard/merge_requests.html.haml  |  2 +-
 .../merge_request_dashboard_merge_checks.yml  |  9 +++++++
 locale/gitlab.pot                             |  3 +++
 .../components/merge_requests_query_spec.js   |  2 ++
 .../components/status_badge_spec.js           | 25 +++++++++++++++++++
 12 files changed, 65 insertions(+), 1 deletion(-)
 create mode 100644 config/feature_flags/gitlab_com_derisk/merge_request_dashboard_merge_checks.yml

diff --git a/app/assets/javascripts/merge_request_dashboard/components/merge_requests_query.vue b/app/assets/javascripts/merge_request_dashboard/components/merge_requests_query.vue
index 8b615900784852..aaeaab1042cb6a 100644
--- a/app/assets/javascripts/merge_request_dashboard/components/merge_requests_query.vue
+++ b/app/assets/javascripts/merge_request_dashboard/components/merge_requests_query.vue
@@ -15,6 +15,7 @@ export default {
       variables() {
         return {
           ...this.variables,
+          includeMergeabilityChecks: this.showMergeChecksSuccess,
           perPage: PER_PAGE,
         };
       },
@@ -43,6 +44,7 @@ export default {
       },
     },
   },
+  inject: { showMergeChecksSuccess: { default: false } },
   props: {
     query: {
       type: String,
diff --git a/app/assets/javascripts/merge_request_dashboard/components/status_badge.vue b/app/assets/javascripts/merge_request_dashboard/components/status_badge.vue
index 3663b0739c5697..c651fdab28e740 100644
--- a/app/assets/javascripts/merge_request_dashboard/components/status_badge.vue
+++ b/app/assets/javascripts/merge_request_dashboard/components/status_badge.vue
@@ -1,5 +1,6 @@
 <script>
 import { GlBadge, GlTooltipDirective as GlTooltip } from '@gitlab/ui';
+import { __ } from '~/locale';
 import { TYPENAME_USER } from '~/graphql_shared/constants';
 import { convertToGraphQLId } from '~/graphql_shared/utils';
 import { BADGE_METHODS } from '../utils/status_badge';
@@ -29,6 +30,21 @@ export default {
       return this.mergeRequest.reviewers.nodes.find((r) => r.id === this.currentUserId);
     },
     badgeData() {
+      if (this.mergeRequest.mergeabilityChecks) {
+        const failedChecks = this.mergeRequest.mergeabilityChecks.filter(
+          ({ status }) => status === 'FAILED',
+        );
+
+        if (failedChecks.length === 0) {
+          return {
+            icon: 'status-success',
+            variant: 'success',
+            text: __('Ready to merge'),
+            iconOpticallyAligned: true,
+          };
+        }
+      }
+
       return BADGE_METHODS[this.listId]?.(this);
     },
   },
diff --git a/app/assets/javascripts/merge_request_dashboard/index.js b/app/assets/javascripts/merge_request_dashboard/index.js
index d79d9ec7f99031..263a2a181fcd36 100644
--- a/app/assets/javascripts/merge_request_dashboard/index.js
+++ b/app/assets/javascripts/merge_request_dashboard/index.js
@@ -97,6 +97,7 @@ export function initMergeRequestDashboard(el) {
     apolloProvider,
     provide: {
       mergeRequestsSearchDashboardPath: el.dataset.mergeRequestsSearchDashboardPath,
+      showMergeChecksSuccess: el.dataset.showMergeChecksSuccess === 'true',
     },
     render(createElement) {
       return createElement(App, {
diff --git a/app/assets/javascripts/merge_request_dashboard/queries/assignee.query.graphql b/app/assets/javascripts/merge_request_dashboard/queries/assignee.query.graphql
index df1f8659f94059..f57c243bd976ae 100644
--- a/app/assets/javascripts/merge_request_dashboard/queries/assignee.query.graphql
+++ b/app/assets/javascripts/merge_request_dashboard/queries/assignee.query.graphql
@@ -11,6 +11,7 @@ query requestingReview(
   $perPage: Int!
   $afterCursor: String
   $sort: MergeRequestSort = UPDATED_DESC
+  $includeMergeabilityChecks: Boolean = false
 ) {
   currentUser {
     id
diff --git a/app/assets/javascripts/merge_request_dashboard/queries/assignee_or_reviewer.query.graphql b/app/assets/javascripts/merge_request_dashboard/queries/assignee_or_reviewer.query.graphql
index 98b46e4f846aae..f91071c99fa337 100644
--- a/app/assets/javascripts/merge_request_dashboard/queries/assignee_or_reviewer.query.graphql
+++ b/app/assets/javascripts/merge_request_dashboard/queries/assignee_or_reviewer.query.graphql
@@ -10,6 +10,7 @@ query assigneeOrReviewer(
   $perPage: Int!
   $afterCursor: String
   $sort: MergeRequestSort = UPDATED_DESC
+  $includeMergeabilityChecks: Boolean = false
 ) {
   currentUser {
     id
diff --git a/app/assets/javascripts/merge_request_dashboard/queries/merge_request.fragment.graphql b/app/assets/javascripts/merge_request_dashboard/queries/merge_request.fragment.graphql
index 11e31234408d03..b7bedc6652280c 100644
--- a/app/assets/javascripts/merge_request_dashboard/queries/merge_request.fragment.graphql
+++ b/app/assets/javascripts/merge_request_dashboard/queries/merge_request.fragment.graphql
@@ -56,5 +56,8 @@ fragment MergeRequestDashboardFragment on MergeRequest {
   mergedAt
   createdAt
   updatedAt
+  mergeabilityChecks @include(if: $includeMergeabilityChecks) {
+    status
+  }
   ...MergeRequestApprovalFragment
 }
diff --git a/app/assets/javascripts/merge_request_dashboard/queries/reviewer.query.graphql b/app/assets/javascripts/merge_request_dashboard/queries/reviewer.query.graphql
index a5a8ab22451b2e..e31220e11366b7 100644
--- a/app/assets/javascripts/merge_request_dashboard/queries/reviewer.query.graphql
+++ b/app/assets/javascripts/merge_request_dashboard/queries/reviewer.query.graphql
@@ -10,6 +10,7 @@ query reviewRequests(
   $perPage: Int!
   $afterCursor: String
   $sort: MergeRequestSort = UPDATED_DESC
+  $includeMergeabilityChecks: Boolean = false
 ) {
   currentUser {
     id
diff --git a/app/views/dashboard/merge_requests.html.haml b/app/views/dashboard/merge_requests.html.haml
index 51c675699bac6e..f4e899b217215a 100644
--- a/app/views/dashboard/merge_requests.html.haml
+++ b/app/views/dashboard/merge_requests.html.haml
@@ -28,7 +28,7 @@
       #js-merge-request-dashboard-config
 
 - if merge_request_dashboard_enabled?(current_user) && !current_page?(merge_requests_search_dashboard_path)
-  #js-merge-request-dashboard{ data: { base_path: merge_requests_dashboard_path, merge_requests_search_dashboard_path: merge_requests_search_dashboard_path(assignee_username: current_user.username), initial_data: merge_request_dashboard_data.to_json } }
+  #js-merge-request-dashboard{ data: { base_path: merge_requests_dashboard_path, merge_requests_search_dashboard_path: merge_requests_search_dashboard_path(assignee_username: current_user.username), initial_data: merge_request_dashboard_data.to_json, show_merge_checks_success: Feature.enabled?(:merge_request_dashboard_merge_checks, current_user, type: :gitlab_com_derisk).to_s } }
     = gl_loading_icon(size: 'lg')
 
 - if !merge_request_dashboard_enabled?(current_user) || current_page?(merge_requests_search_dashboard_path)
diff --git a/config/feature_flags/gitlab_com_derisk/merge_request_dashboard_merge_checks.yml b/config/feature_flags/gitlab_com_derisk/merge_request_dashboard_merge_checks.yml
new file mode 100644
index 00000000000000..aa894badc54a22
--- /dev/null
+++ b/config/feature_flags/gitlab_com_derisk/merge_request_dashboard_merge_checks.yml
@@ -0,0 +1,9 @@
+---
+name: merge_request_dashboard_merge_checks
+feature_issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/518710
+introduced_by_url:
+rollout_issue_url:
+milestone: '17.10'
+group: group::code review
+type: gitlab_com_derisk
+default_enabled: false
diff --git a/locale/gitlab.pot b/locale/gitlab.pot
index df5c363339231b..64980f04b79154 100644
--- a/locale/gitlab.pot
+++ b/locale/gitlab.pot
@@ -47748,6 +47748,9 @@ msgstr ""
 msgid "Ready to get started with GitLab? Follow these steps to get familiar with us:"
 msgstr ""
 
+msgid "Ready to merge"
+msgstr ""
+
 msgid "Ready to merge by members who can write to the target branch."
 msgstr ""
 
diff --git a/spec/frontend/merge_request_dashboard/components/merge_requests_query_spec.js b/spec/frontend/merge_request_dashboard/components/merge_requests_query_spec.js
index 4d3633e7964065..69863abc8ea66e 100644
--- a/spec/frontend/merge_request_dashboard/components/merge_requests_query_spec.js
+++ b/spec/frontend/merge_request_dashboard/components/merge_requests_query_spec.js
@@ -96,6 +96,7 @@ describe('Merge requests query component', () => {
       perPage: 20,
       state: 'opened',
       sort: 'UPDATED_DESC',
+      includeMergeabilityChecks: false,
     });
   });
 
@@ -108,6 +109,7 @@ describe('Merge requests query component', () => {
       perPage: 20,
       state: 'opened',
       sort: 'UPDATED_DESC',
+      includeMergeabilityChecks: false,
     });
   });
 
diff --git a/spec/frontend/merge_request_dashboard/components/status_badge_spec.js b/spec/frontend/merge_request_dashboard/components/status_badge_spec.js
index 5fd7043c4fe67e..e22fc734b77d37 100644
--- a/spec/frontend/merge_request_dashboard/components/status_badge_spec.js
+++ b/spec/frontend/merge_request_dashboard/components/status_badge_spec.js
@@ -46,4 +46,29 @@ describe('Merge request status badge component', () => {
 
     expect(findStatusBadge().element).toMatchSnapshot();
   });
+
+  describe('ready to merge', () => {
+    it('renders ready to merge badge when there is no failed merge checks', () => {
+      createComponent({
+        mergeRequest: {
+          mergeabilityChecks: [{ status: 'SUCCESS' }],
+        },
+      });
+
+      expect(findStatusBadge().text()).toBe('Ready to merge');
+      expect(findStatusBadge().attributes('icon')).toBe('status-success');
+    });
+
+    it('renders normal status badge when there is failed merge checks', () => {
+      createComponent({
+        mergeRequest: {
+          mergeabilityChecks: [{ status: 'FAILED' }],
+          reviewers: { nodes: [] },
+        },
+        listId: 'assigned_to_you',
+      });
+
+      expect(findStatusBadge().text()).toBe('Reviewers needed');
+    });
+  });
 });
-- 
GitLab