prefab-cloud-ruby 0.24.2 → 0.24.4

data/test/test_logger.rb

@@ -10,10 +10,10 @@ class TestLogger < Minitest::Test
   WRONG_ENV_VALUE = 'ERROR'
   PROJECT_ENV_ID = 1
 
-  DEFAULT_ROW = Prefab::ConfigRow.new(
+  DEFAULT_ROW = PrefabProto::ConfigRow.new(
     values: [
-      Prefab::ConditionalValue.new(
-        value: Prefab::ConfigValue.new(log_level: DEFAULT_VALUE)
+      PrefabProto::ConditionalValue.new(
+        value: PrefabProto::ConfigValue.new(log_level: DEFAULT_VALUE)
       )
     ]
   )
@@ -85,46 +85,47 @@ class TestLogger < Minitest::Test
   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)
-    mock_logdev.verify
+    prefab, io = captured_logger
+    prefab.log.log_internal('test message', 'test.path', '', ::Logger::WARN)
+    assert_logged io, 'WARN', "cloud.prefab.client.test.path", "test message"
   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)
-    mock_logdev.verify
+    prefab, io = captured_logger
+    prefab.log.log_internal('test message', 'test.path', '', ::Logger::UNKNOWN)
+    assert_logged io, 'ANY', "cloud.prefab.client.test.path", "test message"
   end
 
   def test_log_internal_silencing
-    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)
+    prefab, io = captured_logger
+    prefab.log.silence do
+      prefab.log.log_internal('should not log', 'test.path', '', ::Logger::WARN)
     end
-    logger.log_internal('should log', 'test.path', '', ::Logger::WARN)
-    mock_logdev.verify
+    prefab.log.log_internal('should log', 'test.path', '', ::Logger::WARN)
+    assert_logged io, 'WARN', "cloud.prefab.client.test.path", "should log"
+    refute_logged io, 'should not log'
   end
 
   def test_log
-    logger, mock_logdev = mock_logger_expecting(/W, \[.*\]  WARN -- test.path: : test message/)
-    logger.log('test message', 'test.path', '', ::Logger::WARN)
-    mock_logdev.verify
+    prefab, io = captured_logger
+    prefab.log.log('test message', 'test.path', '', ::Logger::WARN)
+    assert_logged io, 'WARN', "test.path", "test message"
   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)
-    mock_logdev.verify
+    prefab, io = captured_logger
+    prefab.log.log('test message', 'test.path', '', ::Logger::UNKNOWN)
+    assert_logged io, 'ANY', "test.path", "test message"
   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)
+    prefab, io = captured_logger
+    prefab.log.silence do
+      prefab.log.log('should not log', 'test.path', '', ::Logger::WARN)
     end
-    logger.log('should log', 'test.path', '', ::Logger::WARN)
-    mock_logdev.verify
+    prefab.log.log('should log', 'test.path', '', ::Logger::WARN)
+    assert_logged io, 'WARN', "test.path", "should log"
+    refute_logged io, 'should not log'
   end
 
   def test_logging_with_prefix
@@ -163,7 +164,7 @@ class TestLogger < Minitest::Test
     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
@@ -172,50 +173,50 @@ class TestLogger < Minitest::Test
     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
 
   def test_logging_with_criteria_on_top_level_key
     prefix = 'my.own.prefix'
 
