Merge pull request #30 from tenetxyz/indexer-fix-recs

add hook
tenetxyz · Nov 8, 2023 · c6c9e96 · c6c9e96
2 parents aa54d1e + 945f3d7
commit c6c9e96
Show file tree

Hide file tree

Showing 3 changed files with 66 additions and 27 deletions.
diff --git a/packages/recs/src/Component.ts b/packages/recs/src/Component.ts
@@ -110,6 +110,8 @@ export function setComponent<S extends Schema, T = unknown>(
     }
   }
   component.update$.next({ entity, value: [value, prevValue], component });
+  const updateValue = { entity, value: [value, prevValue], component };
+  return updateValue;
 }
 
 /**
@@ -139,9 +141,9 @@ export function updateComponent<S extends Schema, T = unknown>(
     if (initialValue === undefined) {
       throw new Error(`Can't update component ${getComponentName(component)} without a current value or initial value`);
     }
-    setComponent(component, entity, { ...initialValue, ...value });
+    return setComponent(component, entity, { ...initialValue, ...value });
   } else {
-    setComponent(component, entity, { ...currentValue, ...value });
+    return setComponent(component, entity, { ...currentValue, ...value });
   }
 }
 
@@ -161,6 +163,8 @@ export function removeComponent<S extends Schema, M extends Metadata, T = unknow
     component.values[key].delete(entitySymbol);
   }
   component.update$.next({ entity, value: [undefined, prevValue], component });
+  const updateValue = { entity, value: [undefined, prevValue], component };
+  return updateValue;
 }
 
 /**

diff --git a/packages/store-sync/src/recs/recsStorage.ts b/packages/store-sync/src/recs/recsStorage.ts
@@ -1,30 +1,43 @@
-import { BlockLogsToStorageOptions } from "../blockLogsToStorage";
-import { StoreConfig } from "@latticexyz/store";
-import { debug } from "./debug";
+import { tableIdToHex } from "@latticexyz/common";
+import { isDefined } from "@latticexyz/common/utils";
 import {
+  ComponentUpdate,
   ComponentValue,
+  Entity,
   Component as RecsComponent,
   Schema as RecsSchema,
   getComponentValue,
   removeComponent,
   setComponent,
   updateComponent,
 } from "@latticexyz/recs";
-import { isDefined } from "@latticexyz/common/utils";
+import { StoreConfig } from "@latticexyz/store";
+import { BlockLogsToStorageOptions } from "../blockLogsToStorage";
+import { BlockLogs } from "../common";
 import { schemaToDefaults } from "../schemaToDefaults";
-import { defineInternalComponents } from "./defineInternalComponents";
-import { getTableEntity } from "./getTableEntity";
 import { StoreComponentMetadata } from "./common";
-import { tableIdToHex } from "@latticexyz/common";
+import { debug } from "./debug";
+import { defineInternalComponents } from "./defineInternalComponents";
 import { encodeEntity } from "./encodeEntity";
+import { getTableEntity } from "./getTableEntity";
+
+export type ComponentEntityUpdates = Map<string, Map<Entity, ComponentUpdate[]>>;
 
-export function recsStorage<TConfig extends StoreConfig = StoreConfig>({
-  components,
-}: {
-  components: ReturnType<typeof defineInternalComponents> &
-    Record<string, RecsComponent<RecsSchema, StoreComponentMetadata>>;
-  config?: TConfig;
-}): BlockLogsToStorageOptions<TConfig> {
+export type RecsUpdatesHook = (
+  blockNumber: BlockLogs["blockNumber"],
+  componentEntityUpdates: ComponentEntityUpdates
+) => Promise<void>;
+
+export function recsStorage<TConfig extends StoreConfig = StoreConfig>(
+  {
+    components,
+  }: {
+    components: ReturnType<typeof defineInternalComponents> &
+      Record<string, RecsComponent<RecsSchema, StoreComponentMetadata>>;
+    config?: TConfig;
+  },
+  recsAllUpdatesHook?: RecsUpdatesHook
+): BlockLogsToStorageOptions<TConfig> {
   // TODO: do we need to store block number?
 
   const componentsByTableId = Object.fromEntries(
@@ -44,7 +57,8 @@ export function recsStorage<TConfig extends StoreConfig = StoreConfig>({
         .map((table) => getComponentValue(components.RegisteredTables, getTableEntity(table))?.table)
         .filter(isDefined);
     },
-    async storeOperations({ operations }) {
+    async storeOperations({ blockNumber, operations }) {
+      const componentEntityUpdates: ComponentEntityUpdates = new Map<string, Map<Entity, ComponentUpdate[]>>();
       for (const operation of operations) {
         const table = getComponentValue(
           components.RegisteredTables,
@@ -68,24 +82,43 @@ export function recsStorage<TConfig extends StoreConfig = StoreConfig>({
 
         const entity = encodeEntity(table.keySchema, operation.key);
 
+        let newUpdate = undefined;
         if (operation.type === "SetRecord") {
           debug("setting component", tableId, entity, operation.value);
-          setComponent(component, entity, operation.value as ComponentValue);
+          newUpdate = setComponent(component, entity, operation.value as ComponentValue);
         } else if (operation.type === "SetField") {
           debug("updating component", tableId, entity, {
             [operation.fieldName]: operation.fieldValue,
           });
-          updateComponent(
+          newUpdate = updateComponent(
             component,
             entity,
             { [operation.fieldName]: operation.fieldValue } as ComponentValue,
             schemaToDefaults(table.valueSchema) as ComponentValue
           );
         } else if (operation.type === "DeleteRecord") {
           debug("deleting component", tableId, entity);
-          removeComponent(component, entity);
+          newUpdate = removeComponent(component, entity);
+        }
+
+        if (newUpdate) {
+          if (componentEntityUpdates.has(newUpdate.component.id)) {
+            if (componentEntityUpdates.get(newUpdate.component.id)?.has(newUpdate.entity)) {
+              componentEntityUpdates.get(newUpdate.component.id)?.get(newUpdate.entity)?.push(newUpdate);
+            } else {
+              componentEntityUpdates.get(newUpdate.component.id)?.set(newUpdate.entity, [newUpdate]);
+            }
+          } else {
+            const entityUpdates = new Map<Entity, ComponentUpdate[]>();
+            entityUpdates.set(newUpdate.entity, [newUpdate]);
+            componentEntityUpdates.set(newUpdate.component.id, entityUpdates);
+          }
         }
       }
+
+      if (recsAllUpdatesHook !== undefined) {
+        await recsAllUpdatesHook(blockNumber, componentEntityUpdates);
+      }
     },
   } as BlockLogsToStorageOptions<TConfig>;
 }
diff --git a/packages/store-sync/src/recs/syncToRecs.ts b/packages/store-sync/src/recs/syncToRecs.ts
@@ -1,20 +1,21 @@
-import { StoreConfig } from "@latticexyz/store";
 import { World as RecsWorld, getComponentValue, setComponent } from "@latticexyz/recs";
+import { StoreConfig } from "@latticexyz/store";
+import storeConfig from "@latticexyz/store/mud.config.js";
+import worldConfig from "@latticexyz/world/mud.config.js";
+import { SyncStep } from "../SyncStep";
 import { SyncOptions, SyncResult } from "../common";
-import { recsStorage } from "./recsStorage";
-import { defineInternalComponents } from "./defineInternalComponents";
 import { createStoreSync } from "../createStoreSync";
 import { ConfigToRecsComponents } from "./common";
-import storeConfig from "@latticexyz/store/mud.config.js";
-import worldConfig from "@latticexyz/world/mud.config.js";
 import { configToRecsComponents } from "./configToRecsComponents";
+import { defineInternalComponents } from "./defineInternalComponents";
+import { RecsUpdatesHook, recsStorage } from "./recsStorage";
 import { singletonEntity } from "./singletonEntity";
-import { SyncStep } from "../SyncStep";
 
 type SyncToRecsOptions<TConfig extends StoreConfig = StoreConfig> = SyncOptions<TConfig> & {
   world: RecsWorld;
   config: TConfig;
   startSync?: boolean;
+  recsAllUpdatesHook?: RecsUpdatesHook;
 };
 
 type SyncToRecsResult<TConfig extends StoreConfig = StoreConfig> = SyncResult<TConfig> & {
@@ -34,6 +35,7 @@ export async function syncToRecs<TConfig extends StoreConfig = StoreConfig>({
   maxBlockRange,
   initialState,
   indexerUrl,
+  recsAllUpdatesHook,
   startSync = true,
 }: SyncToRecsOptions<TConfig>): Promise<SyncToRecsResult<TConfig>> {
   const components = {
@@ -46,7 +48,7 @@ export async function syncToRecs<TConfig extends StoreConfig = StoreConfig>({
   world.registerEntity({ id: singletonEntity });
 
   const storeSync = await createStoreSync({
-    storageAdapter: recsStorage({ components, config }),
+    storageAdapter: recsStorage({ components, config }, recsAllUpdatesHook),
     config,
     address,
     publicClient,