fix: EventPublisher should throw immediately if signal is aborted#629
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe changes introduce an immediate check for an already-aborted signal in the event publisher's subscription logic. The corresponding test is updated to verify that the subscription method throws synchronously when the abort signal is already triggered, instead of failing during asynchronous iteration. Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
⏰ Context from checks skipped due to timeout of 90000ms (2)
🔇 Additional comments (2)
✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @unnoq, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
Hello! Gemini here, providing a summary of this pull request. This PR addresses a bug in the EventPublisher class where providing an already-aborted AbortSignal to the subscribe method did not cause an immediate error. Instead, the error would only be thrown when the consumer attempted to iterate over the events. This change modifies the subscribe method to check the signal's state at the very beginning and throw immediately if it is already aborted, aligning the behavior with common expectations for AbortSignal. A corresponding test case has been updated to verify this corrected behavior.
Highlights
- Bug Fix: Fixes an issue in
EventPublisher.subscribewhere an already-abortedAbortSignaldid not cause an immediate error. - Behavior Change: The
subscribemethod now checks the providedAbortSignalupon invocation and throws immediately if it is already aborted. - Test Update: Updates the relevant test case to assert that
subscribethrows synchronously when given an aborted signal.
Changelog
- packages/shared/src/event-publisher.test.ts
- Renamed test case from 'throw right away if signal aborted' to 'throw immediately if signal aborted'.
- Modified test logic to assert that
pub.subscribethrows immediately when provided an aborted signal, rather than asserting the throw during iteration.
- packages/shared/src/event-publisher.ts
- Added
signal?.throwIfAborted()call at the beginning of thesubscribemethod to ensure an error is thrown immediately if the signal is already aborted.
- Added
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request effectively addresses the behavior of EventPublisher when subscribing with an already aborted signal. The change to throw an error immediately in such cases is a good improvement for robustness and developer experience. The corresponding test case has been updated appropriately to verify this new behavior. The code is clean and the fix is well-targeted. Great job!
Summary of Findings
- Unused variable in test: In
packages/shared/src/event-publisher.test.ts, the test'throw immediately if signal aborted'declares apayloadsvariable that is no longer used after the test logic was updated. This is a minor code cleanliness issue. (Severity: low - not commented inline due to review settings).
Merge Readiness
The changes look good and address the intended issue effectively. The code quality is high, and the test coverage for the fix is appropriate. I believe this pull request is ready for merging. As always, ensure any CI checks pass and consider if further reviews are required by your team's policy. I am not authorized to approve the pull request.
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
More templates
@orpc/arktype
@orpc/client
@orpc/contract
@orpc/hey-api
@orpc/nest
@orpc/openapi
@orpc/openapi-client
@orpc/react
@orpc/react-query
@orpc/server
@orpc/shared
@orpc/solid-query
@orpc/standard-server
@orpc/standard-server-aws-lambda
@orpc/standard-server-fetch
@orpc/standard-server-node
@orpc/standard-server-peer
@orpc/svelte-query
@orpc/tanstack-query
@orpc/valibot
@orpc/vue-colada
@orpc/vue-query
@orpc/zod
commit: |
1 participant
Summary by CodeRabbit
Bug Fixes
Tests