import { GlSprintf } from '@gitlab/ui'; import Vue, { nextTick } from 'vue'; import Vuex from 'vuex'; import { shallowMountExtended } from 'helpers/vue_test_utils_helper'; import NoteHeader from '~/notes/components/note_header.vue'; import { AVAILABILITY_STATUS } from '~/set_status_modal/constants'; import UserNameWithStatus from '~/sidebar/components/assignees/user_name_with_status.vue'; Vue.use(Vuex); const actions = { setTargetNoteHash: jest.fn(), }; describe('NoteHeader component', () => { let wrapper; const findActionsWrapper = () => wrapper.findComponent({ ref: 'discussionActions' }); const findToggleThreadButton = () => wrapper.findByTestId('thread-toggle'); const findChevronIcon = () => wrapper.findComponent({ ref: 'chevronIcon' }); const findActionText = () => wrapper.findComponent({ ref: 'actionText' }); const findTimestampLink = () => wrapper.findComponent({ ref: 'noteTimestampLink' }); const findTimestamp = () => wrapper.findComponent({ ref: 'noteTimestamp' }); const findInternalNoteIndicator = () => wrapper.findByTestId('internalNoteIndicator'); const findSpinner = () => wrapper.findComponent({ ref: 'spinner' }); const findAuthorStatus = () => wrapper.findComponent({ ref: 'authorStatus' }); const statusHtml = '"🏀"'; const author = { avatar_url: null, id: 1, name: 'Root', path: '/root', state: 'active', username: 'root', show_status: true, status_tooltip_html: statusHtml, availability: '', }; const createComponent = (props, userAttributes = false) => { wrapper = shallowMountExtended(NoteHeader, { store: new Vuex.Store({ actions, }), propsData: { ...props }, stubs: { GlSprintf, UserNameWithStatus }, provide: { glFeatures: { removeUserAttributesProjects: userAttributes, removeUserAttributesGroups: userAttributes, }, }, }); }; afterEach(() => { wrapper.destroy(); wrapper = null; }); describe('when removeUserAttributesProjects feature flag is enabled', () => { it('does not render busy status', () => { createComponent({ author: { ...author, availability: AVAILABILITY_STATUS.BUSY } }, true); expect(wrapper.find('.note-header-info').text()).not.toContain('(Busy)'); }); it('does not render author status', () => { createComponent({ author }, true); expect(findAuthorStatus().exists()).toBe(false); }); it('does not render username', () => { createComponent({ author }, true); expect(wrapper.find('.note-header-info').text()).not.toContain('@'); }); }); it('does not render discussion actions when includeToggle is false', () => { createComponent({ includeToggle: false, }); expect(findActionsWrapper().exists()).toBe(false); }); describe('when includes a toggle', () => { it('renders discussion actions', () => { createComponent({ includeToggle: true, }); expect(findActionsWrapper().exists()).toBe(true); }); it('emits toggleHandler event on button click', () => { createComponent({ includeToggle: true, }); wrapper.find('.note-action-button').trigger('click'); expect(wrapper.emitted('toggleHandler')).toBeDefined(); expect(wrapper.emitted('toggleHandler')).toHaveLength(1); }); it('has chevron-up icon if expanded prop is true', () => { createComponent({ includeToggle: true, expanded: true, }); expect(findChevronIcon().props('name')).toBe('chevron-up'); }); it('has chevron-down icon if expanded prop is false', () => { createComponent({ includeToggle: true, expanded: false, }); expect(findChevronIcon().props('name')).toBe('chevron-down'); }); it.each` text | expanded ${NoteHeader.i18n.showThread} | ${false} ${NoteHeader.i18n.hideThread} | ${true} `('toggle button has text $text is expanded is $expanded', ({ text, expanded }) => { createComponent({ includeToggle: true, expanded, }); expect(findToggleThreadButton().text()).toBe(text); }); }); it('renders an author link if author is passed to props', () => { createComponent({ author }); expect(wrapper.find('.js-user-link').exists()).toBe(true); }); it('renders busy status if author availability is set', () => { createComponent({ author: { ...author, availability: AVAILABILITY_STATUS.BUSY } }); expect(wrapper.find('.js-user-link').text()).toContain('(Busy)'); }); it('renders author status', () => { createComponent({ author }); expect(findAuthorStatus().exists()).toBe(true); }); it('does not render author status if show_status=false', () => { createComponent({ author: { ...author, status: { availability: AVAILABILITY_STATUS.BUSY }, show_status: false }, }); expect(findAuthorStatus().exists()).toBe(false); }); it('does not render author status if status_tooltip_html=null', () => { createComponent({ author: { ...author, status: { availability: AVAILABILITY_STATUS.BUSY }, status_tooltip_html: null, }, }); expect(findAuthorStatus().exists()).toBe(false); }); it('renders deleted user text if author is not passed as a prop', () => { createComponent(); expect(wrapper.text()).toContain('A deleted user'); }); it('does not render created at information if createdAt is not passed as a prop', () => { createComponent(); expect(findActionText().exists()).toBe(false); expect(findTimestampLink().exists()).toBe(false); }); describe('when createdAt is passed as a prop', () => { it('renders action text and a timestamp', () => { createComponent({ createdAt: '2017-08-02T10:51:58.559Z', noteId: 123, }); expect(findActionText().exists()).toBe(true); expect(findTimestampLink().exists()).toBe(true); }); it('renders correct actionText if passed', () => { createComponent({ createdAt: '2017-08-02T10:51:58.559Z', actionText: 'Test action text', }); expect(findActionText().text()).toBe('Test action text'); }); it('calls an action when timestamp is clicked', () => { createComponent({ createdAt: '2017-08-02T10:51:58.559Z', noteId: 123, }); findTimestampLink().trigger('click'); expect(actions.setTargetNoteHash).toHaveBeenCalled(); }); }); describe('loading spinner', () => { it('shows spinner when showSpinner is true', () => { createComponent(); expect(findSpinner().exists()).toBe(true); }); it('does not show spinner when showSpinner is false', () => { createComponent({ showSpinner: false }); expect(findSpinner().exists()).toBe(false); }); }); describe('timestamp', () => { it('shows timestamp as a link if a noteId was provided', () => { createComponent({ createdAt: new Date().toISOString(), noteId: 123 }); expect(findTimestampLink().exists()).toBe(true); expect(findTimestamp().exists()).toBe(false); }); it('shows timestamp as plain text if a noteId was not provided', () => { createComponent({ createdAt: new Date().toISOString() }); expect(findTimestampLink().exists()).toBe(false); expect(findTimestamp().exists()).toBe(true); }); }); describe('author username link', () => { it('proxies `mouseenter` event to author name link', () => { createComponent({ author }); const dispatchEvent = jest.spyOn(wrapper.vm.$refs.authorNameLink, 'dispatchEvent'); wrapper.findComponent({ ref: 'authorUsernameLink' }).trigger('mouseenter'); expect(dispatchEvent).toHaveBeenCalledWith(new Event('mouseenter')); }); it('proxies `mouseleave` event to author name link', () => { createComponent({ author }); const dispatchEvent = jest.spyOn(wrapper.vm.$refs.authorNameLink, 'dispatchEvent'); wrapper.findComponent({ ref: 'authorUsernameLink' }).trigger('mouseleave'); expect(dispatchEvent).toHaveBeenCalledWith(new Event('mouseleave')); }); }); describe('when author status tooltip is opened', () => { it('removes `title` attribute from emoji to prevent duplicate tooltips', () => { createComponent({ author: { ...author, status_tooltip_html: statusHtml, }, }); return nextTick().then(() => { const authorStatus = findAuthorStatus(); authorStatus.trigger('mouseenter'); expect(authorStatus.find('gl-emoji').attributes('title')).toBeUndefined(); }); }); }); describe('when author username link is hovered', () => { it('toggles hover specific CSS classes on author name link', async () => { createComponent({ author }); const authorUsernameLink = wrapper.findComponent({ ref: 'authorUsernameLink' }); const authorNameLink = wrapper.findComponent({ ref: 'authorNameLink' }); authorUsernameLink.trigger('mouseenter'); await nextTick(); expect(authorNameLink.classes()).toContain('hover'); expect(authorNameLink.classes()).toContain('text-underline'); authorUsernameLink.trigger('mouseleave'); await nextTick(); expect(authorNameLink.classes()).not.toContain('hover'); expect(authorNameLink.classes()).not.toContain('text-underline'); }); }); describe('with internal note badge', () => { it.each` status | condition ${true} | ${'shows'} ${false} | ${'hides'} `('$condition badge when isInternalNote is $status', ({ status }) => { createComponent({ isInternalNote: status }); expect(findInternalNoteIndicator().exists()).toBe(status); }); it('shows internal note badge tooltip for project context', () => { createComponent({ isInternalNote: true, noteableType: 'issue' }); expect(findInternalNoteIndicator().attributes('title')).toBe( 'This internal note will always remain confidential', ); }); }); });