Merge branch 'tor/defect/overview-placeholder-message/endpoint-state' into 'master'

Add metadata endpoints to MR Notes app

See merge request gitlab-org/gitlab!56575

app/assets/javascripts/mr_notes/init_notes.js

@@ -25,6 +25,9 @@ export default () => {
 
       return {
         noteableData,
+        endpoints: {
+          metadata: notesDataset.endpointMetadata,
+        },
         currentUserData: JSON.parse(notesDataset.currentUserData),
         notesData: JSON.parse(notesDataset.notesData),
         helpPagePath: notesDataset.helpPagePath,
@@ -54,6 +57,7 @@ export default () => {
     },
     created() {
       this.setActiveTab(window.mrTabs.getCurrentAction());
+      this.setEndpoints(this.endpoints);
     },
     mounted() {
       this.notesCountBadge = $('.issuable-details').find('.notes-tab .badge');
@@ -65,7 +69,7 @@ export default () => {
       window.mrTabs.eventHub.$off('MergeRequestTabChange', this.setActiveTab);
     },
     methods: {
-      ...mapActions(['setActiveTab']),
+      ...mapActions(['setActiveTab', 'setEndpoints']),
       updateDiscussionTabCounter() {
         this.notesCountBadge.text(this.discussionTabCounter);
       },

app/assets/javascripts/mr_notes/stores/actions.js

 import types from './mutation_types';
 
-export default {
-  setActiveTab({ commit }, tab) {
+export function setActiveTab({ commit }, tab) {
   commit(types.SET_ACTIVE_TAB, tab);
-  },
-};
+}
+
+export function setEndpoints({ commit }, endpoints) {
+  commit(types.SET_ENDPOINTS, endpoints);
+}

app/assets/javascripts/mr_notes/stores/modules/index.js

-import actions from '../actions';
+import * as actions from '../actions';
 import getters from '../getters';
 import mutations from '../mutations';
 
 export default () => ({
   state: {
+    endpoints: {},
     activeTab: null,
   },
   actions,

app/assets/javascripts/mr_notes/stores/mutation_types.js

 export default {
   SET_ACTIVE_TAB: 'SET_ACTIVE_TAB',
+  SET_ENDPOINTS: 'SET_ENDPOINTS',
 };

app/assets/javascripts/mr_notes/stores/mutations.js

@@ -4,4 +4,7 @@ export default {
   [types.SET_ACTIVE_TAB](state, tab) {
     Object.assign(state, { activeTab: tab });
   },
+  [types.SET_ENDPOINTS](state, endpoints) {
+    Object.assign(state, { endpoints });
+  },
 };

app/views/projects/merge_requests/show.html.haml

@@ -13,6 +13,8 @@
 - add_page_specific_style 'page_bundles/reports'
 - add_page_specific_style 'page_bundles/ci_status'
 
+- add_page_startup_api_call @endpoint_metadata_url
+
 .merge-request{ data: { mr_action: mr_action, url: merge_request_path(@merge_request, format: :json), project_path: project_path(@merge_request.project), lock_version: @merge_request.lock_version } }
   = render "projects/merge_requests/mr_title"
 
@@ -63,6 +65,7 @@
                 - add_page_startup_api_call widget_project_json_merge_request_path(@project, @merge_request, format: :json)
                 - add_page_startup_api_call cached_widget_project_json_merge_request_path(@project, @merge_request, format: :json)
               #js-vue-mr-discussions{ data: { notes_data: notes_data(@merge_request, Feature.enabled?(:paginated_notes, @project)).to_json,
+                endpoint_metadata: @endpoint_metadata_url,
                 noteable_data: serialize_issuable(@merge_request, serializer: 'noteable'),
                 noteable_type: 'MergeRequest',
                 target_type: 'merge_request',
@@ -75,8 +78,6 @@
       = render "projects/merge_requests/tabs/pane", name: "pipelines", id: "pipelines", class: "pipelines" do
         - if number_of_pipelines.nonzero?
           = render 'projects/commit/pipelines_list', disable_initialization: true, endpoint: pipelines_project_merge_request_path(@project, @merge_request)
-      - if mr_action === "diffs"
-        - add_page_startup_api_call @endpoint_metadata_url
       - params = request.query_parameters
       - if Feature.enabled?(:default_merge_ref_for_diffs, @project, default_enabled: :yaml)
         - params = params.merge(diff_head: true)

spec/frontend/mr_notes/stores/actions_spec.js

+import testAction from 'helpers/vuex_action_helper';
+import { setEndpoints } from '~/mr_notes/stores/actions';
+import mutationTypes from '~/mr_notes/stores/mutation_types';
+
+describe('MR Notes Mutator Actions', () => {
+  describe('setEndpoints', () => {
+    it('should trigger the SET_ENDPOINTS state mutation', (done) => {
+      const endpoints = { endpointA: 'a' };
+
+      testAction(
+        setEndpoints,
+        endpoints,
+        {},
+        [
+          {
+            type: mutationTypes.SET_ENDPOINTS,
+            payload: endpoints,
+          },
+        ],
+        [],
+        done,
+      );
+    });
+  });
+});

spec/frontend/mr_notes/stores/mutations_spec.js

+import mutationTypes from '~/mr_notes/stores/mutation_types';
+import mutations from '~/mr_notes/stores/mutations';
+
+describe('MR Notes Mutations', () => {
+  describe(mutationTypes.SET_ENDPOINTS, () => {
+    it('should set the endpoints value', () => {
+      const state = {};
+      const endpoints = { endpointA: 'A', endpointB: 'B' };
+
+      mutations[mutationTypes.SET_ENDPOINTS](state, endpoints);
+
+      expect(state.endpoints).toEqual(endpoints);
+    });
+  });
+});