openfeature-sdk 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b8b6e8a5fd01205278fa44c809eb3c1ef578b56e5542aa94793a090e605458d
-  data.tar.gz: f85c7d0e8b804fb651e02cc3c59d14c21458f9fdb419d58df6d8fbb714a35b9b
+  metadata.gz: bf1041c34e962f832b25f1be3e9eeab7fee3fd4272dc9e1e0e8dabe85b6d21e8
+  data.tar.gz: f45667a6a898d3521ea87c31aea62491ace0682c72ef2cfa2a16d5f8a0f3f0b5
 SHA512:
-  metadata.gz: a7fef199498fb02863ed74cf76a6fbff8acf65df23e2e5d4baad90b6ed3da589b6ca98da1540443a7367456a527819eb2380979aa4f1a1ef8780c33ccf425d32
-  data.tar.gz: 71db2db0d85592861ebd5f117d7599e9d54374deb9a6eae5060716044abddb27a4bd10db7ca07314540a36adeb7c366afa1a8c21fb4f19824e05e15fd59a1a27
+  metadata.gz: 393adb8b637763e5b397f6ee702017705bf355c8785ceb1280aa4f95b585a061f8da6e4a6d67ed9e8ab20de1f341b36d4dc3febb38dbbcc7a41a68cfb8002b8c
+  data.tar.gz: d145cc98fb609aa75ad06485d4486cc6aec19ea953cd627f9f71b33e991fafd3a57fa139fbe07f878e5bc105885ce35a74c0ab12485e50649d63b79a100eec98

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.7.0"
+  ".": "0.7.1"
 }

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [0.7.1](https://github.com/open-feature/ruby-sdk/compare/v0.7.0...v0.7.1) (2026-10-23)
+
+
+### Features
+
+* isolated API instances ([#354](https://github.com/open-feature/ruby-sdk/issues/354)) ([1c92b4a](https://github.com/open-feature/ruby-sdk/commit/1c92b4ad7550a6b345e7471f84cd5a7ff445591e))
+
+
+### Bug Fixes
+
+* key provider state by identity, default the NoOp reason, freeze client metadata ([#355](https://github.com/open-feature/ruby-sdk/issues/355)) ([d15bd84](https://github.com/open-feature/ruby-sdk/commit/d15bd84e1456b6200e29c12c3463c4f8ddfe693f))
+
 ## [0.7.0](https://github.com/open-feature/ruby-sdk/compare/v0.6.7...v0.7.0) (2026-10-23)
 
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openfeature-sdk (0.7.0)
+    openfeature-sdk (0.7.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -17,8 +17,8 @@
   </a>
   <!-- x-release-please-start-version -->
 
-  <a href="https://github.com/open-feature/ruby-sdk/releases/tag/v0.7.0">
-    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.7.0&color=blue&style=for-the-badge" />
+  <a href="https://github.com/open-feature/ruby-sdk/releases/tag/v0.7.1">
+    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.7.1&color=blue&style=for-the-badge" />
   </a>
 
   <!-- x-release-please-end -->
@@ -443,6 +443,29 @@ class MyRequestScopedPropagator
 end
 ```
 
+### Isolated API instances
+
+`OpenFeature::SDK` is a global singleton. Some applications need more than one independent API in a process, for example separately developed modules that each need their own provider, or tests that run in parallel. Require the factory explicitly to create one:
+
+```ruby
+require "open_feature/sdk/isolated"
+
+api = OpenFeature::SDK::Isolated.create_api
+api.set_provider_and_wait(MyProvider.new)
+client = api.build_client
+client.fetch_boolean_value(flag_key: "my-flag", default_value: false)
+```
+
+Each instance has its own providers, hooks, evaluation context, event handlers, transaction context propagator and `shutdown`, and shares none of them with `OpenFeature::SDK` or other instances.
+Build its clients with `api.build_client`; `OpenFeature::SDK::Client.new` binds to the global API.
+Prefer the global API unless you need this.
+
+A provider instance should be registered with only one API at a time.
+Registering a provider that includes `OpenFeature::SDK::Provider::EventEmitter` with a second API raises `ArgumentError`; other providers can't be detected.
+Once the first API replaces the provider or shuts down, it can be registered with another.
+
+A `LoggingHook` created without `logger:` logs to the global API's logger, even when added to an isolated API. Pass `logger:` to use another.
+
 ## Extending
 
 ### Develop a provider

data/lib/open_feature/sdk/api.rb

@@ -32,13 +32,15 @@ module OpenFeature
     #
     #   client = OpenFeature::SDK::API.instance.build_client(name: 'my-open-feature-client')
     class API
-      include Singleton # Satisfies Flag Evaluation API Requirement 1.1.1
+      include Singleton # Satisfies Flag Evaluation API Requirement 1.1.1; Isolated.create_api builds others (1.8.1)
       extend Forwardable
 
       def_delegators :configuration, :provider, :set_provider, :set_provider_and_wait, :hooks, :add_hooks, :evaluation_context
 
-      def configuration
-        @configuration ||= Configuration.new
+      attr_reader :configuration
+
+      def initialize
+        @configuration = Configuration.new
       end
 
       def configure(&block)
@@ -48,7 +50,7 @@ module OpenFeature
       end
 
       def build_client(domain: nil, evaluation_context: nil)
-        Client.new(domain:, evaluation_context:)
+        Client.new(domain:, evaluation_context:, configuration:)
       end
 
       def provider_metadata(domain: nil)

data/lib/open_feature/sdk/client.rb

@@ -21,8 +21,9 @@ module OpenFeature
 
       attr_accessor :hooks, :evaluation_context
 
-      def initialize(provider: nil, domain: nil, evaluation_context: nil)
+      def initialize(provider: nil, domain: nil, evaluation_context: nil, configuration: API.instance.configuration)
         @provider = provider
+        @configuration = configuration
         @metadata = ClientMetadata.new(domain:)
         @evaluation_context = evaluation_context
         @hooks = []
@@ -33,17 +34,17 @@ module OpenFeature
       end
 
       def provider_status
-        OpenFeature::SDK.configuration.provider_state(resolve_provider)
+        @configuration.provider_state(resolve_provider)
       end
 
       def add_handler(event_type, handler = nil, &block)
         actual_handler = handler || block
-        OpenFeature::SDK.configuration.add_client_handler(self, event_type, actual_handler)
+        @configuration.add_client_handler(self, event_type, actual_handler)
       end
 
       def remove_handler(event_type, handler = nil, &block)
         actual_handler = handler || block
-        OpenFeature::SDK.configuration.remove_client_handler(self, event_type, actual_handler)
+        @configuration.remove_client_handler(self, event_type, actual_handler)
       end
 
       # Tracking API (spec 6.1.1.1) — dynamic-context paradigm
@@ -81,13 +82,13 @@ module OpenFeature
 
         # Assemble ordered hooks: API → Client → Invocation → Provider (spec 4.4.2)
         provider_hooks = provider.respond_to?(:hooks) ? Array(provider.hooks) : []
-        ordered_hooks = [*OpenFeature::SDK.hooks, *@hooks, *invocation_hooks, *provider_hooks]
+        ordered_hooks = [*@configuration.hooks, *@hooks, *invocation_hooks, *provider_hooks]
 
         # Short-circuit NOT_READY/FATAL providers (required by evaluation_v2.feature). A provider resolved from the
         # configuration is tracked while bound, so one that isn't was replaced mid-call and reads NOT_READY.
         short_circuit_code = nil
-        if @provider ? OpenFeature::SDK.configuration.provider_tracked?(provider) : !provider.equal?(@fallback_provider)
-          short_circuit_code = short_circuit_error_code(OpenFeature::SDK.configuration.provider_state(provider))
+        if @provider ? @configuration.provider_tracked?(provider) : !provider.equal?(@fallback_provider)
+          short_circuit_code = short_circuit_error_code(@configuration.provider_state(provider))
         end
 
         # Fast path: skip hook ceremony when no hooks are registered
@@ -121,7 +122,7 @@ module OpenFeature
           EMPTY_HINTS
         end
 
-        executor = Hooks::HookExecutor.new(logger: OpenFeature::SDK.configuration.logger)
+        executor = Hooks::HookExecutor.new(logger: @configuration.logger)
 
         if short_circuit_code
           resolution = Provider::ResolutionDetails.new(
@@ -169,7 +170,7 @@ module OpenFeature
       # Callers resolve once per operation, so a rebinding mid-evaluation can't mix two providers.
       # The fallback NoOp is never registered: untracked, so not short-circuited, and its status reads NOT_READY.
       def resolve_provider
-        @provider || OpenFeature::SDK.configuration.provider(domain: @metadata.domain) || (@fallback_provider ||= Provider::NoOpProvider.new)
+        @provider || @configuration.provider(domain: @metadata.domain) || (@fallback_provider ||= Provider::NoOpProvider.new)
       end
 
       def short_circuit_error_code(state)
@@ -180,11 +181,11 @@ module OpenFeature
       end
 
       def build_evaluation_context(invocation_context)
-        propagator = OpenFeature::SDK.configuration.transaction_context_propagator
+        propagator = @configuration.transaction_context_propagator
         transaction_context = propagator&.get_transaction_context
 
         EvaluationContextBuilder.new.call(
-          api_context: OpenFeature::SDK.evaluation_context,
+          api_context: @configuration.evaluation_context,
           transaction_context: transaction_context,
           client_context: evaluation_context,
           invocation_context: invocation_context

data/lib/open_feature/sdk/client_metadata.rb

@@ -4,6 +4,11 @@ module OpenFeature
   module SDK
     ClientMetadata = Struct.new(:domain, keyword_init: true) do
       alias_method :name, :domain
+
+      def initialize(domain: nil)
+        super(domain: domain&.dup&.freeze)
+        freeze
+      end
     end
   end
 end

data/lib/open_feature/sdk/configuration.rb

@@ -162,9 +162,10 @@ module OpenFeature
           needs_init = attempt.nil? || attempt.state == :failed
 
           if needs_init
+            # First, so a provider registered with another API (1.8.4) leaves no state behind
+            provider.send(:attach, self) if provider.is_a?(Provider::EventEmitter)
             attempt = @init_attempts[provider] = InitAttempt.new(:running, nil, Thread::Queue.new)
             @provider_state_registry.set_initial_state(provider)
-            provider.send(:attach, self) if provider.is_a?(Provider::EventEmitter)
           end
 
           # Publish last: clients read @providers without the lock, and must not see an untracked provider
@@ -219,7 +220,7 @@ module OpenFeature
         end
       ensure
         # Fail an attempt no init took over (e.g. a Timeout hit first), or it would stay running forever
-        finish_init_attempt(attempt, :failed) if needs_init && !init_thread
+        finish_init_attempt(attempt, :failed) if needs_init && attempt && !init_thread
       end
 
       def init_provider(provider, context, domain:, attempt:, raise_on_error: false)

data/lib/open_feature/sdk/isolated.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "../sdk"
+
+module OpenFeature
+  module SDK
+    # Spec 1.8.3: a separate require, so isolated instances are an explicit opt-in
+    module Isolated
+      # Spec 1.8.1: a new API that shares no state with the global one or other isolated APIs
+      def self.create_api
+        API.send(:new)
+      end
+    end
+  end
+end

data/lib/open_feature/sdk/provider/event_emitter.rb

@@ -8,7 +8,7 @@ module OpenFeature
       # Mixin for providers that emit lifecycle events
       module EventEmitter
         def emit_event(event_type, details = {})
-          config = @configuration
+          config = @openfeature_configuration
           return unless config
 
           unless ::OpenFeature::SDK::ProviderEvent::ALL_EVENTS.include?(event_type)
@@ -19,17 +19,22 @@ module OpenFeature
         end
 
         def configuration_attached?
-          !@configuration.nil?
+          !@openfeature_configuration.nil?
         end
 
         private
 
         def attach(configuration)
-          @configuration = configuration
+          # Spec 1.8.4: only providers using this mixin know which API they're registered with
+          if @openfeature_configuration && !@openfeature_configuration.equal?(configuration)
+            raise ArgumentError, "Provider is already registered with another OpenFeature API instance"
+          end
+
+          @openfeature_configuration = configuration
         end
 
         def detach
-          @configuration = nil
+          @openfeature_configuration = nil
         end
       end
     end

data/lib/open_feature/sdk/provider/no_op_provider.rb

@@ -23,7 +23,7 @@ module OpenFeature
       # * <tt>fetch_object_value</tt> - Retrieve feature flag object value
       #
       class NoOpProvider
-        REASON_NO_OP = "No-op"
+        REASON_NO_OP = Reason::DEFAULT
         NAME = "No-op Provider"
 
         attr_reader :metadata

data/lib/open_feature/sdk/provider_initialization_error.rb

@@ -21,8 +21,8 @@ module OpenFeature
       # @param message [String] the error message
       # @param provider [Object] the provider that failed to initialize
       # @param original_error [Exception] the original error that caused the failure
-      # @param error_code [String] the OpenFeature error code (defaults to PROVIDER_FATAL)
-      def initialize(message, provider: nil, original_error: nil, error_code: Provider::ErrorCode::PROVIDER_FATAL)
+      # @param error_code [String] the OpenFeature error code (defaults to GENERAL)
+      def initialize(message, provider: nil, original_error: nil, error_code: Provider::ErrorCode::GENERAL)
         super(message)
         @provider = provider
         @original_error = original_error

data/lib/open_feature/sdk/provider_state_registry.rb

@@ -9,7 +9,7 @@ module OpenFeature
     # Tracks provider states
     class ProviderStateRegistry
       def initialize
-        @states = {}
+        @states = {}.compare_by_identity
         @mutex = Mutex.new
       end
 
@@ -17,7 +17,7 @@ module OpenFeature
         return unless provider
 
         @mutex.synchronize do
-          @states[provider.object_id] = {state: state, details: {}}
+          @states[provider] = {state: state, details: {}}
         end
       end
 
@@ -29,7 +29,7 @@ module OpenFeature
         # Only update state if the event should cause a state change
         if new_state
           @mutex.synchronize do
-            @states[provider.object_id] = {state: new_state, details: event_details || {}}
+            @states[provider] = {state: new_state, details: event_details || {}}
           end
           new_state
         else
@@ -42,7 +42,7 @@ module OpenFeature
         return ProviderState::NOT_READY unless provider
 
         @mutex.synchronize do
-          entry = @states[provider.object_id]
+          entry = @states[provider]
           entry ? entry[:state] : ProviderState::NOT_READY
         end
       end
@@ -51,7 +51,7 @@ module OpenFeature
         return {} unless provider
 
         @mutex.synchronize do
-          entry = @states[provider.object_id]
+          entry = @states[provider]
           entry ? entry[:details] : {}
         end
       end
@@ -60,7 +60,7 @@ module OpenFeature
         return unless provider
 
         @mutex.synchronize do
-          @states.delete(provider.object_id)
+          @states.delete(provider)
         end
       end
 
@@ -68,7 +68,7 @@ module OpenFeature
         return false unless provider
 
         @mutex.synchronize do
-          @states.key?(provider.object_id)
+          @states.key?(provider)
         end
       end
 

data/lib/open_feature/sdk/thread_local_transaction_context_propagator.rb

@@ -5,14 +5,19 @@ module OpenFeature
     class ThreadLocalTransactionContextPropagator
       include TransactionContextPropagator
 
+      # One context per propagator under this key, so separate APIs never share one (spec 1.8.2)
+      # while resetting the key still clears them all. Weak keys let discarded propagators be collected.
       THREAD_KEY = :openfeature_transaction_context
 
       def set_transaction_context(evaluation_context)
-        Thread.current[THREAD_KEY] = evaluation_context
+        contexts = Thread.current[THREAD_KEY]
+        contexts = Thread.current[THREAD_KEY] = ObjectSpace::WeakKeyMap.new unless contexts.is_a?(ObjectSpace::WeakKeyMap)
+        evaluation_context.nil? ? contexts.delete(self) : contexts[self] = evaluation_context
       end
 
       def get_transaction_context
-        Thread.current[THREAD_KEY]
+        contexts = Thread.current[THREAD_KEY]
+        contexts[self] if contexts.is_a?(ObjectSpace::WeakKeyMap)
       end
     end
   end

data/lib/open_feature/sdk/version.rb

@@ -2,6 +2,6 @@
 
 module OpenFeature
   module SDK
-    VERSION = "0.7.0"
+    VERSION = "0.7.1"
   end
 end

data/sig/open_feature/sdk/api.rbs

@@ -1,10 +1,13 @@
 module OpenFeature
   module SDK
     class API
-      include Singleton
       extend Forwardable
 
-      def configuration: () -> Configuration
+      include Singleton
+
+      attr_reader configuration: Configuration
+
+      def initialize: () -> void
 
       def configure: () { (Configuration) -> void } -> void
 

data/sig/open_feature/sdk/client.rbs

@@ -10,7 +10,7 @@ module OpenFeature
       attr_accessor evaluation_context: EvaluationContext?
       attr_accessor hooks: Array[untyped]
 
-      def initialize: (?provider: untyped, ?domain: String?, ?evaluation_context: EvaluationContext?) -> void
+      def initialize: (?provider: untyped, ?domain: String?, ?evaluation_context: EvaluationContext?, ?configuration: Configuration) -> void
 
       def add_hooks: (*Array[untyped] new_hooks) -> void
 

data/sig/open_feature/sdk/isolated.rbs

@@ -0,0 +1,7 @@
+module OpenFeature
+  module SDK
+    module Isolated
+      def self.create_api: () -> API
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openfeature-sdk
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - OpenFeature Authors
@@ -55,6 +55,7 @@ files:
 - lib/open_feature/sdk/hooks/hook_context.rb
 - lib/open_feature/sdk/hooks/hook_executor.rb
 - lib/open_feature/sdk/hooks/logging_hook.rb
+- lib/open_feature/sdk/isolated.rb
 - lib/open_feature/sdk/provider.rb
 - lib/open_feature/sdk/provider/error_code.rb
 - lib/open_feature/sdk/provider/event_emitter.rb
@@ -92,6 +93,7 @@ files:
 - sig/open_feature/sdk/hooks/hook_context.rbs
 - sig/open_feature/sdk/hooks/hook_executor.rbs
 - sig/open_feature/sdk/hooks/logging_hook.rbs
+- sig/open_feature/sdk/isolated.rbs
 - sig/open_feature/sdk/provider.rbs
 - sig/open_feature/sdk/provider/error_code.rbs
 - sig/open_feature/sdk/provider/event_emitter.rbs