debian-mirror-gitlab/spec/frontend/image_diff/image_diff_spec.js

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

368 lines
12 KiB
JavaScript
Raw Normal View History

2022-07-16 23:28:13 +05:30
import { setHTMLFixture, resetHTMLFixture } from 'helpers/fixtures';
2021-03-08 18:12:59 +05:30
import { TEST_HOST } from 'helpers/test_constants';
2021-03-11 19:13:27 +05:30
import imageDiffHelper from '~/image_diff/helpers/index';
2018-03-17 18:26:18 +05:30
import ImageDiff from '~/image_diff/image_diff';
import * as imageUtility from '~/lib/utils/image_utility';
import * as mockData from './mock_data';
describe('ImageDiff', () => {
let element;
let imageDiff;
beforeEach(() => {
2022-07-16 23:28:13 +05:30
setHTMLFixture(`
2018-03-17 18:26:18 +05:30
<div id="element">
<div class="diff-file">
<div class="js-image-frame">
2020-07-28 23:09:34 +05:30
<img src="${TEST_HOST}/image.png">
2018-03-17 18:26:18 +05:30
<div class="comment-indicator"></div>
2022-04-04 11:22:00 +05:30
<div id="badge-1" class="design-note-pin">1</div>
<div id="badge-2" class="design-note-pin">2</div>
<div id="badge-3" class="design-note-pin">3</div>
2018-03-17 18:26:18 +05:30
</div>
<div class="note-container">
<div class="discussion-notes">
<div class="js-diff-notes-toggle"></div>
<div class="notes"></div>
</div>
<div class="discussion-notes">
<div class="js-diff-notes-toggle"></div>
<div class="notes"></div>
</div>
</div>
</div>
</div>
`);
element = document.getElementById('element');
});
2022-07-16 23:28:13 +05:30
afterEach(() => {
resetHTMLFixture();
});
2018-03-17 18:26:18 +05:30
describe('constructor', () => {
beforeEach(() => {
imageDiff = new ImageDiff(element, {
canCreateNote: true,
renderCommentBadge: true,
});
});
it('should set el', () => {
expect(imageDiff.el).toEqual(element);
});
it('should set canCreateNote', () => {
expect(imageDiff.canCreateNote).toEqual(true);
});
it('should set renderCommentBadge', () => {
expect(imageDiff.renderCommentBadge).toEqual(true);
});
it('should set $noteContainer', () => {
expect(imageDiff.$noteContainer[0]).toEqual(element.querySelector('.note-container'));
});
describe('default', () => {
beforeEach(() => {
imageDiff = new ImageDiff(element);
});
it('should set canCreateNote as false', () => {
expect(imageDiff.canCreateNote).toEqual(false);
});
it('should set renderCommentBadge as false', () => {
expect(imageDiff.renderCommentBadge).toEqual(false);
});
});
});
describe('init', () => {
beforeEach(() => {
2020-05-24 23:13:21 +05:30
jest.spyOn(ImageDiff.prototype, 'bindEvents').mockImplementation(() => {});
2018-03-17 18:26:18 +05:30
imageDiff = new ImageDiff(element);
imageDiff.init();
});
it('should set imageFrameEl', () => {
expect(imageDiff.imageFrameEl).toEqual(element.querySelector('.diff-file .js-image-frame'));
});
it('should set imageEl', () => {
expect(imageDiff.imageEl).toEqual(element.querySelector('.diff-file .js-image-frame img'));
});
it('should call bindEvents', () => {
expect(imageDiff.bindEvents).toHaveBeenCalled();
});
});
describe('bindEvents', () => {
let imageEl;
beforeEach(() => {
2020-05-24 23:13:21 +05:30
jest.spyOn(imageDiffHelper, 'toggleCollapsed').mockImplementation(() => {});
jest.spyOn(imageDiffHelper, 'commentIndicatorOnClick').mockImplementation(() => {});
jest.spyOn(imageDiffHelper, 'removeCommentIndicator').mockImplementation(() => {});
jest.spyOn(ImageDiff.prototype, 'imageClicked').mockImplementation(() => {});
jest.spyOn(ImageDiff.prototype, 'addBadge').mockImplementation(() => {});
jest.spyOn(ImageDiff.prototype, 'removeBadge').mockImplementation(() => {});
jest.spyOn(ImageDiff.prototype, 'renderBadges').mockImplementation(() => {});
2018-03-17 18:26:18 +05:30
imageEl = element.querySelector('.diff-file .js-image-frame img');
});
describe('default', () => {
beforeEach(() => {
2020-05-24 23:13:21 +05:30
jest.spyOn(imageUtility, 'isImageLoaded').mockReturnValue(false);
2018-03-17 18:26:18 +05:30
imageDiff = new ImageDiff(element);
imageDiff.imageEl = imageEl;
imageDiff.bindEvents();
});
it('should register click event delegation to js-diff-notes-toggle', () => {
element.querySelector('.js-diff-notes-toggle').click();
2018-12-13 13:39:08 +05:30
2018-03-17 18:26:18 +05:30
expect(imageDiffHelper.toggleCollapsed).toHaveBeenCalled();
});
it('should register click event delegation to comment-indicator', () => {
element.querySelector('.comment-indicator').click();
2018-12-13 13:39:08 +05:30
expect(imageDiffHelper.commentIndicatorOnClick).toHaveBeenCalled();
2018-03-17 18:26:18 +05:30
});
});
describe('image not loaded', () => {
beforeEach(() => {
2020-05-24 23:13:21 +05:30
jest.spyOn(imageUtility, 'isImageLoaded').mockReturnValue(false);
2018-03-17 18:26:18 +05:30
imageDiff = new ImageDiff(element);
imageDiff.imageEl = imageEl;
imageDiff.bindEvents();
});
it('should registers load eventListener', () => {
const loadEvent = new Event('load');
imageEl.dispatchEvent(loadEvent);
2018-12-13 13:39:08 +05:30
2018-03-17 18:26:18 +05:30
expect(imageDiff.renderBadges).toHaveBeenCalled();
});
});
describe('canCreateNote', () => {
beforeEach(() => {
2020-05-24 23:13:21 +05:30
jest.spyOn(imageUtility, 'isImageLoaded').mockReturnValue(false);
2018-03-17 18:26:18 +05:30
imageDiff = new ImageDiff(element, {
canCreateNote: true,
});
imageDiff.imageEl = imageEl;
imageDiff.bindEvents();
});
it('should register click.imageDiff event', () => {
const event = new CustomEvent('click.imageDiff');
element.dispatchEvent(event);
2018-12-13 13:39:08 +05:30
2018-03-17 18:26:18 +05:30
expect(imageDiff.imageClicked).toHaveBeenCalled();
});
it('should register blur.imageDiff event', () => {
const event = new CustomEvent('blur.imageDiff');
element.dispatchEvent(event);
2018-12-13 13:39:08 +05:30
2018-03-17 18:26:18 +05:30
expect(imageDiffHelper.removeCommentIndicator).toHaveBeenCalled();
});
it('should register addBadge.imageDiff event', () => {
const event = new CustomEvent('addBadge.imageDiff');
element.dispatchEvent(event);
2018-12-13 13:39:08 +05:30
2018-03-17 18:26:18 +05:30
expect(imageDiff.addBadge).toHaveBeenCalled();
});
it('should register removeBadge.imageDiff event', () => {
const event = new CustomEvent('removeBadge.imageDiff');
element.dispatchEvent(event);
2018-12-13 13:39:08 +05:30
2018-03-17 18:26:18 +05:30
expect(imageDiff.removeBadge).toHaveBeenCalled();
});
});
describe('canCreateNote is false', () => {
beforeEach(() => {
2020-05-24 23:13:21 +05:30
jest.spyOn(imageUtility, 'isImageLoaded').mockReturnValue(false);
2018-03-17 18:26:18 +05:30
imageDiff = new ImageDiff(element);
imageDiff.imageEl = imageEl;
imageDiff.bindEvents();
});
it('should not register click.imageDiff event', () => {
const event = new CustomEvent('click.imageDiff');
element.dispatchEvent(event);
2018-12-13 13:39:08 +05:30
2018-03-17 18:26:18 +05:30
expect(imageDiff.imageClicked).not.toHaveBeenCalled();
});
});
});
describe('imageClicked', () => {
beforeEach(() => {
2020-05-24 23:13:21 +05:30
jest.spyOn(imageDiffHelper, 'getTargetSelection').mockReturnValue({
2018-03-17 18:26:18 +05:30
actual: {},
browser: {},
});
2020-05-24 23:13:21 +05:30
jest.spyOn(imageDiffHelper, 'setPositionDataAttribute').mockImplementation(() => {});
jest.spyOn(imageDiffHelper, 'showCommentIndicator').mockImplementation(() => {});
2018-03-17 18:26:18 +05:30
imageDiff = new ImageDiff(element);
imageDiff.imageClicked({
detail: {
currentTarget: {},
},
});
});
it('should call getTargetSelection', () => {
expect(imageDiffHelper.getTargetSelection).toHaveBeenCalled();
});
it('should call setPositionDataAttribute', () => {
expect(imageDiffHelper.setPositionDataAttribute).toHaveBeenCalled();
});
it('should call showCommentIndicator', () => {
expect(imageDiffHelper.showCommentIndicator).toHaveBeenCalled();
});
});
describe('renderBadges', () => {
beforeEach(() => {
2020-05-24 23:13:21 +05:30
jest.spyOn(ImageDiff.prototype, 'renderBadge').mockImplementation(() => {});
2018-03-17 18:26:18 +05:30
imageDiff = new ImageDiff(element);
imageDiff.renderBadges();
});
it('should call renderBadge for each discussionEl', () => {
const discussionEls = element.querySelectorAll('.note-container .discussion-notes .notes');
2018-12-13 13:39:08 +05:30
2020-05-24 23:13:21 +05:30
expect(imageDiff.renderBadge.mock.calls.length).toEqual(discussionEls.length);
2018-03-17 18:26:18 +05:30
});
});
describe('renderBadge', () => {
let discussionEls;
beforeEach(() => {
2020-05-24 23:13:21 +05:30
jest.spyOn(imageDiffHelper, 'addImageBadge').mockImplementation(() => {});
jest.spyOn(imageDiffHelper, 'addImageCommentBadge').mockImplementation(() => {});
jest.spyOn(imageDiffHelper, 'generateBadgeFromDiscussionDOM').mockReturnValue({
2018-03-17 18:26:18 +05:30
browser: {},
noteId: 'noteId',
});
discussionEls = element.querySelectorAll('.note-container .discussion-notes .notes');
imageDiff = new ImageDiff(element);
imageDiff.renderBadge(discussionEls[0], 0);
});
it('should populate imageBadges', () => {
expect(imageDiff.imageBadges.length).toEqual(1);
});
describe('renderCommentBadge', () => {
beforeEach(() => {
imageDiff.renderCommentBadge = true;
imageDiff.renderBadge(discussionEls[0], 0);
});
it('should call addImageCommentBadge', () => {
expect(imageDiffHelper.addImageCommentBadge).toHaveBeenCalled();
});
});
describe('renderCommentBadge is false', () => {
it('should call addImageBadge', () => {
expect(imageDiffHelper.addImageBadge).toHaveBeenCalled();
});
});
});
describe('addBadge', () => {
beforeEach(() => {
2020-05-24 23:13:21 +05:30
jest.spyOn(imageDiffHelper, 'addImageBadge').mockImplementation(() => {});
jest.spyOn(imageDiffHelper, 'addAvatarBadge').mockImplementation(() => {});
jest.spyOn(imageDiffHelper, 'updateDiscussionBadgeNumber').mockImplementation(() => {});
2018-03-17 18:26:18 +05:30
imageDiff = new ImageDiff(element);
imageDiff.imageFrameEl = element.querySelector('.diff-file .js-image-frame');
imageDiff.addBadge({
detail: {
x: 0,
y: 1,
width: 25,
height: 50,
noteId: 'noteId',
discussionId: 'discussionId',
},
});
});
it('should add imageBadge to imageBadges', () => {
expect(imageDiff.imageBadges.length).toEqual(1);
});
it('should call addImageBadge', () => {
expect(imageDiffHelper.addImageBadge).toHaveBeenCalled();
});
it('should call addAvatarBadge', () => {
expect(imageDiffHelper.addAvatarBadge).toHaveBeenCalled();
});
it('should call updateDiscussionBadgeNumber', () => {
expect(imageDiffHelper.updateDiscussionBadgeNumber).toHaveBeenCalled();
});
});
describe('removeBadge', () => {
beforeEach(() => {
const { imageMeta } = mockData;
2020-05-24 23:13:21 +05:30
jest.spyOn(imageDiffHelper, 'updateDiscussionBadgeNumber').mockImplementation(() => {});
jest.spyOn(imageDiffHelper, 'updateDiscussionAvatarBadgeNumber').mockImplementation(() => {});
2018-03-17 18:26:18 +05:30
imageDiff = new ImageDiff(element);
imageDiff.imageBadges = [imageMeta, imageMeta, imageMeta];
imageDiff.imageFrameEl = element.querySelector('.diff-file .js-image-frame');
imageDiff.removeBadge({
detail: {
badgeNumber: 2,
},
});
});
describe('cascade badge count', () => {
it('should update next imageBadgeEl value', () => {
2022-04-04 11:22:00 +05:30
const imageBadgeEls = imageDiff.imageFrameEl.querySelectorAll('.design-note-pin');
2018-12-13 13:39:08 +05:30
2020-05-24 23:13:21 +05:30
expect(imageBadgeEls[0].textContent).toEqual('1');
expect(imageBadgeEls[1].textContent).toEqual('2');
2018-03-17 18:26:18 +05:30
expect(imageBadgeEls.length).toEqual(2);
});
it('should call updateDiscussionBadgeNumber', () => {
expect(imageDiffHelper.updateDiscussionBadgeNumber).toHaveBeenCalled();
});
it('should call updateDiscussionAvatarBadgeNumber', () => {
expect(imageDiffHelper.updateDiscussionAvatarBadgeNumber).toHaveBeenCalled();
});
});
it('should remove badge from imageBadges', () => {
expect(imageDiff.imageBadges.length).toEqual(2);
});
it('should remove imageBadgeEl', () => {
expect(imageDiff.imageFrameEl.querySelector('#badge-2')).toBeNull();
});
});
});