feat: Memoize queries (#2978)

Author: ntucker

.changeset/gentle-nails-try.md

@@ -0,0 +1,14 @@
+---
+'@data-client/normalizr': minor
+---
+
+BREAKING CHANGE: buildQueryKey() -> memo.buildQueryKey()
+
+```ts title="Before"
+const results = buildQueryKey(schema, args, state.indexes, state.entities);
+```
+
+```ts title="After"
+const memo = new MemoCached();
+memo.buildQueryKey(key, schema, args, state.entities, state.indexes);
+```

.changeset/great-geckos-breathe.md

@@ -0,0 +1,20 @@
+---
+"@data-client/normalizr": minor
+---
+
+Add MemoCache
+
+`MemoCache` is a singleton to store the memoization cache for denormalization methods
+
+```ts
+const memo = new MemoCache();
+const data = memo.query(key, schema, args, state.entities, state.indexes);
+const { data, paths } = memo.denormalize(input, schema, state.entities, args);
+const queryKey = memo.buildQueryKey(
+  key,
+  schema,
+  args,
+  state.entities,
+  state.indexes,
+);
+```

.changeset/little-carpets-drop.md

@@ -27,12 +27,12 @@ class MyEntity extends Entity {
   // highlight-next-line
   static queryKey(
     args: readonly any[],
-    indexes: NormalizedIndex,
-    recurse: any,
-    entities: any,
+    queryKey: (...args: any) => any,
+    getEntity: GetEntity,
+    getIndex: GetIndex,
   ): any {
     if (SILLYCONDITION) return undefined;
-    return super.queryKey(args, indexes, recurse, entities);
+    return super.queryKey(args, queryKey, getEntity, getIndex);
   }
 }
 ```

.changeset/sour-apples-sneeze.md

@@ -0,0 +1,15 @@
+---
+"@data-client/normalizr": minor
+---
+
+BREAKING CHANGE: WeakEntityMap -> WeakDependencyMap
+
+We generalize this data type so it can be used with other dependencies.
+
+```ts title="Before"
+new WeakEntityMap();
+```
+
+```ts title="After"
+new WeakDependencyMap<EntityPath>();
+```

.changeset/strange-tomatoes-hunt.md

@@ -0,0 +1,16 @@
+---
+'@data-client/normalizr': minor
+---
+
+BREAKING CHANGE: denormalizeCached() -> new MemoCache().denormalize()
+
+```ts title="Before"
+const endpointCache = new WeakEntityMap();
+const entityCache = {};
+denormalizeCached(input, schema, state.entities, entityCache, endpointCache, args);
+```
+
+```ts title="After"
+const memo = new MemoCached();
+memo.denormalize(input, schema, state.entities, args);
+```

.changeset/warm-tigers-repair.md

@@ -0,0 +1,5 @@
+---
+"@data-client/endpoint": patch
+---
+
+More robustly handle Union queries when the schema cannot be found

docs/core/api/useQuery.md

@@ -59,10 +59,10 @@ and [Union](/rest/api/Union).
 interface Queryable {
   queryKey(
     args: readonly any[],
-    indexes: NormalizedIndex,
-    recurse: (...args: any) => any,
-    entities: EntityTable,
-    // `{}` means non-void
+    queryKey: (...args: any) => any,
+    getEntity: GetEntity,
+    getIndex: GetIndex,
+    // Must be non-void
   ): {};
 };
 ```

docs/graphql/api/GQLEntity.md

@@ -275,7 +275,7 @@ static mergeMetaWithStore(
 
 `mergeMetaWithStore()` is called during normalization when a processed entity is already found in the store.
 
-### static queryKey(args, indexes, recurse): pk? {#queryKey}
+### static queryKey(args, queryKey, getEntity, getIndex): pk? {#queryKey}
 
 This method enables `Entities` to be [Queryable](/rest/api/schema#queryable) - allowing store access without an endpoint.
 

docs/rest/api/Entity.md

@@ -371,7 +371,7 @@ static mergeMetaWithStore(
 
 `mergeMetaWithStore()` is called during normalization when a processed entity is already found in the store.
 
-### static queryKey(args, indexes, recurse, entities): pk? {#queryKey}
+### static queryKey(args, queryKey, getEntity, getIndex): pk? {#queryKey}
 
 This method enables `Entities` to be [Queryable](./schema.md#queryable) - allowing store access without an endpoint.
 
@@ -385,6 +385,31 @@ When used, expiry policy is computed based on the entity's own meta data.
 
 By **default** uses the first argument to lookup in [pk()](#pk) and [indexes](#indexes)
 
+#### getEntity(key, pk?)
+
+Gets all entities of a type with one argument, or a single entity with two
+
+```ts title="One argument"
+const entitiesEntry = getEntity(this.schema.key);
+if (entitiesEntry === undefined) return INVALID;
+return Object.values(entitiesEntry).map(
+  entity => entity && this.schema.pk(entity),
+);
+```
+
+```ts title="Two arguments"
+if (getEntity(this.key, id)) return id;
+```
+
+#### getIndex(key, indexName, value)
+
+Returns the index entry (value->pk map)
+
+```ts
+const value = args[0][indexName];
+return getIndex(schema.key, indexName, value)[value];
+```
+
 ### static createIfValid(processedEntity): Entity | undefined {#createIfValid}
 
 Called when denormalizing an entity. This will create an instance of this class

docs/rest/api/schema.md

@@ -224,9 +224,9 @@ and [Union](./Union.md).
 interface Queryable {
   queryKey(
     args: readonly any[],
-    indexes: NormalizedIndex,
-    recurse: (...args: any) => any,
-    entities: EntityTable,
+    queryKey: (...args: any) => any,
+    getEntity: GetEntity,
+    getIndex: GetIndex,
     // `{}` means non-void
   ): {};
 };