prefab-cloud-ruby 0.16.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82381e4b656d675f4b98ee11601cde1920637e52eb5b039814247500207b9fa5
-  data.tar.gz: 4ff8914774523e745d512d506cc42f20e71a657fd8191d82e7e6ba1878bf04c9
+  metadata.gz: d9225ebaadf8be997d152b66cb58ff342d126bc5cfbe489511af4791d89dd5f7
+  data.tar.gz: cbaf511c7aeaf0ef743b33c2ad00c40bd4d6c8ddba0a17ddff541afeb8e055d9
 SHA512:
-  metadata.gz: aac3fc04c779900ca92a6a859430a2fe7776bee90afba632456ff45e3bacb428dda61314d3cbf5a5b04ce61672e4591afb7ae0248b77352b381f52dcbbfb6f24
-  data.tar.gz: 5e2008ec802e2f32154bffb34804673187feb618a60edf2aba19666851787e14111e3d6e0fbeeebe8e3192cac56a32f3010b4d46ef507c3d16359886973ee90c
+  metadata.gz: f00e343e6f3f7a7f11351409708979c4e02420eae8bf8d9520cdc58de464b682158b863bcab88b4583c469709c621f066bd8995e482963386b931c877bfd2b1f
+  data.tar.gz: 5e51d64d2d5adc738e5f8438cd222ae3e4d9fc1f183a789d25486da7197b25c3263fff9a0fac9b33a9acffc169e035630e7a8cb8b3d3770e9e8b669d34b96f68

data/Gemfile

@@ -10,7 +10,7 @@ gem 'googleapis-common-protos-types', :platforms => :ruby
 group :development do
   gem 'benchmark-ips'
   gem 'grpc-tools', :platforms => :ruby
-  gem "rdoc", "~> 3.12"
+  gem "rdoc"
   gem "bundler"
   gem "juwelier", "~> 2.4.9"
   gem "simplecov", ">= 0"

data/Gemfile.lock

@@ -47,7 +47,6 @@ GEM
     http-cookie (1.0.4)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
-    json (1.8.6)
     juwelier (2.4.9)
       builder
       bundler
@@ -89,8 +88,7 @@ GEM
     rack (2.2.4)
     rake (13.0.3)
     rchardet (1.8.0)
-    rdoc (3.12.2)
-      json (~> 1.4)
+    rdoc (6.3.3)
     ruby2_keywords (0.0.4)
     semver2 (3.4.2)
     simplecov (0.18.5)
@@ -121,7 +119,7 @@ DEPENDENCIES
   juwelier (~> 2.4.9)
   ld-eventsource
   minitest
-  rdoc (~> 3.12)
+  rdoc
   simplecov
   thin
 

data/README.md

@@ -31,8 +31,7 @@ Many ruby web servers fork. GRPC does not like to be forked. You should manually
 ```ruby
 
 #config/initializers/prefab.rb
-$prefab = Prefab::Client.new(shared_cache: Rails.cache,
-                             logdev: $stdout)
+$prefab = Prefab::Client.new
 Rails.logger = $prefab.log
 ```
 
@@ -45,7 +44,7 @@ end
 
 ## Logging & Debugging
 In classpath or ~/.prefab.overrides.config.yaml set
-```log_level.prefab: debug```
+```log-level.prefab: debug```
 
 To debug issues before this config file has been read, set env var
 ```

data/VERSION

@@ -1 +1 @@
-0.16.0
+0.18.0

data/lib/prefab/auth_interceptor.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 module Prefab
   class AuthInterceptor < GRPC::ClientInterceptor
+    VERSION = File.exist?('VERSION') ? File.read('VERSION').chomp : ""
+    CLIENT = "prefab-cloud-ruby.#{VERSION}".freeze
+
     def initialize(api_key)
-      version = File.exist?('VERSION') ? File.read('VERSION').chomp : ""
-      @client = "prefab-cloud-ruby.#{version}".freeze
       @api_key = api_key
     end
 
@@ -25,7 +26,7 @@ module Prefab
 
     def shared(metadata)
       metadata['auth'] = @api_key
-      metadata['client'] = @client
+      metadata['client'] = CLIENT
       yield
     end
   end

data/lib/prefab/config_client.rb

@@ -149,8 +149,7 @@ module Prefab
     end
 
     def load_checkpoint_api_cdn
-      key_hash = Murmur3.murmur3_32(@base_client.api_key)
-      url = "#{@options.url_for_api_cdn}/api/v1/configs/0/#{key_hash}/0"
+      url = "#{@options.url_for_api_cdn}/api/v1/configs/0"
       conn = if Faraday::VERSION[0].to_i >= 2
                Faraday.new(url) do |conn|
                  conn.request :authorization, :basic, AUTH_USER, @base_client.api_key

data/lib/prefab/config_helper.rb

@@ -15,6 +15,8 @@ module Prefab
         config_value.feature_flag
       when :segment
         config_value.segment
+      when :log_level
+        config_value.log_level
       end
     end
 

data/lib/prefab/config_loader.rb

@@ -102,7 +102,7 @@ module Prefab
           config: Prefab::Config.new(
             key: k,
             rows: [
-              Prefab::ConfigRow.new(value: Prefab::ConfigValue.new(value_from(v)))
+              Prefab::ConfigRow.new(value: Prefab::ConfigValue.new(value_from(k, v)))
             ]
           )
         }
@@ -119,10 +119,15 @@ module Prefab
       end
     end
 
-    def value_from(raw)
+    def value_from(key, raw)
       case raw
       when String
-        { string: raw }
+        if key.start_with? Prefab::LoggerClient::BASE_KEY
+          prefab_log_level_resolve = Prefab::LogLevel.resolve(raw.upcase.to_sym) || Prefab::LogLevel::NOT_SET_LOG_LEVEL
+          { log_level: prefab_log_level_resolve }
+        else
+          { string: raw }
+        end
       when Integer
         { int: raw }
       when TrueClass, FalseClass
@@ -165,7 +170,7 @@ module Prefab
         match: key,
         config: Prefab::Config.new(
           key: key,
-          variants: [Prefab::FeatureFlagVariant.new(value_from(value['value']))],
+          variants: [Prefab::FeatureFlagVariant.new(value_from(key, value['value']))],
           rows: [row]
         )
       }

data/lib/prefab/logger_client.rb

@@ -3,12 +3,22 @@ module Prefab
   class LoggerClient < Logger
 
     SEP = "."
-    BASE = "log_level"
-    UNKNOWN = "unknown"
+    BASE_KEY = "log-level"
+    UNKNOWN_PATH = "unknown."
+
+    LOG_LEVEL_LOOKUPS = {
+      Prefab::LogLevel::NOT_SET_LOG_LEVEL => Logger::DEBUG,
+      Prefab::LogLevel::TRACE => Logger::DEBUG,
+      Prefab::LogLevel::DEBUG => Logger::DEBUG,
+      Prefab::LogLevel::INFO => Logger::INFO,
+      Prefab::LogLevel::WARN => Logger::WARN,
+      Prefab::LogLevel::ERROR => Logger::ERROR,
+      Prefab::LogLevel::FATAL => Logger::FATAL
+    }
 
     def initialize(logdev, formatter: nil)
       super(logdev)
-      self.formatter= formatter
+      self.formatter = formatter
       @config_client = BootstrappingConfigClient.new
       @silences = Concurrent::Map.new(:initial_capacity => 2)
     end
@@ -26,7 +36,7 @@ module Prefab
     def log_internal(message, path, progname, severity, &block)
       level = level_of(path)
       progname = "#{path}: #{progname}"
-      severity ||= UNKNOWN
+      severity ||= Logger::UNKNOWN
       if @logdev.nil? || severity < level || @silences[local_log_id]
         return true
       end
@@ -109,8 +119,8 @@ module Prefab
 
     # Find the closest match to 'log_level.path' in config
     def level_of(path)
-      closest_log_level_match = @config_client.get(BASE, :warn)
-      path.split(SEP).inject([BASE]) do |memo, n|
+      closest_log_level_match = @config_client.get(BASE_KEY, :WARN)
+      path.split(SEP).inject([BASE_KEY]) do |memo, n|
         memo << n
         val = @config_client.get(memo.join(SEP), nil)
         unless val.nil?
@@ -118,7 +128,8 @@ module Prefab
         end
         memo
       end
-      val(closest_log_level_match)
+      closest_log_level_match_int = Prefab::LogLevel.resolve(closest_log_level_match)
+      LOG_LEVEL_LOOKUPS[closest_log_level_match_int]
     end
 
     def get_loc_path(loc)
@@ -129,7 +140,7 @@ module Prefab
     # sanitize & clean the path of the caller so the key
     # looks like log_level.app.models.user
     def get_path(absolute_path, base_label)
-      path = (absolute_path || UNKNOWN).dup
+      path = (absolute_path || UNKNOWN_PATH).dup
       path.slice! Dir.pwd
       path.gsub!(/(.*)?(?=\/lib)/im, "") # replace everything before first lib
 
@@ -138,17 +149,13 @@ module Prefab
       path.slice! SEP
       path
     end
-
-    def val level
-      return Object.const_get("Logger::#{level.upcase}")
-    end
   end
 
   # StubConfigClient to be used while config client initializes
   # since it may log
   class BootstrappingConfigClient
-    def get(key, default=nil)
-      ENV["PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL"] || default
+    def get(key, default = nil)
+      ENV["PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL"] ? ENV["PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL"].upcase.to_sym : default
     end
   end
 end

data/lib/prefab_pb.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: prefab.proto
 
@@ -21,6 +20,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
         optional :feature_flag, :message, 6, "prefab.FeatureFlag"
         optional :limit_definition, :message, 7, "prefab.LimitDefinition"
         optional :segment, :message, 8, "prefab.Segment"
+        optional :log_level, :enum, 9, "prefab.LogLevel"
       end
     end
     add_message "prefab.Configs" do
@@ -184,6 +184,15 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :sequence_name, :string, 3
       optional :size, :int64, 4
     end
+    add_enum "prefab.LogLevel" do
+      value :NOT_SET_LOG_LEVEL, 0
+      value :TRACE, 1
+      value :DEBUG, 2
+      value :INFO, 3
+      value :WARN, 5
+      value :ERROR, 6
+      value :FATAL, 9
+    end
     add_enum "prefab.OnFailure" do
       value :NOT_SET, 0
       value :LOG_AND_PASS, 1
@@ -222,5 +231,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
+  LogLevel = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.LogLevel").enummodule
   OnFailure = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("prefab.OnFailure").enummodule
 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.16.0 ruby lib
+# stub: prefab-cloud-ruby 0.18.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "prefab-cloud-ruby".freeze
-  s.version = "0.16.0"
+  s.version = "0.18.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 = "2022-09-01"
+  s.date = "2022-10-14"
   s.description = "RateLimits & Config as a service".freeze
   s.email = "jdwyer@prefab.cloud".freeze
   s.extra_rdoc_files = [
@@ -83,7 +83,7 @@ Gem::Specification.new do |s|
     s.add_runtime_dependency(%q<googleapis-common-protos-types>.freeze, [">= 0"])
     s.add_development_dependency(%q<benchmark-ips>.freeze, [">= 0"])
     s.add_development_dependency(%q<grpc-tools>.freeze, [">= 0"])
-    s.add_development_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+    s.add_development_dependency(%q<rdoc>.freeze, [">= 0"])
     s.add_development_dependency(%q<bundler>.freeze, [">= 0"])
     s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.4.9"])
     s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
@@ -97,7 +97,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<googleapis-common-protos-types>.freeze, [">= 0"])
     s.add_dependency(%q<benchmark-ips>.freeze, [">= 0"])
     s.add_dependency(%q<grpc-tools>.freeze, [">= 0"])
-    s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+    s.add_dependency(%q<rdoc>.freeze, [">= 0"])
     s.add_dependency(%q<bundler>.freeze, [">= 0"])
     s.add_dependency(%q<juwelier>.freeze, ["~> 2.4.9"])
     s.add_dependency(%q<simplecov>.freeze, [">= 0"])

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

@@ -16,10 +16,11 @@ nested:
     _: top level
     string: nested value
 
-logging:
+log-level:
   app:
     _: error
     controller:
       hello:
         _: warn
         index: info
+  invalid: not a valid log level

data/test/test_config_client.rb

@@ -16,6 +16,9 @@ class TestConfigClient < Minitest::Test
   def test_load
     assert_equal "test sample value", @config_client.get("sample")
     assert_equal 123, @config_client.get("sample_int")
+    assert_equal 12.12, @config_client.get("sample_double")
+    assert_equal true, @config_client.get("sample_bool")
+    assert_equal :ERROR, @config_client.get("log-level.app")
   end
 
   def test_initialization_timeout_error

data/test/test_config_loader.rb

@@ -21,9 +21,13 @@ class TestConfigLoader < Minitest::Test
   def test_nested
     should_be :string, "nested value", "nested.values.string"
     should_be :string, "top level", "nested.values"
-    should_be :string, "error", "logging.app"
-    should_be :string, "warn", "logging.app.controller.hello"
-    should_be :string, "info", "logging.app.controller.hello.index"
+    should_be :log_level, :ERROR, "log-level.app"
+    should_be :log_level, :WARN, "log-level.app.controller.hello"
+    should_be :log_level, :INFO, "log-level.app.controller.hello.index"
+  end
+
+  def test_invalid_log_level
+    should_be :log_level, :NOT_SET_LOG_LEVEL, "log-level.invalid"
   end
 
   def test_load_without_unit_test_env

data/test/test_helper.rb

@@ -69,10 +69,11 @@ def default_ff_rule(variant_idx)
   ]
 end
 
-def with_env(key, value)
+def with_env(key, value, &block)
   old_value = ENV[key]
 
   ENV[key] = value
+  block.call
 ensure
   ENV[key] = old_value
 end

data/test/test_logger.rb

@@ -20,6 +20,9 @@ class TestCLogger < Minitest::Test
     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",
+                 @logger.get_path(nil,
+                                  "info")
   end
 
   def test_loc_resolution
@@ -44,24 +47,61 @@ class TestCLogger < Minitest::Test
     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"
+                   @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"
+                   @logger.level_of("app.models.user"), "default is warn"
 
-      @logger.set_config_client(MockConfigClient.new("log_level.app" => "info"))
+      @logger.set_config_client(MockConfigClient.new("log-level.app" => :INFO))
       assert_equal Logger::INFO,
-                  @logger.level_of("app.models.user")
+                   @logger.level_of("app.models.user")
 
-      @logger.set_config_client(MockConfigClient.new("log_level.app" => "debug"))
+      @logger.set_config_client(MockConfigClient.new("log-level.app" => :DEBUG))
       assert_equal Logger::DEBUG,
-                  @logger.level_of("app.models.user")
+                   @logger.level_of("app.models.user")
 
-      @logger.set_config_client(MockConfigClient.new("log_level.app" => "debug",
-                                                    "log_level.app.models" => "warn"))
-      assert_equal Logger::WARN,
-                  @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"
     end
   end
+
+  def test_log_internal
+    logger, mock_logdev = mock_logger_expecting /W, \[.*\]  WARN -- test.path: : test message/
+    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 -- test.path: : test message/
+    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 -- test.path: : should log/, calls: 2
+    logger.silence do
+      logger.log_internal("should not log", "test.path", "", Logger::WARN)
+    end
+    logger.log_internal("should log", "test.path", "", Logger::WARN)
+    mock_logdev.verify
+  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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prefab-cloud-ruby
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Jeff Dwyer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-01 00:00:00.000000000 Z
+date: 2022-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -132,16 +132,16 @@ dependencies:
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement