feat(trpc): restructure ORPCMeta + accessible lazy router #758
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
dosubot
bot
added
the
size:M
WalkthroughThe changes update the handling and structure of metadata for tRPC procedures being converted to oRPC procedures. The Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant tRPC Procedure
participant toORPCProcedure
participant oRPC Procedure
Developer->>tRPC Procedure: Define procedure with .meta({ route: { ... } })
tRPC Procedure->>toORPCProcedure: Pass procedure for conversion
toORPCProcedure->>toORPCProcedure: Use get(meta, ['route']) to extract route
toORPCProcedure->>oRPC Procedure: Create oRPC procedure with route metadata
Possibly related PRs
Suggested labels
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @unnoq, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces a breaking change by restructuring the ORPCMeta interface within the tRPC integration. The primary goal is to improve the organization of metadata by nesting route-related information under a dedicated route property. This change necessitates updates to how route metadata is defined in tRPC procedures and how it's accessed internally, with corresponding documentation and test updates to ensure compatibility and correct error handling.
Highlights
- ORPCMeta Restructuring: The
experimental_ORPCMetainterface has been refactored to nest route-specific metadata under arouteproperty, improving the overall organization of metadata for tRPC procedures. - Metadata Access Update: The internal logic responsible for extracting route metadata from tRPC procedures has been updated to correctly access the newly nested
routeproperty within theORPCMetastructure. - Documentation & Test Alignment: Existing documentation and test cases have been updated to reflect the new
ORPCMetastructure, ensuring consistency and providing clear examples for proper usage. - Error Handling Enhancement: A new test case has been added to verify robust error handling for input validation failures, specifically ensuring that
ORPCErrorinstances correctly wrap underlyingTRPCErrorandZodErrorinstances.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Code Review
This pull request refactors ORPCMeta to nest route-specific information under a route property, which is a breaking change. The changes are consistently applied across documentation, tests, and implementation. The get utility is also improved for better type safety.
My review identifies one high-severity issue regarding type safety in to-orpc-router.ts where a value of type unknown is assigned to a property expecting an object, which could lead to runtime errors. I've provided a suggestion to fix this using a type guard.
More templates
@orpc/arktype
@orpc/client
@orpc/contract
@orpc/experimental-durable-event-iterator
@orpc/hey-api
@orpc/json-schema
@orpc/nest
@orpc/openapi
@orpc/openapi-client
@orpc/react
@orpc/react-query
@orpc/server
@orpc/shared
@orpc/solid-query
@orpc/standard-server
@orpc/standard-server-aws-lambda
@orpc/standard-server-fetch
@orpc/standard-server-node
@orpc/standard-server-peer
@orpc/svelte-query
@orpc/tanstack-query
@orpc/trpc
@orpc/valibot
@orpc/vue-colada
@orpc/vue-query
@orpc/zod
commit: |
unnoq
changed the title
unnoq
changed the title
1 participant
Summary by CodeRabbit
Documentation
.metaproperty with route metadata in tRPC procedures for OpenAPI integration.Bug Fixes
routekey, improving consistency and clarity.Tests