fix(client): set `last-event-id` header when sending by dinwwwh · Pull Request #266 · middleapi/orpc

dinwwwh · 2025-03-19T08:05:17Z

Summary by CodeRabbit

Refactor
- Enhanced the handling of event identifier headers by improving the merging process for new and existing values. This update ensures that event identifiers are combined reliably without unintended modifications.
Tests
- Introduced comprehensive validations to confirm the correct behavior of header merging under various scenarios, further bolstering system reliability.

vercel · 2025-03-19T08:05:21Z

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 19, 2025 8:06am

coderabbitai · 2025-03-19T08:05:25Z

Walkthrough

This change set updates the StandardRPCLinkCodec to handle the last-event-id header more robustly within its encode method. The modifications ensure that headers are constructed immutably by using a spread operator and that the last-event-id is processed dynamically—appending to an array if it already exists or converting a scalar to an array when needed. Additionally, a new test suite validates various scenarios for setting and merging the last-event-id header.

Changes

File(s)	Change Summary
`packages/client/src/adapters/standard/rpc-link-codec.test.ts`	Added a new test suite under `describe('last-event-id', ...)` with three cases validating proper setting and merging of the `last-event-id` header.
`packages/client/src/adapters/standard/rpc-link-codec.ts`	Modified the `encode` method to construct headers immutably and updated the logic to handle `last-event-id` by appending values, converting scalars to arrays, or initializing the header as required.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant E as StandardRPCLinkCodec.encode
    participant H as Headers Object

    C->>E: Invoke encode(options, headers)
    E->>H: Retrieve current headers (immutable copy)
    alt options.lastEventId provided
        H-->>E: Return existing 'last-event-id' value (if any)
        alt Header not set
            E->>H: Set 'last-event-id' = options.lastEventId
        else alt Header is a non-array
            E->>H: Convert existing value to array and append options.lastEventId
        else
            E->>H: Append options.lastEventId to existing array
        end
    end
    E-->>C: Return updated headers

Poem

I'm a little rabbit, hopping in the code,
Merging headers neatly on a joyful road.
With tests that check each twist and turn,
I cheer as clean header logic I learn.
Hoppy bytes and merry lines now shine,
Celebrating changes in a code-rabbit rhyme!

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
- To enable this feature, set early_access to true under in the settings.

📜 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 8900489 and be4625b.

📒 Files selected for processing (2)

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

🧰 Additional context used

🧬 Code Definitions (2)

packages/client/src/adapters/standard/rpc-link-codec.test.ts (1)

packages/client/src/adapters/standard/rpc-link-codec.ts (1) (1)

StandardRPCLinkCodec (60-167)

packages/client/src/adapters/standard/rpc-link-codec.ts (3)

packages/standard-server-fetch/src/response.ts (2) (2)

headers (23-27)

headers (28-30)

packages/standard-server-fetch/src/request.ts (2) (2)

headers (14-18)

headers (19-21)

packages/client/src/adapters/standard/link.ts (1) (1)

path (109-121)

🔇 Additional comments (3)

packages/client/src/adapters/standard/rpc-link-codec.test.ts (1)

101-140: Adding comprehensive test cases for the last-event-id header is great!

These new test cases thoroughly validate the three scenarios for handling the last-event-id header:

Setting the header when it doesn't already exist

Merging with an existing scalar value

Merging with an existing array of values

The tests are well-structured and cover the key functionality implemented in the codec. This ensures that the header is properly managed across different scenarios.

packages/client/src/adapters/standard/rpc-link-codec.ts (2)

80-80: Good use of immutable headers creation.

Using the spread operator to create a new headers object is a good practice as it prevents mutation of the original object and potential side effects.

84-94: Robust implementation of last-event-id header handling.

This implementation correctly handles all three cases:

When last-event-id is an array, it preserves existing values

When last-event-id is a scalar value, it converts to an array with both values

When last-event-id doesn't exist, it sets it as a scalar value

The implementation follows best practices for handling HTTP headers that can have multiple values.

✨ 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 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-19T08:06:31Z

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

pkg-pr-new · 2025-03-19T08:06:41Z

Open in Stackblitz

More templates

@orpc/arktype

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

@orpc/client

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

@orpc/contract

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

@orpc/openapi-client

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

@orpc/react-query

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

@orpc/openapi

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

@orpc/server

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

@orpc/shared

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

@orpc/solid-query

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

@orpc/standard-server

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

@orpc/standard-server-fetch

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

@orpc/standard-server-node

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

@orpc/svelte-query

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

@orpc/valibot

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

@orpc/vue-colada

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

@orpc/vue-query

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

@orpc/zod

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

commit: be4625b

fix(client): set last-event-id header when sending

be4625b

vercel bot temporarily deployed to Preview March 19, 2025 08:06 Inactive

dinwwwh merged commit 232b708 into main Mar 19, 2025
8 checks passed

coderabbitai bot mentioned this pull request Apr 3, 2025

test(client): codec base url #327

Merged

coderabbitai bot mentioned this pull request Aug 29, 2025

feat(client): support fetch headers in link options #946

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(client): set `last-event-id` header when sending#266

fix(client): set `last-event-id` header when sending#266
dinwwwh merged 1 commit intomainfrom
fix/client/missing-last-event-id-when-send

dinwwwh commented Mar 19, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Mar 19, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Mar 19, 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 Mar 19, 2025

Uh oh!

pkg-pr-new bot commented Mar 19, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

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

Uh oh!

Uh oh!

coderabbitai bot commented Mar 19, 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 Mar 19, 2025

Codecov Report

Uh oh!

pkg-pr-new bot commented Mar 19, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

dinwwwh commented Mar 19, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Mar 19, 2025 •

edited

Loading

coderabbitai bot commented Mar 19, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)