prefab-cloud-ruby 1.6.0.pre2 → 1.6.1

data/lib/prefab/context.rb

@@ -8,18 +8,8 @@ module Prefab
       attr_reader :name
 
       def initialize(name, hash)
-        @hash = {}
         @name = name.to_s
-
-        merge!(hash)
-      end
-
-      def get(parts)
-        @hash[parts]
-      end
-
-      def merge!(other)
-        @hash = @hash.merge(other.transform_keys(&:to_s))
+        @hash = hash.transform_keys(&:to_s)
       end
 
       def to_h
@@ -27,13 +17,13 @@ module Prefab
       end
 
       def key
-        "#{@name}:#{get('key')}"
+        "#{@name}:#{@hash['key']}"
       end
 
       def to_proto
         PrefabProto::Context.new(
           type: name,
-          values: to_h.transform_values do |value|
+          values: @hash.transform_values do |value|
             ConfigValueWrapper.wrap(value)
           end
         )
@@ -44,17 +34,35 @@ module Prefab
     attr_reader :contexts, :seen_at
 
     class << self
+      def global_context=(context)
+        @global_context = join(hash: context, parent: nil, id: :global_context)
+      end
+
+      def global_context
+        @global_context ||= join(parent: nil, id: :global_context)
+      end
+
+      def default_context=(context)
+        @default_context = join(hash: context, parent: global_context, id: :default_context)
+
+        self.current.update_parent(@default_context)
+      end
+
+      def default_context
+        @default_context ||= join(parent: global_context, id: :default_context)
+      end
+
       def current=(context)
-        Thread.current[THREAD_KEY] = context
+        Thread.current[THREAD_KEY] = join(hash: context || {}, parent: default_context, id: :block)
       end
 
       def current
-        Thread.current[THREAD_KEY] ||= new
+        Thread.current[THREAD_KEY] ||= join(parent: default_context, id: :block)
       end
 
       def with_context(context)
         old_context = Thread.current[THREAD_KEY]
-        Thread.current[THREAD_KEY] = new(context)
+        Thread.current[THREAD_KEY] = join(parent: default_context, hash: context, id: :block)
         yield
       ensure
         Thread.current[THREAD_KEY] = old_context
@@ -62,7 +70,7 @@ module Prefab
 
       def with_merged_context(context)
         old_context = Thread.current[THREAD_KEY]
-        Thread.current[THREAD_KEY] = merge_with_current(context)
+        Thread.current[THREAD_KEY] = join(parent: current, hash: context, id: :merged)
         yield
       ensure
         Thread.current[THREAD_KEY] = old_context
@@ -77,51 +85,92 @@ module Prefab
       end
     end
 
-    def initialize(context = {})
+    def self.join(hash: {}, parent: nil, id: :not_provided)
+      context = new(hash)
+      context.update_parent(parent)
+      context.instance_variable_set(:@id, id)
+      context
+    end
+
+    def initialize(hash = {})
       @contexts = {}
+      @flattened = {}
       @seen_at = Time.now.utc.to_i
+      warned = false
+
+      if hash.is_a?(Hash)
+        hash.map do |name, values|
+          unless values.is_a?(Hash)
+            warn "[DEPRECATION] Prefab contexts should be a hash with a key of the context name and a value of a hash."
+            values = { name => values }
+            name = BLANK_CONTEXT_NAME
+          end
 
-      if context.is_a?(NamedContext)
-        @contexts[context.name] = context
-      elsif context.is_a?(Hash)
-        context.map do |name, values|
-          if values.is_a?(Hash)
-            @contexts[name.to_s] = NamedContext.new(name, values)
-          else
-            warn '[DEPRECATION] Prefab contexts should be a hash with a key of the context name and a value of a hash.'
-
-            @contexts[BLANK_CONTEXT_NAME] ||= NamedContext.new(BLANK_CONTEXT_NAME, {})
-            @contexts[BLANK_CONTEXT_NAME].merge!({ name => values })
+          @contexts[name.to_s] = NamedContext.new(name, values)
+          values.each do |key, value|
+            @flattened[name.to_s + '.' + key.to_s] = value
           end
         end
       else
-        raise ArgumentError, 'must be a Hash or a NamedContext'
+        raise ArgumentError, 'must be a Hash'
       end
     end
 
+    def update_parent(parent)
+      @parent = parent
+    end
+
     def blank?
       contexts.empty?
     end
 
     def set(name, hash)
       @contexts[name.to_s] = NamedContext.new(name, hash)
+      hash.each do |key, value|
+        @flattened[name.to_s + '.' + key.to_s] = value
+      end
     end
 
