prefab-cloud-ruby 0.23.7 → 0.24.0

data/lib/prefab/resolved_config_presenter.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Prefab
+  class ResolvedConfigPresenter
+    class ConfigRow
+      include Comparable
+
+      attr_reader :key, :value, :match, :source
+
+      def initialize(key, value, match, source)
+        @key = key
+        @value = value
+        @match = match
+        @source = source
+      end
+
+      def <=>(other)
+        inspect <=> other.inspect
+      end
+
+      def inspect
+        [@key, @value, @match, @source].inspect
+      end
+    end
+
+    def initialize(resolver, lock, local_store)
+      @resolver = resolver
+      @lock = lock
+      @local_store = local_store
+    end
+
+    def each(&block)
+      to_h.each(&block)
+    end
+
+    def to_h
+      hash = {}
+
+      Prefab::Context.with_context({}) do
+        @lock.with_read_lock do
+          @local_store.keys.sort.each do |k|
+            v = @local_store[k]
+
+            if v.nil?
+              hash[k] = ConfigRow.new(k, nil, nil, nil)
+            else
+              config = @resolver.evaluate(v[:config])
+              value = Prefab::ConfigValueUnwrapper.unwrap(config, k, {})
+              hash[k] = ConfigRow.new(k, value, v[:match], v[:source])
+            end
+          end
+        end
+      end
+
+      hash
+    end
+
+    def to_s
+      str = "\n"
+
+      Prefab::Context.with_context({}) do
+        @lock.with_read_lock do
+          @local_store.keys.sort.each do |k|
+            v = @local_store[k]
+            elements = [k.slice(0..49).ljust(50)]
+            if v.nil?
+              elements << 'tombstone'
+            else
+              config = @resolver.evaluate(v[:config], {})
+              value = Prefab::ConfigValueUnwrapper.unwrap(config, k, {})
+              elements << value.to_s.slice(0..34).ljust(35)
+              elements << value.class.to_s.slice(0..6).ljust(7)
+              elements << "Match: #{v[:match]}".slice(0..29).ljust(30)
+              elements << "Source: #{v[:source]}"
+            end
+            str += elements.join(' | ') << "\n"
+          end
+        end
+      end
+
+      str
+    end
+  end
+end

data/lib/prefab/weighted_value_resolver.rb

@@ -4,14 +4,14 @@ module Prefab
   class WeightedValueResolver
     MAX_32_FLOAT = 4_294_967_294.0
 
-    def initialize(weights, config_key, lookup_key)
+    def initialize(weights, config_key, context_hash_value)
       @weights = weights
       @config_key = config_key
-      @lookup_key = lookup_key
+      @context_hash_value = context_hash_value
     end
 
     def resolve
-      percent = @lookup_key ? user_percent : rand
+      percent = @context_hash_value ? user_percent : rand
 
       index = variant_index(percent)
 
@@ -19,7 +19,7 @@ module Prefab
     end
 
     def user_percent
-      to_hash = "#{@config_key}#{@lookup_key}"
+      to_hash = "#{@config_key}#{@context_hash_value}"
       int_value = Murmur3.murmur3_32(to_hash)
       int_value / MAX_32_FLOAT
     end

data/lib/prefab-cloud-ruby.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+module Prefab
+  NO_DEFAULT_PROVIDED = :no_default_provided
+end
+
 require 'concurrent/atomics'
 require 'concurrent'
 require 'faraday'
@@ -21,8 +25,10 @@ require 'prefab/criteria_evaluator'
 require 'prefab/config_loader'
 require 'prefab/local_config_parser'
 require 'prefab/yaml_config_parser'
+require 'prefab/resolved_config_presenter'
 require 'prefab/config_resolver'
 require 'prefab/http_connection'
+require 'prefab/context'
 require 'prefab/client'
 require 'prefab/config_client'
 require 'prefab/feature_flag_client'

data/lib/prefab_pb.rb

@@ -32,6 +32,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "prefab.WeightedValues" do
       repeated :weighted_values, :message, 1, "prefab.WeightedValue"
+      proto3_optional :hash_by_property_name, :string, 2
     end
     add_message "prefab.Configs" do
       repeated :configs, :message, 1, "prefab.Config"
@@ -60,6 +61,42 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       repeated :criteria, :message, 1, "prefab.Criterion"
       optional :value, :message, 2, "prefab.ConfigValue"
     end
+    add_message "prefab.Criterion" do
+      optional :property_name, :string, 1
+      optional :operator, :enum, 2, "prefab.Criterion.CriterionOperator"
+      optional :value_to_match, :message, 3, "prefab.ConfigValue"
+    end
+    add_enum "prefab.Criterion.CriterionOperator" do
+      value :NOT_SET, 0
+      value :LOOKUP_KEY_IN, 1
+      value :LOOKUP_KEY_NOT_IN, 2
+      value :IN_SEG, 3
+      value :NOT_IN_SEG, 4
+      value :ALWAYS_TRUE, 5
+      value :PROP_IS_ONE_OF, 6
+      value :PROP_IS_NOT_ONE_OF, 7
+      value :PROP_ENDS_WITH_ONE_OF, 8
+      value :PROP_DOES_NOT_END_WITH_ONE_OF, 9
+      value :HIERARCHICAL_MATCH, 10
+    end
+    add_message "prefab.Loggers" do
+      repeated :loggers, :message, 1, "prefab.Logger"
+      optional :start_at, :int64, 2
+      optional :end_at, :int64, 3
+      optional :instance_hash, :string, 4
+      proto3_optional :namespace, :string, 5
+    end
+    add_message "prefab.Logger" do
+      optional :logger_name, :string, 1
+      proto3_optional :traces, :int64, 2
+      proto3_optional :debugs, :int64, 3
+      proto3_optional :infos, :int64, 4
+      proto3_optional :warns, :int64, 5
+      proto3_optional :errors, :int64, 6
+      proto3_optional :fatals, :int64, 7
+    end
+    add_message "prefab.LoggerReportResponse" do
+    end
     add_message "prefab.LimitResponse" do
       optional :passed, :bool, 1
       optional :expires_at, :int64, 2
@@ -95,24 +132,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :MINIMUM, 1
       value :MAXIMUM, 2
     end
-    add_message "prefab.Criterion" do
-      optional :property_name, :string, 1
-      optional :operator, :enum, 2, "prefab.Criterion.CriterionOperator"
-      optional :value_to_match, :message, 3, "prefab.ConfigValue"
-    end
-    add_enum "prefab.Criterion.CriterionOperator" do
-      value :NOT_SET, 0
-      value :LOOKUP_KEY_IN, 1
-      value :LOOKUP_KEY_NOT_IN, 2
-      value :IN_SEG, 3
-      value :NOT_IN_SEG, 4
-      value :ALWAYS_TRUE, 5
-      value :PROP_IS_ONE_OF, 6
-      value :PROP_IS_NOT_ONE_OF, 7
-      value :PROP_ENDS_WITH_ONE_OF, 8
-      value :PROP_DOES_NOT_END_WITH_ONE_OF, 9
-      value :HIERARCHICAL_MATCH, 10
-    end
     add_message "prefab.Identity" do
       proto3_optional :lookup, :string, 1
       map :attributes, :string, :string, 2
@@ -181,24 +200,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :sequence_name, :string, 3
       optional :size, :int64, 4
     end
-    add_message "prefab.Loggers" do
-      repeated :loggers, :message, 1, "prefab.Logger"
-      optional :start_at, :int64, 2
-      optional :end_at, :int64, 3
-      optional :instance_hash, :string, 4
-      proto3_optional :namespace, :string, 5
-    end
-    add_message "prefab.Logger" do
-      optional :logger_name, :string, 1
-      proto3_optional :traces, :int64, 2
-      proto3_optional :debugs, :int64, 3
-      proto3_optional :infos, :int64, 4
-      proto3_optional :warns, :int64, 5
-      proto3_optional :errors, :int64, 6
-      proto3_optional :fatals, :int64, 7
-    end
-    add_message "prefab.LoggerReportResponse" do
-    end
     add_enum "prefab.ConfigType" do
       value :NOT_SET_CONFIG_TYPE, 0
       value :CONFIG, 1
@@ -236,12 +237,15 @@ module Prefab
   ChangedBy = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.ChangedBy").msgclass
   ConfigRow = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.ConfigRow").msgclass
   ConditionalValue = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.ConditionalValue").msgclass
+  Criterion = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.Criterion").msgclass
+  Criterion::CriterionOperator = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.Criterion.CriterionOperator").enummodule
+  Loggers = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.Loggers").msgclass
+  Logger = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.Logger").msgclass
+  LoggerReportResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.LoggerReportResponse").msgclass
   LimitResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.LimitResponse").msgclass
   LimitResponse::LimitPolicyNames = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.LimitResponse.LimitPolicyNames").enummodule
   LimitRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.LimitRequest").msgclass
   LimitRequest::LimitCombiner = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.LimitRequest.LimitCombiner").enummodule
-  Criterion = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.Criterion").msgclass
-  Criterion::CriterionOperator = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.Criterion.CriterionOperator").enummodule
   Identity = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.Identity").msgclass
   ClientConfigValue = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.ClientConfigValue").msgclass
   ConfigEvaluations = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.ConfigEvaluations").msgclass
@@ -254,9 +258,6 @@ module Prefab
   CreationResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.CreationResponse").msgclass
   IdBlock = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.IdBlock").msgclass
   IdBlockRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.IdBlockRequest").msgclass
