prefab-cloud-ruby 0.20.0 → 0.22.0

data/test/test_logger.rb

@@ -11,19 +11,19 @@ class TestCLogger < Minitest::Test
   end
 
   def test_get_path
-    assert_equal "test_l.foo_warn",
-                 @logger.get_path("/Users/jdwyah/Documents/workspace/RateLimitInc/prefab-cloud-ruby/lib/test_l.rb",
-                                  "foo_warn")
-
-    assert_equal "active_support.log_subscriber.info",
-                 @logger.get_path("/Users/jdwyah/.rvm/gems/ruby-2.3.3@forcerank/gems/activesupport-4.1.16/lib/active_support/log_subscriber.rb",
-                                  "info")
-    assert_equal "active_support.log_subscriber.info",
+    assert_equal 'test_l.foo_warn',
+                 @logger.get_path('/Users/jdwyah/Documents/workspace/RateLimitInc/prefab-cloud-ruby/lib/test_l.rb',
+                                  'foo_warn')
+
+    assert_equal 'active_support.log_subscriber.info',
+                 @logger.get_path('/Users/jdwyah/.rvm/gems/ruby-2.3.3@forcerank/gems/activesupport-4.1.16/lib/active_support/log_subscriber.rb',
+                                  'info')
+    assert_equal 'active_support.log_subscriber.info',
                  @logger.get_path("/Users/jeffdwyer/.asdf/installs/ruby/3.1.2/lib/ruby/gems/3.1.0/gems/activesupport-7.0.2.4/lib/active_support/log_subscriber.rb:130:in `info'",
-                                  "info")
-    assert_equal "unknown.info",
+                                  'info')
+    assert_equal 'unknown.info',
                  @logger.get_path(nil,
-                                  "info")
+                                  'info')
   end
 
   def test_loc_resolution
@@ -34,80 +34,81 @@ class TestCLogger < Minitest::Test
     end # https://ruby-doc.org/core-3.0.0/Thread/Backtrace/Location.html
 
     # verify that even if the Thread::Backtrace::Location does not have an absolute_location, we do our best
-    assert_equal "active_support.log_subscriber.info",
+    assert_equal 'active_support.log_subscriber.info',
                  @logger.get_loc_path(backtrace_location.new(nil,
-                                                             "info",
+                                                             'info',
                                                              "/Users/jeffdwyer/.asdf/installs/ruby/3.1.2/lib/ruby/gems/3.1.0/gems/activesupport-7.0.2.4/lib/active_support/log_subscriber.rb:130:in `info'"))
