enhance: state.results -> state.endpoints

.changeset/nasty-items-count.md

@@ -0,0 +1,5 @@
+---
+"@data-client/normalizr": minor
+---
+
+type ResultCache -> EndpointCache

.changeset/violet-numbers-pump.md

@@ -0,0 +1,6 @@
+---
+"@data-client/react": minor
+"@data-client/core": minor
+---
+
+BREAKING: Internal state.results -> state.endpoints

examples/benchmark/old-normalizr/normalizr.js

@@ -38,7 +38,7 @@ function mergeWithStore({ entities, result }, storeState) {
   return {
     ...storeState,
     entities: newEntities,
-    results: { ...storeState.results, ...{ abc: result } },
+    endpoints: { ...storeState.endpoints, ...{ abc: result } },
   };
 }
 

packages/core/README.md

@@ -31,7 +31,7 @@ function useSuspense(endpoint, ...args)
   const controller = useController();
 
   const key = args[0] !== null ? endpoint.key(...args) : '';
-  const cacheResults = key && state.results[key];
+  const cacheResults = key && state.endpoints[key];
   const meta = state.meta[key];
 
   // Compute denormalized value

packages/core/src/actions.ts

@@ -137,7 +137,7 @@ export interface ResetAction {
 export interface GCAction {
   type: typeof GC_TYPE;
   entities: [string, string][];
-  results: string[];
+  endpoints: string[];
 }
 
 export type ActionTypes =

packages/core/src/controller/Controller.ts

@@ -87,7 +87,7 @@ export default class Controller<
     getState = unsetState,
     globalCache = {
       entities: {},
-      results: {},
+      endpoints: {},
     },
   }: ConstructorProps<D> = {}) {
     this.dispatch = dispatch;
@@ -327,9 +327,9 @@ export default class Controller<
     const key = endpoint.key(...args);
 
     const meta = selectMeta(state, key);
-    const results = state.results[key];
+    const error = state.endpoints[key];
 
-    if (results !== undefined && meta?.errorPolicy === 'soft') return;
+    if (error !== undefined && meta?.errorPolicy === 'soft') return;
 
     return meta?.error as any;
   };
@@ -386,14 +386,14 @@ export default class Controller<
       .map(ensurePojo);
     const isActive = args.length !== 1 || args[0] !== null;
     const key = isActive ? endpoint.key(...args) : '';
-    const cacheResults = isActive ? state.results[key] : undefined;
+    const cacheEndpoints = isActive ? state.endpoints[key] : undefined;
     const schema = endpoint.schema;
     const meta = selectMeta(state, key);
     let expiresAt = meta?.expiresAt;
 
     let invalidResults = false;
     let results;
