prefab-cloud-ruby 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5df09f0991b0d46c29ce33bc010116733960a5004ede7dd5a0df868b15e4a29
-  data.tar.gz: ded97aa4f8e2dc37e7581ee5d29c7bcb3eff88e7aa8f72fedb7bd9710050bfec
+  metadata.gz: 2cd914702e6efb141278bbf12bf120342c0de3d788e8e6399a3baefd8f11a102
+  data.tar.gz: d7ba7ad4210bbf2f89005479e970f33b6486a67fbef125502c86455830381797
 SHA512:
-  metadata.gz: 5e44b86fabd88830aed86910f4ff9175df14a06dc30b19821c741c691a9637bcff69870de0d816c2348a650dc9eb5b3a3c54a4452f71039aaab2f042086c3536
-  data.tar.gz: d81cf8af71e9aa189e7ba8b7078af6472df4dc6e3b08a33771163363424986d8b194c0ed88fa961217758ee9e5d21ca5604810f96db53a80366d72df606cb6d7
+  metadata.gz: a797285f8e5ecffc90b5861f87af50c5aae93f6dc3ba1803b79232823ee4ff2fa4fdf4017c04712aa89fa5f607496eb99376dbc6595bcfad69e2df2ae0aa0324
+  data.tar.gz: 965bc69143e55822b5a53d691eb50ee5a883b50e85dfe3ecf868ab58b947efc717b752d287d636636846418539c2ce602451b12b4a29f596a41a41be2839ef7e

data/Gemfile.lock

@@ -94,7 +94,7 @@ GEM
     psych (3.3.1)
     public_suffix (4.0.6)
     racc (1.6.1)
-    rack (3.0.4.1)
+    rack (3.0.6.1)
     rake (13.0.6)
     rchardet (1.8.0)
     rdoc (6.3.3)

data/VERSION

@@ -1 +1 @@
-0.22.0
+0.23.0

data/lib/prefab/client.rb

@@ -40,6 +40,18 @@ module Prefab
           channel.destroy
         end
       end
+      # start config client
+      config_client
+    end
+
+    def with_log_context(lookup_key, properties)
+      Thread.current[:prefab_log_lookup_key] = lookup_key
+      Thread.current[:prefab_log_properties] = properties
+
+      yield
+    ensure
+      Thread.current[:prefab_log_lookup_key] = nil
+      Thread.current[:prefab_log_properties] = {}
     end
 
     def channel
@@ -72,6 +84,15 @@ module Prefab
                                                                    log_path_collector: log_path_collector)
     end
 
+    def set_rails_loggers
+      Rails.logger = log
+      ActionView::Base.logger = log
+      ActionController::Base.logger = log
+      ActiveJob::Base.logger = log
+      ActiveRecord::Base.logger = log
+      ActiveStorage.logger = log
+    end
+
     def log_internal(level, msg, path = nil)
       log.log_internal msg, path, nil, level
     end

data/lib/prefab/config_client.rb

@@ -74,6 +74,7 @@ module Prefab
 
     def get(key, default = Prefab::Client::NO_DEFAULT_PROVIDED, properties = {}, lookup_key = nil)
       value = _get(key, lookup_key, properties)
+
       value ? Prefab::ConfigValueUnwrapper.unwrap(value, key, properties) : handle_default(key, default)
     end
 

data/lib/prefab/logger_client.rb

@@ -131,14 +131,26 @@ module Prefab
 
     private
 
+    NO_DEFAULT = nil
+
     # Find the closest match to 'log_level.path' in config
     def level_of(path)
-      closest_log_level_match = @config_client.get(BASE_KEY, :WARN)
+      properties = Thread.current[:prefab_log_properties] || {}
+      lookup_key = Thread.current[:prefab_log_lookup_key] || nil
+
+      closest_log_level_match = nil
+
       path.split(SEP).each_with_object([BASE_KEY]) do |n, memo|
         memo << n
-        val = @config_client.get(memo.join(SEP), nil)
+        val = @config_client.get(memo.join(SEP), NO_DEFAULT, properties, lookup_key)
         closest_log_level_match = val unless val.nil?
       end
+
+      if closest_log_level_match.nil?
+        # get the top-level setting or default to WARN
+        closest_log_level_match = @config_client.get(BASE_KEY, :WARN, properties, lookup_key)
+      end
+
       closest_log_level_match_int = Prefab::LogLevel.resolve(closest_log_level_match)
       LOG_LEVEL_LOOKUPS[closest_log_level_match_int]
     end
@@ -165,7 +177,7 @@ module Prefab
   # StubConfigClient to be used while config client initializes
   # since it may log
   class BootstrappingConfigClient
