openfeature-sdk 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af657f35506e7f76184269c57877bbe87cb75f03a2e697e228e9b48f0b2bb17c
-  data.tar.gz: 57944d4c3a74838e73a1f55b4f06e9b82ec4b5186c76ad000577504b30d72d88
+  metadata.gz: ac3b2793c1b6453e2525dcc04d7646fd4e5d61a87e6ade8b257754cf9b9c991c
+  data.tar.gz: c5aeedfe23851ef99e26024bf1db5f4ba38d7f669b9ea6b3e1e5f63d0693c1a6
 SHA512:
-  metadata.gz: 8dc359e5bb318d79e2fcb48bc0c393c055578cf0a331b02bc61f82910b3da973eaf487457db80d9cd73f12303b15a77cbef9062481933c3d7b4c305de0ed1cc2
-  data.tar.gz: c733ce2f12dbd64ad9fd4e42a5c6cd17c805aa0ab746408c222aee42e6af5ba385ff92baf6cffbf79e4e949dbd7e6b5b2c67937694717ef5b41396353b9f9391
+  metadata.gz: 9aa41845c24248cf6eec381f4531fbfc301196ea748f3b3189333c4879c64a2dc1eda8a935e3514291dcbb5100c1668260e1b87bec837952e1eb1777ae083501
+  data.tar.gz: c162a21b0a5b4ee91f132e676440b84cf7862afccd689416f97e9b41f9284bf8b86de5050a1c32a3c98096ec39074cbb0ae1dcbe0d85d4db905d447f3baccd3d

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.6.0"
+  ".": "0.6.1"
 }

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [0.6.1](https://github.com/open-feature/ruby-sdk/compare/v0.6.0...v0.6.1) (2026-03-05)
+
+
+### Features
+
+* add flag metadata defaulting and immutability ([#221](https://github.com/open-feature/ruby-sdk/issues/221)) ([a300fc5](https://github.com/open-feature/ruby-sdk/commit/a300fc559293169f22eb1ce26f738cdee664cd26))
+* add hook data per-hook mutable state ([#222](https://github.com/open-feature/ruby-sdk/issues/222)) ([28518a0](https://github.com/open-feature/ruby-sdk/commit/28518a0e08143d167b9d34c86e57a583fe5ee0de))
+* add InMemoryProvider context callbacks and event emission ([#224](https://github.com/open-feature/ruby-sdk/issues/224)) ([0a148f6](https://github.com/open-feature/ruby-sdk/commit/0a148f66abc815fc2ec9fd70027075125dbd504a))
+* add shutdown API, provider status, and status short-circuit ([#223](https://github.com/open-feature/ruby-sdk/issues/223)) ([f9c32ad](https://github.com/open-feature/ruby-sdk/commit/f9c32ad1b467af25697423a542bc568597f39743))
+* implement Tracking API (spec section 6) ([#227](https://github.com/open-feature/ruby-sdk/issues/227)) ([5576fce](https://github.com/open-feature/ruby-sdk/commit/5576fce1c3bcf6e7510d8957c7e40e85c4b83b6f))
+* populate event details payload with error_code and message ([#225](https://github.com/open-feature/ruby-sdk/issues/225)) ([a185003](https://github.com/open-feature/ruby-sdk/commit/a185003dc09a69b2dda1fe569d1f82c45979cdad))
+
 ## [0.6.0](https://github.com/open-feature/ruby-sdk/compare/v0.5.1...v0.6.0) (2026-03-05)
 
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openfeature-sdk (0.6.0)
+    openfeature-sdk (0.6.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.6.0">
-    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.6.0&color=blue&style=for-the-badge" />
+  <a href="https://github.com/open-feature/ruby-sdk/releases/tag/v0.6.1">
+    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.6.1&color=blue&style=for-the-badge" />
   </a>
 
   <!-- x-release-please-end -->
@@ -100,13 +100,14 @@ object = client.fetch_object_value(flag_key: 'object_value', default_value: { na
 | ------ | --------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | ✅      | [Providers](#providers)                                             | Integrate with a commercial, open source, or in-house feature management tool.                                                                               |
 | ✅      | [Targeting](#targeting)                                             | Contextually-aware flag evaluation using [evaluation context](https://openfeature.dev/docs/reference/concepts/evaluation-context).                           |
-| ⚠️      | [Hooks](#hooks)                                                     | Add functionality to various stages of the flag evaluation life-cycle.                                                                                       |
+| ✅      | [Hooks](#hooks)                                                     | Add functionality to various stages of the flag evaluation life-cycle.                                                                                       |
 | ❌      | [Logging](#logging)                                                 | Integrate with popular logging packages.                                                                                                                     |
 | ✅      | [Domains](#domains)                                                 | Logically bind clients with providers.                                                                                                                       |
 | ✅      | [Eventing](#eventing)                                               | React to state changes in the provider or flag management system.                                                                                            |
-| ⚠️      | [Shutdown](#shutdown)                                               | Gracefully clean up a provider during application shutdown.                                                                                                  |
+| ✅      | [Shutdown](#shutdown)                                               | Gracefully clean up a provider during application shutdown.                                                                                                  |
+| ✅      | [Tracking](#tracking)                                               | Associate user actions with feature flag evaluations for experimentation.                                                                                    |
 | ❌      | [Transaction Context Propagation](#transaction-context-propagation) | Set a specific [evaluation context](https://openfeature.dev/docs/reference/concepts/evaluation-context) for a transaction (e.g. an HTTP request or a thread) |
-| ⚠️      | [Extending](#extending)                                             | Extend OpenFeature with custom providers and hooks.                                                                                                          |
+| ✅      | [Extending](#extending)                                             | Extend OpenFeature with custom providers and hooks.                                                                                                          |
 
 <sub>Implemented: ✅ | In-progress: ⚠️ | Not implemented yet: ❌</sub>
 
@@ -200,15 +201,49 @@ bool_value = client.fetch_boolean_value(
 
 ### Hooks
 
-Coming Soon! [Issue available](https://github.com/open-feature/ruby-sdk/issues/52) to be worked on.
-
-<!-- [Hooks](https://openfeature.dev/docs/reference/concepts/hooks) allow for custom logic to be added at well-defined points of the flag evaluation life-cycle.
+[Hooks](https://openfeature.dev/docs/reference/concepts/hooks) allow for custom logic to be added at well-defined points of the flag evaluation life-cycle.
 Look [here](https://openfeature.dev/ecosystem/?instant_search%5BrefinementList%5D%5Btype%5D%5B0%5D=Hook&instant_search%5BrefinementList%5D%5Btechnology%5D%5B0%5D=Ruby) for a complete list of available hooks.
 If the hook you're looking for hasn't been created yet, see the [develop a hook](#develop-a-hook) section to learn how to build it yourself.
 
-Once you've added a hook as a dependency, it can be registered at the global, client, or flag invocation level. -->
+Hooks can be registered at the global, client, or flag invocation level.
+
+```ruby
+# Define a hook
+class MyHook
+  include OpenFeature::SDK::Hooks::Hook
+
+  def before(hook_context:, hints:)
+    puts "Evaluating flag: #{hook_context.flag_key}"
+    nil
+  end
+
+  def after(hook_context:, evaluation_details:, hints:)
+    puts "Flag #{hook_context.flag_key} evaluated to: #{evaluation_details.value}"
+  end
+
+  def error(hook_context:, exception:, hints:)
+    puts "Error evaluating #{hook_context.flag_key}: #{exception.message}"
+  end
+
+  def finally(hook_context:, evaluation_details:, hints:)
+    puts "Evaluation complete for #{hook_context.flag_key}"
+  end
+end
+
+# Register at the API (global) level
+OpenFeature::SDK.hooks << MyHook.new
+
+# Register at the client level
+client = OpenFeature::SDK.build_client
+client.hooks << MyHook.new
 
-<!-- TODO: code example of setting hooks at all levels -->
+# Register at the invocation level
+client.fetch_boolean_value(
+  flag_key: "my-flag",
+  default_value: false,
+  hooks: [MyHook.new]
+)
+```
 
 ### Logging
 
@@ -276,19 +311,53 @@ OpenFeature::SDK.remove_handler(OpenFeature::SDK::ProviderEvent::PROVIDER_READY,
 
 ### Shutdown
 
-Coming Soon! [Issue available](https://github.com/open-feature/ruby-sdk/issues/149) to be worked on.
-
-<!-- TODO The OpenFeature API provides a close function to perform a cleanup of all registered providers.
+The OpenFeature API provides a `shutdown` method to perform cleanup of all registered providers.
 This should only be called when your application is in the process of shutting down.
 
+```ruby
+# Shut down all registered providers and clear state
+OpenFeature::SDK.shutdown
+```
+
+Individual providers can implement a `shutdown` method to perform cleanup:
+
 ```ruby
 class MyProvider
   def shutdown
     # Perform any shutdown/reclamation steps with flag management system here
-    # Return value is ignored
   end
 end
-``` -->
+```
+
+### Tracking
+
+The tracking API allows you to use OpenFeature abstractions and objects to associate user actions with feature flag evaluations.
+This is essential for robust experimentation powered by feature flags.
+For example, a flag enhancing the appearance of a UI component might drive user engagement to a new feature; to test this hypothesis, telemetry collected by a [hook](#hooks) or [provider](#providers) can be associated with telemetry reported in the client's `track` function.
+
+```ruby
+client = OpenFeature::SDK.build_client
+
+# Simple tracking event
+client.track("checkout_completed")
+
+# With evaluation context
+client.track(
+  "purchase",
+  evaluation_context: OpenFeature::SDK::EvaluationContext.new(targeting_key: "user-123")
+)
+
+# With tracking event details (optional numeric value + custom fields)
+details = OpenFeature::SDK::TrackingEventDetails.new(
+  value: 99.99,
+  plan: "premium",
+  currency: "USD"
+)
+client.track("subscription", tracking_event_details: details)
+```
+
+Note that some providers may not support tracking; if the provider does not implement a `track` method, the call is a no-op.
+Check the documentation for your [provider](#providers) for more information.
 
 ### Transaction Context Propagation
 
@@ -344,6 +413,12 @@ class MyProvider
   def fetch_object_value(flag_key:, default_value:, evaluation_context: nil)
     # Retrieve a hash value from provider source
   end
+
+  # Optional: implement tracking support (spec 6.1.4)
+  # If not defined, Client#track is a no-op
+  def track(tracking_event_name, evaluation_context:, tracking_event_details:)
+    # Record a tracking event with your flag management system
+  end
 end
 ```
 
@@ -351,17 +426,29 @@ end
 
 ### Develop a hook
 
-Coming Soon! [Issue available](https://github.com/open-feature/ruby-sdk/issues/52) to be worked on.
-
-<!-- To develop a hook, you need to create a new project and include the OpenFeature SDK as a dependency.
+To develop a hook, you need to create a new project and include the OpenFeature SDK as a dependency.
 This can be a new repository or included in [the existing contrib repository](https://github.com/open-feature/ruby-sdk-contrib) available under the OpenFeature organization.
-Implement your own hook by conforming to the `Hook interface`.
-To satisfy the interface, all methods (`Before`/`After`/`Finally`/`Error`) need to be defined.
-To avoid defining empty functions, make use of the `UnimplementedHook` struct (which already implements all the empty functions). -->
+Implement your own hook by including the `OpenFeature::SDK::Hooks::Hook` module.
+You only need to define the stages you care about — unimplemented stages are no-ops by default.
+
+```ruby
+class MyLoggingHook
+  include OpenFeature::SDK::Hooks::Hook
 
-<!-- TODO: code example of hook implementation -->
+  def before(hook_context:, hints:)
+    puts "Evaluating #{hook_context.flag_key}"
+    nil # Return nil or an EvaluationContext to merge
+  end
+
+  def after(hook_context:, evaluation_details:, hints:)
+    puts "Result: #{evaluation_details.value}"
+  end
+
+  # error and finally are optional — only define what you need
+end
+```
 
-<!-- > Built a new hook? [Let us know](https://github.com/open-feature/openfeature.dev/issues/new?assignees=&labels=hook&projects=&template=document-hook.yaml&title=%5BHook%5D%3A+) so we can add it to the docs! -->
+> Built a new hook? [Let us know](https://github.com/open-feature/openfeature.dev/issues/new?assignees=&labels=hook&projects=&template=document-hook.yaml&title=%5BHook%5D%3A+) so we can add it to the docs!
 
 <!-- x-hide-in-docs-start -->
 ## ⭐️ Support the project

data/lib/open_feature/sdk/api.rb

@@ -10,6 +10,7 @@ require_relative "evaluation_details"
 require_relative "client_metadata"
 require_relative "hooks"
 require_relative "client"
+require_relative "tracking_event_details"
 require_relative "provider"
 
 module OpenFeature
@@ -68,6 +69,10 @@ module OpenFeature
       def logger=(new_logger)
         configuration.logger = new_logger
       end
+
+      def shutdown
+        configuration.shutdown
+      end
     end
   end
 end

data/lib/open_feature/sdk/client.rb

@@ -28,6 +28,10 @@ module OpenFeature
         @hooks = []
       end
 
+      def provider_status
+        OpenFeature::SDK.configuration.provider_state(@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)
@@ -38,6 +42,22 @@ module OpenFeature
         OpenFeature::SDK.configuration.remove_client_handler(self, event_type, actual_handler)
       end
 
+      # Tracking API (spec 6.1.1.1) — dynamic-context paradigm
+      #
+      # Records a tracking event. If the provider does not implement
+      # tracking, this is a no-op (spec 6.1.4).
+      def track(tracking_event_name, evaluation_context: nil, tracking_event_details: nil)
+        return unless @provider.respond_to?(:track)
+
+        built_context = EvaluationContextBuilder.new.call(
+          api_context: OpenFeature::SDK.evaluation_context,
+          client_context: self.evaluation_context,
+          invocation_context: evaluation_context
+        )
+
+        @provider.track(tracking_event_name, evaluation_context: built_context, tracking_event_details: tracking_event_details)
+      end
+
       RESULT_TYPE.each do |result_type|
         SUFFIXES.each do |suffix|
           class_eval <<-RUBY, __FILE__, __LINE__ + 1
@@ -54,6 +74,18 @@ module OpenFeature
       def fetch_details(type:, flag_key:, default_value:, evaluation_context: nil, invocation_hooks: [], hook_hints: nil)
         validate_default_value_type(type, default_value)
 
+        if OpenFeature::SDK.configuration.provider_tracked?(@provider)
+          error_code = short_circuit_error_code(provider_status)
+          if error_code
+            resolution = Provider::ResolutionDetails.new(
+              value: default_value,
+              error_code: error_code,
+              reason: Provider::Reason::ERROR
+            )
+            return EvaluationDetails.new(flag_key: flag_key, resolution_details: resolution)
+          end
+        end
+
         built_context = EvaluationContextBuilder.new.call(
           api_context: OpenFeature::SDK.evaluation_context,
           client_context: self.evaluation_context,
@@ -109,6 +141,13 @@ module OpenFeature
         EvaluationDetails.new(flag_key: flag_key, resolution_details: resolution_details)
       end
 
+      def short_circuit_error_code(state)
+        case state
+        when ProviderState::NOT_READY then Provider::ErrorCode::PROVIDER_NOT_READY
+        when ProviderState::FATAL then Provider::ErrorCode::PROVIDER_FATAL
+        end
+      end
+
       def validate_default_value_type(type, default_value)
         expected_classes = TYPE_CLASS_MAP[type]
         unless expected_classes.any? { |klass| default_value.is_a?(klass) }

data/lib/open_feature/sdk/configuration.rb

@@ -76,6 +76,26 @@ module OpenFeature
         set_provider_internal(provider, domain: domain, wait_for_init: true)
       end
 
+      def provider_state(provider)
+        @provider_state_registry.get_state(provider)
+      end
+
+      def provider_tracked?(provider)
+        @provider_state_registry.tracked?(provider)
+      end
+
+      def shutdown
+        providers_to_shutdown = @provider_mutex.synchronize { @providers.values.uniq }
+
+        providers_to_shutdown.each do |prov|
+          prov.shutdown if prov.respond_to?(:shutdown)
+        rescue => e
+          @logger&.warn("Error shutting down provider #{prov&.class&.name || "unknown"}: #{e.message}")
+        end
+
+        reset
+      end
+
       private
 
       def reset
@@ -171,10 +191,6 @@ module OpenFeature
         run_handlers_for_provider(provider, event_type, event_details)
       end
 
-      def provider_state(provider)
-        @provider_state_registry.get_state(provider)
-      end
-
       private
 
       def extract_provider_name(provider)
@@ -219,8 +235,7 @@ module OpenFeature
             provider_state = @provider_state_registry.get_state(provider)
 
             if event_type == status_to_event[provider_state]
-              provider_name = extract_provider_name(provider)
-              event_details = {provider_name: provider_name}
+              event_details = build_event_details(provider)
 
               begin
                 handler.call(event_details)
@@ -237,8 +252,7 @@ module OpenFeature
           provider_state = @provider_state_registry.get_state(client_provider)
 
           if event_type == status_to_event[provider_state]
-            provider_name = extract_provider_name(client_provider)
-            event_details = {provider_name: provider_name}
+            event_details = build_event_details(client_provider)
 
             begin
               handler.call(event_details)
@@ -248,6 +262,11 @@ module OpenFeature
           end
         end
       end
+
+      def build_event_details(provider)
+        stored_details = @provider_state_registry.get_details(provider)
+        {provider_name: extract_provider_name(provider)}.merge(stored_details)
+      end
     end
   end
 end

data/lib/open_feature/sdk/hooks/hook_context.rb

@@ -22,6 +22,14 @@ module OpenFeature
           @evaluation_context = evaluation_context
           @client_metadata = client_metadata
           @provider_metadata = provider_metadata
+          @hook_data = {}
+        end
+
+        # Returns a mutable hash scoped to the given hook instance.
+        # The same hash is returned across all hook stages (before, after, error, finally),
+        # allowing hooks to share state across their lifecycle (spec 4.1.5, 4.6.1).
+        def hook_data_for(hook)
+          @hook_data[hook.object_id] ||= {}
         end
       end
     end

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

@@ -3,8 +3,9 @@
 module OpenFeature
   module SDK
     module Provider
-      # TODO: Add evaluation context support
       class InMemoryProvider
+        include Provider::EventEmitter
+
         NAME = "In-memory Provider"
 
         attr_reader :metadata
@@ -24,7 +25,12 @@ module OpenFeature
 
         def add_flag(flag_key:, value:)
           flags[flag_key] = value
-          # TODO: Emit PROVIDER_CONFIGURATION_CHANGED event once events are implemented
+          emit_provider_changed([flag_key])
+        end
+
+        def update_flags(new_flags)
+          @flags = new_flags.dup
+          emit_provider_changed(new_flags.keys)
         end
 
         def fetch_boolean_value(flag_key:, default_value:, evaluation_context: nil)
@@ -56,13 +62,24 @@ module OpenFeature
         attr_reader :flags
 
         def fetch_value(flag_key:, default_value:, evaluation_context:)
-          value = flags[flag_key]
+          raw_value = flags[flag_key]
 
-          if value.nil?
+          if raw_value.nil?
             return ResolutionDetails.new(value: default_value, error_code: ErrorCode::FLAG_NOT_FOUND, reason: Reason::ERROR)
           end
 
-          ResolutionDetails.new(value:, reason: Reason::STATIC)
+          if raw_value.respond_to?(:call)
+            value = raw_value.call(evaluation_context)
+            ResolutionDetails.new(value: value, reason: Reason::TARGETING_MATCH)
+          else
+            ResolutionDetails.new(value: raw_value, reason: Reason::STATIC)
+          end
+        end
+
+        def emit_provider_changed(flag_keys)
+          return unless configuration_attached?
+
+          emit_event(ProviderEvent::PROVIDER_CONFIGURATION_CHANGED, flags_changed: flag_keys)
         end
       end
     end

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

@@ -3,7 +3,20 @@
 module OpenFeature
   module SDK
     module Provider
-      ResolutionDetails = Struct.new(:value, :reason, :variant, :error_code, :error_message, :flag_metadata, keyword_init: true)
+      EMPTY_FLAG_METADATA = {}.freeze
+
+      ResolutionDetails = Struct.new(:value, :reason, :variant, :error_code, :error_message, :flag_metadata, keyword_init: true) do
+        def flag_metadata
+          raw = self[:flag_metadata]
+          if raw.nil?
+            EMPTY_FLAG_METADATA
+          elsif raw.frozen?
+            raw
+          else
+            raw.dup.freeze
+          end
+        end
+      end
     end
   end
 end

data/lib/open_feature/sdk/provider_state_registry.rb

@@ -17,7 +17,7 @@ module OpenFeature
         return unless provider
 
         @mutex.synchronize do
-          @states[provider.object_id] = state
+          @states[provider.object_id] = {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] = new_state
+            @states[provider.object_id] = {state: new_state, details: event_details || {}}
           end
           new_state
         else
@@ -42,7 +42,17 @@ module OpenFeature
         return ProviderState::NOT_READY unless provider
 
         @mutex.synchronize do
-          @states[provider.object_id] || ProviderState::NOT_READY
+          entry = @states[provider.object_id]
+          entry ? entry[:state] : ProviderState::NOT_READY
+        end
+      end
+
+      def get_details(provider)
+        return {} unless provider
+
+        @mutex.synchronize do
+          entry = @states[provider.object_id]
+          entry ? entry[:details] : {}
         end
       end
 
@@ -54,6 +64,14 @@ module OpenFeature
         end
       end
 
+      def tracked?(provider)
+        return false unless provider
+
+        @mutex.synchronize do
+          @states.key?(provider.object_id)
+        end
+      end
+
       def ready?(provider)
         get_state(provider) == ProviderState::READY
       end

data/lib/open_feature/sdk/tracking_event_details.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module OpenFeature
+  module SDK
+    # Represents tracking event details per spec section 6.2.
+    #
+    # Requirement 6.2.1: MUST define an optional numeric value.
+    # Requirement 6.2.2: MUST support custom fields (string keys,
+    # boolean/string/number/structure values).
+    class TrackingEventDetails
+      attr_reader :value, :fields
+
+      def initialize(value: nil, **fields)
+        if !value.nil? && !value.is_a?(Numeric)
+          raise ArgumentError, "Tracking event value must be Numeric, got #{value.class}"
+        end
+
+        @value = value
+        @fields = fields.transform_keys(&:to_s)
+      end
+    end
+  end
+end

data/lib/open_feature/sdk/version.rb

@@ -2,6 +2,6 @@
 
 module OpenFeature
   module SDK
-    VERSION = "0.6.0"
+    VERSION = "0.6.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openfeature-sdk
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - OpenFeature Authors
@@ -185,6 +185,7 @@ files:
 - lib/open_feature/sdk/provider_initialization_error.rb
 - lib/open_feature/sdk/provider_state.rb
 - lib/open_feature/sdk/provider_state_registry.rb
+- lib/open_feature/sdk/tracking_event_details.rb
 - lib/open_feature/sdk/version.rb
 - release-please-config.json
 - renovate.json