refactor: migrate out of static methods

[dinwwwh]

Summary by CodeRabbit

• Refactor
  • Streamlined the mechanism for processing error responses, resulting in more robust and consistent error reporting.
  • Updated error handling logic in various components to utilize new functions for error creation and validation.
• Tests
  • Enhanced test coverage to validate the new error creation and validation logic across key application areas.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
orpc	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 8, 2025 8:05am

[coderabbitai]

Walkthrough

This pull request updates the error handling logic across various modules. The modifications replace the use of static methods on the ORPCError class with two standalone functions, isORPCErrorJson and createORPCErrorFromJson, to validate and create error objects from JSON data. Changes span adapters, serializers, tests, and React hooks, ensuring a consistent and streamlined approach for processing errors from JSON responses.

Changes

File(s)	Change Summary
packages/client/src/adapters/standard/…/rpc-link-codec.ts packages/openapi-client/src/adapters/standard/…/openapi-link-codec.ts	Updated the decode method to replace ORPCError.isValidJSON and ORPCError.fromJSON with isORPCErrorJson and createORPCErrorFromJson. Import statements were adjusted accordingly.
packages/client/src/adapters/standard/…/rpc-serializer.ts packages/openapi-client/src/adapters/standard/…/openapi-serializer.ts	Modified the deserialize method error handling by using the new functions for validation and error creation instead of the deprecated ORPCError methods.
packages/client/src/error.ts	Removed the static fromJSON and isValidJSON methods from the ORPCError class. Added standalone functions isORPCErrorJson and createORPCErrorFromJson to handle JSON error processing.
packages/client/src/error.test.ts	Removed tests for the deprecated methods and introduced new tests to validate the standalone functions ensuring correct error property assignment and cause handling.
packages/react/src/action-form.ts packages/react/src/hooks/action-hooks.ts	Updated the import and error instantiation in React components. The interceptor and hook now create errors using createORPCErrorFromJson in place of ORPCError.fromJSON.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Codec
    Caller->>Codec: Call decode/deserialize with response
    Codec->>Codec: Deserialize response data
    Codec->>isORPCErrorJson: Validate if error JSON?
    alt Error JSON valid
       Codec->>createORPCErrorFromJson: Create ORPC error from JSON
       createORPCErrorFromJson-->>Codec: Return error object
       Codec-->>Caller: Throw error object
    else Not an error
       Codec-->>Caller: Return successful response
    end

Loading

Possibly Related PRs

• unnoq/orpc#246: Involves modifications to error handling logic, specifically replacing the fromJSON and isValidJSON methods with new functions for creating and validating errors in JSON format.
• unnoq/orpc#210: Related to modifications in error handling logic and the introduction of new functions for creating and validating errors, reflected in the updates to the ORPCError class.
• unnoq/orpc#290: Involves modifications to error handling logic, specifically the transition from using ORPCError methods to new functions like createORPCErrorFromJson and isORPCErrorJson.

Poem

I’m a coding rabbit, hopping light and free,
Newly minted functions set the error logic spree.
No more static chains, my carrots now abound,
With isORPCErrorJson and createORPCErrorFromJson around.
I celebrate clean code with a joyful bound! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3907108 and 7c31cbe.

📒 Files selected for processing (1)

• packages/client/src/error.test.ts (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• packages/client/src/error.test.ts

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: publish-commit

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

[pkg-pr-new]

More templates

• @orpc/contract-first-playground
• @orpc/nextjs-playground
• @orpc/nuxt-playground
• @orpc/solid-start-playground
• @orpc/svelte-kit-playground

@orpc/arktype

npm i https://pkg.pr.new/@orpc/arktype@340

@orpc/client

npm i https://pkg.pr.new/@orpc/client@340

@orpc/openapi

npm i https://pkg.pr.new/@orpc/openapi@340

@orpc/contract

npm i https://pkg.pr.new/@orpc/contract@340

@orpc/openapi-client

npm i https://pkg.pr.new/@orpc/openapi-client@340

@orpc/react

npm i https://pkg.pr.new/@orpc/react@340

@orpc/react-query

npm i https://pkg.pr.new/@orpc/react-query@340

@orpc/server

npm i https://pkg.pr.new/@orpc/server@340

@orpc/shared

npm i https://pkg.pr.new/@orpc/shared@340

@orpc/solid-query

npm i https://pkg.pr.new/@orpc/solid-query@340

@orpc/standard-server

npm i https://pkg.pr.new/@orpc/standard-server@340

@orpc/standard-server-fetch

npm i https://pkg.pr.new/@orpc/standard-server-fetch@340

@orpc/standard-server-node

npm i https://pkg.pr.new/@orpc/standard-server-node@340

@orpc/svelte-query

npm i https://pkg.pr.new/@orpc/svelte-query@340

@orpc/valibot

npm i https://pkg.pr.new/@orpc/valibot@340

@orpc/vue-colada

npm i https://pkg.pr.new/@orpc/vue-colada@340

@orpc/vue-query

npm i https://pkg.pr.new/@orpc/vue-query@340

@orpc/zod

npm i https://pkg.pr.new/@orpc/zod@340

commit: 7c31cbe