feat(flags): accept a caller default in FeatureFlagEvaluations#enabled?

[posthog]

💡 Motivation and Context

The cross-SDK is-feature-enabled spec states a hard requirement with no server-SDK carve-out:

The SDK SHALL accept a caller-supplied boolean default (defaultValue; parameter placement per platform idiom) and SHALL return it whenever the flag has no value: flags not loaded yet, a failed flags request, or no flag with that key in the loaded flags. A flag that has a value — including false and variant strings — always wins over the caller-supplied default.

The compliance matrix records this as a ❌ Fail for posthog-ruby:

FeatureFlagEvaluations#enabled? has no default_value parameter: def enabled?(key) ... flag&.enabled ? true : false end — it collapses every miss to a hardcoded false rather than accepting a caller override.

Remediation: Add a default_value: keyword to FeatureFlagEvaluations#enabled?, distinguishing "no default supplied" (current false behavior) from an explicit caller-supplied default.

Today a caller cannot tell "the flag is off" apart from "we never got an answer", and cannot choose to fail open when flag data is unavailable (empty snapshot, failed /flags request, quota-limited response).

Explanation of the change

PostHog::FeatureFlagEvaluations#enabled? gains an optional default_value: keyword:

flags = posthog.evaluate_flags(distinct_id)
flags.enabled?('new-checkout', default_value: true)

