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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
|
odoo.define('mail/static/src/utils/throttle/throttle_tests.js', function (require) {
'use strict';
const { afterEach, beforeEach, start } = require('mail/static/src/utils/test_utils.js');
const throttle = require('mail/static/src/utils/throttle/throttle.js');
const { nextTick } = require('mail/static/src/utils/utils.js');
const { ThrottleReinvokedError, ThrottleCanceledError } = throttle;
QUnit.module('mail', {}, function () {
QUnit.module('utils', {}, function () {
QUnit.module('throttle', {}, function () {
QUnit.module('throttle_tests.js', {
beforeEach() {
beforeEach(this);
this.throttles = [];
this.start = async params => {
const { env, widget } = await start(Object.assign({}, params, {
data: this.data,
}));
this.env = env;
this.widget = widget;
};
},
afterEach() {
// Important: tests should cleanly intercept cancelation errors that
// may result from this teardown.
for (const t of this.throttles) {
t.clear();
}
afterEach(this);
},
});
QUnit.test('single call', async function (assert) {
assert.expect(6);
await this.start({
hasTimeControl: true,
});
let hasInvokedFunc = false;
const throttledFunc = throttle(
this.env,
() => {
hasInvokedFunc = true;
return 'func_result';
},
0
);
this.throttles.push(throttledFunc);
assert.notOk(
hasInvokedFunc,
"func should not have been invoked on immediate throttle initialization"
);
await this.env.testUtils.advanceTime(0);
assert.notOk(
hasInvokedFunc,
"func should not have been invoked from throttle initialization after 0ms"
);
throttledFunc().then(res => {
assert.step('throttle_observed_invoke');
assert.strictEqual(
res,
'func_result',
"throttle call return should forward result of inner func"
);
});
await nextTick();
assert.ok(
hasInvokedFunc,
"func should have been immediately invoked on first throttle call"
);
assert.verifySteps(
['throttle_observed_invoke'],
"throttle should have observed invoked on first throttle call"
);
});
QUnit.test('2nd (throttled) call', async function (assert) {
assert.expect(8);
await this.start({
hasTimeControl: true,
});
let funcCalledAmount = 0;
const throttledFunc = throttle(
this.env,
() => {
funcCalledAmount++;
return `func_result_${funcCalledAmount}`;
},
1000
);
this.throttles.push(throttledFunc);
throttledFunc().then(result => {
assert.step('throttle_observed_invoke_1');
assert.strictEqual(
result,
'func_result_1',
"throttle call return should forward result of inner func 1"
);
});
await nextTick();
assert.verifySteps(
['throttle_observed_invoke_1'],
"inner function of throttle should have been invoked on 1st call (immediate return)"
);
throttledFunc().then(res => {
assert.step('throttle_observed_invoke_2');
assert.strictEqual(
res,
'func_result_2',
"throttle call return should forward result of inner func 2"
);
});
await nextTick();
assert.verifySteps(
[],
"inner function of throttle should not have been immediately invoked after 2nd call immediately after 1st call (throttled with 1s internal clock)"
);
await this.env.testUtils.advanceTime(999);
assert.verifySteps(
[],
"inner function of throttle should not have been invoked after 999ms of 2nd call (throttled with 1s internal clock)"
);
await this.env.testUtils.advanceTime(1);
assert.verifySteps(
['throttle_observed_invoke_2'],
"inner function of throttle should not have been invoked after 1s of 2nd call (throttled with 1s internal clock)"
);
});
QUnit.test('throttled call reinvocation', async function (assert) {
assert.expect(11);
await this.start({
hasTimeControl: true,
});
let funcCalledAmount = 0;
const throttledFunc = throttle(
this.env,
() => {
funcCalledAmount++;
return `func_result_${funcCalledAmount}`;
},
1000,
{ silentCancelationErrors: false }
);
this.throttles.push(throttledFunc);
throttledFunc().then(result => {
assert.step('throttle_observed_invoke_1');
assert.strictEqual(
result,
'func_result_1',
"throttle call return should forward result of inner func 1"
);
});
await nextTick();
assert.verifySteps(
['throttle_observed_invoke_1'],
"inner function of throttle should have been invoked on 1st call (immediate return)"
);
throttledFunc()
.then(() => {
throw new Error("2nd throttle call should not be resolved (should have been canceled by reinvocation)");
})
.catch(error => {
assert.ok(
error instanceof ThrottleReinvokedError,
"Should generate a Throttle reinvoked error (from another throttle function call)"
);
assert.step('throttle_reinvoked_1');
});
await nextTick();
assert.verifySteps(
[],
"inner function of throttle should not have been immediately invoked after 2nd call immediately after 1st call (throttled with 1s internal clock)"
);
await this.env.testUtils.advanceTime(999);
assert.verifySteps(
[],
"inner function of throttle should not have been invoked after 999ms of 2nd call (throttled with 1s internal clock)"
);
throttledFunc()
.then(result => {
assert.step('throttle_observed_invoke_2');
assert.strictEqual(
result,
'func_result_2',
"throttle call return should forward result of inner func 2"
);
});
await nextTick();
assert.verifySteps(
['throttle_reinvoked_1'],
"2nd throttle call should have been canceled from 3rd throttle call (reinvoked before cooling down phase has ended)"
);
await this.env.testUtils.advanceTime(1);
assert.verifySteps(
['throttle_observed_invoke_2'],
"inner function of throttle should have been invoked after 1s of 1st call (throttled with 1s internal clock, 3rd throttle call re-use timer of 2nd throttle call)"
);
});
QUnit.test('flush throttled call', async function (assert) {
assert.expect(9);
await this.start({
hasTimeControl: true,
});
const throttledFunc = throttle(
this.env,
() => {},
1000,
);
this.throttles.push(throttledFunc);
throttledFunc().then(() => assert.step('throttle_observed_invoke_1'));
await nextTick();
assert.verifySteps(
['throttle_observed_invoke_1'],
"inner function of throttle should have been invoked on 1st call (immediate return)"
);
throttledFunc().then(() => assert.step('throttle_observed_invoke_2'));
await nextTick();
assert.verifySteps(
[],
"inner function of throttle should not have been immediately invoked after 2nd call immediately after 1st call (throttled with 1s internal clock)"
);
await this.env.testUtils.advanceTime(10);
assert.verifySteps(
[],
"inner function of throttle should not have been invoked after 10ms of 2nd call (throttled with 1s internal clock)"
);
throttledFunc.flush();
await nextTick();
assert.verifySteps(
['throttle_observed_invoke_2'],
"inner function of throttle should have been invoked from 2nd call after flush"
);
throttledFunc().then(() => assert.step('throttle_observed_invoke_3'));
await nextTick();
await this.env.testUtils.advanceTime(999);
assert.verifySteps(
[],
"inner function of throttle should not have been invoked after 999ms of 3rd call (throttled with 1s internal clock)"
);
await this.env.testUtils.advanceTime(1);
assert.verifySteps(
['throttle_observed_invoke_3'],
"inner function of throttle should not have been invoked after 999ms of 3rd call (throttled with 1s internal clock)"
);
});
QUnit.test('cancel throttled call', async function (assert) {
assert.expect(10);
await this.start({
hasTimeControl: true,
});
const throttledFunc = throttle(
this.env,
() => {},
1000,
{ silentCancelationErrors: false }
);
this.throttles.push(throttledFunc);
throttledFunc().then(() => assert.step('throttle_observed_invoke_1'));
await nextTick();
assert.verifySteps(
['throttle_observed_invoke_1'],
"inner function of throttle should have been invoked on 1st call (immediate return)"
);
throttledFunc()
.then(() => {
throw new Error("2nd throttle call should not be resolved (should have been canceled)");
})
.catch(error => {
assert.ok(
error instanceof ThrottleCanceledError,
"Should generate a Throttle canceled error (from `.cancel()`)"
);
assert.step('throttle_canceled');
});
await nextTick();
assert.verifySteps(
[],
"inner function of throttle should not have been immediately invoked after 2nd call immediately after 1st call (throttled with 1s internal clock)"
);
await this.env.testUtils.advanceTime(500);
assert.verifySteps(
[],
"inner function of throttle should not have been invoked after 500ms of 2nd call (throttled with 1s internal clock)"
);
throttledFunc.cancel();
await nextTick();
assert.verifySteps(
['throttle_canceled'],
"2nd throttle function call should have been canceled"
);
throttledFunc().then(() => assert.step('throttle_observed_invoke_3'));
await nextTick();
assert.verifySteps(
[],
"3rd throttle function call should not have invoked inner function yet (cancel reuses inner clock of throttle)"
);
await this.env.testUtils.advanceTime(500);
assert.verifySteps(
['throttle_observed_invoke_3'],
"3rd throttle function call should have invoke inner function after 500ms (cancel reuses inner clock of throttle which was at 500ms in, throttle set at 1ms)"
);
});
QUnit.test('clear throttled call', async function (assert) {
assert.expect(9);
await this.start({
hasTimeControl: true,
});
const throttledFunc = throttle(
this.env,
() => {},
1000,
{ silentCancelationErrors: false }
);
this.throttles.push(throttledFunc);
throttledFunc().then(() => assert.step('throttle_observed_invoke_1'));
await nextTick();
assert.verifySteps(
['throttle_observed_invoke_1'],
"inner function of throttle should have been invoked on 1st call (immediate return)"
);
throttledFunc()
.then(() => {
throw new Error("2nd throttle call should not be resolved (should have been canceled from clear)");
})
.catch(error => {
assert.ok(
error instanceof ThrottleCanceledError,
"Should generate a Throttle canceled error (from `.clear()`)"
);
assert.step('throttle_canceled');
});
await nextTick();
assert.verifySteps(
[],
"inner function of throttle should not have been immediately invoked after 2nd call immediately after 1st call (throttled with 1s internal clock)"
);
await this.env.testUtils.advanceTime(500);
assert.verifySteps(
[],
"inner function of throttle should not have been invoked after 500ms of 2nd call (throttled with 1s internal clock)"
);
throttledFunc.clear();
await nextTick();
assert.verifySteps(
['throttle_canceled'],
"2nd throttle function call should have been canceled (from `.clear()`)"
);
throttledFunc().then(() => assert.step('throttle_observed_invoke_3'));
await nextTick();
assert.verifySteps(
['throttle_observed_invoke_3'],
"3rd throttle function call should have invoke inner function immediately (`.clear()` flushes throttle)"
);
});
});
});
});
});
|