-    assert_equal "test_l.info",
-                 @logger.get_loc_path(backtrace_location.new("/Users/jdwyah/Documents/workspace/RateLimitInc/prefab-cloud-ruby/lib/test_l.rb",
-                                                             "info",
+    assert_equal 'test_l.info',
+                 @logger.get_loc_path(backtrace_location.new('/Users/jdwyah/Documents/workspace/RateLimitInc/prefab-cloud-ruby/lib/test_l.rb',
+                                                             'info',
                                                              "/Users/jeffdwyer/.asdf/installs/ruby/3.1.2/lib/ruby/gems/3.1.0/gems/activesupport-7.0.2.4/lib/active_support/log_subscriber.rb:130:in `info'"))
   end
 
   def test_level_of
-    with_env("PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL", "info") do
+    with_env('PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL', 'info') do
       # env var overrides the default level
-      assert_equal Logger::INFO,
-                   @logger.level_of("app.models.user"), "PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL is info"
+      assert_equal ::Logger::INFO,
+                   @logger.level_of('app.models.user'), 'PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL is info'
 
       @logger.set_config_client(MockConfigClient.new({}))
-      assert_equal Logger::WARN,
-                   @logger.level_of("app.models.user"), "default is warn"
+      assert_equal ::Logger::WARN,
+                   @logger.level_of('app.models.user'), 'default is warn'
 
-      @logger.set_config_client(MockConfigClient.new("log-level.app" => :INFO))
-      assert_equal Logger::INFO,
-                   @logger.level_of("app.models.user")
+      @logger.set_config_client(MockConfigClient.new('log-level.app' => :INFO))
+      assert_equal ::Logger::INFO,
+                   @logger.level_of('app.models.user')
 
-      @logger.set_config_client(MockConfigClient.new("log-level.app" => :DEBUG))
-      assert_equal Logger::DEBUG,
-                   @logger.level_of("app.models.user")
+      @logger.set_config_client(MockConfigClient.new('log-level.app' => :DEBUG))
+      assert_equal ::Logger::DEBUG,
+                   @logger.level_of('app.models.user')
 
-      @logger.set_config_client(MockConfigClient.new("log-level.app" => :DEBUG,
-                                                     "log-level.app.models" => :ERROR))
-      assert_equal Logger::ERROR,
-                   @logger.level_of("app.models.user"), "test leveling"
+      @logger.set_config_client(MockConfigClient.new('log-level.app' => :DEBUG,
+                                                     'log-level.app.models' => :ERROR))
+      assert_equal ::Logger::ERROR,
+                   @logger.level_of('app.models.user'), 'test leveling'
     end
   end
 
   def test_log_internal
     logger, mock_logdev = mock_logger_expecting(/W, \[.*\]  WARN -- cloud.prefab.client.test.path: : test message/)
-    logger.log_internal("test message", "test.path", "", Logger::WARN)
+    logger.log_internal('test message', 'test.path', '', ::Logger::WARN)
     mock_logdev.verify
   end
 
   def test_log_internal_unknown
     logger, mock_logdev = mock_logger_expecting(/A, \[.*\]   ANY -- cloud.prefab.client.test.path: : test message/)
-    logger.log_internal("test message", "test.path", "", Logger::UNKNOWN)
+    logger.log_internal('test message', 'test.path', '', ::Logger::UNKNOWN)
     mock_logdev.verify
   end
 
   def test_log_internal_silencing
-    logger, mock_logdev = mock_logger_expecting(/W, \[.*\]  WARN -- cloud.prefab.client.test.path: : should log/, calls: 2)
+    logger, mock_logdev = mock_logger_expecting(/W, \[.*\]  WARN -- cloud.prefab.client.test.path: : should log/,
+                                                calls: 2)
     logger.silence do
-      logger.log_internal("should not log", "test.path", "", Logger::WARN)
+      logger.log_internal('should not log', 'test.path', '', ::Logger::WARN)
     end
-    logger.log_internal("should log", "test.path", "", Logger::WARN)
+    logger.log_internal('should log', 'test.path', '', ::Logger::WARN)
     mock_logdev.verify
   end
 
   def test_log
     logger, mock_logdev = mock_logger_expecting(/W, \[.*\]  WARN -- test.path: : test message/)
-    logger.log("test message", "test.path", "", Logger::WARN)
+    logger.log('test message', 'test.path', '', ::Logger::WARN)
     mock_logdev.verify
   end
 
   def test_log_unknown
     logger, mock_logdev = mock_logger_expecting(/A, \[.*\]   ANY -- test.path: : test message/)
-    logger.log("test message", "test.path", "", Logger::UNKNOWN)
+    logger.log('test message', 'test.path', '', ::Logger::UNKNOWN)
     mock_logdev.verify
   end
 
   def test_log_silencing
     logger, mock_logdev = mock_logger_expecting(/W, \[.*\]  WARN -- test.path: : should log/, calls: 2)
     logger.silence do
-      logger.log("should not log", "test.path", "", Logger::WARN)
+      logger.log('should not log', 'test.path', '', ::Logger::WARN)
     end
-    logger.log("should log", "test.path", "", Logger::WARN)
+    logger.log('should log', 'test.path', '', ::Logger::WARN)
     mock_logdev.verify
   end
 
@@ -125,11 +126,11 @@ class TestCLogger < Minitest::Test
 
   def test_logging_without_a_progname
     prefab, io = captured_logger
-    message = "MY MESSAGE"
+    message = 'MY MESSAGE'
 
     prefab.log.error message
 
-    assert_logged io, 'ERROR', "test.test_logger.test_logging_without_a_progname", message
+    assert_logged io, 'ERROR', 'test.test_logger.test_logging_without_a_progname', message
   end
 
   def test_logging_without_a_progname_or_message
@@ -137,35 +138,35 @@ class TestCLogger < Minitest::Test
 
     prefab.log.error
 
-    assert_logged io, 'ERROR', "test.test_logger.test_logging_without_a_progname_or_message", ""
+    assert_logged io, 'ERROR', 'test.test_logger.test_logging_without_a_progname_or_message', ''
   end
 
   def test_logging_with_a_progname
     prefab, io = captured_logger
-    message = "MY MESSAGE"
+    message = 'MY MESSAGE'
 
-    prefab.log.progname = "MY_PROGNAME"
+    prefab.log.progname = 'MY_PROGNAME'
     prefab.log.error message
 
-    assert_logged io, 'ERROR', "MY_PROGNAME test.test_logger.test_logging_with_a_progname", message
+    assert_logged io, 'ERROR', 'MY_PROGNAME test.test_logger.test_logging_with_a_progname', message
   end
 
   def test_logging_with_a_progname_and_no_message
     prefab, io = captured_logger
 
-    prefab.log.progname = "MY_PROGNAME"
+    prefab.log.progname = 'MY_PROGNAME'
     prefab.log.error
 
-    assert_logged io, 'ERROR', "MY_PROGNAME test.test_logger.test_logging_with_a_progname_and_no_message", "MY_PROGNAME"
+    assert_logged io, 'ERROR', 'MY_PROGNAME test.test_logger.test_logging_with_a_progname_and_no_message', 'MY_PROGNAME'
   end
 
   private
 
   def assert_logged(logged_io, level, path, message)
-    assert_match(/#{level} \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} [-\+]?\d+: #{path}: #{message}\n/, logged_io.string)
+    assert_match(/#{level} \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} [-+]?\d+: #{path}: #{message}\n/, logged_io.string)
   end
 
-  def mock_logger_expecting pattern, configs = {}, calls: 1
+  def mock_logger_expecting(pattern, configs = {}, calls: 1)
     mock_logdev = Minitest::Mock.new
     mock_logdev.expect :write, nil do |arg|
       pattern.match(arg)
@@ -189,6 +190,6 @@ class TestCLogger < Minitest::Test
     ))
     prefab = Prefab::Client.new(options)
 
-    return [prefab, io]
+    [prefab, io]
   end
 end

data/test/test_options.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class TestOptions < Minitest::Test
+  API_KEY = 'abcdefg'
+
+  def test_works_with_named_arguments
+    assert_equal API_KEY, Prefab::Options.new(api_key: API_KEY).api_key
+  end
+
+  def test_works_with_hash
+    assert_equal API_KEY, Prefab::Options.new({ api_key: API_KEY }).api_key
+  end
+
+  def test_collect_max_paths
+    assert_equal 1000, Prefab::Options.new.collect_max_paths
+    assert_equal 100, Prefab::Options.new(collect_max_paths: 100).collect_max_paths
+  end
+
+  def test_collect_max_paths_with_local_only
+    options = Prefab::Options.new(collect_max_paths: 100,
+                                  prefab_datasources: Prefab::Options::DATASOURCES::LOCAL_ONLY)
+    assert_equal 0, options.collect_max_paths
+  end
+
+  def test_collect_max_paths_with_collect_logs_false
+    options = Prefab::Options.new(collect_max_paths: 100,
+                                  collect_logs: false)
+    assert_equal 0, options.collect_max_paths
+  end
+end

data/test/test_weighted_value_resolver.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class TestWeightedValueResolver < Minitest::Test
+  KEY = 'config_key'
+
+  def test_resolving_single_value
+    values = weighted_values([['abc', 1]])
+    resolver = Prefab::WeightedValueResolver.new(values, KEY, nil)
+    assert_equal 'abc', resolver.resolve.value.string
+  end
+
+  def test_resolving_multiple_values_evenly_distributed
+    values = weighted_values([['abc', 1], ['def', 1]])
+
+    resolver = Prefab::WeightedValueResolver.new(values, KEY, 'user:001')
+    assert_equal 'abc', resolver.resolve.value.string
+
+    resolver = Prefab::WeightedValueResolver.new(values, KEY, 'user:456')
+    assert_equal 'def', resolver.resolve.value.string
+  end
+
+  def test_resolving_multiple_values_unevenly_distributed
+    values = weighted_values([['abc', 1], ['def', 98], ['ghi', 1]])
+
+    resolver = Prefab::WeightedValueResolver.new(values, KEY, 'user:456')
+    assert_equal 'def', resolver.resolve.value.string
+
+    resolver = Prefab::WeightedValueResolver.new(values, KEY, 'user:103')
+    assert_equal 'ghi', resolver.resolve.value.string
+
+    resolver = Prefab::WeightedValueResolver.new(values, KEY, 'user:119')
+    assert_equal 'abc', resolver.resolve.value.string
+  end
+
+  def test_resolving_multiple_values_with_simulation
+    values = weighted_values([['abc', 1], ['def', 98], ['ghi', 1]])
+    results = {}
+
+    10_000.times do |i|
+      result = Prefab::WeightedValueResolver.new(values, KEY, "user:#{i}").resolve.value.string
+      results[result] ||= 0
+      results[result] += 1
+    end
+
+    assert_in_delta 100, results['abc'], 20
+    assert_in_delta 9800, results['def'], 50
+    assert_in_delta 100, results['ghi'], 20
+  end
+
+  private
+
+  def weighted_values(values_and_weights)
+    values_and_weights.map do |value, weight|
+      weighted_value(value, weight)
+    end
+  end
+
+  def weighted_value(string, weight)
+    Prefab::WeightedValue.new(
+      value: Prefab::ConfigValue.new(string: string), weight: weight
+    )
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prefab-cloud-ruby
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Jeff Dwyer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-02 00:00:00.000000000 Z
+date: 2023-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -45,7 +45,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ld-eventsource
+  name: googleapis-common-protos-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -59,7 +59,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: grpc
+  name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -73,7 +73,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: google-protobuf
+  name: grpc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,7 +87,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: googleapis-common-protos-types
+  name: ld-eventsource
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -101,13 +101,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: benchmark-ips
+  name: uuid
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -115,7 +115,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: grpc-tools
+  name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -129,7 +129,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -143,7 +143,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: grpc-tools
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -171,7 +171,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.4.9
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -185,7 +185,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: thin
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -207,7 +207,9 @@ extra_rdoc_files:
 - README.md
 files:
 - ".envrc"
+- ".envrc.sample"
 - ".github/workflows/ruby.yml"
+- ".gitmodules"
 - ".tool-versions"
 - CODEOWNERS
 - Gemfile
@@ -222,15 +224,18 @@ files:
 - lib/prefab/cancellable_interceptor.rb
 - lib/prefab/client.rb
 - lib/prefab/config_client.rb
-- lib/prefab/config_helper.rb
 - lib/prefab/config_loader.rb
 - lib/prefab/config_resolver.rb
+- lib/prefab/config_value_unwrapper.rb
+- lib/prefab/criteria_evaluator.rb
 - lib/prefab/error.rb
 - lib/prefab/errors/initialization_timeout_error.rb
 - lib/prefab/errors/invalid_api_key_error.rb
 - lib/prefab/errors/missing_default_error.rb
 - lib/prefab/feature_flag_client.rb
 - lib/prefab/internal_logger.rb
+- lib/prefab/local_config_parser.rb
+- lib/prefab/log_path_collector.rb
 - lib/prefab/logger_client.rb
 - lib/prefab/murmer3.rb
 - lib/prefab/noop_cache.rb
@@ -238,20 +243,29 @@ files:
 - lib/prefab/options.rb
 - lib/prefab/ratelimit_client.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
-- run_test_harness_server.sh
 - test/.prefab.default.config.yaml
 - test/.prefab.unit_tests.config.yaml
-- test/harness_server.rb
+- test/integration_test.rb
+- test/integration_test_helpers.rb
 - test/test_client.rb
 - test/test_config_client.rb
 - test/test_config_loader.rb
 - test/test_config_resolver.rb
+- test/test_config_value_unwrapper.rb
+- test/test_criteria_evaluator.rb
 - test/test_feature_flag_client.rb
 - test/test_helper.rb
+- test/test_integration.rb
+- test/test_local_config_parser.rb
+- test/test_log_path_collector.rb
 - test/test_logger.rb
+- test/test_options.rb
+- test/test_weighted_value_resolver.rb
 homepage: http://github.com/prefab-cloud/prefab-cloud-ruby
 licenses:
 - MIT

data/lib/prefab/config_helper.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-module Prefab
-  module ConfigHelper
-    def value_of(config_value)
-      case config_value.type
-      when :string
-        config_value.string
-      when :int
-        config_value.int
-      when :double
-        config_value.double
-      when :bool
-        config_value.bool
-      when :feature_flag
-        config_value.feature_flag
-      when :segment
-        config_value.segment
-      when :log_level
-        config_value.log_level
-      end
-    end
-
-    def value_of_variant(feature_flag_variant)
-      return feature_flag_variant.string if feature_flag_variant.has_string?
-      return feature_flag_variant.int if feature_flag_variant.has_int?
-      return feature_flag_variant.double if feature_flag_variant.has_double?
-      return feature_flag_variant.bool if feature_flag_variant.has_bool?
-      return nil
-    end
-  end
-end

data/run_test_harness_server.sh

@@ -1,8 +0,0 @@
-#! /usr/bin/env bash
-
-PREFAB_CDN_URL="https://api-prefab-cloud.global.ssl.fastly.net" \
-  PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL=debug \
-  PREFAB_CLOUD_HTTP=true \
-  PREFAB_API_KEY="1|local_development_api_key" \
-  PREFAB_GRPC_URL="localhost:50051" \
-  ruby -Ilib test/harness_server.rb

data/test/harness_server.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-require 'prefab-cloud-ruby'
-require 'rack'
-require 'base64'
-require 'json'
-
-handler = Rack::Handler::Thin
-
-#
-# This is a very lightweight server that allows the compliance harness to excercise the prefab client
-#
-class RackApp
-  def call(env)
-    props = CGI::parse(env["QUERY_STRING"])
-    props = JSON.parse(Base64.decode64(props["props"][0]))
-
-    key = props["key"]
-    namespace = props["namespace"]
-    api_key = props["api_key"]
-    user_key = props["user_key"]
-    is_feature_flag = !props["feature_flag"].nil?
-    attributes = props["attributes"]
-    puts props
-
-    options = Prefab::Options.new(
-      api_key: api_key,
-      namespace: namespace,
-      initialization_timeout_sec: 1,
-      # We want to `return` rather than raise so we'll use the initial payload if we can't connect to the SSE server
-      on_init_failure: Prefab::Options::ON_INITIALIZATION_FAILURE::RETURN,
-      # Want to return `nil` rather than raise so we can verify empty values
-      on_no_default: Prefab::Options::ON_NO_DEFAULT::RETURN_NIL
-    )
-
-    client = Prefab::Client.new(options)
-
-    puts "Key #{key}"
-    puts "User #{user_key}"
-    puts "api_key #{api_key}"
-    puts "Namespace #{namespace}"
-    puts "Props! #{props}"
-    puts "is_feature_flag! #{is_feature_flag}"
-
-    puts client.config_client.to_s
-
-    if is_feature_flag
-      puts "EVALFF #{key} #{user_key}"
-      rtn = client.feature_flag_client.get(key, user_key, attributes).to_s
-    else
-      rtn = client.config_client.get(key).to_s
-    end
-
-    puts "return #{rtn}"
-
-    [200, { "Content-Type" => "text/plain" }, rtn]
-
-    rescue Exception => e
-      puts "ERROR #{e.message}"
-      puts e.backtrace
-      [500, { "Content-Type" => "text/plain" }, e.message]
-  end
-end
-
-handler.run RackApp.new