Ruby: Add OpenFeature provider by msiebert · Pull Request #132 · mixpanel/mixpanel-ruby

msiebert · 2026-03-19T18:44:55Z

Summary

Adds an OpenFeature-compatible provider as a separate gem (mixpanel-openfeature) in the openfeature-provider/ directory
Wraps either LocalFlagsProvider or RemoteFlagsProvider via a single Mixpanel::OpenFeature::Provider class
Implements the OpenFeature Ruby SDK duck-type interface: fetch_boolean_value, fetch_string_value, fetch_number_value, fetch_integer_value, fetch_float_value, fetch_object_value

Design decisions

Identity check for flag-not-found detection: passes a fallback SelectedVariant to get_variant and uses equal? (object identity) to detect when the flag was not found
Reason codes: STATIC for successful evaluations, ERROR for all failure cases
Error codes: PROVIDER_NOT_READY, FLAG_NOT_FOUND, TYPE_MISMATCH
Variant key passthrough: successful resolutions include variant: result.variant_key in ResolutionDetails
Context forwarding: evaluation_context is converted and forwarded to get_variant
Provider readiness: uses respond_to?(:are_flags_ready) so remote providers are treated as always ready
Type coercion: float-to-int when no fractional part, int-to-float promotion
shutdown is a no-op: Mixpanel SDK manages its own lifecycle
targetingKey has no special meaning: included in context as a regular property

Test coverage

37 RSpec tests covering all 6 flag types, type coercion, all 3 error codes, variant key passthrough, context forwarding, remote provider readiness, lifecycle, and metadata.

Test plan

bundle exec rspec spec/ — 37 examples, 0 failures

Generated with Claude Code

Implement an OpenFeature-compatible provider as a separate gem (mixpanel-openfeature) that wraps the existing Mixpanel flags providers. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

codecov · 2026-03-19T18:46:27Z

Codecov Report

❌ Patch coverage is 98.19820% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 96.64%. Comparing base (a3020d2) to head (a4c48c9).
⚠️ Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
lib/mixpanel-ruby/flags/flags_provider.rb	83.33%	1 Missing ⚠️
lib/mixpanel-ruby/flags/local_flags_provider.rb	94.11%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #132      +/-   ##
==========================================
+ Coverage   96.29%   96.64%   +0.34%     
==========================================
  Files          12       14       +2     
  Lines         567      655      +88     
==========================================
+ Hits          546      633      +87     
- Misses         21       22       +1

