fix(standard-server): batch signal

[dinwwwh]

Summary by CodeRabbit

• Bug Fixes

  • Improved cancellation handling to gracefully manage empty or undefined input scenarios, preventing potential errors.

• Refactor

  • Streamlined the internal logic for managing cancellation events, resulting in more robust and predictable behavior.

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

[coderabbitai]

Walkthrough

The changes update the behavior of the toBatchAbortSignal function and its corresponding tests. The function now returns undefined if the input array is empty or contains undefined, and utilizes a helper function (abortIfAllInputsAborted) to manage abort events. The tests have been enhanced to account for potential undefined results using optional chaining when checking the aborted property. These modifications adjust the control flow and improve the robustness of both the function and its tests.

Changes

Files	Change Summary
packages/standard-server/src/batch/signal.ts	Updated toBatchAbortSignal to return `AbortSignal
packages/standard-server/src/batch/signal.test.ts	Introduced a new test case to verify that toBatchAbortSignal returns undefined when input array is empty or contains undefined; modified existing assertions to use optional chaining (?.) for safely accessing the aborted property of the potential undefined result.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Caller
    participant Function as toBatchAbortSignal
    participant Controller as AbortController
    participant Helper as abortIfAllInputsAborted

    Caller->>Function: call toBatchAbortSignal(signals)
    alt Signals array empty or mismatch
        Function-->>Caller: return undefined
    else Valid signals provided
        Function->>Controller: Instantiate AbortController
        Function->>Helper: Monitor each signal's abort event
        Helper-->>Function: Notify if all inputs aborted
        Function->>Controller: Execute controller.abort()
        Function-->>Caller: Return controller.signal
    end

Loading

Poem

I'm just a little rabbit, hopping with delight,
New tests and functions shining bright at night.
With early exits and helpers so neat,
My code garden's blooming, oh how sweet!
🐰 CodeRabbit cheers with every byte!
Hop on, let's celebrate the update in flight!

---

📜 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 57d90ad and e3ef3c6.

📒 Files selected for processing (2)

• packages/standard-server/src/batch/signal.test.ts (3 hunks)
• packages/standard-server/src/batch/signal.ts (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

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

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

• toBatchAbortSignal (1-28)

🔇 Additional comments (9)

packages/standard-server/src/batch/signal.test.ts (4)

4-9: Good addition of test cases for edge conditions

These test cases provide good coverage for the updated behavior of toBatchAbortSignal when dealing with empty arrays or arrays containing undefined values. This ensures the function handles edge cases appropriately.

---

15-15: Appropriate use of optional chaining

The optional chaining (?.) is a good defensive programming practice that prevents runtime errors when the function returns undefined.

---

27-28: Proper handling of potentially undefined values

The code correctly expects the batch signal to potentially be undefined and uses optional chaining to safely access its properties.

---

44-44: Consistent application of optional chaining throughout the test suite

Good job applying the optional chaining pattern consistently across all test cases that interact with the batch signal.

Also applies to: 47-47, 50-50, 54-54

packages/standard-server/src/batch/signal.ts (5)

1-1: Improved function signature with explicit undefined return type

The updated function signature now correctly reflects that the function can return undefined in certain cases, making the API contract more explicit.

---

4-6: Enhanced robustness with early termination for invalid inputs

The new condition improves the function by explicitly handling two edge cases:

1. Empty arrays after filtering out undefined values
2. Arrays where some elements are undefined

This early return pattern is clean and makes the function more robust.

---

10-14: Good refactoring with helper function

The abortIfAllInputsAborted helper function encapsulates the abort logic in a clean way. This improves readability and reduces code duplication since this logic is used both for the initial check and in the event listener.

---

16-17: Immediate check for already aborted signals

This initial call to the helper function ensures that the batch signal is properly initialized as aborted if all input signals are already aborted, maintaining the expected behavior.

---

18-25: Simplified event listener logic

The event listener now calls the helper function when a signal is aborted, which is cleaner than maintaining a separate array of aborted signals and checking its length.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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@353

@orpc/client

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

@orpc/contract

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

@orpc/openapi

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

@orpc/openapi-client

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

@orpc/react

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

@orpc/react-query

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

@orpc/shared

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

@orpc/server

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

@orpc/solid-query

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

@orpc/standard-server

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

@orpc/standard-server-fetch

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

@orpc/standard-server-node

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

@orpc/svelte-query

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

@orpc/valibot

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

@orpc/vue-colada

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

@orpc/vue-query

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

@orpc/zod

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

commit: e3ef3c6