import { mount } from '@vue/test-utils'; import Vue, { nextTick } from 'vue'; import Vuex from 'vuex'; import { GlAvatar } from '@gitlab/ui'; import waitForPromises from 'helpers/wait_for_promises'; import DiffsModule from '~/diffs/store/modules'; import NoteActions from '~/notes/components/note_actions.vue'; import NoteBody from '~/notes/components/note_body.vue'; import NoteHeader from '~/notes/components/note_header.vue'; import issueNote from '~/notes/components/noteable_note.vue'; import NotesModule from '~/notes/stores/modules'; import { NOTEABLE_TYPE_MAPPING } from '~/notes/constants'; import { noteableDataMock, notesDataMock, note } from '../mock_data'; Vue.use(Vuex); const singleLineNotePosition = { line_range: { start: { line_code: 'abc_1_1', type: null, old_line: '1', new_line: '1', }, end: { line_code: 'abc_1_1', type: null, old_line: '1', new_line: '1', }, }, }; describe('issue_note', () => { let store; let wrapper; const REPORT_ABUSE_PATH = '/abuse_reports/add_category'; const findMultilineComment = () => wrapper.find('[data-testid="multiline-comment"]'); const createWrapper = (props = {}, storeUpdater = (s) => s) => { store = new Vuex.Store( storeUpdater({ modules: { notes: NotesModule(), diffs: DiffsModule(), }, }), ); store.dispatch('setNoteableData', noteableDataMock); store.dispatch('setNotesData', notesDataMock); wrapper = mount(issueNote, { store, propsData: { note, ...props, }, stubs: [ 'note-header', 'user-avatar-link', 'note-actions', 'note-body', 'multiline-comment-form', ], provide: { reportAbusePath: REPORT_ABUSE_PATH, }, }); }; describe('mutiline comments', () => { beforeEach(() => { createWrapper(); }); it('should render if has multiline comment', async () => { const position = { line_range: { start: { line_code: 'abc_1_1', type: null, old_line: '1', new_line: '1', }, end: { line_code: 'abc_2_2', type: null, old_line: '2', new_line: '2', }, }, }; const line = { line_code: 'abc_1_1', type: null, old_line: '1', new_line: '1', }; wrapper.setProps({ note: { ...note, position }, discussionRoot: true, line, }); await nextTick(); expect(findMultilineComment().text()).toBe('Comment on lines 1 to 2'); }); it('should only render if it has everything it needs', async () => { const position = { line_range: { start: { line_code: 'abc_1_1', type: null, old_line: '', new_line: '', }, end: { line_code: 'abc_2_2', type: null, old_line: '2', new_line: '2', }, }, }; const line = { line_code: 'abc_1_1', type: null, old_line: '1', new_line: '1', }; wrapper.setProps({ note: { ...note, position }, discussionRoot: true, line, }); await nextTick(); expect(findMultilineComment().exists()).toBe(false); }); it('should not render if has single line comment', async () => { const position = { line_range: { start: { line_code: 'abc_1_1', type: null, old_line: '1', new_line: '1', }, end: { line_code: 'abc_1_1', type: null, old_line: '1', new_line: '1', }, }, }; const line = { line_code: 'abc_1_1', type: null, old_line: '1', new_line: '1', }; wrapper.setProps({ note: { ...note, position }, discussionRoot: true, line, }); await nextTick(); expect(findMultilineComment().exists()).toBe(false); }); it('should not render if `line_range` is unavailable', () => { expect(findMultilineComment().exists()).toBe(false); }); }); describe('rendering', () => { beforeEach(() => { createWrapper(); }); describe('avatar sizes in diffs', () => { const line = { line_code: 'abc_1_1', type: null, old_line: '1', new_line: '1', }; it('should render 24px avatars', async () => { wrapper.setProps({ note: { ...note }, discussionRoot: true, line, }); await nextTick(); const avatar = wrapper.findComponent(GlAvatar); const avatarProps = avatar.props(); expect(avatarProps.size).toBe(24); }); }); it('should render user avatar', () => { const { author } = note; const avatar = wrapper.findComponent(GlAvatar); const avatarProps = avatar.props(); expect(avatarProps.src).toBe(author.avatar_url); expect(avatarProps.entityName).toBe(author.username); expect(avatarProps.alt).toBe(author.name); expect(avatarProps.size).toEqual(32); }); it('should render note header content', () => { const noteHeader = wrapper.findComponent(NoteHeader); const noteHeaderProps = noteHeader.props(); expect(noteHeaderProps.author).toBe(note.author); expect(noteHeaderProps.createdAt).toBe(note.created_at); expect(noteHeaderProps.noteId).toBe(note.id); expect(noteHeaderProps.noteableType).toBe(NOTEABLE_TYPE_MAPPING[note.noteable_type]); }); it('should render note actions', () => { const { author } = note; const noteActions = wrapper.findComponent(NoteActions); const noteActionsProps = noteActions.props(); expect(noteActionsProps.authorId).toBe(author.id); expect(noteActionsProps.noteId).toBe(note.id); expect(noteActionsProps.noteUrl).toBe(note.noteable_note_url); expect(noteActionsProps.accessLevel).toBe(note.human_access); expect(noteActionsProps.canEdit).toBe(note.current_user.can_edit); expect(noteActionsProps.canAwardEmoji).toBe(note.current_user.can_award_emoji); expect(noteActionsProps.canDelete).toBe(note.current_user.can_edit); expect(noteActionsProps.canReportAsAbuse).toBe(true); expect(noteActionsProps.canResolve).toBe(false); expect(noteActionsProps.resolvable).toBe(false); expect(noteActionsProps.isResolved).toBe(false); expect(noteActionsProps.isResolving).toBe(false); expect(noteActionsProps.resolvedBy).toEqual({}); }); it('should render issue body', () => { const noteBody = wrapper.findComponent(NoteBody); const noteBodyProps = noteBody.props(); expect(noteBodyProps.note).toBe(note); expect(noteBodyProps.line).toBe(null); expect(noteBodyProps.canEdit).toBe(note.current_user.can_edit); expect(noteBodyProps.isEditing).toBe(false); expect(noteBodyProps.helpPagePath).toBe(''); }); it('prevents note preview xss', async () => { const noteBody = ''; const alertSpy = jest.spyOn(window, 'alert').mockImplementation(() => {}); const noteBodyComponent = wrapper.findComponent(NoteBody); store.hotUpdate({ modules: { notes: { actions: { updateNote() {}, setSelectedCommentPositionHover() {}, }, }, }, }); noteBodyComponent.vm.$emit('handleFormUpdate', { noteText: noteBody, parentElement: null, callback: () => {}, }); await waitForPromises(); expect(alertSpy).not.toHaveBeenCalled(); expect(wrapper.vm.note.note_html).toBe( '', ); }); }); describe('internal note', () => { it('has internal note class for internal notes', () => { createWrapper({ note: { ...note, internal: true } }); expect(wrapper.classes()).toContain('internal-note'); }); it('does not have internal note class for external notes', () => { createWrapper({ note }); expect(wrapper.classes()).not.toContain('internal-note'); }); }); describe('cancel edit', () => { beforeEach(() => { createWrapper(); }); it('restores content of updated note', async () => { const updatedText = 'updated note text'; store.hotUpdate({ modules: { notes: { actions: { updateNote() {}, }, }, }, }); const noteBody = wrapper.findComponent(NoteBody); noteBody.vm.resetAutoSave = () => {}; noteBody.vm.$emit('handleFormUpdate', { noteText: updatedText, parentElement: null, callback: () => {}, }); await nextTick(); let noteBodyProps = noteBody.props(); expect(noteBodyProps.note.note_html).toBe(`

${updatedText}

\n`); noteBody.vm.$emit('cancelForm', {}); await nextTick(); noteBodyProps = noteBody.props(); expect(noteBodyProps.note.note_html).toBe(note.note_html); }); }); describe('formUpdateHandler', () => { const updateNote = jest.fn(); const params = { noteText: '', parentElement: null, callback: jest.fn(), resolveDiscussion: false, }; const updateActions = () => { store.hotUpdate({ modules: { notes: { actions: { updateNote, setSelectedCommentPositionHover() {}, }, }, }, }); }; afterEach(() => updateNote.mockReset()); it('responds to handleFormUpdate', () => { createWrapper(); updateActions(); wrapper.findComponent(NoteBody).vm.$emit('handleFormUpdate', params); expect(wrapper.emitted('handleUpdateNote')).toHaveLength(1); }); it('should not update note with sensitive token', () => { const sensitiveMessage = 'token: glpat-1234567890abcdefghij'; createWrapper(); updateActions(); wrapper .findComponent(NoteBody) .vm.$emit('handleFormUpdate', { ...params, noteText: sensitiveMessage }); expect(updateNote).not.toHaveBeenCalled(); }); it('does not stringify empty position', () => { createWrapper(); updateActions(); wrapper.findComponent(NoteBody).vm.$emit('handleFormUpdate', params); expect(updateNote.mock.calls[0][1].note.note.position).toBeUndefined(); }); it('stringifies populated position', () => { const position = { test: true }; const expectation = JSON.stringify(position); createWrapper({ note: { ...note, position } }); updateActions(); wrapper.findComponent(NoteBody).vm.$emit('handleFormUpdate', params); expect(updateNote.mock.calls[0][1].note.note.position).toBe(expectation); }); }); describe('diffFile', () => { it.each` scenario | files | noteDef ${'the note has no position'} | ${undefined} | ${note} ${'the Diffs store has no data'} | ${[]} | ${{ ...note, position: singleLineNotePosition }} `( 'returns `null` when $scenario and no diff file is provided as a prop', ({ noteDef, diffs }) => { const storeUpdater = (rawStore) => { const updatedStore = { ...rawStore }; if (diffs) { updatedStore.modules.diffs.state.diffFiles = diffs; } return updatedStore; }; createWrapper({ note: noteDef, discussionFile: null }, storeUpdater); expect(wrapper.vm.diffFile).toBe(null); }, ); it("returns the correct diff file from the Diffs store if it's available", () => { createWrapper( { note: { ...note, position: singleLineNotePosition }, }, (rawStore) => { const updatedStore = { ...rawStore }; updatedStore.modules.diffs.state.diffFiles = [ { file_hash: 'abc', testId: 'diffFileTest' }, ]; return updatedStore; }, ); expect(wrapper.vm.diffFile.testId).toBe('diffFileTest'); }); it('returns the provided diff file if the more robust getters fail', () => { createWrapper( { note: { ...note, position: singleLineNotePosition }, discussionFile: { testId: 'diffFileTest' }, }, (rawStore) => { const updatedStore = { ...rawStore }; updatedStore.modules.diffs.state.diffFiles = []; return updatedStore; }, ); expect(wrapper.vm.diffFile.testId).toBe('diffFileTest'); }); }); });