1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
import Vue from 'vue';
import VueApollo from 'vue-apollo';
import createMockApollo from 'helpers/mock_apollo_helper';
import { shallowMountExtended } from 'helpers/vue_test_utils_helper';
import { setHTMLFixture } from 'helpers/fixtures';
import SourceViewer from '~/vue_shared/components/source_viewer/source_viewer_new.vue';
import Chunk from '~/vue_shared/components/source_viewer/components/chunk_new.vue';
import { EVENT_ACTION, EVENT_LABEL_VIEWER } from '~/vue_shared/components/source_viewer/constants';
import Tracking from '~/tracking';
import LineHighlighter from '~/blob/line_highlighter';
import addBlobLinksTracking from '~/blob/blob_links_tracking';
import waitForPromises from 'helpers/wait_for_promises';
import blameDataQuery from '~/vue_shared/components/source_viewer/queries/blame_data.query.graphql';
import Blame from '~/vue_shared/components/source_viewer/components/blame_info.vue';
import * as utils from '~/vue_shared/components/source_viewer/utils';
import {
BLOB_DATA_MOCK,
CHUNK_1,
CHUNK_2,
LANGUAGE_MOCK,
BLAME_DATA_QUERY_RESPONSE_MOCK,
SOURCE_CODE_CONTENT_MOCK,
} from './mock_data';
Vue.use(VueApollo);
const lineHighlighter = new LineHighlighter();
jest.mock('~/blob/line_highlighter', () =>
jest.fn().mockReturnValue({
highlightHash: jest.fn(),
}),
);
jest.mock('~/blob/blob_links_tracking');
describe('Source Viewer component', () => {
let wrapper;
let fakeApollo;
const CHUNKS_MOCK = [CHUNK_1, CHUNK_2];
const hash = '#L142';
const blameDataQueryHandlerSuccess = jest.fn().mockResolvedValue(BLAME_DATA_QUERY_RESPONSE_MOCK);
const blameInfo =
BLAME_DATA_QUERY_RESPONSE_MOCK.data.project.repository.blobs.nodes[0].blame.groups;
const createComponent = ({ showBlame = true } = {}) => {
fakeApollo = createMockApollo([[blameDataQuery, blameDataQueryHandlerSuccess]]);
wrapper = shallowMountExtended(SourceViewer, {
apolloProvider: fakeApollo,
mocks: { $route: { hash } },
propsData: {
blob: BLOB_DATA_MOCK,
chunks: CHUNKS_MOCK,
projectPath: 'test',
showBlame,
},
});
};
const findChunks = () => wrapper.findAllComponents(Chunk);
const findBlameComponents = () => wrapper.findAllComponents(Blame);
const triggerChunkAppear = async (chunkIndex = 0) => {
findChunks().at(chunkIndex).vm.$emit('appear');
await waitForPromises();
};
beforeEach(() => {
jest.spyOn(Tracking, 'event');
return createComponent();
});
it('instantiates the lineHighlighter class', () => {
expect(LineHighlighter).toHaveBeenCalled();
});
describe('event tracking', () => {
it('fires a tracking event when the component is created', () => {
const eventData = { label: EVENT_LABEL_VIEWER, property: LANGUAGE_MOCK };
expect(Tracking.event).toHaveBeenCalledWith(undefined, EVENT_ACTION, eventData);
});
it('adds blob links tracking', () => {
expect(addBlobLinksTracking).toHaveBeenCalled();
});
});
describe('rendering', () => {
it('does not render a Blame component if the respective chunk for the blame has not appeared', async () => {
await waitForPromises();
expect(findBlameComponents()).toHaveLength(0);
});
describe('DOM updates', () => {
it('adds the necessary classes to the DOM', async () => {
setHTMLFixture(SOURCE_CODE_CONTENT_MOCK);
jest.spyOn(utils, 'toggleBlameClasses');
createComponent();
await triggerChunkAppear();
expect(utils.toggleBlameClasses).toHaveBeenCalledWith(blameInfo, true);
});
});
describe('Blame information', () => {
it('renders a Blame component when a chunk appears', async () => {
await triggerChunkAppear();
expect(findBlameComponents().at(0).exists()).toBe(true);
expect(findBlameComponents().at(0).props()).toMatchObject({ blameInfo });
});
it('calls the query only once per chunk', async () => {
jest.spyOn(wrapper.vm.$apollo, 'query');
// We trigger the `appear` event multiple times here in order to simulate the user scrolling past the chunk more than once.
// In this scenario we only want to query the backend once.
await triggerChunkAppear();
await triggerChunkAppear();
expect(wrapper.vm.$apollo.query).toHaveBeenCalledTimes(1);
});
it('requests blame information for overlapping chunk', async () => {
jest.spyOn(wrapper.vm.$apollo, 'query');
await triggerChunkAppear(1);
expect(wrapper.vm.$apollo.query).toHaveBeenCalledTimes(2);
expect(blameDataQueryHandlerSuccess).toHaveBeenCalledWith(
expect.objectContaining({ fromLine: 71, toLine: 110 }),
);
expect(blameDataQueryHandlerSuccess).toHaveBeenCalledWith(
expect.objectContaining({ fromLine: 1, toLine: 70 }),
);
expect(findChunks().at(0).props('isHighlighted')).toBe(true);
});
it('does not render a Blame component when `showBlame: false`', async () => {
createComponent({ showBlame: false });
await triggerChunkAppear();
expect(findBlameComponents()).toHaveLength(0);
});
});
it('renders a Chunk component for each chunk', () => {
expect(findChunks().at(0).props()).toMatchObject(CHUNK_1);
expect(findChunks().at(1).props()).toMatchObject(CHUNK_2);
});
});
describe('hash highlighting', () => {
it('calls highlightHash with expected parameter', () => {
expect(lineHighlighter.highlightHash).toHaveBeenCalledWith(hash);
});
});
});
|
