rich
', // Note the leading space }; const correctLine = { foo: 'test', line_code: 'file-hash_5_5', old_line: 5, new_line: 5, rich_text: 'rich
', // Note no leading space discussionsExpanded: true, discussions: [], hasForm: false, text: undefined, alreadyPrepared: true, commentsDisabled: false, problems: { brokenLineCode: false, brokenSymlink: false, fileOnlyMoved: false, }, }; let preppedLine; beforeEach(() => { preppedLine = utils.prepareLineForRenamedFile({ diffViewType: INLINE_DIFF_VIEW_TYPE, line: sourceLine, index: lineIndex, diffFile, }); }); it('copies over the original line object to the new prepared line', () => { expect(preppedLine).toEqual( expect.objectContaining({ foo: correctLine.foo, rich_text: correctLine.rich_text, }), ); }); it('correctly sets the old and new lines, plus a line code', () => { expect(preppedLine.old_line).toEqual(correctLine.old_line); expect(preppedLine.new_line).toEqual(correctLine.new_line); expect(preppedLine.line_code).toEqual(correctLine.line_code); }); it('returns a single object with the correct structure for `inline` lines', () => { expect(preppedLine).toEqual(correctLine); }); it.each` brokenSymlink | renamed | added | removed | lineCode | commentsDisabled ${false} | ${false} | ${0} | ${0} | ${'a'} | ${false} ${{}} | ${false} | ${1} | ${1} | ${'a'} | ${true} ${'truthy'} | ${false} | ${1} | ${1} | ${'a'} | ${true} ${false} | ${true} | ${1} | ${1} | ${'a'} | ${false} ${false} | ${true} | ${1} | ${0} | ${'a'} | ${false} ${false} | ${true} | ${0} | ${1} | ${'a'} | ${false} ${false} | ${true} | ${0} | ${0} | ${'a'} | ${true} `( "properly sets a line's `commentsDisabled` to '$commentsDisabled' for file and line settings { brokenSymlink: $brokenSymlink, renamed: $renamed, added: $added, removed: $removed, line_code: $lineCode }", ({ brokenSymlink, renamed, added, removed, lineCode, commentsDisabled }) => { const line = { ...sourceLine, line_code: lineCode, }; const file = { ...diffFile, brokenSymlink, renamed_file: renamed, added_lines: added, removed_lines: removed, }; const preparedLine = utils.prepareLineForRenamedFile({ index: lineIndex, diffFile: file, line, }); expect(preparedLine.commentsDisabled).toBe(commentsDisabled); }, ); }); describe('prepareDiffData', () => { describe('for regular diff files', () => { let mock; let preparedDiff; let splitInlineDiff; let splitParallelDiff; let completedDiff; beforeEach(() => { mock = getDiffFileMock(); preparedDiff = { diff_files: [mock] }; splitInlineDiff = { diff_files: [{ ...mock }], }; splitParallelDiff = { diff_files: [{ ...mock, [INLINE_DIFF_LINES_KEY]: undefined }], }; completedDiff = { diff_files: [{ ...mock, [INLINE_DIFF_LINES_KEY]: undefined }], }; preparedDiff.diff_files = utils.prepareDiffData({ diff: preparedDiff }); splitInlineDiff.diff_files = utils.prepareDiffData({ diff: splitInlineDiff }); splitParallelDiff.diff_files = utils.prepareDiffData({ diff: splitParallelDiff }); completedDiff.diff_files = utils.prepareDiffData({ diff: completedDiff, priorFiles: [mock], }); }); it('sets the renderIt and collapsed attribute on files', () => { const checkLine = preparedDiff.diff_files[0][INLINE_DIFF_LINES_KEY][0]; expect(checkLine.discussions.length).toBe(0); expect(checkLine).not.toHaveAttr('text'); const firstChar = checkLine.rich_text.charAt(0); expect(firstChar).not.toBe(' '); expect(firstChar).not.toBe('+'); expect(firstChar).not.toBe('-'); expect(preparedDiff.diff_files[0].renderIt).toBe(true); expect(preparedDiff.diff_files[0].collapsed).toBe(false); }); it('guarantees an empty array for both diff styles', () => { expect(splitInlineDiff.diff_files[0][INLINE_DIFF_LINES_KEY].length).toBeGreaterThan(0); expect(splitParallelDiff.diff_files[0][INLINE_DIFF_LINES_KEY].length).toEqual(0); }); it('merges existing diff files with newly loaded diff files to ensure split diffs are eventually completed', () => { expect(completedDiff.diff_files.length).toEqual(1); expect(completedDiff.diff_files[0][INLINE_DIFF_LINES_KEY].length).toBeGreaterThan(0); }); it('leaves files in the existing state', () => { const priorFiles = [mock]; const fakeNewFile = { ...mock, content_sha: 'ABC', file_hash: 'DEF', }; const updatedFilesList = utils.prepareDiffData({ diff: { diff_files: [fakeNewFile] }, priorFiles, }); expect(updatedFilesList).toEqual([mock, fakeNewFile]); }); it('completes an existing split diff without overwriting existing diffs', () => { // The current state has a file that has only loaded inline lines const priorFiles = [{ ...mock }]; // The next (batch) load loads two files: the other half of that file, and a new file const fakeBatch = [ { ...mock, [INLINE_DIFF_LINES_KEY]: undefined }, { ...mock, [INLINE_DIFF_LINES_KEY]: undefined, content_sha: 'ABC', file_hash: 'DEF' }, ]; const updatedFilesList = utils.prepareDiffData({ diff: { diff_files: fakeBatch }, priorFiles, }); expect(updatedFilesList).toEqual([ mock, expect.objectContaining({ content_sha: 'ABC', file_hash: 'DEF', }), ]); }); it('adds the `.brokenSymlink` property to each diff file', () => { preparedDiff.diff_files.forEach((file) => { expect(file).toHaveProperty('brokenSymlink', false); }); }); it("copies the diff file's `.brokenSymlink` value to each of that file's child lines", () => { const lines = [ ...preparedDiff.diff_files, ...splitInlineDiff.diff_files, ...splitParallelDiff.diff_files, ...completedDiff.diff_files, ].flatMap((file) => [...file[INLINE_DIFF_LINES_KEY]]); lines.forEach((line) => { expect(line.problems.brokenSymlink).toBe(false); }); }); }); describe('for diff metadata', () => { let mock; let preparedDiffFiles; beforeEach(() => { mock = getDiffMetadataMock(); preparedDiffFiles = utils.prepareDiffData({ diff: mock, meta: true }); }); it('sets the renderIt and collapsed attribute on files', () => { expect(preparedDiffFiles[0].renderIt).toBe(true); expect(preparedDiffFiles[0].collapsed).toBeUndefined(); }); it('guarantees an empty array of lines for both diff styles', () => { expect(preparedDiffFiles[0][INLINE_DIFF_LINES_KEY].length).toEqual(0); }); it('leaves files in the existing state', () => { const fileMock = getDiffFileMock(); const metaData = getDiffMetadataMock(); const priorFiles = [fileMock]; const updatedFilesList = utils.prepareDiffData({ diff: metaData, priorFiles, meta: true }); expect(updatedFilesList.length).toEqual(2); expect(updatedFilesList[0]).toEqual(fileMock); }); it('adds a new file to the file that already exists in state', () => { // This is actually buggy behavior: // Because the metadata doesn't include a content_sha, // the de-duplicator in prepareDiffData doesn't realize it // should combine these two. // This buggy behavior hasn't caused a defect YET, because // `diffs_metadata.json` is only called the first time the // diffs app starts up, which is: // - after a fresh page load // - after you switch to the changes tab *the first time* // This test should begin FAILING and can be reversed to check // for just a single file when this is implemented: // https://gitlab.com/groups/gitlab-org/-/epics/2852#note_304803233 const fileMock = getDiffFileMock(); const metaMock = getDiffMetadataMock(); const priorFiles = [{ ...fileMock }]; const updatedFilesList = utils.prepareDiffData({ diff: metaMock, priorFiles, meta: true }); expect(updatedFilesList).toEqual([ fileMock, { ...metaMock.diff_files[0], [INLINE_DIFF_LINES_KEY]: [], }, ]); }); it('adds the `.brokenSymlink` property to each meta diff file', () => { preparedDiffFiles.forEach((file) => { expect(file).toMatchObject({ brokenSymlink: false }); }); }); }); }); describe('isDiscussionApplicableToLine', () => { const diffPosition = { baseSha: 'ed13df29948c41ba367caa757ab3ec4892509910', headSha: 'b921914f9a834ac47e6fd9420f78db0f83559130', newLine: null, newPath: '500-lines-4.txt', oldLine: 5, oldPath: '500-lines-4.txt', startSha: 'ed13df29948c41ba367caa757ab3ec4892509910', }; const wrongDiffPosition = { baseSha: 'wrong', headSha: 'wrong', newLine: null, newPath: '500-lines-4.txt', oldLine: 5, oldPath: '500-lines-4.txt', startSha: 'wrong', }; const discussions = { upToDateDiscussion1: { original_position: diffPosition, position: wrongDiffPosition, }, outDatedDiscussion1: { original_position: wrongDiffPosition, position: wrongDiffPosition, }, }; // When multi line comments are fully implemented `line_code` will be // included in all requests. Until then we need to ensure the logic does // not change when it is included only in the "comparison" argument. const lineRange = { start: { line_code: 'abc_1_1' }, end: { line_code: 'abc_1_2' } }; it('returns true when the discussion is up to date', () => { expect( utils.isDiscussionApplicableToLine({ discussion: discussions.upToDateDiscussion1, diffPosition: { ...diffPosition, line_range: lineRange }, latestDiff: true, }), ).toBe(true); }); it('returns false when the discussion is not up to date', () => { expect( utils.isDiscussionApplicableToLine({ discussion: discussions.outDatedDiscussion1, diffPosition: { ...diffPosition, line_range: lineRange }, latestDiff: true, }), ).toBe(false); }); it('returns true when line codes match and discussion does not contain position and is not active', () => { const discussion = { ...discussions.outDatedDiscussion1, line_code: 'ABC_1', active: false }; delete discussion.original_position; delete discussion.position; expect( utils.isDiscussionApplicableToLine({ discussion, diffPosition: { ...diffPosition, lineCode: 'ABC_1', line_range: lineRange, }, latestDiff: true, }), ).toBe(false); }); it('returns true when line codes match and discussion does not contain position and is active', () => { const discussion = { ...discussions.outDatedDiscussion1, line_code: 'ABC_1', active: true }; delete discussion.original_position; delete discussion.position; expect( utils.isDiscussionApplicableToLine({ discussion, diffPosition: { ...diffPosition, line_code: 'ABC_1', line_range: lineRange, }, latestDiff: true, }), ).toBe(true); }); it('returns false when not latest diff', () => { const discussion = { ...discussions.outDatedDiscussion1, line_code: 'ABC_1', active: true }; delete discussion.original_position; delete discussion.position; expect( utils.isDiscussionApplicableToLine({ discussion, diffPosition: { ...diffPosition, lineCode: 'ABC_1', line_range: lineRange, }, latestDiff: false, }), ).toBe(false); }); }); describe('getDiffMode', () => { it('returns mode when matched in file', () => { expect( utils.getDiffMode({ renamed_file: true, }), ).toBe('renamed'); }); it('returns mode_changed if key has no match', () => { expect( utils.getDiffMode({ viewer: { name: 'mode_changed' }, }), ).toBe('mode_changed'); }); it('defaults to replaced', () => { expect(utils.getDiffMode({})).toBe('replaced'); }); }); describe('convertExpandLines', () => { it('converts expanded lines to normal lines', () => { const diffLines = [ { type: 'match', old_line: 1, new_line: 1, }, { type: '', old_line: 2, new_line: 2, }, ]; const lines = utils.convertExpandLines({ diffLines, data: [{ text: 'expanded' }], typeKey: 'type', oldLineKey: 'old_line', newLineKey: 'new_line', mapLine: ({ line, oldLine, newLine }) => ({ ...line, old_line: oldLine, new_line: newLine, }), }); expect(lines).toEqual([ { text: 'expanded', new_line: 1, old_line: 1, discussions: [], hasForm: false, }, { type: '', old_line: 2, new_line: 2, }, ]); }); }); describe('isAdded', () => { it.each` type | expected ${'new'} | ${true} ${'new-nonewline'} | ${true} ${'old'} | ${false} `('returns $expected when type is $type', ({ type, expected }) => { expect(utils.isAdded({ type })).toBe(expected); }); }); describe('isRemoved', () => { it.each` type | expected ${'old'} | ${true} ${'old-nonewline'} | ${true} ${'new'} | ${false} `('returns $expected when type is $type', ({ type, expected }) => { expect(utils.isRemoved({ type })).toBe(expected); }); }); describe('isUnchanged', () => { it.each` type | expected ${null} | ${true} ${'new'} | ${false} ${'old'} | ${false} `('returns $expected when type is $type', ({ type, expected }) => { expect(utils.isUnchanged({ type })).toBe(expected); }); }); describe('isMeta', () => { it.each` type | expected ${'match'} | ${true} ${'new-nonewline'} | ${true} ${'old-nonewline'} | ${true} ${'new'} | ${false} `('returns $expected when type is $type', ({ type, expected }) => { expect(utils.isMeta({ type })).toBe(expected); }); }); describe('isConflictMarker', () => { it.each` type | expected ${'conflict_marker_our'} | ${true} ${'conflict_marker_their'} | ${true} ${'conflict_their'} | ${false} ${'conflict_our'} | ${false} `('returns $expected when type is $type', ({ type, expected }) => { expect(utils.isConflictMarker({ type })).toBe(expected); }); }); describe('isConflictOur', () => { it.each` type | expected ${'conflict_marker_our'} | ${false} ${'conflict_marker_their'} | ${false} ${'conflict_their'} | ${false} ${'conflict_our'} | ${true} `('returns $expected when type is $type', ({ type, expected }) => { expect(utils.isConflictOur({ type })).toBe(expected); }); }); describe('isConflictTheir', () => { it.each` type | expected ${'conflict_marker_our'} | ${false} ${'conflict_marker_their'} | ${false} ${'conflict_their'} | ${true} ${'conflict_our'} | ${false} `('returns $expected when type is $type', ({ type, expected }) => { expect(utils.isConflictTheir({ type })).toBe(expected); }); }); describe('parallelizeDiffLines', () => { it('converts inline diff lines to parallel diff lines', () => { const file = getDiffFileMock(); expect(utils.parallelizeDiffLines(file[INLINE_DIFF_LINES_KEY])).toMatchObject( file.parallel_diff_lines, ); }); it('converts conflicted diffs line', () => { const lines = [ { type: 'new' }, { type: 'conflict_marker_our' }, { type: 'conflict_our' }, { type: 'conflict_marker' }, { type: 'conflict_their' }, { type: 'conflict_marker_their' }, ]; expect(utils.parallelizeDiffLines(lines)).toEqual([ { left: null, right: { chunk: 0, type: 'new', }, }, { left: { chunk: 0, type: 'conflict_marker_our' }, right: { chunk: 0, type: 'conflict_marker_their' }, }, { left: { chunk: 0, type: 'conflict_our' }, right: { chunk: 0, type: 'conflict_their' }, }, ]); }); it('converts inline diff lines', () => { const file = getDiffFileMock(); const files = utils.parallelizeDiffLines(file.highlighted_diff_lines, true); expect(files[5].left).toMatchObject(file.parallel_diff_lines[5].left); expect(files[5].right).toBeNull(); expect(files[6].left).toMatchObject(file.parallel_diff_lines[5].right); expect(files[6].right).toBeNull(); }); }); describe('isUrlHashNoteLink', () => { it.each` input | bool ${'#note_12345'} | ${true} ${'#12345'} | ${false} ${'note_12345'} | ${true} ${'12345'} | ${false} `('returns $bool for $input', ({ bool, input }) => { expect(utils.isUrlHashNoteLink(input)).toBe(bool); }); }); describe('isUrlHashFileHeader', () => { it.each` input | bool ${'#diff-content-12345'} | ${true} ${'#12345'} | ${false} ${'diff-content-12345'} | ${true} ${'12345'} | ${false} `('returns $bool for $input', ({ bool, input }) => { expect(utils.isUrlHashFileHeader(input)).toBe(bool); }); }); describe('parseUrlHashAsFileHash', () => { it.each` input | currentDiffId | resultId ${'#note_12345'} | ${'1A2B3C'} | ${'1A2B3C'} ${'note_12345'} | ${'1A2B3C'} | ${'1A2B3C'} ${'#note_12345'} | ${undefined} | ${null} ${'note_12345'} | ${undefined} | ${null} ${'#diff-content-12345'} | ${undefined} | ${'12345'} ${'diff-content-12345'} | ${undefined} | ${'12345'} ${'#diff-content-12345'} | ${'98765'} | ${'12345'} ${'diff-content-12345'} | ${'98765'} | ${'12345'} ${'#e334a2a10f036c00151a04cea7938a5d4213a818'} | ${undefined} | ${'e334a2a10f036c00151a04cea7938a5d4213a818'} ${'e334a2a10f036c00151a04cea7938a5d4213a818'} | ${undefined} | ${'e334a2a10f036c00151a04cea7938a5d4213a818'} ${'#Z334a2a10f036c00151a04cea7938a5d4213a818'} | ${undefined} | ${null} ${'Z334a2a10f036c00151a04cea7938a5d4213a818'} | ${undefined} | ${null} `('returns $resultId for $input and $currentDiffId', ({ input, currentDiffId, resultId }) => { expect(utils.parseUrlHashAsFileHash(input, currentDiffId)).toBe(resultId); }); }); describe('markTreeEntriesLoaded', () => { it.each` desc | entries | loaded | outcome ${'marks an existing entry as loaded'} | ${{ abc: {} }} | ${[{ new_path: 'abc' }]} | ${{ abc: { diffLoaded: true } }} ${'does nothing if the new file is not found in the tree entries'} | ${{ abc: {} }} | ${[{ new_path: 'def' }]} | ${{ abc: {} }} ${'leaves entries unmodified if they are not in the loaded files'} | ${{ abc: {}, def: { diffLoaded: true }, ghi: {} }} | ${[{ new_path: 'ghi' }]} | ${{ abc: {}, def: { diffLoaded: true }, ghi: { diffLoaded: true } }} `('$desc', ({ entries, loaded, outcome }) => { expect(utils.markTreeEntriesLoaded({ priorEntries: entries, loadedFiles: loaded })).toEqual( outcome, ); }); }); });