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 augmented router types cheaper to type-check - #2453
AugmentedRouter and AugmentedRouterWithMiddlewares are the types returned by os.router(), os.use(...).router(), os.lazy() and the implementer's .router(). Two changes make them cheaper:
A procedure is matched through its ~orpc definition instead of the Procedure class. .handler() returns a DecoratedProcedure, a different class, so the class match compared the two classes structurally for every procedure.
Each key is tested against AnyRouter first, which has no infer. The Lazy<infer $> inference now runs only for keys that are not plain routers.
Both types still recurse on themselves; there is no new helper type.
Measurements
The workload is the typecheck project of orpc-benchmarks (3,000 procedures plus a typed client call for each), with routers wrapped as described in each row. 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.
Routers wrapped with
Instantiations
Types
os.router() at the root
1,349,789 → 1,274,217 (−5.6%)
262,932 → 265,928 (+1.1%)
os.router() in each of the 500 router files
1,362,253 → 1,307,191 (−4.0%)
279,425 → 282,421 (+1.1%)
os.use(middleware).router() at the root
1,388,983 → 1,313,411 (−5.4%)
263,503 → 266,499 (+1.1%)
nothing (plain objects, the unmodified benchmark)
1,040,001 → 1,040,001
247,841 → 247,841
The type count rises by one per procedure. For scale: the same project with plain object routers is 1,040,001 instantiations, so os.router() at the root accounts for about 309,800 of them before and 234,200 after (−24%).
No difference from main. I compared the old and new definitions directly on procedures, nested routers, lazy routers and procedures, keys typed as Lazyable<...>, optional and readonly keys, os.router() output, AnyRouter, any and never, with and without an error map: 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 passes a router type parameter to .router(), 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 existing type tests in router-utils.test-d.ts cover a single procedure, a nested router and a lazy router for both types.
AugmentedRouter and AugmentedRouterWithMiddlewares now match a procedure
through its `~orpc` definition instead of the Procedure class, and test
each key against AnyRouter before trying the `Lazy<infer $>` inference,
so only lazy keys pay for it.
Both 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
Refactor
Improved type inference for procedures and nested or lazy routers while preserving existing error-map and context typing behavior. These changes affect internal type handling; no user-facing behavior changes are reported.
The exported router mapping types now identify procedure nodes through ~orpc metadata and infer their schema and context types from ProcedureDefinition. Recursive mappings check router children before lazy children while preserving lazy wrapping and merged types.
Changes: Router Type Mapping
Layer / File(s)
Summary
Procedure and recursive router mapping packages/server/src/router-utils.ts
The exported mappings use ProcedureDefinition metadata for procedure types. They check AnyRouter children before lazy children and retain lazy wrapping and merged error-map and context types.
This is a type-checking performance change to the router types returned by os.router() and related helpers. The supplied context shows no concrete behavioral or compatibility risk, so it looks safe to merge after the normal checks.
Pre-merge checks: 4
Check name
Status
Explanation
Title check
The title names the main change: a performance improvement to the augmented router types in @orpc/server, which the changeset makes by matching procedures through their ~orpc definition and checking A…
Description check
The description covers the two type changes, the motivation (class comparison cost versus definition matching), the benchmark measurements, the behavior and emitted-declaration checks, and the verific…
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: a performance improvement to the augmented router types in @orpc/server, which the changeset makes by matching procedures through their ~orpc definition and checking AnyRouter before lazy inference. The title is specific and accurate, and it stays short and in one sentence.
Full details: Description check
Explanation
The description covers the two type changes, the motivation (class comparison cost versus definition matching), the benchmark measurements, the behavior and emitted-declaration checks, and the verification steps. It relates directly to the router-utils.ts changes.
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: 91f5781e-7ba1-4103-8426-beb5dd0b9e6c
Commits
Reviewing files that changed from the base of the PR and between 5c3b5c0 and 791d354.
Files selected for processing: 1
packages/server/src/router-utils.ts
Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 5 remain after this review.
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.
The reason will be displayed to describe this comment to others. Learn more.
ℹ️ No critical issues — one small suggestion inline, one optional follow-up below.
Reviewed changes
Structural procedure match — AugmentedRouter and AugmentedRouterWithMiddlewares now match a procedure through { '~orpc': ProcedureDefinition<infer ...> } instead of the Procedure class, so DecoratedProcedure (and any other subclass) no longer goes through a class-vs-subclass comparison and no Procedure<infer ...> is instantiated per procedure.
Router-before-lazy key dispatch — in the mapped branch, T[K] extends AnyRouter is tested before T[K] extends Lazy<infer $>, so the inference-bearing Lazy check only runs for keys that are not routers.
I re-ran the equivalence claim independently with a throwaway Equal<Old, New> probe covering plain procedures, AnyProcedure, a bare ProcedureDefinition-shaped object, nested routers, Lazy<router>, optional and readonly keys, Procedure | Lazy<Procedure> unions, Lazyable<...> keys, AnyRouter, an index-signature router, any and never — all identical, for both augmented types. I also reproduced the perf direction on a 300-procedure router (two files identical except for the definition, TS 7.0.2, repo config): 49,677 → 48,726 instantiations, and exactly +1 type per procedure, matching the numbers in the PR body. router-utils/builder/implementer-router tests and oxlint are clean. The probe artifacts were removed, tree is clean.
ℹ️ The same class match is still in the InferRouter* helpers
packages/server/src/router.ts still uses T extends Procedure<infer ...> in InferRouterInitialContexts, InferRouterFinalContexts, InferRouterInputs, InferRouterOutputs, InferRouterError and InferRouterErrors, and each recurses per key on every client inference. The same ~orpc-structural rewrite is presumably applicable there — out of scope for this PR, but a natural follow-up if the class match is a measurable share of those types too (it would need its own measurement, since these helpers do not feed augmentRouter).
Technical details
# Follow-up: apply the structural match to router inference helpers## Affected sites-`packages/server/src/router.ts:41` — `InferRouterInitialContexts`-`packages/server/src/router.ts:58` — `InferRouterFinalContexts`-`packages/server/src/router.ts:75` — `InferRouterInputs`-`packages/server/src/router.ts:92` — `InferRouterOutputs`-`packages/server/src/router.ts:106` — `InferRouterError`-`packages/server/src/router.ts:120` — `InferRouterErrors`## Required outcome- Measure whether replacing `T extends Procedure<infer ...>` with
`T extends { '~orpc': ProcedureDefinition<infer ...> }` in these helpers moves
the client-side inference cost before changing them; they are unaffected by
this PR's benchmark.
- Keep the result type-equal to today's for procedures, nested routers, lazy
routers and `AnyRouter`.
## Suggested approach (optional)- Reuse the same probe shape used for `AugmentedRouter` (`Equal<Old, New>` over
the shapes listed above) to confirm equivalence before landing.
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
AugmentedRouterandAugmentedRouterWithMiddlewaresare the types returned byos.router(),os.use(...).router(),os.lazy()and the implementer's.router(). Two changes make them cheaper:~orpcdefinition instead of theProcedureclass..handler()returns aDecoratedProcedure, a different class, so the class match compared the two classes structurally for every procedure.AnyRouterfirst, which has noinfer. TheLazy<infer $>inference now runs only for keys that are not plain routers.Both types still recurse on themselves; there is no new helper type.
Measurements
The workload is the
typecheckproject of orpc-benchmarks (3,000 procedures plus a typed client call for each), with routers wrapped as described in each row.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.os.router()at the rootos.router()in each of the 500 router filesos.use(middleware).router()at the rootThe type count rises by one per procedure. For scale: the same project with plain object routers is 1,040,001 instantiations, so
os.router()at the root accounts for about 309,800 of them before and 234,200 after (−24%).This is independent of #2451 and #2452.
Behavior
No difference from
main. I compared the old and new definitions directly on procedures, nested routers, lazy routers and procedures, keys typed asLazyable<...>, optional and readonly keys,os.router()output,AnyRouter,anyandnever, with and without an error map: 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 passes a router type parameter to.router(), 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 existing type tests inrouter-utils.test-d.tscover a single procedure, a nested router and a lazy router for both types.Generated by Claude Code