-    if (cacheResults === undefined && endpoint.schema !== undefined) {
+    if (cacheEndpoints === undefined && endpoint.schema !== undefined) {
       results = inferResults(
         endpoint.schema,
         args,
@@ -403,7 +403,7 @@ export default class Controller<
       invalidResults = !validateInference(results);
       if (!expiresAt && invalidResults) expiresAt = 1;
     } else {
-      results = cacheResults;
+      results = cacheEndpoints;
     }
 
     if (!isActive) {
@@ -419,22 +419,22 @@ export default class Controller<
         data: results,
         expiryStatus:
           meta?.invalidated ? ExpiryStatus.Invalid
-          : cacheResults && !endpoint.invalidIfStale ? ExpiryStatus.Valid
+          : cacheEndpoints && !endpoint.invalidIfStale ? ExpiryStatus.Valid
           : ExpiryStatus.InvalidIfStale,
         expiresAt: expiresAt || 0,
       };
     }
 
-    if (!this.globalCache.results[key])
-      this.globalCache.results[key] = new WeakEntityMap();
+    if (!this.globalCache.endpoints[key])
+      this.globalCache.endpoints[key] = new WeakEntityMap();
 
     return this.getSchemaResponse(
       results,
       schema as Exclude<Schema, undefined>,
       args,
       state,
       expiresAt,
-      this.globalCache.results[key],
+      this.globalCache.endpoints[key],
       endpoint.invalidIfStale || invalidResults,
       meta,
     );

packages/core/src/controller/__tests__/Controller.ts

@@ -43,7 +43,7 @@ describe('Controller', () => {
       const state = {
         ...initialState,
         entities,
-        results: {
+        endpoints: {
           [fetchKey]: result,
         },
         entityMeta: createEntityMeta(entities),
@@ -80,7 +80,7 @@ describe('Controller', () => {
       const state = {
         ...initialState,
         entities,
-        results: {
+        endpoints: {
           [fetchKey]: result,
         },
         entityMeta: createEntityMeta(entities),

packages/core/src/controller/__tests__/getResponse.ts

@@ -39,7 +39,7 @@ describe('Controller.getResponse()', () => {
     const state = {
       ...initialState,
       entities,
-      results: {
+      endpoints: {
         [ep.key()]: {
           data: ['1', '2'],
         },
@@ -84,7 +84,7 @@ describe('Controller.getResponse()', () => {
     const state = {
       ...initialState,
       entities,
-      results: {
+      endpoints: {
         [ep.key()]: {
           data: ['1', '2'],
         },

packages/core/src/state/__tests__/__snapshots__/reducer.ts.snap

@@ -2,6 +2,7 @@
 
 exports[`reducer should set error in meta for "set" 1`] = `
 {
+  "endpoints": {},
   "entities": {},
   "entityMeta": {},
   "indexes": {},
@@ -15,12 +16,14 @@ exports[`reducer should set error in meta for "set" 1`] = `
     },
   },
   "optimistic": [],
-  "results": {},
 }
 `;
 
 exports[`reducer singles should update state correctly 1`] = `
 {
+  "endpoints": {
+    "http://test.com/article/20": "20",
+  },
   "entities": {
     "Article": {
       "20": {
@@ -49,8 +52,5 @@ exports[`reducer singles should update state correctly 1`] = `
     },
   },
   "optimistic": [],
-  "results": {
-    "http://test.com/article/20": "20",
-  },
 }
 `;

packages/core/src/state/__tests__/reducer.ts

@@ -207,7 +207,7 @@ describe('reducer', () => {
     });
   });
 
-  it('mutate should never change results', () => {
+  it('mutate should never change endpoints', () => {
     const id = 20;
     const payload = { id, title: 'hi', content: 'this is the content' };
     const action: SetAction = {
@@ -224,10 +224,10 @@ describe('reducer', () => {
     };
     const iniState = {
       ...initialState,
-      results: { abc: '5', [ArticleResource.get.key(payload)]: `${id}` },
+      endpoints: { abc: '5', [ArticleResource.get.key(payload)]: `${id}` },
     };
     const newState = reducer(iniState, action);
-    expect(newState.results).toStrictEqual(iniState.results);
+    expect(newState.endpoints).toStrictEqual(iniState.endpoints);
   });
   it('purge should delete entities', () => {
     const id = 20;
@@ -256,10 +256,10 @@ describe('reducer', () => {
         },
         '5': undefined,
       },
-      results: { abc: '20' },
+      endpoints: { abc: '20' },
     };
     const newState = reducer(iniState, action);
-    expect(newState.results.abc).toBe(iniState.results.abc);
+    expect(newState.endpoints.abc).toBe(iniState.endpoints.abc);
     const expectedEntities = { ...iniState.entities[Article.key] };
     expectedEntities['20'] = INVALID;
     expect(newState.entities[Article.key]).toEqual(expectedEntities);
@@ -277,8 +277,8 @@ describe('reducer', () => {
             '10': PaginatedArticle.fromJS({ id: 10 }),
           },
         },
-        results: {
-          [PaginatedArticleResource.getList.key({})]: { results: ['10'] },
+        endpoints: {
+          [PaginatedArticleResource.getList.key({})]: { endpoints: ['10'] },
         },
       };
 
@@ -301,7 +301,7 @@ describe('reducer', () => {
         );
         const newState = reducer(iniState, action);
         expect(
-          newState.results[PaginatedArticleResource.getList.key({})],
+          newState.endpoints[PaginatedArticleResource.getList.key({})],
         ).toStrictEqual({
           results: ['10', '11', '12'],
         });
@@ -328,7 +328,7 @@ describe('reducer', () => {
           ),
         );
         expect(
-          newState.results[PaginatedArticleResource.getList.key({})],
+          newState.endpoints[PaginatedArticleResource.getList.key({})],
         ).toStrictEqual({
           results: ['11', '12', '10'],
         });
@@ -342,7 +342,7 @@ describe('reducer', () => {
               '10': PaginatedArticle.fromJS({ id: 10 }),
             },
           },
-          results: {
+          endpoints: {
             [PaginatedArticleResource.getList.key({ admin: true })]: {
               results: ['10'],
             },
@@ -369,7 +369,7 @@ describe('reducer', () => {
           ),
         );
         expect(
-          newState.results[
+          newState.endpoints[
             PaginatedArticleResource.getList.key({ admin: true })
           ],
         ).toStrictEqual({
@@ -400,7 +400,7 @@ describe('reducer', () => {
         },
         '5': undefined,
       },
-      results: { abc: '20' },
+      endpoints: { abc: '20' },
       meta: {
         '20': {
           expiresAt: 500,
@@ -411,7 +411,7 @@ describe('reducer', () => {
       },
     };
     const newState = reducer(iniState, action);
-    expect(newState.results).toEqual(iniState.results);
+    expect(newState.endpoints).toEqual(iniState.endpoints);
     expect(newState.entities).toBe(iniState.entities);
     const expectedMeta = { ...iniState.meta };
     expectedMeta['20'] = { expiresAt: 0, invalidated: true };
@@ -481,7 +481,7 @@ describe('reducer', () => {
           [id]: Article.fromJS({}),
         },
       },
-      results: {
+      endpoints: {
         [ArticleResource.get.url({ id })]: id,
       },
     };
@@ -509,7 +509,7 @@ describe('reducer', () => {
       };
       const iniState = {
         ...initialState,
-        results: { abc: '5' },
+        endpoints: { abc: '5' },
       };
       const newState = reducer(iniState, action);
       expect(newState).toBe(iniState);
@@ -524,7 +524,7 @@ describe('reducer', () => {
     };
     const iniState = {
       ...initialState,
-      results: { abc: '5' },
+      endpoints: { abc: '5' },
     };
     const newState = reducer(iniState, action);
     expect(newState).toBe(iniState);
@@ -556,10 +556,10 @@ describe('reducer', () => {
           },
           '5': undefined,
         },
-        results: { abc: '20' },
+        endpoints: { abc: '20' },
       };
       const newState = reducer(iniState, action);
-      expect(newState.results).toEqual({});
+      expect(newState.endpoints).toEqual({});
       expect(newState.meta).toEqual({});
       expect(newState.entities).toEqual({});
     });
@@ -591,21 +591,21 @@ describe('reducer', () => {
             '250': { date: 0, expiresAt: 10000, fetchedAt: 0 },
           },
         },
-        results: { abc: '20' },
+        endpoints: { abc: '20' },
       };
     });
 
     it('empty targets should do nothing', () => {
       const action: GCAction = {
         type: GC_TYPE,
         entities: [],
-        results: [],
+        endpoints: [],
       };
 
       const newState = reducer(iniState, action);
       expect(newState).toBe(iniState);
       expect(Object.keys(newState.entities[Article.key] ?? {}).length).toBe(4);
-      expect(Object.keys(newState.results).length).toBe(1);
+      expect(Object.keys(newState.endpoints).length).toBe(1);
     });
 
     it('empty deleting entities should work', () => {
@@ -615,7 +615,7 @@ describe('reducer', () => {
           [Article.key, '10'],
           [Article.key, '250'],
         ],
-        results: ['abc'],
+        endpoints: ['abc'],
       };
 
       const newState = reducer(iniState, action);
@@ -624,7 +624,7 @@ describe('reducer', () => {
       expect(Object.keys(newState.entityMeta[Article.key] ?? {}).length).toBe(
         2,
       );
-      expect(Object.keys(newState.results).length).toBe(0);
+      expect(Object.keys(newState.endpoints).length).toBe(0);
     });
 
     it('empty deleting nonexistant things should passthrough', () => {
@@ -634,13 +634,13 @@ describe('reducer', () => {
           [Article.key, '100000000'],
           ['sillythings', '10'],
         ],
-        results: [],
+        endpoints: [],
       };
 
       const newState = reducer(iniState, action);
       expect(newState).toBe(iniState);
       expect(Object.keys(newState.entities[Article.key] ?? {}).length).toBe(4);
-      expect(Object.keys(newState.results).length).toBe(1);
+      expect(Object.keys(newState.endpoints).length).toBe(1);
     });
   });
 });