Conversation
|
|
@sevenzing is attempting to deploy a commit to the NameHash Team on Vercel. A member of the Team first needs to authorize it. |
📝 WalkthroughWalkthroughThe pull request refactors the API routing structure by removing four public API submodules from the ensnode-api handler, renaming and reorganizing realtime API modules with updated path conventions, creating a new router module to consolidate route wiring, and updating import paths across the codebase to use new module locations and alias paths. Changes
Possibly Related PRs
Poem
Estimated Code Review Effort🎯 3 (Moderate) | ⏱️ ~22 minutes 🚥 Pre-merge checks | ✅ 1 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (1 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 |
sevenzing
force-pushed
the
ll/ensapi/rearrange-api-register
branch
from
0ee90f6 to
b3795f1
Compare
|
The latest updates on your projects. Learn more about Vercel for GitHub. 3 Skipped Deployments
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
apps/ensapi/src/index.ts (1)
63-75:⚠️ Potential issue | 🟠 MajorPick one canonical realtime URL; this currently exposes two public endpoints.
apiRouteralready makes the same handler available at/api/realtime, so Line 75 keeps a second live path at/amirealtimewhile the generated OpenAPI only documents/api/realtime. That leaves the legacy path undocumented and makes the public contract ambiguous.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@apps/ensapi/src/index.ts` around lines 63 - 75, The code exposes the realtime handler twice—once via apiRouter at /api/realtime and again with app.route("/amirealtime", realtimeApi)—which creates an undocumented duplicate public path; remove the duplicate by deleting the app.route("/amirealtime", realtimeApi) line (or replace it with a 301 redirect to /api/realtime if you must preserve a legacy URL) so that the canonical endpoint is /api/realtime served by apiRouter and only realtimeApi is referenced through that single route.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@apps/ensapi/src/handlers/api/meta/realtime-api.routes.ts`:
- Around line 14-17: The operationId for this route was changed and will break
the published OpenAPI contract; revert the operationId in the createRoute call
for amIRealtimeGetMeta back to the original name (e.g., "isRealtime") so
generated client methods and the API contract remain unchanged—update the
operationId property inside the createRoute invocation that defines
amIRealtimeGetMeta to the original identifier.
---
Outside diff comments:
In `@apps/ensapi/src/index.ts`:
- Around line 63-75: The code exposes the realtime handler twice—once via
apiRouter at /api/realtime and again with app.route("/amirealtime",
realtimeApi)—which creates an undocumented duplicate public path; remove the
duplicate by deleting the app.route("/amirealtime", realtimeApi) line (or
replace it with a 301 redirect to /api/realtime if you must preserve a legacy
URL) so that the canonical endpoint is /api/realtime served by apiRouter and
only realtimeApi is referenced through that single route.
🪄 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: 350239c6-a41e-4389-99b8-a9d70f981c4b
📒 Files selected for processing (22)
apps/ensapi/src/handlers/api/explore/name-tokens-api.routes.tsapps/ensapi/src/handlers/api/explore/name-tokens-api.tsapps/ensapi/src/handlers/api/explore/registrar-actions-api.routes.tsapps/ensapi/src/handlers/api/explore/registrar-actions-api.tsapps/ensapi/src/handlers/api/graphql/ensnode-graphql-api.tsapps/ensapi/src/handlers/api/meta/ensnode-api.routes.tsapps/ensapi/src/handlers/api/meta/ensnode-api.tsapps/ensapi/src/handlers/api/meta/realtime-api.routes.tsapps/ensapi/src/handlers/api/meta/realtime-api.test.tsapps/ensapi/src/handlers/api/meta/realtime-api.tsapps/ensapi/src/handlers/api/resolution/resolution-api.routes.tsapps/ensapi/src/handlers/api/resolution/resolution-api.tsapps/ensapi/src/handlers/api/router.tsapps/ensapi/src/handlers/ensanalytics/ensanalytics-api-v1.routes.tsapps/ensapi/src/handlers/ensanalytics/ensanalytics-api-v1.test.tsapps/ensapi/src/handlers/ensanalytics/ensanalytics-api-v1.tsapps/ensapi/src/handlers/ensanalytics/ensanalytics-api.routes.tsapps/ensapi/src/handlers/ensanalytics/ensanalytics-api.test.tsapps/ensapi/src/handlers/ensanalytics/ensanalytics-api.tsapps/ensapi/src/handlers/subgraph/subgraph-api.tsapps/ensapi/src/index.tsapps/ensapi/src/openapi-document.ts
💤 Files with no reviewable changes (1)
- apps/ensapi/src/handlers/api/meta/ensnode-api.ts
| export const amIRealtimeGetMeta = createRoute({ | ||
| method: "get", | ||
| path: "/", | ||
| operationId: "isRealtime", | ||
| operationId: "getRealtime", |
There was a problem hiding this comment.
Keep the existing operationId unless you want an explicit breaking API change.
Renaming isRealtime to getRealtime changes the published OpenAPI contract and will rename generated client methods even though the endpoint behavior did not change.
Minimal fix
export const amIRealtimeGetMeta = createRoute({
method: "get",
path: "/",
- operationId: "getRealtime",
+ operationId: "isRealtime",
tags: ["Meta"],📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| export const amIRealtimeGetMeta = createRoute({ | |
| method: "get", | |
| path: "/", | |
| operationId: "isRealtime", | |
| operationId: "getRealtime", | |
| export const amIRealtimeGetMeta = createRoute({ | |
| method: "get", | |
| path: "/", | |
| operationId: "isRealtime", |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@apps/ensapi/src/handlers/api/meta/realtime-api.routes.ts` around lines 14 -
17, The operationId for this route was changed and will break the published
OpenAPI contract; revert the operationId in the createRoute call for
amIRealtimeGetMeta back to the original name (e.g., "isRealtime") so generated
client methods and the API contract remain unchanged—update the operationId
property inside the createRoute invocation that defines amIRealtimeGetMeta to
the original identifier.
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
There was a problem hiding this comment.
Additional Suggestions:
- The typecheck script uses 'tsgo --noEmit' from @typescript/native-preview, an unstable development preview that crashes with SIGKILL
- The 'files' field in package.json uses incorrect './' prefix for relative paths, which violates npm specification best practices
1 participant
Lite PR
Tip: Review docs on the ENSNode PR process
Summary
Why
Testing
Notes for Reviewer (Optional)
Pre-Review Checklist (Blocking)