openfeature-sdk-sorbet 0.2.1 → 0.3.1

data/lib/open_feature/hook_context.rb

@@ -0,0 +1,30 @@
+# typed: strict
+# frozen_string_literal: true
+
+module OpenFeature
+  # See https://openfeature.dev/specification/sections/hooks#41-hook-context
+  # See Requirement 4.1.1, 4.1.3, 4.1.4
+  # TODO: Requirement 4.1.2
+  class HookContext < T::Struct
+    extend T::Generic
+    extend T::Sig
+
+    include T::Struct::ActsAsComparable
+
+    Value = type_member
+    const :flag_key, String
+    const :flag_type, String
+    const :evaluation_context, EvaluationContext
+    const :default_value, Value
+    const :client_metadata, ClientMetadata
+    const :provider_metadata, ProviderMetadata
+
+    # Needed as opposed to .with due to https://sorbet.org/docs/tstruct#from_hash-gotchas
+    sig { params(new_context: EvaluationContext).returns(HookContext[Value]) }
+    def with_new_evaluation_context(new_context)
+      OpenFeature::HookContext.new(flag_key:, flag_type:, default_value:,
+                                   evaluation_context: new_context, client_metadata:,
+                                   provider_metadata:)
+    end
+  end
+end

data/lib/open_feature/hooks.rb

@@ -0,0 +1,22 @@
+# typed: strict
+# frozen_string_literal: true
+
+module OpenFeature
+  # Represents full set of hooks with helper methods for filtering and sequencing each subtype
+  class Hooks < T::Struct
+    extend T::Generic
+    extend T::Sig
+    const :global, T::Array[Hook], default: []
+    const :provider, T::Array[Hook], default: []
+    const :client, T::Array[Hook], default: []
+    const :invocation, T::Array[Hook], default: []
+
+    # See Requirement 4.4.2
+    # TODO: when there is >1 subtype of hook will need to filter and not simply re-cast
+    #   ACHTUNG! T.cast is safe for now but will need to be updated after ^
+    sig { returns(T::Array[Hook::BeforeHook]) }
+    def before
+      T.cast(global + client + invocation + provider, T::Array[Hook::BeforeHook])
+    end
+  end
+end

data/lib/open_feature/multiple_source_provider.rb

@@ -7,19 +7,18 @@ module OpenFeature
   # The providers will be evaluated in that order and the first
   # non-error result will be used. If all sources return an error
   # then the default value is used.
-  class MultipleSourceProvider
+  class MultipleSourceProvider < Provider
     extend T::Sig
 
-    include Provider
-
     sig { params(providers: T::Array[Provider]).void }
     def initialize(providers:)
       @providers = providers
+      super(ProviderStatus::NotReady)
     end
 
     sig { override.returns(ProviderMetadata) }
     def metadata
-      ProviderMetadata.new(name: "Multiple Sources: #{providers.map(&:metadata).map(&:name).join(", ")}")
+      ProviderMetadata.new(name: "Multiple Sources: #{providers.map { |provider| provider.metadata.name }.join(", ")}")
     end
 
     sig { override.returns(T::Array[Hook]) }
@@ -27,6 +26,23 @@ module OpenFeature
       providers.flat_map(&:hooks)
     end
 
