forked from tbranyen/diffhtml
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtransaction.js
More file actions
360 lines (276 loc) · 10.2 KB
/
Copy pathtransaction.js
File metadata and controls
360 lines (276 loc) · 10.2 KB
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
import { ok, deepStrictEqual, strictEqual, doesNotThrow, throws } from 'assert';
import * as Sinon from 'sinon';
import Transaction from '../lib/transaction';
import use from '../lib/use';
import release from '../lib/release';
import validateMemory from './util/validate-memory';
// To appease nodejs
const { spy, stub, SinonSpy, ...rest } = Sinon.default;
describe('Transaction', function() {
const suite = /** @type {any} */(this);
beforeEach(() => {
process.env.NODE_ENV = 'development';
suite.mount = document.createElement('div');
suite.input = `
<div>Hello world</div>
`;
suite.config = { inner: false, tasks: [spy()] };
});
afterEach(() => {
release(suite.mount);
validateMemory();
});
describe('create', () => {
it('will return a transaction instance', () => {
const { mount, input, config } = suite;
const transaction = new Transaction(mount, input, config);
ok(transaction instanceof Transaction);
});
it('will attach relevant properties to the transaction instance', () => {
const { mount, input, config } = suite;
const transaction = new Transaction(mount, input, config);
const { tasks, state, endedCallbacks } = transaction;
deepStrictEqual({ ...transaction }, {
// Public.
mount,
input,
config,
tasks,
state,
endedCallbacks,
// Private
newTree: undefined,
oldTree: undefined,
patches: [],
});
});
});
describe('flow', () => {
it('will set up a single function to flow', () => {
const testFn = spy();
Transaction.flow(suite, [testFn]);
strictEqual(testFn.calledOnce, true);
strictEqual(testFn.calledWith(this), true);
});
it('will set up multiple functions to run', () => {
const testFn = spy();
const testFnTwo = spy();
Transaction.flow(suite, [testFn, testFnTwo]);
strictEqual(testFn.calledOnce, true);
strictEqual(testFnTwo.calledOnce, true);
});
it('will abort a flow when a function returns a value', () => {
const testFn = spy();
const testFnTwo = stub().returns(false);
const testFnThree = spy();
Transaction.flow(suite, [testFn, testFnTwo, testFnThree]);
strictEqual(testFn.calledOnce, true);
strictEqual(testFnTwo.calledOnce, true);
strictEqual(testFnThree.calledOnce, false);
});
it('will throw an exception if any values are not functions', () => {
const testFn = spy();
const testFnTwo = undefined;
const InvalidTransaction = /** @type {any} */ (Transaction);
throws(() => InvalidTransaction.flow(testFn, testFnTwo)());
});
it('will pass initial value as arguments to all functions', () => {
const testFnOne = spy();
const testFnTwo = spy();
Transaction.flow(suite, [testFnOne, testFnTwo]);
strictEqual(testFnOne.calledOnce, true);
strictEqual(testFnOne.calledWith(this), true);
strictEqual(testFnTwo.calledOnce, true);
strictEqual(testFnTwo.calledWith(this), true);
});
it('will force abort the flow, the last task will still execute', () => {
const testFnOne = transaction => transaction.abort(true);
const testFnTwo = spy();
const testFnThree = spy();
const transaction = Transaction.create(suite.mount, null, {
tasks: [testFnOne, testFnTwo, testFnThree],
});
transaction.start();
strictEqual(testFnTwo.called, false);
strictEqual(testFnThree.calledOnce, true);
strictEqual(testFnThree.calledWith(transaction), true);
});
it('will silently abort the flow', () => {
const testFnOne = transaction => transaction.abort(false);
const testFnTwo = spy();
const testFnThree = spy();
const transaction = Transaction.create(suite.mount, null, {
tasks: [testFnOne, testFnTwo, testFnThree],
});
transaction.start();
strictEqual(testFnTwo.called, false);
strictEqual(testFnThree.calledOnce, false);
strictEqual(testFnThree.calledWith(transaction), false);
});
});
describe('assert', () => {
it('will not error if not aborted or completd', () => {
const { mount, input } = suite;
const tasks = [
transaction => transaction.abort(),
spy(),
];
const transaction = Transaction.create(mount, input, { tasks });
transaction.aborted = false;
transaction.completed = false;
doesNotThrow(() => transaction.start());
transaction.end();
});
it('will error if a transaction has been aborted', () => {
const { mount, input } = suite;
const tasks = [
transaction => transaction.abort(),
spy(),
];
const transaction = Transaction.create(mount, input, { tasks });
transaction.aborted = true;
transaction.completed = true;
throws(() => transaction.start());
});
it('will error if a transaction has been completed', () => {
const { mount, input } = suite;
const tasks = [
transaction => transaction.abort(),
spy(),
];
const transaction = Transaction.create(mount, input, { tasks });
transaction.aborted = false;
transaction.completed = true;
throws(() => transaction.start());
});
});
describe('invokeMiddleware', () => {
it('will not modify the task flow if not provided a function', () => {
const { mount, input, config } = suite;
const transaction = Transaction.create(mount, input, config);
/** @type {unknown} */
const middleware = spy();
const unsubscribe = use(middleware);
Transaction.invokeMiddleware(transaction);
strictEqual(transaction.tasks.length, 1);
unsubscribe();
});
it('will modify the task flow if provided a function', () => {
const { mount, input, config } = suite;
const transaction = Transaction.create(mount, input, config);
const task = spy();
/** @type {unknown} */
const middleware = () => task;
const unsubscribe = use(middleware);
Transaction.invokeMiddleware(transaction);
strictEqual(transaction.tasks.length, 2);
unsubscribe();
});
});
describe('start', () => {
it('will not error in production if trying to start a transaction without a dom node', () => {
process.env.NODE_ENV = 'production';
const { mount, input, config } = suite;
const transaction = Transaction.create(mount, input, config);
transaction.mount = null;
doesNotThrow(() => {
transaction.start();
});
});
it('will error in development if trying to start a transaction without a dom node', () => {
const { mount, input, config } = suite;
const transaction = Transaction.create(mount, input, config);
transaction.mount = null;
throws(() => {
transaction.start();
}, / /);
});
it('will error in development if trying to start a transaction without a dom node', () => {
const { mount, input, config } = suite;
const transaction = Transaction.create(mount, input, config);
transaction.mount = null;
throws(() => {
transaction.start();
}, / /);
});
it('will start a transaction', () => {
const { mount, input, config } = suite;
const transaction = Transaction.create(mount, input, config);
transaction.start();
const firstTask = /** @type {SinonSpy} */ (transaction.tasks[0]);
strictEqual(firstTask.calledOnce, true);
});
it('will start a transaction with middleware', () => {
const { mount, input, config } = suite;
const transaction = Transaction.create(mount, input, config);
const task = spy();
/** @type {unknown} */
const middleware = () => task;
const unsubscribe = use(middleware);
transaction.start();
strictEqual(transaction.tasks.length, 2);
unsubscribe();
});
it('will get the return value from the flow', async () => {
const { mount, input } = suite;
const token = {};
const tasks = [() => token];
const transaction = Transaction.create(mount, input, { tasks });
const returnValue = transaction.start();
strictEqual(returnValue, token);
});
});
describe('abort', () => {
it('will abort a transaction flow', () => {
const { mount, input, config } = suite;
const transaction = Transaction.create(mount, input, config);
transaction.start();
const returnValue = transaction.abort();
strictEqual(returnValue, undefined);
strictEqual(transaction.aborted, true);
});
it('will return the last tasks return value', () => {
const { mount, input } = suite;
const token = {};
const tasks = [() => token];
const transaction = Transaction.create(mount, input, { tasks });
transaction.start();
const returnValue = transaction.abort(true);
strictEqual(returnValue, token);
strictEqual(transaction.aborted, true);
});
});
describe('end', () => {
it('will mark the transaction as completed', () => {
const { mount, input, config } = suite;
const transaction = Transaction.create(mount, input, config);
transaction.end();
strictEqual(transaction.completed, true);
});
it('will change isRendering', () => {
const { mount, input, config } = suite;
const transaction = Transaction.create(mount, input, config);
transaction.start();
strictEqual(transaction.state.isRendering, undefined);
transaction.end();
strictEqual(transaction.state.isRendering, false);
});
});
describe('onceEnded', () => {
it('will register callbacks to run after ended', () => {
const { mount, input, config } = suite;
const transaction = Transaction.create(mount, input, config);
const fn = () => {};
transaction.onceEnded(fn);
strictEqual(transaction.endedCallbacks.size, 1);
});
it('will trigger onceEnded callbacks', () => {
const { mount, input, config } = suite;
const transaction = Transaction.create(mount, input, config);
const fn = spy();
transaction.onceEnded(fn);
transaction.end();
strictEqual(fn.calledOnce, true);
});
});
});