prefab-cloud-ruby 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac25de1650da9f74095f10f535d3d82d7b865c8e3f2c56d621703ebe5a5c15f9
-  data.tar.gz: a628c38bba37dbb0f49fcb9ed6beeb6c58363a73a656a24d853d87ea9d835d92
+  metadata.gz: a71229211822c51b1c42109d9554b59508abe12226af8f1f4c0c5717426309ad
+  data.tar.gz: 643af23ac3361bbc7a1ea6d2d45bcb84cf15788bc82e2823705997e458fca5c6
 SHA512:
-  metadata.gz: 1ea0aef2dd291d5263b825ad7ccb0565feb05acba45c0e142872f22b1111b93c3fadb431a03540230d97f48b20c13772821d523e41beb9b940bcbeec25e074bf
-  data.tar.gz: 9a70210438aeff434d33adfd6119ea279d4b27ff0c87cc604970ed3e48c77651d8064b761b06cc376039f29cab2519f72c494579472de87bdfadd7fdf02c4467
+  metadata.gz: cc81730e0dc3282aa5519c7fe5aa36282fece615252869c5464c4ad0c35eb0ec53ae1507a1b9478aea56486429ff1cb9c4f241166b942dc2ff81955eeb6bd054
+  data.tar.gz: bf81a80940acec11928e5445c024aee0b17c74da03a343c2d90ce9b216db121762767c2c3d2e28836efded14d77af90077f095f1e472339f1940fa5abad4863c

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Changelog
 
