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,183 @@
1
+ import { describe, expect, test } from 'vitest';
2
+ import {
3
+ newTSDFDocumentStore,
4
+ TSDFDocumentStoreState,
5
+ } from '../src/documentStore';
6
+ import { mockServerResource } from './mocks/fetchMock';
7
+ import { sleep } from './utils/sleep';
8
+ import {
9
+ createDefaultDocumentStore,
10
+ normalizeError,
11
+ StoreError,
12
+ } from './utils/storeUtils';
13
+
14
+ type DocumentStoreState = TSDFDocumentStoreState<any, StoreError>;
15
+
16
+ describe('fetch lifecicle', () => {
17
+ const { serverMock, store: documentStore } = createDefaultDocumentStore();
18
+
19
+ test('fetch resource', async () => {
20
+ expect(documentStore.store.state).toEqual<DocumentStoreState>({
21
+ data: null,
22
+ error: null,
23
+ refetchOnMount: false,
24
+ status: 'idle',
25
+ });
26
+
27
+ documentStore.scheduleFetch('lowPriority');
28
+
29
+ expect(documentStore.store.state).toEqual<DocumentStoreState>({
30
+ data: null,
31
+ error: null,
32
+ refetchOnMount: false,
33
+ status: 'loading',
34
+ });
35
+
36
+ await sleep(serverMock.fetchDuration + 5);
37
+
38
+ expect(documentStore.store.state).toEqual<DocumentStoreState>({
39
+ data: {
40
+ hello: 'world',
41
+ },
42
+ error: null,
43
+ refetchOnMount: false,
44
+ status: 'success',
45
+ });
46
+ });
47
+
48
+ test('refetch resource with new data', async () => {
49
+ serverMock.mutateData({ hello: 'new data' });
50
+
51
+ documentStore.scheduleFetch('highPriority');
52
+
53
+ expect(documentStore.store.state).toEqual<DocumentStoreState>({
54
+ data: {
55
+ hello: 'world',
56
+ },
57
+ error: null,
58
+ refetchOnMount: false,
59
+ status: 'refetching',
60
+ });
61
+
62
+ await sleep(serverMock.fetchDuration + 5);
63
+
64
+ expect(documentStore.store.state).toEqual<DocumentStoreState>({
65
+ data: {
66
+ hello: 'new data',
67
+ },
68
+ error: null,
69
+ refetchOnMount: false,
70
+ status: 'success',
71
+ });
72
+
73
+ expect(serverMock.fetchsCount).toBe(2);
74
+ });
75
+
76
+ test('refetch resource with error', async () => {
77
+ serverMock.setFetchError('error');
78
+
79
+ documentStore.scheduleFetch('highPriority');
80
+
81
+ await sleep(serverMock.fetchDuration + 5);
82
+
83
+ expect(documentStore.store.state).toEqual<DocumentStoreState>({
84
+ data: {
85
+ hello: 'new data',
86
+ },
87
+ error: {
88
+ message: 'error',
89
+ },
90
+ refetchOnMount: false,
91
+ status: 'error',
92
+ });
93
+ });
94
+ });
95
+
96
+ test.concurrent('start with initialized data', () => {
97
+ const serverMock = mockServerResource<any>({
98
+ initialData: null,
99
+ });
100
+
101
+ const documentStore = newTSDFDocumentStore({
102
+ fetchFn: serverMock.fetchWitoutSelector,
103
+ initialData: { hello: 'initial data' },
104
+ errorNormalizer: normalizeError,
105
+ });
106
+
107
+ expect(documentStore.store.state).toEqual<DocumentStoreState>({
108
+ data: {
109
+ hello: 'initial data',
110
+ },
111
+ error: null,
112
+ refetchOnMount: false,
113
+ status: 'success',
114
+ });
115
+ });
116
+
117
+ test.concurrent(
118
+ 'multiple low priority fetchs at same time trigger only one fetch',
119
+ async () => {
120
+ const serverMock = mockServerResource<any>({
121
+ initialData: { hello: 'new data' },
122
+ });
123
+
124
+ const documentStore = newTSDFDocumentStore({
125
+ fetchFn: serverMock.fetchWitoutSelector,
126
+ initialData: { hello: 'world' },
127
+ errorNormalizer: normalizeError,
128
+ });
129
+
130
+ documentStore.scheduleFetch('lowPriority');
131
+ documentStore.scheduleFetch('lowPriority');
132
+ documentStore.scheduleFetch('lowPriority');
133
+ documentStore.scheduleFetch('lowPriority');
134
+
135
+ expect(documentStore.store.state).toEqual<DocumentStoreState>({
136
+ data: { hello: 'world' },
137
+ error: null,
138
+ refetchOnMount: false,
139
+ status: 'refetching',
140
+ });
141
+
142
+ await sleep(serverMock.fetchDuration + 5);
143
+
144
+ expect(serverMock.fetchsCount).toBe(1);
145
+
146
+ expect(documentStore.store.state).toEqual<DocumentStoreState>({
147
+ data: { hello: 'new data' },
148
+ error: null,
149
+ refetchOnMount: false,
150
+ status: 'success',
151
+ });
152
+ },
153
+ );
154
+
155
+ test.concurrent('await fetch', async () => {
156
+ const { serverMock, store: documentStore } = createDefaultDocumentStore({
157
+ useLoadedSnapshot: true,
158
+ });
159
+
160
+ serverMock.mutateData({ hello: 'new data' });
161
+
162
+ expect(documentStore.store.state).toMatchObject({
163
+ data: {
164
+ hello: 'world',
165
+ },
166
+ });
167
+
168
+ expect(await documentStore.awaitFetch()).toEqual({
169
+ data: {
170
+ hello: 'new data',
171
+ },
172
+ error: null,
173
+ });
174
+
175
+ serverMock.setFetchError('error');
176
+
177
+ expect(await documentStore.awaitFetch()).toEqual({
178
+ data: null,
179
+ error: {
180
+ message: 'error',
181
+ },
182
+ });
183
+ });