prefab-cloud-ruby 0.17.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96a092713ab6a3e93c9597c9457144769d954679877d35cfa21550880fb30251
-  data.tar.gz: 43aaa1cadb70983991ea7f2908d5986c47579e9057574a8cd623f4a12d2e4e3e
+  metadata.gz: f56ee15a73bef27dbb37cfbc4df7b1004543664ea7b5defc5ae6afbb738a4c23
+  data.tar.gz: 151d525aca5d58ee1098fed1f6e87037ee6b2cc8570985f2a922ec028cc3d394
 SHA512:
-  metadata.gz: 8392d08f8bdd0b6bfd89e1b1ad32fb3e1161e60f8b2ad54984d0cc1795b91476061c7b38a770263a48d217072d8562e6d4dd1b348c975f22cab092e25d017806
-  data.tar.gz: c6fc0b30a9f52d850b1e6422932691b47004a29738cf8adeafada21d734392630df00d081b4dc230a8a0ba2148ebf4d12610a4d17d3791eb02104097fce86b96
+  metadata.gz: 9d48de76dc679c635a9530625aa0feedd6ddb9193023b98e5c24247f6eded562e9ffcca770116dc5a1bc7dc60a0e7fad2f828f31b791c771c7d3aa587daf77bd
+  data.tar.gz: da2371a89c4886ac22d2ce5ef0b7b2e8b732aa8ac2600a699b1598cc1c9138c9a99e075df944d911f790f385ffea81c2b186aaf29d6b40ed7c5f05247d41d22b

data/Gemfile

@@ -19,4 +19,5 @@ end
 
 group :test do
   gem "minitest"
+  gem "minitest-focus"
 end

data/Gemfile.lock

@@ -30,7 +30,7 @@ GEM
       faraday (>= 0.8, < 2)
       hashie (~> 3.5, >= 3.5.2)
       oauth2 (~> 1.0)
-    google-protobuf (3.21.4)
+    google-protobuf (3.21.9)
     googleapis-common-protos-types (1.3.0)
       google-protobuf (~> 3.14)
     grpc (1.43.1)
@@ -70,10 +70,12 @@ GEM
       rake (~> 13.0)
     mini_portile2 (2.8.0)
     minitest (5.16.2)
+    minitest-focus (1.3.1)
+      minitest (>= 4, < 6)
     multi_json (1.15.0)
     multi_xml (0.6.0)
     multipart-post (2.1.1)
-    nokogiri (1.13.6)
+    nokogiri (1.13.9)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     oauth2 (1.4.7)
@@ -86,7 +88,7 @@ GEM
     public_suffix (4.0.6)
     racc (1.6.0)
     rack (2.2.4)
-    rake (13.0.3)
+    rake (13.0.6)
     rchardet (1.8.0)
     rdoc (6.3.3)
     ruby2_keywords (0.0.4)
@@ -119,6 +121,7 @@ DEPENDENCIES
   juwelier (~> 2.4.9)
   ld-eventsource
   minitest
+  minitest-focus
   rdoc
   simplecov
   thin

data/README.md

@@ -1,5 +1,5 @@
 # prefab-cloud-ruby
-Ruby Client for Prefab RateLimits, FeatureFlags, Config as a Service: https://www.prefab.cloud
+Ruby Client for Prefab FeatureFlags, Config as a Service: https://www.prefab.cloud
 
 ```ruby
 client = Prefab::Client.new
@@ -16,11 +16,9 @@ puts @feature_flags.feature_is_on? "MyFeature", "user:1123"
 ```
 See full documentation https://www.prefab.cloud/documentation/installation
 
