You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
perf(server): make router inference types cheaper to type-check - #2454
This applies the same two changes as #2452 to the remaining types that walk a router with Lazyable<infer U>:
InferRouterInputs, InferRouterOutputs, InferRouterInitialContexts, InferRouterFinalContexts, InferRouterError and InferRouterErrors match a procedure through its ~orpc definition instead of the Procedure class.
Those six, and UnlaziedRouter, test each key against AnyRouter first, which has no infer. The Lazyable<infer U> inference now runs only for keys that are not plain routers.
Every type still recurses on itself; there is no new helper type.
Measurements
The base workload is the typecheck project of orpc-benchmarks: 500 routers, 3,000 procedures. Each row replaces its client calls with the lookups described. tsc --singleThreaded --extendedDiagnostics, TypeScript 7.0.2. "Before" is the published 2.0.0-beta.50, "after" is @orpc/server built from this branch. These counts are deterministic.
Workload
Instantiations
Types
InferRouterInputs and InferRouterOutputs, one lookup per procedure each
1,010,371 → 830,327 (−17.8%)
226,790 → 217,779 (−4.0%)
InferRouterInitialContexts, InferRouterFinalContexts and InferRouterErrors, one lookup per procedure each
953,314 → 726,737 (−23.8%)
192,260 → 183,245 (−4.7%)
Root router passed through unlazyRouter(), then read by a typed client call per procedure
1,168,031 → 1,112,523 (−4.8%)
253,867 → 250,863 (−1.2%)
InferRouterError has the same shape as InferRouterErrors and is changed the same way, but I did not build a separate workload for it.
No difference from main. I compared the old and new definitions of all seven types directly on procedures, nested routers, lazy routers and procedures, keys typed as Lazyable<...>, optional and readonly keys, os.router() output, AnyRouter, any and never: all resolve to identical types.
Emitted declarations are unchanged too. A consumer installed from packed tarballs (pnpm, depending only on @orpc/server) and built with composite: true, including generic code that takes a router as a type parameter, emits a .d.ts byte-identical to the one built against main, on TypeScript 7.0.2, 6.0.3 and 5.9.3.
Verification
pnpm check, pnpm test (4,585 tests) and pnpm docs:validate pass. The first pnpm test run had two failures in packages/bun (cancel and abort: bun-fetch), which are runtime timing tests this type-only change cannot reach; they passed in three separate re-runs and in a second full run.
InferRouterInputs, InferRouterOutputs, InferRouterInitialContexts,
InferRouterFinalContexts, InferRouterError and InferRouterErrors now
match a procedure through its `~orpc` definition instead of the
Procedure class. They, and UnlaziedRouter, also test each key against
AnyRouter before trying the `Lazyable<infer U>` inference, so only lazy
keys pay for it.
All of them resolve to the same types as before.
Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VVaw7SLCp5Vav859sAFS6N
No actionable comments were generated in the recent review.
Summary
Summary by CodeRabbit
TypeScript Improvements
Improved type inference for nested routers, including routers loaded lazily or referenced directly.
Router procedure types now provide more consistent inference for contexts, inputs, outputs, and errors.
Router inference types now extract procedure details from ~orpc metadata and recurse through direct router children as well as lazy routers. UnlaziedRouter now recursively maps properties that already extend AnyRouter.
Changes: Recursive Router Types
Layer / File(s)
Summary
Procedure metadata and recursive inference packages/server/src/router.ts
Router inference aliases extract contexts, schemas, and error maps from ~orpc procedure metadata. They now recurse through direct router children as well as lazy routers.
middleapi/orpc#219: Adds UnlaziedRouter; this change extends that alias to map properties that already extend AnyRouter.
Merge Risk: Minimal · up to 6b959
This change makes router type inference cheaper to type-check without altering runtime behavior. No concrete issues were found, and the risk of merging is minimal.
Pre-merge checks: 4
Check name
Status
Explanation
Title check
The title names the main change: router inference types are made cheaper to type-check, under a perf(server) scope. The objectives and summary describe the same change to the Infer Router* types and U…
Description check
The description states the purpose of the change. It lists the six Infer Router types and UnlaziedRouter that now match procedures through ~orpc and check AnyRouter before Lazyable inference. It also …
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Title check
Explanation
The title names the main change: router inference types are made cheaper to type-check, under a perf(server) scope. The objectives and summary describe the same change to the Infer Router* types and UnlaziedRouter, which matches the title's focus on type-check cost.
Full details: Description check
Explanation
The description states the purpose of the change. It lists the six Infer Router types and UnlaziedRouter that now match procedures through ~orpc and check AnyRouter before Lazyable inference. It also reports benchmark results, behavior checks, and verification runs, all of which relate to the changeset.
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
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.
File: No configuration file from this repository applied
Commit: Unavailable
Layers: Repository UI
Review profile: CHILL
Plan: Advanced
Run ID: e0bbdf36-0a18-4c2b-ab2a-2db25e330190
Commits
Reviewing files that changed from the base of the PR and between 5c3b5c0 and 6b959bd.
Files selected for processing: 2
packages/server/src/router-utils.ts
packages/server/src/router.ts
Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 4 remain after this review.
Merging this PR will improve performance by 62.11%
2 warnings
⚠️5 benchmarks are dominated by system calls
System calls cannot be simulated consistently and are left out of the measure. The reported value understates the real cost. Switch to the Walltime instrument to measure them.
⚠️1 benchmark with a significant change ran on different hardware
Its base and head results were measured on machines with a different CPU, core count or memory, so the change might not come from the code. Run base and head on the same runner type.
The reason will be displayed to describe this comment to others. Learn more.
✅ No new issues found.
Reviewed changes
Procedure detection via ~orpc — InferRouterInitialContexts, InferRouterFinalContexts, InferRouterInputs, InferRouterOutputs, InferRouterError and InferRouterErrors now match a procedure through ~orpc: ProcedureDefinition<...> instead of the Procedure class, so a decorated procedure no longer triggers a structural class comparison.
Router-first key check — those six types plus UnlaziedRouter test each key against AnyRouter before falling back to the Lazyable<infer U extends AnyRouter> inference, so the inferring union match only runs for lazy keys.
I compared the old and new definitions directly with a throwaway type probe (bare procedure, nested router, Lazy<procedure>/Lazy<router> keys, Lazyable and union keys, optional and readonly keys, AnyRouter, AugmentedRouter output, any, never) and every one of the seven types resolved identically. The branch order is sound: Lazy<T> is not assignable to AnyRouter or to the ~orpc definition shape, so the fast path cannot shadow lazy unwrapping. Root tsc -p tsconfig.json --noEmit is clean.
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
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.
![pullfrog[bot]](https://avatars.githubusercontent.com/in/1768019?s=60&v=4){kind=small}
Summary
This applies the same two changes as #2452 to the remaining types that walk a router with
Lazyable<infer U>:InferRouterInputs,InferRouterOutputs,InferRouterInitialContexts,InferRouterFinalContexts,InferRouterErrorandInferRouterErrorsmatch a procedure through its~orpcdefinition instead of theProcedureclass.UnlaziedRouter, test each key againstAnyRouterfirst, which has noinfer. TheLazyable<infer U>inference now runs only for keys that are not plain routers.Every type still recurses on itself; there is no new helper type.
Measurements
The base workload is the
typecheckproject of orpc-benchmarks: 500 routers, 3,000 procedures. Each row replaces its client calls with the lookups described.tsc --singleThreaded --extendedDiagnostics, TypeScript 7.0.2. "Before" is the published2.0.0-beta.50, "after" is@orpc/serverbuilt from this branch. These counts are deterministic.InferRouterInputsandInferRouterOutputs, one lookup per procedure eachInferRouterInitialContexts,InferRouterFinalContextsandInferRouterErrors, one lookup per procedure eachunlazyRouter(), then read by a typed client call per procedureInferRouterErrorhas the same shape asInferRouterErrorsand is changed the same way, but I did not build a separate workload for it.This is independent of #2451, #2452 and #2453.
Behavior
No difference from
main. I compared the old and new definitions of all seven types directly on procedures, nested routers, lazy routers and procedures, keys typed asLazyable<...>, optional and readonly keys,os.router()output,AnyRouter,anyandnever: all resolve to identical types.Emitted declarations are unchanged too. A consumer installed from packed tarballs (pnpm, depending only on
@orpc/server) and built withcomposite: true, including generic code that takes a router as a type parameter, emits a.d.tsbyte-identical to the one built againstmain, on TypeScript 7.0.2, 6.0.3 and 5.9.3.Verification
pnpm check,pnpm test(4,585 tests) andpnpm docs:validatepass. The firstpnpm testrun had two failures inpackages/bun(cancel and abort: bun-fetch), which are runtime timing tests this type-only change cannot reach; they passed in three separate re-runs and in a second full run.Generated by Claude Code