tsdf 7.1.0 → 8.0.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/.eslintrc.cjs +79 -16
  2. package/.vscode/tasks.json +11 -1
  3. package/fetch-orquestrator-scenarios.excalidraw +10115 -0
  4. package/package.json +21 -13
  5. package/src/collectionFetchOrquestrator.ts +23 -0
  6. package/src/collectionStore.ts +608 -0
  7. package/src/documentStore.ts +272 -0
  8. package/src/fetchOrquestrator.ts +335 -0
  9. package/src/listQueryStore.ts +1190 -0
  10. package/src/main.ts +22 -1
  11. package/src/storeShared.ts +5 -0
  12. package/src/useEnsureIsLoaded.ts +50 -0
  13. package/src/utils/filterAndMap.ts +20 -0
  14. package/src/utils/getCacheId.ts +19 -0
  15. package/src/utils/hooks.ts +110 -0
  16. package/src/utils/isObject.ts +3 -0
  17. package/src/utils/math.ts +7 -0
  18. package/src/utils/serializableClone.ts +3 -0
  19. package/src/utils/useLatestValue.ts +16 -0
  20. package/test/__snapshots__/listQueryStore.test.ts.snap +146 -0
  21. package/test/__snapshots__/listQueryStoreHooks.test.ts.snap +9 -0
  22. package/test/collectionStore.test.ts +523 -0
  23. package/test/collectionStoreHooks.test.tsx +651 -0
  24. package/test/documentStore.test.ts +183 -0
  25. package/test/documentStoreHooks.test.tsx +857 -0
  26. package/test/fetchOrquestrator.test.ts +913 -0
  27. package/test/listQueryStore.test.ts +1158 -0
  28. package/test/listQueryStoreHooks.test.tsx +662 -0
  29. package/test/listQueryStoreHooks2.test.tsx +483 -0
  30. package/test/listQueryStoreHooksMutations.test.tsx +764 -0
  31. package/test/mocks/fetchMock.ts +296 -0
  32. package/test/mocks/fetchOrquestratorEnv.ts +370 -0
  33. package/test/setup/setup.ts +95 -1
  34. package/test/testHelpers.test.ts +88 -0
  35. package/test/utils/RenderObjValues.tsx +23 -0
  36. package/test/utils/arrayUtils.ts +13 -0
  37. package/test/utils/createDefaultListQueryStore.ts +275 -0
  38. package/test/utils/createOrVariations.ts +48 -0
  39. package/test/utils/dedent.ts +50 -0
  40. package/test/utils/delayCall.ts +25 -0
  41. package/test/utils/math.ts +3 -0
  42. package/test/utils/objectUtils.ts +18 -0
  43. package/test/utils/range.ts +19 -0
  44. package/test/utils/sleep.ts +3 -0
  45. package/test/utils/storeUtils.ts +460 -0
  46. package/tsconfig.prod.json +1 -1
  47. package/tsup.config.ts +1 -1
  48. package/vitest.config.ts +2 -1
  49. package/test/test.test.ts +0 -5
