Skip to content

Change TriggerState finished bitset coder to a SentinelBitSetCoder#38139

Open
arunpandianp wants to merge 6 commits intoapache:masterfrom
arunpandianp:sentinelbitsetcoder
Open

Change TriggerState finished bitset coder to a SentinelBitSetCoder#38139
arunpandianp wants to merge 6 commits intoapache:masterfrom
arunpandianp:sentinelbitsetcoder

Conversation

@arunpandianp
Copy link
Copy Markdown
Contributor

@arunpandianp arunpandianp commented Apr 10, 2026

SentinelBitSetCoder is same as BitSetCoder except that it encodes empty bitset as a single element 0 byte array.

This allows checking if the finished bitset is empty or missing #37574.

SentinelBitSetCoder and BitSetCoder are state compatible. Both coders can decode encoded bytes from the other coder successfully.

@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 a specialized coder, SentinelBitSetCoder, to handle BitSet serialization in scenarios where distinguishing between an empty bitset and a missing one is required. By ensuring backward compatibility with the existing BitSetCoder, this change allows for safer state management within the trigger state machine runner without breaking existing data pipelines.

Highlights

  • New Coder Implementation: Introduced SentinelBitSetCoder, which encodes empty BitSet objects as a single-element 0 byte array to distinguish between empty and missing states.
  • Compatibility: Ensured that SentinelBitSetCoder remains state-compatible with the existing BitSetCoder, allowing for seamless decoding of data encoded by either implementation.
  • Refactoring: Updated TriggerStateMachineRunner to utilize the new SentinelBitSetCoder for the FINISHED_BITS_TAG.

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

SentinelBitSetCoder is same as BitSetCoder except that it encodes
empty bitset as a single element 0 byte array.

This allows checking if the finished bitset is empty or missing.

SentinelBitSetCoder and BitSetCoder are state compatible. Both coders
can decode encoded bytes from the other coder successfully.
@arunpandianp
Copy link
Copy Markdown
Contributor Author

R: @scwhittle

@github-actions
Copy link
Copy Markdown
Contributor

Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment assign set of reviewers


@Override
public boolean consistentWithEquals() {
return true;
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if this should be true/false.

Reading the doc, true here means if encodedBytes match then decoded objects are equals to each other. It doesn't say if encodedBytes does not match then decoded objects are not equals to each other.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

injective in that comment means 1:1 so I think it implies that serializedA == serializedB if and only if A.equals(B)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Taking SentinelBitSetCoder.java in isolation, returning true here is valid and when serialized bytes are same the objects are same and vice versa.

I am thinking if we need to do anything special for the case where SentinelBitSetCoder will decode bytes encoded by BitSetCoder after a job update. Based on the usage in TriggerStateMachineRunner, It seems like we don't need to do anything special. Not sure if I'm missing anything.


@Override
public boolean consistentWithEquals() {
return true;
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

injective in that comment means 1:1 so I think it implies that serializedA == serializedB if and only if A.equals(B)

if (value == null) {
throw new CoderException("cannot encode a null BitSet");
}
byte[] bytes = value.isEmpty() ? new byte[] {0} : value.toByteArray();
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this already seems to be what value.toByteArray() does, am I missing something?

https://github.com/openjdk-mirror/jdk7u-jdk/blob/master/src/share/classes/java/util/BitSet.java#L291

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

value.toByteArray() has return new byte[0]; which returns an empty byte array. Here we return a single zero element byte array

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants