debian-mirror-gitlab/spec/frontend/persistent_user_callout_spec.js

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

237 lines
7.3 KiB
JavaScript
Raw Normal View History

2019-07-07 11:18:12 +05:30
import MockAdapter from 'axios-mock-adapter';
2021-10-27 15:23:28 +05:30
import { useMockLocationHelper } from 'helpers/mock_window_location_helper';
2020-06-23 00:09:42 +05:30
import waitForPromises from 'helpers/wait_for_promises';
2023-05-27 22:25:52 +05:30
import { createAlert } from '~/alert';
2019-07-07 11:18:12 +05:30
import axios from '~/lib/utils/axios_utils';
2023-04-23 21:23:45 +05:30
import { HTTP_STATUS_INTERNAL_SERVER_ERROR, HTTP_STATUS_OK } from '~/lib/utils/http_status';
2019-07-07 11:18:12 +05:30
import PersistentUserCallout from '~/persistent_user_callout';
2020-06-23 00:09:42 +05:30
2023-05-27 22:25:52 +05:30
jest.mock('~/alert');
2019-07-07 11:18:12 +05:30
describe('PersistentUserCallout', () => {
const dismissEndpoint = '/dismiss';
const featureName = 'feature';
2022-04-04 11:22:00 +05:30
const groupId = '5';
2019-07-07 11:18:12 +05:30
function createFixture() {
const fixture = document.createElement('div');
fixture.innerHTML = `
<div
class="container"
data-dismiss-endpoint="${dismissEndpoint}"
data-feature-id="${featureName}"
2022-04-04 11:22:00 +05:30
data-group-id="${groupId}"
2019-07-07 11:18:12 +05:30
>
2022-05-07 20:08:51 +05:30
<button type="button" class="js-close js-close-primary"></button>
<button type="button" class="js-close js-close-secondary"></button>
2019-07-07 11:18:12 +05:30
</div>
`;
return fixture;
}
2019-10-12 21:52:04 +05:30
function createDeferredLinkFixture() {
const fixture = document.createElement('div');
fixture.innerHTML = `
<div
class="container"
data-dismiss-endpoint="${dismissEndpoint}"
data-feature-id="${featureName}"
data-defer-links="true"
>
<button type="button" class="js-close"></button>
<a href="/somewhere-pleasant" target="_blank" class="deferred-link">A link</a>
<a href="/somewhere-else" target="_blank" class="normal-link">Another link</a>
</div>
`;
return fixture;
}
2020-07-28 23:09:34 +05:30
function createFollowLinkFixture() {
const fixture = document.createElement('div');
fixture.innerHTML = `
<ul>
<li
class="container"
data-dismiss-endpoint="${dismissEndpoint}"
data-feature-id="${featureName}"
>
<a class="js-follow-link" href="/somewhere-pleasant">A Link</a>
</li>
</ul>
`;
return fixture;
}
2019-07-07 11:18:12 +05:30
describe('dismiss', () => {
2022-05-07 20:08:51 +05:30
const buttons = {};
2019-07-07 11:18:12 +05:30
let mockAxios;
let persistentUserCallout;
beforeEach(() => {
const fixture = createFixture();
const container = fixture.querySelector('.container');
2022-05-07 20:08:51 +05:30
buttons.primary = fixture.querySelector('.js-close-primary');
buttons.secondary = fixture.querySelector('.js-close-secondary');
2019-07-07 11:18:12 +05:30
mockAxios = new MockAdapter(axios);
persistentUserCallout = new PersistentUserCallout(container);
2020-06-23 00:09:42 +05:30
jest.spyOn(persistentUserCallout.container, 'remove').mockImplementation(() => {});
2019-07-07 11:18:12 +05:30
});
afterEach(() => {
mockAxios.restore();
});
2022-05-07 20:08:51 +05:30
it.each`
button
${'primary'}
${'secondary'}
`('POSTs endpoint and removes container when clicking $button close', async ({ button }) => {
2023-04-23 21:23:45 +05:30
mockAxios.onPost(dismissEndpoint).replyOnce(HTTP_STATUS_OK);
2019-07-07 11:18:12 +05:30
2022-05-07 20:08:51 +05:30
buttons[button].click();
2019-07-07 11:18:12 +05:30
2022-05-07 20:08:51 +05:30
await waitForPromises();
expect(persistentUserCallout.container.remove).toHaveBeenCalled();
expect(mockAxios.history.post[0].data).toBe(
JSON.stringify({ feature_name: featureName, group_id: groupId }),
);
2019-07-07 11:18:12 +05:30
});
2022-05-07 20:08:51 +05:30
it('invokes Flash when the dismiss request fails', async () => {
2023-04-23 21:23:45 +05:30
mockAxios.onPost(dismissEndpoint).replyOnce(HTTP_STATUS_INTERNAL_SERVER_ERROR);
2019-07-07 11:18:12 +05:30
2022-05-07 20:08:51 +05:30
buttons.primary.click();
2019-07-07 11:18:12 +05:30
2022-05-07 20:08:51 +05:30
await waitForPromises();
expect(persistentUserCallout.container.remove).not.toHaveBeenCalled();
2022-11-25 23:54:43 +05:30
expect(createAlert).toHaveBeenCalledWith({
2022-05-07 20:08:51 +05:30
message: 'An error occurred while dismissing the alert. Refresh the page and try again.',
2020-06-23 00:09:42 +05:30
});
2019-07-07 11:18:12 +05:30
});
});
2019-10-12 21:52:04 +05:30
describe('deferred links', () => {
let button;
let deferredLink;
let normalLink;
let mockAxios;
let persistentUserCallout;
let windowSpy;
beforeEach(() => {
const fixture = createDeferredLinkFixture();
const container = fixture.querySelector('.container');
button = fixture.querySelector('.js-close');
deferredLink = fixture.querySelector('.deferred-link');
normalLink = fixture.querySelector('.normal-link');
mockAxios = new MockAdapter(axios);
persistentUserCallout = new PersistentUserCallout(container);
2020-06-23 00:09:42 +05:30
jest.spyOn(persistentUserCallout.container, 'remove').mockImplementation(() => {});
windowSpy = jest.spyOn(window, 'open').mockImplementation(() => {});
2019-10-12 21:52:04 +05:30
});
afterEach(() => {
mockAxios.restore();
});
2022-05-07 20:08:51 +05:30
it('defers loading of a link until callout is dismissed', async () => {
2019-10-12 21:52:04 +05:30
const { href, target } = deferredLink;
2023-04-23 21:23:45 +05:30
mockAxios.onPost(dismissEndpoint).replyOnce(HTTP_STATUS_OK);
2019-10-12 21:52:04 +05:30
deferredLink.click();
2022-05-07 20:08:51 +05:30
await waitForPromises();
expect(windowSpy).toHaveBeenCalledWith(href, target);
expect(persistentUserCallout.container.remove).toHaveBeenCalled();
expect(mockAxios.history.post[0].data).toBe(JSON.stringify({ feature_name: featureName }));
2019-10-12 21:52:04 +05:30
});
2022-05-07 20:08:51 +05:30
it('does not dismiss callout on non-deferred links', async () => {
2019-10-12 21:52:04 +05:30
normalLink.click();
2022-05-07 20:08:51 +05:30
await waitForPromises();
expect(windowSpy).not.toHaveBeenCalled();
expect(persistentUserCallout.container.remove).not.toHaveBeenCalled();
2019-10-12 21:52:04 +05:30
});
2022-05-07 20:08:51 +05:30
it('does not follow link when notification is closed', async () => {
2023-04-23 21:23:45 +05:30
mockAxios.onPost(dismissEndpoint).replyOnce(HTTP_STATUS_OK);
2019-10-12 21:52:04 +05:30
button.click();
2022-05-07 20:08:51 +05:30
await waitForPromises();
expect(windowSpy).not.toHaveBeenCalled();
expect(persistentUserCallout.container.remove).toHaveBeenCalled();
2019-10-12 21:52:04 +05:30
});
});
2020-07-28 23:09:34 +05:30
describe('follow links', () => {
let link;
let mockAxios;
let persistentUserCallout;
2021-10-27 15:23:28 +05:30
useMockLocationHelper();
2020-07-28 23:09:34 +05:30
beforeEach(() => {
const fixture = createFollowLinkFixture();
const container = fixture.querySelector('.container');
link = fixture.querySelector('.js-follow-link');
mockAxios = new MockAdapter(axios);
persistentUserCallout = new PersistentUserCallout(container);
jest.spyOn(persistentUserCallout.container, 'remove').mockImplementation(() => {});
});
afterEach(() => {
mockAxios.restore();
});
2022-05-07 20:08:51 +05:30
it('uses a link to trigger callout and defers following until callout is finished', async () => {
2020-07-28 23:09:34 +05:30
const { href } = link;
2023-04-23 21:23:45 +05:30
mockAxios.onPost(dismissEndpoint).replyOnce(HTTP_STATUS_OK);
2020-07-28 23:09:34 +05:30
link.click();
2022-05-07 20:08:51 +05:30
await waitForPromises();
2022-10-11 01:57:18 +05:30
expect(window.location.assign).toHaveBeenCalledWith(href);
2022-05-07 20:08:51 +05:30
expect(persistentUserCallout.container.remove).not.toHaveBeenCalled();
expect(mockAxios.history.post[0].data).toBe(JSON.stringify({ feature_name: featureName }));
2020-07-28 23:09:34 +05:30
});
2022-05-07 20:08:51 +05:30
it('invokes Flash when the dismiss request fails', async () => {
2023-04-23 21:23:45 +05:30
mockAxios.onPost(dismissEndpoint).replyOnce(HTTP_STATUS_INTERNAL_SERVER_ERROR);
2020-07-28 23:09:34 +05:30
link.click();
2022-05-07 20:08:51 +05:30
await waitForPromises();
expect(window.location.assign).not.toHaveBeenCalled();
2022-11-25 23:54:43 +05:30
expect(createAlert).toHaveBeenCalledWith({
2022-05-07 20:08:51 +05:30
message:
'An error occurred while acknowledging the notification. Refresh the page and try again.',
2020-07-28 23:09:34 +05:30
});
});
});
2019-07-07 11:18:12 +05:30
describe('factory', () => {
it('returns an instance of PersistentUserCallout with the provided container property', () => {
const fixture = createFixture();
expect(PersistentUserCallout.factory(fixture) instanceof PersistentUserCallout).toBe(true);
});
it('returns undefined if container is falsey', () => {
expect(PersistentUserCallout.factory()).toBe(undefined);
});
});
});