chore: Support flag change listeners in contract tests#349
Merged
aaron-zeisler merged 4 commits intov7from Mar 6, 2026
Merged
Conversation
06224bc to
6f3b218
Compare
This was referenced Feb 24, 2026
aaron-zeisler
commented
Feb 25, 2026
tanderson-ld
approved these changes
Feb 27, 2026
Contributor
tanderson-ld
left a comment
There was a problem hiding this comment.
I don't see any issues, but probably makes sense to get @keelerm84 review.
keelerm84
approved these changes
Mar 2, 2026
This was referenced Mar 3, 2026
Add command constants, parameter structs, and the ListenerNotification payload type to support the three new flag change listener commands: registerFlagChangeListener, registerFlagValueChangeListener, and unregisterListener. Also adds the CapabilityFlagChangeListeners constant to service_params.go. No runtime behavior is introduced in this commit; these are pure type definitions that subsequent commits will build on.
Add flag_change_listener.go with a listenerRegistry that manages goroutine-based subscriptions to the SDK's FlagTracker channels. Each registered listener spawns a goroutine that consumes SDK events and POSTs a ListenerNotification JSON payload to the provided callback URI. General flag change listeners support optional key filtering; value change listeners include old and new values in the payload. Wire the three new commands into SDKClientEntity.DoCommand: registerFlagChangeListener, registerFlagValueChangeListener, and unregisterListener. Also calls closeAll() in Close() to cancel all listener goroutines before the SDK client shuts down. The flag-change-listeners capability is not yet advertised, so no test harness tests are run yet.
Add CapabilityFlagChangeListeners to the test service capabilities list. All 8 flag change listener tests pass against the sdk-test-harness.
ac77b18 to
cbb3c53
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.
This pull request is part of a larger set of PRs that implement Flag Change Listener tests for server SDKs. Here's the list of pull requests that I currently have open:
Summary
Implements test service support for the new flag change listener contract tests defined in sdk-test-harness#317. No changes to the SDK itself — only the test service (
testservice/) is modified.For context on how the test harness drives these tests and what the full test matrix covers, see the sdk-test-harness PR description.
What this PR does
Adds type definitions (
testservice/servicedef/) for the three new commands and theListenerNotificationcallback payload, plus theflag-change-listenerscapability constant.Implements a
listenerRegistry(testservice/flag_change_listener.go) that manages all active listener subscriptions for an SDK client entity. Each registration spawns a goroutine that consumes events from the Go SDK'sFlagTrackerchannel and POSTs aListenerNotificationJSON payload to the callback URI provided by the test harness. The registry handles:FlagTracker.AddFlagChangeListener(), with optional key filtering when the test registers for a specific flagFlagTracker.AddFlagValueChangeListener(), which handles context-specific evaluation and old/new value tracking internallycloseAll()is called when the SDK client entity shuts down, ensuring no orphaned goroutinesAdvertises the capability by adding
flag-change-listenersto the test service's capabilities list. All 8 contract tests pass.Requirements
Related issues
Provide links to any issues in this repository or elsewhere relating to this pull request.
Describe the solution you've provided
Provide a clear and concise description of what you expect to happen.
Describe alternatives you've considered
Provide a clear and concise description of any alternative solutions or features you've considered.
Additional context
Add any other context about the pull request here.
Note
Medium Risk
Adds new goroutine-based listener registrations that POST callbacks on flag updates; main risk is concurrency/lifecycle management causing leaks or flaky test behavior if listeners aren’t cleaned up correctly.
Overview
Adds contract-test support for flag change listeners in the Go
testserviceby introducing new service commands to register/unregister listeners and a callback payload (ListenerNotification).Implements a per-client
listenerRegistrythat subscribes to the SDKFlagTrackerfor either any flag config change or value changes for a specific flag+context, forwards events to the harness via HTTP POST, and ensures listeners are cancelled onunregisterand when the client entity closes. The service now advertisesflag-change-listenersandflag-value-change-listenerscapabilities.Written by Cursor Bugbot for commit cbb3c53. This will update automatically on new commits. Configure here.