Repository navigation
fix: Prevent a full status listener from hanging Close - #498
Merged
Merged
Conversation
beekld
force-pushed
the
bklimt/SDK-3425/broadcaster-unblock
branch
from
November 3, 2026 00:05
036e2f4 to
c1e6e39
Compare
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit c1e6e39. Configure here.
kinyoklion
reviewed
Nov 3, 2026
kinyoklion
left a comment
Member
There was a problem hiding this comment.
Approved with consideration of 505.
tanderson-ld
self-requested a review
November 3, 2026 19:00
tanderson-ld
approved these changes
Nov 3, 2026
tanderson-ld
left a comment
Contributor
There was a problem hiding this comment.
Requires 505 for stack to merge together.
beekld
force-pushed
the
bklimt/SDK-3425/broadcaster-unblock
branch
from
November 3, 2026 19:38
c1e6e39 to
b5e17cb
Compare
beekld
added a commit
that referenced
this pull request
Nov 3, 2026
…ps (#505) ## Summary **Behavior change:** compared with the released 7.21.2, FDv2 status listeners that are still reading now receive an `Off` status when the client closes. Their channels then close as before. 7.21.2 neither broadcast `Off` nor set it on shutdown. #489 added a blocking broadcast that could hang `Close()`, and #498 removed it. This PR adds `Broadcaster.CloseWith`, which sends a final value to each listener that has room for it in its buffer and then closes every listener channel. It never waits for a listener to read, so a listener that has stopped reading still can't block `Close()`. That listener misses `Off` and only sees its channel close. The data system uses it in `Stop()` to send the `Off` status. As a result, a `WaitFor(DataSourceStateOff, ...)` call that's running when the client closes now returns `true`. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Overview** > Adds **`Broadcaster.CloseWith`**, which non-blockingly pushes one final value into each subscriber channel that still has buffer space, then closes all listener channels. **`Close()`** is unchanged in behavior and routes through shared **`closeAll(nil)`** logic; **`RemoveListener`** still closes without a final value. > > **FDv2 `Stop()`** now records **`DataSourceStateOff`** via **`maybeUpdateStatus`** and shuts down broadcasters with **`Close(status)`**, so data-source status listeners that are still reading typically receive **`Off`** before their channel closes. **`WaitFor(DataSourceStateOff, …)`** can therefore return **`true`** when the client stops instead of timing out or failing only on channel close. > > Listeners whose buffers are full still do not block shutdown—the final **`Off`** is dropped for them (same non-waiting guarantee as **`CloseWith`**). Tests cover broadcaster **`CloseWith`** semantics and FDv2 stop / **`WaitFor(Off)`** behavior. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit 0ec9157. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY -->
beekld
pushed a commit
that referenced
this pull request
Nov 6, 2026
🤖 I have created a release *beep* *boop* --- ## [7.22.0](v7.21.2...v7.22.0) (2026-11-06) ### Features * Broadcast Off to FDv2 status listeners when the data system stops ([#505](#505)) ([5c5b8ce](5c5b8ce)) * End an FDv1 fallback after a default TTL of one hour ([#499](#499)) ([1f03a5f](1f03a5f)) * Park FDv2 synchronizers instead of retiring them on unexpected failures ([#489](#489)) ([644253a](644253a)) ### Bug Fixes * Keep data from a store that is not initialized out of override evaluations and AllFlagsState, and report a store failure ([#491](#491)) ([1005a1a](1005a1a)) * Keep the override marking when a migration flag serves an unrecognized stage ([#492](#492)) ([9f9911f](9f9911f)) * Leave StateSince alone when a synchronizer starts ([#502](#502)) ([823b9aa](823b9aa)) * Make TestData ValueForAll return its value when targeting is off ([#507](#507)) ([7300bc1](7300bc1)) * Park a synchronizer that reports Off or closes its results ([#500](#500)) ([f6e9910](f6e9910)) * Poll the override files when they cannot be watched ([#495](#495)) ([170ad3b](170ad3b)) * Prevent a full status listener from hanging Close ([#498](#498)) ([9efd570](9efd570)) * Say that the data system retries after an unrecoverable HTTP error ([#501](#501)) ([d4066cc](d4066cc)) * Treat a repeated override file path in a different case as a repeat on Windows ([#494](#494)) ([eeb68d3](eeb68d3)) * Warn when offline mode skips the override source ([#493](#493)) ([69bbe61](69bbe61)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Overview** > **Cuts the Go server SDK release `7.22.0` and records its notes.** > > The root **`.release-please-manifest.json`** and **`internal/version.go`** now declare **`7.22.0`** (replacing `7.21.2`). **`CHANGELOG.md`** gains a new **`[7.22.0]`** section dated **2026-11-06** documenting shipped work: FDv2 data-system behavior (status **Off** broadcasts, synchronizer **parking** instead of retire, **FDv1 fallback TTL**, **StateSince** handling, parking on **Off**/closed results), plus multiple **bug fixes** around uninitialized store data in overrides/**AllFlagsState**, migration override marking, **TestData** when targeting is off, **override file** polling/deduping on Windows, offline-mode warnings, status listener **Close** hangs, and messaging for unrecoverable HTTP retries. > > No application code changes appear in this PR; it’s version bookkeeping and release notes only. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit c763cc0. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.

Summary
#489 made
FDv2.Stop()broadcast anOffstatus after its goroutines exit. A broadcast does a blocking send to each listener channel, which buffers 10 values. If an application listener stops reading while its buffer is full,Stop()blocks forever. That hangsLDClient.Close(), andGetStatus()hangs with it, because the send ran under the status lock.The hazard predates #489. Any status update can block the same way while the data system runs, and the broadcaster holds its lock during the send. So removing the stuck listener also blocks.
This PR:
RemoveListenerandCloseunblock a send to a full listener. Listeners that keep reading still get every value, in order. No broadcast drops events.GetStatus()no longer waits on a listener.OfffromFDv2.Stop(). The status still changes toOff, and listeners learn of shutdown when their channels close.WaitForthat only existed to work around the blocking removal.WaitForreturnfalsewhen its listener channel closes, in both FDv1 and FDv2. Before, aWaitForstill running atClose()spun on the closed channel until its timeout.Note
Overview
Fixes hangs when a status listener’s buffered channel is full and the app stops reading—previously
Broadcast,RemoveListener,Close,FDv2.Stop(), andGetStatus()could block indefinitely (includingLDClient.Close()).The generic
Broadcasternow sends without holding the subscriber list lock, uses per-subscriberdonesignaling so removal/shutdown aborts in-flight sends, and still delivers every value in order to listeners that keep reading.FDv2.UpdateStatusbroadcasts only after the status mutex is released (matching FDv1).Stop()sets status toOffinternally but no longer broadcastsOff—shutdown is signaled by closing listener channels.WaitFordrops the old channel-drain workaround and returnsfalsewhen the listener channel closes (e.g. on stop or broadcaster close).Tests cover full-buffer broadcast/unblock paths and FDv1/FDv2
WaitFor,GetStatus, andStopunder a full listener.Reviewed by Cursor Bugbot for commit b5e17cb. Bugbot is set up for automated code reviews on this repo. Configure here.