docs: remove outdated State Resync Event section - #1970
Conversation
✅ Deploy Preview for polite-licorice-3db33c canceled.
|
dosubot
Bot
added
the
size:S
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
💤 Files with no reviewable changes (1)
📝 WalkthroughWalkthroughThe sync concepts documentation removes the outdated State Resync Events section and its related illustrations. ChangesSync documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Removes the State Resync Events section from syncs.md as it describes behavior that flagd does not actually support. Issue open-feature#1797 clarified that flagd does not handle cases where the same flag key is defined across multiple sources. The removed section incorrectly implied that a resync event would restore a flag definition from a lower-priority source when a higher-priority source deleted its version of the flag. Closes open-feature#1809 Signed-off-by: Kunal Das <kunalworldwide@gmail.com>
|
|
Removal looks correct. Could you also add the note from #1809 that users shouldn't reuse a flagset ID across sources (and the risks if they do)? That was part of the ask here. |
| When a delete event results in a flag definition being removed from the merged state, the full set of definition is requested from all flag sources, and the merged state is rebuilt. | ||
| As a result, the value of the `foo` flag from `source-B` will be stored in the merged state, preventing flagd from returning `FLAG_NOT_FOUND` errors. | ||
|
|
||
|  |
There was a problem hiding this comment.
flag-merge-3.svg and flag-merge-4.svg were only used here; they're orphaned now. Might be worth deleting them too.
|
@toddbaert good eye — those two SVGs are indeed orphaned after removing the State Resync Events section. I'll delete |
2 participants
Description
Removes the "State Resync Events" section from as it describes behavior that flagd does not actually support.
Context
Issue #1797 clarified that flagd does not handle cases where the same flag key is defined across multiple sources. The removed section incorrectly implied that when a higher-priority source deletes its version of a flag, a resync event would restore the flag definition from a lower-priority source. This is not accurate behavior.
The section being removed included:
This is a minimal documentation-only fix with no code changes.
Closes #1809