-    def get(_key, default = nil)
+    def get(_key, default = nil, _properties = {}, _lookup_key = nil)
       ENV['PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL'] ? ENV['PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL'].upcase.to_sym : default
     end
   end

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.22.0 ruby lib
+# stub: prefab-cloud-ruby 0.23.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "prefab-cloud-ruby".freeze
-  s.version = "0.22.0"
+  s.version = "0.23.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-03-15"
+  s.date = "2023-03-28"
   s.description = "RateLimits & Config as a service".freeze
   s.email = "jdwyer@prefab.cloud".freeze
   s.extra_rdoc_files = [

data/test/test_config_resolver.rb

@@ -374,8 +374,4 @@ class TestConfigResolver < Minitest::Test
     resolver.update
     resolver
   end
-
-  def string_list(values)
-    Prefab::ConfigValue.new(string_list: Prefab::StringList.new(values: values))
-  end
 end

data/test/test_helper.rb

@@ -43,7 +43,7 @@ class MockConfigClient
     @config_values = config_values
   end
 
-  def get(key, default = nil)
+  def get(key, default = nil, _, _)
     @config_values.fetch(key, default)
   end
 
@@ -93,3 +93,19 @@ def new_client(overrides = {})
 
   Prefab::Client.new(options)
 end
+
+def string_list(values)
+  Prefab::ConfigValue.new(string_list: Prefab::StringList.new(values: values))
+end
+
+def inject_config(client, config)
+  resolver = client.config_client.instance_variable_get('@config_resolver')
+  store = resolver.instance_variable_get('@local_store')
+
+  store[config.key] = { config: config }
+end
+
+def inject_project_env_id(client, project_env_id)
+  resolver = client.config_client.instance_variable_get('@config_resolver')
+  resolver.project_env_id = project_env_id
+end

data/test/test_logger.rb

@@ -2,7 +2,22 @@
 
 require 'test_helper'
 
-class TestCLogger < Minitest::Test
+class TestLogger < Minitest::Test
+  TEST_ENV_ID = 2
+  DEFAULT_VALUE = 'FATAL'
+  DEFAULT_ENV_VALUE = 'INFO'
+  DESIRED_VALUE = 'DEBUG'
+  WRONG_ENV_VALUE = 'ERROR'
+  PROJECT_ENV_ID = 1
+
+  DEFAULT_ROW = Prefab::ConfigRow.new(
+    values: [
+      Prefab::ConditionalValue.new(
+        value: Prefab::ConfigValue.new(log_level: DEFAULT_VALUE)
+      )
+    ]
+  )
+
   def setup
     Prefab::LoggerClient.send(:public, :get_path)
     Prefab::LoggerClient.send(:public, :get_loc_path)
@@ -160,10 +175,226 @@ class TestCLogger < Minitest::Test
     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(
+      key: 'log-level',
+      rows: [
+        DEFAULT_ROW,
+
+        # wrong env
+        Prefab::ConfigRow.new(
+          project_env_id: TEST_ENV_ID,
+          values: [
+            Prefab::ConditionalValue.new(
+              criteria: [
+                Prefab::Criterion.new(
+                  operator: Prefab::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)
+            )
+          ]
+        ),
+
+        # correct env
+        Prefab::ConfigRow.new(
+          project_env_id: PROJECT_ENV_ID,
+          values: [
+            Prefab::ConditionalValue.new(
+              criteria: [
+                Prefab::Criterion.new(
+                  operator: Prefab::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: DESIRED_VALUE)
+            ),
+            Prefab::ConditionalValue.new(
+              value: Prefab::ConfigValue.new(log_level: DEFAULT_ENV_VALUE)
+            )
+          ]
+        )
+      ]
+    )
+
+    prefab, io = captured_logger(log_prefix: prefix)
+
+    inject_config(prefab, config)
+    inject_project_env_id(prefab, PROJECT_ENV_ID)
+
+    # without any context, the level should be the default for the env (info)
+    prefab.with_log_context(nil, {}) do
+      prefab.log.debug 'Test debug'
+      refute_logged io, 'Test debug'
+
+      prefab.log.info 'Test info'
+      assert_logged io, 'INFO', "#{prefix}.test.test_logger.test_logging_with_criteria_on_top_level_key", 'Test info'
+
+      prefab.log.error 'Test error'
+      assert_logged io, 'ERROR', "#{prefix}.test.test_logger.test_logging_with_criteria_on_top_level_key", 'Test error'
+    end
+
+    reset_io(io)
+
+    # with the wrong context, the level should be the default for the env (info)
+    prefab.with_log_context('user:1234', email_suffix: 'yahoo.com') do
+      prefab.log.debug 'Test debug'
+      refute_logged io, 'Test debug'
+
+      prefab.log.info 'Test info'
+      assert_logged io, 'INFO', "#{prefix}.test.test_logger.test_logging_with_criteria_on_top_level_key", 'Test info'
+
+      prefab.log.error 'Test error'
+      assert_logged io, 'ERROR', "#{prefix}.test.test_logger.test_logging_with_criteria_on_top_level_key", 'Test error'
+    end
+
+    reset_io(io)
+
+    # with the correct context, the level should be the desired value (debug)
+    prefab.with_log_context('user:1234', email_suffix: 'hotmail.com') do
+      prefab.log.debug 'Test debug'
+      assert_logged io, 'DEBUG', "#{prefix}.test.test_logger.test_logging_with_criteria_on_top_level_key", 'Test debug'
+
+      prefab.log.info 'Test info'
+      assert_logged io, 'INFO', "#{prefix}.test.test_logger.test_logging_with_criteria_on_top_level_key", 'Test info'
+
+      prefab.log.error 'Test error'
+      assert_logged io, 'ERROR', "#{prefix}.test.test_logger.test_logging_with_criteria_on_top_level_key", 'Test error'
+    end
+  end
+
+  def test_logging_with_criteria_on_key_path
+    prefix = 'my.own.prefix'
+
+    config = Prefab::Config.new(
+      key: 'log-level.my.own.prefix.test.test_logger',
+      rows: [
+        DEFAULT_ROW,
+
+        # wrong env
+        Prefab::ConfigRow.new(
+          project_env_id: TEST_ENV_ID,
+          values: [
+            Prefab::ConditionalValue.new(
+              criteria: [
+                Prefab::Criterion.new(
+                  operator: Prefab::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)
+            )
+          ]
+        ),
+
+        # correct env
+        Prefab::ConfigRow.new(
+          project_env_id: PROJECT_ENV_ID,
+          values: [
+            Prefab::ConditionalValue.new(
+              criteria: [
+                Prefab::Criterion.new(
+                  operator: Prefab::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: DESIRED_VALUE)
+            ),
+
+            Prefab::ConditionalValue.new(
+              criteria: [
+                Prefab::Criterion.new(
+                  operator: Prefab::Criterion::CriterionOperator::LOOKUP_KEY_IN,
+                  value_to_match: string_list(%w[user:4567]),
+                  property_name: Prefab::CriteriaEvaluator::LOOKUP_KEY
+                )
+              ],
+              value: Prefab::ConfigValue.new(log_level: DESIRED_VALUE)
+            ),
+
+            Prefab::ConditionalValue.new(
+              value: Prefab::ConfigValue.new(log_level: DEFAULT_ENV_VALUE)
+            )
+          ]
+        )
+      ]
+    )
+
+    prefab, io = captured_logger(log_prefix: prefix)
+
+    inject_config(prefab, config)
+    inject_project_env_id(prefab, PROJECT_ENV_ID)
+
+    # without any context, the level should be the default for the env (info)
+    prefab.with_log_context(nil, {}) do
+      prefab.log.debug 'Test debug'
+      refute_logged io, 'Test debug'
+
+      prefab.log.info 'Test info'
+      assert_logged io, 'INFO', "#{prefix}.test.test_logger.test_logging_with_criteria_on_key_path", 'Test info'
+
+      prefab.log.error 'Test error'
+      assert_logged io, 'ERROR', "#{prefix}.test.test_logger.test_logging_with_criteria_on_key_path", 'Test error'
+    end
+
+    reset_io(io)
+
+    # with the wrong context, the level should be the default for the env (info)
+    prefab.with_log_context('user:1234', email_suffix: 'yahoo.com') do
+      prefab.log.debug 'Test debug'
+      refute_logged io, 'Test debug'
+
+      prefab.log.info 'Test info'
+      assert_logged io, 'INFO', "#{prefix}.test.test_logger.test_logging_with_criteria_on_key_path", 'Test info'
+
+      prefab.log.error 'Test error'
+      assert_logged io, 'ERROR', "#{prefix}.test.test_logger.test_logging_with_criteria_on_key_path", 'Test error'
+    end
+
+    reset_io(io)
+
+    # with the correct context, the level should be the desired value (debug)
+    prefab.with_log_context('user:1234', email_suffix: 'hotmail.com') do
+      prefab.log.debug 'Test debug'
+      assert_logged io, 'DEBUG', "#{prefix}.test.test_logger.test_logging_with_criteria_on_key_path", 'Test debug'
+
+      prefab.log.info 'Test info'
+      assert_logged io, 'INFO', "#{prefix}.test.test_logger.test_logging_with_criteria_on_key_path", 'Test info'
+
+      prefab.log.error 'Test error'
+      assert_logged io, 'ERROR', "#{prefix}.test.test_logger.test_logging_with_criteria_on_key_path", 'Test error'
+    end
+
+    reset_io(io)
+
+    # with the correct lookup key
+    prefab.with_log_context('user:4567', email_suffix: 'example.com') do
+      prefab.log.debug 'Test debug'
+      assert_logged io, 'DEBUG', "#{prefix}.test.test_logger.test_logging_with_criteria_on_key_path", 'Test debug'
+
+      prefab.log.info 'Test info'
+      assert_logged io, 'INFO', "#{prefix}.test.test_logger.test_logging_with_criteria_on_key_path", 'Test info'
+
+      prefab.log.error 'Test error'
+      assert_logged io, 'ERROR', "#{prefix}.test.test_logger.test_logging_with_criteria_on_key_path", 'Test error'
+    end
+  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}\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)
@@ -192,4 +423,11 @@ class TestCLogger < Minitest::Test
 
     [prefab, io]
   end
+
+  def reset_io(io)
+    io.close
+    io.reopen
+
+    assert_equal '', io.string
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prefab-cloud-ruby
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Jeff Dwyer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-15 00:00:00.000000000 Z
+date: 2023-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby