WIP Add custom window support in Go SDK#38288
WIP Add custom window support in Go SDK#38288hnnsgstfssn wants to merge 1 commit intoapache:masterfrom
Conversation
Implement custom WindowFn registration for the Go SDK, reaching capability parity with Java/Python AssignContext. Custom WindowFns are plain structs registered via RegisterWindowFn and validated structurally at registration time, matching the DoFn pattern used elsewhere in the SDK. Two AssignWindows shapes are accepted: AssignWindows(typex.EventTime) []typex.Window AssignWindows(typex.EventTime, T) []typex.Window The second form is element-aware: the element value drives which window(s) it lands in. Validation happens via reflection at registration, so misuse fails at pipeline construction rather than at runtime. A package-level registry records the struct type and optional element type for cross-package lookup via LookupWindowFnMeta. An interface-based shape (WindowAssigner) was explored first. Structural typing was chosen instead because it keeps custom WindowFns consistent with DoFns, avoids forcing users to satisfy a Go-specific interface, and lets the same registry carry the element-type metadata that the dispatch and translation paths need. WindowFnInvoker dispatches in three tiers: typed interface (zero alloc), element-aware typed interface (zero alloc), and reflect.Value.Method.Call as a fallback (2 allocs/element). Serialization piggybacks on the Beam model proto (FunctionSpec with URN + JSON payload), so the internal v1 proto needs no new fields. The side-input mapping path panics for element-aware WindowFns, matching the existing sessions guard, since side-input windows have no element to feed AssignWindows. Integration coverage exercises an element-aware WindowFn end-to-end through the direct runner, verifying that elements with different SizeMs values land in the windows dictated by their own data.
Summary of ChangesHello, 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 introduces support for custom WindowFns in the Go SDK, achieving capability parity with the Java and Python SDKs. By adopting a structural typing approach consistent with the existing DoFn pattern, it allows users to define custom windowing logic while ensuring type safety and performance through an optimized invocation layer. The changes include a new registration system, serialization support, and robust integration testing to verify correct behavior across different windowing scenarios. Highlights
🧠 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 to enable Memory in your admin console. Using Gemini Code AssistThe 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 by creating a comment using either
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 Limitations & Feedback Gemini Code Assist 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
Implement custom WindowFn registration for the Go SDK, reaching capability parity with Java/Python AssignContext.
Custom WindowFns are plain structs registered via RegisterWindowFn and validated structurally at registration time, matching the DoFn pattern used elsewhere in the SDK. Two AssignWindows shapes are accepted:
AssignWindows(typex.EventTime) []typex.Window
AssignWindows(typex.EventTime, T) []typex.Window
The second form is element-aware: the element value drives which window(s) it lands in. Validation happens via reflection at registration, so misuse fails at pipeline construction rather than at runtime. A package-level registry records the struct type and optional element type for cross-package lookup via LookupWindowFnMeta.
An interface-based shape (WindowAssigner) was explored first. Structural typing was chosen instead because it keeps custom WindowFns consistent with DoFns, avoids forcing users to satisfy a Go-specific interface, and lets the same registry carry the element-type metadata that the dispatch and translation paths need.
WindowFnInvoker dispatches in three tiers: typed interface (zero alloc), element-aware typed interface (zero alloc), and reflect.Value.Method.Call as a fallback (2 allocs/element).
Serialization piggybacks on the Beam model proto (FunctionSpec with URN + JSON payload), so the internal v1 proto needs no new fields. The side-input mapping path panics for element-aware WindowFns, matching the existing sessions guard, since side-input windows have no element to feed AssignWindows.
Integration coverage exercises an element-aware WindowFn end-to-end through the direct runner, verifying that elements with different SizeMs values land in the windows dictated by their own data.
Adresses #20627
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
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, commentfixes #<ISSUE NUMBER>instead.CHANGES.mdwith noteworthy changes.See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.