-
 ## Supports
 
 * [FeatureFlags](https://www.prefab.cloud/documentation/feature_flags) as a Service
-* [RateLimits](https://www.prefab.cloud/documentation/basic_rate_limits)
 * Millions of individual limits sharing the same policies
 * WebUI for tweaking limits & feature flags
 * Infinite retention for [deduplication workflows](https://www.prefab.cloud/documentation/once_and_only_once)
@@ -44,15 +42,19 @@ end
 
 ## Logging & Debugging
 In classpath or ~/.prefab.overrides.config.yaml set
-```log-level.prefab: debug```
+
+```
+log-level:
+  cloud.prefab: debug
+```
 
 To debug issues before this config file has been read, set env var
 ```
-PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL = debug
+PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL=debug
 ```
 
 ## Contributing to prefab-cloud-ruby
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.17.0
+0.19.0

data/lib/prefab/client.rb

@@ -47,10 +47,11 @@ module Prefab
     end
 
     def log
-      @logger_client ||= Prefab::LoggerClient.new(@options.logdev, formatter: @options.log_formatter)
+      @logger_client ||= Prefab::LoggerClient.new(@options.logdev, formatter: @options.log_formatter,
+                                                                   prefix: @options.log_prefix)
     end
 
-    def log_internal(level, msg, path = "prefab")
+    def log_internal(level, msg, path = nil)
       log.log_internal msg, path, nil, level
     end
 

data/lib/prefab/config_client.rb

@@ -189,7 +189,7 @@ module Prefab
       if @config_loader.highwater_mark > starting_highwater_mark
         @base_client.log_internal Logger::INFO, "Found new checkpoint with highwater id #{@config_loader.highwater_mark} from #{source} in project #{project_id} environment: #{project_env_id} and namespace: '#{@namespace}'"
       else
-        @base_client.log_internal Logger::DEBUG, "Checkpoint with highwater id #{@config_loader.highwater_mark} from #{source}. No changes.", "prefab.config_client.load_configs"
+        @base_client.log_internal Logger::DEBUG, "Checkpoint with highwater id #{@config_loader.highwater_mark} from #{source}. No changes.", "load_configs"
       end
       @base_client.stats.increment("prefab.config.checkpoint.load")
       @config_resolver.update
@@ -237,7 +237,7 @@ module Prefab
       @streaming_thread = SSE::Client.new(url,
                                           headers: headers,
                                           read_timeout: SSE_READ_TIMEOUT,
-                                          logger: Prefab::InternalLogger.new("prefab.config.sse", @base_client.log)) do |client|
+                                          logger: Prefab::SseLogger.new(@base_client.log)) do |client|
         client.on_event do |event|
           configs = Prefab::Configs.decode(Base64.decode64(event.data))
           load_configs(configs, :sse)

data/lib/prefab/config_resolver.rb

@@ -18,7 +18,8 @@ module Prefab
     def to_s
       str = "\n"
       @lock.with_read_lock do
-        @local_store.each do |k, v|
+        @local_store.keys.sort.each do |k|
+          v = @local_store[k]
           elements = [k.slice(0..49).ljust(50)]
           if v.nil?
             elements << "tombstone"

data/lib/prefab/logger_client.rb

@@ -4,7 +4,8 @@ module Prefab
 
     SEP = "."
     BASE_KEY = "log-level"
-    UNKNOWN = "unknown"
+    UNKNOWN_PATH = "unknown."
+    INTERNAL_PREFIX = "cloud.prefab.client"
 
     LOG_LEVEL_LOOKUPS = {
       Prefab::LogLevel::NOT_SET_LOG_LEVEL => Logger::DEBUG,
@@ -16,27 +17,35 @@ module Prefab
       Prefab::LogLevel::FATAL => Logger::FATAL
     }
 
-    def initialize(logdev, formatter: nil)
+    def initialize(logdev, formatter: nil, prefix: nil)
       super(logdev)
       self.formatter = formatter
       @config_client = BootstrappingConfigClient.new
-      @silences = Concurrent::Map.new(:initial_capacity => 2)
+      @silences = Concurrent::Map.new(initial_capacity: 2)
+      @prefix = prefix
     end
 
-    def add(severity, message = nil, progname = nil)
-      loc = caller_locations(1, 1)[0]
-      add_internal(severity, message, progname, loc)
+    def add(severity, message = nil, progname = nil, loc, &block)
+      path = get_loc_path(loc)
+      path = "#{@prefix}#{@prefix && '.'}#{path}"
+
+      log(message, path, progname, severity, &block)
     end
 
-    def add_internal(severity, message = nil, progname = nil, loc, &block)
-      path = get_loc_path(loc)
-      log_internal(message, path, progname, severity, &block)
+    def log_internal(message, path = nil, progname, severity, &block)
+      if path
+        path = "#{INTERNAL_PREFIX}.#{path}"
+      else
+        path = INTERNAL_PREFIX
+      end
+
+      log(message, path, progname, severity, &block)
     end
 
-    def log_internal(message, path, progname, severity, &block)
+    def log(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
@@ -57,23 +66,23 @@ module Prefab
     end
 
     def debug(progname = nil, &block)
-      add_internal(DEBUG, nil, progname, caller_locations(1, 1)[0], &block)
+      add(DEBUG, nil, progname, caller_locations(1, 1)[0], &block)
     end
 
     def info(progname = nil, &block)
-      add_internal(INFO, nil, progname, caller_locations(1, 1)[0], &block)
+      add(INFO, nil, progname, caller_locations(1, 1)[0], &block)
     end
 
     def warn(progname = nil, &block)
-      add_internal(WARN, nil, progname, caller_locations(1, 1)[0], &block)
+      add(WARN, nil, progname, caller_locations(1, 1)[0], &block)
     end
 
     def error(progname = nil, &block)
-      add_internal(ERROR, nil, progname, caller_locations(1, 1)[0], &block)
+      add(ERROR, nil, progname, caller_locations(1, 1)[0], &block)
     end
 
     def fatal(progname = nil, &block)
-      add_internal(FATAL, nil, progname, caller_locations(1, 1)[0], &block)
+      add(FATAL, nil, progname, caller_locations(1, 1)[0], &block)
     end
 
     def debug?
@@ -119,7 +128,7 @@ module Prefab
 
     # Find the closest match to 'log_level.path' in config
     def level_of(path)
-      closest_log_level_match = @config_client.get(BASE_KEY, Prefab::LogLevel::WARN)
+      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)
@@ -128,7 +137,8 @@ module Prefab
         end
         memo
       end
-      LOG_LEVEL_LOOKUPS[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)
@@ -139,7 +149,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
 
@@ -154,7 +164,7 @@ module Prefab
   # since it may log
   class BootstrappingConfigClient
     def get(key, default = nil)
-      ENV["PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL"] ? Prefab::LogLevel.resolve(ENV["PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL"].upcase.to_sym) : default
+      ENV["PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL"] ? ENV["PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL"].upcase.to_sym : default
     end
   end
 end

data/lib/prefab/options.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
+
 module Prefab
   class Options
     attr_reader :api_key
     attr_reader :logdev
+    attr_reader :log_prefix
     attr_reader :log_formatter
     attr_reader :stats
     attr_reader :shared_cache
@@ -40,6 +42,7 @@ module Prefab
       shared_cache: NoopCache.new, # Something that quacks like Rails.cache ideally memcached
       namespace: "",
       log_formatter: DEFAULT_LOG_FORMATTER,
+      log_prefix: nil,
       prefab_api_url: ENV["PREFAB_API_URL"] || 'https://api.prefab.cloud',
       prefab_grpc_url: ENV["PREFAB_GRPC_URL"] || 'grpc.prefab.cloud:443',
       on_no_default: ON_NO_DEFAULT::RAISE, # options :raise, :warn_and_return_nil,
@@ -59,6 +62,7 @@ module Prefab
       @shared_cache = shared_cache
       @namespace = namespace
       @log_formatter = log_formatter
+      @log_prefix = log_prefix
       @prefab_api_url = prefab_api_url
       @prefab_grpc_url = prefab_grpc_url
       @on_no_default = on_no_default

data/lib/prefab/sse_logger.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+module Prefab
+  class SseLogger < InternalLogger
+    def initialize(logger)
+      super("sse", logger)
+    end
+
+    # The SSE::Client warns on a perfectly normal stream disconnect, recast to info
+    def warn(progname = nil, &block)
+      @logger.log_internal yield, @path, progname, INFO
+    end
+  end
+end

data/lib/prefab-cloud-ruby.rb

@@ -13,6 +13,7 @@ require 'prefab/errors/missing_default_error'
 require 'prefab_services_pb'
 require 'prefab/options'
 require 'prefab/internal_logger'
+require 'prefab/sse_logger'
 require 'prefab/config_helper'
 require 'prefab/config_loader'
 require 'prefab/config_resolver'

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.17.0 ruby lib
+# stub: prefab-cloud-ruby 0.19.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "prefab-cloud-ruby".freeze
-  s.version = "0.17.0"
+  s.version = "0.19.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-10-11"
+  s.date = "2022-11-19"
   s.description = "RateLimits & Config as a service".freeze
   s.email = "jdwyer@prefab.cloud".freeze
   s.extra_rdoc_files = [
@@ -50,6 +50,7 @@ Gem::Specification.new do |s|
     "lib/prefab/noop_stats.rb",
     "lib/prefab/options.rb",
     "lib/prefab/ratelimit_client.rb",
+    "lib/prefab/sse_logger.rb",
     "lib/prefab_pb.rb",
     "lib/prefab_services_pb.rb",
     "prefab-cloud-ruby.gemspec",

data/test/test_helper.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require 'minitest/autorun'
+require "minitest/focus"
 require 'prefab-cloud-ruby'
 
 class MockBaseClient

data/test/test_logger.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'test_helper'
 
 class TestCLogger < Minitest::Test
@@ -20,6 +21,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 +48,100 @@ 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" => Prefab::LogLevel::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" => Prefab::LogLevel::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" => Prefab::LogLevel::DEBUG,
-                                                    "log-level.app.models" => Prefab::LogLevel::ERROR))
+      @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.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)
+    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)
+    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.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 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
+  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
+  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)
+    end
+    logger.log("should log", "test.path", "", Logger::WARN)
+    mock_logdev.verify
+  end
+
+  def test_logging_with_prefix
+    prefix = 'my.own.prefix'
+    message = 'this is a test'
+
+    io = StringIO.new
+    options = Prefab::Options.new(logdev: io, log_prefix: prefix, prefab_datasources: Prefab::Options::DATASOURCES::LOCAL_ONLY)
+    prefab = Prefab::Client.new(options)
+
+    prefixed_logger = prefab.log
+    prefixed_logger.error message
+
+    assert_logged io.string, 'ERROR', "#{prefix}.test.test_logger.test_logging_with_prefix", message
+  end
+
+  def assert_logged(log_line, level, path, message)
+    assert_match(/#{level} \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} [-\+]?\d+:  #{path}: #{message}\n/, log_line)
+  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.17.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Jeff Dwyer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-11 00:00:00.000000000 Z
+date: 2022-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -237,6 +237,7 @@ files:
 - lib/prefab/noop_stats.rb
 - lib/prefab/options.rb
 - lib/prefab/ratelimit_client.rb
+- lib/prefab/sse_logger.rb
 - lib/prefab_pb.rb
 - lib/prefab_services_pb.rb
 - prefab-cloud-ruby.gemspec