openfeature-sdk-sorbet 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96650d45be9bb86f0349e27d1ad9d56c748659b3d075b6c2cc6c769fff642571
-  data.tar.gz: 370bd63d0ffb1143eec2de19d3b70e5e0b5033b4dcd0f08117dfbaeee7c1f8cd
+  metadata.gz: b0df7fa6e69c0e30dd01d5e5f0aad7b5543787ed2ab7a11ab35d7b034ffe1dc6
+  data.tar.gz: 22de53663fcd170d801f9ed12e0fb7bef01618b685ca61f2dbe486801d5fdcc1
 SHA512:
-  metadata.gz: 915afef5bdae8110b53c4e96dc9494955636753c1170349eb25f432760590fc75004ebd6f8c47bd3359da982b81fbae0c08a7053df4b552fe760f939021bdd00
-  data.tar.gz: 799b9745b26bf0eac7cdf5e54b237d63abe8f2af5e238bcaf554bd368105dc880a7cc643e5565529053baa4a7041cbc61a5c95eafcc56331ad25b6c2527883e9
+  metadata.gz: b31be23ed317d0e8d1418085f2e4adb655030d023a08cf1eb3ef450fa5aaf091319bdd6cd4af57d28d795e48711c705499aed23181c9f894919c01af8a7e8495
+  data.tar.gz: b3bdf0316cd4637a7970791f2d2b5d4d3407bb45cd14b613fd268ce5f4e3486d6cdbe5731c955b5c92f4b9f26196d1a514dc8f54f683f8ec776f345f102f7173

data/.rubocop.yml

@@ -30,9 +30,7 @@ Metrics/ClassLength:
 
 Metrics/MethodLength:
   Exclude:
-    - test/open_feature/evaluation_details_test.rb
-    - test/open_feature/multiple_source_provider_test.rb
-    - test/support/test_provider.rb
+    - test/**/*
 
 Style/AccessorGrouping:
   Enabled: false

data/CHANGELOG.md

@@ -6,6 +6,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0] - 2023-05-17
+
+### Added
+
+- Added ability to set evaluation context globally on the `Configuration` singleton, i.e. `OpenFeature::Configuration.instance.evaluation_context = OpenFeature::EvaluationContext.new(fields: { "globally" => "available" })`.
+- Added ability to set evaluation context globally on the `OpenFeature` module, i.e. `OpenFeature.set_evaluation_context(OpenFeature::EvaluationContext.new(fields: { "globally" => "available" }))`.
+- Added ability to set evaluation context on a `Client` instance, i.e. `client.evaluation_context = OpenFeature::EvaluationContext.new(fields: { "client" => "available" })`.
+- Added ability to set hooks and evaluation context on `Client` initialization, i.e. `OpenFeature.create_client(name: "my_client", evaluation_context: OpenFeature::EvaluationContext.new(fields: { "client" => "available" }), hooks: OpenFeature::Hook.new)`
+- Added `Configuration#reset!` to reset global configuration to the default state.
+
+### Changed
+
+- Renamed `Configuration#set_provider` to `Configuration#provider=`.
+- Renamed `Configuration#add_provider` to `Configuration#hooks=`.
+- During flag initialization, contexts are now merged. The invocation context takes precedence over the client context which takes precedence over the global context.
+
+### Removed
+
+- Removed `Configuration#clear_hooks!` in favor of `Configuration#reset!`.
+
 ## [0.1.2] - 2023-05-16
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openfeature-sdk-sorbet (0.1.2)
+    openfeature-sdk-sorbet (0.2.0)
       sorbet-runtime (~> 0.5)
       sorbet-struct-comparable (~> 1.3)
       zeitwerk (~> 2.6)
@@ -56,14 +56,14 @@ GEM
     rubocop-sorbet (0.7.0)
       rubocop (>= 0.90.0)
     ruby-progressbar (1.13.0)
-    sorbet (0.5.10827)
-      sorbet-static (= 0.5.10827)
-    sorbet-runtime (0.5.10827)
-    sorbet-static (0.5.10827-universal-darwin-22)
-    sorbet-static (0.5.10827-x86_64-linux)
-    sorbet-static-and-runtime (0.5.10827)
-      sorbet (= 0.5.10827)
-      sorbet-runtime (= 0.5.10827)
+    sorbet (0.5.10830)
+      sorbet-static (= 0.5.10830)
+    sorbet-runtime (0.5.10830)
+    sorbet-static (0.5.10830-universal-darwin-22)
+    sorbet-static (0.5.10830-x86_64-linux)
+    sorbet-static-and-runtime (0.5.10830)
+      sorbet (= 0.5.10830)
+      sorbet-runtime (= 0.5.10830)
     sorbet-struct-comparable (1.3.0)
       sorbet-runtime (>= 0.5)
     spoom (1.2.1)

data/README.md

@@ -26,9 +26,10 @@ require "open_feature"
 # Configure global API properties
 
 OpenFeature.set_provider(OpenFeature::NoOpProvider.new)
+OpenFeature.set_evaluation_context(OpenFeature::EvaluationContext.new(fields: { "globally" => "available" }))
 OpenFeature.add_hooks([OpenFeature::Hook.new]) # experimental, not fully supported
 
-client = OpenFeature.create_client
+client = OpenFeature.create_client(evaluation_context: OpenFeature::EvaluationContext.new(fields: { "client" => "available" }))
 
 # Fetch boolean value
 # Also methods available for String, Number, Integer, Float and Structure (Hash)
@@ -37,6 +38,9 @@ bool_value = client.fetch_boolean_value(flag_key: "my_toggle", default_value: fa
 # Sorbet sprinkles in type safety
 bool_value = client.fetch_boolean_value(flag_key: "my_toggle", default_value: "bad!") # => raises TypeError from Sorbet, invalid default value
 
+# Additional evaluation context can be provided during invocation
+number_value = client.fetch_number_value(flag_key: "my_toggle", default_value: 1, context: OpenFeature::EvaluationContext.new(fields: { "only_this_call_site" => 10 })) # => merges client and global context
+
 # Fetch structure evaluation details
 structure_evaluation_details = client.fetch_structure_details(flag_key: "my_structure", default_value: { "a" => "fallback" }) # => EvaluationDetails(value: Hash, flag_key: "my_structure", ...)
 ```
@@ -45,6 +49,10 @@ structure_evaluation_details = client.fetch_structure_details(flag_key: "my_stru
 
 The OpenFeature specification defines [Structure as a potential return type](https://openfeature.dev/specification/types#structure). This is somewhat ambiguous in Ruby, further complicated by `T::Struct` that we get from Sorbet. For now, the type I've elected here is `T.any(T::Array[T.untyped], T::Hash[T.untyped, T.untyped]` (loosely, either an Array of untyped members or a Hash with untyped keys and untyped values) for flexibility but with a little more structure than a YML or JSON parsable string. This decision might change in the future upon further interpretation or new versions of the specification.
 
+### Evaluation Context
+
+We support global evaluation context (set on the `OpenFeature` module), client evaluation context (set on client instances or during client initialization) and invocation evaluation context (passed in during flag evaluation). In compliance with the specification, the invocation context merges into the client context which merges into the global context. Fields in invocation context take precedence over fields in the client context which take precedence over fields in the global context.
+
 ### Provider Interface
 
 By default, this implementation sets the provider to the `OpenFeature::NoOpProvider` which always returns the default value. It's up to the individual teams to define their own providers based on their flag source (in the future, I'll release open-source providers based on various, common vendors).

data/lib/open_feature/client.rb

@@ -9,14 +9,25 @@ module OpenFeature
     sig { returns(ClientMetadata) }
     attr_reader :client_metadata
 
+    sig { returns(T.nilable(EvaluationContext)) }
+    attr_accessor :evaluation_context
+
     sig { returns(T::Array[Hook]) }
     attr_reader :hooks
 
-    sig { params(provider: Provider, name: T.nilable(String)).void }
-    def initialize(provider:, name: nil)
+    sig do
+      params(
+        provider: Provider,
+        name: T.nilable(String),
+        evaluation_context: T.nilable(EvaluationContext),
+        hooks: T::Array[Hook]
+      ).void
+    end
+    def initialize(provider:, name: nil, evaluation_context: nil, hooks: [])
       @provider = provider
       @client_metadata = T.let(ClientMetadata.new(name: name), ClientMetadata)
-      @hooks = T.let([], T::Array[Hook])
+      @evaluation_context = evaluation_context
+      @hooks = hooks
     end
 
     sig { params(hooks: T.any(Hook, T::Array[Hook])).void }
@@ -33,7 +44,9 @@ module OpenFeature
       ).returns(T::Boolean)
     end
     def fetch_boolean_value(flag_key:, default_value:, context: nil, options: nil) # rubocop:disable Lint/UnusedMethodArgument
-      provider.resolve_boolean_value(flag_key: flag_key, default_value: default_value, context: context).value
+      provider
+        .resolve_boolean_value(flag_key: flag_key, default_value: default_value, context: build_context(context))
+        .value
     rescue StandardError
       default_value
     end
@@ -47,7 +60,11 @@ module OpenFeature
       ).returns(EvaluationDetails[T::Boolean])
     end
     def fetch_boolean_details(flag_key:, default_value:, context: nil, options: nil) # rubocop:disable Lint/UnusedMethodArgument
-      details = provider.resolve_boolean_value(flag_key: flag_key, default_value: default_value, context: context)
+      details = provider.resolve_boolean_value(
+        flag_key: flag_key,
+        default_value: default_value,
+        context: build_context(context)
+      )
 
       EvaluationDetails.from_resolution_details(details, flag_key: flag_key)
     rescue StandardError => e
@@ -63,7 +80,9 @@ module OpenFeature
       ).returns(String)
     end
     def fetch_string_value(flag_key:, default_value:, context: nil, options: nil) # rubocop:disable Lint/UnusedMethodArgument
-      provider.resolve_string_value(flag_key: flag_key, default_value: default_value, context: context).value
+      provider
+        .resolve_string_value(flag_key: flag_key, default_value: default_value, context: build_context(context))
+        .value
     rescue StandardError
       default_value
     end
@@ -77,7 +96,11 @@ module OpenFeature
       ).returns(EvaluationDetails[String])
     end
     def fetch_string_details(flag_key:, default_value:, context: nil, options: nil) # rubocop:disable Lint/UnusedMethodArgument
-      details = provider.resolve_string_value(flag_key: flag_key, default_value: default_value, context: context)
+      details = provider.resolve_string_value(
+        flag_key: flag_key,
+        default_value: default_value,
+        context: build_context(context)
+      )
 
       EvaluationDetails.from_resolution_details(details, flag_key: flag_key)
     rescue StandardError => e
@@ -93,7 +116,9 @@ module OpenFeature
       ).returns(Numeric)
     end
     def fetch_number_value(flag_key:, default_value:, context: nil, options: nil) # rubocop:disable Lint/UnusedMethodArgument
-      provider.resolve_number_value(flag_key: flag_key, default_value: default_value, context: context).value
+      provider
+        .resolve_number_value(flag_key: flag_key, default_value: default_value, context: build_context(context))
+        .value
     rescue StandardError
       default_value
     end
@@ -107,7 +132,11 @@ module OpenFeature
       ).returns(EvaluationDetails[Numeric])
     end
     def fetch_number_details(flag_key:, default_value:, context: nil, options: nil) # rubocop:disable Lint/UnusedMethodArgument
-      details = provider.resolve_number_value(flag_key: flag_key, default_value: default_value, context: context)
+      details = provider.resolve_number_value(
+        flag_key: flag_key,
+        default_value: default_value,
+        context: build_context(context)
+      )
 
       EvaluationDetails.from_resolution_details(details, flag_key: flag_key)
     rescue StandardError => e
@@ -123,7 +152,10 @@ module OpenFeature
       ).returns(Integer)
     end
     def fetch_integer_value(flag_key:, default_value:, context: nil, options: nil) # rubocop:disable Lint/UnusedMethodArgument
-      provider.resolve_number_value(flag_key: flag_key, default_value: default_value, context: context).value.to_i
+      provider
+        .resolve_number_value(flag_key: flag_key, default_value: default_value, context: build_context(context))
+        .value
+        .to_i
     rescue StandardError
       default_value
     end
@@ -137,7 +169,10 @@ module OpenFeature
       ).returns(Float)
     end
     def fetch_float_value(flag_key:, default_value:, context: nil, options: nil) # rubocop:disable Lint/UnusedMethodArgument
-      provider.resolve_number_value(flag_key: flag_key, default_value: default_value, context: context).value.to_f
+      provider
+        .resolve_number_value(flag_key: flag_key, default_value: default_value, context: build_context(context))
+        .value
+        .to_f
     rescue StandardError
       default_value
     end
@@ -151,7 +186,9 @@ module OpenFeature
       ).returns(Structure)
     end
     def fetch_structure_value(flag_key:, default_value:, context: nil, options: nil) # rubocop:disable Lint/UnusedMethodArgument
-      provider.resolve_structure_value(flag_key: flag_key, default_value: default_value, context: context).value
+      provider
+        .resolve_structure_value(flag_key: flag_key, default_value: default_value, context: build_context(context))
+        .value
     rescue StandardError
       default_value
     end
@@ -165,7 +202,11 @@ module OpenFeature
       ).returns(EvaluationDetails[Structure])
     end
     def fetch_structure_details(flag_key:, default_value:, context: nil, options: nil) # rubocop:disable Lint/UnusedMethodArgument
-      details = provider.resolve_structure_value(flag_key: flag_key, default_value: default_value, context: context)
+      details = provider.resolve_structure_value(
+        flag_key: flag_key,
+        default_value: default_value,
+        context: build_context(context)
+      )
 
       EvaluationDetails.from_resolution_details(details, flag_key: flag_key)
     rescue StandardError => e
@@ -176,5 +217,14 @@ module OpenFeature
 
     sig { returns(Provider) }
     attr_reader :provider
+
+    sig { params(invocation_context: T.nilable(EvaluationContext)).returns(T.nilable(EvaluationContext)) }
+    def build_context(invocation_context)
+      EvaluationContextBuilder.new.call(
+        global_context: OpenFeature.configuration.evaluation_context,
+        client_context: evaluation_context,
+        invocation_context: invocation_context
+      )
+    end
   end
 end

data/lib/open_feature/configuration.rb

@@ -13,14 +13,18 @@ module OpenFeature
     include Singleton
 
     sig { returns(Provider) }
-    attr_reader :provider
+    attr_accessor :provider
+
+    sig { returns(T.nilable(EvaluationContext)) }
+    attr_accessor :evaluation_context
 
     sig { returns(T::Array[Hook]) }
-    attr_reader :hooks
+    attr_accessor :hooks
 
     sig { void }
     def initialize
       @provider = T.let(NoOpProvider.new, Provider)
+      @evaluation_context = T.let(nil, T.nilable(EvaluationContext))
       @hooks = T.let([], T::Array[Hook])
     end
 
@@ -29,19 +33,11 @@ module OpenFeature
       provider.metadata
     end
 
-    sig { params(provider: Provider).void }
-    def set_provider(provider) # rubocop:disable Naming/AccessorMethodName
-      @provider = provider
-    end
-
-    sig { params(hooks: T.any(Hook, T::Array[Hook])).void }
-    def add_hooks(hooks)
-      @hooks.concat(Array(hooks))
-    end
-
     sig { void }
-    def clear_hooks!
+    def reset!
+      @provider = OpenFeature::NoOpProvider.new
       @hooks = []
+      @evaluation_context = nil
     end
   end
 end

data/lib/open_feature/evaluation_context.rb

@@ -1,10 +1,50 @@
 # typed: strict
 # frozen_string_literal: true
 
+require "date"
+
 module OpenFeature
   # Provides ambient information for the purposes of flag evaluation.
   # Currently does not meet specification!
   class EvaluationContext < T::Struct
+    extend T::Sig
+
+    include T::Struct::ActsAsComparable
+
+    FieldValueType = T.type_alias { T.any(T::Boolean, String, Numeric, DateTime, Structure) }
+
     const :targeting_key, T.nilable(String)
+    const :fields, T::Hash[String, FieldValueType], default: {}
+
+    sig { params(method_name: Symbol).returns(T::Boolean) }
+    def respond_to_missing?(method_name)
+      fields.key?(method_name.to_s)
+    end
+
+    sig { params(method_name: Symbol).returns(T.nilable(FieldValueType)) }
+    def method_missing(method_name)
+      fields.fetch(method_name.to_s, nil)
+    end
+
+    sig { params(key: String, value: FieldValueType).returns(EvaluationContext) }
+    def add_field(key, value)
+      EvaluationContext.new(
+        targeting_key: targeting_key,
+        fields: fields.merge({ key => value })
+      )
+    end
+
+    sig { returns(T::Hash[String, FieldValueType]) }
+    def to_h
+      targeting_key.nil? ? fields : fields.merge("targeting_key" => targeting_key)
+    end
+
+    sig { params(overriding_context: EvaluationContext).returns(EvaluationContext) }
+    def merge(overriding_context)
+      EvaluationContext.new(
+        targeting_key: overriding_context.targeting_key || targeting_key,
+        fields: fields.merge(overriding_context.fields)
+      )
+    end
   end
 end

data/lib/open_feature/evaluation_context_builder.rb

@@ -0,0 +1,26 @@
+# typed: strict
+# frozen_string_literal: true
+
+module OpenFeature
+  # Used to combine evaluation contexts from different sources
+  class EvaluationContextBuilder
+    extend T::Sig
+
+    sig do
+      params(
+        global_context: T.nilable(EvaluationContext),
+        client_context: T.nilable(EvaluationContext),
+        invocation_context: T.nilable(EvaluationContext)
+      ).returns(T.nilable(EvaluationContext))
+    end
+    def call(global_context:, client_context:, invocation_context:)
+      available_contexts = [global_context, client_context, invocation_context].compact
+
+      return nil if available_contexts.empty?
+
+      available_contexts.reduce(EvaluationContext.new) do |built_context, context|
+        built_context.merge(context)
+      end
+    end
+  end
+end

data/lib/open_feature.rb

@@ -19,17 +19,33 @@ module OpenFeature
 
     sig { params(provider: Provider).void }
     def set_provider(provider) # rubocop:disable Naming/AccessorMethodName
-      configuration.set_provider(provider)
+      configuration.provider = provider
+    end
+
+    sig { params(context: EvaluationContext).void }
+    def set_evaluation_context(context) # rubocop:disable Naming/AccessorMethodName
+      configuration.evaluation_context = context
     end
 
     sig { params(hooks: T.any(Hook, T::Array[Hook])).void }
     def add_hooks(hooks)
-      configuration.add_hooks(hooks)
+      configuration.hooks.concat(Array(hooks))
     end
 
-    sig { params(name: T.nilable(String)).returns(Client) }
-    def create_client(name: nil)
-      Client.new(provider: configuration.provider, name: name)
+    sig do
+      params(
+        name: T.nilable(String),
+        evaluation_context: T.nilable(EvaluationContext),
+        hooks: T.nilable(T.any(Hook, T::Array[Hook]))
+      ).returns(Client)
+    end
+    def create_client(name: nil, evaluation_context: nil, hooks: nil)
+      Client.new(
+        provider: configuration.provider,
+        name: name,
+        evaluation_context: evaluation_context,
+        hooks: Array(hooks)
+      )
     end
 
     sig { returns(Configuration) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openfeature-sdk-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Max VelDink
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-16 00:00:00.000000000 Z
+date: 2023-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -76,6 +76,7 @@ files:
 - lib/open_feature/configuration.rb
 - lib/open_feature/error_code.rb
 - lib/open_feature/evaluation_context.rb
+- lib/open_feature/evaluation_context_builder.rb
 - lib/open_feature/evaluation_details.rb
 - lib/open_feature/evaluation_options.rb
 - lib/open_feature/flag_metadata.rb