Skip to content

feat(flags): add default_value to feature_enabled() - #859

Closed
posthog[bot] wants to merge 2 commits into
mainfrom
posthog-code/feature-enabled-default-value
Closed

feat(flags): add default_value to feature_enabled()#859
posthog[bot] wants to merge 2 commits into
mainfrom
posthog-code/feature-enabled-default-value

Conversation

@posthog

@posthog posthog Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

💡 Motivation and Context

Brings feature_enabled() into compliance with the cross-SDK is-feature-enabled contract in PostHog/sdk-specs: a hard SHALL, @both-tagged requirement that the SDK accept a caller-supplied boolean default and return it whenever the flag has no value (not loaded, failed request, or unknown key) — while any present value, including False and variant strings, still always wins over the default.

This was flagged in the sdk-specs compliance matrix (posthog-python.md#n10, "Is Feature Enabled — ❌ Fail"): feature_enabled() had no default_value parameter at all, unconditionally returning None on a miss with no way for a caller to force a True/False fallback. Its successor, FeatureFlagEvaluations.is_enabled(), already got a default_value parameter in 7.38.0 — this PR closes the identical gap on the legacy feature_enabled() API for parity.

Backwards compatibility

Purely additive — default_value is a new keyword-only parameter defaulting to None. Existing callers who don't pass it see byte-for-byte identical behavior (a miss still resolves to None, matching the spec's allowed variation for three-state boolean APIs). Callers can now opt in to a True/False fallback on a miss.

💚 How did you test it?

  • Added two new tests to posthog/test/test_feature_flags.py: one confirming a caller-supplied default_value is returned on a missing flag or a failed /flags request, another confirming a flag with a real (even falsy) value still wins over the default.
  • Ran the full test_feature_flags.py + test_evaluate_flags.py + test_client.py suites (414 tests) — all passing.
  • mypy posthog/client.py — clean.
  • ruff format — clean on touched files.

📝 Checklist

  • I reviewed the submitted code.
  • I added tests to verify the changes.
  • I updated the docs if needed. (docstring updated; no README signature to update)
  • No breaking change or entry added to the changelog.

If releasing new changes

  • Ran sampo add to generate a changeset file

🤖 Agent context