The default is returned only when the key is absent from the snapshot. Any flag that has a value — true, false, or a variant string — still wins over it, and nil (the parameter's own default) preserves the historical false result for a missing flag.

$feature_flag_called reporting is deliberately untouched: the event still carries the real evaluated response (nil plus $feature_flag_error: flag_missing for a miss), not the caller's default, so exposure data keeps reflecting what the server actually said.

Scope is limited to this one contract. The deprecated Client#is_feature_enabled has the same gap but is not changed here — it already warns callers to move to evaluate_flags(...).enabled?, which is now the compliant surface. The matrix's other open gaps for this SDK are left alone.

Why this is backwards-compatible

Purely additive. default_value: defaults to nil, and the miss path is only diverted when a caller explicitly passes a non-nil value, so every existing call site behaves exactly as before. public_api_snapshot.txt is regenerated to record the new optional keyword.

💚 How did you test it?

Four new specs in spec/posthog/feature_flag_evaluations_spec.rb, mapping onto the spec's acceptance scenarios (acceptance/public/is-feature-enabled.feature):

• a missing flag resolves to the caller default (true and false)
• an existing value wins over the default (disabled flag, variant flag, boolean flag)
• an empty snapshot uses the default, and still returns false when no default is given
• $feature_flag_called still reports the evaluated response and flag_missing, not the default

Locally, on Ruby 3.2:

• bundle exec rspec — 1252 examples, 0 failures (2 pending, the OTel-gemfile integration tests)
• bundle exec rubocop — 129 files, no offenses
• bundle exec rake public_api:check — clean after regenerating the snapshot

Follow-up work

• The same default-value gap is recorded for posthog-node, posthog-php, posthog-go and posthog-dotnet; posthog-java is the existing reference implementation.
• The spec's own "Surface variants" table shows a stale Ruby signature without a default parameter, and the docs for evaluate_flags could mention the new keyword.

📝 Checklist

• I reviewed the submitted code.
• I added tests to verify the changes.
• I updated the docs if needed.
• No breaking change or entry added to the changelog.

If releasing new changes

• Ran pnpm changeset to generate a changeset file

🤖 Agent context

Autonomy: Fully autonomous

Opened by the scheduled SDK-compliance agent, which reads the compliance matrices in PostHog/sdk-specs and implements one open, backwards-compatible gap per run. This gap was picked over the alternatives because it is a hard SHALL with a one-method, additive remediation on a non-deprecated surface, and because no existing PR or branch in this repo touched it.

Deliberate decisions: only the canonical evaluate_flags(...).enabled? path was changed (the legacy is_feature_enabled is deprecated, so extending it would add API surface we are steering callers away from); $feature_flag_called properties were left reporting the true evaluated response rather than the substituted default, so the default cannot distort exposure analytics.

No manual/end-to-end testing beyond the automated checks listed above.

---

Created with PostHog Desktop

🤖 Generated with Claude Code

[github-actions]

posthog-ruby-sync Compliance Report

Date: 2026-10-07T00:01:41.672247+00:00
Duration: 93990ms

⚠️ Some Tests Failed

45/47 tests passed, 2 failed

---

Capture Tests

⚠️ 29/30 tests passed, 1 failed

View Details

Test	Status	Duration
Format Validation.Event Has Required Fields	✅	8ms
Format Validation.Event Has Uuid	✅	5ms
Format Validation.Event Has Lib Properties	✅	4ms
Format Validation.Distinct Id Is String	✅	8ms
Format Validation.Token Is Present	✅	6ms
Format Validation.Custom Properties Preserved	✅	4ms
Format Validation.Event Has Timestamp	✅	6ms
Format Validation.Non Utc Event Timestamp Is Converted To Utc	✅	5ms
Retry Behavior.Retries On 503	✅	5367ms
Retry Behavior.Does Not Retry On 400	✅	2009ms
Retry Behavior.Does Not Retry On 401	✅	2008ms
Retry Behavior.Respects Retry After Header	✅	8014ms
Retry Behavior.Implements Backoff	✅	15349ms
Retry Behavior.Retries On 500	✅	5163ms
Retry Behavior.Retries On 502	✅	5113ms
Retry Behavior.Retries On 504	✅	5150ms
Retry Behavior.Max Retries Respected	✅	15524ms
Deduplication.Generates Unique Uuids	✅	17ms
Deduplication.Preserves Uuid On Retry	✅	5111ms
Deduplication.Preserves Uuid And Timestamp On Retry	✅	10296ms
Deduplication.Preserves Uuid And Timestamp On Batch Retry	✅	5117ms
Deduplication.No Duplicate Events In Batch	✅	13ms
Deduplication.Different Events Have Different Uuids	✅	6ms
Compression.Sends Gzip When Enabled	✅	4ms
Batch Format.Uses Proper Batch Structure	✅	4ms
Batch Format.Flush With No Events Sends Nothing	✅	2ms
Batch Format.Multiple Events Batched Together	❌	15ms
Error Handling.Does Not Retry On 403	✅	2006ms
Error Handling.Does Not Retry On 413	✅	2006ms
Error Handling.Retries On 408	✅	5152ms

Failures

batch_format.multiple_events_batched_together

Expected 1 requests, got 5

Feature_Flags Tests

⚠️ 16/17 tests passed, 1 failed

View Details

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

Failures

request_payload.disable_geoip_omitted_defaults_to_false

Field 'geoip_disable' not found in /flags request body at path 'geoip_disable'. Available keys: ['distinct_id', 'groups', 'person_properties', 'group_properties', 'flag_keys_to_evaluate', 'token']

[github-actions]

posthog-ruby-async Compliance Report

Date: 2026-10-07T00:01:44.043467+00:00
Duration: 98233ms

⚠️ Some Tests Failed

46/47 tests passed, 1 failed

---

Capture Tests

✅ 30/30 tests passed

View Details

Test	Status	Duration
Format Validation.Event Has Required Fields	✅	107ms
Format Validation.Event Has Uuid	✅	106ms
Format Validation.Event Has Lib Properties	✅	108ms
Format Validation.Distinct Id Is String	✅	105ms
Format Validation.Token Is Present	✅	107ms
Format Validation.Custom Properties Preserved	✅	106ms
Format Validation.Event Has Timestamp	✅	107ms
Format Validation.Non Utc Event Timestamp Is Converted To Utc	✅	110ms
Retry Behavior.Retries On 503	✅	5311ms
Retry Behavior.Does Not Retry On 400	✅	2109ms
Retry Behavior.Does Not Retry On 401	✅	2108ms
Retry Behavior.Respects Retry After Header	✅	8116ms
Retry Behavior.Implements Backoff	✅	15612ms
Retry Behavior.Retries On 500	✅	5211ms
Retry Behavior.Retries On 502	✅	5212ms
Retry Behavior.Retries On 504	✅	5211ms
Retry Behavior.Max Retries Respected	✅	15523ms
Deduplication.Generates Unique Uuids	✅	114ms
Deduplication.Preserves Uuid On Retry	✅	5211ms
Deduplication.Preserves Uuid And Timestamp On Retry	✅	10316ms
Deduplication.Preserves Uuid And Timestamp On Batch Retry	✅	5213ms
Deduplication.No Duplicate Events In Batch	✅	110ms
Deduplication.Different Events Have Different Uuids	✅	106ms
Compression.Sends Gzip When Enabled	✅	106ms
Batch Format.Uses Proper Batch Structure	✅	105ms
Batch Format.Flush With No Events Sends Nothing	✅	3ms
Batch Format.Multiple Events Batched Together	✅	108ms
Error Handling.Does Not Retry On 403	✅	2107ms
Error Handling.Does Not Retry On 413	✅	2108ms
Error Handling.Retries On 408	✅	5212ms

Feature_Flags Tests

⚠️ 16/17 tests passed, 1 failed

View Details

Test	Status	Duration
Request Payload.Request With Person Properties Device Id	✅	109ms
Request Payload.Flags Request Uses V2 Query Param	✅	107ms
Request Payload.Flags Request Hits Flags Path Not Decide	✅	106ms
Request Payload.Flags Request Omits Authorization Header	✅	105ms
Request Payload.Token In Flags Body Matches Init	✅	105ms
Request Payload.Groups Round Trip	✅	106ms
Request Payload.Groups Default To Empty Object	✅	105ms
Request Payload.Disable Geoip False Propagates As Geoip Disable False	✅	105ms
Request Payload.Disable Geoip Omitted Defaults To False	❌	105ms
Request Payload.Flag Keys To Evaluate Contains Only Requested Key	✅	106ms
Request Lifecycle.No Flags Request On Init Alone	✅	3ms
Request Lifecycle.No Flags Request On Normal Capture	✅	104ms
Request Lifecycle.Two Flag Calls Produce Two Remote Requests	✅	109ms
Request Lifecycle.Mock Response Value Is Returned To Caller	✅	105ms
Retry Behavior.Retries Flags On 502	✅	207ms
Retry Behavior.Retries Flags On 504	✅	236ms
Side Effect Events.Get Feature Flag Captures Feature Flag Called Event	✅	108ms

Failures

request_payload.disable_geoip_omitted_defaults_to_false

Field 'geoip_disable' not found in /flags request body at path 'geoip_disable'. Available keys: ['distinct_id', 'groups', 'person_properties', 'group_properties', 'flag_keys_to_evaluate', 'token']