-  Loggers = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.Loggers").msgclass
-  Logger = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.Logger").msgclass
-  LoggerReportResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.LoggerReportResponse").msgclass
   ConfigType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.ConfigType").enummodule
   LogLevel = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.LogLevel").enummodule
   OnFailure = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.OnFailure").enummodule

data/prefab-cloud-ruby.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: prefab-cloud-ruby 0.23.7 ruby lib
+# stub: prefab-cloud-ruby 0.24.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "prefab-cloud-ruby".freeze
-  s.version = "0.23.7"
+  s.version = "0.24.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Jeff Dwyer".freeze]
-  s.date = "2023-04-21"
+  s.date = "2023-04-26"
   s.description = "Feature Flags, Live Config, and Dynamic Log Levels as a service".freeze
   s.email = "jdwyer@prefab.cloud".freeze
   s.extra_rdoc_files = [
@@ -38,6 +38,7 @@ Gem::Specification.new do |s|
     "lib/prefab/config_loader.rb",
     "lib/prefab/config_resolver.rb",
     "lib/prefab/config_value_unwrapper.rb",
+    "lib/prefab/context.rb",
     "lib/prefab/criteria_evaluator.rb",
     "lib/prefab/error.rb",
     "lib/prefab/errors/initialization_timeout_error.rb",
@@ -54,11 +55,11 @@ Gem::Specification.new do |s|
     "lib/prefab/noop_cache.rb",
     "lib/prefab/noop_stats.rb",
     "lib/prefab/options.rb",
+    "lib/prefab/resolved_config_presenter.rb",
     "lib/prefab/sse_logger.rb",
     "lib/prefab/weighted_value_resolver.rb",
     "lib/prefab/yaml_config_parser.rb",
     "lib/prefab_pb.rb",
-    "lib/prefab_services_pb.rb",
     "prefab-cloud-ruby.gemspec",
     "test/.prefab.default.config.yaml",
     "test/.prefab.unit_tests.config.yaml",
@@ -69,6 +70,7 @@ Gem::Specification.new do |s|
     "test/test_config_loader.rb",
     "test/test_config_resolver.rb",
     "test/test_config_value_unwrapper.rb",
+    "test/test_context.rb",
     "test/test_criteria_evaluator.rb",
     "test/test_exponential_backoff.rb",
     "test/test_feature_flag_client.rb",

data/test/.prefab.unit_tests.config.yaml

@@ -9,8 +9,9 @@ sample: test sample value
 enabled_flag: true
 disabled_flag: false
 flag_with_a_value: { "feature_flag": "true", value: "all-features" }
-in_lookup_key: { "feature_flag": "true", value: true, criterion: { operator: LOOKUP_KEY_IN, values: [ "abc123", "xyz987" ] } }
-just_my_domain: { "feature_flag": "true", value: "new-version", criterion: { operator: PROP_IS_ONE_OF, property: "domain", values: [ "prefab.cloud", "example.com" ] } }
+user_key_match: { "feature_flag": "true", value: true, criterion: { operator: PROP_IS_ONE_OF, values: [ "abc123", "xyz987" ], property: "user.key" } }
+just_my_domain: { "feature_flag": "true", value: "new-version", criterion: { operator: PROP_IS_ONE_OF, property: "user.domain", values: [ "prefab.cloud", "example.com" ] } }
+deprecated_no_dot_notation: { "feature_flag": "true", value: true, criterion: { operator: PROP_IS_ONE_OF, property: "domain", values: [ "prefab.cloud", "example.com" ] } }
 
 nested:
   values:

data/test/integration_test.rb

@@ -1,18 +1,14 @@
 # frozen_string_literal: true
 
 class IntegrationTest
-  attr_reader :func
-  attr_reader :input
-  attr_reader :expected
-  attr_reader :test_client
+  attr_reader :func, :input, :expected, :test_client
 
   def initialize(test_data)
     @client_overrides = parse_client_overrides(test_data['client_overrides'])
     @func = parse_function(test_data['function'])
     @input = parse_input(test_data['input'])
     @expected = parse_expected(test_data['expected'])
-    test_client = :"#{test_data['client']}"
-    @test_client = base_client.send(test_client)
+    @test_client = base_client
   end
 
   def test_type
@@ -40,7 +36,7 @@ class IntegrationTest
   def parse_function(function)
     case function
     when 'get_or_raise' then :get
-    when 'enabled' then :feature_is_on_for?
+    when 'enabled' then :enabled?
     else :"#{function}"
     end
   end
@@ -62,7 +58,7 @@ class IntegrationTest
   end
 
   def parse_ff_input(input)
-    [input['flag'], input['lookup_key'], input['properties'] || {}]
+    [input['flag'], input['context']]
   end
 
   def parse_expected(expected)

data/test/test_client.rb

@@ -44,32 +44,36 @@ class TestClient < Minitest::Test
     assert_equal false, @client.enabled?('flag_with_a_value')
   end
 
-  def test_ff_enabled_with_lookup_key
-    assert_equal false, @client.enabled?('in_lookup_key', 'jimmy')
-    assert_equal true, @client.enabled?('in_lookup_key', 'abc123')
-    assert_equal true, @client.enabled?('in_lookup_key', 'xyz987')
+  def test_ff_enabled_with_user_key_match
+    assert_equal_context_and_jit(false, :enabled?, 'user_key_match', { user: { key: 'jimmy' } })
+    assert_equal_context_and_jit(true, :enabled?, 'user_key_match', { user: { key: 'abc123' } })
+    assert_equal_context_and_jit(true, :enabled?, 'user_key_match', { user: { key: 'xyz987' } })
   end
 
-  def test_ff_get_with_lookup_key
-    assert_nil @client.get('in_lookup_key', 'jimmy')
-    assert_equal 'DEFAULT', @client.get('in_lookup_key', 'jimmy', {}, 'DEFAULT')
-
-    assert_equal true, @client.get('in_lookup_key', 'abc123')
-    assert_equal true, @client.get('in_lookup_key', 'xyz987')
+  def test_ff_enabled_with_context
+    assert_equal_context_and_jit(false, :enabled?, 'just_my_domain', user: { domain: 'gmail.com' })
+    assert_equal_context_and_jit(false, :enabled?, 'just_my_domain', user: { domain: 'prefab.cloud' })
+    assert_equal_context_and_jit(false, :enabled?, 'just_my_domain', user: { domain: 'example.com' })
   end
 
-  def test_ff_enabled_with_attributes
-    assert_equal false, @client.enabled?('just_my_domain', 'abc123', { domain: 'gmail.com' })
-    assert_equal false, @client.enabled?('just_my_domain', 'abc123', { domain: 'prefab.cloud' })
-    assert_equal false, @client.enabled?('just_my_domain', 'abc123', { domain: 'example.com' })
+  def test_ff_get_with_context
+    assert_nil @client.get('just_my_domain', 'abc123', user: { domain: 'gmail.com' })
+    assert_equal 'DEFAULT', @client.get('just_my_domain', 'abc123', { user: { domain: 'gmail.com' } }, 'DEFAULT')
+
+    assert_equal_context_and_jit('new-version', :get, 'just_my_domain', { user: { domain: 'prefab.cloud' } })
+    assert_equal_context_and_jit('new-version', :get, 'just_my_domain', { user: { domain: 'example.com' } })
   end
 
-  def test_ff_get_with_attributes
-    assert_nil @client.get('just_my_domain', 'abc123', { domain: 'gmail.com' })
-    assert_equal 'DEFAULT', @client.get('just_my_domain', 'abc123', { domain: 'gmail.com' }, 'DEFAULT')
+  def test_deprecated_no_dot_notation_ff_enabled_with_jit_context
+    # with no lookup key
+    assert_equal false, @client.enabled?('deprecated_no_dot_notation', { domain: 'gmail.com' })
+    assert_equal true, @client.enabled?('deprecated_no_dot_notation', { domain: 'prefab.cloud' })
+    assert_equal true, @client.enabled?('deprecated_no_dot_notation', { domain: 'example.com' })
 
-    assert_equal 'new-version', @client.get('just_my_domain', 'abc123', { domain: 'prefab.cloud' })
-    assert_equal 'new-version', @client.get('just_my_domain', 'abc123', { domain: 'example.com' })
+    # with a lookup key
+    assert_equal false, @client.enabled?('deprecated_no_dot_notation', 'some-lookup-key', { domain: 'gmail.com' })
+    assert_equal true, @client.enabled?('deprecated_no_dot_notation', 'some-lookup-key', { domain: 'prefab.cloud' })
+    assert_equal true, @client.enabled?('deprecated_no_dot_notation', 'some-lookup-key', { domain: 'example.com' })
   end
 
   def test_getting_feature_flag_value
@@ -103,14 +107,11 @@ class TestClient < Minitest::Test
 
   private
 
-  def new_client(overrides = {})
-    options = Prefab::Options.new(**{
-      prefab_config_override_dir: 'none',
-      prefab_config_classpath_dir: 'test',
-      prefab_envs: ['unit_tests'],
-      prefab_datasources: Prefab::Options::DATASOURCES::LOCAL_ONLY
-    }.merge(overrides))
+  def assert_equal_context_and_jit(expected, method, key, context)
+    assert_equal expected, @client.send(method, key, context)
 
-    Prefab::Client.new(options)
+    Prefab::Context.with_context(context) do
+      assert_equal expected, @client.send(method, key)
+    end
   end
 end