prefab-cloud-ruby 1.6.0.pre1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 216fce2170e0fc185a3a79d2f9b7ffa4830e966fc203dc97bcb9b69aa4d79fd0
-  data.tar.gz: c2e4ac474cd6b83b33042a9a0cc3ef95d3f96b3f2c3044884831215d4f3af418
+  metadata.gz: f8cd1347e930a4820b28ae3943e100a09765efeb56ca423dc4e4f26b51e3543b
+  data.tar.gz: 783119a33360850c31c425558735d356202e5365aa9f3ae3e88f776a22c7e231
 SHA512:
-  metadata.gz: be331123d75a902d6a48a4fa0fb59eb3dbf74254d9671ab0f3b8d3507a6ac2958815e014494288c9e61c2469110dbfc8c374be7d958e3e7dd95142b7ced01cd1
-  data.tar.gz: c73394980ed15e9edf8e3b513bca62922bded72aacc3efc75f2a1915701c89c75aad7c70c534cc350c68bf25bfe77b123a819ea39e0bfc589d45eeca0bf9d209
+  metadata.gz: 04b84fcdebab292f086d7909428ea8b77f0d7a53a2dfe5943716ba988ea778ddef0f3c0f09ed4ccddae048097e17f358699633213059ab3062ae04ae287acc99
+  data.tar.gz: 2f65bdf10b36016e397413774bc676b20ed40d42f4ea4abcb7984bdd16afcbefd313e05a28505630cc9a818bcca950e60dcb41774d15e353d08f1e4d8d028966

data/CHANGELOG.md

@@ -1,11 +1,15 @@
 # Changelog
 
-## Unreleased
+## 1.6.0 - 2024-03-27
 
 - 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.1 - 2024-02-22
