fix(contract): eventIterator should cleanup on validation failure - #715
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThis update introduces new test cases to verify proper cleanup and cancellation behavior in async iterators when errors or validation failures occur. It also modifies the internal cleanup logic of the Changes
Sequence Diagram(s)sequenceDiagram
participant Test as Test Suite
participant MapIter as mapEventIterator
participant Gen as Async Generator
Test->>MapIter: Start mapped iteration
MapIter->>Gen: next()
Gen-->>MapIter: value1
MapIter-->>Test: mapped value1
MapIter->>Gen: next()
Gen-->>MapIter: value2
MapIter-->>Test: throw error
Note over MapIter,Gen: Cleanup triggered
MapIter->>Gen: return()
Gen-->>MapIter: (finally block runs)
Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (3)
🧰 Additional context used🧬 Code Graph Analysis (2)packages/contract/src/event-iterator.test.ts (1)
packages/client/src/event-iterator.test.ts (1)
⏰ Context from checks skipped due to timeout of 90000ms (2)
🔇 Additional comments (3)
✨ 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 (
|
dosubot
Bot
added
the
size:M
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
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!
This pull request addresses a critical resource management issue within the eventIterator and mapEventIterator utilities. It ensures that underlying iterators are reliably closed and cleaned up whenever an error, such as a data validation failure, interrupts the iteration process. This enhancement improves the stability and resource handling of these core components, preventing potential leaks and ensuring predictable behavior.
Highlights
- Bug Fix: Iterator Cleanup: This pull request fixes a bug where
eventIteratorandmapEventIteratordid not consistently clean up their underlying iterators when an error, such as a data validation failure, occurred during iteration. This could lead to resource leaks or unexpected behavior. - Improved Error Handling: The
mapEventIteratorfunction inpackages/client/src/event-iterator.tshas been updated to ensure that the original iterator'sreturn()method is always called when an error is thrown, simplifying the cleanup logic and making it more robust. - New Test Cases: New test cases have been added in both
packages/client/src/event-iterator.test.tsandpackages/contract/src/event-iterator.test.tsto specifically verify that iterators are properly cleaned up when errors (including validation errors) occur during the mapping or validation process.
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. ↩
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Code Review
This pull request introduces a test case to verify that the underlying event iterator is cleaned up upon a validation failure. The change ensures that the cleanup function is always called, addressing the issue effectively. The added test in the contract package provides coverage for the fix.
More templates
@orpc/arktype
@orpc/client
@orpc/contract
@orpc/experimental-durable-event-iterator
@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/trpc
@orpc/valibot
@orpc/vue-colada
@orpc/vue-query
@orpc/zod
commit: |
1 participant
Summary by CodeRabbit
Bug Fixes
Tests