prefab-cloud-ruby 0.18.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9225ebaadf8be997d152b66cb58ff342d126bc5cfbe489511af4791d89dd5f7
-  data.tar.gz: cbaf511c7aeaf0ef743b33c2ad00c40bd4d6c8ddba0a17ddff541afeb8e055d9
+  metadata.gz: d1d4612e27cae5a4e66065a16d8d70cb0b1c7120770eac8c7e09ce3ca0e48e82
+  data.tar.gz: 1d1f50b6b4605729b93d62194b17ed9a1fca739f435ec2a4e682482a293bffe6
 SHA512:
-  metadata.gz: f00e343e6f3f7a7f11351409708979c4e02420eae8bf8d9520cdc58de464b682158b863bcab88b4583c469709c621f066bd8995e482963386b931c877bfd2b1f
-  data.tar.gz: 5e51d64d2d5adc738e5f8438cd222ae3e4d9fc1f183a789d25486da7197b25c3263fff9a0fac9b33a9acffc169e035630e7a8cb8b3d3770e9e8b669d34b96f68
+  metadata.gz: ed5a04b2a16a79b0963d9af2dd71955141fdd06e7d73a4897adf74245435cf33239f78b08bbde797b7420b7e988fbb76e5e4333e6da5350f1037502949c469e7
+  data.tar.gz: 1b6f556bb94a31c272d5cd3c585860cacb4698be61830379c1a1a7e2d2fdcb461c02777e0c6fdb6a2cc939dcb070a27237506bd3c21d69ccd723ec50dccfbf2a

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.18.0
+0.20.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

@@ -5,6 +5,7 @@ module Prefab
     SEP = "."
     BASE_KEY = "log-level"
     UNKNOWN_PATH = "unknown."
+    INTERNAL_PREFIX = "cloud.prefab.client"
 
     LOG_LEVEL_LOOKUPS = {
       Prefab::LogLevel::NOT_SET_LOG_LEVEL => Logger::DEBUG,
@@ -16,33 +17,39 @@ 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)
-      level = level_of(path)
-      progname = "#{path}: #{progname}"
+    def log(message, path, progname, severity, &block)
       severity ||= Logger::UNKNOWN
-      if @logdev.nil? || severity < level || @silences[local_log_id]
+      if @logdev.nil? || severity < level_of(path) || @silences[local_log_id]
         return true
       end
-      if progname.nil?
-        progname = @progname
-      end
+
+      progname = "#{path}: #{progname || @progname}"
+
       if message.nil?
         if block_given?
           message = yield
@@ -51,29 +58,30 @@ module Prefab
           progname = @progname
         end
       end
+
       @logdev.write(
         format_message(format_severity(severity), Time.now, progname, message))
       true
     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?

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
@@ -17,7 +19,7 @@ module Prefab
     attr_reader :prefab_envs
 
     DEFAULT_LOG_FORMATTER = proc { |severity, datetime, progname, msg|
-      "#{severity.ljust(5)} #{datetime}: #{progname} #{msg}\n"
+      "#{severity.ljust(5)} #{datetime}:#{" " if progname}#{progname} #{msg}\n"
     }
 
     module ON_INITIALIZATION_FAILURE
@@ -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.18.0 ruby lib
+# stub: prefab-cloud-ruby 0.20.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "prefab-cloud-ruby".freeze
-  s.version = "0.18.0"
+  s.version = "0.20.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-14"
+  s.date = "2022-12-02"
   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
@@ -69,19 +70,19 @@ class TestCLogger < Minitest::Test
   end
 
   def test_log_internal
-    logger, mock_logdev = mock_logger_expecting /W, \[.*\]  WARN -- test.path: : test message/
+    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 -- test.path: : test message/
+    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 -- 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)
     end
@@ -89,6 +90,81 @@ class TestCLogger < Minitest::Test
     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'
+
+    prefab, io = captured_logger(log_prefix: prefix)
+
+    prefixed_logger = prefab.log
+    prefixed_logger.error message
+
+    assert_logged io, 'ERROR', "#{prefix}.test.test_logger.test_logging_with_prefix", message
+  end
+
+  def test_logging_without_a_progname
+    prefab, io = captured_logger
+    message = "MY MESSAGE"
+
+    prefab.log.error message
+
+    assert_logged io, 'ERROR', "test.test_logger.test_logging_without_a_progname", message
+  end
+
+  def test_logging_without_a_progname_or_message
+    prefab, io = captured_logger
+
+    prefab.log.error
+
+    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"
+
+    prefab.log.progname = "MY_PROGNAME"
+    prefab.log.error 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.error
+
+    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)
+  end
+
   def mock_logger_expecting pattern, configs = {}, calls: 1
     mock_logdev = Minitest::Mock.new
     mock_logdev.expect :write, nil do |arg|
@@ -104,4 +180,15 @@ class TestCLogger < Minitest::Test
     logger.set_config_client(MockConfigClient.new(configs))
     [logger, mock_logdev]
   end
+
+  def captured_logger(options = {})
+    io = StringIO.new
+    options = Prefab::Options.new(**options.merge(
+      logdev: io,
+      prefab_datasources: Prefab::Options::DATASOURCES::LOCAL_ONLY
+    ))
+    prefab = Prefab::Client.new(options)
+
+    return [prefab, io]
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prefab-cloud-ruby
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Jeff Dwyer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-14 00:00:00.000000000 Z
+date: 2022-12-02 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