Skip to content

fix: Prevent a null prerequisites list from stopping the client from initializing - #587

Merged
kinyoklion merged 1 commit into
mainfrom
rlamb/sdk-3667/explicit-null-optional-properties
Nov 18, 2026
Merged

kinyoklion merged 1 commit into
mainfrom
rlamb/sdk-3667/explicit-null-optional-properties

Conversation

@kinyoklion

@kinyoklion kinyoklion commented Nov 17, 2026 •

Copy link
Copy Markdown
Member

When flag data sets prerequisites to null, the SDK cannot write the data set to its store. The store puts each prerequisite flag before the flags that depend on it, and that ordering iterated over the null value and raised a TypeError. The sync client then restarted the stream again and again and never initialized. The async client fails the same way when it writes to a persistent store. A null prerequisites list now has the same effect as an omitted list, which is how the flag model already reads it.

Testing: added a unit test for store ordering with a null prerequisites list; the explicit-null data-model contract tests now pass, and the full v2 and v3 contract suites are unchanged for the sync and async clients.

SDK-3667

Opened from termag


Note

Overview
Fixes client initialization when flag payloads include prerequisites: null. Feature store ordering used flag.get('prerequisites', []), which still returns None when the field is present but null, so dependency traversal raised a TypeError and blocked store writes (sync stream restart loop / async persistent store failures).

FEATURES.get_dependency_keys now treats a null prerequisites list like a missing list via (flag.get('prerequisites') or []).

Adds test_store_data_set_ordering_treats_null_prerequisites_as_empty to assert flags still land in dependency order (b before a) when a prerequisite flag has null prerequisites.

Reviewed by Cursor Bugbot for commit 8b76d12. Bugbot is set up for automated code reviews on this repo. Configure here.

… the store

An explicit null prerequisites property made the dependency ordering fail with a TypeError, so the store was never initialized and the stream restarted forever.

Generated-by: termag
@kinyoklion
kinyoklion marked this pull request as ready for review November 17, 2026 23:22
@kinyoklion
kinyoklion requested a review from a team as a code owner November 17, 2026 23:22
@cursor cursor Bot added the risk:low label Nov 17, 2026

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Risk: low.

Automated risk review (dry run): Low

This PR would be automatically approved.

Why: The change treats a null prerequisites list as empty in ldclient/versioned_data_kind.py when ordering flag dependencies, matching an omitted list, and adds a focused unit test in ldclient/testing/test_ldclient.py. It is a narrow correctness fix with tests and no infrastructure, auth, or CI changes.

If you disagree with this review, share this PR in #feedback-agent-approvals or submit a changes-requested review explaining why.

Open in Web View Automation 

Sent by Cursor Approval Agent: Dry-Run PR Approver

@kinyoklion
kinyoklion merged commit 298e2a3 into main Nov 18, 2026
18 checks passed
@kinyoklion
kinyoklion deleted the rlamb/sdk-3667/explicit-null-optional-properties branch November 18, 2026 17:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants