prefab-cloud-ruby 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4207ba2ec83b02534caa1d8f23b75c2120c8d277253312a5bd98898c38baf156
-  data.tar.gz: 8698e869c65017759a56c01f3ff57bc16b9597cc4d1edc219fc282f0ae371e0c
+  metadata.gz: 0d3348f914c10f7f7d45814ff1be70a067e227cbef499b6f44736f10aa5cc30c
+  data.tar.gz: 52699e5fee8f4f6ea26a89d3e3381cc6220d25d4720dcb69d7aee8de8f79e1c9
 SHA512:
-  metadata.gz: 31eb4a0e5e132dd3136a48f9afa5f7d7decb73eccb43cc74329e9fc2b3c5a5b7109bc53a3c468e8272ae0d4ad04e3f85fb516eb16b6590325e23046e6f1c9d7b
-  data.tar.gz: 9ea6c49f4ffe05d15654143c98dc7f74d405ac00bd919d3ae43547d9aa3ba4c3adcfa54626a0c393fa766cb420af29231032f07dd4da1c53d71c12da2cfc273a
+  metadata.gz: c960267ea9f3e09664e48965fb470c1a3093061b1e6906f8f73b4c80a396ab80e0b383b3e42209e6cc95d5fab778c6221a2b9292a2015603139a874586eddf22
+  data.tar.gz: 98cc728c27f1b1f6267c4b01b754d07f23fa60f8dfad95edd9e9288de666f6fc92539bf7124e85337023bf772946422c8919c75ebf487e9999a60251734a4d61

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.1.2 - 2023-10-13
+
+- Add `cloud.prefab.client.criteria_evaluator` `debug` logging of evaluations (#150)
+- Add `x_use_local_cache` for local caching (#148)
+- Tests run in RubyMine (#147)
+
 ## 1.1.1 - 2023-10-11
 
 - Migrate happy-path client-initialization logging to `DEBUG` level rather than `INFO` (#144)

data/VERSION

@@ -1 +1 @@
-1.1.1
+1.1.2

data/lib/prefab/client.rb

@@ -133,7 +133,7 @@ module Prefab
     #   $prefab.set_rails_loggers
     # end
     def fork
-      Prefab::Client.new(@options)
+      Prefab::Client.new(@options.for_fork)
     end
 
     private

data/lib/prefab/config_client.rb

@@ -5,6 +5,7 @@ module Prefab
     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
 
@@ -112,6 +113,10 @@ module Prefab
 
       return if success
 
+      success = load_cache
+
+      return if success
+
       @base_client.log_internal ::Logger::WARN, 'No success loading checkpoints'
     end
 
@@ -130,6 +135,7 @@ module Prefab
       if resp.status == 200
         configs = PrefabProto::Configs.decode(resp.body)
         load_configs(configs, source)
+        cache_configs(configs)
         true
       else
         @base_client.log_internal ::Logger::INFO, "Checkpoint #{source} failed to load. Response #{resp.status}"
@@ -171,6 +177,47 @@ module Prefab
       finish_init!(source, project_id)
     end
 
+    def cache_path
+      return @cache_path unless @cache_path.nil?
+      @cache_path ||= calc_cache_path
+      FileUtils.mkdir_p(File.dirname(@cache_path))
+      @cache_path
+    end
+
+    def calc_cache_path
+      file_name = "prefab.cache.#{@base_client.options.api_key_id}.json"
+      dir = ENV.fetch('XDG_CACHE_HOME', File.join(Dir.home, '.cache'))
+      File.join(dir, file_name)
+    end
+
+    def cache_configs(configs)
+      return unless @options.use_local_cache && !@options.is_fork
+      File.open(cache_path, "w") do |f|
+        f.flock(File::LOCK_EX)
+        f.write(PrefabProto::Configs.encode_json(configs))
+      end
+      @base_client.log_internal ::Logger::DEBUG, "Cached configs to #{cache_path}"
+    rescue => e
+      @base_client.log_internal ::Logger::DEBUG, "Failed to cache configs to #{cache_path} #{e}"
+    end
+
+    def load_cache
+      return false unless @options.use_local_cache
+      File.open(cache_path) do |f|
+        f.flock(File::LOCK_SH)
+        configs = PrefabProto::Configs.decode_json(f.read)
+        load_configs(configs, :cache)
+
+        hours_old = ((Time.now - File.mtime(f)) / 60 / 60).round(2)
+        if hours_old > STALE_CACHE_WARN_HOURS
+          @base_client.log_internal ::Logger::INFO, "Stale Cache Load: #{hours_old} hours old"
+        end
+      end
+    rescue => e
+      @base_client.log_internal ::Logger::DEBUG, "Failed to read cached configs at #{cache_path}. #{e}"
+      false
+    end
+
     # A thread that checks for a checkpoint
     def start_checkpointing_thread
       Thread.new do
@@ -197,7 +244,7 @@ module Prefab
         source: source,
         project_id: project_id,
         project_env_id: @config_resolver.project_env_id,
-        api_key: @base_client.options.api_key
+        api_key_id: @base_client.options.api_key_id
       )
       @base_client.log_internal ::Logger::INFO, presenter.to_s
       @base_client.log_internal ::Logger::DEBUG, to_s

data/lib/prefab/config_client_presenter.rb

@@ -2,12 +2,12 @@
 
 module Prefab
   class ConfigClientPresenter
-    def initialize(size:, source:, project_id:, project_env_id:, api_key:)
+    def initialize(size:, source:, project_id:, project_env_id:, api_key_id:)
       @size = size
       @source = source
       @project_id = project_id
       @project_env_id = project_env_id
-      @api_key_id = api_key&.split("-")&.first
+      @api_key_id = api_key_id
     end
 
     def to_s

data/lib/prefab/criteria_evaluator.rb

@@ -19,8 +19,10 @@ module Prefab
     end
 
     def evaluate(properties)
-      evaluate_for_env(@project_env_id, properties) ||
+      rtn = evaluate_for_env(@project_env_id, properties) ||
         evaluate_for_env(0, properties)
+      @base_client.log_internal ::Logger::DEBUG, "Eval Key #{@config.key} Result #{rtn&.value} with #{properties.to_h}", :criteria_evaluator unless @config.config_type == :LOG_LEVEL
+      rtn
     end
 
     def all_criteria_match?(conditional_value, props)

data/lib/prefab/logger_client.rb

@@ -22,6 +22,7 @@ module Prefab
       self.formatter = formatter
       @config_client = BootstrappingConfigClient.new
       @silences = Concurrent::Map.new(initial_capacity: 2)
+      @recurse_check = Concurrent::Map.new(initial_capacity: 2)
       @prefix = "#{prefix}#{prefix && '.'}"
 
       @log_path_aggregator = log_path_aggregator
@@ -37,13 +38,19 @@ module Prefab
     end
 
     def log_internal(message, path, progname, severity, log_context={}, &block)
+      return if @recurse_check[local_log_id]
+      @recurse_check[local_log_id] = true
+
       path = if path
                "#{INTERNAL_PREFIX}.#{path}"
              else
                INTERNAL_PREFIX
              end
-
-      log(message, path, progname, severity, log_context, &block)
+      begin
+        log(message, path, progname, severity, log_context, &block)
+      ensure
+        @recurse_check[local_log_id] = false
+      end
     end
 
     def log(message, path, progname, severity, log_context={})

data/lib/prefab/options.rb

@@ -16,6 +16,8 @@ module Prefab
     attr_reader :prefab_config_classpath_dir
     attr_reader :prefab_envs
     attr_reader :collect_sync_interval
+    attr_reader :use_local_cache
+    attr_accessor :is_fork
 
     DEFAULT_LOG_FORMATTER = proc { |data|
       severity = data[:severity]
@@ -77,7 +79,8 @@ module Prefab
       context_max_size: DEFAULT_MAX_EVAL_SUMMARIES,
       collect_evaluation_summaries: true,
       collect_max_evaluation_summaries: DEFAULT_MAX_EVAL_SUMMARIES,
-      allow_telemetry_in_local_mode: false
+      allow_telemetry_in_local_mode: false,
+      x_use_local_cache: false
     )
       @api_key = api_key
       @logdev = logdev
@@ -98,6 +101,8 @@ module Prefab
       @collect_evaluation_summaries = collect_evaluation_summaries
       @collect_max_evaluation_summaries = collect_max_evaluation_summaries
       @allow_telemetry_in_local_mode = allow_telemetry_in_local_mode
+      @use_local_cache = x_use_local_cache
+      @is_fork = false
 
       # defaults that may be overridden by context_upload_mode
       @collect_shapes = false
@@ -156,6 +161,16 @@ module Prefab
       ENV['PREFAB_CDN_URL'] || "#{@prefab_api_url.gsub(/\./, '-')}.global.ssl.fastly.net"
     end
 
+    def api_key_id
+      @api_key&.split("-")&.first
+    end
+
+    def for_fork
+      clone = self.clone
+      clone.is_fork = true
+      clone
+    end
+
     private
 
     def telemetry_allowed?(option)

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.1.1 ruby lib
+# stub: prefab-cloud-ruby 1.1.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "prefab-cloud-ruby".freeze
-  s.version = "1.1.1"
+  s.version = "1.1.2"
 
   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-10-11"
+  s.date = "2023-10-13"
   s.description = "Feature Flags, Live Config, and Dynamic Log Levels as a service".freeze
   s.email = "jdwyer@prefab.cloud".freeze
   s.executables = ["console".freeze]
@@ -21,7 +21,6 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
-    ".envrc",
     ".envrc.sample",
     ".github/workflows/ruby.yml",
     ".gitmodules",

data/test/support/mock_base_client.rb

@@ -30,7 +30,7 @@ class MockBaseClient
     @logger
   end
 
-  def log_internal(level, message); end
+  def log_internal(level, msg, path = nil, **tags); end
 
   def context_shape_aggregator; end
 

data/test/test_config_client.rb

@@ -9,7 +9,8 @@ class TestConfigClient < Minitest::Test
       prefab_config_override_dir: 'none',
       prefab_config_classpath_dir: 'test',
       prefab_envs: 'unit_tests',
-      prefab_datasources: Prefab::Options::DATASOURCES::LOCAL_ONLY
+      prefab_datasources: Prefab::Options::DATASOURCES::LOCAL_ONLY,
+      x_use_local_cache: true,
     )
 
     @config_client = Prefab::ConfigClient.new(MockBaseClient.new(options), 10)
@@ -73,4 +74,36 @@ class TestConfigClient < Minitest::Test
 
     assert_match(/format is invalid/, err.message)
   end
+
+  def test_caching
+    @config_client.send(:cache_configs,
+                        PrefabProto::Configs.new(configs:
+                                                   [PrefabProto::Config.new(key: 'test', id: 1,
+                                                                            rows: [PrefabProto::ConfigRow.new(
+                                                                              values: [
+                                                                                PrefabProto::ConditionalValue.new(
+                                                                                  value: PrefabProto::ConfigValue.new(string: "test value")
+                                                                                )
+                                                                              ]
+                                                                            )])],
+                                                 config_service_pointer: PrefabProto::ConfigServicePointer.new(project_id: 3, project_env_id: 5)))
+    @config_client.send(:load_cache)
+    assert_equal "test value", @config_client.get("test")
+  end
+
+  def test_cache_path_respects_xdg
+    options = Prefab::Options.new(
+      prefab_datasources: Prefab::Options::DATASOURCES::LOCAL_ONLY,
+      x_use_local_cache: true,
+      api_key: "123-ENV-KEY-SDK",)
+
+    config_client = Prefab::ConfigClient.new(MockBaseClient.new(options), 10)
+    assert_equal "#{Dir.home}/.cache/prefab.cache.123.json", config_client.send(:cache_path)
+
+    with_env('XDG_CACHE_HOME', '/tmp') do
+      config_client = Prefab::ConfigClient.new(MockBaseClient.new(options), 10)
+      assert_equal "/tmp/prefab.cache.123.json", config_client.send(:cache_path)
+    end
+  end
+
 end

data/test/test_criteria_evaluator.rb

@@ -724,6 +724,8 @@ class TestCriteriaEvaluator < Minitest::Test
       FakeLogger.new
     end
 
+    def log_internal(level, msg, path = nil, **tags); end
+
     def evaluation_summary_aggregator
       @evaluation_summary_aggregator ||= Prefab::EvaluationSummaryAggregator.new(client: self, max_keys: 9999, sync_interval: 9999)
     end

data/test/test_helper.rb

@@ -3,7 +3,7 @@
 require 'minitest/autorun'
 require 'minitest/focus'
 require 'minitest/reporters'
-Minitest::Reporters.use!
+Minitest::Reporters.use! unless ENV['RM_INFO']
 
 require 'prefab-cloud-ruby'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prefab-cloud-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Jeff Dwyer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-11 00:00:00.000000000 Z
+date: 2023-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -180,7 +180,6 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- ".envrc"
 - ".envrc.sample"
 - ".github/workflows/ruby.yml"
 - ".gitmodules"

data/.envrc

@@ -1,2 +0,0 @@
-export AWS_ACCESS_KEY_ID=
-export AWS_SECRET_ACCESS_KEY=