Merge branch 'mr-diff-data' into 'master'

Impove diff discussion data

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

app/assets/javascripts/diffs/components/app.vue

@@ -41,6 +41,11 @@ export default {
       required: true,
     },
   },
+  data() {
+    return {
+      assignedDiscussions: false,
+    };
+  },
   computed: {
     ...mapState({
       isLoading: state => state.diffs.isLoading,
@@ -58,9 +63,9 @@ export default {
       plainDiffPath: state => state.diffs.plainDiffPath,
       emailPatchPath: state => state.diffs.emailPatchPath,
     }),
-    ...mapState('diffs', ['showTreeList']),
+    ...mapState('diffs', ['showTreeList', 'isLoading']),
     ...mapGetters('diffs', ['isParallelView']),
-    ...mapGetters(['isNotesFetched', 'discussionsStructuredByLineCode']),
+    ...mapGetters(['isNotesFetched', 'getNoteableData']),
     targetBranch() {
       return {
         branchName: this.targetBranchName,
@@ -147,11 +152,12 @@ export default {
       }
     },
     setDiscussions() {
-      if (this.isNotesFetched) {
+      if (this.isNotesFetched && !this.assignedDiscussions && !this.isLoading) {
         requestIdleCallback(
-          () => {
-            this.assignDiscussionsToDiff(this.discussionsStructuredByLineCode);
-          },
+          () =>
+            this.assignDiscussionsToDiff().then(() => {
+              this.assignedDiscussions = true;
+            }),
           { timeout: 1000 },
         );
       }

app/assets/javascripts/diffs/components/diff_file.vue

@@ -29,7 +29,7 @@ export default {
   },
   computed: {
     ...mapState('diffs', ['currentDiffFileId']),
-    ...mapGetters(['isNotesFetched', 'discussionsStructuredByLineCode']),
+    ...mapGetters(['isNotesFetched']),
     isCollapsed() {
       return this.file.collapsed || false;
     },
@@ -79,7 +79,7 @@ export default {
         .then(() => {
           requestIdleCallback(
             () => {
-              this.assignDiscussionsToDiff(this.discussionsStructuredByLineCode);
+              this.assignDiscussionsToDiff();
             },
             { timeout: 1000 },
           );

app/assets/javascripts/diffs/store/actions.js

@@ -5,7 +5,6 @@ import createFlash from '~/flash';
 import { s__ } from '~/locale';
 import { handleLocationHash, historyPushState } from '~/lib/utils/common_utils';
 import { mergeUrlParams, getLocationHash } from '~/lib/utils/url_utility';
-import { reduceDiscussionsToLineCodes } from '../../notes/stores/utils';
 import { getDiffPositionByLineCode, getNoteFormData } from './utils';
 import * as types from './mutation_types';
 import {
@@ -36,18 +35,17 @@ export const fetchDiffFiles = ({ state, commit }) => {
 
 // This is adding line discussions to the actual lines in the diff tree
 // once for parallel and once for inline mode
-export const assignDiscussionsToDiff = ({ state, commit }, allLineDiscussions) => {
+export const assignDiscussionsToDiff = (
+  { commit, state, rootState },
+  discussions = rootState.notes.discussions,
+) => {
   const diffPositionByLineCode = getDiffPositionByLineCode(state.diffFiles);
 
-  Object.values(allLineDiscussions).forEach(discussions => {
-    if (discussions.length > 0) {
-      const { fileHash } = discussions[0];
-      commit(types.SET_LINE_DISCUSSIONS_FOR_FILE, {
-        fileHash,
-        discussions,
-        diffPositionByLineCode,
-      });
-    }
+  discussions.filter(discussion => discussion.diff_discussion).forEach(discussion => {
+    commit(types.SET_LINE_DISCUSSIONS_FOR_FILE, {
+      discussion,
+      diffPositionByLineCode,
+    });
   });
 };
 
@@ -190,9 +188,7 @@ export const saveDiffDiscussion = ({ dispatch }, { note, formData }) => {
 
   return dispatch('saveNote', postData, { root: true })
     .then(result => dispatch('updateDiscussion', result.discussion, { root: true }))
-    .then(discussion =>
-      dispatch('assignDiscussionsToDiff', reduceDiscussionsToLineCodes([discussion])),
-    )
+    .then(discussion => dispatch('assignDiscussionsToDiff', [discussion]))
     .catch(() => createFlash(s__('MergeRequests|Saving the comment failed')));
 };
 

app/assets/javascripts/diffs/store/mutations.js

@@ -90,53 +90,67 @@ export default {
     }));
   },
 
-  [types.SET_LINE_DISCUSSIONS_FOR_FILE](state, { fileHash, discussions, diffPositionByLineCode }) {
-    const selectedFile = state.diffFiles.find(f => f.fileHash === fileHash);
-    const firstDiscussion = discussions[0];
-    const isDiffDiscussion = firstDiscussion.diff_discussion;
-    const hasLineCode = firstDiscussion.line_code;
-    const diffPosition = diffPositionByLineCode[firstDiscussion.line_code];
-
-    if (
-      selectedFile &&
-      isDiffDiscussion &&
-      hasLineCode &&
-      diffPosition &&
+  [types.SET_LINE_DISCUSSIONS_FOR_FILE](state, { discussion, diffPositionByLineCode }) {
+    const { latestDiff } = state;
+
+    const discussionLineCode = discussion.line_code;
+    const fileHash = discussion.diff_file.file_hash;
+    const lineCheck = ({ lineCode }) =>
+      lineCode === discussionLineCode &&
       isDiscussionApplicableToLine({
-        discussion: firstDiscussion,
-        diffPosition,
-        latestDiff: state.latestDiff,
-      })
-    ) {
-      const targetLine = selectedFile.parallelDiffLines.find(
-        line =>
-          (line.left && line.left.lineCode === firstDiscussion.line_code) ||
-          (line.right && line.right.lineCode === firstDiscussion.line_code),
-      );
-      if (targetLine) {
-        if (targetLine.left && targetLine.left.lineCode === firstDiscussion.line_code) {
-          Object.assign(targetLine.left, {
-            discussions,
-          });
-        } else {
-          Object.assign(targetLine.right, {
-            discussions,
+        discussion,
+        diffPosition: diffPositionByLineCode[lineCode],
+        latestDiff,
+      });
+
+    state.diffFiles = state.diffFiles.map(diffFile => {
+      if (diffFile.fileHash === fileHash) {
+        const file = { ...diffFile };
+
+        if (file.highlightedDiffLines) {
+          file.highlightedDiffLines = file.highlightedDiffLines.map(line => {
+            if (lineCheck(line)) {
+              return {
+                ...line,
+                discussions: line.discussions.concat(discussion),
+              };
+            }
+
+            return line;
           });
         }
-      }
-
-      if (selectedFile.highlightedDiffLines) {
-        const targetInlineLine = selectedFile.highlightedDiffLines.find(
-          line => line.lineCode === firstDiscussion.line_code,
-        );
 
-        if (targetInlineLine) {
-          Object.assign(targetInlineLine, {
-            discussions,
+        if (file.parallelDiffLines) {
+          file.parallelDiffLines = file.parallelDiffLines.map(line => {
+            const left = line.left && lineCheck(line.left);
+            const right = line.right && lineCheck(line.right);
+
+            if (left || right) {
+              return {
+                left: {
+                  ...line.left,
+                  discussions: left ? line.left.discussions.concat(discussion) : [],
+                },
+                right: {
+                  ...line.right,
+                  discussions: right ? line.right.discussions.concat(discussion) : [],
+                },
+              };
+            }
+
+            return line;
           });
         }
+
+        if (!file.parallelDiffLines || !file.highlightedDiffLines) {
+          file.discussions = file.discussions.concat(discussion);
+        }
+
+        return file;
       }
-    }
+
+      return diffFile;
+    });
   },
 
   [types.REMOVE_LINE_DISCUSSIONS_FOR_FILE](state, { fileHash, lineCode }) {

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

 import _ from 'underscore';
 import * as constants from '../constants';
-import { reduceDiscussionsToLineCodes } from './utils';
 import { collapseSystemNotes } from './collapse_utils';
 
 export const discussions = state => collapseSystemNotes(state.discussions);
@@ -31,9 +30,6 @@ export const notesById = state =>
     return acc;
   }, {});
 
-export const discussionsStructuredByLineCode = state =>
-  reduceDiscussionsToLineCodes(state.discussions);
-
 export const noteableType = state => {
   const { ISSUE_NOTEABLE_TYPE, MERGE_REQUEST_NOTEABLE_TYPE, EPIC_NOTEABLE_TYPE } = constants;
 

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

@@ -25,18 +25,6 @@ export const getQuickActionText = note => {
   return text;
 };
 
-export const reduceDiscussionsToLineCodes = selectedDiscussions =>
-  selectedDiscussions.reduce((acc, note) => {
-    if (note.diff_discussion && note.line_code) {
-      // For context about line notes: there might be multiple notes with the same line code
-      const items = acc[note.line_code] || [];
-      items.push(note);
-
-      Object.assign(acc, { [note.line_code]: items });
-    }
-    return acc;
-  }, {});
-
 export const hasQuickActions = note => REGEX_QUICK_ACTIONS.test(note);
 
 export const stripQuickActions = note => note.replace(REGEX_QUICK_ACTIONS, '').trim();

spec/javascripts/diffs/store/actions_spec.js

@@ -27,7 +27,6 @@ import actions, {
   toggleShowTreeList,
 } from '~/diffs/store/actions';
 import * as types from '~/diffs/store/mutation_types';
-import { reduceDiscussionsToLineCodes } from '~/notes/stores/utils';
 import axios from '~/lib/utils/axios_utils';
 import testAction from '../../helpers/vuex_action_helper';
 
@@ -152,7 +151,7 @@ describe('DiffsStoreActions', () => {
         original_position: diffPosition,
       };
 
-      const discussions = reduceDiscussionsToLineCodes([singleDiscussion]);
+      const discussions = [singleDiscussion];
 
       testAction(
         assignDiscussionsToDiff,
@@ -162,8 +161,7 @@ describe('DiffsStoreActions', () => {
           {
             type: types.SET_LINE_DISCUSSIONS_FOR_FILE,
             payload: {
-              fileHash: 'ABC',
-              discussions: [singleDiscussion],
+              discussion: singleDiscussion,
               diffPositionByLineCode: {
                 ABC_1_1: {
                   baseSha: 'abc',
@@ -581,7 +579,6 @@ describe('DiffsStoreActions', () => {
   describe('saveDiffDiscussion', () => {
     beforeEach(() => {
       spyOnDependency(actions, 'getNoteFormData').and.returnValue('testData');
-      spyOnDependency(actions, 'reduceDiscussionsToLineCodes').and.returnValue('discussions');
     });
 
     it('dispatches actions', done => {
@@ -602,7 +599,7 @@ describe('DiffsStoreActions', () => {
         .then(() => {
           expect(dispatch.calls.argsFor(0)).toEqual(['saveNote', 'testData', { root: true }]);
           expect(dispatch.calls.argsFor(1)).toEqual(['updateDiscussion', 'test', { root: true }]);
-          expect(dispatch.calls.argsFor(2)).toEqual(['assignDiscussionsToDiff', 'discussions']);
+          expect(dispatch.calls.argsFor(2)).toEqual(['assignDiscussionsToDiff', ['discussion']]);
         })
         .then(done)
         .catch(done.fail);

spec/javascripts/diffs/store/mutations_spec.js

@@ -198,40 +198,32 @@ describe('DiffsStoreMutations', () => {
           },
         ],
       };
-      const discussions = [
-        {
-          id: 1,
-          line_code: 'ABC_1',
-          diff_discussion: true,
-          resolvable: true,
-          original_position: diffPosition,
-          position: diffPosition,
+      const discussion = {
+        id: 1,
+        line_code: 'ABC_1',
+        diff_discussion: true,
+        resolvable: true,
+        original_position: diffPosition,
+        position: diffPosition,
+        diff_file: {
+          file_hash: state.diffFiles[0].fileHash,
         },
-        {
-          id: 2,
-          line_code: 'ABC_1',
-          diff_discussion: true,
-          resolvable: true,
-          original_position: diffPosition,
-          position: diffPosition,
-        },
-      ];
+      };
 
       const diffPositionByLineCode = {
         ABC_1: diffPosition,
       };
 
       mutations[types.SET_LINE_DISCUSSIONS_FOR_FILE](state, {
-        fileHash: 'ABC',
-        discussions,
+        discussion,
         diffPositionByLineCode,
       });
 
-      expect(state.diffFiles[0].parallelDiffLines[0].left.discussions.length).toEqual(2);
-      expect(state.diffFiles[0].parallelDiffLines[0].left.discussions[1].id).toEqual(2);
+      expect(state.diffFiles[0].parallelDiffLines[0].left.discussions.length).toEqual(1);
+      expect(state.diffFiles[0].parallelDiffLines[0].left.discussions[0].id).toEqual(1);
 
-      expect(state.diffFiles[0].highlightedDiffLines[0].discussions.length).toEqual(2);
-      expect(state.diffFiles[0].highlightedDiffLines[0].discussions[1].id).toEqual(2);
+      expect(state.diffFiles[0].highlightedDiffLines[0].discussions.length).toEqual(1);
+      expect(state.diffFiles[0].highlightedDiffLines[0].discussions[0].id).toEqual(1);
     });
 
     it('should add legacy discussions to the given line', () => {
@@ -272,36 +264,30 @@ describe('DiffsStoreMutations', () => {
           },
         ],
       };
-      const discussions = [
-        {
-          id: 1,
-          line_code: 'ABC_1',
-          diff_discussion: true,
-          active: true,
+      const discussion = {
+        id: 1,
+        line_code: 'ABC_1',
+        diff_discussion: true,
+        active: true,
+        diff_file: {
+          file_hash: state.diffFiles[0].fileHash,
         },
-        {
-          id: 2,
-          line_code: 'ABC_1',
-          diff_discussion: true,
-          active: true,
-        },
-      ];
+      };
 
       const diffPositionByLineCode = {
         ABC_1: diffPosition,
       };
 
       mutations[types.SET_LINE_DISCUSSIONS_FOR_FILE](state, {
-        fileHash: 'ABC',
-        discussions,
+        discussion,
         diffPositionByLineCode,
       });
 
-      expect(state.diffFiles[0].parallelDiffLines[0].left.discussions.length).toEqual(2);
-      expect(state.diffFiles[0].parallelDiffLines[0].left.discussions[1].id).toEqual(2);
+      expect(state.diffFiles[0].parallelDiffLines[0].left.discussions.length).toEqual(1);
+      expect(state.diffFiles[0].parallelDiffLines[0].left.discussions[0].id).toEqual(1);
 
-      expect(state.diffFiles[0].highlightedDiffLines[0].discussions.length).toEqual(2);
-      expect(state.diffFiles[0].highlightedDiffLines[0].discussions[1].id).toEqual(2);
+      expect(state.diffFiles[0].highlightedDiffLines[0].discussions.length).toEqual(1);
+      expect(state.diffFiles[0].highlightedDiffLines[0].discussions[0].id).toEqual(1);
     });
   });