prefab-cloud-ruby 1.5.0 → 1.6.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84471490fb3fb725eb19f111b2c452c3905791f3f45e0e735b64954b382a1c4c
-  data.tar.gz: 2a5bbd48f450b39930910e5649537df80b37877db299d91ff88c06dd78550cc7
+  metadata.gz: 20317c94cd1f107434e8d4df80851ecaecf026cc406dc421e0f36a769f1cbda1
+  data.tar.gz: 5efce4e6ab0ada5a01257c41e716726e591eab2e91ec70fa9f57e220cfd1cd5d
 SHA512:
-  metadata.gz: 7fdd39c81ae85d709622fb88a44d8cf3b1f42778d92e9425f30f6d0edef192fc11eb322af69060da210c917af2e33bbf90454b11e21887c7577060b9f4bca9ab
-  data.tar.gz: 0b8d5a42bdd5f127d8b42d7c2710695625e51bdd0751f7651c2c613cfeee745702081225b75b9f8888e23e92fc712988505e46bf84241e026702aeb5d1a74597
+  metadata.gz: 5bdf94c45e6c0a9c3e49939f392670cf0ed499eb5dfdbe63a8bfdf63ad6f501dbea7e6802b6053e2ee472d006663bfd353d2fe73be10ff5f68e06a574430e88b
+  data.tar.gz: f29975d152647db4ba6ee3249732790dc89ed709d50b313a228c809f63b5ba770fae06f529a9ce6d213c12f1f6f6904ecb84f007824bcbfef6b88fe0f34c4f01

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+- Use semantic_logger for internal logging (#173)
+- Remove Prefab::LoggerClient as a logger for end users (#173)
+- Provide log_filter for end users (#173)
+
 ## 1.5.0 - 2024-02-12
 
 - Fix potential inconsistent Context behavior (#172)

data/Gemfile

@@ -10,6 +10,8 @@ gem 'uuid'
 gem 'activesupport',  '>= 4'
 gem 'actionpack',  '>= 4'
 
+gem 'semantic_logger', require: "semantic_logger/sync"
+
 group :development do
   gem 'benchmark-ips'
   gem 'bundler'

data/Gemfile.lock

@@ -146,6 +146,8 @@ GEM
     rdoc (6.3.3)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.4)
+    semantic_logger (4.15.0)
+      concurrent-ruby (~> 1.0)
     semver2 (3.4.2)
     simplecov (0.18.5)
       docile (~> 1.1)
@@ -180,6 +182,7 @@ DEPENDENCIES
   minitest-focus
   minitest-reporters
   rdoc
+  semantic_logger
   simplecov
   timecop
   uuid

data/README.md

@@ -33,40 +33,50 @@ See full documentation https://docs.prefab.cloud/docs/ruby-sdk/ruby
 Many ruby web servers fork. When the process is forked, the current realtime update stream is disconnected. If you're using Puma or Unicorn, do the following.
 
 ```ruby
-#config/initializers/prefab.rb
-$prefab = Prefab::Client.new
-$prefab.set_rails_loggers
+#config/application.rb
+Prefab.init # reads PREFAB_API_KEY env var
 ```
 
 ```ruby
 #puma.rb
 on_worker_boot do
-  $prefab = $prefab.fork
-  $prefab.set_rails_loggers
+  Prefab.fork
 end
 ```
 
 ```ruby
 # unicorn.rb
 after_fork do |server, worker|
-  $prefab = $prefab.fork
-  $prefab.set_rails_loggers
+  Prefab.fork
 end
 ```
 
 ## Logging & Debugging
 
-In classpath or ~/.prefab.default.config.yaml set
+To use dynamic logging. Install https://logger.rocketjob.io/rails.html and then add Prefab as a dynamic filter.
 
 ```
-log-level:
-  cloud.prefab: debug
+gem "amazing_print"
+gem "rails_semantic_logger"
 ```
+```ruby
+#application.rb
+SemanticLogger.sync!
+SemanticLogger.default_level = :trace # Prefab will take over the filtering
+SemanticLogger.add_appender(
+  io: $stdout,
+  formatter: Rails.env.development? ? :default : :json,
+  filter: Prefab.log_filter,
+)
+Prefab.init
+````
 
-To debug issues before this config file has been read, set env var
-
-```
-PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL=debug
+```ruby
+#puma.rb
+on_worker_boot do
+    SemanticLogger.reopen
+    Prefab.fork
+end
 ```
 
 ## Contributing to prefab-cloud-ruby
@@ -91,4 +101,4 @@ REMOTE_BRANCH=main LOCAL_BRANCH=main bundle exec rake release
 
 ## Copyright
 
-Copyright (c) 2023 Jeff Dwyer. See LICENSE.txt for further details.
+Copyright (c) 2024 Prefab, Inc. See LICENSE.txt for further details.

data/VERSION

@@ -1 +1 @@
-1.5.0
+1.6.0.pre2

data/lib/prefab/client.rb

@@ -4,9 +4,9 @@ require 'uuid'
 
 module Prefab
   class Client
+    LOG = Prefab::InternalLogger.new(self)
     MAX_SLEEP_SEC = 10
     BASE_SLEEP_SEC = 0.5
-    LOG = Prefab::InternalLogger.new(Client)
 
     attr_reader :namespace, :interceptor, :api_key, :prefab_api_url, :options, :instance_hash
 
@@ -15,10 +15,6 @@ module Prefab
       @namespace = @options.namespace
       @stubs = {}
       @instance_hash = UUID.new.generate
-      Prefab::LoggerClient.new(@options.logdev, formatter: @options.log_formatter,
-                                prefix: @options.log_prefix,
-                               log_path_aggregator: log_path_aggregator
-      )
 
       if @options.local_only?
         LOG.debug 'Prefab Running in Local Mode'
@@ -55,13 +51,12 @@ module Prefab
 
     def log_path_aggregator
       return nil if @options.collect_max_paths <= 0
-
       @log_path_aggregator ||= LogPathAggregator.new(client: self, max_paths: @options.collect_max_paths,
                                                      sync_interval: @options.collect_sync_interval)
     end
 
     def log
-      Prefab::LoggerClient.instance
+      @log ||= Prefab::LoggerClient.new(client: self, log_path_aggregator: log_path_aggregator)
     end
 
     def context_shape_aggregator
@@ -132,14 +127,10 @@ module Prefab
 
     # When starting a forked process, use this to re-use the options
     # on_worker_boot do
-    #   $prefab = $prefab.fork
-    #   $prefab.set_rails_loggers
+    #   Prefab.fork
     # end
     def fork
-      log_options = self.log.context_keys.to_a # get keys pre-fork
-      Prefab::Client.new(@options.for_fork).tap do |client|
-        client.log.add_context_keys(*log_options)
-      end
+      Prefab::Client.new(@options.for_fork)
     end
 
     private

data/lib/prefab/config_client.rb

@@ -2,14 +2,12 @@
 
 module Prefab
   class ConfigClient
+    LOG = Prefab::InternalLogger.new(self)
     RECONNECT_WAIT = 5
     DEFAULT_CHECKPOINT_FREQ_SEC = 60
     SSE_READ_TIMEOUT = 300
     STALE_CACHE_WARN_HOURS = 5
     AUTH_USER = 'authuser'
-    LOGGING_KEY_PREFIX = "#{Prefab::LoggerClient::BASE_KEY}#{Prefab::LoggerClient::SEP}".freeze
-    LOG = Prefab::InternalLogger.new(ConfigClient)
-
     def initialize(base_client, timeout)
       @base_client = base_client
       @options = base_client.options
@@ -23,11 +21,7 @@ module Prefab
       @config_loader = Prefab::ConfigLoader.new(@base_client)
       @config_resolver = Prefab::ConfigResolver.new(@base_client, @config_loader)
 
-      @initialization_lock = Concurrent::ReadWriteLock.new
-      LOG.debug 'Initialize ConfigClient: AcquireWriteLock'
-      @initialization_lock.acquire_write_lock
-      LOG.debug 'Initialize ConfigClient: AcquiredWriteLock'
-      @initialized_future = Concurrent::Future.execute { @initialization_lock.acquire_read_lock }
+      @initialization_lock = Concurrent::CountDownLatch.new(1)
 
       if @options.local_only?
         finish_init!(:local_only, nil)
@@ -77,6 +71,10 @@ module Prefab
       end
     end
 
+    def initialized?
+      @initialization_lock.count <= 0
+    end
+
     private
 
     def raw(key)
@@ -93,14 +91,13 @@ module Prefab
 
     def _get(key, properties)
       # wait timeout sec for the initialization to be complete
-      @initialized_future.value(@options.initialization_timeout_sec)
-      if @initialized_future.incomplete?
+      success = @initialization_lock.wait(@options.initialization_timeout_sec)
+      if !success
         unless @options.on_init_failure == Prefab::Options::ON_INITIALIZATION_FAILURE::RETURN
           raise Prefab::Errors::InitializationTimeoutError.new(@options.initialization_timeout_sec, key)
         end
 
         LOG.warn("Couldn't Initialize In #{@options.initialization_timeout_sec}. Key #{key}. Returning what we have")
-        @initialization_lock.release_write_lock
       end
 
       @config_resolver.get key, properties
@@ -144,7 +141,7 @@ module Prefab
         false
       end
     rescue Faraday::ConnectionFailed => e
-      if @initialization_lock.write_locked?
+      if !initialized?
         LOG.warn "Connection Fail loading #{source} checkpoint."
       else
         LOG.debug "Connection Fail loading #{source} checkpoint."
@@ -251,12 +248,11 @@ module Prefab
     end
 
     def finish_init!(source, project_id)
-      return unless @initialization_lock.write_locked?
+      return if initialized?
 
       LOG.debug "Unlocked Config via #{source}"
-      @initialization_lock.release_write_lock
+      @initialization_lock.count_down
 
-      Prefab::LoggerClient.instance.config_client = self
       presenter = Prefab::ConfigClientPresenter.new(
         size: @config_resolver.local_store.size,
         source: source,
@@ -281,7 +277,7 @@ module Prefab
       @streaming_thread = SSE::Client.new(url,
                                           headers: headers,
                                           read_timeout: SSE_READ_TIMEOUT,
-                                          logger: Prefab::SseLogger.new) do |client|
+                                          logger: Prefab::InternalLogger.new(SSE::Client)) do |client|
         client.on_event do |event|
           configs = PrefabProto::Configs.decode(Base64.decode64(event.data))
           load_configs(configs, :sse)

data/lib/prefab/config_loader.rb

@@ -2,7 +2,7 @@
 
 module Prefab
   class ConfigLoader
-    LOG = Prefab::InternalLogger.new(ConfigLoader)
+    LOG = Prefab::InternalLogger.new(self)
 
     attr_reader :highwater_mark
 

data/lib/prefab/config_value_unwrapper.rb

@@ -2,7 +2,7 @@
 
 module Prefab
   class ConfigValueUnwrapper
-    LOG = Prefab::InternalLogger.new(ConfigValueUnwrapper)
+    LOG = Prefab::InternalLogger.new(self)
     CONFIDENTIAL_PREFIX = "*****"
     attr_reader :weighted_value_index
 

data/lib/prefab/context_shape_aggregator.rb

@@ -5,8 +5,7 @@ require_relative 'periodic_sync'
 module Prefab
   class ContextShapeAggregator
     include Prefab::PeriodicSync
-
-    LOG = Prefab::InternalLogger.new(ContextShapeAggregator)
+    LOG = Prefab::InternalLogger.new(self)
 
     attr_reader :data
 

data/lib/prefab/criteria_evaluator.rb

@@ -7,7 +7,7 @@ module Prefab
   # This class evaluates a config's criteria. `evaluate` returns the value of
   # the first match based on the provided properties.
   class CriteriaEvaluator
-    LOG = Prefab::InternalLogger.new(CriteriaEvaluator)
+    LOG = Prefab::InternalLogger.new(self)
     NAMESPACE_KEY = 'NAMESPACE'
     NO_MATCHING_ROWS = [].freeze
 
@@ -22,7 +22,7 @@ module Prefab
     def evaluate(properties)
       rtn = evaluate_for_env(@project_env_id, properties) ||
         evaluate_for_env(0, properties)
-      LOG.debug "Eval Key #{@config.key} Result #{rtn&.reportable_value} with #{properties.to_h}" unless @config.config_type == :LOG_LEVEL
+      LOG.trace "Eval Key #{@config.key} Result #{rtn&.reportable_value} with #{properties.to_h}" unless @config.config_type == :LOG_LEVEL
       rtn
     end
 
@@ -105,7 +105,7 @@ module Prefab
     def in_segment?(criterion, properties)
       segment = @resolver.get(criterion.value_to_match.string, properties)
 
-      @base_client.log.info("Segment #{criterion.value_to_match.string} not found") unless segment
+      LOG.info("Segment #{criterion.value_to_match.string} not found") unless segment
 
       segment&.report_and_return(@base_client.evaluation_summary_aggregator)
     end

data/lib/prefab/evaluation_summary_aggregator.rb

@@ -8,8 +8,7 @@ module Prefab
   # server at a regular interval defined by `sync_interval`.
   class EvaluationSummaryAggregator
     include Prefab::PeriodicSync
-
-    LOG = Prefab::InternalLogger.new(EvaluationSummaryAggregator)
+    LOG = Prefab::InternalLogger.new(self)
 
     attr_reader :data
 

data/lib/prefab/example_contexts_aggregator.rb

@@ -9,8 +9,7 @@ module Prefab
   # It shouldn't send the same context more than once per hour.
   class ExampleContextsAggregator
     include Prefab::PeriodicSync
-
-    LOG = Prefab::InternalLogger.new(ExampleContextsAggregator)
+    LOG = Prefab::InternalLogger.new(self)
 
     attr_reader :data, :cache
 

data/lib/prefab/feature_flag_client.rb

@@ -2,6 +2,7 @@
 
 module Prefab
   class FeatureFlagClient
+    LOG = Prefab::InternalLogger.new(self)
     def initialize(base_client)
       @base_client = base_client
     end
@@ -35,7 +36,7 @@ module Prefab
 
       variant.bool
     rescue StandardError
-      @base_client.log.info("is_on? methods only work for boolean feature flags variants. This feature flags variant is '#{variant}'. Returning false")
+      LOG.info("is_on? methods only work for boolean feature flags variants. This feature flags variant is '#{variant}'. Returning false")
       false
     end
   end

data/lib/prefab/internal_logger.rb

@@ -1,16 +1,42 @@
-# frozen_string_literal: true
-
 module Prefab
-  class InternalLogger < StaticLogger
-    INTERNAL_PREFIX = 'cloud.prefab.client'
+  class InternalLogger < SemanticLogger::Logger
+
+    def initialize(klass)
+      super(klass, :warn)
+      instances << self
+    end
 
-    def initialize(path)
-      if path.is_a?(Class)
-        path_string = path.name.split('::').last.downcase
-      else
-        path_string = path
+    def log(log, message = nil, progname = nil, &block)
+      return if recurse_check[local_log_id]
+      recurse_check[local_log_id] = true
+      begin
+        super(log, message, progname, &block)
+      ensure
+        recurse_check[local_log_id] = false
       end
-      super("#{INTERNAL_PREFIX}.#{path_string}")
+    end
+
+    def local_log_id
+      Thread.current.__id__
+    end
+
+    # Our client outputs debug logging,
+    # but if you aren't using Prefab logging this could be too chatty.
+    # If you aren't using prefab log filter, only log warn level and above
+    def self.using_prefab_log_filter!
+      @@instances.each do |l|
+        l.level = :trace
+      end
+    end
+
+    private
+
+    def instances
+      @@instances ||= []
+    end
+
+    def recurse_check
+      @recurse_check ||=Concurrent::Map.new(initial_capacity: 2)
     end
   end
 end

data/lib/prefab/log_path_aggregator.rb

@@ -4,8 +4,7 @@ require_relative 'periodic_sync'
 
 module Prefab
   class LogPathAggregator
-    LOG = Prefab::InternalLogger.new(LogPathAggregator)
-
+    LOG = Prefab::InternalLogger.new(self)
     include Prefab::PeriodicSync
 
     INCREMENT = ->(count) { (count || 0) + 1 }