Skip to content

WIP Add custom window support in Go SDK#38288

Draft
hnnsgstfssn wants to merge 1 commit intoapache:masterfrom
hnnsgstfssn:custom_windows
Draft

WIP Add custom window support in Go SDK#38288
hnnsgstfssn wants to merge 1 commit intoapache:masterfrom
hnnsgstfssn:custom_windows

Conversation

@hnnsgstfssn
Copy link
Copy Markdown
Contributor

@hnnsgstfssn hnnsgstfssn commented Apr 26, 2026

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:

  • 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.

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)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

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.
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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

  • Custom WindowFn Registration: Implemented a registration mechanism for custom WindowFns using a struct-based pattern, allowing for structural validation at registration time.
  • Element-Aware Windowing: Added support for element-aware WindowFns, enabling window assignment logic to depend on the element value itself.
  • Dispatch Optimization: Introduced a WindowFnInvoker that provides optimized dispatch paths (typed interface vs. reflection) to minimize allocation overhead during window assignment.
  • Serialization and Integration: Integrated custom WindowFns with the existing Beam model proto serialization and added comprehensive integration tests covering both standard and element-aware custom windowing.

🧠 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 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 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.

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 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

  1. 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.

@github-actions github-actions Bot added the go label Apr 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant