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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
import Visibility from 'visibilityjs';
import {
isGid,
getIdFromGraphQLId,
convertToGraphQLId,
convertToGraphQLIds,
convertFromGraphQLIds,
convertNodeIdsFromGraphQLIds,
getNodesOrDefault,
toggleQueryPollingByVisibility,
etagQueryHeaders,
} from '~/graphql_shared/utils';
const mockType = 'Group';
const mockId = 12;
const mockGid = `gid://gitlab/Group/12`;
describe('isGid', () => {
it('returns true if passed id is gid', () => {
expect(isGid(mockGid)).toBe(true);
});
it('returns false if passed id is not gid', () => {
expect(isGid(mockId)).toBe(false);
});
});
describe('getIdFromGraphQLId', () => {
[
{
input: '',
output: null,
},
{
input: null,
output: null,
},
{
input: 2,
output: 2,
},
{
input: 'gid://',
output: null,
},
{
input: 'gid://gitlab/',
output: null,
},
{
input: 'gid://gitlab/Environments',
output: null,
},
{
input: 'gid://gitlab/Environments/',
output: null,
},
{
input: 'gid://gitlab/Environments/0',
output: 0,
},
{
input: 'gid://gitlab/Environments/123',
output: 123,
},
{
input: 'gid://gitlab/DesignManagement::Version/2',
output: 2,
},
].forEach(({ input, output }) => {
it(`getIdFromGraphQLId returns ${output} when passed ${input}`, () => {
expect(getIdFromGraphQLId(input)).toBe(output);
});
});
});
describe('convertToGraphQLId', () => {
it('combines $type and $id into $result', () => {
expect(convertToGraphQLId(mockType, mockId)).toBe(mockGid);
});
it.each`
type | id | message
${mockType} | ${null} | ${'id must be a number or string; got object'}
${null} | ${mockId} | ${'type must be a string; got object'}
`('throws TypeError with "$message" if a param is missing', ({ type, id, message }) => {
expect(() => convertToGraphQLId(type, id)).toThrow(new TypeError(message));
});
it('returns id as is if it follows the gid format', () => {
expect(convertToGraphQLId(mockType, mockGid)).toStrictEqual(mockGid);
});
});
describe('convertToGraphQLIds', () => {
it('combines $type and $id into $result', () => {
expect(convertToGraphQLIds(mockType, [mockId])).toStrictEqual([mockGid]);
});
it.each`
type | ids | message
${mockType} | ${null} | ${"Cannot read properties of null (reading 'map')"}
${mockType} | ${[mockId, null]} | ${'id must be a number or string; got object'}
${null} | ${[mockId]} | ${'type must be a string; got object'}
`('throws TypeError with "$message" if a param is missing', ({ type, ids, message }) => {
expect(() => convertToGraphQLIds(type, ids)).toThrow(new TypeError(message));
});
});
describe('convertFromGraphQLIds', () => {
it.each`
ids | expected
${[mockGid]} | ${[mockId]}
${[mockGid, 'invalid id']} | ${[mockId, null]}
`('converts $ids from GraphQL Ids', ({ ids, expected }) => {
expect(convertFromGraphQLIds(ids)).toEqual(expected);
});
it("throws TypeError if `ids` parameter isn't an array", () => {
expect(() => convertFromGraphQLIds('invalid')).toThrow(
new TypeError('ids must be an array; got string'),
);
});
});
describe('convertNodeIdsFromGraphQLIds', () => {
it.each`
nodes | expected
${[{ id: mockGid, name: 'foo bar' }, { id: mockGid, name: 'baz' }]} | ${[{ id: mockId, name: 'foo bar' }, { id: mockId, name: 'baz' }]}
${[{ name: 'foo bar' }]} | ${[{ name: 'foo bar' }]}
`('converts `id` properties in $nodes from GraphQL Id', ({ nodes, expected }) => {
expect(convertNodeIdsFromGraphQLIds(nodes)).toEqual(expected);
});
it("throws TypeError if `nodes` parameter isn't an array", () => {
expect(() => convertNodeIdsFromGraphQLIds('invalid')).toThrow(
new TypeError('nodes must be an array; got string'),
);
});
});
describe('getNodesOrDefault', () => {
const mockDataWithNodes = {
users: {
nodes: [
{ __typename: 'UserCore', id: 'gid://gitlab/User/44' },
{ __typename: 'UserCore', id: 'gid://gitlab/User/42' },
{ __typename: 'UserCore', id: 'gid://gitlab/User/41' },
],
},
};
it.each`
desc | input | expected
${'with nodes child'} | ${[mockDataWithNodes.users]} | ${mockDataWithNodes.users.nodes}
${'with nodes child and "dne" as field'} | ${[mockDataWithNodes.users, 'dne']} | ${[]}
${'with empty data object'} | ${[{ users: {} }]} | ${[]}
${'with empty object'} | ${[{}]} | ${[]}
${'with falsy value'} | ${[undefined]} | ${[]}
`('$desc', ({ input, expected }) => {
const result = getNodesOrDefault(...input);
expect(result).toEqual(expected);
});
});
describe('toggleQueryPollingByVisibility', () => {
let query;
let changeFn;
let interval;
let hidden;
beforeEach(() => {
hidden = jest.spyOn(Visibility, 'hidden').mockReturnValue(true);
jest.spyOn(Visibility, 'change').mockImplementation((fn) => {
changeFn = fn;
});
query = { startPolling: jest.fn(), stopPolling: jest.fn() };
interval = 5000;
toggleQueryPollingByVisibility(query, 5000);
});
it('starts polling not hidden', () => {
hidden.mockReturnValue(false);
changeFn();
expect(query.startPolling).toHaveBeenCalledWith(interval);
});
it('stops polling when hidden', () => {
query.stopPolling.mockReset();
hidden.mockReturnValue(true);
changeFn();
expect(query.stopPolling).toHaveBeenCalled();
});
});
describe('etagQueryHeaders', () => {
it('returns headers necessary for etag caching', () => {
expect(etagQueryHeaders('myFeature', 'myResource')).toEqual({
fetchOptions: {
method: 'GET',
},
headers: {
'X-GITLAB-GRAPHQL-FEATURE-CORRELATION': 'myFeature',
'X-GITLAB-GRAPHQL-RESOURCE-ETAG': 'myResource',
'X-Requested-With': 'XMLHttpRequest',
},
});
});
});
|
