Use static import for ENSIndexer Schema used with subgraphGraphQLMidlleware function#1851
Use static import for ENSIndexer Schema used with subgraphGraphQLMidlleware function#1851tk-o merged 2 commits intov1.9-patchesfrom
subgraphGraphQLMidlleware function#1851Conversation
…dleware` function
… `subgraphGraphQLMiddleware` function.
🦋 Changeset detectedLatest commit: 3d4a94b The changes in this PR will be included in the next version bump. This PR includes changesets to release 19 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughA changeset entry documents a patch-level release for the Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Greptile SummaryThis PR is a targeted hotfix replacing the Root cause: Why the fix works: By importing the abstract schema module directly ( Correctness observations:
Confidence Score: 5/5This PR is safe to merge — it is a focused hotfix with no functional regressions, proper documentation of the temporary workaround, and preserves all existing lazy-initialization behavior. The change is minimal, well-reasoned, and directly fixes a concrete runtime failure. No P0/P1 issues found. The mutation semantics of the abstract schema module work correctly with filterSchemaByPrefix's reference-based filtering and the lazy() guard remains intact for OpenAPI generation. The FIXME comment appropriately tracks the follow-up work. No files require special attention. The only file modified meaningfully is apps/ensapi/src/handlers/subgraph/subgraph-api.ts, and the change is correct. Important Files Changed
Sequence DiagramsequenceDiagram
participant Mod as subgraph-api.ts (module load)
participant Abs as @ensnode/ensdb-sdk/ensindexer-abstract
participant Filter as filterSchemaByPrefix
participant Lazy as lazy()
participant MW as subgraphGraphQLMiddleware
participant Drizzle as makeDrizzle / setDatabaseSchema
Mod->>Abs: import * as ensIndexerSchema
Note over Abs: Real module namespace (no Proxy)
Mod->>Filter: filterSchemaByPrefix("subgraph_", ensIndexerSchema)
Filter-->>Mod: subgraphSchema (plain object with table refs)
Note over Mod,Lazy: Module fully loaded — env vars NOT required yet
rect rgb(200, 230, 200)
Note over Lazy,Drizzle: First incoming HTTP request
Lazy->>MW: subgraphGraphQLMiddleware({schema: subgraphSchema, databaseSchema, ...})
MW->>Drizzle: makeDrizzle({schema: subgraphSchema, databaseSchema})
Drizzle->>Drizzle: setDatabaseSchema(subgraphSchema, databaseSchema)
Note over Drizzle: Mutates table objects in-place via Table.Symbol.Schema — works correctly, no Proxy in the way
Drizzle-->>MW: drizzleClient
MW-->>Lazy: Hono middleware
end
Reviews (1): Last reviewed commit: "docs(changeset): Updated `ensIndexerSche..." | Re-trigger Greptile |
There was a problem hiding this comment.
Pull request overview
This PR updates ENSApi’s subgraph handler to use a statically imported ENSIndexer schema (from @ensnode/ensdb-sdk) instead of the lazyProxy-wrapped ensIndexerSchema export, addressing a Drizzle ORM compatibility issue in ponder-subgraph while preserving the ability to import the module during OpenAPI generation without requiring env vars.
Changes:
- Replaced
ensIndexerSchemaimport from@/lib/ensdb/singletonwith a static import from@ensnode/ensdb-sdk/ensindexer-abstract. - Kept subgraph schema derivation via
filterSchemaByPrefix("subgraph_", ...)but with the new schema source. - Added a changeset to ship the fix as an
ensapipatch.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| apps/ensapi/src/handlers/subgraph/subgraph-api.ts | Switches schema source to ensdb-sdk’s abstract schema to avoid lazyProxy/Drizzle incompatibility. |
| .changeset/thin-lemons-type.md | Declares a patch release for ensapi describing the schema import adjustment. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| // import { ensIndexerSchema } from "@/lib/ensdb/singleton"; | ||
| // Once the lazy proxy implemented for `ensIndexerSchema` export is improved | ||
| // to support Drizzle ORM in `ponder-subgraph` package. | ||
| import * as ensIndexerSchema from "@ensnode/ensdb-sdk/ensindexer-abstract"; |
There was a problem hiding this comment.
The identifier ensIndexerSchema is now importing the abstract schema module (@ensnode/ensdb-sdk/ensindexer-abstract), not the concrete EnsDbReader.ensIndexerSchema. Renaming this import to something like abstractEnsIndexerSchema (and updating the filterSchemaByPrefix call) would avoid confusion and make it clear why setDatabaseSchema is needed downstream.
| // Once the lazy proxy implemented for `ensIndexerSchema` export is improved | ||
| // to support Drizzle ORM in `ponder-subgraph` package. |
There was a problem hiding this comment.
The FIXME comment is a bit ambiguous about what needs to be “improved”. Consider clarifying that the current lazyProxy implementation doesn’t support key enumeration (e.g. Object.entries/Object.keys/ownKeys), which is what Drizzle (via ponder-subgraph) relies on, so future readers know the precise blocker.
| // Once the lazy proxy implemented for `ensIndexerSchema` export is improved | |
| // to support Drizzle ORM in `ponder-subgraph` package. | |
| // once the `lazyProxy` used for the `ensIndexerSchema` export supports key | |
| // enumeration (e.g. Object.keys/Object.entries/Reflect.ownKeys), which Drizzle | |
| // (used by the `@ensnode/ponder-subgraph` package) currently relies on. |
Lite PR
Tip: Review docs on the ENSNode PR process
Summary
ensIndexerSchemavalue that is passed intosubgraphGraphQLMiddlewarefunction.lazyProxywith the value read directly from ENSDb SDK.Why
The lazy-proxy implemented for
ensIndexerSchemaexport is not working with Drizzle ORM inponder-subgraphpackage.What does not work (the current v1.9.0):
What does work:
However, there would be a problem with generating the OpenAPI spec if we went ahead with just dropping the
lazyProxywrapper. We need something else for the hotfix.Testing
v1.8.1andv1.9.0.ENSINDEXER_SCHEMA_NAME=mainnetSchema1.9.0Notes for Reviewer (Optional)
v1.9.0commit.Pre-Review Checklist (Blocking)