You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by "stankiewicz (via GitHub)" <gi...@apache.org> on 2026/03/24 14:17:44 UTC
[PR] Add outstanding parameters to processElement and onTimer signatures [beam]
stankiewicz opened a new pull request, #37933:
URL: https://github.com/apache/beam/pull/37933
Add outstanding recordId, recordOffset and fireTimestamp as they were missing in reflection module.
------------------------
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] Add outstanding parameters to processElement and onTimer signatures [beam]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #37933:
URL: https://github.com/apache/beam/pull/37933#issuecomment-4119684429
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] Add outstanding parameters to processElement and onTimer signatures [beam]
Posted by "codecov[bot] (via GitHub)" <gi...@apache.org>.
codecov[bot] commented on PR #37933:
URL: https://github.com/apache/beam/pull/37933#issuecomment-4121619863
## [Codecov](https://app.codecov.io/gh/apache/beam/pull/37933?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
:white_check_mark: All modified and coverable lines are covered by tests.
:white_check_mark: Project coverage is 54.75%. Comparing base ([`0afbdf6`](https://app.codecov.io/gh/apache/beam/commit/0afbdf684fb8b3407b01e829df6d525f648322e1?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)) to head ([`88a82a6`](https://app.codecov.io/gh/apache/beam/commit/88a82a610151f66c3d09f12c7ee823cfb539d6ec?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)).
:warning: Report is 18 commits behind head on master.
<details><summary>Additional details and impacted files</summary>
```diff
@@ Coverage Diff @@
## master #37933 +/- ##
=========================================
Coverage 54.75% 54.75%
Complexity 1690 1690
=========================================
Files 1063 1063
Lines 166898 166898
Branches 1226 1226
=========================================
Hits 91377 91377
Misses 73328 73328
Partials 2193 2193
```
</details>
[:umbrella: View full report in Codecov by Sentry](https://app.codecov.io/gh/apache/beam/pull/37933?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
:loudspeaker: Have feedback on the report? [Share it here](https://about.codecov.io/codecov-pr-comment-feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
<details><summary> :rocket: New features to boost your workflow: </summary>
- :snowflake: [Test Analytics](https://docs.codecov.com/docs/test-analytics): Detect flaky tests, report on failures, and find test suite problems.
- :package: [JS Bundle Analysis](https://docs.codecov.com/docs/javascript-bundle-analysis): Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
</details>
--
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] Add outstanding parameters to processElement and onTimer signatures [beam]
Posted by "stankiewicz (via GitHub)" <gi...@apache.org>.
stankiewicz commented on PR #37933:
URL: https://github.com/apache/beam/pull/37933#issuecomment-4250581126
> Is fire timestamp for looking at when a timer was set to fire, even when it has an output timestamp that is different? (sorry if I just missed that one)
Kenn, I didn't have much thought about meaning of it, the goal was to fill the gap between OnTimerContext:
https://github.com/stankiewicz/beam/blob/a05482e92d977a0ea6b8dd39f681f1a58d4c87e8/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFn.java#L348-L351
and allowing to refer to same via signature. fire timestamp is scheduled time and is different from output timestamp.
--
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] Add outstanding parameters to processElement and onTimer signatures [beam]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #37933:
URL: https://github.com/apache/beam/pull/37933#issuecomment-4343799151
Reminder, please take a look at this pr: @kennknowles
--
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] Add outstanding parameters to processElement and onTimer signatures [beam]
Posted by "stankiewicz (via GitHub)" <gi...@apache.org>.
stankiewicz merged PR #37933:
URL: https://github.com/apache/beam/pull/37933
--
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] Add outstanding parameters to processElement and onTimer signatures [beam]
Posted by "stankiewicz (via GitHub)" <gi...@apache.org>.
stankiewicz commented on PR #37933:
URL: https://github.com/apache/beam/pull/37933#issuecomment-4120993153
Run Java PreCommit
--
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] Add outstanding parameters to processElement and onTimer signatures [beam]
Posted by "stankiewicz (via GitHub)" <gi...@apache.org>.
stankiewicz commented on PR #37933:
URL: https://github.com/apache/beam/pull/37933#issuecomment-4289349338
/gemini review
--
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] Add outstanding parameters to processElement and onTimer signatures [beam]
Posted by "kennknowles (via GitHub)" <gi...@apache.org>.
kennknowles commented on PR #37933:
URL: https://github.com/apache/beam/pull/37933#issuecomment-4178595209
Is fire timestamp for looking at when a timer was set to fire, even when it has an output timestamp that is different? (sorry if I just missed that one)
--
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] Add outstanding parameters to processElement and onTimer signatures [beam]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #37933:
URL: https://github.com/apache/beam/pull/37933#issuecomment-4177549295
Reminder, please take a look at this pr: @kennknowles
--
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] Add outstanding parameters to processElement and onTimer signatures [beam]
Posted by "stankiewicz (via GitHub)" <gi...@apache.org>.
stankiewicz commented on PR #37933:
URL: https://github.com/apache/beam/pull/37933#issuecomment-4120994799
Run Java_PVR_Prism_Loopback PreCommit
--
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] Add outstanding parameters to processElement and onTimer signatures [beam]
Posted by "gemini-code-assist[bot] (via GitHub)" <gi...@apache.org>.
gemini-code-assist[bot] commented on PR #37933:
URL: https://github.com/apache/beam/pull/37933#issuecomment-4118682133
## 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 enhances the Apache Beam SDK by adding new parameters to the signatures of `processElement` and `onTimer` methods in `DoFn`. These additions include `recordId`, `recordOffset`, and `fireTimestamp`, which provide more context and control within the data processing pipeline. The changes also introduce new annotations to facilitate the use of these parameters and ensure they are accessed correctly within the appropriate method contexts.
### Highlights
* **New Parameters**: Added recordId, recordOffset, and fireTimestamp parameters to processElement and onTimer signatures, enhancing the flexibility of DoFn methods.
* **Annotations**: Introduced new annotations (@CurrentRecordId, @CurrentRecordOffset, @FireTimestamp) to tag parameters in DoFn methods.
* **Exception Handling**: Implemented specific UnsupportedOperationException messages to prevent incorrect access to recordId, recordOffset, and fireTimestamp outside their intended contexts.
🧠**New Feature in Public Preview:** You can now enable **Memory** 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>
<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 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 counter productive. 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] Add outstanding parameters to processElement and onTimer signatures [beam]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #37933:
URL: https://github.com/apache/beam/pull/37933#issuecomment-4121618584
Assigning reviewers:
R: @kennknowles for label java.
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] Add outstanding parameters to processElement and onTimer signatures [beam]
Posted by "gemini-code-assist[bot] (via GitHub)" <gi...@apache.org>.
gemini-code-assist[bot] commented on code in PR #37933:
URL: https://github.com/apache/beam/pull/37933#discussion_r3118191177
##########
sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFn.java:
##########
@@ -700,6 +704,12 @@ public interface MultiOutputReceiver {
* <li>If one of its arguments is tagged with the {@link Element} annotation, then it will be
* passed the current element being processed. The argument type must match the input type
* of this DoFn exactly, or both types must have equivalent schemas registered.
+ * <li>If one of its arguments is tagged with the {@link RecordId} annotation, then it will be
Review Comment:
The Javadoc refers to `RecordId`, but the annotation defined in this PR is named `CurrentRecordId`. This mismatch will cause broken Javadoc links and confusion for users attempting to use the new parameter.
```suggestion
* <li>If one of its arguments is tagged with the {@link CurrentRecordId} annotation, then it will be
```
##########
sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFn.java:
##########
@@ -608,8 +610,10 @@ public interface MultiOutputReceiver {
*
* <p>The method annotated with {@code @OnTimerFamily} may have parameters according to the same
* logic as {@link ProcessElement}, but limited to the {@link BoundedWindow}, {@link State}
- * subclasses, and {@link org.apache.beam.sdk.state.TimerMap}. State and timer parameters must be
- * annotated with their {@link StateId} and {@link TimerId} respectively.
+ * subclasses, {@link org.apache.beam.sdk.state.TimerMap}, {@link Timestamp}, {@link Key}, {@link
Review Comment:
The Javadoc for `@OnTimerFamily` is missing `{@link FireTimestamp}` in the list of supported parameters. Since it is included in the reflection logic for allowed parameters in `DoFnSignatures`, it should be documented here for consistency with the `@OnTimer` documentation.
```suggestion
* subclasses, {@link org.apache.beam.sdk.state.TimerMap}, {@link FireTimestamp}, {@link Timestamp}, {@link Key}, {@link
```
##########
sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFn.java:
##########
@@ -700,6 +704,12 @@ public interface MultiOutputReceiver {
* <li>If one of its arguments is tagged with the {@link Element} annotation, then it will be
* passed the current element being processed. The argument type must match the input type
* of this DoFn exactly, or both types must have equivalent schemas registered.
+ * <li>If one of its arguments is tagged with the {@link RecordId} annotation, then it will be
+ * passed the record id of the current element being processed; the argument must be of type
+ * {@link String}.
+ * <li>If one of its arguments is tagged with the {@link RecordOffset} annotation, then it will
Review Comment:
The Javadoc refers to `RecordOffset`, but the annotation defined in this PR is named `CurrentRecordOffset`. Please update the Javadoc to match the actual annotation name.
```suggestion
* <li>If one of its arguments is tagged with the {@link CurrentRecordOffset} annotation, then it will
```
--
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