Flag	Coverage Δ
openfeature	`100.00% <100.00%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Adds begin/rescue for SDK exceptions in provider, plus tests for exception handling and null variant key behavior. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Use camelCase 'targetingKey' instead of snake_case 'targeting_key' to match the key name Java and Go SDKs receive from their OpenFeature SDKs' built-in flattening. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

- shutdown now delegates to underlying flags provider - Add shutdown to FlagsProvider (no-op) and LocalFlagsProvider (stops polling) - Explicitly pass report_exposure: true to get_variant - Add context value unwrapping with whole-number float→int conversion Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Fix bug where ServerError was incorrectly caught and re-raised as ConnectionError in call_flags_endpoint. Use dig for nested hash access, each_with_object for hash construction, map(&:dup), and simplified conditionals throughout. Simplify boolean type check and make number case consistent in provider. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Add nil guard for typed resolutions to return TYPE_MISMATCH instead of passing nil through. Update mock signatures to capture report_exposure keyword arg. Add exposure reporting verification test. Strengthen shutdown test to verify delegation. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Required by repo policy — all actions must use full-length commit SHAs instead of version tags. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Aligns with the convention used by other SDKs (e.g. mixpanel-java-openfeature-provider) where the language name is included in the package name. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Runs the openfeature-provider test suite as a separate job across all Ruby versions to ensure the provider is tested in CI. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

openfeature-sdk 0.5.1 requires Ruby >= 3.1, so Ruby 3.0 is no longer compatible. Update the gemspec and remove 3.0 from the CI matrix. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Add SimpleCov with Cobertura output to the openfeature-provider test suite and upload coverage from the test-openfeature CI job. This lets Codecov merge coverage from both test suites, fixing the patch/project coverage check failures. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Provider.from_local and Provider.from_remote accept a token and config, create the Tracker internally, auto-start polling for local configs, and expose the tracker via the mixpanel attr_reader. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

.github/workflows/ruby.yml

efahk · 2026-04-07T17:40:08Z

lib/mixpanel-ruby/flags/flags_provider.rb

      # @param selected_variant [SelectedVariant] The selected variant
      # @param context [Hash] User context (must include 'distinct_id')
      # @param latency_ms [Integer, nil] Optional latency in milliseconds
+      def shutdown; end


The param comments got separated from the track_exposure_event call

oh lol, whoops

lib/mixpanel-ruby/flags/local_flags_provider.rb

openfeature-provider/lib/mixpanel/openfeature/provider.rb

Move shutdown method above track_exposure_event doc comments to fix separated param annotations. Revert @flag_definitions assignment to use a local variable for GIL-safe concurrent reads. Add tests for from_local/from_remote factory methods and complex context type unwrapping (floats, arrays, nested hashes) to reach 100% coverage. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

…found Address review feedback: successful flag evaluations now return TARGETING_MATCH reason instead of STATIC, and FLAG_NOT_FOUND returns DEFAULT reason instead of ERROR. Also adds error_handler parameter to from_local and from_remote factory methods. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

The OpenFeature provider depends on shutdown methods and error handling fixes added after the 3.0.0 release. Bump the main SDK version and tighten the provider's dependency constraint to ~> 3.1. Add release ordering documentation. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Add OpenFeature provider for Mixpanel Ruby SDK

c617140

Implement an OpenFeature-compatible provider as a separate gem (mixpanel-openfeature) that wraps the existing Mixpanel flags providers. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

msiebert self-assigned this Mar 19, 2026

msiebert and others added 3 commits March 20, 2026 11:05

Add missing OpenFeature provider tests and SDK exception handling

6e3cac9

Adds begin/rescue for SDK exceptions in provider, plus tests for exception handling and null variant key behavior. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Fix targetingKey casing in OpenFeature context passthrough

879abb5

Use camelCase 'targetingKey' instead of snake_case 'targeting_key' to match the key name Java and Go SDKs receive from their OpenFeature SDKs' built-in flattening. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

msiebert changed the title ~~Add OpenFeature provider~~ Ruby: Add OpenFeature provider Mar 31, 2026

msiebert and others added 4 commits April 1, 2026 12:49

Pin GitHub Actions to full commit SHAs

5b9d0f6

Required by repo policy — all actions must use full-length commit SHAs instead of version tags. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Rename gem from mixpanel-openfeature to mixpanel-ruby-openfeature

d4dd3ec

Aligns with the convention used by other SDKs (e.g. mixpanel-java-openfeature-provider) where the language name is included in the package name. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

msiebert requested a review from efahk April 2, 2026 22:25

msiebert marked this pull request as ready for review April 2, 2026 22:25

msiebert requested review from a team and jaredmixpanel April 2, 2026 22:25

msiebert and others added 4 commits April 2, 2026 15:34

Add OpenFeature provider tests to CI workflow

2b579be

Runs the openfeature-provider test suite as a separate job across all Ruby versions to ensure the provider is tested in CI. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Bump minimum Ruby to 3.1 for OpenFeature provider

a05866d

openfeature-sdk 0.5.1 requires Ruby >= 3.1, so Ruby 3.0 is no longer compatible. Update the gemspec and remove 3.0 from the CI matrix. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

efahk approved these changes Apr 7, 2026

View reviewed changes

efahk reviewed Apr 7, 2026

View reviewed changes

lib/mixpanel-ruby/flags/local_flags_provider.rb Outdated Show resolved Hide resolved

efahk reviewed Apr 7, 2026

View reviewed changes

openfeature-provider/lib/mixpanel/openfeature/provider.rb Outdated Show resolved Hide resolved

openfeature-provider/lib/mixpanel/openfeature/provider.rb Outdated Show resolved Hide resolved

msiebert and others added 2 commits April 7, 2026 11:09

jaredmixpanel approved these changes Apr 9, 2026

View reviewed changes

msiebert and others added 3 commits April 9, 2026 14:16

Add README for OpenFeature provider

51b3a1d

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Add release documentation for OpenFeature provider

020f4ed

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

msiebert merged commit a780e93 into master Apr 9, 2026
14 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ruby: Add OpenFeature provider#132

Ruby: Add OpenFeature provider#132
msiebert merged 17 commits intomasterfrom
msiebert-openfeature-provider

msiebert commented Mar 19, 2026

Uh oh!

codecov bot commented Mar 19, 2026 •

edited

Loading

Uh oh!

Uh oh!

efahk Apr 7, 2026

Uh oh!

msiebert Apr 7, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

msiebert commented Mar 19, 2026

Summary

Design decisions

Test coverage

Test plan

Uh oh!

codecov bot commented Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

efahk Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

msiebert Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Mar 19, 2026 •

edited

Loading