-    def get(property_key)
-      name, key = property_key.split('.', 2)
-
-      if key.nil?
-        name = BLANK_CONTEXT_NAME
-        key = property_key
+    def get(property_key, scope: nil)
+      if !property_key.include?(".")
+        property_key = BLANK_CONTEXT_NAME + '.' + property_key
       end
 
-      contexts[name]&.get(key)
+      if @flattened.key?(property_key)
+        @flattened[property_key]
+      else
+        scope ||= property_key.split('.').first
+
+        if @contexts[scope]
+          # If the key is in the present scope, parent values should not be used.
+          # We can consider the parent value clobbered by the present scope.
+          nil
+        else
+          @parent&.get(property_key, scope: scope)
+        end
+      end
     end
 
     def to_h
       contexts.transform_values(&:to_h)
     end
 
+    def to_s
+      "#<Prefab::Context:#{object_id} id=#{@id} #{to_h}>"
+    end
+
+    # Visualize a tree of the context up through its parents
+    #
+    # example:
+    #
+    # | jit:                            {"user"=>{"name"=>"Frank"}}
+    # |-- block:                        {"clock"=>{"timezone"=>"PST"}}
+    # |---- default_context:            {"prefab-api-key"=>{"user-id"=>123}}
+    # |------ global_context:           {"cpu"=>{"count"=>4, "speed"=>"2.4GHz"}, "clock"=>{"timezone"=>"UTC"}}
+    def tree(depth = 0)
+      "|" + ("-" * depth) + " #{id}: #{(" " * (30 - id.to_s.length - depth ))}#{to_h}\n" + (@parent&.tree(depth + 2) || '')
+    end
+
     def clear
       @contexts = {}
     end
@@ -175,5 +224,9 @@ module Prefab
         super
       end
     end
+
+    def id
+      @id
+    end
   end
 end

data/lib/prefab/evaluation.rb

@@ -3,7 +3,7 @@
 module Prefab
   # Records the result of evaluating a config's criteria and forensics for reporting
   class Evaluation
-    attr_reader :value
+    attr_reader :value, :context
 
     def initialize(config:, value:, value_index:, config_row_index:, context:, resolver:)
       @config = config
@@ -32,6 +32,7 @@ module Prefab
 
     def report(evaluation_summary_aggregator)
       return if @config.config_type == :LOG_LEVEL
+
       evaluation_summary_aggregator&.record(
         config_key: @config.key,
         config_type: @config.config_type,

data/lib/prefab/options.rb

@@ -15,7 +15,7 @@ module Prefab
     attr_reader :collect_sync_interval
     attr_reader :use_local_cache
     attr_reader :datafile
-    attr_reader :disable_action_controller_logging
+    attr_reader :global_context
     attr_accessor :is_fork
 
     module ON_INITIALIZATION_FAILURE
@@ -59,7 +59,7 @@ module Prefab
       allow_telemetry_in_local_mode: false,
       x_datafile: ENV['PREFAB_DATAFILE'],
       x_use_local_cache: false,
-      disable_action_controller_logging: false
+      global_context: {}
     )
       @api_key = api_key
       @namespace = namespace
@@ -79,8 +79,8 @@ module Prefab
       @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
-      @disable_action_controller_logging = disable_action_controller_logging
       @is_fork = false
+      @global_context = global_context
 
       # defaults that may be overridden by context_upload_mode
       @collect_shapes = false
@@ -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/lib/prefab-cloud-ruby.rb

@@ -45,7 +45,6 @@ require 'prefab/context'
 require 'prefab/logger_client'
 require 'active_support/deprecation'
 require 'active_support'
-require 'action_controller/metal/strong_parameters'
 require 'prefab/client'
 require 'prefab/config_client_presenter'
 require 'prefab/config_client'

data/prefab-cloud-ruby.gemspec

@@ -2,19 +2,18 @@
 # 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.pre2 ruby lib
+# stub: prefab-cloud-ruby 1.6.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "prefab-cloud-ruby".freeze
-  s.version = "1.6.0.pre2"
+  s.version = "1.6.1"
 
-  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-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]
   s.extra_rdoc_files = [
     "CHANGELOG.md",
     "LICENSE.txt",
@@ -34,8 +33,10 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "VERSION",
-    "bin/console",
     "compile_protos.sh",
+    "dev/allocation_stats",
+    "dev/benchmark",
+    "dev/console",
     "lib/prefab-cloud-ruby.rb",
     "lib/prefab/client.rb",
     "lib/prefab/config_client.rb",
@@ -129,7 +130,6 @@ Gem::Specification.new do |s|
     s.add_runtime_dependency(%q<ld-eventsource>.freeze, [">= 0"])
     s.add_runtime_dependency(%q<uuid>.freeze, [">= 0"])
     s.add_runtime_dependency(%q<activesupport>.freeze, [">= 4"])
-    s.add_runtime_dependency(%q<actionpack>.freeze, [">= 4"])
     s.add_runtime_dependency(%q<semantic_logger>.freeze, [">= 0"])
     s.add_development_dependency(%q<benchmark-ips>.freeze, [">= 0"])
     s.add_development_dependency(%q<bundler>.freeze, [">= 0"])
@@ -144,7 +144,6 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<ld-eventsource>.freeze, [">= 0"])
     s.add_dependency(%q<uuid>.freeze, [">= 0"])
     s.add_dependency(%q<activesupport>.freeze, [">= 4"])
-    s.add_dependency(%q<actionpack>.freeze, [">= 4"])
     s.add_dependency(%q<semantic_logger>.freeze, [">= 0"])
     s.add_dependency(%q<benchmark-ips>.freeze, [">= 0"])
     s.add_dependency(%q<bundler>.freeze, [">= 0"])

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)
@@ -173,7 +180,7 @@ module CommonHelpers
       return
     end
 
-    assert_equal expected, $stderr.string.split("\n")
+    assert_equal expected.uniq, $stderr.string.split("\n").uniq
 
     # restore since we've handled it
     $stderr = $oldstderr

data/test/test_config_resolver.rb

@@ -408,6 +408,47 @@ class TestConfigResolver < Minitest::Test
     end
   end
 
+  def test_context_lookup
+    global_context = { cpu: { count: 4, speed: '2.4GHz' }, clock: { timezone: 'UTC' } }
+    default_context = { 'prefab-api-key' => { 'user-id' => 123 } }
+    local_context = { clock: { timezone: 'PST' }, user: { name: 'Ted', email: 'ted@example.com' } }
+    jit_context = { user: { name: 'Frank' } }
+
+    config = PrefabProto::Config.new( key: 'example', rows: [ PrefabProto::ConfigRow.new( values: [ PrefabProto::ConditionalValue.new( value: PrefabProto::ConfigValue.new(string: 'valueB2')) ]) ])
+
+    client = new_client(global_context: global_context, config: [config])
+
+    # we fake getting the default context from the API
+    Prefab::Context.default_context = default_context
+
+    resolver = client.resolver
+
+    client.with_context(local_context) do
+      context = resolver.get("example", jit_context).context
+
+      # This digs all the way to the global context
+      assert_equal 4, context.get('cpu.count')
+      assert_equal '2.4GHz', context.get('cpu.speed')
+
+      # This digs to the default context
+      assert_equal 123, context.get('prefab-api-key.user-id')
+
+      # This digs to the local context
+      assert_equal 'PST', context.get('clock.timezone')
+
+      # This uses the jit context
+      assert_equal 'Frank', context.get('user.name')
+
+      # This is nil in the jit context because `user` was clobbered
+      assert_nil context.get('user.email')
+
+      context = resolver.get("example").context
+
+      # But without the JIT clobbering, it is still set
+      assert_equal 'ted@example.com', context.get('user.email')
+    end
+  end
+
   private
 
   def resolver_for_namespace(namespace, loader, project_env_id: TEST_ENV_ID)

data/test/test_context.rb

@@ -15,33 +15,17 @@ class TestContext < Minitest::Test
     assert_empty context.contexts
   end
 
-  def test_initialize_with_named_context
-    named_context = Prefab::Context::NamedContext.new('test', foo: 'bar')
-    context = Prefab::Context.new(named_context)
-    assert_equal 1, context.contexts.size
-    assert_equal named_context, context.contexts['test']
-  end
-
   def test_initialize_with_hash
     context = Prefab::Context.new(test: { foo: 'bar' })
     assert_equal 1, context.contexts.size
-    assert_equal 'bar', context.contexts['test'].get('foo')
+    assert_equal 'bar', context.get("test.foo")
   end
 
   def test_initialize_with_multiple_hashes
     context = Prefab::Context.new(test: { foo: 'bar' }, other: { foo: 'baz' })
     assert_equal 2, context.contexts.size
-    assert_equal 'bar', context.contexts['test'].get('foo')
-    assert_equal 'baz', context.contexts['other'].get('foo')
-  end
-
-  def test_initialize_with_invalid_hash
-    _, err = capture_io do
-      Prefab::Context.new({ foo: 'bar', baz: 'qux' })
-    end
-
-    assert_match '[DEPRECATION] Prefab contexts should be a hash with a key of the context name and a value of a hash',
-                 err
+    assert_equal 'bar', context.get("test.foo")
+    assert_equal 'baz', context.get("other.foo")
   end
 
   def test_initialize_with_invalid_argument
@@ -56,33 +40,11 @@ class TestContext < Minitest::Test
 
   def test_current_set
     context = Prefab::Context.new(EXAMPLE_PROPERTIES)
-    Prefab::Context.current = context
+    Prefab::Context.current = context.to_h
     assert_instance_of Prefab::Context, context
     assert_equal stringify(EXAMPLE_PROPERTIES), context.to_h
   end
 
-  def test_merge_with_current
-    context = Prefab::Context.new(EXAMPLE_PROPERTIES)
-    Prefab::Context.current = context
-    assert_equal stringify(EXAMPLE_PROPERTIES), context.to_h
-
-    new_context = Prefab::Context.merge_with_current({ user: { key: 'brand-new', other: 'different' },
-                                                       address: { city: 'New York' } })
-    assert_equal stringify({
-                             # Note that the user's `name` from the original
-                             # context is not included. This is because we don't _merge_ the new
-                             # properties if they collide with an existing context name. We _replace_
-                             # them.
-                             user: { key: 'brand-new', other: 'different' },
-                             team: EXAMPLE_PROPERTIES[:team],
-                             address: { city: 'New York' }
-                           }),
-                 new_context.to_h
-
-    # the original/current context is unchanged
-    assert_equal stringify(EXAMPLE_PROPERTIES), Prefab::Context.current.to_h
-  end
-
   def test_with_context
     Prefab::Context.with_context(EXAMPLE_PROPERTIES) do
       context = Prefab::Context.current
@@ -105,9 +67,14 @@ class TestContext < Minitest::Test
 
   def test_with_context_merge_nesting
     Prefab::Context.with_context(EXAMPLE_PROPERTIES) do
-      Prefab::Context.with_merged_context({ user: { key: 'abc', other: 'different' } }) do
+      Prefab::Context.with_merged_context({ user: { key: 'hij', other: 'different' } }) do
         context = Prefab::Context.current
-        assert_equal({ 'user' => { 'key' => 'abc', 'other' => 'different' }, "team"=>{"key"=>"abc", "plan"=>"pro"} }, context.to_h)
+        assert_nil context.get('user.name')
+        assert_equal context.get('user.key'), 'hij'
+        assert_equal context.get('user.other'), 'different'
+
+        assert_equal context.get('team.key'), 'abc'
+        assert_equal context.get('team.plan'), 'pro'
       end
 
       context = Prefab::Context.current
@@ -187,6 +154,35 @@ class TestContext < Minitest::Test
     ), contexts.to_proto(namespace)
   end
 
+  def test_parent_lookup
+    global_context = { cpu: { count: 4, speed: '2.4GHz' }, clock: { timezone: 'UTC' } }
+    default_context = { 'prefab-api-key' => { 'user-id' => 123 } }
+    local_context = { clock: { timezone: 'PST' }, user: { name: 'Ted', email: 'ted@example.com' } }
+    jit_context = { user: { name: 'Frank' } }
+
+    Prefab::Context.global_context = global_context
+    Prefab::Context.default_context = default_context
+    Prefab::Context.current = local_context
+
+    context = Prefab::Context.join(parent: Prefab::Context.current, hash: jit_context, id: :jit)
+
+    # This digs all the way to the global context
+    assert_equal 4, context.get('cpu.count')
+    assert_equal '2.4GHz', context.get('cpu.speed')
+
+    # This digs to the default context
+    assert_equal 123, context.get('prefab-api-key.user-id')
+
+    # This digs to the local context
+    assert_equal 'PST', context.get('clock.timezone')
+
+    # This uses the jit context
+    assert_equal 'Frank', context.get('user.name')
+
+    # This is nil in the jit context because `user` was clobbered
+    assert_nil context.get('user.email')
+  end
+
   private
 
   def stringify(hash)

data/test/test_example_contexts_aggregator.rb

@@ -10,10 +10,7 @@ class TestExampleContextsAggregator < Minitest::Test
     aggregator = Prefab::ExampleContextsAggregator.new(client: MockBaseClient.new, max_contexts: 2,
                                                        sync_interval: EFFECTIVELY_NEVER)
 
-    context = Prefab::Context.new(
-      user: { key: 'abc' },
-      device: { key: 'def', mobile: true }
-    )
+    context = Prefab::Context.new(user: { key: 'abc' }, device: { key: 'def', mobile: true })
 
     aggregator.record(context)
     assert_equal [context], aggregator.data

data/test/test_helper.rb

@@ -11,7 +11,7 @@ Dir.glob(File.join(File.dirname(__FILE__), 'support', '**', '*.rb')).each do |fi
   require file
 end
 
-MiniTest::Test.class_eval do
+Minitest::Test.class_eval do
   include CommonHelpers
   extend CommonHelpers
 end

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