You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by "aIbrahiim (via GitHub)" <gi...@apache.org> on 2026/05/21 10:42:47 UTC
[PR] Fix Fn API data plane deadlock when outbound queue is full [beam]
aIbrahiim opened a new pull request, #38581:
URL: https://github.com/apache/beam/pull/38581
**Please** add a meaningful description for your change here
------------------------
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
- [ ] Mention the appropriate issue in your description (for example: `addresses #123`), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment `fixes #<ISSUE NUMBER>` instead.
- [ ] Update `CHANGES.md` with noteworthy changes.
- [ ] If this contribution is large, please file an Apache [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://github.com/apache/beam/blob/master/CONTRIBUTING.md#make-the-reviewers-job-easier).
To check the build health, please visit [https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md](https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md)
GitHub Actions Tests Status (on master branch)
------------------------------------------------------------------------------------------------
[](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Go+tests%22+branch%3Amaster+event%3Aschedule)
See [CI.md](https://github.com/apache/beam/blob/master/CI.md) for more information about GitHub Actions CI or the [workflows README](https://github.com/apache/beam/blob/master/.github/workflows/README.md) to see a list of phrases to trigger workflows.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix Fn API data plane deadlock when outbound queue is full [beam]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #38581:
URL: https://github.com/apache/beam/pull/38581#issuecomment-4513228736
Assigning reviewers:
R: @jrmccluskey for label python.
Note: If you would like to opt out of this review, comment `assign to next reviewer`.
Available commands:
- `stop reviewer notifications` - opt out of the automated review tooling
- `remind me after tests pass` - tag the comment author after tests pass
- `waiting on author` - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)
The PR bot will only process comments in the main thread (not review comments).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix Fn API data plane deadlock when outbound queue is full [beam]
Posted by "gemini-code-assist[bot] (via GitHub)" <gi...@apache.org>.
gemini-code-assist[bot] commented on code in PR #38581:
URL: https://github.com/apache/beam/pull/38581#discussion_r3282916770
##########
sdks/python/apache_beam/runners/worker/data_plane.py:
##########
@@ -478,9 +491,38 @@ def __init__(self, data_buffer_time_limit_ms=0):
def close(self):
# type: () -> None
- self._to_send.put(self._WRITES_FINISHED, 0)
+ self._enqueue_to_send(self._WRITES_FINISHED)
+ if self._send_forwarder is not None:
+ self._send_forwarder.join()
self._closed = True
+ def _start_send_forwarder(self):
+ # type: () -> None
+ forwarder = threading.Thread(
+ target=self._forward_pending_to_send,
+ name='forward_grpc_outputs')
+ forwarder.daemon = True
+ forwarder.start()
+ self._send_forwarder = forwarder
+
+ def _enqueue_to_send(self, elem):
+ # type: (DataOrTimers) -> None
+ self._pending_send.put(elem, self._get_element_size_bytes(elem))
+
+ def _forward_pending_to_send(self):
+ # type: () -> None
+ try:
+ while True:
+ elem = self._pending_send.get()
+ self._to_send.put(elem, self._get_element_size_bytes(elem))
+ if elem is self._WRITES_FINISHED:
+ return
+ except Exception as e:
+ if not self._closed:
+ _LOGGER.exception('Failed to forward outputs in the data plane.')
+ self._exception = e
+ raise
Review Comment:

The `_forward_pending_to_send` method re-calculates the size of each element using `self._get_element_size_bytes(elem)`. Since `_enqueue_to_send` already calculates this size to put it into the `_pending_send` queue, this is redundant work. For large elements, this could be a performance bottleneck. Consider passing a tuple of `(element, size)` through the `_pending_send` queue to avoid re-calculation.
```suggestion
def _forward_pending_to_send(self):
# type: () -> None
try:
while True:
elem, size = self._pending_send.get()
self._to_send.put(elem, size)
if elem is self._WRITES_FINISHED:
return
except Exception as e:
if not self._closed:
_LOGGER.exception('Failed to forward outputs in the data plane.')
self._exception = e
raise
```
##########
sdks/python/apache_beam/runners/worker/data_plane.py:
##########
@@ -478,9 +491,38 @@ def __init__(self, data_buffer_time_limit_ms=0):
def close(self):
# type: () -> None
- self._to_send.put(self._WRITES_FINISHED, 0)
+ self._enqueue_to_send(self._WRITES_FINISHED)
+ if self._send_forwarder is not None:
+ self._send_forwarder.join()
self._closed = True
Review Comment:

The `close` method joins the `_send_forwarder` thread but does not check if that thread encountered an exception (stored in `self._exception`). If the forwarder thread fails, data might not be fully sent, and the caller should be notified. It is recommended to check and re-raise `self._exception` after the join.
```suggestion
def close(self):
# type: () -> None
self._enqueue_to_send(self._WRITES_FINISHED)
if self._send_forwarder is not None:
self._send_forwarder.join()
if self._exception:
raise self._exception
self._closed = True
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix Fn API data plane deadlock when outbound queue is full [beam]
Posted by "jrmccluskey (via GitHub)" <gi...@apache.org>.
jrmccluskey merged PR #38581:
URL: https://github.com/apache/beam/pull/38581
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix Fn API data plane deadlock when outbound queue is full [beam]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #38581:
URL: https://github.com/apache/beam/pull/38581#issuecomment-4510607616
Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment `assign set of reviewers`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix Fn API data plane deadlock when outbound queue is full [beam]
Posted by "gemini-code-assist[bot] (via GitHub)" <gi...@apache.org>.
gemini-code-assist[bot] commented on PR #38581:
URL: https://github.com/apache/beam/pull/38581#issuecomment-4510525726
## Summary of Changes
Hello, I'm Gemini Code Assist[^1]! 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 potential deadlock in the Fn API data plane that occurs when the outbound gRPC queue becomes saturated. By introducing an asynchronous staging queue and a dedicated forwarder thread, the system can continue reading inputs even when the primary send buffer is blocked, significantly improving the robustness of the data plane under high load.
### Highlights
* **Deadlock Prevention**: Introduced a staging queue (`_pending_send`) and a dedicated forwarder thread to decouple input reading from the outbound gRPC send buffer, preventing deadlocks when the queue is full.
* **Configuration Constants**: Added new default constants for send/receive queue sizes and byte limits to improve data plane flow control.
* **Refactored Enqueue Logic**: Centralized queueing logic through `_enqueue_to_send` to ensure all data and timer elements pass through the new staging mechanism.
<details>
<summary><b>New Features</b></summary>
🧠You can now enable **Memory** (public preview) to help **Gemini Code Assist** learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. **Click [here](https://codeassist.google/code-review/login) to enable Memory in your admin console.**
</details>
<details>
<summary><b>Using Gemini Code Assist</b></summary>
<br>
The full guide for Gemini Code Assist can be found on our [documentation page](https://developers.google.com/gemini-code-assist/docs/review-github-code), here are some quick tips.
<b>Invoking Gemini</b>
You can request assistance from Gemini at any point by creating a comment using either `/gemini <command>` or `@gemini-code-assist <command>`. Below is a summary of the supported commands on the current page.
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 pull request comments and review comments.
Help | `/gemini help` | Displays a list of available commands.
<b>Customization</b>
To customize the 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](https://developers.google.com/gemini-code-assist/docs/customize-gemini-behavior-github).
<b>Limitations & Feedback</b>
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up [here](https://google.qualtrics.com/jfe/form/SV_2cyuGuTWsEw84yG).
</details>
[^1]: Review the [Privacy Notices](https://policies.google.com/privacy), [Generative AI Prohibited Use Policy](https://policies.google.com/terms/generative-ai/use-policy), [Terms of Service](https://policies.google.com/terms), and learn how to configure Gemini Code Assist in GitHub [here](https://developers.google.com/gemini-code-assist/docs/customize-gemini-behavior-github). Gemini can make mistakes, so double check it and [use code with caution](https://support.google.com/legal/answer/13505487).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix Fn API data plane deadlock when outbound queue is full [beam]
Posted by "aIbrahiim (via GitHub)" <gi...@apache.org>.
aIbrahiim commented on PR #38581:
URL: https://github.com/apache/beam/pull/38581#issuecomment-4513222253
assign set of reviewers
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org