-## Unreleased
+## 1.4.0 - 2023-11-28
+- ActiveJob tagged logger issue (#164)
+- Compact Log Format (#163)
+- Tagged Logging (#161)
+- ContextKey logging thread safety (#162)
+
+## 1.3.2 - 2023-11-15
+- Send back cloud.prefab logging telemetry (#160)
 
 ## 1.3.1 - 2023-11-14
 - Improve path of rails.controller logging & fix strong param include (#159)

data/VERSION

@@ -1 +1 @@
-1.3.1
+1.4.0

data/lib/prefab/context.rb

@@ -60,6 +60,14 @@ module Prefab
         Thread.current[THREAD_KEY] = old_context
       end
 
+      def with_merged_context(context)
+        old_context = Thread.current[THREAD_KEY]
+        Thread.current[THREAD_KEY] = merge_with_current(context)
+        yield
+      ensure
+        Thread.current[THREAD_KEY] = old_context
+      end
+
       def clear_current
         Thread.current[THREAD_KEY] = nil
       end

data/lib/prefab/errors/uninitialized_error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Prefab
+  module Errors
+    class UninitializedError < Prefab::Error
+      def initialize(key=nil)
+        message = "Use Prefab.initialize before calling Prefab.get #{key}"
+
+        super(message)
+      end
+    end
+  end
+end

data/lib/prefab/logger_client.rb

@@ -5,6 +5,8 @@ module Prefab
     SEP = '.'
     BASE_KEY = 'log-level'
     UNKNOWN_PATH = 'unknown.'
+    LOG_TAGS = 'log.tags'
+    REQ_TAGS = 'req.tags'
 
     LOG_LEVEL_LOOKUPS = {
       PrefabProto::LogLevel::NOT_SET_LOG_LEVEL => ::Logger::DEBUG,
@@ -20,48 +22,48 @@ module Prefab
       @@shared_instance ||= LoggerClient.new($stdout)
     end
 
-    attr_reader :context_keys
-
     def initialize(logdev, log_path_aggregator: nil, formatter: Options::DEFAULT_LOG_FORMATTER, prefix: nil)
       super(logdev)
-      self.formatter = formatter
+      self.formatter = Prefab::Logging::FormatterBase.new(formatter_proc: formatter, logger_client: self)
       @config_client = BootstrappingConfigClient.new
       @silences = Concurrent::Map.new(initial_capacity: 2)
       @recurse_check = Concurrent::Map.new(initial_capacity: 2)
       @prefix = "#{prefix}#{prefix && '.'}"
 
-      @context_keys = Concurrent::Set.new
+      @context_keys_map = Concurrent::Map.new(initial_capacity: 4)
 
       @log_path_aggregator = log_path_aggregator
       @@shared_instance = self
     end
 
     def add_context_keys(*keys)
-      @context_keys += keys
+      context_keys.merge(keys)
     end
 
     def with_context_keys(*keys)
-      @context_keys += keys
+      context_keys.merge(keys)
       yield
     ensure
-      @context_keys -= keys
+      context_keys.subtract(keys)
     end
 
-    def internal_logger(path=nil)
+    def internal_logger(path = nil)
       InternalLogger.new(path, self)
     end
-    
+
+    def context_keys
+      @context_keys_map.fetch_or_store(local_log_id, Concurrent::Set.new)
+    end
+
     # InternalLoggers Will Call This
-    def add_internal(severity, message, progname, loc, log_context={}, &block)
+    def add_internal(severity, message, progname, loc, log_context = {}, &block)
       path_loc = get_loc_path(loc)
       path = @prefix + path_loc
 
-      @log_path_aggregator&.push(path_loc, severity)
-
       log(message, path, progname, severity, log_context, &block)
     end
 
-    def log_internal(severity, message, path, log_context={}, &block)
+    def log_internal(severity, message, path, log_context = {}, &block)
       return if @recurse_check[local_log_id]
       @recurse_check[local_log_id] = true
       begin
@@ -71,8 +73,10 @@ module Prefab
       end
     end
 
-    def log(message, path, progname, severity, log_context={})
+    def log(message, path, progname, severity, log_context = {})
       severity ||= ::Logger::UNKNOWN
+      @log_path_aggregator&.push(path, severity)
+
       return true if @logdev.nil? || severity < level_of(path) || @silences[local_log_id]
 
       progname = @progname if progname.nil?
@@ -136,6 +140,34 @@ module Prefab
       DEBUG
     end
 
+    def tagged(*tags)
+      to_add = tags.flatten.compact
+      if block_given?
+        new_log_tags = current_tags
+        new_log_tags += to_add unless to_add.empty?
+        Prefab::Context.with_merged_context({ "log" => { "tags" => new_log_tags } }) do
+          with_context_keys LOG_TAGS do
+            yield self
+          end
+        end
+      else
+        new_log_tags = Prefab::Context.current.get(REQ_TAGS) || []
+        new_log_tags += to_add unless to_add.empty?
+        add_context_keys REQ_TAGS
+        Prefab::Context.current.set("req", {"tags": new_log_tags})
+        self
+      end
+    end
+
+    def current_tags
+      Prefab::Context.current.get(LOG_TAGS) || []
+    end
+
+    def flush
+      Prefab::Context.current.set("req", {"tags": nil})
+      super if defined?(super)
+    end
+
     def config_client=(config_client)
       @config_client = config_client
     end
@@ -161,7 +193,7 @@ module Prefab
 
     def fetch_context_for_context_keys
       context = Prefab::Context.current.to_h
-      Hash[@context_keys.map do |key|
+      Hash[context_keys.map do |key|
         [key, context.dig(*key.split("."))]
       end]
     end
@@ -203,16 +235,16 @@ module Prefab
       path
     end
 
-    def format_message(severity, datetime, progname, msg, path = nil, log_context={})
+    def format_message(severity, datetime, progname, msg, path = nil, log_context = {})
       formatter = (@formatter || @default_formatter)
-
-      formatter.call(
+      compact_context = log_context.reject{ |_, v| v.nil? || ((v.is_a? Array) && v.empty?) }
+      @formatter.call_proc(
         severity: severity,
         datetime: datetime,
         progname: progname,
         path: path,
         message: msg,
-        log_context: log_context
+        log_context: compact_context
       )
     end
   end

data/lib/prefab/logging/formatter_base.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Prefab
+  module Logging
+    # Shim class to quack like a Rails TaggedLogger
+    class FormatterBase < ::Logger
+      def initialize(formatter_proc:, logger_client:)
+        @formatter_proc = formatter_proc
+        @logger_client = logger_client
+      end
+
+      def call_proc(data)
+        @formatter_proc.call(data)
+      end
+
+      def current_tags
+        @logger_client.current_tags
+      end
+    end
+  end
+end

data/lib/prefab/options.rb

@@ -32,8 +32,8 @@ module Prefab
       progname = (progname.nil? || progname.empty?) ? path : "#{progname}: #{path}"
 
       formatted_log_context = log_context.sort.map do |k, v|
-        v.nil? ? nil : "#{k}=#{v}"
-      end.compact.join(" ")
+        "#{k}=#{v}"
+      end.join(" ")
       "#{severity.ljust(5)} #{datetime}:#{' ' if progname}#{progname} #{msg}#{log_context.any? ? " " + formatted_log_context : ""}\n"
     }
 
@@ -42,6 +42,18 @@ module Prefab
       data.merge(log_context).compact.to_json << "\n"
     }
 
+    COMPACT_LOG_FORMATTER = proc { |data|
+      severity = data[:severity]
+      msg = data[:message]
+      log_context = data[:log_context]
+      log_context["path"] = data[:path] || ""
+
+      formatted_log_context = log_context.sort.map do |k, v|
+        "#{k}=#{v}"
+      end.join(" ")
+      "#{severity.ljust(5)} #{msg&.strip} #{formatted_log_context}\n"
+    }
+
     module ON_INITIALIZATION_FAILURE
       RAISE = :raise
       RETURN = :return

data/lib/prefab/prefab.rb

@@ -27,12 +27,12 @@ module Prefab
   end
 
   def self.get(key, properties = NO_DEFAULT_PROVIDED)
-    ensure_initialized
+    ensure_initialized key
     @singleton.get(key, properties)
   end
 
   def self.enabled?(feature_name, jit_context = NO_DEFAULT_PROVIDED)
-    ensure_initialized
+    ensure_initialized feature_name
     @singleton.enabled?(feature_name, jit_context)
   end
 
@@ -48,9 +48,9 @@ module Prefab
 
   private
 
-  def self.ensure_initialized
+  def self.ensure_initialized(key = nil)
     if not defined? @singleton or @singleton.nil?
-      raise "Use Prefab.initialize before calling Prefab.get"
+      raise Prefab::Errors::UninitializedError.new(key)
     end
   end
 end

data/lib/prefab-cloud-ruby.rb

@@ -20,6 +20,7 @@ require 'prefab/errors/initialization_timeout_error'
 require 'prefab/errors/invalid_api_key_error'
 require 'prefab/errors/missing_default_error'
 require 'prefab/errors/env_var_parse_error'
+require 'prefab/errors/uninitialized_error'
 require 'prefab/options'
 require 'prefab/static_logger'
 require 'prefab/internal_logger'
@@ -45,6 +46,7 @@ require 'prefab/logger_client'
 require 'active_support/deprecation'
 require 'active_support'
 require 'action_controller/metal/strong_parameters'
+require 'prefab/logging/formatter_base'
 require 'prefab/log_subscribers/action_controller_subscriber'
 require 'prefab/client'
 require 'prefab/config_client_presenter'

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 1.3.1 ruby lib
+# stub: prefab-cloud-ruby 1.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "prefab-cloud-ruby".freeze
-  s.version = "1.3.1"
+  s.version = "1.4.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-11-14"
+  s.date = "2023-11-28"
   s.description = "Feature Flags, Live Config, and Dynamic Log Levels as a service".freeze
   s.email = "jdwyer@prefab.cloud".freeze
   s.executables = ["console".freeze]
@@ -54,6 +54,7 @@ Gem::Specification.new do |s|
     "lib/prefab/errors/initialization_timeout_error.rb",
     "lib/prefab/errors/invalid_api_key_error.rb",
     "lib/prefab/errors/missing_default_error.rb",
+    "lib/prefab/errors/uninitialized_error.rb",
     "lib/prefab/evaluation.rb",
     "lib/prefab/evaluation_summary_aggregator.rb",
     "lib/prefab/example_contexts_aggregator.rb",
@@ -65,6 +66,7 @@ Gem::Specification.new do |s|
     "lib/prefab/log_path_aggregator.rb",
     "lib/prefab/log_subscribers/action_controller_subscriber.rb",
     "lib/prefab/logger_client.rb",
+    "lib/prefab/logging/formatter_base.rb",
     "lib/prefab/murmer3.rb",
     "lib/prefab/options.rb",
     "lib/prefab/periodic_sync.rb",

data/test/test_context.rb

@@ -103,6 +103,18 @@ class TestContext < Minitest::Test
     end
   end
 
+  def test_with_context_merge_nesting
+    Prefab::Context.with_context(EXAMPLE_PROPERTIES) do
+      Prefab::Context.with_merged_context({ user: { key: 'abc', other: 'different' } }) do
+        context = Prefab::Context.current
+        assert_equal({ 'user' => { 'key' => 'abc', 'other' => 'different' }, "team"=>{"key"=>"abc", "plan"=>"pro"} }, context.to_h)
+      end
+
+      context = Prefab::Context.current
+      assert_equal(stringify(EXAMPLE_PROPERTIES), context.to_h)
+    end
+  end
+
   def test_setting
     context = Prefab::Context.new({})
     context.set('user', { key: 'value' })

data/test/test_log_path_aggregator.rb

@@ -34,22 +34,19 @@ class TestLogPathAggregator < Minitest::Test
         client.log_path_aggregator.send(:sync)
       end
 
-      assert_equal [[
-        '/api/v1/known-loggers',
-        PrefabProto::Loggers.new(
-          loggers: [PrefabProto::Logger.new(logger_name: 'test.test_log_path_aggregator.test_sync',
-                                            infos: 2, errors: 3)],
-          start_at: Prefab::TimeHelpers.now_in_ms,
-          end_at: Prefab::TimeHelpers.now_in_ms,
-          instance_hash: client.instance_hash,
-          namespace: 'this.is.a.namespace'
-        )
-      ]], requests
+      assert_equal '/api/v1/known-loggers', requests[0][0]
+      sent_logger = requests[0][1]
+      assert_equal 'this.is.a.namespace', sent_logger.namespace
+      assert_equal Prefab::TimeHelpers.now_in_ms, sent_logger.start_at
+      assert_equal Prefab::TimeHelpers.now_in_ms, sent_logger.end_at
+      assert_equal client.instance_hash, sent_logger.instance_hash
+      assert_includes sent_logger.loggers, PrefabProto::Logger.new(logger_name: 'test.test_log_path_aggregator.test_sync', infos: 2, errors: 3)
+      assert_includes sent_logger.loggers, PrefabProto::Logger.new(logger_name: 'cloud.prefab.client.client', debugs: 1) # spot test that internal logging is here too
 
       assert_logged [
-        'WARN  2023-08-09 15:18:12 -0400: cloud.prefab.client.configclient No success loading checkpoints',
-        'ERROR 2023-08-09 15:18:12 -0400: test.test_log_path_aggregator.test_sync here is a message'
-      ]
+                      'WARN  2023-08-09 15:18:12 -0400: cloud.prefab.client.configclient No success loading checkpoints',
+                      'ERROR 2023-08-09 15:18:12 -0400: test.test_log_path_aggregator.test_sync here is a message'
+                    ]
     end
   end
 

data/test/test_logger.rb

@@ -542,6 +542,55 @@ class TestLogger < Minitest::Test
     end
   end
 
+  def test_context_key_threads
+    prefab, io = captured_logger
+
+    threads = []
+    1000.times.map do |i|
+      threads << Thread.new do
+        prefab.with_context({test: {"thread_#{i}": "thread_#{i}"}}) do
+          prefab.log.add_context_keys "test.thread_#{i}"
+          prefab.log.error "UH OH"
+          assert_logged io, 'ERROR', 'test.test_logger.test_context_key_threads',
+                        "UH OH test.thread_#{i}=thread_#{i}"
+        end
+      end
+    end
+    threads.each { |thr| thr.join }
+  end
+
+  def test_tagged
+    prefab, io = captured_logger
+
+    prefab.log.tagged([[]]) do # rails sends some of these
+      prefab.log.tagged("outside") do
+        prefab.log.tagged("nested", "tag2") do
+          prefab.log.error "msg"
+          assert_logged io, 'ERROR', 'test.test_logger.test_tagged',
+                        'msg log.tags=\["outside", "nested", "tag2"\]'
+        end
+      end
+    end
+  end
+
+  def test_req_tagged
+    prefab, io = captured_logger
+    prefab.log.tagged("tag-1").error "first"
+    assert_logged io, 'ERROR', 'test.test_logger.test_req_tagged',
+                  'first req.tags=\["tag-1"\]'
+    reset_io(io)
+
+    prefab.log.tagged("tag-2").error "2nd"
+    assert_logged io, 'ERROR', 'test.test_logger.test_req_tagged',
+                  '2nd req.tags=\["tag-1", "tag-2"\]'
+    prefab.log.flush
+
+    prefab.log.tagged("tag-3").error "3rd"
+    assert_logged io, 'ERROR', 'test.test_logger.test_req_tagged',
+                  '3rd req.tags=\["tag-3"\]'
+    prefab.log.flush
+  end
+
   private
 
   def assert_logged(logged_io, level, path, message)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prefab-cloud-ruby
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Jeff Dwyer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-14 00:00:00.000000000 Z
+date: 2023-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -241,6 +241,7 @@ files:
 - lib/prefab/errors/initialization_timeout_error.rb
 - lib/prefab/errors/invalid_api_key_error.rb
 - lib/prefab/errors/missing_default_error.rb
+- lib/prefab/errors/uninitialized_error.rb
 - lib/prefab/evaluation.rb
 - lib/prefab/evaluation_summary_aggregator.rb
 - lib/prefab/example_contexts_aggregator.rb
@@ -252,6 +253,7 @@ files:
 - lib/prefab/log_path_aggregator.rb
 - lib/prefab/log_subscribers/action_controller_subscriber.rb
 - lib/prefab/logger_client.rb
+- lib/prefab/logging/formatter_base.rb
 - lib/prefab/murmer3.rb
 - lib/prefab/options.rb
 - lib/prefab/periodic_sync.rb