-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
result.spec.ts
484 lines (417 loc) · 15.7 KB
/
result.spec.ts
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
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
import { z } from 'zod';
import { logger } from '../../test/util';
import { AsyncResult, Result } from './result';
describe('util/result', () => {
describe('Result', () => {
describe('constructors', () => {
it('ok result', () => {
const res = Result.ok(42);
expect(res).toEqual({
res: {
ok: true,
val: 42,
},
});
});
it('error result', () => {
const res = Result.err('oops');
expect(res).toEqual({
res: {
ok: false,
err: 'oops',
},
});
});
});
describe('Wrapping', () => {
it('wraps callback', () => {
const res = Result.wrap(() => 42);
expect(res).toEqual(Result.ok(42));
});
it('handles callback error', () => {
const res = Result.wrap(() => {
throw 'oops';
});
expect(res).toEqual(Result.err('oops'));
});
it('wraps nullable callback', () => {
const res = Result.wrapNullable(() => 42, 'oops');
expect(res).toEqual(Result.ok(42));
});
it('wraps nullable callback null', () => {
const res = Result.wrapNullable(() => null, 'oops');
expect(res).toEqual(Result.err('oops'));
});
it('wraps nullable callback undefined', () => {
const res = Result.wrapNullable(() => undefined, 'oops');
expect(res).toEqual(Result.err('oops'));
});
it('distincts between null and undefined callback results', () => {
expect(Result.wrapNullable(() => null, 'null', 'undefined')).toEqual(
Result.err('null')
);
expect(
Result.wrapNullable(() => undefined, 'null', 'undefined')
).toEqual(Result.err('undefined'));
});
it('handles nullable callback error', () => {
const res = Result.wrapNullable(() => {
throw 'oops';
}, 'nullable');
expect(res).toEqual(Result.err('oops'));
});
it('wraps zod parse result', () => {
const schema = z.string().transform((x) => x.toUpperCase());
expect(Result.wrap(schema.safeParse('foo'))).toEqual(Result.ok('FOO'));
expect(Result.wrap(schema.safeParse(42))).toMatchObject(
Result.err({
issues: [
{ code: 'invalid_type', expected: 'string', received: 'number' },
],
})
);
});
});
describe('Unwrapping', () => {
it('unwraps successful value', () => {
const res = Result.ok(42);
expect(res.unwrap()).toEqual({
ok: true,
val: 42,
});
});
it('unwraps error value', () => {
const res = Result.err('oops');
expect(res.unwrap()).toEqual({
ok: false,
err: 'oops',
});
});
it('skips fallback for successful value', () => {
const res: Result<number> = Result.ok(42);
expect(res.unwrap(-1)).toBe(42);
});
it('uses fallback for error value', () => {
const res: Result<number, string> = Result.err('oops');
expect(res.unwrap(42)).toBe(42);
});
it('throws error uncaught in the failed transform', () => {
const res = Result.ok(42);
expect(() =>
res
.transform(() => {
throw 'oops';
})
.unwrap()
).toThrow('oops');
});
it('returns ok-value for unwrapOrThrow', () => {
const res = Result.ok(42);
expect(res.unwrapOrThrow()).toBe(42);
});
it('throws error for unwrapOrThrow on error result', () => {
const res = Result.err('oops');
expect(() => res.unwrapOrThrow()).toThrow('oops');
});
});
describe('Transforming', () => {
it('transforms value to value', () => {
const res = Result.ok('foo').transform((x) => x.toUpperCase());
expect(res).toEqual(Result.ok('FOO'));
});
it('transforms value to Result', () => {
const res = Result.ok('foo').transform((x) =>
Result.ok(x.toUpperCase())
);
expect(res).toEqual(Result.ok('FOO'));
});
it('skips transform for error Result', () => {
const res: Result<number, string> = Result.err('oops');
const fn = jest.fn((x: number) => x + 1);
expect(res.transform(fn)).toEqual(Result.err('oops'));
expect(fn).not.toHaveBeenCalled();
});
it('logs and returns error on transform failure', () => {
const res = Result.ok('foo').transform(() => {
throw 'oops';
});
expect(res).toEqual(Result._uncaught('oops'));
expect(logger.logger.warn).toHaveBeenCalledWith(
{ err: 'oops' },
'Result: unhandled transform error'
);
});
it('automatically converts zod values', () => {
const schema = z.string().transform((x) => x.toUpperCase());
const res = Result.ok('foo').transform((x) => schema.safeParse(x));
expect(res).toEqual(Result.ok('FOO'));
});
});
describe('Catch', () => {
it('bypasses ok result', () => {
const res = Result.ok(42);
expect(res.catch(() => Result.ok(0))).toEqual(Result.ok(42));
expect(res.catch(() => Result.ok(0))).toBe(res);
});
it('bypasses uncaught transform errors', () => {
const res = Result.ok(42).transform(() => {
throw 'oops';
});
expect(res.catch(() => Result.ok(0))).toEqual(Result._uncaught('oops'));
expect(res.catch(() => Result.ok(0))).toBe(res);
});
it('converts error to Result', () => {
const result = Result.err<string>('oops').catch(() =>
Result.ok<number>(42)
);
expect(result).toEqual(Result.ok(42));
});
it('handles error thrown in catch function', () => {
const result = Result.err<string>('oops').catch(() => {
throw 'oops';
});
expect(result).toEqual(Result._uncaught('oops'));
});
});
});
describe('AsyncResult', () => {
describe('Wrapping', () => {
it('wraps promise', async () => {
const res: AsyncResult<number, string> = Result.wrap(
Promise.resolve(42)
);
await expect(res).resolves.toEqual(Result.ok(42));
});
it('wraps Result promise', async () => {
const res: AsyncResult<number, string> = Result.wrap(
Promise.resolve(Result.ok(42))
);
await expect(res).resolves.toEqual(Result.ok(42));
});
it('handles rejected promise', async () => {
const res: AsyncResult<number, string> = Result.wrap(
Promise.reject('oops')
);
await expect(res).resolves.toEqual(Result.err('oops'));
});
it('wraps nullable promise', async () => {
const res = Result.wrapNullable(Promise.resolve(42), 'oops');
await expect(res).resolves.toEqual(Result.ok(42));
});
it('wraps promise returning null', async () => {
const res = Result.wrapNullable(Promise.resolve(null), 'oops');
await expect(res).resolves.toEqual(Result.err('oops'));
});
it('wraps promise returning undefined', async () => {
const res = Result.wrapNullable(Promise.resolve(undefined), 'oops');
await expect(res).resolves.toEqual(Result.err('oops'));
});
it('distincts between null and undefined promise results', async () => {
await expect(
Result.wrapNullable(Promise.resolve(null), 'null', 'undefined')
).resolves.toEqual(Result.err('null'));
await expect(
Result.wrapNullable(Promise.resolve(undefined), 'null', 'undefined')
).resolves.toEqual(Result.err('undefined'));
});
it('handles rejected nullable promise', async () => {
const res = Result.wrapNullable(Promise.reject('oops'), 'nullable');
await expect(res).resolves.toEqual(Result.err('oops'));
});
});
describe('Unwrapping', () => {
it('unwraps successful AsyncResult', async () => {
const res = Result.wrap(Promise.resolve(42));
await expect(res.unwrap()).resolves.toEqual({
ok: true,
val: 42,
});
});
it('unwraps error AsyncResult', async () => {
const res = Result.wrap(Promise.reject('oops'));
await expect(res.unwrap()).resolves.toEqual({
ok: false,
err: 'oops',
});
});
it('skips fallback for successful AsyncResult', async () => {
const res = Result.wrap(Promise.resolve(42));
await expect(res.unwrap(0)).resolves.toBe(42);
});
it('uses fallback for error AsyncResult', async () => {
const res = Result.wrap(Promise.reject('oops'));
await expect(res.unwrap(42)).resolves.toBe(42);
});
it('returns ok-value for unwrapOrThrow', async () => {
const res = Result.wrap(Promise.resolve(42));
await expect(res.unwrapOrThrow()).resolves.toBe(42);
});
it('rejects for error for unwrapOrThrow', async () => {
const res = Result.wrap(Promise.reject('oops'));
await expect(res.unwrapOrThrow()).rejects.toBe('oops');
});
});
describe('Transforming', () => {
it('transforms AsyncResult to pure value', async () => {
const res = await AsyncResult.ok('foo').transform((x) =>
x.toUpperCase()
);
expect(res).toEqual(Result.ok('FOO'));
});
it('transforms AsyncResult to Result', async () => {
const res = await AsyncResult.ok('foo').transform((x) =>
Result.ok(x.toUpperCase())
);
expect(res).toEqual(Result.ok('FOO'));
});
it('transforms Result to AsyncResult', async () => {
const res = await Result.ok('foo').transform((x) =>
AsyncResult.ok(x.toUpperCase())
);
expect(res).toEqual(Result.ok('FOO'));
});
it('transforms AsyncResult to AsyncResult', async () => {
const res = await AsyncResult.ok('foo').transform((x) =>
AsyncResult.ok(x.toUpperCase())
);
expect(res).toEqual(Result.ok('FOO'));
});
it('skips transform for failed promises', async () => {
const res = AsyncResult.err('oops');
const fn = jest.fn((x: number) => x + 1);
await expect(res.transform(fn)).resolves.toEqual(Result.err('oops'));
expect(fn).not.toHaveBeenCalled();
});
it('asyncronously transforms successfull promise to value', async () => {
const res = await AsyncResult.ok('foo').transform((x) =>
Promise.resolve(x.toUpperCase())
);
expect(res).toEqual(Result.ok('FOO'));
});
it('asynchronously transforms successful AsyncResult to Result', async () => {
const res = await AsyncResult.ok('foo').transform((x) =>
Promise.resolve(Result.ok(x.toUpperCase()))
);
expect(res).toEqual(Result.ok('FOO'));
});
it('asynchronously transforms value to value', async () => {
const res = await Result.ok('foo').transform((x) =>
Promise.resolve(x.toUpperCase())
);
expect(res).toEqual(Result.ok('FOO'));
});
it('asynchronously transforms value to Result', async () => {
const res = await Result.ok('foo').transform((x) =>
Promise.resolve(Result.ok(x.toUpperCase()))
);
expect(res).toEqual(Result.ok('FOO'));
});
it('skips async transform for error Result', async () => {
const input: Result<number, string> = Result.err('oops');
const fn = jest.fn((x: number) => Promise.resolve(x + 1));
const res = await input.transform(fn);
expect(res).toEqual(Result.err('oops'));
expect(fn).not.toHaveBeenCalled();
});
it('skips async transform for rejected promise', async () => {
const res: AsyncResult<number, string> = AsyncResult.err('oops');
const fn = jest.fn((x: number) => Promise.resolve(x + 1));
await expect(res.transform(fn)).resolves.toEqual(Result.err('oops'));
expect(fn).not.toHaveBeenCalled();
});
it('re-wraps error thrown via unwrapping in async transform', async () => {
const res = await AsyncResult.ok(42)
.transform(async (): Promise<number> => {
await Promise.resolve();
throw 'oops';
})
.transform((x) => x + 1);
expect(res).toEqual(Result._uncaught('oops'));
});
it('handles error thrown on Result async transform', async () => {
const res = Result.ok('foo');
await expect(
res.transform((_) => Promise.reject('oops'))
).resolves.toEqual(Result._uncaught('oops'));
expect(logger.logger.warn).toHaveBeenCalledWith(
{ err: 'oops' },
'Result: unhandled async transform error'
);
});
it('handles error thrown on promise transform', async () => {
const res = AsyncResult.ok('foo');
await expect(
res.transform(() => {
throw 'bar';
})
).resolves.toEqual(Result._uncaught('bar'));
expect(logger.logger.warn).toHaveBeenCalledWith(
{ err: 'bar' },
'AsyncResult: unhandled transform error'
);
});
it('handles error thrown on promise async transform', async () => {
const res = AsyncResult.ok('foo');
await expect(
res.transform(() => Promise.reject('bar'))
).resolves.toEqual(Result._uncaught('bar'));
expect(logger.logger.warn).toHaveBeenCalledWith(
{ err: 'bar' },
'AsyncResult: unhandled async transform error'
);
});
it('accumulates error types into union type during chained transform', async () => {
const fn1 = (x: string): Result<string, string> =>
Result.ok(x.toUpperCase());
const fn2 = (x: string): Result<string[], number> =>
Result.ok(x.split(''));
const fn3 = (x: string[]): Result<string, boolean> =>
Result.ok(x.join('-'));
type Res = Result<string, string | number | boolean>;
const res: Res = await AsyncResult.ok('foo')
.transform(fn1)
.transform(fn2)
.transform(fn3);
expect(res).toEqual(Result.ok('F-O-O'));
});
it('asynchronously transforms Result to zod values', async () => {
const schema = z.string().transform((x) => x.toUpperCase());
const res = await Result.ok('foo').transform((x) =>
Promise.resolve(schema.safeParse(x))
);
expect(res).toEqual(Result.ok('FOO'));
});
it('transforms AsyncResult to zod values', async () => {
const schema = z.string().transform((x) => x.toUpperCase());
const res = await AsyncResult.ok('foo').transform((x) =>
schema.safeParse(x)
);
expect(res).toEqual(Result.ok('FOO'));
});
});
describe('Catch', () => {
it('converts error to AsyncResult', async () => {
const result = await Result.err<string>('oops').catch(() =>
AsyncResult.ok(42)
);
expect(result).toEqual(Result.ok(42));
});
it('converts error to Promise', async () => {
const fallback = Promise.resolve(Result.ok(42));
const result = await Result.err<string>('oops').catch(() => fallback);
expect(result).toEqual(Result.ok(42));
});
it('handles error thrown in Promise result', async () => {
const fallback = Promise.reject('oops');
const result = await Result.err<string>('oops').catch(() => fallback);
expect(result).toEqual(Result._uncaught('oops'));
});
it('converts AsyncResult error to Result', async () => {
const result = await AsyncResult.err<string>('oops').catch(() =>
AsyncResult.ok<number>(42)
);
expect(result).toEqual(Result.ok(42));
});
});
});
});