Add REST accessor for decoded WAGED assignments - #222
Open
LZD-PratyushBhatt wants to merge 1 commit into
Open
Conversation
LZD-PratyushBhatt
requested review from
arkmish,
laxman-ch,
ngngwr and
thestreak101
as code owners
August 9, 2026 01:09
The controller persists the WAGED baseline and best possible assignments
through ZkBucketDataAccessor, which GZIPs the serialized record and splits
it across numbered bucket ZNodes. Reading those ZNodes over the existing
/zookeeper API therefore returns opaque compressed chunks, and the
propertyStore API cannot reach them at all because ASSIGNMENT_METADATA
lives at the cluster root rather than under PROPERTYSTORE. The only other
assignment API, /partitionAssignment, recomputes a what-if placement and
never reads what was actually persisted.
Add WagedAssignmentAccessor, which reassembles the buckets, decompresses,
and deserializes each resource assignment server side:
GET /clusters/{clusterId}/wagedAssignment/bestPossible
GET /clusters/{clusterId}/wagedAssignment/baseline
Supported query params:
format=IdealStateFormat (default) | CurrentStateFormat
resources, instances, partitions - comma separated allowlists, since
these payloads are large on real clusters
includeMetadata (default true) - the persisted write version, its ZK
mtime, and the bucket metadata, so callers can tell how fresh the
decoded assignment is
A missing assignment returns 404 rather than an empty body, so callers can
distinguish "WAGED never persisted here" from "assignment is empty".
The path layout and the per-resource decode are exposed from
AssignmentMetadataStore instead of being duplicated in helix-rest, so the
reader cannot drift from the writer.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
LZD-PratyushBhatt
force-pushed
the
lzd/waged-assignment-rest
branch
from
August 9, 2026 01:13
d646388 to
1172997
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The controller persists the WAGED baseline and best possible assignments through ZkBucketDataAccessor, which GZIPs the serialized record and splits it across numbered bucket ZNodes. Reading those ZNodes over the existing /zookeeper API therefore returns opaque compressed chunks, and the propertyStore API cannot reach them at all because ASSIGNMENT_METADATA lives at the cluster root rather than under PROPERTYSTORE. The only other assignment API, /partitionAssignment, recomputes a what-if placement and never reads what was actually persisted.
Add WagedAssignmentAccessor, which reassembles the buckets, decompresses, and deserializes each resource assignment server side:
GET /clusters/{clusterId}/wagedAssignment/bestPossible
GET /clusters/{clusterId}/wagedAssignment/baseline
Supported query params:
format=IdealStateFormat (default) | CurrentStateFormat
resources, instances, partitions - comma separated allowlists, since
these payloads are large on real clusters
includeMetadata (default true) - the persisted write version, its ZK
mtime, and the bucket metadata, so callers can tell how fresh the
decoded assignment is
A missing assignment returns 404 rather than an empty body, so callers can distinguish "WAGED never persisted here" from "assignment is empty".
The path layout and the per-resource decode are exposed from AssignmentMetadataStore instead of being duplicated in helix-rest, so the reader cannot drift from the writer.
Issues
(#200 - Link your issue number here: You can write "Fixes #XXX". Please use the proper keyword so that the issue gets closed automatically. See https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue
Any of the following keywords can be used: close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved)
Description
(Write a concise description including what, why, how)
Tests
(List the names of added unit/integration tests)
(If CI test fails due to known issue, please specify the issue and test PR locally. Then copy & paste the result of "mvn test" to here.)
Changes that Break Backward Compatibility (Optional)
(Consider including all behavior changes for public methods or API. Also include these changes in merge description so that other developers are aware of these changes. This allows them to make relevant code changes in feature branches accounting for the new method/API behavior.)
Documentation (Optional)
(Link the GitHub wiki you added)
Commits
Code Quality
(helix-style-intellij.xml if IntelliJ IDE is used)