WIP global hooks exploration

packages/config/package.json

@@ -42,10 +42,12 @@
     "esbuild": "^0.17.15",
     "ethers": "^5.7.2",
     "find-up": "^6.3.0",
+    "tapable": "^2.2.1",
     "zod": "^3.21.4",
     "zod-validation-error": "^1.3.0"
   },
   "devDependencies": {
+    "@types/tapable": "^2.2.3",
     "tsup": "^6.7.0"
   },
   "gitHead": "914a1e0ae4a573d685841ca2ea921435057deb8f"

packages/config/src/library/context.ts

@@ -1,5 +1,6 @@
-import { MUDConfigExtender } from "./core";
+import { MUDConfigExtender, MUDHooks } from "./types";
 import { MUDContextAlreadyCreatedError, MUDContextNotCreatedError } from "./errors";
+import { defaultHooks } from "./defaultHooks";
 
 export type GlobalWithMUDCoreContext = typeof global & {
   __mudCoreContext: MUDCoreContext;
@@ -33,4 +34,6 @@ export class MUDCoreContext {
   }
 
   public readonly configExtenders: MUDConfigExtender[] = [];
+  // the typecast helps prevent typechecks after type extensions from erroring on defaultHooks not having a key
+  public readonly hooks: MUDHooks = defaultHooks as MUDHooks;
 }

packages/config/src/library/core.ts

@@ -1,22 +1,20 @@
+import { MUDError } from "@latticexyz/common/errors";
 import { MUDCoreContext } from "./context";
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface MUDCoreUserConfig {}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface MUDCoreConfig {}
-
-export type MUDConfigExtender = (config: MUDCoreConfig) => Record<string, unknown>;
+import { MUDConfigExtender, MUDCoreConfig, MUDCoreUserConfig, MUDHooks } from "./types";
 
 /** Resolver that sequentially passes the config through all the plugins */
 export function mudCoreConfig(config: MUDCoreUserConfig): MUDCoreConfig {
   // config types can change with plugins, `any` helps avoid errors when typechecking dependencies
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   let configAsAny = config as any;
   const context = MUDCoreContext.getContext();
+
+  context.hooks.beforeAll.call(configAsAny);
   for (const extender of context.configExtenders) {
     configAsAny = extender(configAsAny);
   }
+  context.hooks.afterAll.call(configAsAny);
+
   return configAsAny;
 }
 
@@ -25,3 +23,20 @@ export function extendMUDCoreConfig(extender: MUDConfigExtender) {
   const context = MUDCoreContext.getContext();
   context.configExtenders.push(extender);
 }
+
+export function initializeMUDHook<T extends keyof MUDHooks>(name: T, hook: MUDHooks[T]) {
+  const context = MUDCoreContext.getContext();
+  if (context.hooks[name]) {
+    throw new MUDError(`Hook "${name}" has already been initialized`);
+  }
+  context.hooks[name] = hook;
+}
+
+export function getMudHook(name: keyof MUDHooks) {
+  const context = MUDCoreContext.getContext();
+  const hook = context.hooks[name];
+  if (!hook) {
+    throw new MUDError(`Hook "${name}" has not been initialized`);
+  }
+  return hook;
+}

packages/config/src/library/defaultHooks.ts

@@ -0,0 +1,7 @@
+import { SyncHook } from "tapable";
+import { MUDDefaultHooks } from "./types";
+
+export const defaultHooks: MUDDefaultHooks = {
+  beforeAll: new SyncHook(["mudUserConfig"]),
+  afterAll: new SyncHook(["mudConfig"]),
+};

packages/config/src/library/index.ts

@@ -5,4 +5,5 @@ export * from "./context";
 export * from "./core";
 export * from "./dynamicResolution";
 export * from "./errors";
+export * from "./types";
 export * from "./validation";

packages/config/src/library/types.ts