Autonomy: Fully autonomous — this PR was generated by a scheduled compliance-audit loop that reads the SDK compliance matrices in PostHog/sdk-specs and implements one well-scoped, backward-compatible gap per run. No human directed this specific change; left unassigned for the owning team to triage.

  • Tooling: Claude Code (Sonnet 5), running an unattended daily loop over compliance/*.md in PostHog/sdk-specs.
  • Selection: Of the open gaps across 12 SDKs, this one was chosen for being a hard spec SHALL (not just a nice-to-have), high-impact/widely-used (core flag-evaluation API), narrowly scoped (a single optional parameter), and purely additive — no existing open PR/branch addressed it.
  • Scope decision: The audit note also mentioned a related-but-separate gap (no per-call tracking-suppression on is_enabled()/get_flag()); that was left out of scope here to keep this PR focused on the single contract (default_value).

Closes the posthog-python × Is Feature Enabled cell in the sdk-specs compliance matrix.

Bring `feature_enabled()` in line with the sdk-specs `is-feature-enabled`
contract's hard SHALL: accept a caller-supplied boolean default and return it
whenever the flag has no value (not loaded, failed request, or unknown key).
A flag with a present value — including `False` and variant strings — still
always wins over the default.

`FeatureFlagEvaluations.is_enabled()` already got this in 7.38.0; this closes
the gap on the legacy `feature_enabled()` API.

Generated-By: PostHog Code
Task-Id: c093e5e1-ce99-4af4-a335-7687fe675eee
@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

posthog-python Compliance Report

Date: 2026-08-10 16:36:38 UTC
Duration: 256389ms

✅ All Tests Passed!

111/111 tests passed


Capture_V1 Tests

94/94 tests passed

View Details
Test Status Duration
Endpoint And Method.Targets V1 Endpoint 518ms
Endpoint And Method.Does Not Use Legacy Endpoints 511ms
Required Headers.Has Authorization Bearer Header 510ms
Required Headers.Has Content Type Json 510ms
Required Headers.Has Posthog Sdk Info Format 511ms
Required Headers.Has Posthog Attempt Header 510ms
Required Headers.Has Posthog Request Id 510ms
Required Headers.Has Posthog Request Timestamp 510ms
Required Headers.Has User Agent 511ms
Body Format.Body Has Created At And Batch 510ms
Body Format.No Api Key In Body 510ms
Body Format.No Sent At In Body 511ms
Event Format.Event Has Required Root Fields 510ms
Event Format.Event Uuid Is Valid 510ms
Event Format.Event Timestamp Is Rfc3339 510ms
Event Format.Distinct Id Is String 510ms
Event Format.Distinct Id At Root Not Properties 510ms
Event Format.Custom Properties Preserved 511ms
Event Format.Set Properties Preserved 510ms
Event Format.Set Once Properties Preserved 510ms
Event Format.Groups Properties Preserved 512ms
Event Format.Sdk Generates Uuid If Not Provided 510ms
Event Format.Event Has Required Root Fields Batch 514ms
Event Format.Event Uuid Is Valid Batch 513ms
Event Format.Event Timestamp Is Rfc3339 Batch 513ms
Event Format.Distinct Id Is String Batch 514ms
Event Format.Distinct Id At Root Not Properties Batch 514ms
Event Format.Custom Properties Preserved Batch 513ms
Event Format.Set Properties Preserved Batch 514ms
Event Format.Set Once Properties Preserved Batch 513ms
Event Format.Groups Properties Preserved Batch 513ms
Event Format.Sdk Generates Uuid If Not Provided Batch 513ms
Batch Behavior.Multiple Events In Single Batch 518ms
Batch Behavior.Batch Envelope Smoke 515ms
Batch Behavior.Flush With No Events Sends Nothing 506ms
Batch Behavior.Flush At Triggers Batch 1010ms
Batch Behavior.Created At Reflects Batch Creation Time 511ms
Deduplication.Generates Unique Uuids 517ms
Deduplication.Different Events Same Content Different Uuids 513ms
Deduplication.Preserves Uuid On Retry 6515ms
Deduplication.Preserves Timestamp On Retry 6520ms
Deduplication.Preserves Uuid And Timestamp On Batch Retry 6524ms
Deduplication.No Duplicate Events In Batch 518ms
Header Behavior On Retry.Attempt Header Starts At One 510ms
Header Behavior On Retry.Attempt Header Increments On Retry 13522ms
Header Behavior On Retry.Request Id Preserved On Retry 6516ms
Header Behavior On Retry.Different Requests Have Different Request Ids 3020ms
Header Behavior On Retry.Request Timestamp Changes On Retry 6520ms
Response Format Validation.Success Response Has Uuid Keyed Results 511ms
Response Format Validation.Success Response Has Ok For Each Event 514ms
Response Format Validation.Success No Retry After When All Ok 513ms
Response Format Validation.Success Retry After Present When Retry Events 1516ms
Response Format Validation.Success No Retry After When Drop Only 513ms
Response Format Validation.Response Echoes Request Id 510ms
Retry Behavior.Retries On 408 6519ms
Retry Behavior.Retries On 500 6520ms
Retry Behavior.Retries On 503 8523ms
Retry Behavior.Retries On 504 6516ms
Retry Behavior.Retryable Errors Have Retry After 3517ms
Retry Behavior.Respects Retry After On Retryable Error 11516ms
Retry Behavior.Does Not Retry On 400 2514ms
Retry Behavior.Does Not Retry On 401 2512ms
Retry Behavior.Does Not Retry On 402 2513ms
Retry Behavior.Does Not Retry On 413 2514ms
Retry Behavior.Does Not Retry On 415 2514ms
Retry Behavior.Non Retryable Errors Have No Retry After 2512ms
Retry Behavior.Implements Backoff 22538ms
Retry Behavior.Max Retries Respected 22536ms
Partial Batch Handling.Handles 200 Full Success 2512ms
Partial Batch Handling.Handles 200 With All Ok 3517ms
Partial Batch Handling.Does Not Retry Dropped Events 3517ms
Partial Batch Handling.Does Not Retry Limited Events 3515ms
Partial Batch Handling.Prunes Ok Events On Partial Retry 6518ms
Partial Batch Handling.Prunes Dropped Events On Partial Retry 6521ms
Partial Batch Handling.Retries Only Retry Events From Partial 6523ms
Partial Batch Handling.Partial Retry Preserves Uuids 6518ms
Partial Batch Handling.Partial Retry Attempt Header Increments 6522ms
Partial Batch Handling.Partial Retry Request Id Preserved 6521ms
Partial Batch Handling.Respects Retry After On Partial 8522ms
Partial Batch Handling.Unknown Result Treated As Terminal 3517ms
Partial Batch Handling.Mixed Ok Drop Limited No Retry 3520ms
Compression.Sends Gzip Content Encoding 511ms
Compression.No Content Encoding When Disabled 509ms
Compression.Compressed Body Is Decompressible 511ms
Error Handling.Does Not Retry On Unknown 4Xx 2513ms
Event Options.Cookieless Mode Override 511ms
Event Options.Disable Skew Correction Override 510ms
Event Options.Process Person Profile Override 511ms
Event Options.Product Tour Id Override 510ms
Event Options.Unset Options Omitted 510ms
Event Options.Options Override In Batch 514ms
Geoip And Historical Migration.Geoip Disable Injected Into Properties 510ms
Geoip And Historical Migration.Historical Migration Set In Body 510ms
Geoip And Historical Migration.Historical Migration Absent By Default 510ms

Feature_Flags Tests

17/17 tests passed

View Details
Test Status Duration
Request Payload.Request With Person Properties Device Id 12ms
Request Payload.Flags Request Uses V2 Query Param 10ms
Request Payload.Flags Request Hits Flags Path Not Decide 9ms
Request Payload.Flags Request Omits Authorization Header 9ms
Request Payload.Token In Flags Body Matches Init 11ms
Request Payload.Groups Round Trip 10ms
Request Payload.Groups Default To Empty Object 10ms
Request Payload.Disable Geoip False Propagates As Geoip Disable False 10ms
Request Payload.Disable Geoip Omitted Defaults To False 10ms
Request Payload.Flag Keys To Evaluate Contains Only Requested Key 9ms
Request Lifecycle.No Flags Request On Init Alone 4ms
Request Lifecycle.No Flags Request On Normal Capture 510ms
Request Lifecycle.Two Flag Calls Produce Two Remote Requests 14ms
Request Lifecycle.Mock Response Value Is Returned To Caller 10ms
Retry Behavior.Retries Flags On 502 313ms
Retry Behavior.Retries Flags On 504 314ms
Side Effect Events.Get Feature Flag Captures Feature Flag Called Event 512ms

Updates references/public_api_snapshot.txt for the new `default_value` parameter on `Client.feature_enabled()`, fixing the failing "Public API snapshot" CI check.

Generated-By: PostHog Code
Task-Id: c093e5e1-ce99-4af4-a335-7687fe675eee
@dustinbyrne

Copy link
Copy Markdown
Contributor

i'd closed this because i initially thought it was changing the deprecated is_feature_flag_enabled API - but this is different. this is the evaluate_flags API, so it's still good.

@dustinbyrne dustinbyrne reopened this Aug 10, 2026
@dustinbyrne
dustinbyrne marked this pull request as ready for review August 10, 2026 16:31
@dustinbyrne
dustinbyrne requested a review from a team as a code owner August 10, 2026 16:31
@posthog

posthog Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor Author

🦔 ReviewHog reviewed this pull request

Nothing worth raising this time, so here's a calming picture instead:

A happy dog on a sunny path

@dustinbyrne

Copy link
Copy Markdown
Contributor

this IS the wrong api

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant