openfeature-sdk 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf1041c34e962f832b25f1be3e9eeab7fee3fd4272dc9e1e0e8dabe85b6d21e8
-  data.tar.gz: f45667a6a898d3521ea87c31aea62491ace0682c72ef2cfa2a16d5f8a0f3f0b5
+  metadata.gz: a637edf0b0a85dbfbaf655066912a64a21c1cd4a467b4fe557208c10184df3a9
+  data.tar.gz: 6fa0f3f6e534279a8e1b6296e1e8b524decd315c99e4bc6238575f3867a8a428
 SHA512:
-  metadata.gz: 393adb8b637763e5b397f6ee702017705bf355c8785ceb1280aa4f95b585a061f8da6e4a6d67ed9e8ab20de1f341b36d4dc3febb38dbbcc7a41a68cfb8002b8c
-  data.tar.gz: d145cc98fb609aa75ad06485d4486cc6aec19ea953cd627f9f71b33e991fafd3a57fa139fbe07f878e5bc105885ce35a74c0ab12485e50649d63b79a100eec98
+  metadata.gz: d16e851abe52d3bbbac68aa9180a9c1ace7b7cf97ce3508c21e083d7780825b862a608a7f438598d6bcb44c50efeceb84148c2f5351d544cb5584546d2cb2c22
+  data.tar.gz: 18c44f236a822a02469a4ed66b297c607e7e59d440428266790ce1a95da21a549e122c605d7d1f9c70af9442d8f6ce8c0c7ff0242e1f69268ce242bb7dbb02b8

data/.release-please-manifest.json

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

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [0.8.0](https://github.com/open-feature/ruby-sdk/compare/v0.7.1...v0.8.0) (2026-10-23)
+
+
+### ⚠ BREAKING CHANGES
+
+* make hook inputs immutable ([#357](https://github.com/open-feature/ruby-sdk/issues/357))
+
+### Bug Fixes
+
+* do not mutate the provider's ResolutionDetails ([#358](https://github.com/open-feature/ruby-sdk/issues/358)) ([ec657a5](https://github.com/open-feature/ruby-sdk/commit/ec657a5fc7b1514828ea2fa1cb6bfe017029f5af))
+* make hook inputs immutable ([#357](https://github.com/open-feature/ruby-sdk/issues/357)) ([9e166fe](https://github.com/open-feature/ruby-sdk/commit/9e166fe09ec2a10d220295b600141cb351516b24))
+
 ## [0.7.1](https://github.com/open-feature/ruby-sdk/compare/v0.7.0...v0.7.1) (2026-10-23)
 
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openfeature-sdk (0.7.1)
+    openfeature-sdk (0.8.0)
 
 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.1">
-    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.7.1&color=blue&style=for-the-badge" />
+  <a href="https://github.com/open-feature/ruby-sdk/releases/tag/v0.8.0">
+    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.8.0&color=blue&style=for-the-badge" />
   </a>
 
   <!-- x-release-please-end -->
@@ -566,6 +566,11 @@ class MyLoggingHook
 end
 ```
 
+Hooks can read their inputs but not change them:
+
+- Only `before` hooks can change the evaluation context: return an `EvaluationContext` for the SDK to merge in, or assign `hook_context.evaluation_context`. By the time `after`, `error` and `finally` run, it's a frozen copy, so assigning it or writing to its `fields` raises `FrozenError`. Nested field values aren't frozen, because they belong to the caller.
+- The flag key, the default value, the hints, and the client and provider metadata are frozen copies. Your own objects aren't frozen.
+
 > 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 -->

data/lib/open_feature/sdk/client.rb

@@ -134,7 +134,7 @@ module OpenFeature
           executor.run_short_circuit(ordered_hooks: ordered_hooks, hook_context: hook_context, hints: hints, evaluation_details: evaluation_details)
           evaluation_details
         else
-          executor.execute(ordered_hooks: ordered_hooks, hook_context: hook_context, hints: hints) do |hctx|
+          executor.execute(ordered_hooks: ordered_hooks, hook_context: hook_context, hints: hints, default_value:) do |hctx|
             evaluate_flag(provider: provider, type: type, flag_key: flag_key, default_value: default_value, evaluation_context: hctx.evaluation_context)
           end
         end
@@ -157,11 +157,16 @@ module OpenFeature
           evaluation_context: evaluation_context
         )
 
-        if resolution_details.error_code || TYPE_CLASS_MAP[type].none? { |klass| resolution_details.value.is_a?(klass) }
-          resolution_details.value = default_value
-          resolution_details.error_code ||= Provider::ErrorCode::TYPE_MISMATCH
-          resolution_details.reason = Provider::Reason::ERROR
-          resolution_details.variant = nil
+        provider_error = resolution_details.error_code
+        if provider_error || TYPE_CLASS_MAP[type].none? { |klass| resolution_details.value.is_a?(klass) }
+          # A new struct, since a provider may cache and reuse the one it returned
+          resolution_details = Provider::ResolutionDetails.new(
+            value: default_value,
+            reason: Provider::Reason::ERROR,
+            error_code: provider_error || Provider::ErrorCode::TYPE_MISMATCH,
+            error_message: provider_error ? resolution_details.error_message : "Expected #{type}, got #{resolution_details.value.class}",
+            flag_metadata: resolution_details.flag_metadata
+          )
         end
 
         EvaluationDetails.new(flag_key: flag_key, resolution_details: resolution_details)

data/lib/open_feature/sdk/evaluation_context.rb

@@ -26,6 +26,16 @@ module OpenFeature
         )
       end
 
+      def initialize_copy(source)
+        super
+        @fields = @fields.dup
+      end
+
+      def freeze
+        fields.freeze
+        super
+      end
+
       def ==(other)
         fields == other.fields
       end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module OpenFeature
+  module SDK
+    module Hooks
+      # A deep-frozen copy of a hook input, so hooks can't change it and the caller's object isn't frozen (spec 4.1.3, 4.2.2)
+      def self.frozen_copy(value)
+        Ractor.make_shareable(value, copy: true)
+      rescue
+        value.dup.freeze # shortcut: when something inside can't be copied (a Mutex, Queue or Proc), only the top level is frozen
+      end
+    end
+  end
+end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "delegate"
+require_relative "frozen_copy"
 
 module OpenFeature
   module SDK
@@ -13,8 +14,7 @@ module OpenFeature
             assert_allowed_key(key)
             assert_allowed_value(value)
           end
-          @hash = hash.dup
-          super(@hash)
+          super(Hooks.frozen_copy(hash))
           freeze
         end
 

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

@@ -1,28 +1,45 @@
 # frozen_string_literal: true
 
+require_relative "frozen_copy"
+
 module OpenFeature
   module SDK
     module Hooks
       # Provides context to hook stages during flag evaluation.
       #
-      # Per spec 4.1.1-4.1.5:
+      # Per spec 4.1.1-4.1.5 and 4.2.2:
       # - flag_key, flag_value_type, default_value are immutable (4.1.3)
-      # - client_metadata, provider_metadata are optional (4.1.2)
-      # - evaluation_context is mutable (for before hooks to modify, 4.1.4.1)
+      # - client_metadata, provider_metadata are optional (4.1.2) and immutable (4.2.2.2, 4.2.2.3)
+      # - evaluation_context is mutable only in before hooks; HookExecutor freezes the hook context after them (4.1.4.1)
       class HookContext
-        attr_reader :flag_key, :flag_value_type, :default_value,
-          :client_metadata, :provider_metadata
+        attr_reader :flag_key, :flag_value_type, :client_metadata, :provider_metadata
         attr_accessor :evaluation_context
 
         def initialize(flag_key:, flag_value_type:, default_value:, evaluation_context:,
           client_metadata: nil, provider_metadata: nil)
-          @flag_key = flag_key.freeze
+          @flag_key = Hooks.frozen_copy(flag_key)
           @flag_value_type = flag_value_type.freeze
-          @default_value = default_value.freeze
+          @source_default_value = default_value
           @evaluation_context = evaluation_context
           @client_metadata = client_metadata
-          @provider_metadata = provider_metadata
+          @provider_metadata = Hooks.frozen_copy(provider_metadata)
           @hook_data = {}
+          @copies = {}
+        end
+
+        # Copied on first read: most hooks never read it, and the copy grows with the value
+        def default_value
+          @copies.fetch(:default_value) { @copies[:default_value] = Hooks.frozen_copy(@source_default_value) }
+        end
+
+        # Swaps in a frozen copy of the evaluation context, so neither the caller's nor a before hook's object is frozen.
+        # Top-level strings are copied too, so a hook can't edit a targeting key in place.
+        def freeze
+          return self if frozen?
+          @evaluation_context &&= @evaluation_context.dup.tap do |copy|
+            copy.fields.transform_values! { |value| (value.is_a?(String) && !value.frozen?) ? value.dup.freeze : value }
+          end.freeze
+          super
         end
 
         # Returns a mutable hash scoped to the given hook instance.

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

@@ -13,6 +13,9 @@ module OpenFeature
       #   - Before/after hook error → stop remaining hooks, run error hooks, return default
       #   - Error hook error → log, continue remaining error hooks
       #   - Finally hook error → log, continue remaining finally hooks
+      #
+      # The hook context is frozen before after, error and finally hooks run, so only before hooks
+      # can change the evaluation context (spec 4.1.4.1). Not earlier: some providers write to it.
       class HookExecutor
         def initialize(logger: nil)
           @logger = logger
@@ -37,9 +40,10 @@ module OpenFeature
         # @param ordered_hooks [Array] hooks in before-order (API, Client, Invocation, Provider)
         # @param hook_context [HookContext] the hook context
         # @param hints [Hints] hook hints
+        # @param default_value [Object] returned if evaluation raises; the caller's own object, not the hooks' frozen copy
         # @param evaluate_block [Proc] the flag evaluation to wrap
         # @return [EvaluationDetails] the evaluation result
-        def execute(ordered_hooks:, hook_context:, hints:, &evaluate_block)
+        def execute(ordered_hooks:, hook_context:, hints:, default_value:, &evaluate_block)
           evaluation_details = nil
 
           begin
@@ -60,7 +64,7 @@ module OpenFeature
             evaluation_details = EvaluationDetails.new(
               flag_key: hook_context.flag_key,
               resolution_details: Provider::ResolutionDetails.new(
-                value: hook_context.default_value,
+                value: default_value,
                 error_code: EvaluationError.code_for(e),
                 reason: Provider::Reason::ERROR,
                 error_message: e.message
@@ -91,6 +95,7 @@ module OpenFeature
 
         # Spec 4.4.2: After hooks run in reverse order: Provider → Invocation → Client → API
         def run_after_hooks(hooks, hook_context, evaluation_details, hints)
+          hook_context.freeze
           hooks.reverse_each do |hook|
             next unless hook.respond_to?(:after)
             hook.after(hook_context: hook_context, evaluation_details: evaluation_details, hints: hints)
@@ -100,6 +105,7 @@ module OpenFeature
         # Spec 4.4.4: Error hooks run in reverse order.
         # If an error hook itself errors, log and continue remaining error hooks.
         def run_error_hooks(hooks, hook_context, exception, hints)
+          hook_context.freeze
           hooks.reverse_each do |hook|
             next unless hook.respond_to?(:error)
             hook.error(hook_context: hook_context, exception: exception, hints: hints)
@@ -111,6 +117,7 @@ module OpenFeature
         # Spec 4.4.3: Finally hooks run in reverse order unconditionally.
         # If a finally hook errors, log and continue remaining finally hooks.
         def run_finally_hooks(hooks, hook_context, evaluation_details, hints)
+          hook_context.freeze
           hooks.reverse_each do |hook|
             next unless hook.respond_to?(:finally)
             hook.finally(hook_context: hook_context, evaluation_details: evaluation_details, hints: hints)

data/lib/open_feature/sdk/version.rb

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

data/sig/open_feature/sdk/evaluation_context.rbs

@@ -13,6 +13,10 @@ module OpenFeature
 
       def merge: (EvaluationContext overriding_context) -> EvaluationContext
 
+      def initialize_copy: (EvaluationContext source) -> void
+
+      def freeze: () -> self
+
       def ==: (untyped other) -> bool
     end
   end

data/sig/open_feature/sdk/hooks/frozen_copy.rbs

@@ -0,0 +1,7 @@
+module OpenFeature
+  module SDK
+    module Hooks
+      def self.frozen_copy: [T] (T value) -> T
+    end
+  end
+end

data/sig/open_feature/sdk/hooks/hook_context.rbs

@@ -4,13 +4,16 @@ module OpenFeature
       class HookContext
         attr_reader flag_key: String
         attr_reader flag_value_type: Symbol
-        attr_reader default_value: untyped
         attr_reader client_metadata: ClientMetadata?
         attr_reader provider_metadata: Provider::ProviderMetadata?
         attr_accessor evaluation_context: EvaluationContext?
 
         def initialize: (flag_key: String, flag_value_type: Symbol, default_value: untyped, evaluation_context: EvaluationContext?, ?client_metadata: ClientMetadata?, ?provider_metadata: Provider::ProviderMetadata?) -> void
 
+        def default_value: () -> untyped
+
+        def freeze: () -> self
+
         def hook_data_for: (untyped hook) -> Hash[untyped, untyped]
       end
     end

data/sig/open_feature/sdk/hooks/hook_executor.rbs

@@ -6,7 +6,7 @@ module OpenFeature
 
         def run_short_circuit: (ordered_hooks: Array[untyped], hook_context: HookContext, hints: Hints, evaluation_details: EvaluationDetails) -> void
 
-        def execute: (ordered_hooks: Array[untyped], hook_context: HookContext, hints: Hints) { (HookContext) -> EvaluationDetails } -> EvaluationDetails?
+        def execute: (ordered_hooks: Array[untyped], hook_context: HookContext, hints: Hints, default_value: untyped) { (HookContext) -> EvaluationDetails } -> EvaluationDetails?
 
         private
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openfeature-sdk
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - OpenFeature Authors
@@ -50,6 +50,7 @@ files:
 - lib/open_feature/sdk/evaluation_error.rb
 - lib/open_feature/sdk/event_dispatcher.rb
 - lib/open_feature/sdk/hooks.rb
+- lib/open_feature/sdk/hooks/frozen_copy.rb
 - lib/open_feature/sdk/hooks/hints.rb
 - lib/open_feature/sdk/hooks/hook.rb
 - lib/open_feature/sdk/hooks/hook_context.rb
@@ -88,6 +89,7 @@ files:
 - sig/open_feature/sdk/evaluation_details.rbs
 - sig/open_feature/sdk/evaluation_error.rbs
 - sig/open_feature/sdk/event_dispatcher.rbs
+- sig/open_feature/sdk/hooks/frozen_copy.rbs
 - sig/open_feature/sdk/hooks/hints.rbs
 - sig/open_feature/sdk/hooks/hook.rbs
 - sig/open_feature/sdk/hooks/hook_context.rbs