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,483 @@
1
+ import { cleanup, render, renderHook } from '@testing-library/react';
2
+ import { afterEach, describe, expect, test } from 'vitest';
3
+ import {
4
+ createDefaultListQueryStore,
5
+ ListQueryParams,
6
+ Tables,
7
+ } from './utils/createDefaultListQueryStore';
8
+ import { range } from './utils/range';
9
+ import { sleep } from './utils/sleep';
10
+ import { createRenderStore, shouldNotSkip } from './utils/storeUtils';
11
+
12
+ const initialServerData: Tables = {
13
+ users: range(1, 5).map((id) => ({ id, name: `User ${id}` })),
14
+ products: range(1, 50).map((id) => ({ id, name: `Product ${id}` })),
15
+ orders: range(1, 50).map((id) => ({ id, name: `Order ${id}` })),
16
+ };
17
+
18
+ export const createTestEnv = createDefaultListQueryStore;
19
+
20
+ const CompWithItemLoaded = ({
21
+ disableRefetchOnMount = true,
22
+ store,
23
+ loadItem,
24
+ renderStore,
25
+ }: {
26
+ disableRefetchOnMount?: boolean;
27
+ store: ReturnType<typeof createTestEnv>['store'];
28
+ loadItem: string;
29
+ renderStore: ReturnType<typeof createRenderStore>;
30
+ }) => {
31
+ const { status, error, data, itemId } = store.useItem(loadItem, {
32
+ disableRefetchOnMount,
33
+ returnRefetchingStatus: true,
34
+ });
35
+
36
+ renderStore.add({ status, error, data, itemId });
37
+
38
+ return <div />;
39
+ };
40
+
41
+ const CompWithQueryLoaded = ({
42
+ disableRefetchOnMount = true,
43
+ store,
44
+ loadTable,
45
+ filters,
46
+ renderStore,
47
+ }: {
48
+ disableRefetchOnMount?: boolean;
49
+ store: ReturnType<typeof createTestEnv>['store'];
50
+ loadTable: string;
51
+ renderStore: ReturnType<typeof createRenderStore>;
52
+ filters?: ListQueryParams['filters'];
53
+ }) => {
54
+ const { status, error, items, payload } = store.useListQuery(
55
+ { tableId: loadTable, filters },
56
+ {
57
+ disableRefetchOnMount,
58
+ returnRefetchingStatus: true,
59
+ itemSelector: (data) => data,
60
+ },
61
+ );
62
+
63
+ renderStore.add({ status, error, items, payload });
64
+
65
+ return <div />;
66
+ };
67
+
68
+ function renderComponents({
69
+ store,
70
+ loadItem,
71
+ loadTable,
72
+ disableRefetchOnMount,
73
+ }: {
74
+ store: ReturnType<typeof createTestEnv>['store'];
75
+ loadItem: string;
76
+ loadTable: string;
77
+ disableRefetchOnMount: boolean;
78
+ }) {
79
+ const compWithItemLoadedRenders = createRenderStore();
80
+
81
+ const compWithQueryLoadedRenders = createRenderStore();
82
+
83
+ render(
84
+ <>
85
+ <CompWithItemLoaded
86
+ store={store}
87
+ loadItem={loadItem}
88
+ disableRefetchOnMount={disableRefetchOnMount}
89
+ renderStore={compWithItemLoadedRenders}
90
+ />
91
+ <CompWithQueryLoaded
92
+ store={store}
93
+ loadTable={loadTable}
94
+ disableRefetchOnMount={disableRefetchOnMount}
95
+ renderStore={compWithQueryLoadedRenders}
96
+ />
97
+ </>,
98
+ );
99
+
100
+ return { compWithItemLoadedRenders, compWithQueryLoadedRenders };
101
+ }
102
+
103
+ afterEach(() => {
104
+ cleanup();
105
+ });
106
+
107
+ test('refetch an query and after a few ms refetch an item', async () => {
108
+ const { store, serverMock } = createTestEnv({
109
+ initialServerData,
110
+ useLoadedSnapshot: { tables: ['users'] },
111
+ });
112
+
113
+ const { compWithItemLoadedRenders, compWithQueryLoadedRenders } =
114
+ renderComponents({
115
+ store,
116
+ disableRefetchOnMount: true,
117
+ loadItem: 'users||1',
118
+ loadTable: 'users',
119
+ });
120
+
121
+ serverMock.setFetchDuration(50);
122
+
123
+ shouldNotSkip(
124
+ store.scheduleListQueryFetch('highPriority', { tableId: 'users' }),
125
+ );
126
+
127
+ await sleep(40);
128
+
129
+ shouldNotSkip(store.scheduleItemFetch('highPriority', 'users||1'));
130
+
131
+ await serverMock.waitFetchIdle();
132
+
133
+ expect(compWithItemLoadedRenders.snapshot).toMatchInlineSnapshot(`
134
+ "
135
+ status: success -- error: null -- data: {id:1, name:User 1} -- itemId: users||1
136
+ status: refetching -- error: null -- data: {id:1, name:User 1} -- itemId: users||1
137
+ status: success -- error: null -- data: {id:1, name:User 1} -- itemId: users||1
138
+ "
139
+ `);
140
+ expect(compWithQueryLoadedRenders.snapshot).toMatchInlineSnapshot(`
141
+ "
142
+ status: success -- error: null -- items: [{id:1, name:User 1}, ...(4 more)] -- payload: {tableId:users}
143
+ status: refetching -- error: null -- items: [{id:1, name:User 1}, ...(4 more)] -- payload: {tableId:users}
144
+ status: success -- error: null -- items: [{id:1, name:User 1}, ...(4 more)] -- payload: {tableId:users}
145
+ "
146
+ `);
147
+ });
148
+
149
+ test('load an query and item at same time', async () => {
150
+ const { store, serverMock } = createTestEnv({
151
+ initialServerData,
152
+ useLoadedSnapshot: { tables: ['users'] },
153
+ });
154
+
155
+ const { compWithItemLoadedRenders, compWithQueryLoadedRenders } =
156
+ renderComponents({
157
+ store,
158
+ loadItem: 'users||1',
159
+ loadTable: 'users',
160
+ disableRefetchOnMount: false,
161
+ });
162
+
163
+ await serverMock.waitFetchIdle();
164
+
165
+ expect(compWithItemLoadedRenders.snapshot).toMatchInlineSnapshot(`
166
+ "
167
+ status: success -- error: null -- data: {id:1, name:User 1} -- itemId: users||1
168
+ status: refetching -- error: null -- data: {id:1, name:User 1} -- itemId: users||1
169
+ status: success -- error: null -- data: {id:1, name:User 1} -- itemId: users||1
170
+ "
171
+ `);
172
+ expect(compWithQueryLoadedRenders.snapshot).toMatchInlineSnapshot(`
173
+ "
174
+ status: success -- error: null -- items: [{id:1, name:User 1}, ...(4 more)] -- payload: {tableId:users}
175
+ status: refetching -- error: null -- items: [{id:1, name:User 1}, ...(4 more)] -- payload: {tableId:users}
176
+ status: success -- error: null -- items: [{id:1, name:User 1}, ...(4 more)] -- payload: {tableId:users}
177
+ "
178
+ `);
179
+
180
+ expect(serverMock.fetchsCount).toBe(2);
181
+ });
182
+
183
+ test('load a query and a few ms after load a item with different data', async () => {
184
+ const { store, serverMock } = createTestEnv({
185
+ initialServerData,
186
+ useLoadedSnapshot: { tables: ['users'] },
187
+ });
188
+
189
+ const { compWithItemLoadedRenders, compWithQueryLoadedRenders } =
190
+ renderComponents({
191
+ store,
192
+ disableRefetchOnMount: true,
193
+ loadItem: 'users||1',
194
+ loadTable: 'users',
195
+ });
196
+
197
+ serverMock.setFetchDuration(50);
198
+
199
+ shouldNotSkip(
200
+ store.scheduleListQueryFetch('highPriority', { tableId: 'users' }),
201
+ );
202
+
203
+ await sleep(45);
204
+ serverMock.produceData((draft) => {
205
+ draft.users![0]!.name = 'User 1 changed';
206
+ });
207
+
208
+ shouldNotSkip(store.scheduleItemFetch('highPriority', 'users||1'));
209
+
210
+ await serverMock.waitFetchIdle();
211
+
212
+ expect(compWithQueryLoadedRenders.snapshot).toMatchInlineSnapshot(`
213
+ "
214
+ status: success -- error: null -- items: [{id:1, name:User 1}, ...(4 more)] -- payload: {tableId:users}
215
+ status: refetching -- error: null -- items: [{id:1, name:User 1}, ...(4 more)] -- payload: {tableId:users}
216
+ status: success -- error: null -- items: [{id:1, name:User 1}, ...(4 more)] -- payload: {tableId:users}
217
+ status: success -- error: null -- items: [{id:1, name:User 1 changed}, ...(4 more)] -- payload: {tableId:users}
218
+ "
219
+ `);
220
+ expect(compWithItemLoadedRenders.snapshot).toMatchInlineSnapshot(`
221
+ "
222
+ status: success -- error: null -- data: {id:1, name:User 1} -- itemId: users||1
223
+ status: refetching -- error: null -- data: {id:1, name:User 1} -- itemId: users||1
224
+ status: success -- error: null -- data: {id:1, name:User 1 changed} -- itemId: users||1
225
+ "
226
+ `);
227
+
228
+ expect(serverMock.fetchsSequence()).toMatchInlineSnapshot(`
229
+ "
230
+ started: 0, result: [{id: 1, name: User 1}, ...(4 more)], params: users
231
+ started: 1, result: {id: 1, name: User 1 changed}, params: users||1
232
+ "
233
+ `);
234
+
235
+ expect(serverMock.fetchsCount).toBe(2);
236
+ });
237
+
238
+ test('load a item and a few ms after load a query with different data', async () => {
239
+ const { store, serverMock } = createTestEnv({
240
+ initialServerData,
241
+ useLoadedSnapshot: { tables: ['users'] },
242
+ });
243
+
244
+ const { compWithItemLoadedRenders, compWithQueryLoadedRenders } =
245
+ renderComponents({
246
+ store,
247
+ disableRefetchOnMount: true,
248
+ loadItem: 'users||1',
249
+ loadTable: 'users',
250
+ });
251
+
252
+ serverMock.setFetchDuration(50);
253
+
254
+ shouldNotSkip(store.scheduleItemFetch('highPriority', 'users||1'));
255
+
256
+ await sleep(45);
257
+ serverMock.produceData((draft) => {
258
+ draft.users![0]!.name = 'User 1 changed';
259
+ });
260
+
261
+ shouldNotSkip(
262
+ store.scheduleListQueryFetch('highPriority', { tableId: 'users' }),
263
+ );
264
+
265
+ await serverMock.waitFetchIdle();
266
+
267
+ expect(compWithQueryLoadedRenders.snapshot).toMatchInlineSnapshot(`
268
+ "
269
+ status: success -- error: null -- items: [{id:1, name:User 1}, ...(4 more)] -- payload: {tableId:users}
270
+ status: refetching -- error: null -- items: [{id:1, name:User 1}, ...(4 more)] -- payload: {tableId:users}
271
+ status: success -- error: null -- items: [{id:1, name:User 1 changed}, ...(4 more)] -- payload: {tableId:users}
272
+ "
273
+ `);
274
+ expect(compWithItemLoadedRenders.snapshot).toMatchInlineSnapshot(`
275
+ "
276
+ status: success -- error: null -- data: {id:1, name:User 1} -- itemId: users||1
277
+ status: refetching -- error: null -- data: {id:1, name:User 1} -- itemId: users||1
278
+ status: success -- error: null -- data: {id:1, name:User 1} -- itemId: users||1
279
+ status: success -- error: null -- data: {id:1, name:User 1 changed} -- itemId: users||1
280
+ "
281
+ `);
282
+
283
+ expect(serverMock.fetchsSequence()).toMatchInlineSnapshot(`
284
+ "
285
+ started: 0, result: {id: 1, name: User 1}, params: users||1
286
+ started: 1, result: [{id: 1, name: User 1 changed}, ...(4 more)], params: users
287
+ "
288
+ `);
289
+
290
+ expect(serverMock.fetchsCount).toBe(2);
291
+ });
292
+
293
+ describe('syncMutationAndInvalidation', () => {
294
+ test('invalidate related queries after item invalidation', async () => {
295
+ const { store, serverMock } = createTestEnv({
296
+ initialServerData,
297
+ useLoadedSnapshot: { tables: ['users', 'products'] },
298
+ });
299
+
300
+ const { compWithItemLoadedRenders, compWithQueryLoadedRenders } =
301
+ renderComponents({
302
+ store,
303
+ disableRefetchOnMount: true,
304
+ loadItem: 'users||1',
305
+ loadTable: 'users',
306
+ });
307
+
308
+ const comp3Renders = createRenderStore();
309
+
310
+ renderHook(() => {
311
+ const { status, error, items } = store.useListQuery(
312
+ { tableId: 'products' },
313
+ { disableRefetchOnMount: true },
314
+ );
315
+
316
+ comp3Renders.add({ status, error, items });
317
+ });
318
+
319
+ store.invalidateItem('users||1');
320
+
321
+ await serverMock.waitFetchIdle();
322
+
323
+ expect(compWithItemLoadedRenders.snapshot).toMatchInlineSnapshot(`
324
+ "
325
+ status: success -- error: null -- data: {id:1, name:User 1} -- itemId: users||1
326
+ status: refetching -- error: null -- data: {id:1, name:User 1} -- itemId: users||1
327
+ status: success -- error: null -- data: {id:1, name:User 1} -- itemId: users||1
328
+ "
329
+ `);
330
+ expect(comp3Renders.snapshot).toMatchInlineSnapshot(`
331
+ "
332
+ status: success -- error: null -- items: [{id:products||1, data:{id:1, name:Product 1}}, ...(49 more)]
333
+ "
334
+ `);
335
+ expect(compWithQueryLoadedRenders.snapshot).toMatchInlineSnapshot(`
336
+ "
337
+ status: success -- error: null -- items: [{id:1, name:User 1}, ...(4 more)] -- payload: {tableId:users}
338
+ status: refetching -- error: null -- items: [{id:1, name:User 1}, ...(4 more)] -- payload: {tableId:users}
339
+ status: success -- error: null -- items: [{id:1, name:User 1}, ...(4 more)] -- payload: {tableId:users}
340
+ "
341
+ `);
342
+
343
+ expect(serverMock.fetchsCount).toBe(2);
344
+ });
345
+
346
+ test('invalidate related item and query after query invalidation', async () => {
347
+ const { store, serverMock } = createTestEnv({
348
+ initialServerData,
349
+ useLoadedSnapshot: {
350
+ tables: ['users', 'products'],
351
+ queries: [{ tableId: 'users', filters: { idIsGreaterThan: 3 } }],
352
+ },
353
+ });
354
+
355
+ const { compWithItemLoadedRenders, compWithQueryLoadedRenders } =
356
+ renderComponents({
357
+ store,
358
+ disableRefetchOnMount: true,
359
+ loadItem: 'users||1',
360
+ loadTable: 'users',
361
+ });
362
+
363
+ const ignoreItemRenders = createRenderStore();
364
+ const ignoreQueryRenders = createRenderStore();
365
+ const relatedQueryRenders = createRenderStore();
366
+
367
+ render(
368
+ <>
369
+ <CompWithItemLoaded
370
+ store={store}
371
+ loadItem="products||1"
372
+ renderStore={ignoreItemRenders}
373
+ />
374
+ <CompWithQueryLoaded
375
+ store={store}
376
+ loadTable="products"
377
+ renderStore={ignoreQueryRenders}
378
+ />
379
+ <CompWithQueryLoaded
380
+ store={store}
381
+ loadTable="users"
382
+ filters={{
383
+ idIsGreaterThan: 3,
384
+ }}
385
+ renderStore={relatedQueryRenders}
386
+ />
387
+ </>,
388
+ );
389
+
390
+ store.invalidateQuery({ tableId: 'users' });
391
+
392
+ await serverMock.waitFetchIdle();
393
+
394
+ expect(compWithQueryLoadedRenders.snapshot).toMatchInlineSnapshot(`
395
+ "
396
+ status: success -- error: null -- items: [{id:1, name:User 1}, ...(4 more)] -- payload: {tableId:users}
397
+ status: refetching -- error: null -- items: [{id:1, name:User 1}, ...(4 more)] -- payload: {tableId:users}
398
+ status: success -- error: null -- items: [{id:1, name:User 1}, ...(4 more)] -- payload: {tableId:users}
399
+ "
400
+ `);
401
+
402
+ expect(ignoreItemRenders.snapshot).toMatchInlineSnapshot(`
403
+ "
404
+ status: success -- error: null -- data: {id:1, name:Product 1} -- itemId: products||1
405
+ "
406
+ `);
407
+ expect(ignoreQueryRenders.snapshot).toMatchInlineSnapshot(`
408
+ "
409
+ status: success -- error: null -- items: [{id:1, name:Product 1}, ...(49 more)] -- payload: {tableId:products}
410
+ "
411
+ `);
412
+
413
+ expect(compWithItemLoadedRenders.snapshot).toMatchInlineSnapshot(`
414
+ "
415
+ status: success -- error: null -- data: {id:1, name:User 1} -- itemId: users||1
416
+ status: refetching -- error: null -- data: {id:1, name:User 1} -- itemId: users||1
417
+ status: success -- error: null -- data: {id:1, name:User 1} -- itemId: users||1
418
+ "
419
+ `);
420
+ expect(relatedQueryRenders.snapshot).toMatchInlineSnapshot(`
421
+ "
422
+ status: success -- error: null -- items: [{id:4, name:User 4}, {id:5, name:User 5}] -- payload: {tableId:users, filters:{idIsGreaterThan:3}}
423
+ status: refetching -- error: null -- items: [{id:4, name:User 4}, {id:5, name:User 5}] -- payload: {tableId:users, filters:{idIsGreaterThan:3}}
424
+ status: success -- error: null -- items: [{id:4, name:User 4}, {id:5, name:User 5}] -- payload: {tableId:users, filters:{idIsGreaterThan:3}}
425
+ "
426
+ `);
427
+
428
+ expect(serverMock.fetchsCount).toBe(3);
429
+ });
430
+ });
431
+
432
+ test('receive a RTU', async () => {
433
+ const { store, serverMock } = createTestEnv({
434
+ initialServerData,
435
+ useLoadedSnapshot: { tables: ['users', 'products'] },
436
+ emulateRTU: true,
437
+ });
438
+
439
+ const { compWithItemLoadedRenders, compWithQueryLoadedRenders } =
440
+ renderComponents({
441
+ store,
442
+ disableRefetchOnMount: true,
443
+ loadItem: 'users||1',
444
+ loadTable: 'users',
445
+ });
446
+
447
+ const ignoreQueryRenders = createRenderStore();
448
+
449
+ render(
450
+ <CompWithQueryLoaded
451
+ store={store}
452
+ loadTable="products"
453
+ renderStore={ignoreQueryRenders}
454
+ />,
455
+ );
456
+
457
+ serverMock.produceData((draft) => {
458
+ draft.users![0]!.name = 'User 1 updated';
459
+ });
460
+
461
+ await serverMock.waitFetchIdle();
462
+
463
+ expect(compWithQueryLoadedRenders.snapshot).toMatchInlineSnapshot(`
464
+ "
465
+ status: success -- error: null -- items: [{id:1, name:User 1}, ...(4 more)] -- payload: {tableId:users}
466
+ status: refetching -- error: null -- items: [{id:1, name:User 1}, ...(4 more)] -- payload: {tableId:users}
467
+ status: success -- error: null -- items: [{id:1, name:User 1 updated}, ...(4 more)] -- payload: {tableId:users}
468
+ "
469
+ `);
470
+ expect(compWithItemLoadedRenders.snapshot).toMatchInlineSnapshot(`
471
+ "
472
+ status: success -- error: null -- data: {id:1, name:User 1} -- itemId: users||1
473
+ status: refetching -- error: null -- data: {id:1, name:User 1} -- itemId: users||1
474
+ status: refetching -- error: null -- data: {id:1, name:User 1 updated} -- itemId: users||1
475
+ status: success -- error: null -- data: {id:1, name:User 1 updated} -- itemId: users||1
476
+ "
477
+ `);
478
+ expect(ignoreQueryRenders.snapshot).toMatchInlineSnapshot(`
479
+ "
480
+ status: success -- error: null -- items: [{id:1, name:Product 1}, ...(49 more)] -- payload: {tableId:products}
481
+ "
482
+ `);
483
+ });