feat(client)!: improve malformed response errors by dinwwwh · Pull Request #317 · middleapi/orpc

dinwwwh · 2025-03-31T13:31:16Z

Summary by CodeRabbit

Bug Fixes
- Enhanced error reporting to provide more precise, context-aware codes when encountering malformed responses.
Tests
- Updated validations to ensure robust handling of server response errors, confirming the improved error code generation across different status scenarios.
- Added new tests for the getMalformedResponseErrorCode function to verify expected outputs for various input status codes.

vercel · 2025-03-31T13:31:20Z

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	Mar 31, 2025 1:38pm

coderabbitai · 2025-03-31T13:31:24Z

Caution

Review failed

The pull request is closed.

Walkthrough

The changes update error handling logic across multiple modules. Both the RPC and OpenAPI codecs now use the new getMalformedResponseErrorCode function to derive error codes dynamically based on the response status. Test cases have been revised accordingly to verify the new error code behavior and to spy on the function calls. Additionally, a new utility function, along with its tests, has been added to support this dynamic error handling.

Changes

File(s)	Change Summary
`packages/client/.../rpc-link-codec.ts` `packages/client/.../rpc-link-codec.test.ts`	Updated the `decode` method to call `getMalformedResponseErrorCode` instead of using a hardcoded error message. Tests now validate that an `ORPCError` with code `"__MOCKED_CODE__"` is thrown and that the utility function is called once with status 403.
`packages/client/.../utils.ts` `packages/client/.../utils.test.ts`	Added the `getMalformedResponseErrorCode` function to derive error codes from the response status using `COMMON_ORPC_ERROR_DEFS`. New tests verify its output for statuses 400, 401, and 433.
`packages/openapi-client/.../openapi-link-codec.ts` `packages/openapi-client/.../openapi-link-codec.test.ts`	Integrated `getMalformedResponseErrorCode` in the error handling within the `decode` method, with tests updated to expect `"__MOCKED_CODE__"` for status 409 and to spy on the function call.

Sequence Diagram(s)

sequenceDiagram
    participant Codec as Codec Module
    participant Utils as Utils Module
    participant Response as Server Response

    Response->>Codec: Send response with error status
    Codec->>Utils: Call getMalformedResponseErrorCode(status)
    Utils-->>Codec: Return dynamic error code
    Codec->>Codec: Throw ORPCError(dynamic error code, response data)

Possibly related PRs

unnoq/orpc#304: The changes in the main PR are related to those in the retrieved PR as both involve modifications to error handling logic using the isORPCErrorStatus function, specifically in the context of decoding responses and validating error statuses.
unnoq/orpc#246: The changes in the main PR, which involve modifications to the error handling logic and testing of the getMalformedResponseErrorCode function, are directly related to the changes in the retrieved PR, where the same function is utilized in error handling and testing within the OpenAPI context.
unnoq/orpc#182: The changes in the main PR are related to the modifications in error handling and the introduction of the getMalformedResponseErrorCode function, which aligns with the updates in the retrieved PR that also involve dynamic error handling and the use of similar error codes.

Poem

I'm a rabbit with a cheerful hop,
Hopping through errors, I never stop.
Dynamic codes now lead the way,
Spies and tests join in the fray.
With whiskers twitching, I celebrate today! 🐰

📜 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 5f80957 and d71c6f5.

📒 Files selected for processing (2)

packages/client/src/adapters/standard/rpc-link-codec.test.ts (2 hunks)
packages/openapi-client/src/adapters/standard/openapi-link-codec.test.ts (4 hunks)

✨ Finishing Touches

📝 Generate Docstrings

🪧 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 · 2025-03-31T13:32:25Z

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

pkg-pr-new · 2025-03-31T13:32:54Z

Open in Stackblitz

More templates

@orpc/arktype

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

@orpc/client

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

@orpc/openapi

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

@orpc/openapi-client

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

@orpc/contract

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

@orpc/react

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

@orpc/react-query

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

@orpc/server

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

@orpc/shared

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

@orpc/solid-query

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

@orpc/standard-server

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

@orpc/standard-server-fetch

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

@orpc/standard-server-node

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

@orpc/svelte-query

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

@orpc/valibot

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

@orpc/vue-colada

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

@orpc/vue-query

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

@orpc/zod

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

commit: d71c6f5

feat(client)!: improve malformed response errors

5f80957

vercel bot temporarily deployed to Preview March 31, 2025 13:33 Inactive

tests

d71c6f5

vercel bot temporarily deployed to Preview March 31, 2025 13:38 Inactive

dinwwwh merged commit 48a5661 into main Mar 31, 2025
7 of 8 checks passed

This was referenced Apr 8, 2025

refactor: isORPCErrorStatus -> ORPCError.isValidStatus #339

Closed

refactor: migrate out of static methods #340

Merged

feat(client)!: include entire response in malformed response error data #341

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(client)!: improve malformed response errors#317

feat(client)!: improve malformed response errors#317
dinwwwh merged 2 commits intomainfrom
feat/client/improve-malformed-errors

dinwwwh commented Mar 31, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Mar 31, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Mar 31, 2025 •

edited

Loading

Review failed

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

codecov bot commented Mar 31, 2025

Uh oh!

pkg-pr-new bot commented Mar 31, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

dinwwwh commented Mar 31, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

vercel bot commented Mar 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Mar 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codecov bot commented Mar 31, 2025

Codecov Report

Uh oh!

pkg-pr-new bot commented Mar 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

dinwwwh commented Mar 31, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Mar 31, 2025 •

edited

Loading

coderabbitai bot commented Mar 31, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

pkg-pr-new bot commented Mar 31, 2025 •

edited

Loading