@@ -0,0 +1,17 @@
+import { SyncHook } from "tapable";
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface MUDCoreUserConfig {}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface MUDCoreConfig {}
+
+export type MUDConfigExtender = (config: MUDCoreConfig) => Record<string, unknown>;
+
+export interface MUDDefaultHooks {
+  beforeAll: SyncHook<MUDCoreUserConfig>;
+  afterAll: SyncHook<MUDCoreConfig>;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface MUDHooks extends MUDDefaultHooks {}

packages/store/package.json

@@ -53,13 +53,15 @@
     "@latticexyz/config": "workspace:*",
     "@latticexyz/schema-type": "workspace:*",
     "ethers": "^5.7.2",
+    "tapable": "^2.2.1",
     "zod": "^3.21.4"
   },
   "devDependencies": {
     "@typechain/ethers-v5": "^10.2.0",
     "@types/ejs": "^3.1.1",
     "@types/mocha": "^9.1.1",
     "@types/node": "^18.15.11",
+    "@types/tapable": "^2.2.3",
     "ds-test": "https://github.com/dapphub/ds-test.git#c9ce3f25bde29fc5eb9901842bf02850dfd2d084",
     "ejs": "^3.1.8",
     "forge-std": "https://github.com/foundry-rs/forge-std.git#b4f121555729b3afb3c5ffccb62ff4b6e2818fd3",

packages/store/ts/library/hooks.ts

@@ -0,0 +1,6 @@
+import { MUDCoreConfig } from "@latticexyz/config";
+import { SyncHook } from "tapable";
+
+export type StoreHooks = {
+  preTablegen: SyncHook<MUDCoreConfig>;
+};

packages/store/ts/library/index.ts

@@ -2,3 +2,4 @@
 // (library neither creates nor extends MUDCoreContext when imported)
 export * from "./config";
 export * from "./render-solidity";
+export * from "./hooks";

packages/store/ts/library/render-solidity/tablegen.ts

@@ -6,10 +6,13 @@ import { renderTypesFromConfig } from "./renderTypesFromConfig";
 import { renderTableIndex } from "./renderTableIndex";
 import { rmSync } from "fs";
 import { StoreConfig } from "../config";
+import { getMudHook } from "@latticexyz/config";
 
 export async function tablegen(config: StoreConfig, outputBaseDirectory: string) {
   const allTableOptions = getTableOptions(config);
 
+  //getMudHook("")
+
   const uniqueTableDirectories = new Set(allTableOptions.map(({ outputPath }) => path.dirname(outputPath)));
   for (const tableDir of uniqueTableDirectories) {
     rmSync(path.join(outputBaseDirectory, tableDir), { recursive: true, force: true });

packages/store/ts/register/configExtensions.ts → packages/store/ts/register/contextExtensions.ts

@@ -1,4 +1,5 @@
-import { extendMUDCoreConfig, fromZodErrorCustom } from "@latticexyz/config";
+import { extendMUDCoreConfig, fromZodErrorCustom, initializeMUDHook } from "@latticexyz/config";
+import { SyncHook } from "tapable";
 import { ZodError } from "zod";
 import { zPluginStoreConfig } from "../library/config";
 
@@ -16,3 +17,5 @@ extendMUDCoreConfig((config) => {
     }
   }
 });
+
+initializeMUDHook("preTablegen", new SyncHook(["mudConfig"]));

packages/store/ts/register/index.ts

@@ -6,8 +6,10 @@
 import "@latticexyz/config/register";
 export { mudCoreConfig, resolveTableId } from "@latticexyz/config/register";
 // Extend core config and types
-import "./configExtensions";
+import "./contextExtensions";
 import "./typeExtensions";
+// Tap hooks
+import "./tapHooks";
 
 export { mudConfig } from "./mudConfig";
 export type { ExpandMUDUserConfig } from "./typeExtensions";

packages/store/ts/register/tapHooks.ts

@@ -0,0 +1,9 @@
+import { getMudHook } from "@latticexyz/config";
+
+getMudHook("beforeAll").tap("store", () => {
+  console.log("called store's beforeAll hook");
+});
+
+getMudHook("afterAll").tap("store", () => {
+  console.log("called store's afterAll hook");
+});

packages/store/ts/register/typeExtensions.ts

@@ -1,5 +1,6 @@
 import { OrDefaults } from "@latticexyz/common/type-utils";
 import { MUDCoreUserConfig } from "@latticexyz/config";
+import { StoreHooks } from "../library";
 import { ExpandTablesConfig, StoreConfig, StoreUserConfig } from "../library/config";
 import { DEFAULTS, PATH_DEFAULTS } from "../library/config/defaults";
 
@@ -17,6 +18,9 @@ declare module "@latticexyz/config" {
   // Other plugins receive this resolved config as their input.
   // eslint-disable-next-line @typescript-eslint/no-empty-interface
   export interface MUDCoreConfig extends StoreConfig {}
+
+  // eslint-disable-next-line @typescript-eslint/no-empty-interface
+  export interface MUDHooks extends StoreHooks {}
 }
 
 // store-specific helper to preserve strong types, depends on store's type extensions to the core config