@@ -0,0 +1,523 @@
1
+ /* eslint-disable @typescript-eslint/no-unsafe-call */
2
+ /* eslint-disable @typescript-eslint/no-unsafe-member-access */
3
+ import { describe, expect, test } from 'vitest';
4
+ import { sleep } from './utils/sleep';
5
+ import {
6
+ createDefaultCollectionStore,
7
+ DefaultCollectionState,
8
+ } from './utils/storeUtils';
9
+
10
+ const createTestEnv = createDefaultCollectionStore;
11
+
12
+ async function waitInitializationFetch(store: any) {
13
+ store.scheduleFetch('lowPriority', '1');
14
+ await sleep(35);
15
+ }
16
+
17
+ const defaultTodo = { title: 'todo', completed: false };
18
+
19
+ describe('test helpers', () => {
20
+ test('start with store initialized state', () => {
21
+ const { store: collectionStore } = createTestEnv({
22
+ initialServerData: { '1': defaultTodo, '2': defaultTodo },
23
+ useLoadedSnapshot: true,
24
+ });
25
+
26
+ expect(collectionStore.store.state).toEqual({
27
+ '1': {
28
+ data: { completed: false, title: 'todo' },
29
+ error: null,
30
+ payload: '1',
31
+ refetchOnMount: false,
32
+ status: 'success',
33
+ wasLoaded: true,
34
+ },
35
+ '2': {
36
+ data: { completed: false, title: 'todo' },
37
+ error: null,
38
+ payload: '2',
39
+ refetchOnMount: false,
40
+ status: 'success',
41
+ wasLoaded: true,
42
+ },
43
+ });
44
+ });
45
+ });
46
+
47
+ describe('fetch lifecicle', () => {
48
+ const { serverMock, store: collectionStore } = createTestEnv();
49
+
50
+ test('fetch resource', async () => {
51
+ expect(collectionStore.store.state).toEqual<DefaultCollectionState>({});
52
+
53
+ collectionStore.scheduleFetch('lowPriority', '1');
54
+
55
+ expect(collectionStore.store.state).toEqual<DefaultCollectionState>({
56
+ '1': {
57
+ data: null,
58
+ error: null,
59
+ refetchOnMount: false,
60
+ status: 'loading',
61
+ payload: '1',
62
+ wasLoaded: false,
63
+ },
64
+ });
65
+
66
+ await sleep(serverMock.fetchDuration + 5);
67
+
68
+ expect(collectionStore.store.state).toEqual<DefaultCollectionState>({
69
+ '1': {
70
+ data: { title: 'todo', completed: false },
71
+ error: null,
72
+ refetchOnMount: false,
73
+ status: 'success',
74
+ payload: '1',
75
+ wasLoaded: true,
76
+ },
77
+ });
78
+
79
+ expect(serverMock.fetchsCount).toBe(1);
80
+ });
81
+
82
+ test('refetch resource with new data', async () => {
83
+ serverMock.mutateData({
84
+ '1': {
85
+ title: 'new title',
86
+ completed: false,
87
+ },
88
+ });
89
+
90
+ collectionStore.scheduleFetch('highPriority', '1');
91
+
92
+ expect(collectionStore.store.state).toEqual<DefaultCollectionState>({
93
+ '1': {
94
+ data: { title: 'todo', completed: false },
95
+ error: null,
96
+ refetchOnMount: false,
97
+ status: 'refetching',
98
+ payload: '1',
99
+ wasLoaded: true,
100
+ },
101
+ });
102
+
103
+ await sleep(serverMock.fetchDuration + 5);
104
+
105
+ expect(collectionStore.store.state).toEqual<DefaultCollectionState>({
106
+ '1': {
107
+ data: { title: 'new title', completed: false },
108
+ error: null,
109
+ refetchOnMount: false,
110
+ status: 'success',
111
+ payload: '1',
112
+ wasLoaded: true,
113
+ },
114
+ });
115
+
116
+ expect(serverMock.fetchsCount).toBe(2);
117
+ });
118
+
119
+ test('refetch resource with error', async () => {
120
+ serverMock.setFetchError('error');
121
+
122
+ collectionStore.scheduleFetch('highPriority', '1');
123
+
124
+ await sleep(serverMock.fetchDuration + 5);
125
+
126
+ expect(collectionStore.store.state).toEqual<DefaultCollectionState>({
127
+ '1': {
128
+ data: { title: 'new title', completed: false },
129
+ error: { message: 'error' },
130
+ refetchOnMount: false,
131
+ status: 'error',
132
+ payload: '1',
133
+ wasLoaded: true,
134
+ },
135
+ });
136
+ });
137
+ });
138
+
139
+ test.concurrent(
140
+ 'multiple low priority fetchs at same time trigger only one fetch',
141
+ async () => {
142
+ const { serverMock, store: collectionStore } = createTestEnv();
143
+
144
+ collectionStore.scheduleFetch('lowPriority', '1');
145
+ collectionStore.scheduleFetch('lowPriority', '1');
146
+ collectionStore.scheduleFetch('lowPriority', '1');
147
+ collectionStore.scheduleFetch('lowPriority', '1');
148
+
149
+ expect(collectionStore.store.state).toEqual<DefaultCollectionState>({
150
+ '1': {
151
+ data: null,
152
+ error: null,
153
+ payload: '1',
154
+ refetchOnMount: false,
155
+ status: 'loading',
156
+ wasLoaded: false,
157
+ },
158
+ });
159
+
160
+ await sleep(serverMock.fetchDuration + 5);
161
+
162
+ expect(serverMock.fetchsCount).toEqual(1);
163
+
164
+ expect(collectionStore.store.state).toEqual<DefaultCollectionState>({
165
+ '1': {
166
+ data: { title: 'todo', completed: false },
167
+ error: null,
168
+ refetchOnMount: false,
169
+ status: 'success',
170
+ payload: '1',
171
+ wasLoaded: true,
172
+ },
173
+ });
174
+ },
175
+ );
176
+
177
+ test.concurrent('initialization fetch', async () => {
178
+ const { store: collectionStore } = createTestEnv();
179
+
180
+ await waitInitializationFetch(collectionStore);
181
+
182
+ expect(collectionStore.store.state).toEqual<DefaultCollectionState>({
183
+ '1': {
184
+ data: { title: 'todo', completed: false },
185
+ error: null,
186
+ refetchOnMount: false,
187
+ status: 'success',
188
+ payload: '1',
189
+ wasLoaded: true,
190
+ },
191
+ });
192
+ });
193
+
194
+ test.concurrent('await fetch', async () => {
195
+ const { serverMock, store: collectionStore } = createTestEnv();
196
+
197
+ await waitInitializationFetch(collectionStore);
198
+
199
+ serverMock.mutateData({ '1': { title: 'new title', completed: false } });
200
+
201
+ expect(collectionStore.getItemState('1')).toMatchObject({
202
+ data: { title: 'todo', completed: false },
203
+ });
204
+
205
+ expect(await collectionStore.awaitFetch('1')).toEqual({
206
+ data: { title: 'new title', completed: false },
207
+ error: null,
208
+ });
209
+
210
+ serverMock.setFetchError('error');
211
+
212
+ expect(await collectionStore.awaitFetch('1')).toEqual({
213
+ data: null,
214
+ error: {
215
+ message: 'error',
216
+ },
217
+ });
218
+
219
+ expect(serverMock.fetchsCount).toEqual(3);
220
+ });
221
+
222
+ test.concurrent(
223
+ 'multiple fetchs with different payloads not cancel each other, but cancel same payload fetchs',
224
+ async () => {
225
+ const { serverMock, store: collectionStore } = createTestEnv({
226
+ initialServerData: {
227
+ '1': defaultTodo,
228
+ '2': defaultTodo,
229
+ '3': defaultTodo,
230
+ '4': defaultTodo,
231
+ '5': defaultTodo,
232
+ '6': defaultTodo,
233
+ '7': defaultTodo,
234
+ },
235
+ });
236
+
237
+ collectionStore.scheduleFetch('lowPriority', '1');
238
+ collectionStore.scheduleFetch('lowPriority', '2');
239
+ collectionStore.scheduleFetch('lowPriority', '3');
240
+ collectionStore.scheduleFetch('lowPriority', '4');
241
+ collectionStore.scheduleFetch('lowPriority', '5');
242
+ collectionStore.scheduleFetch('lowPriority', '6');
243
+ collectionStore.scheduleFetch('lowPriority', '7');
244
+
245
+ await sleep(10);
246
+
247
+ collectionStore.scheduleFetch('lowPriority', '1');
248
+ collectionStore.scheduleFetch('lowPriority', '2');
249
+ collectionStore.scheduleFetch('lowPriority', '3');
250
+ collectionStore.scheduleFetch('lowPriority', '4');
251
+ collectionStore.scheduleFetch('lowPriority', '5');
252
+ collectionStore.scheduleFetch('lowPriority', '6');
253
+ collectionStore.scheduleFetch('lowPriority', '7');
254
+
255
+ await sleep(serverMock.fetchDuration + 5);
256
+
257
+ expect(serverMock.fetchsCount).toEqual(7);
258
+
259
+ const defaultState = {
260
+ data: defaultTodo,
261
+ error: null,
262
+ refetchOnMount: false as const,
263
+ status: 'success' as const,
264
+ wasLoaded: true,
265
+ };
266
+
267
+ expect(collectionStore.store.state).toEqual<DefaultCollectionState>({
268
+ '1': { ...defaultState, payload: '1' },
269
+ '2': { ...defaultState, payload: '2' },
270
+ '3': { ...defaultState, payload: '3' },
271
+ '4': { ...defaultState, payload: '4' },
272
+ '5': { ...defaultState, payload: '5' },
273
+ '6': { ...defaultState, payload: '6' },
274
+ '7': { ...defaultState, payload: '7' },
275
+ });
276
+ },
277
+ );
278
+
279
+ describe('update state functions', () => {
280
+ const initialServerData = {
281
+ '1': { ...defaultTodo, completed: true },
282
+ '2': { ...defaultTodo, completed: true },
283
+ '3': defaultTodo,
284
+ '4': defaultTodo,
285
+ '5': defaultTodo,
286
+ };
287
+
288
+ describe('updateItemState', () => {
289
+ test('update state of one item', () => {
290
+ const { store } = createTestEnv({
291
+ initialServerData,
292
+ useLoadedSnapshot: true,
293
+ });
294
+
295
+ expect(store.getItemState('1')?.data).toEqual({
296
+ completed: true,
297
+ title: 'todo',
298
+ });
299
+
300
+ store.updateItemState('1', (data) => {
301
+ data.title = 'new title';
302
+ });
303
+
304
+ expect(store.getItemState('1')?.data).toEqual({
305
+ completed: true,
306
+ title: 'new title',
307
+ });
308
+ });
309
+
310
+ test('update multiple itens state', () => {
311
+ const { store } = createTestEnv({
312
+ initialServerData,
313
+ useLoadedSnapshot: true,
314
+ });
315
+
316
+ store.updateItemState(['1', '2'], () => {
317
+ return {
318
+ title: 'new title 2',
319
+ completed: false,
320
+ };
321
+ });
322
+
323
+ expect(
324
+ store.getItemState(['1', '2', '3']).map((item) => {
325
+ return { id: item.payload, ...item.data };
326
+ }),
327
+ ).toEqual([
328
+ { completed: false, id: '1', title: 'new title 2' },
329
+ { completed: false, id: '2', title: 'new title 2' },
330
+ // 3 is not updated
331
+ { completed: false, id: '3', title: 'todo' },
332
+ ]);
333
+ });
334
+
335
+ test('update multiple itens state with filter fn', () => {
336
+ const { store } = createTestEnv({
337
+ initialServerData,
338
+ useLoadedSnapshot: true,
339
+ });
340
+
341
+ store.updateItemState(
342
+ (_, data) => !!data?.completed,
343
+ (data) => {
344
+ data.completed = false;
345
+ data.title = 'modified';
346
+ },
347
+ );
348
+
349
+ expect(
350
+ store
351
+ .getItemState(() => true)
352
+ .map((item) => {
353
+ return { id: item.payload, ...item.data };
354
+ }),
355
+ ).toEqual([
356
+ { completed: false, id: '1', title: 'modified' },
357
+ { completed: false, id: '2', title: 'modified' },
358
+ { completed: false, id: '3', title: 'todo' },
359
+ { completed: false, id: '4', title: 'todo' },
360
+ { completed: false, id: '5', title: 'todo' },
361
+ ]);
362
+ });
363
+
364
+ test('create if not exist', () => {
365
+ const { store } = createTestEnv({
366
+ initialServerData,
367
+ useLoadedSnapshot: true,
368
+ });
369
+
370
+ let storeUpdates = 0;
371
+ store.store.subscribe(() => {
372
+ storeUpdates++;
373
+ });
374
+
375
+ store.updateItemState(
376
+ '6',
377
+ (data) => {
378
+ data.title = 'item 6';
379
+ },
380
+ () => {
381
+ store.addItemToState('6', {
382
+ title: 'item 6',
383
+ completed: false,
384
+ });
385
+ },
386
+ );
387
+
388
+ expect(storeUpdates).toEqual(1);
389
+
390
+ expect(store.getItemState('6')).toEqual({
391
+ data: { completed: false, title: 'item 6' },
392
+ error: null,
393
+ payload: '6',
394
+ refetchOnMount: false,
395
+ status: 'success',
396
+ wasLoaded: true,
397
+ });
398
+ });
399
+
400
+ test('create multiple if not exist', () => {
401
+ const { store } = createTestEnv({
402
+ initialServerData,
403
+ useLoadedSnapshot: true,
404
+ });
405
+
406
+ let storeUpdates = 0;
407
+ store.store.subscribe(() => {
408
+ storeUpdates++;
409
+ });
410
+
411
+ store.updateItemState(
412
+ (id) => id === '?',
413
+ (data) => {
414
+ data.title = 'item 6';
415
+ },
416
+ () => {
417
+ store.addItemToState('6', {
418
+ title: 'item 6',
419
+ completed: false,
420
+ });
421
+ store.addItemToState('7', {
422
+ title: 'item 7',
423
+ completed: false,
424
+ });
425
+ },
426
+ );
427
+
428
+ expect(storeUpdates).toEqual(1);
429
+
430
+ expect(store.getItemState(['6', '7', '5'])).toEqual([
431
+ {
432
+ data: { completed: false, title: 'item 6' },
433
+ error: null,
434
+ payload: '6',
435
+ refetchOnMount: false,
436
+ status: 'success',
437
+ wasLoaded: true,
438
+ },
439
+ {
440
+ data: { completed: false, title: 'item 7' },
441
+ error: null,
442
+ payload: '7',
443
+ refetchOnMount: false,
444
+ status: 'success',
445
+ wasLoaded: true,
446
+ },
447
+ {
448
+ data: { completed: false, title: 'todo' },
449
+ error: null,
450
+ payload: '5',
451
+ refetchOnMount: false,
452
+ status: 'success',
453
+ wasLoaded: true,
454
+ },
455
+ ]);
456
+ });
457
+ });
458
+
459
+ test('addItemToState', () => {
460
+ const { store: collectionStore } = createTestEnv({
461
+ initialServerData,
462
+ useLoadedSnapshot: true,
463
+ });
464
+
465
+ expect(collectionStore.getItemState('6')).toBeUndefined();
466
+
467
+ collectionStore.addItemToState('6', {
468
+ title: 'item 6',
469
+ completed: false,
470
+ });
471
+
472
+ expect(collectionStore.getItemState('6')).toEqual({
473
+ data: { completed: false, title: 'item 6' },
474
+ error: null,
475
+ payload: '6',
476
+ refetchOnMount: false,
477
+ status: 'success',
478
+ wasLoaded: true,
479
+ });
480
+ });
481
+
482
+ test('deleteItemState', () => {
483
+ const { store } = createTestEnv({
484
+ initialServerData,
485
+ useLoadedSnapshot: true,
486
+ });
487
+
488
+ expect(store.getItemState('1')).toBeDefined();
489
+
490
+ store.deleteItemState('1');
491
+
492
+ expect(store.getItemState('1')).toBeNull();
493
+
494
+ expect(store.scheduleFetch('highPriority', '1')).toBe('started');
495
+ });
496
+ });
497
+
498
+ test('mutation a obj passed as payload does not breaks the store', () => {
499
+ const env = createTestEnv<{ id: { id: string } }>({});
500
+
501
+ const obj = { id: { id: '1' } };
502
+
503
+ env.store.scheduleFetch('highPriority', obj);
504
+
505
+ env.serverMock.waitFetchIdle();
506
+
507
+ obj.id.id = '2';
508
+
509
+ expect(env.store.getItemState({ id: { id: '1' } })).toMatchInlineSnapshot(`
510
+ {
511
+ "data": null,
512
+ "error": null,
513
+ "payload": {
514
+ "id": {
515
+ "id": "1",
516
+ },
517
+ },
518
+ "refetchOnMount": false,
519
+ "status": "loading",
520
+ "wasLoaded": false,
521
+ }
522
+ `);
523
+ });