+    sig { override.params(context: EvaluationContext).void }
+    def init(context:)
+      providers.each { |provider| provider.init(context:) }
+      @status = if providers.all? { |provider| provider.status == ProviderStatus::Ready }
+                  ProviderStatus::Ready
+                else
+                  ProviderStatus::Error
+                end
+    rescue StandardError
+      @status = ProviderStatus::Error
+    end
+
+    sig { override.void }
+    def shutdown
+      providers.each(&:shutdown)
+    end
+
     sig do
       override
         .params(
@@ -37,8 +53,8 @@ module OpenFeature
         .returns(ResolutionDetails[T::Boolean])
     end
     def resolve_boolean_value(flag_key:, default_value:, context: nil)
-      resolve_from_sources(default_value: default_value) do |provider|
-        provider.resolve_boolean_value(flag_key: flag_key, default_value: default_value, context: context)
+      resolve_from_sources(default_value:) do |provider|
+        provider.resolve_boolean_value(flag_key:, default_value:, context:)
       end
     end
 
@@ -52,8 +68,8 @@ module OpenFeature
         .returns(ResolutionDetails[Numeric])
     end
     def resolve_number_value(flag_key:, default_value:, context: nil)
-      resolve_from_sources(default_value: default_value) do |provider|
-        provider.resolve_number_value(flag_key: flag_key, default_value: default_value, context: context)
+      resolve_from_sources(default_value:) do |provider|
+        provider.resolve_number_value(flag_key:, default_value:, context:)
       end
     end
 
@@ -67,8 +83,8 @@ module OpenFeature
         .returns(ResolutionDetails[Structure])
     end
     def resolve_structure_value(flag_key:, default_value:, context: nil)
-      resolve_from_sources(default_value: default_value) do |provider|
-        provider.resolve_structure_value(flag_key: flag_key, default_value: default_value, context: context)
+      resolve_from_sources(default_value:) do |provider|
+        provider.resolve_structure_value(flag_key:, default_value:, context:)
       end
     end
 
@@ -82,8 +98,8 @@ module OpenFeature
         .returns(ResolutionDetails[String])
     end
     def resolve_string_value(flag_key:, default_value:, context: nil)
-      resolve_from_sources(default_value: default_value) do |provider|
-        provider.resolve_string_value(flag_key: flag_key, default_value: default_value, context: context)
+      resolve_from_sources(default_value:) do |provider|
+        provider.resolve_string_value(flag_key:, default_value:, context:)
       end
     end
 

data/lib/open_feature/no_op_provider.rb

@@ -5,11 +5,9 @@ module OpenFeature
   # Default provider when initializing OpenFeature.
   # Always returns the default value given.
   # This will result in a TypeError if the given default value does not have the correct type.
-  class NoOpProvider
+  class NoOpProvider < Provider
     extend T::Sig
 
-    include Provider
-
     sig { override.returns(ProviderMetadata) }
     attr_reader :metadata
 
@@ -20,6 +18,7 @@ module OpenFeature
     def initialize
       @metadata = T.let(ProviderMetadata.new(name: "No Op Provider"), ProviderMetadata)
       @hooks = T.let([], T::Array[Hook])
+      super()
     end
 
     sig do

data/lib/open_feature/provider.rb

@@ -3,10 +3,21 @@
 
 module OpenFeature
   # Interface that providers must implement.
-  module Provider
+  class Provider
     extend T::Sig
     extend T::Helpers
-    interface!
+    abstract!
+
+    sig { returns(ProviderStatus) }
+    attr_reader :status
+
+    sig { params(status: ProviderStatus).void }
+    def initialize(status = ProviderStatus::Ready)
+      @status = status
+    end
+
+    sig { overridable.params(context: EvaluationContext).void }
+    def init(context:); end
 
     sig { abstract.returns(ProviderMetadata) }
     def metadata; end
@@ -14,6 +25,9 @@ module OpenFeature
     sig { abstract.returns(T::Array[Hook]) }
     def hooks; end
 
+    sig { overridable.void }
+    def shutdown; end
+
     sig do
       abstract
         .params(

data/lib/open_feature/provider_status.rb

@@ -0,0 +1,13 @@
+# typed: strict
+# frozen_string_literal: true
+
+module OpenFeature
+  # Indicates what state a provider is in
+  class ProviderStatus < T::Enum
+    enums do
+      NotReady = new
+      Ready = new
+      Error = new
+    end
+  end
+end

data/lib/open_feature.rb

@@ -19,6 +19,8 @@ module OpenFeature
 
     sig { params(provider: Provider).void }
     def set_provider(provider) # rubocop:disable Naming/AccessorMethodName
+      configuration.provider.shutdown
+      provider.init(context: configuration.evaluation_context || EvaluationContext.new)
       configuration.provider = provider
     end
 
@@ -42,12 +44,17 @@ module OpenFeature
     def create_client(name: nil, evaluation_context: nil, hooks: nil)
       Client.new(
         provider: configuration.provider,
-        name: name,
-        evaluation_context: evaluation_context,
+        name:,
+        evaluation_context:,
         hooks: Array(hooks)
       )
     end
 
+    sig { void }
+    def shutdown
+      configuration.provider.shutdown
+    end
+
     sig { returns(Configuration) }
     def configuration
       Configuration.instance

data/sorbet/rbi/gems/.gitattributes

@@ -0,0 +1 @@
+**/*.rbi linguist-generated=true