enhance: Make argsKey optional in memo.query and memo.buildQueryKey

examples/benchmark/normalizr.js

@@ -22,14 +22,12 @@ const { result, entities } = normalize(ProjectSchema, data);
 const queryState = normalize(ProjectQuery, data);
 const queryMemo = new MemoCache();
 queryState.result = queryMemo.buildQueryKey(
-  '',
   ProjectQuery,
   [],
   queryState.entities,
   queryState.indexes,
 );
 const queryInfer = queryMemo.buildQueryKey(
-  '',
   ProjectQuerySorted,
   [],
   queryState.entities,
@@ -57,17 +55,11 @@ export default function addNormlizrSuite(suite) {
   let curState = initialState;
   return suite
     .add('normalizeLong', () => {
-      normalize(
-        ProjectSchema,
-        data,
-        actionMeta,
-        curState,
-      );
+      normalize(ProjectSchema, data, actionMeta, curState);
       curState = { ...initialState, entities: {}, endpoints: {} };
     })
     .add('infer All', () => {
       return new MemoCache().buildQueryKey(
-        '',
         ProjectQuery,
         [],
         queryState.entities,

packages/core/src/controller/Controller.ts

@@ -430,11 +430,11 @@ export default class Controller<
       shouldQuery ?
         // nothing in endpoints cache, so try querying if we have a schema to do so
         this.memo.buildQueryKey(
-          key,
           schema,
           args,
           state.entities as any,
           state.indexes,
+          key,
         )
       : cacheEndpoints;
 
@@ -500,16 +500,7 @@ export default class Controller<
       .slice(0, rest.length - 1)
       .map(ensurePojo) as SchemaArgs<S>;
 
-    // NOTE: different orders can result in cache busting here; but since it's just a perf penalty we will allow for now
-    const key = JSON.stringify(args);
-
-    return this.memo.query(
-      key,
-      schema,
-      args,
-      state.entities as any,
-      state.indexes,
-    );
+    return this.memo.query(schema, args, state.entities as any, state.indexes);
   }
 
   private getSchemaResponse<T>(

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

@@ -115,7 +115,7 @@ describe.each([
       };
       const sch = new schema.All(Cat);
       expect(
-        new MemoCache().query('', sch, [], createInput(entities), {}),
+        new MemoCache().query(sch, [], createInput(entities), {}),
       ).toMatchSnapshot();
     });
 
@@ -129,7 +129,7 @@ describe.each([
         },
       };
       expect(
-        new MemoCache().query('', catSchema, [], createInput(entities), {}),
+        new MemoCache().query(catSchema, [], createInput(entities), {}),
       ).toMatchSnapshot();
     });
 
@@ -143,7 +143,6 @@ describe.each([
         },
       };
       const value = new MemoCache().query(
-        '',
         catSchema,
         [],
         createInput(entities),
@@ -167,7 +166,6 @@ describe.each([
         },
       };
       const value = new MemoCache().query(
-        '',
         catSchema,
         [],
         createInput(entities) as any,
@@ -191,11 +189,11 @@ describe.each([
         },
       };
       const memo = new MemoCache();
-      const value = memo.query('', catSchema, [], entities, {});
+      const value = memo.query(catSchema, [], entities, {});
 
       expect(createOutput(value).results?.length).toBe(2);
       expect(createOutput(value).results).toMatchSnapshot();
-      const value2 = memo.query('', catSchema, [], entities, {});
+      const value2 = memo.query(catSchema, [], entities, {});
       expect(createOutput(value).results[0]).toBe(
         createOutput(value2).results[0],
       );
@@ -208,7 +206,7 @@ describe.each([
           3: { id: '3', name: 'Jelico' },
         },
       };
-      const value3 = memo.query('', catSchema, [], entities, {});
+      const value3 = memo.query(catSchema, [], entities, {});
       expect(createOutput(value3).results?.length).toBe(3);
       expect(createOutput(value3).results).toMatchSnapshot();
       expect(createOutput(value).results[0]).toBe(
@@ -231,7 +229,6 @@ describe.each([
       };
 
       const value = new MemoCache().query(
-        '',
         catSchema,
         [],
         createInput(entities),
@@ -267,7 +264,6 @@ describe.each([
         },
       };
       const value = new MemoCache().query(
-        '',
         listSchema,
         [],
         createInput(entities),
@@ -331,7 +327,6 @@ describe.each([
         },
       };
       const value = new MemoCache().query(
-        '',
         listSchema,
         [],
         createInput(entities) as any,

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

@@ -518,7 +518,6 @@ describe(`${schema.Collection.name} denormalization`, () => {
   it('should buildQueryKey with matching args', () => {
     const memo = new MemoCache();
     const queryKey = memo.buildQueryKey(
-      '',
       userTodos,
       [{ userId: '1' }],
       normalizeNested.entities,
@@ -543,7 +542,6 @@ describe(`${schema.Collection.name} denormalization`, () => {
   it('should buildQueryKey undefined when not in cache', () => {
     const memo = new MemoCache();
     const queryKey = memo.buildQueryKey(
-      '',
       userTodos,
       [{ userId: '100' }],
       normalizeNested.entities,
@@ -555,7 +553,6 @@ describe(`${schema.Collection.name} denormalization`, () => {
   it('should buildQueryKey undefined with nested Collection', () => {
     const memo = new MemoCache();
     const queryKey = memo.buildQueryKey(
-      '',
       User.schema.todos,
       [{ userId: '1' }],
       normalizeNested.entities,

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

@@ -72,7 +72,7 @@ describe.each([
           },
         };
         const users: DenormalizeNullable<typeof sortedUsers> | symbol =
-          new MemoCache().query('', sortedUsers, [], createInput(entities), {});
+          new MemoCache().query(sortedUsers, [], createInput(entities), {});
         expect(users).not.toEqual(expect.any(Symbol));
         if (typeof users === 'symbol') return;
         expect(users && users[0].name).toBe('Zeta');
@@ -95,7 +95,6 @@ describe.each([
         };
         expect(
           new MemoCache().query(
-            '',
             sortedUsers,
             [{ asc: true }],
             createInput(entities),
@@ -111,7 +110,7 @@ describe.each([
             2: { id: '2', name: 'Jake' },
           },
         };
-        const data = new MemoCache().query('', sortedUsers, [], entities, {});
+        const data = new MemoCache().query(sortedUsers, [], entities, {});
 
         expect(createOutput(data)).toEqual(undefined);
       });
@@ -147,7 +146,6 @@ describe.each([
         const totalCount:
           | DenormalizeNullable<typeof userCountByAdmin>
           | symbol = new MemoCache().query(
-          '',
           userCountByAdmin,
           [],
           createInput(entities),
@@ -158,7 +156,6 @@ describe.each([
         const nonAdminCount:
           | DenormalizeNullable<typeof userCountByAdmin>
           | symbol = new MemoCache().query(
-          '',
           userCountByAdmin,
           [{ isAdmin: false }],
           createInput(entities),
@@ -168,7 +165,6 @@ describe.each([
         const adminCount:
           | DenormalizeNullable<typeof userCountByAdmin>
           | symbol = new MemoCache().query(
-          '',
           userCountByAdmin,
           [{ isAdmin: true }],
           createInput(entities),
@@ -208,7 +204,7 @@ describe('top level schema', () => {
         [new schema.Collection([User]).pk({}, undefined, '', [])]: [1, 2, 3, 4],
       },
     };
-    const users = new MemoCache().query('', sortedUsers, [], entities, {});
+    const users = new MemoCache().query(sortedUsers, [], entities, {});
     expect(users).not.toEqual(expect.any(Symbol));
     if (typeof users === 'symbol') return;
     expect(users && users[0].name).toBe('Zeta');
@@ -224,7 +220,7 @@ describe('top level schema', () => {
         4: { id: '4', name: 'Alpha' },
       },
     };
-    const users = new MemoCache().query('', sortedUsers, [], entities, {});
+    const users = new MemoCache().query(sortedUsers, [], entities, {});
     expect(users).toBeUndefined();
   });
 
@@ -239,7 +235,7 @@ describe('top level schema', () => {
         return sorted.reverse();
       },
     );
-    const users = new MemoCache().query('', allSortedUsers, [], {}, {});
+    const users = new MemoCache().query(allSortedUsers, [], {}, {});
     expect(users).toBeUndefined();
   });
 
@@ -254,7 +250,7 @@ describe('top level schema', () => {
         return sorted.reverse();
       },
     );
-    const users = new MemoCache().query('', allSortedUsers, [], {}, {});
+    const users = new MemoCache().query(allSortedUsers, [], {}, {});
     expect(users).toBeUndefined();
   });
 
@@ -266,7 +262,7 @@ describe('top level schema', () => {
       },
     };
 
-    const value = new MemoCache().query('', sortedUsers, [], entities, {});
+    const value = new MemoCache().query(sortedUsers, [], entities, {});
 
     expect(value).toEqual(undefined);
   });

packages/normalizr/README.md

@@ -216,15 +216,15 @@ const memo = new MemoCache();
 
 const { data, paths } = memo.denormalize(schema, input, state.entities, args);
 
-const data = memo.query(schema, key, args, state.entities, state.indexes);
+const data = memo.query(schema, args, state.entities, state.indexes);
 
-function query(schema, key, args, state) {
+function query(schema, args, state, key) {
   const queryKey = memo.buildQueryKey(
-    key,
     schema,
     args,
     state.entities,
     state.indexes,
+    key,
   );
   const { data } = this.denormalize(schema, queryKey, state.entities, args);
   return typeof data === 'symbol' ? undefined : (data as any);