Merge branch '207100-description-diffs-system-notes-shows-only-latest-change' into 'master'

Allow multiple descriptionVersions

See merge request gitlab-org/gitlab!26316

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

@@ -515,7 +515,7 @@ export const removeConvertedDiscussion = ({ commit }, noteId) =>
 export const setCurrentDiscussionId = ({ commit }, discussionId) =>
   commit(types.SET_CURRENT_DISCUSSION_ID, discussionId);
 
-export const fetchDescriptionVersion = ({ dispatch }, { endpoint, startingVersion }) => {
+export const fetchDescriptionVersion = ({ dispatch }, { endpoint, startingVersion, versionId }) => {
   let requestUrl = endpoint;
 
   if (startingVersion) {
@@ -526,7 +526,7 @@ export const fetchDescriptionVersion = ({ dispatch }, { endpoint, startingVersio
   return axios
     .get(requestUrl)
     .then(res => {
-      dispatch('receiveDescriptionVersion', res.data);
+      dispatch('receiveDescriptionVersion', { descriptionVersion: res.data, versionId });
     })
     .catch(error => {
       dispatch('receiveDescriptionVersionError', error);
@@ -544,7 +544,10 @@ export const receiveDescriptionVersionError = ({ commit }, error) => {
   commit(types.RECEIVE_DESCRIPTION_VERSION_ERROR, error);
 };
 
-export const softDeleteDescriptionVersion = ({ dispatch }, { endpoint, startingVersion }) => {
+export const softDeleteDescriptionVersion = (
+  { dispatch },
+  { endpoint, startingVersion, versionId },
+) => {
   let requestUrl = endpoint;
 
   if (startingVersion) {
@@ -555,7 +558,7 @@ export const softDeleteDescriptionVersion = ({ dispatch }, { endpoint, startingV
   return axios
     .delete(requestUrl)
     .then(() => {
-      dispatch('receiveDeleteDescriptionVersion');
+      dispatch('receiveDeleteDescriptionVersion', versionId);
     })
     .catch(error => {
       dispatch('receiveDeleteDescriptionVersionError', error);
@@ -566,8 +569,8 @@ export const softDeleteDescriptionVersion = ({ dispatch }, { endpoint, startingV
 export const requestDeleteDescriptionVersion = ({ commit }) => {
   commit(types.REQUEST_DELETE_DESCRIPTION_VERSION);
 };
-export const receiveDeleteDescriptionVersion = ({ commit }) => {
-  commit(types.RECEIVE_DELETE_DESCRIPTION_VERSION, __('Deleted'));
+export const receiveDeleteDescriptionVersion = ({ commit }, versionId) => {
+  commit(types.RECEIVE_DELETE_DESCRIPTION_VERSION, { [versionId]: __('Deleted') });
 };
 export const receiveDeleteDescriptionVersionError = ({ commit }, error) => {
   commit(types.RECEIVE_DELETE_DESCRIPTION_VERSION_ERROR, error);

app/assets/javascripts/notes/stores/getters.js

@@ -28,7 +28,7 @@ export const getUserData = state => state.userData || {};
 
 export const getUserDataByProp = state => prop => state.userData && state.userData[prop];
 
-export const descriptionVersion = state => state.descriptionVersion;
+export const descriptionVersions = state => state.descriptionVersions;
 
 export const notesById = state =>
   state.discussions.reduce((acc, note) => {

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

@@ -28,7 +28,7 @@ export default () => ({
     commentsDisabled: false,
     resolvableDiscussionsCount: 0,
     unresolvedDiscussionsCount: 0,
-    descriptionVersion: null,
+    descriptionVersions: {},
   },
   actions,
   getters,

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

@@ -288,9 +288,9 @@ export default {
   [types.REQUEST_DESCRIPTION_VERSION](state) {
     state.isLoadingDescriptionVersion = true;
   },
-  [types.RECEIVE_DESCRIPTION_VERSION](state, descriptionVersion) {
-    state.isLoadingDescriptionVersion = false;
-    state.descriptionVersion = descriptionVersion;
+  [types.RECEIVE_DESCRIPTION_VERSION](state, { descriptionVersion, versionId }) {
+    const descriptionVersions = { ...state.descriptionVersions, [versionId]: descriptionVersion };
+    Object.assign(state, { descriptionVersions, isLoadingDescriptionVersion: false });
   },
   [types.RECEIVE_DESCRIPTION_VERSION_ERROR](state) {
     state.isLoadingDescriptionVersion = false;
@@ -300,7 +300,7 @@ export default {
   },
   [types.RECEIVE_DELETE_DESCRIPTION_VERSION](state, descriptionVersion) {
     state.isLoadingDescriptionVersion = false;
-    state.descriptionVersion = descriptionVersion;
+    Object.assign(state.descriptionVersions, descriptionVersion);
   },
   [types.RECEIVE_DELETE_DESCRIPTION_VERSION_ERROR](state) {
     state.isLoadingDescriptionVersion = false;

app/assets/javascripts/vue_shared/components/notes/system_note.vue

@@ -54,7 +54,7 @@ export default {
     };
   },
   computed: {
-    ...mapGetters(['targetNoteHash', 'descriptionVersion']),
+    ...mapGetters(['targetNoteHash', 'descriptionVersions']),
     ...mapState(['isLoadingDescriptionVersion']),
     noteAnchorId() {
       return `note_${this.note.id}`;
@@ -81,6 +81,9 @@ export default {
           .children().length > MAX_VISIBLE_COMMIT_LIST_COUNT
       );
     },
+    descriptionVersion() {
+      return this.descriptionVersions[this.note.description_version_id];
+    },
   },
   mounted() {
     initMRPopovers(this.$el.querySelectorAll('.gfm-merge_request'));

ee/app/assets/javascripts/notes/mixins/description_version_history.js

@@ -25,21 +25,23 @@ export default {
   methods: {
     toggleDescriptionVersion() {
       this.isDescriptionVersionExpanded = !this.isDescriptionVersionExpanded;
+      const versionId = this.note.description_version_id;
 
-      if (this.descriptionVersion) {
+      if (this.descriptionVersions?.[versionId]) {
         return false;
       }
 
       const endpoint = this.note.description_diff_path;
       const startingVersion = this.note.start_description_version_id;
 
-      return this.fetchDescriptionVersion({ endpoint, startingVersion });
+      return this.fetchDescriptionVersion({ endpoint, startingVersion, versionId });
     },
     deleteDescriptionVersion() {
       const endpoint = this.note.delete_description_version_path;
       const startingVersion = this.note.start_description_version_id;
+      const versionId = this.note.description_version_id;
 
-      return this.softDeleteDescriptionVersion({ endpoint, startingVersion });
+      return this.softDeleteDescriptionVersion({ endpoint, startingVersion, versionId });
     },
   },
 };

spec/frontend/notes/stores/getters_spec.js

@@ -35,7 +35,7 @@ describe('Getters Notes Store', () => {
       notesData: notesDataMock,
       userData: userDataMock,
       noteableData: noteableDataMock,
-      descriptionVersion: 'descriptionVersion',
+      descriptionVersions: 'descriptionVersions',
     };
   });
 
@@ -387,9 +387,9 @@ describe('Getters Notes Store', () => {
     });
   });
 
-  describe('descriptionVersion', () => {
-    it('should return `descriptionVersion`', () => {
-      expect(getters.descriptionVersion(state)).toEqual('descriptionVersion');
+  describe('descriptionVersions', () => {
+    it('should return `descriptionVersions`', () => {
+      expect(getters.descriptionVersions(state)).toEqual('descriptionVersions');
     });
   });
 });

spec/frontend/notes/stores/mutation_spec.js

@@ -8,6 +8,7 @@ import {
   userDataMock,
   noteableDataMock,
   individualNote,
+  notesWithDescriptionChanges,
 } from '../mock_data';
 
 const RESOLVED_NOTE = { resolvable: true, resolved: true };
@@ -579,4 +580,27 @@ describe('Notes Store mutations', () => {
       expect(state.convertedDisscussionIds).not.toContain(discussion.id);
     });
   });
+
+  describe('RECEIVE_DESCRIPTION_VERSION', () => {
+    const descriptionVersion = notesWithDescriptionChanges[0].notes[0].note;
+    const versionId = notesWithDescriptionChanges[0].notes[0].id;
+    const state = {};
+
+    it('adds a descriptionVersion', () => {
+      mutations.RECEIVE_DESCRIPTION_VERSION(state, { descriptionVersion, versionId });
+      expect(state.descriptionVersions[versionId]).toBe(descriptionVersion);
+    });
+  });
+
+  describe('RECEIVE_DELETE_DESCRIPTION_VERSION', () => {
+    const descriptionVersion = notesWithDescriptionChanges[0].notes[0].note;
+    const versionId = notesWithDescriptionChanges[0].notes[0].id;
+    const state = { descriptionVersions: { [versionId]: descriptionVersion } };
+    const deleted = 'Deleted';
+
+    it('updates descriptionVersion to "Deleted"', () => {
+      mutations.RECEIVE_DELETE_DESCRIPTION_VERSION(state, { [versionId]: deleted });
+      expect(state.descriptionVersions[versionId]).toBe(deleted);
+    });
+  });
 });