Lazy-evaluate ENSDb modules in ENSApi#2174
Open
tk-o wants to merge 3 commits into
Open
Conversation
|
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
3 Skipped Deployments
|
Contributor
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (34)
📝 WalkthroughWalkthroughThis PR removes the ENS DB singleton pattern and migrates all database/schema dependencies across the ensapi application to use a centralized dependency-injection container. Module-level imports of ChangesSingleton Dependency Injection Refactor
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Possibly related issues
Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 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 |
Contributor
Greptile SummaryThis PR replaces eagerly-evaluated imports from
Confidence Score: 5/5Safe to merge — the change is a well-scoped mechanical refactor with no behavioral differences in the production path. All production code paths continue to resolve ensDbClient lazily before first use; the circular-dependency workaround in the two cache modules uses a documented, intentional dynamic import and is correctly placed before the try block so the captured reference stays valid in error logs. Tests are updated consistently and the deleted singleton had no remaining callers. No files require special attention. Important Files Changed
Sequence DiagramsequenceDiagram
participant App as ENSApi Startup
participant DI as EnsApiDiContainer
participant Cache as SWRCache (lazyProxy)
participant DiMod as @/di (async import)
participant EnsDb as EnsDbReader
App->>DI: di.init()
DI->>DI: loadContext() → buildEnsApiDiContext(process.env)
DI->>Cache: context.indexingStatusCache.read()
Note over Cache: lazyProxy triggers SWRCache construction
Cache-->>DI: Promise (async)
DI->>Cache: context.stackInfoCache.read()
Cache-->>DI: Promise (async)
Note over Cache,DiMod: Async load fn runs later
Cache->>DiMod: "await import("@/di")"
DiMod-->>Cache: di (singleton)
Cache->>DI: di.context.ensDbClient
DI->>DI: "instances.ensDbConfig = buildEnsDbConfigFromEnvironment(env)"
DI->>EnsDb: new EnsDbReader(ensDbUrl, ensIndexerSchemaName)
EnsDb-->>DI: EnsDbReader instance
DI-->>Cache: ensDbClient
Cache->>EnsDb: getIndexingMetadataContext()
EnsDb-->>Cache: IndexingMetadataContext
Reviews (2): Last reviewed commit: "Fix tests" | Re-trigger Greptile |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR migrates ENSApi’s ENSDb access away from the @/lib/ensdb/singleton lazyProxy-based singleton and onto the @/di container so ENSDb modules are instantiated lazily via DI getters instead of import-time evaluation.
Changes:
- Replace
ensDb/ensIndexerSchema/ensDbClientimports from@/lib/ensdb/singletonwithdi.context.*across Omnigraph schema + supporting libs/handlers. - Move ENSDb config + client construction into
apps/ensapi/src/di.ts(build config from env on-demand; instantiateEnsDbReaderon first access). - Remove
apps/ensapi/src/lib/ensdb/singleton.tsand update tests/caches to reference DI.
Reviewed changes
Copilot reviewed 34 out of 34 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| apps/ensapi/src/omnigraph-api/schema/resolver.ts | Swap ENSDb/schema access to di.context inside resolver loaders/field resolvers. |
| apps/ensapi/src/omnigraph-api/schema/resolver-records.ts | Use di.context.ensDb for ResolverRecords loader. |
| apps/ensapi/src/omnigraph-api/schema/resolver-permissions-user.ts | Update PermissionsUser typing to reference DI-provided schema types. |
| apps/ensapi/src/omnigraph-api/schema/renewal.ts | Use di.context.ensDb for Renewal loader. |
| apps/ensapi/src/omnigraph-api/schema/registry.ts | Use DI for registry loading + subregistry-domain connection queries. |
| apps/ensapi/src/omnigraph-api/schema/registry-permissions-user.ts | Update PermissionsUser typing to reference DI-provided schema types. |
| apps/ensapi/src/omnigraph-api/schema/registration.ts | Use DI for registration loading + renewals queries. |
| apps/ensapi/src/omnigraph-api/schema/query.ts | Use DI for “dev method” connections (allDomains/resolvers/registrations). |
| apps/ensapi/src/omnigraph-api/schema/permissions.ts | Use DI for Permissions/Resource/User loaders + event connections. |
| apps/ensapi/src/omnigraph-api/schema/label.ts | Update Label typing to reference DI-provided schema types. |
| apps/ensapi/src/omnigraph-api/schema/event.ts | Use di.context.ensDb for Event loader. |
| apps/ensapi/src/omnigraph-api/schema/domain.ts | Use DI for domain loading + registrations/events/permissions queries. |
| apps/ensapi/src/omnigraph-api/schema/account.ts | Use DI for account loading + permissions queries. |
| apps/ensapi/src/omnigraph-api/lib/get-latest-registration.ts | Read ENSDb via DI inside helper. |
| apps/ensapi/src/omnigraph-api/lib/get-domain-resolver.ts | Read ENSDb via DI inside helper. |
| apps/ensapi/src/omnigraph-api/lib/get-domain-by-interpreted-name.ts | Read ENSDb/schema via DI before executing recursive SQL. |
| apps/ensapi/src/omnigraph-api/lib/find-events/find-events-resolver.ts | Replace ENSDb/schema singleton usage with DI throughout event query builder. |
| apps/ensapi/src/omnigraph-api/lib/find-domains/find-domains-resolver.ts | Replace ENSDb/schema singleton usage with DI throughout domain query builder. |
| apps/ensapi/src/omnigraph-api/lib/find-domains/find-domains-resolver-helpers.ts | Replace schema singleton usage with DI in ordering/cursor helpers. |
| apps/ensapi/src/omnigraph-api/context.ts | Use DI for DataLoader query against ENSDb/schema. |
| apps/ensapi/src/lib/registrar-actions/find-registrar-actions.ts | Replace ENSDb/schema singleton usage with DI throughout query building. |
| apps/ensapi/src/lib/protocol-acceleration/get-records-from-index.ts | Replace ENSDb singleton usage with DI. |
| apps/ensapi/src/lib/protocol-acceleration/get-primary-name-from-index.ts | Replace ENSDb singleton usage with DI. |
| apps/ensapi/src/lib/protocol-acceleration/find-resolver.ts | Replace ENSDb singleton usage with DI in index-backed resolver lookup. |
| apps/ensapi/src/lib/name-tokens/find-name-tokens-for-domain.ts | Replace ENSDb/schema singleton usage with DI in typed select + query. |
| apps/ensapi/src/lib/ensdb/singleton.ts | Remove ENSApi ENSDb singleton module. |
| apps/ensapi/src/lib/ensanalytics/referrer-leaderboard/database.ts | Replace ENSDb/schema singleton usage with DI for referral queries. |
| apps/ensapi/src/handlers/ensapi-probes/ensapi-probes-api.ts | Use di.context.ensDbClient for health/readiness probes. |
| apps/ensapi/src/di.ts | Move ENSDb config + EnsDbReader instantiation into DI context getters. |
| apps/ensapi/src/config/ensdb-config.ts | Tighten env typing for ENSDb config builder to EnsDbEnvironment. |
| apps/ensapi/src/config/config.singleton.test.ts | Update singleton bootstrap tests to initialize/use DI container. |
| apps/ensapi/src/config/config.schema.test.ts | Remove ENSDb singleton mocks; adjust imports accordingly. |
| apps/ensapi/src/cache/stack-info.cache.ts | Switch to dynamic DI import + di.context.ensDbClient for metadata reads. |
| apps/ensapi/src/cache/indexing-status.cache.ts | Switch to dynamic DI import + di.context.ensDbClient for metadata reads. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
3
to
14
| @@ -9,7 +9,7 @@ import { ResolverRef } from "@/omnigraph-api/schema/resolver"; | |||
| * Represents a PermissionsUser whose contract is a Resolver, providing a semantic `resolver` field. | |||
| */ | |||
| export const ResolverPermissionsUserRef = | |||
| builder.objectRef<typeof ensIndexerSchema.permissionsUser.$inferSelect>( | |||
| builder.objectRef<typeof di.context.ensIndexerSchema.permissionsUser.$inferSelect>( | |||
| "ResolverPermissionsUser", | |||
| ); | |||
Comment on lines
113
to
120
| get ensDbClient(): EnsDbReader { | ||
| return ensDbClient; | ||
| if (instances.ensDbClient === undefined) { | ||
| const { ensDbUrl, ensIndexerSchemaName } = context.ensDbConfig; | ||
| instances.ensDbClient = new EnsDbReader(ensDbUrl, ensIndexerSchemaName); | ||
| } | ||
|
|
||
| return instances.ensDbClient; | ||
| }, |
… `@/di` imports Mechanical updates only
tk-o
force-pushed
the
feat/2029-di-for-ensdb-modules
branch
from
d943075 to
3fa3adb
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@apps/ensapi/src/cache/indexing-status.cache.ts`:
- Around line 32-37: The dynamic import of "`@/di`" and the subsequent access to
di.context/ensDbClient occur before the existing try block so any failures skip
the loader’s structured error logging; move the import("`@/di`") and the const {
ensDbClient } = di.context into the existing try block (or wrap them in their
own try/catch that forwards errors to the same loader error handler) so import
rejections and missing context errors are caught and logged by the loader’s
structured error path, ensuring the same error handling used elsewhere in this
module.
In `@apps/ensapi/src/cache/stack-info.cache.ts`:
- Around line 43-48: Move the dynamic DI import and context access into the
existing try block so any failures are caught and routed through the function's
error logging; specifically, relocate the await import("`@/di`").then((mod) =>
mod.default) and the subsequent const { ensDbClient } = di.context into the try
that wraps the cache load logic (the block that currently catches and logs load
errors) so that errors resolving di or accessing ensDbClient are logged like
other load failures.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 01efee16-ee34-4955-be6a-7db3525f8067
📒 Files selected for processing (34)
apps/ensapi/src/cache/indexing-status.cache.tsapps/ensapi/src/cache/stack-info.cache.tsapps/ensapi/src/config/config.schema.test.tsapps/ensapi/src/config/config.singleton.test.tsapps/ensapi/src/config/ensdb-config.tsapps/ensapi/src/di.tsapps/ensapi/src/handlers/ensapi-probes/ensapi-probes-api.tsapps/ensapi/src/lib/ensanalytics/referrer-leaderboard/database.tsapps/ensapi/src/lib/ensdb/singleton.tsapps/ensapi/src/lib/name-tokens/find-name-tokens-for-domain.tsapps/ensapi/src/lib/protocol-acceleration/find-resolver.tsapps/ensapi/src/lib/protocol-acceleration/get-primary-name-from-index.tsapps/ensapi/src/lib/protocol-acceleration/get-records-from-index.tsapps/ensapi/src/lib/registrar-actions/find-registrar-actions.tsapps/ensapi/src/omnigraph-api/context.tsapps/ensapi/src/omnigraph-api/lib/find-domains/find-domains-resolver-helpers.tsapps/ensapi/src/omnigraph-api/lib/find-domains/find-domains-resolver.tsapps/ensapi/src/omnigraph-api/lib/find-events/find-events-resolver.tsapps/ensapi/src/omnigraph-api/lib/get-domain-by-interpreted-name.tsapps/ensapi/src/omnigraph-api/lib/get-domain-resolver.tsapps/ensapi/src/omnigraph-api/lib/get-latest-registration.tsapps/ensapi/src/omnigraph-api/schema/account.tsapps/ensapi/src/omnigraph-api/schema/domain.tsapps/ensapi/src/omnigraph-api/schema/event.tsapps/ensapi/src/omnigraph-api/schema/label.tsapps/ensapi/src/omnigraph-api/schema/permissions.tsapps/ensapi/src/omnigraph-api/schema/query.tsapps/ensapi/src/omnigraph-api/schema/registration.tsapps/ensapi/src/omnigraph-api/schema/registry-permissions-user.tsapps/ensapi/src/omnigraph-api/schema/registry.tsapps/ensapi/src/omnigraph-api/schema/renewal.tsapps/ensapi/src/omnigraph-api/schema/resolver-permissions-user.tsapps/ensapi/src/omnigraph-api/schema/resolver-records.tsapps/ensapi/src/omnigraph-api/schema/resolver.ts
💤 Files with no reviewable changes (1)
- apps/ensapi/src/lib/ensdb/singleton.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Lite PR
Tip: Review docs on the ENSNode PR process
Summary
@/lib/ensdb/singletonwith the lazily-evaluated counterparts from@/di.Why
lazy/lazyProxyprimitives from ENSNode codebase.Testing
Notes for Reviewer (Optional)
Pre-Review Checklist (Blocking)