-    config = Prefab::Config.new(
+    config = PrefabProto::Config.new(
       key: 'log-level',
       rows: [
         DEFAULT_ROW,
 
         # wrong env
-        Prefab::ConfigRow.new(
+        PrefabProto::ConfigRow.new(
           project_env_id: TEST_ENV_ID,
           values: [
-            Prefab::ConditionalValue.new(
+            PrefabProto::ConditionalValue.new(
               criteria: [
-                Prefab::Criterion.new(
-                  operator: Prefab::Criterion::CriterionOperator::PROP_IS_ONE_OF,
+                PrefabProto::Criterion.new(
+                  operator: PrefabProto::Criterion::CriterionOperator::PROP_IS_ONE_OF,
                   value_to_match: string_list(['hotmail.com', 'gmail.com']),
                   property_name: 'user.email_suffix'
                 )
               ],
-              value: Prefab::ConfigValue.new(log_level: WRONG_ENV_VALUE)
+              value: PrefabProto::ConfigValue.new(log_level: WRONG_ENV_VALUE)
             )
           ]
         ),
 
         # correct env
-        Prefab::ConfigRow.new(
+        PrefabProto::ConfigRow.new(
           project_env_id: PROJECT_ENV_ID,
           values: [
-            Prefab::ConditionalValue.new(
+            PrefabProto::ConditionalValue.new(
               criteria: [
-                Prefab::Criterion.new(
-                  operator: Prefab::Criterion::CriterionOperator::PROP_IS_ONE_OF,
+                PrefabProto::Criterion.new(
+                  operator: PrefabProto::Criterion::CriterionOperator::PROP_IS_ONE_OF,
                   value_to_match: string_list(['hotmail.com', 'gmail.com']),
                   property_name: 'user.email_suffix'
                 )
               ],
-              value: Prefab::ConfigValue.new(log_level: DESIRED_VALUE)
+              value: PrefabProto::ConfigValue.new(log_level: DESIRED_VALUE)
             ),
-            Prefab::ConditionalValue.new(
-              value: Prefab::ConfigValue.new(log_level: DEFAULT_ENV_VALUE)
+            PrefabProto::ConditionalValue.new(
+              value: PrefabProto::ConfigValue.new(log_level: DEFAULT_ENV_VALUE)
             )
           ]
         )
@@ -271,56 +272,56 @@ class TestLogger < Minitest::Test
   def test_logging_with_criteria_on_key_path
     prefix = 'my.own.prefix'
 
-    config = Prefab::Config.new(
+    config = PrefabProto::Config.new(
       key: 'log-level.my.own.prefix.test.test_logger',
       rows: [
         DEFAULT_ROW,
 
         # wrong env
-        Prefab::ConfigRow.new(
+        PrefabProto::ConfigRow.new(
           project_env_id: TEST_ENV_ID,
           values: [
-            Prefab::ConditionalValue.new(
+            PrefabProto::ConditionalValue.new(
               criteria: [
-                Prefab::Criterion.new(
-                  operator: Prefab::Criterion::CriterionOperator::PROP_IS_ONE_OF,
+                PrefabProto::Criterion.new(
+                  operator: PrefabProto::Criterion::CriterionOperator::PROP_IS_ONE_OF,
                   value_to_match: string_list(['hotmail.com', 'gmail.com']),
                   property_name: 'email_suffix'
                 )
               ],
-              value: Prefab::ConfigValue.new(log_level: WRONG_ENV_VALUE)
+              value: PrefabProto::ConfigValue.new(log_level: WRONG_ENV_VALUE)
             )
           ]
         ),
 
         # correct env
-        Prefab::ConfigRow.new(
+        PrefabProto::ConfigRow.new(
           project_env_id: PROJECT_ENV_ID,
           values: [
-            Prefab::ConditionalValue.new(
+            PrefabProto::ConditionalValue.new(
               criteria: [
-                Prefab::Criterion.new(
-                  operator: Prefab::Criterion::CriterionOperator::PROP_IS_ONE_OF,
+                PrefabProto::Criterion.new(
+                  operator: PrefabProto::Criterion::CriterionOperator::PROP_IS_ONE_OF,
                   value_to_match: string_list(['hotmail.com', 'gmail.com']),
                   property_name: 'user.email_suffix'
                 )
               ],
-              value: Prefab::ConfigValue.new(log_level: DESIRED_VALUE)
+              value: PrefabProto::ConfigValue.new(log_level: DESIRED_VALUE)
             ),
 
-            Prefab::ConditionalValue.new(
+            PrefabProto::ConditionalValue.new(
               criteria: [
-                Prefab::Criterion.new(
-                  operator: Prefab::Criterion::CriterionOperator::PROP_IS_ONE_OF,
+                PrefabProto::Criterion.new(
+                  operator: PrefabProto::Criterion::CriterionOperator::PROP_IS_ONE_OF,
                   value_to_match: string_list(%w[user:4567]),
                   property_name: 'user.tracking_id'
                 )
               ],
-              value: Prefab::ConfigValue.new(log_level: DESIRED_VALUE)
+              value: PrefabProto::ConfigValue.new(log_level: DESIRED_VALUE)
             ),
 
-            Prefab::ConditionalValue.new(
-              value: Prefab::ConfigValue.new(log_level: DEFAULT_ENV_VALUE)
+            PrefabProto::ConditionalValue.new(
+              value: PrefabProto::ConfigValue.new(log_level: DEFAULT_ENV_VALUE)
             )
           ]
         )
@@ -399,35 +400,19 @@ class TestLogger < Minitest::Test
       raise 'THIS WILL NEVER BE EVALUATED'
     end
 
-    assert_logged io, 'ERROR', 'test.test_logger.test_logging_with_a_block', ' ' + message
+    assert_logged io, 'ERROR', 'test.test_logger.test_logging_with_a_block', message
   end
 
   private
 
   def assert_logged(logged_io, level, path, message)
-    assert_match(/#{level}\s+\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} [-+]?\d+:\s+#{path}: #{message}\n/, logged_io.string)
+    assert_match(/#{level}\s+\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} [-+]?\d+:\s+#{path} #{message}\n/, logged_io.string)
   end
 
   def refute_logged(logged_io, message)
     refute_match(/#{message}/, logged_io.string)
   end
 
-  def mock_logger_expecting(pattern, configs = {}, calls: 1)
-    mock_logdev = Minitest::Mock.new
-    mock_logdev.expect :write, nil do |arg|
-      pattern.match(arg)
-    end
-
-    calls.times.each do
-      mock_logdev.expect(:nil?, false)
-    end
-
-    logger = Prefab::LoggerClient.new($stdout)
-    logger.instance_variable_set('@logdev', mock_logdev)
-    logger.set_config_client(MockConfigClient.new(configs))
-    [logger, mock_logdev]
-  end
-
   def captured_logger(options = {})
     io = StringIO.new
     options = Prefab::Options.new(**options.merge(

data/test/test_weighted_value_resolver.rb

@@ -58,8 +58,8 @@ class TestWeightedValueResolver < Minitest::Test
   end
 
   def weighted_value(string, weight)
-    Prefab::WeightedValue.new(
-      value: Prefab::ConfigValue.new(string: string), weight: weight
+    PrefabProto::WeightedValue.new(
+      value: PrefabProto::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.24.2
+  version: 0.24.4
 platform: ruby
 authors:
 - Jeff Dwyer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-12 00:00:00.000000000 Z
+date: 2023-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -172,9 +172,11 @@ dependencies:
         version: '0'
 description: Feature Flags, Live Config, and Dynamic Log Levels as a service
 email: jdwyer@prefab.cloud
-executables: []
+executables:
+- console
 extensions: []
 extra_rdoc_files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 files:
@@ -182,7 +184,9 @@ files:
 - ".envrc.sample"
 - ".github/workflows/ruby.yml"
 - ".gitmodules"
+- ".rubocop.yml"
 - ".tool-versions"
+- CHANGELOG.md
 - CODEOWNERS
 - Gemfile
 - Gemfile.lock
@@ -190,6 +194,7 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- bin/console
 - compile_protos.sh
 - lib/prefab-cloud-ruby.rb
 - lib/prefab/client.rb
@@ -197,25 +202,32 @@ files:
 - lib/prefab/config_loader.rb
 - lib/prefab/config_resolver.rb
 - lib/prefab/config_value_unwrapper.rb
+- lib/prefab/config_value_wrapper.rb
 - lib/prefab/context.rb
+- lib/prefab/context_shape.rb
+- lib/prefab/context_shape_aggregator.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/evaluated_configs_aggregator.rb
+- lib/prefab/evaluated_keys_aggregator.rb
 - lib/prefab/exponential_backoff.rb
 - lib/prefab/feature_flag_client.rb
 - lib/prefab/http_connection.rb
 - lib/prefab/internal_logger.rb
 - lib/prefab/local_config_parser.rb
-- lib/prefab/log_path_collector.rb
+- lib/prefab/log_path_aggregator.rb
 - lib/prefab/logger_client.rb
 - lib/prefab/murmer3.rb
 - lib/prefab/noop_cache.rb
 - lib/prefab/noop_stats.rb
 - lib/prefab/options.rb
+- lib/prefab/periodic_sync.rb
 - lib/prefab/resolved_config_presenter.rb
 - lib/prefab/sse_logger.rb
+- lib/prefab/time_helpers.rb
 - lib/prefab/weighted_value_resolver.rb
 - lib/prefab/yaml_config_parser.rb
 - lib/prefab_pb.rb
@@ -230,13 +242,17 @@ files:
 - test/test_config_resolver.rb
 - test/test_config_value_unwrapper.rb
 - test/test_context.rb
+- test/test_context_shape.rb
+- test/test_context_shape_aggregator.rb
 - test/test_criteria_evaluator.rb
+- test/test_evaluated_configs_aggregator.rb
+- test/test_evaluated_keys_aggregator.rb
 - test/test_exponential_backoff.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_log_path_aggregator.rb
 - test/test_logger.rb
 - test/test_options.rb
 - test/test_weighted_value_resolver.rb

data/lib/prefab/log_path_collector.rb

@@ -1,102 +0,0 @@
-# frozen_string_literal: true
-
-module Prefab
-  class LogPathCollector
-    INCREMENT = ->(count) { (count || 0) + 1 }
-
-    SEVERITY_KEY = {
-      ::Logger::DEBUG => 'debugs',
-      ::Logger::INFO => 'infos',
-      ::Logger::WARN => 'warns',
-      ::Logger::ERROR => 'errors',
-      ::Logger::FATAL => 'fatals'
-    }.freeze
-
-    def initialize(client:, max_paths:, sync_interval:)
-      @max_paths = max_paths
-      @client = client
-      @start_at = now
-      @sync_interval = if sync_interval.is_a?(Numeric)
-                         proc { sync_interval }
-                       else
-                         sync_interval || ExponentialBackoff.new(initial_delay: 8, max_delay: 60 * 10)
-                       end
-
-      @pool = Concurrent::ThreadPoolExecutor.new(
-        fallback_policy: :discard,
-        max_queue: 5,
-        max_threads: 4,
-        min_threads: 1,
-        name: 'prefab-log-paths'
-      )
-
-      @paths = Concurrent::Map.new
-
-      start_periodic_sync
-    end
-
-    def push(path, severity)
-      return unless @paths.size < @max_paths
-
-      @paths.compute([path, severity], &INCREMENT)
-    end
-
-    private
-
-    def sync
-      return if @paths.size.zero?
-
-      log_internal "Syncing #{@paths.size} paths"
-
-      flush
-    end
-
-    def flush
-      to_ship = @paths.dup
-      @paths.clear
-
-      start_at_was = @start_at
-      @start_at = now
-
-      @pool.post do
-        log_internal "Uploading stats for #{to_ship.size} paths"
-
-        aggregate = Hash.new { |h, k| h[k] = Prefab::Logger.new }
-
-        to_ship.each do |(path, severity), count|
-          aggregate[path][SEVERITY_KEY[severity]] = count
-          aggregate[path]['logger_name'] = path
-        end
-
-        loggers = Prefab::Loggers.new(
-          loggers: aggregate.values,
-          start_at: start_at_was,
-          end_at: now,
-          instance_hash: @client.instance_hash,
-          namespace: @client.namespace
-        )
-
-        @client.post('/api/v1/known-loggers', loggers)
-      end
-    end
-
-    def start_periodic_sync
-      Thread.new do
-        log_internal "Initialized log path collector instance_hash=#{@client.instance_hash} max_paths=#{@max_paths}"
-
-        loop do
-          sleep @sync_interval.call
-          sync
-        end
-      end
-    end
-
-    def log_internal(message)
-      @client.log.log_internal message, 'log_path_collector', nil, ::Logger::DEBUG
-    end
-
-    def now
-      (Time.now.utc.to_f * 1000).to_i
-    end
-  end
-end

data/test/test_log_path_collector.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-require 'timecop'
-
-class TestLogPathCollector < Minitest::Test
-  MAX_WAIT = 2
-  SLEEP_TIME = 0.01
-
-  def test_sync
-    Timecop.freeze do
-      client = new_client(namespace: 'this.is.a.namespace')
-
-      2.times { client.log.info('here is a message') }
-      3.times { client.log.error('here is a message') }
-
-      requests = []
-
-      client.define_singleton_method(:post) do |*params|
-        requests.push(params)
-      end
-
-      client.log_path_collector.send(:sync)
-
-      # let the flush thread run
-
-      wait_time = 0
-      while requests.length == 0
-        wait_time += SLEEP_TIME
-        sleep SLEEP_TIME
-
-        raise "Waited #{MAX_WAIT} seconds for the flush thread to run, but it never did" if wait_time > MAX_WAIT
-      end
-
-      assert_equal requests, [[
-        '/api/v1/known-loggers',
-        Prefab::Loggers.new(
-          loggers: [Prefab::Logger.new(logger_name: 'test.test_log_path_collector.test_sync',
-                                       infos: 2, errors: 3)],
-          start_at: (Time.now.utc.to_f * 1000).to_i,
-          end_at: (Time.now.utc.to_f * 1000).to_i,
-          instance_hash: client.instance_hash,
-          namespace: 'this.is.a.namespace'
-        )
-      ]]
-    end
-  end
-
-  private
-
-  def new_client(overrides = {})
-    super(**{
-      prefab_datasources: Prefab::Options::DATASOURCES::ALL,
-      api_key: '123-development-yourapikey-SDK',
-      collect_sync_interval: 1000 # we'll trigger sync manually in our test
-    }.merge(overrides))
-  end
-end