perf(standard-server): reduce payload size for batch request/response by dinwwwh · Pull Request #352 · middleapi/orpc

dinwwwh · 2025-04-10T01:40:58Z

Summary by CodeRabbit

Refactor
- Enhanced batch request handling by conditionally including request details, ensuring requests only feature necessary properties.
Tests
- Updated test configurations and expectations to align with the improved handling of request properties.

vercel · 2025-04-10T01:41:01Z

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 10, 2025 1:42am

coderabbitai · 2025-04-10T01:41:04Z

Walkthrough

The changes update the handling of headers and methods in batch request functions and their tests. In the test file, the headers2 variable has been changed from an object with a custom header to an empty object. In the request module, the toBatchRequest function now conditionally assigns headers and method properties—setting headers to undefined when absent and method to undefined when it matches options.method. Additionally, the type assertion has been relaxed to allow partial properties. The parseBatchRequest function has been adjusted to default missing headers to an empty object and to prioritize item values for the method.

Changes

File(s)	Change Summary
packages/standard-server/src/batch/request.test.ts	Modified `headers2` in tests from `{ 'x-custom': 'value' }` to an empty object, affecting header validations in tests.
packages/standard-server/src/batch/request.ts	Updated `toBatchRequest`: Conditionally sets `headers` (to `undefined` if absent) and `method` (to `undefined` if equal to `options.method`); relaxed type assertion to `Partial<StandardRequest>`. Updated `parseBatchRequest`: Defaults missing `headers` to an empty object and sets `method` based on item or request.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant BatchRequest
    participant RequestProcessor as toBatchRequest
    Client->>RequestProcessor: Call toBatchRequest(request, options)
    alt Headers present
      RequestProcessor->>BatchRequest: Set headers value from request
    else Headers missing
      RequestProcessor->>BatchRequest: Set headers = undefined
    end
    alt Method equals options.method
      RequestProcessor->>BatchRequest: Set method = undefined
    else
      RequestProcessor->>BatchRequest: Retain original method
    end
    RequestProcessor-->>Client: Return modified batch request

sequenceDiagram
    participant Client
    participant BatchParser as parseBatchRequest
    participant ParsedRequest
    Client->>BatchParser: Call parseBatchRequest(item, request)
    alt Item has headers
      BatchParser->>ParsedRequest: Use item.headers
    else Item missing headers
      BatchParser->>ParsedRequest: Set headers = {}
    end
    alt Item has method
      BatchParser->>ParsedRequest: Use item.method
    else
      BatchParser->>ParsedRequest: Use request.method
    end
    BatchParser-->>Client: Return parsed request

Poem

I’m a rabbit hopping fast,
Through lines of code that now contrast.
Headers fade like a gentle breeze,
And methods shift with graceful ease.
Happy hops in revised keys! 🐇🌟

📜 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 dcb8714 and 690e059.

📒 Files selected for processing (2)

packages/standard-server/src/batch/request.test.ts (1 hunks)
packages/standard-server/src/batch/request.ts (2 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

packages/standard-server/src/batch/request.ts (1)

packages/standard-server/src/types.ts (1)

StandardRequest (13-24)

🔇 Additional comments (4)

packages/standard-server/src/batch/request.test.ts (1)

18-18: Updated test case aligns with optimization changes

This change from a non-empty headers object to an empty one is intentional and correlates with the performance optimizations in the implementation file. It allows testing the omission of empty headers in batch requests.

packages/standard-server/src/batch/request.ts (3)

18-19: Good optimization to reduce payload size

These changes effectively reduce payload size by:

Omitting empty header objects (line 18)

Removing redundant method information when it matches the parent request (line 19)

Using a more flexible type assertion (line 21)

This approach aligns well with the PR objective of reducing batch request/response payload size.

Also applies to: 21-21

51-51: Properly handles potential undefined method values

Using the nullish coalescing operator ensures that even if the method is omitted in the optimized request (as could happen on line 19), it will default to the parent request's method.

53-53: Correctly handles potentially undefined headers

This change properly handles the case where headers might be undefined due to the optimization in the toBatchRequest function. Using an empty object as the default value maintains backward compatibility.

✨ Finishing Touches

📝 Generate Docstrings

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.

❤️ Share

🪧 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-04-10T01:42:09Z

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

pkg-pr-new · 2025-04-10T01:42:45Z

More templates

@orpc/arktype

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

@orpc/client

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

@orpc/openapi

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

@orpc/contract

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

@orpc/openapi-client

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

@orpc/react

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

@orpc/react-query

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

@orpc/server

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

@orpc/shared

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

@orpc/solid-query

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

@orpc/standard-server

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

@orpc/standard-server-fetch

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

@orpc/standard-server-node

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

@orpc/svelte-query

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

@orpc/valibot

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

@orpc/vue-colada

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

@orpc/vue-query

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

@orpc/zod

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

commit: 690e059

perf(standard-server): reduce payload size for batch request/response

690e059

vercel Bot temporarily deployed to Preview April 10, 2025 01:42 Inactive

dinwwwh merged commit 57d90ad into main Apr 10, 2025
8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

perf(standard-server): reduce payload size for batch request/response#352

perf(standard-server): reduce payload size for batch request/response#352
dinwwwh merged 1 commit into
mainfrom
perf/standard-server/reduce-payload-size-for-batch-requests-responses

dinwwwh commented Apr 10, 2025 •

edited by coderabbitai Bot

Loading

Uh oh!

vercel Bot commented Apr 10, 2025 •

edited

Loading

Uh oh!

coderabbitai Bot commented Apr 10, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

codecov Bot commented Apr 10, 2025

Uh oh!

pkg-pr-new Bot commented Apr 10, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

dinwwwh commented Apr 10, 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 Apr 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Apr 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

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 Apr 10, 2025

Codecov Report

Uh oh!

pkg-pr-new Bot commented Apr 10, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

dinwwwh commented Apr 10, 2025 •

edited by coderabbitai Bot

Loading

vercel Bot commented Apr 10, 2025 •

edited

Loading

coderabbitai Bot commented Apr 10, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)