prefab-cloud-ruby 0.23.1 → 0.23.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55f7405129237177e62c5dfe267782a09825ef548daa1dc4991ab21a66769455
-  data.tar.gz: ec4e47e424a6898f31bcba403293de19d8a70d67a951c3d6a830e5cdbb71156e
+  metadata.gz: 45234586612606d2efe94b569039c7f7866b948b1cc9ef1d252c3af68b678ac0
+  data.tar.gz: c4ca19037512f306fe4fe62a6031d56153a68d549e58a64e3754050af6b91948
 SHA512:
-  metadata.gz: 0e78923408d4bf39a2a73c7e9d90c88274b1da106ff148094c2bcba694195d93eab81d373fe36e404740e0266f06b35d928bc21caa10e85c374fbf3667d055af
-  data.tar.gz: db4052d845d6dbda926579da65af9bececa24c96676b44f0d7af01bfed85e527d4768d22b095867f6ec6ec6d30d8e3975fd6edebf4af4d9ea47d1550a5215fb9
+  metadata.gz: 1562416434735eb380f3cc7e159120a43e4f18e22f486020cfe7a35dc0c66f2c10a04104e46120c6f455a70ff7078c35ce16978bb1a111669686971be3a9c432
+  data.tar.gz: 4671527a60e7166e3acbeca47bbe211d405ceda58600c621406cf865b0942864d7b2d7c5f71c8fbb7ccc0e020113cf8921f7dcf5a9fe5b7a81b887392ef35460

data/README.md

@@ -1,5 +1,6 @@
 # prefab-cloud-ruby
-Ruby Client for Prefab FeatureFlags, Config as a Service: https://www.prefab.cloud
+
+Ruby Client for Prefab Feature Flags, Dynamic log levels, and Config as a Service: https://www.prefab.cloud
 
 ```ruby
 client = Prefab::Client.new
@@ -20,25 +21,36 @@ See full documentation https://docs.prefab.cloud/docs/ruby-sdk/ruby
 
 ## Supports
 
-* [FeatureFlags](https://www.prefab.cloud/documentation/feature_flags) as a Service
-* 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)
+* Feature Flags
+* Dynamic log levels
+* Live Config
+* WebUI for tweaking config, log levels, and feature flags
 
 ## Important note about Forking and realtime updates
-Many ruby web servers fork. GRPC does not like to be forked. You should manually start gRPC streaming in the on_worker_boot or after_fork hook of your server. See some details on GRPC and forking: https://github.com/grpc/grpc/issues/7951#issuecomment-335998583
 
-```ruby
+Many ruby web servers fork. GRPC does not like to be forked. See some details on GRPC and forking: https://github.com/grpc/grpc/issues/7951#issuecomment-335998583
 
+If you're using Puma or Unicorn, you can do the following.
+
+```ruby
 #config/initializers/prefab.rb
 $prefab = Prefab::Client.new
-Rails.logger = $prefab.log
+$prefab.set_rails_loggers
 ```
 
 ```ruby
 #puma.rb
 on_worker_boot do
-  $prefab.config_client.start_streaming
+  $prefab = Prefab::Client.new
+  $prefab.set_rails_loggers
+end
+```
+
+```ruby
+# unicorn.rb
+after_fork do |server, worker|
+  $prefab = Prefab::Client.new(options)
+  $prefab.set_rails_loggers
 end
 ```
 
@@ -76,5 +88,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) 2023 Jeff Dwyer. See LICENSE.txt for further details.

data/VERSION

@@ -1 +1 @@
-0.23.1
+0.23.3

data/lib/prefab/config_resolver.rb

@@ -34,6 +34,8 @@ module Prefab
         end
       end
       str
+    rescue StandardError => e
+      "Error printing resolved config: #{e.message}"
     end
 
     def raw(key)

data/lib/prefab/exponential_backoff.rb

@@ -0,0 +1,16 @@
+module Prefab
+  class ExponentialBackoff
+    def initialize(max_delay:, initial_delay: 2, multiplier: 2)
+      @initial_delay = initial_delay
+      @max_delay = max_delay
+      @multiplier = multiplier
+      @delay = initial_delay
+    end
+
+    def call
+      delay = @delay
+      @delay = [@delay * @multiplier, @max_delay].min
+      delay
+    end
+  end
+end

data/lib/prefab/log_path_collector.rb

@@ -14,9 +14,13 @@ module Prefab
 
     def initialize(client:, max_paths:, sync_interval:)
       @max_paths = max_paths
-      @sync_interval = sync_interval
       @client = client
       @start_at = now
+      @sync_interval = if sync_interval.is_a?(Numeric)
+                         proc { sync_interval }
+                       else
+                         sync_interval || ExponentialBackoff.new(initial_delay: 8, max_delay: 60 * 10)
+                       end
 
       @pool = Concurrent::ThreadPoolExecutor.new(
         fallback_policy: :discard,
@@ -78,17 +82,17 @@ module Prefab
 
     def start_periodic_sync
       Thread.new do
-        log_internal "Initialized log path collector instance_hash=#{@client.instance_hash} max_paths=#{@max_paths} sync_interval=#{@sync_interval}"
+        log_internal "Initialized log path collector instance_hash=#{@client.instance_hash} max_paths=#{@max_paths}"
 
         loop do
-          sleep @sync_interval
+          sleep @sync_interval.call
           sync
         end
       end
     end
 
     def log_internal(message)
-      @client.log.log_internal message, 'log_path_collector', nil, ::Logger::INFO
+      @client.log.log_internal message, 'log_path_collector', nil, ::Logger::DEBUG
     end
 
     def now

data/lib/prefab/options.rb

@@ -39,7 +39,6 @@ module Prefab
     end
 
     DEFAULT_MAX_PATHS = 1_000
-    DEFAULT_SYNC_INTERVAL = 60
 
     private def init(
       api_key: ENV['PREFAB_API_KEY'],
@@ -62,7 +61,7 @@ module Prefab
       prefab_envs: ENV['PREFAB_ENVS'].nil? ? [] : ENV['PREFAB_ENVS'].split(','),
       collect_logs: true,
       collect_max_paths: DEFAULT_MAX_PATHS,
-      collect_sync_interval: DEFAULT_SYNC_INTERVAL
+      collect_sync_interval: nil
     )
       @api_key = api_key
       @logdev = logdev
@@ -71,7 +70,7 @@ module Prefab
       @namespace = namespace
       @log_formatter = log_formatter
       @log_prefix = log_prefix
-      @prefab_api_url = prefab_api_url
+      @prefab_api_url = remove_trailing_slash(prefab_api_url)
       @prefab_grpc_url = prefab_grpc_url
       @on_no_default = on_no_default
       @initialization_timeout_sec = initialization_timeout_sec
@@ -103,5 +102,11 @@ module Prefab
     def url_for_api_cdn
       ENV['PREFAB_CDN_URL'] || "#{@prefab_api_url.gsub(/\./, '-')}.global.ssl.fastly.net"
     end
+
+    private
+
+    def remove_trailing_slash(url)
+      url.end_with?('/') ? url[0..-2] : url
+    end
   end
 end

data/lib/prefab-cloud-ruby.rb

@@ -8,6 +8,7 @@ require 'openssl'
 require 'ld-eventsource'
 require 'prefab_pb'
 require 'prefab/error'
+require 'prefab/exponential_backoff'
 require 'prefab/errors/initialization_timeout_error'
 require 'prefab/errors/invalid_api_key_error'
 require 'prefab/errors/missing_default_error'

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.23.1 ruby lib
+# stub: prefab-cloud-ruby 0.23.3 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "prefab-cloud-ruby".freeze
-  s.version = "0.23.1"
+  s.version = "0.23.3"
 
   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-03-30"
+  s.date = "2023-04-07"
   s.description = "RateLimits & Config as a service".freeze
   s.email = "jdwyer@prefab.cloud".freeze
   s.extra_rdoc_files = [
@@ -45,6 +45,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/exponential_backoff.rb",
     "lib/prefab/feature_flag_client.rb",
     "lib/prefab/internal_logger.rb",
     "lib/prefab/local_config_parser.rb",
@@ -71,6 +72,7 @@ Gem::Specification.new do |s|
     "test/test_config_resolver.rb",
     "test/test_config_value_unwrapper.rb",
     "test/test_criteria_evaluator.rb",
+    "test/test_exponential_backoff.rb",
     "test/test_feature_flag_client.rb",
     "test/test_helper.rb",
     "test/test_integration.rb",

data/test/test_exponential_backoff.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class TestExponentialBackoff < Minitest::Test
+  def test_backoff
+    backoff = Prefab::ExponentialBackoff.new(max_delay: 120)
+
+    assert_equal 2, backoff.call
+    assert_equal 4, backoff.call
+    assert_equal 8, backoff.call
+    assert_equal 16, backoff.call
+    assert_equal 32, backoff.call
+    assert_equal 64, backoff.call
+    assert_equal 120, backoff.call
+    assert_equal 120, backoff.call
+  end
+end

data/test/test_log_path_collector.rb

@@ -47,8 +47,7 @@ class TestLogPathCollector < Minitest::Test
       prefab_config_override_dir: 'none',
       prefab_config_classpath_dir: 'test',
       prefab_envs: ['unit_tests'],
-      api_key: '123-development-yourapikey-SDK',
-      collect_sync_interval: 1000 # we'll trigger sync manually in our test
+      api_key: '123-development-yourapikey-SDK'
     }.merge(overrides))
 
     Prefab::Client.new(options)

data/test/test_options.rb

@@ -5,6 +5,18 @@ require 'test_helper'
 class TestOptions < Minitest::Test
   API_KEY = 'abcdefg'
 
+  def test_prefab_api_url
+    assert_equal 'https://api.prefab.cloud', Prefab::Options.new.prefab_api_url
+
+    with_env 'PREFAB_API_URL', 'https://api.prefab.cloud' do
+      assert_equal 'https://api.prefab.cloud', Prefab::Options.new.prefab_api_url
+    end
+
+    with_env 'PREFAB_API_URL', 'https://api.prefab.cloud/' do
+      assert_equal 'https://api.prefab.cloud', Prefab::Options.new.prefab_api_url
+    end
+  end
+
   def test_works_with_named_arguments
     assert_equal API_KEY, Prefab::Options.new(api_key: API_KEY).api_key
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prefab-cloud-ruby
 version: !ruby/object:Gem::Version
-  version: 0.23.1
+  version: 0.23.3
 platform: ruby
 authors:
 - Jeff Dwyer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-30 00:00:00.000000000 Z
+date: 2023-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -232,6 +232,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/exponential_backoff.rb
 - lib/prefab/feature_flag_client.rb
 - lib/prefab/internal_logger.rb
 - lib/prefab/local_config_parser.rb
@@ -258,6 +259,7 @@ files:
 - test/test_config_resolver.rb
 - test/test_config_value_unwrapper.rb
 - test/test_criteria_evaluator.rb
+- test/test_exponential_backoff.rb
 - test/test_feature_flag_client.rb
 - test/test_helper.rb
 - test/test_integration.rb