enhance: MemoCache.query() and MemoCache.buildQueryKey() take state as one argument (#3454)

Author: ntucker

.changeset/poor-jobs-turn.md

@@ -0,0 +1,41 @@
+---
+'@data-client/normalizr': minor
+---
+
+BREAKING CHANGE: MemoCache.query() and MemoCache.buildQueryKey() take state as one argument
+
+#### Before
+
+```ts
+this.memo.buildQueryKey(
+  schema,
+  args,
+  state.entities,
+  state.indexes,
+  key,
+);
+```
+
+
+#### After
+
+```ts
+this.memo.buildQueryKey(
+  schema,
+  args,
+  state,
+  key,
+);
+```
+
+#### Before
+
+```ts
+this.memo.query(schema, args, state.entities, state.indexes);
+```
+
+#### After
+
+```ts
+this.memo.query(schema, args, state);
+```

examples/benchmark/normalizr.js

@@ -21,18 +21,8 @@ import userData from './user.json' with { type: 'json' };
 const { result, entities } = normalize(ProjectSchema, data);
 const queryState = normalize(AllProjects, data);
 const queryMemo = new MemoCache();
-queryState.result = queryMemo.buildQueryKey(
-  AllProjects,
-  [],
-  queryState.entities,
-  queryState.indexes,
-);
-const queryInfer = queryMemo.buildQueryKey(
-  getSortedProjects,
-  [],
-  queryState.entities,
-  queryState.indexes,
-);
+queryState.result = queryMemo.buildQueryKey(AllProjects, [], queryState);
+const queryInfer = queryMemo.buildQueryKey(getSortedProjects, [], queryState);
 
 let githubState = normalize(User, userData);
 
@@ -56,12 +46,7 @@ export default function addNormlizrSuite(suite) {
       curState = { ...initialState, entities: {}, endpoints: {} };
     })
     .add('infer All', () => {
-      return new MemoCache().buildQueryKey(
-        AllProjects,
-        [],
-        queryState.entities,
-        queryState.indexes,
-      );
+      return new MemoCache().buildQueryKey(AllProjects, [], queryState);
     })
     .add('denormalizeLong', () => {
       return new MemoCache().denormalize(ProjectSchema, result, entities);
@@ -86,12 +71,7 @@ export default function addNormlizrSuite(suite) {
     })
     .add('queryShort 500x withCache', () => {
       for (let i = 0; i < 500; ++i) {
-        memo.query(
-          User,
-          [{ login: 'gnoff' }],
-          githubState.entities,
-          githubState.indexes,
-        );
+        memo.query(User, [{ login: 'gnoff' }], githubState);
       }
     })
     .add('denormalizeLong with mixin Entity', () => {

packages/core/src/controller/Controller.ts

@@ -514,13 +514,7 @@ export default class Controller<
     const input =
       shouldQuery ?
         // nothing in endpoints cache, so try querying if we have a schema to do so
-        this.memo.buildQueryKey(
-          schema,
-          args,
-          state.entities as any,
-          state.indexes,
-          key,
-        )
+        this.memo.buildQueryKey(schema, args, state, key)
       : cacheEndpoints;
 
     if (!isActive) {
@@ -595,7 +589,7 @@ export default class Controller<
       .slice(0, rest.length - 1)
       .map(ensurePojo) as SchemaArgs<S>;
 
-    return this.memo.query(schema, args, state.entities as any, state.indexes);
+    return this.memo.query(schema, args, state);
   }
 
   /**
@@ -623,8 +617,7 @@ export default class Controller<
     const input = this.memo.buildQueryKey(
       schema,
       args,
-      state.entities as any,
-      state.indexes,
+      state,
       JSON.stringify(args),
     );
 

packages/endpoint/src/schemas/__tests__/All.test.ts

@@ -135,9 +135,7 @@ describe.each([
         indexes: {},
       });
       // use memocache because we don't support 'object' schemas in controller yet
-      expect(
-        new MemoCache().query(catSchema, [], state.entities, state.indexes),
-      ).toMatchSnapshot();
+      expect(new MemoCache().query(catSchema, [], state)).toMatchSnapshot();
     });
 
     test('denormalizes nested in object with primitive', () => {
@@ -152,12 +150,7 @@ describe.each([
         },
         indexes: {},
       });
-      const value = new MemoCache().query(
-        catSchema,
-        [],
-        state.entities,
-        state.indexes,
-      );
+      const value = new MemoCache().query(catSchema, [], state);
       expect(value).not.toEqual(expect.any(Symbol));
       if (typeof value === 'symbol' || value === undefined) return;
       expect(createOutput(value.results)).toMatchSnapshot();
@@ -178,12 +171,7 @@ describe.each([
         },
         indexes: {},
       });
-      const value = new MemoCache().query(
-        catSchema,
-        [],
-        state.entities,
-        state.indexes,
-      );
+      const value = new MemoCache().query(catSchema, [], state);
       expect(value).not.toEqual(expect.any(Symbol));
       if (typeof value === 'symbol' || value === undefined) return;
       expect(createOutput(value.results).length).toBe(2);
@@ -206,11 +194,11 @@ describe.each([
         indexes: {},
       };
       const memo = new MemoCache();
-      const value = memo.query(catSchema, [], state.entities, state.indexes);
+      const value = memo.query(catSchema, [], state);
 
       expect(createOutput(value).results?.length).toBe(2);
       expect(createOutput(value).results).toMatchSnapshot();
-      const value2 = memo.query(catSchema, [], state.entities, state.indexes);
+      const value2 = memo.query(catSchema, [], state);
       expect(createOutput(value).results[0]).toBe(
         createOutput(value2).results[0],
       );
@@ -226,7 +214,7 @@ describe.each([
           },
         },
       };
-      const value3 = memo.query(catSchema, [], state.entities, state.indexes);
+      const value3 = memo.query(catSchema, [], state);
       expect(createOutput(value3).results?.length).toBe(3);
       expect(createOutput(value3).results).toMatchSnapshot();
       expect(createOutput(value).results[0]).toBe(
@@ -250,12 +238,7 @@ describe.each([
         },
         indexes: {},
       });
-      const value = new MemoCache().query(
-        catSchema,
-        [],
-        state.entities,
-        state.indexes,
-      );
+      const value = new MemoCache().query(catSchema, [], state);
       expect(createOutput(value)).toBeUndefined();
     });
 
@@ -287,12 +270,7 @@ describe.each([
         },
         indexes: {},
       });
-      const value = new MemoCache().query(
-        listSchema,
-        [],
-        state.entities,
-        state.indexes,
-      );
+      const value = new MemoCache().query(listSchema, [], state);
       expect(createOutput(value)).toBeUndefined();
     });
 
@@ -355,12 +333,7 @@ describe.each([
         },
         indexes: {},
       });
-      const value = new MemoCache().query(
-        listSchema,
-        [],
-        state.entities,
-        state.indexes,
-      );
+      const value = new MemoCache().query(listSchema, [], state);
       expect(value).not.toEqual(expect.any(Symbol));
       if (typeof value === 'symbol') return;
       expect(value).toMatchSnapshot();

packages/endpoint/src/schemas/__tests__/Collection.test.ts

@@ -620,8 +620,7 @@ describe(`${schema.Collection.name} denormalization`, () => {
     const queryKey = memo.buildQueryKey(
       userTodos,
       [{ userId: '1' }],
-      normalizeNested.entities,
-      normalizeNested.indexes,
+      normalizeNested,
     );
     expect(queryKey).toBeDefined();
     // now ensure our queryKey is usable
@@ -644,8 +643,7 @@ describe(`${schema.Collection.name} denormalization`, () => {
     const queryKey = memo.buildQueryKey(
       userTodos,
       [{ userId: '100' }],
-      normalizeNested.entities,
-      normalizeNested.indexes,
+      normalizeNested,
     );
     expect(queryKey).toBeUndefined();
   });
@@ -655,8 +653,7 @@ describe(`${schema.Collection.name} denormalization`, () => {
     const queryKey = memo.buildQueryKey(
       User.schema.todos,
       [{ userId: '1' }],
-      normalizeNested.entities,
-      normalizeNested.indexes,
+      normalizeNested,
     );
     expect(queryKey).toBeUndefined();
   });