Support custom configs in MockIndexer and add envio package tests

.github/workflows/build_and_verify.yml

@@ -223,6 +223,10 @@ jobs:
               echo "Hasura is up"; exit 0; fi; sleep 1; done
           echo "Hasura did not become ready"; exit 1
 
+      - name: envio-tests
+        working-directory: packages/envio-tests
+        run: pnpm test
+
       - name: test_codegen
         working-directory: scenarios/test_codegen
         run: |

package.json

@@ -5,7 +5,7 @@
   "scripts": {
     "test:templates": "pnpm --filter e2e-tests test:templates",
     "test:e2e": "pnpm --filter e2e-tests test:e2e",
-    "test": "for d in test_codegen fuel_test svm_test e2e_test; do echo \"=== scenarios/$d ===\" && (cd \"scenarios/$d\" && pnpm exec envio codegen && pnpm test) || exit 1; done"
+    "test": "(cd packages/envio-tests && pnpm test) && for d in test_codegen fuel_test svm_test e2e_test; do echo \"=== scenarios/$d ===\" && (cd \"scenarios/$d\" && pnpm exec envio codegen && pnpm test) || exit 1; done"
   },
   "devDependencies": {},
   "pnpm": {

packages/envio-tests/.gitignore

@@ -0,0 +1,6 @@
+node_modules/
+
+# ReScript artifacts
+lib
+*.res.js
+*.res.mjs

packages/envio-tests/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "envio-tests",
+  "version": "0.0.1-dev",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "build": "rescript",
+    "watch": "rescript watch",
+    "test": "rescript && vitest run"
+  },
+  "devDependencies": {
+    "@rescript/runtime": "12.2.0",
+    "rescript": "12.2.0",
+    "rescript-schema": "9.5.1",
+    "vitest": "4.1.0"
+  },
+  "dependencies": {
+    "bignumber.js": "9.3.1",
+    "envio": "file:../envio"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  }
+}

packages/envio-tests/rescript.json

@@ -0,0 +1,23 @@
+{
+  "name": "envio-tests",
+  "namespace": false,
+  "sources": [
+    {
+      "dir": "test",
+      "subdirs": true
+    }
+  ],
+  "suffix": ".res.mjs",
+  "package-specs": {
+    "module": "esmodule",
+    "in-source": true
+  },
+  "jsx": {
+    "version": 4
+  },
+  "dependencies": ["rescript-schema", "envio"],
+  "compiler-flags": ["-open RescriptSchema"],
+  "warnings": {
+    "error": "+a"
+  }
+}

packages/envio-tests/test/setup.ts

@@ -0,0 +1,3 @@
+// Importing Env triggers Logging.setLogger as a side effect,
+// ensuring the logger is available for all tests.
+import "envio/src/Env.res.mjs";

packages/envio-tests/vitest.config.ts

@@ -0,0 +1,22 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    include: ["test/**/*_test.res.mjs", "test/**/*.test.ts"],
+    exclude: ["test/helpers/**"],
+    // No shared database or other cross-file state, so files can run in
+    // parallel (each fork gets its own process-level globals).
+    pool: "forks",
+    testTimeout: 30_000,
+    hookTimeout: 30_000,
+    setupFiles: ["test/setup.ts"],
+    passWithNoTests: true,
+    server: {
+      deps: {
+        // Externalize non-test files so they load via native Node.js ESM,
+        // preventing dual module cache between vite and native import()
+        external: [/^(?!.*\.test\.)(?!.*_test\.)(?!.*\/test\/).*$/i],
+      },
+    },
+  },
+});

packages/envio/package.json

@@ -74,7 +74,6 @@
     "tsx": "4.21.0"
   },
   "devDependencies": {
-    "rescript": "12.2.0",
-    "vitest": "4.1.0"
+    "rescript": "12.2.0"
   }
 }

scenarios/test_codegen/package.json

@@ -32,7 +32,8 @@
     "typescript": "6.0.3",
     "ts-expect": "1.3.0",
     "viem": "2.54.0",
-    "envio": "file:../../packages/envio"
+    "envio": "file:../../packages/envio",
+    "envio-tests": "file:../../packages/envio-tests"
   },
   "engines": {
     "node": ">=22.0.0"

scenarios/test_codegen/rescript.json

@@ -20,7 +20,8 @@
   },
   "dependencies": [
     "rescript-schema",
-    "envio"
+    "envio",
+    "envio-tests"
   ],
   "compiler-flags": ["-open RescriptSchema"],
   "warnings": {

scenarios/test_codegen/test/IndexerState_test.res

@@ -145,7 +145,7 @@ let populateChainQueuesWithRandomEvents = (~runTime=1000, ~maxBlockTime=15, ())
 
   let state = IndexerState.make(
     ~config,
-    ~persistence=MockIndexer.defaultPersistence,
+    ~persistence=MockIndexer.defaultPersistence(),
     ~chainStates,
     ~isInReorgThreshold=false,
     ~isRealtime=false,
@@ -336,7 +336,7 @@ describe("IndexerState", () => {
           )
           IndexerState.make(
             ~config,
-            ~persistence=MockIndexer.defaultPersistence,
+            ~persistence=MockIndexer.defaultPersistence(),
             ~chainStates,
             ~isInReorgThreshold=false,
             ~isRealtime=false,

scenarios/test_codegen/test/YamlConfigIndexer_test.res

@@ -0,0 +1,71 @@
+open Vitest
+
+// The user-facing entity shape declared in the schema string below —
+// intentionally absent from the generated project schema.
+type yamlToken = {
+  id: string,
+  owner: string,
+}
+
+type yamlTokenOps = {set: yamlToken => unit}
+type yamlHandlerContext = {@as("YamlToken") yamlToken: yamlTokenOps}
+
+describe("YAML-driven MockIndexer", () => {
+  Async.it(
+    "runs the indexer loop with a config parsed from user YAML instead of the generated one",
+    async t => {
+      let {config} = MockIndexerConfig.parseYaml(
+        ~schema=`
+type YamlToken {
+  id: ID!
+  owner: String!
+}
+`,
+        `
+name: yaml-driven
+chains:
+  - id: 1337
+    rpc:
+      url: https://rpc.example.test
+      for: sync
+    start_block: 1
+    contracts:
+      - name: Token
+        address: "0x0000000000000000000000000000000000000001"
+        events:
+          - event: Transfer()
+`,
+      )
+
+      let source = MockIndexer.Source.make([#getHeightOrThrow, #getItemsOrThrow], ~chain=#1337)
+      let indexerMock = await MockIndexer.Indexer.make(
+        ~config,
+        ~chains=[{chain: #1337, sourceConfig: Config.CustomSources([source.source])}],
+        ~shouldRollbackOnReorg=false,
+      )
+      await Utils.delay(0)
+
+      source.resolveGetHeightOrThrow(300)
+      await Utils.delay(0)
+      await Utils.delay(0)
+
+      source.resolveGetItemsOrThrow([
+        {
+          blockNumber: 5,
+          logIndex: 0,
+          handler: async args => {
+            let context =
+              args.context->(Utils.magic: MockIndexer.handlerContext => yamlHandlerContext)
+            context.yamlToken.set({id: "token-1", owner: "0xabc"})
+          },
+        },
+      ], ~latestFetchedBlockNumber=300)
+      await indexerMock.getBatchWritePromise()
+
+      let tokens: array<yamlToken> = await indexerMock.queryRaw(
+        config.userEntitiesByName->Dict.getUnsafe("YamlToken"),
+      )
+      t.expect(tokens).toEqual([{id: "token-1", owner: "0xabc"}])
+    },
+  )
+})