+
+- Fix: Send context shapes by default (#174)
+
 ## 1.5.0 - 2024-02-12
 
 - Fix potential inconsistent Context behavior (#172)

data/Gemfile

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

data/README.md

@@ -34,7 +34,7 @@ Many ruby web servers fork. When the process is forked, the current realtime upd
 
 ```ruby
 #config/application.rb
-Prefab.init # reads PREFAB_API_KEY env var
+Prefab.init # reads PREFAB_API_KEY env var by default
 ```
 
 ```ruby
@@ -53,22 +53,51 @@ end
 
 ## Logging & Debugging
 
-To use dynamic logging. Install https://logger.rocketjob.io/rails.html and then add Prefab as a dynamic filter.
+To use dynamic logging, we recommend [semantic logger]. Add semantic_logger to your Gemfile and then we'll configure our app to use it.
 
+### Plain ol' Ruby
+
+```ruby
+# Gemfile
+gem "semantic_logger"
+```
+
+```ruby
+require "semantic_logger"
+require "prefab"
+
+Prefab.init
+
+SemanticLogger.sync!
+SemanticLogger.default_level = :trace # Prefab will take over the filtering
+SemanticLogger.add_appender(
+  io: $stdout,
+  formatter: :json,
+  filter: Prefab.log_filter,
+)
 ```
+
+### With Rails
+
+```ruby
+# Gemfile
 gem "amazing_print"
 gem "rails_semantic_logger"
 ```
+
 ```ruby
-#application.rb
+# config/application.rb
+Prefab.init
+
+# config/initializers/logging.rb
+SemanticLogger.sync!
 SemanticLogger.default_level = :trace # Prefab will take over the filtering
 SemanticLogger.add_appender(
   io: $stdout,
-  formatter: Rails.env.development? ? :default : :json,
+  formatter: Rails.env.development? ? :color : :json,
   filter: Prefab.log_filter,
 )
-Prefab.init
-````
+```
 
 ```ruby
 #puma.rb
@@ -101,3 +130,5 @@ REMOTE_BRANCH=main LOCAL_BRANCH=main bundle exec rake release
 ## Copyright
 
 Copyright (c) 2024 Prefab, Inc. See LICENSE.txt for further details.
+
+[semantic logger]: https://logger.rocketjob.io/

data/VERSION

@@ -1 +1 @@
-1.6.0.pre1
+1.6.0

data/lib/prefab/client.rb

@@ -51,6 +51,7 @@ 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
@@ -87,14 +88,7 @@ module Prefab
     end
 
     def set_rails_loggers
-      Rails.logger = log
-      ActionView::Base.logger = log
-      ActionController::Base.logger = log
-      ActiveJob::Base.logger = log if defined?(ActiveJob)
-      ActiveRecord::Base.logger = log
-      ActiveStorage.logger = log if defined?(ActiveStorage)
-
-      LogSubscribers::ActionControllerSubscriber.attach_to :action_controller unless @options.disable_action_controller_logging
+      warn '[DEPRECATION] `set_rails_loggers` is deprecated since 1.6. Please use semantic_logger or `Prefab.log_filter` instead.'
     end
 
     def on_update(&block)
@@ -127,14 +121,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/options.rb

@@ -94,6 +94,8 @@ module Prefab
       when :periodic_example
         @collect_example_contexts = true
         @collect_max_example_contexts = context_max_size
+        @collect_shapes = true
+        @collect_max_shapes = context_max_size
       when :shape_only
         @collect_shapes = true
         @collect_max_shapes = context_max_size

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.6.0.pre1 ruby lib
+# stub: prefab-cloud-ruby 1.6.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "prefab-cloud-ruby".freeze
-  s.version = "1.6.0.pre1"
+  s.version = "1.6.0"
 
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1".freeze) if s.respond_to? :required_rubygems_version=
+  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 = "2024-02-22"
+  s.date = "2024-03-27"
   s.description = "Feature Flags, Live Config, and Dynamic Log Levels as a service".freeze
   s.email = "jdwyer@prefab.cloud".freeze
   s.executables = ["console".freeze]

data/test/support/common_helpers.rb

@@ -6,12 +6,24 @@ module CommonHelpers
   def setup
     $oldstderr, $stderr = $stderr, StringIO.new
 
-    $logs ||= StringIO.new
-    SemanticLogger.add_appender(io: $logs)
+    $logs = StringIO.new
+    SemanticLogger.add_appender(io: $logs, filter: Prefab.log_filter)
+    SemanticLogger.sync!
     Timecop.freeze('2023-08-09 15:18:12 -0400')
   end
 
   def teardown
+    if $logs && !$logs.string.empty?
+      log_lines = $logs.string.split("\n").reject do |line|
+        line.match(/Prefab::ConfigClient -- No success loading checkpoints/)
+      end
+
+      if log_lines.size > 0
+        $logs = nil
+        raise "Unexpected logs. Handle logs with assert_logged\n\n#{log_lines}"
+      end
+    end
+
     if $stderr != $oldstderr && !$stderr.string.empty?
       # we ignore 2.X because of the number of `instance variable @xyz not initialized` warnings
       if !RUBY_VERSION.start_with?('2.')
@@ -41,7 +53,6 @@ module CommonHelpers
   }.freeze
 
   def new_client(overrides = {})
-
     config = overrides.delete(:config)
     project_env_id = overrides.delete(:project_env_id)
 
@@ -140,12 +151,6 @@ module CommonHelpers
     Prefab::Context.new(properties)
   end
 
-  def assert_only_expected_logs
-    # assert_equal "WARN  2023-08-09 15:18:12 -0400: cloud.prefab.client.configclient No success loading checkpoints\n", $logs.string
-    # mark nil to indicate we handled it
-    $logs = nil
-  end
-
   def assert_logged(expected)
     # we do a uniq here because logging can happen in a separate thread so the
     # number of times a log might happen could be slightly variable.
@@ -159,6 +164,8 @@ module CommonHelpers
 
       assert(matched, "expectation: #{expectation}, got: #{actuals}")
     end
+    # mark nil to indicate we handled it
+    $logs = nil
   end
 
   def assert_stderr(expected)

data/test/test_integration.rb

@@ -50,6 +50,12 @@ class TestIntegration < Minitest::Test
             else
               raise "Unknown test type: #{it.test_type}"
             end
+
+            if test_case["name"].match(/doesn't raise on init timeout/)
+              assert_logged [
+                "Prefab::ConfigClient -- Couldn't Initialize In 0.01. Key any-key. Returning what we have"
+              ]
+            end
           end
         end
       end

data/test/test_log_path_aggregator.rb

@@ -8,7 +8,7 @@ class TestLogPathAggregator < Minitest::Test
   SLEEP_TIME = 0.01
 
   def test_push
-    client = new_client
+    client = new_client(prefab_datasources: Prefab::Options::DATASOURCES::ALL,)
     aggregator = Prefab::LogPathAggregator.new(client: client, max_paths: 2, sync_interval: 1000)
 
     aggregator.push('test.test_log_path_aggregator.test_push.1', ::Logger::INFO)
@@ -19,16 +19,14 @@ class TestLogPathAggregator < Minitest::Test
     # we've reached the limit, so no more
     aggregator.push('test.test_log_path_aggregator.test_push.3', ::Logger::INFO)
     assert_equal 2, aggregator.data.size
-
-    assert_only_expected_logs
   end
 
   def test_sync
     Timecop.freeze do
       client = new_client(namespace: 'this.is.a.namespace', allow_telemetry_in_local_mode: true)
 
-      2.times { client.log.should_log? 1, "test.test_log_path_aggregator.test_sync"}
-      3.times { client.log.should_log? 3, "test.test_log_path_aggregator.test_sync"}
+      2.times { client.log.should_log? 1, "test.test_log_path_aggregator.test_sync" }
+      3.times { client.log.should_log? 3, "test.test_log_path_aggregator.test_sync" }
 
       requests = wait_for_post_requests(client) do
         client.log_path_aggregator.send(:sync)
@@ -40,7 +38,9 @@ class TestLogPathAggregator < Minitest::Test
       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: 'test.test_log_path_aggregator.test_sync', infos: 2,
+                                              errors: 3)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prefab-cloud-ruby
 version: !ruby/object:Gem::Version
-  version: 1.6.0.pre1
+  version: 1.6.0
 platform: ruby
 authors:
 - Jeff Dwyer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-22 00:00:00.000000000 Z
+date: 2024-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -327,9 +327,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.32
 signing_key: