prefab-cloud-ruby 0.23.7 → 0.24.0

data/test/test_config_resolver.rb

@@ -9,10 +9,19 @@ class TestConfigResolver < Minitest::Test
   SEGMENT_KEY = 'segment_key'
   CONFIG_KEY = 'config_key'
   DEFAULT_VALUE = 'default_value'
+  DESIRED_VALUE = 'desired_value'
   IN_SEGMENT_VALUE = 'in_segment_value'
   WRONG_ENV_VALUE = 'wrong_env_value'
   NOT_IN_SEGMENT_VALUE = 'not_in_segment_value'
 
+  DEFAULT_ROW = Prefab::ConfigRow.new(
+    values: [
+      Prefab::ConditionalValue.new(
+        value: Prefab::ConfigValue.new(string: DEFAULT_VALUE)
+      )
+    ]
+  )
+
   def test_resolution
     @loader = MockConfigLoader.new
 
@@ -20,13 +29,7 @@ class TestConfigResolver < Minitest::Test
       'key' => { config: Prefab::Config.new(
         key: 'key',
         rows: [
-          Prefab::ConfigRow.new(
-            values: [
-              Prefab::ConditionalValue.new(
-                value: Prefab::ConfigValue.new(string: 'value_no_env_default')
-              )
-            ]
-          ),
+          DEFAULT_ROW,
           Prefab::ConfigRow.new(
             project_env_id: TEST_ENV_ID,
             values: [
@@ -114,31 +117,49 @@ class TestConfigResolver < Minitest::Test
 
     @loader.stub :calc_config, loaded_values do
       @resolverA = resolver_for_namespace('', @loader, project_env_id: PRODUCTION_ENV_ID)
-      assert_equal 'value_no_env_default', @resolverA.get('key', nil).string
+      assert_equal_context_and_jit DEFAULT_VALUE, @resolverA, 'key', {}, :string
 
       ## below here in the test env
       @resolverA = resolver_for_namespace('', @loader)
-      assert_equal 'value_none', @resolverA.get('key', nil).string
+      assert_equal_context_and_jit 'value_none', @resolverA, 'key', {}, :string
 
       @resolverA = resolver_for_namespace('projectA', @loader)
-      assert_equal 'valueA', @resolverA.get('key', nil).string
+      assert_equal_context_and_jit 'valueA', @resolverA, 'key', {}, :string
 
       @resolverB = resolver_for_namespace('projectB', @loader)
-      assert_equal 'valueB', @resolverB.get('key', nil).string
+      assert_equal_context_and_jit 'valueB', @resolverB, 'key', {}, :string
 
       @resolverBX = resolver_for_namespace('projectB.subprojectX', @loader)
-      assert_equal 'projectB.subprojectX', @resolverBX.get('key', nil).string
+      assert_equal_context_and_jit 'projectB.subprojectX', @resolverBX, 'key', {}, :string
 
       @resolverBX = resolver_for_namespace('projectB.subprojectX', @loader)
-      assert_equal 'valueB2', @resolverBX.get('key2', nil).string
+      assert_equal_context_and_jit 'valueB2', @resolverBX, 'key2', {}, :string
 
-      @resolverUndefinedSubProject = resolver_for_namespace('projectB.subprojectX.subsubQ', @loader)
-      assert_equal 'projectB.subprojectX', @resolverUndefinedSubProject.get('key', nil).string
+      @resolverUndefinedSubProject = resolver_for_namespace('projectB.subprojectX.subsubQ',
+                                                            @loader)
+      assert_equal_context_and_jit 'projectB.subprojectX', @resolverUndefinedSubProject, 'key',
+                                   {}, :string
 
       @resolverBX = resolver_for_namespace('projectC', @loader)
-      assert_equal 'value_none', @resolverBX.get('key', nil).string
+      assert_equal_context_and_jit 'value_none', @resolverBX, 'key', {}, :string
 
       assert_nil @resolverBX.get('key_that_doesnt_exist', nil)
+
+      assert_equal @resolverBX.to_s.strip.split("\n").map(&:strip), [
+        'key                                                | value_none                          | String  | Match:                         | Source:',
+        'key2                                               | valueB2                             | String  | Match:                         | Source:'
+      ]
+
+      assert_equal @resolverBX.presenter.to_h, {
+        'key' => Prefab::ResolvedConfigPresenter::ConfigRow.new('key', 'value_none', nil, nil),
+        'key2' => Prefab::ResolvedConfigPresenter::ConfigRow.new('key2', 'valueB2', nil, nil)
+      }
+
+      resolved_lines = []
+      @resolverBX.presenter.each do |key, row|
+        resolved_lines << [key, row.value]
+      end
+      assert_equal resolved_lines, [%w[key value_none], %w[key2 valueB2]]
     end
   end
 
@@ -155,7 +176,7 @@ class TestConfigResolver < Minitest::Test
                 Prefab::Criterion.new(
                   operator: Prefab::Criterion::CriterionOperator::PROP_ENDS_WITH_ONE_OF,
                   value_to_match: string_list(['hotmail.com', 'gmail.com']),
-                  property_name: 'email'
+                  property_name: 'user.email'
                 )
               ]
             ),
@@ -222,8 +243,10 @@ class TestConfigResolver < Minitest::Test
       resolver = Prefab::ConfigResolver.new(MockBaseClient.new(options), loader)
       resolver.project_env_id = PRODUCTION_ENV_ID
 
-      assert_equal DEFAULT_VALUE, resolver.get(CONFIG_KEY, nil, { email: 'test@something-else.com' }).string
-      assert_equal IN_SEGMENT_VALUE, resolver.get(CONFIG_KEY, nil, { email: 'test@hotmail.com' }).string
+      assert_equal_context_and_jit DEFAULT_VALUE, resolver, CONFIG_KEY,
+                                   { user: { email: 'test@something-else.com' } }, :string
+      assert_equal_context_and_jit IN_SEGMENT_VALUE, resolver, CONFIG_KEY,
+                                   { user: { email: 'test@hotmail.com' } }, :string
     end
   end
 
@@ -240,7 +263,7 @@ class TestConfigResolver < Minitest::Test
                 Prefab::Criterion.new(
                   operator: Prefab::Criterion::CriterionOperator::PROP_ENDS_WITH_ONE_OF,
                   value_to_match: string_list(['hotmail.com', 'gmail.com']),
-                  property_name: 'email'
+                  property_name: 'user.email'
                 )
               ]
             ),
@@ -289,77 +312,98 @@ class TestConfigResolver < Minitest::Test
       options = Prefab::Options.new
       resolver = Prefab::ConfigResolver.new(MockBaseClient.new(options), loader)
 
-      assert_equal IN_SEGMENT_VALUE, resolver.get(CONFIG_KEY, nil, { email: 'test@hotmail.com' }).string
-      assert_equal NOT_IN_SEGMENT_VALUE, resolver.get(CONFIG_KEY, nil, { email: 'test@something-else.com' }).string
+      assert_equal_context_and_jit IN_SEGMENT_VALUE, resolver, CONFIG_KEY, { user: { email: 'test@hotmail.com' } },
+                                   :string
+      assert_equal_context_and_jit NOT_IN_SEGMENT_VALUE, resolver, CONFIG_KEY, { user: { email: 'test@something-else.com' } },
+                                   :string
     end
   end
 
-  def test_resolving_in_segment_with_lookup_key
-    segment_config = Prefab::Config.new(
-      config_type: Prefab::ConfigType::SEGMENT,
-      key: SEGMENT_KEY,
+  def test_jit_context_merges_with_existing_context
+    config = Prefab::Config.new(
+      key: CONFIG_KEY,
       rows: [
+        DEFAULT_ROW,
         Prefab::ConfigRow.new(
+          project_env_id: TEST_ENV_ID,
           values: [
             Prefab::ConditionalValue.new(
-              value: Prefab::ConfigValue.new(bool: true),
               criteria: [
                 Prefab::Criterion.new(
-                  operator: Prefab::Criterion::CriterionOperator::LOOKUP_KEY_IN,
-                  value_to_match: string_list(['user:1234', 'user:4567']),
-                  property_name: 'LOOKUP'
+                  operator: Prefab::Criterion::CriterionOperator::PROP_IS_ONE_OF,
+                  value_to_match: string_list(%w[pro advanced]),
+                  property_name: 'team.plan'
+                ),
+
+                Prefab::Criterion.new(
+                  operator: Prefab::Criterion::CriterionOperator::PROP_ENDS_WITH_ONE_OF,
+                  value_to_match: string_list(%w[@example.com]),
+                  property_name: 'user.email'
                 )
-              ]
-            ),
-            Prefab::ConditionalValue.new(value: Prefab::ConfigValue.new(bool: false))
+              ],
+              value: Prefab::ConfigValue.new(string: DESIRED_VALUE)
+            )
           ]
         )
       ]
     )
 
+    loader = MockConfigLoader.new
+
+    loader.stub :calc_config, { CONFIG_KEY => { config: config } } do
+      options = Prefab::Options.new
+      resolver = Prefab::ConfigResolver.new(MockBaseClient.new(options), loader)
+      resolver.project_env_id = TEST_ENV_ID
+
+      Prefab::Context.with_context({ user: { email: 'test@example.com' } }) do
+        assert_equal DEFAULT_VALUE, resolver.get(CONFIG_KEY).string
+        assert_equal DEFAULT_VALUE, resolver.get(CONFIG_KEY, { team: { plan: 'freebie' } }).string
+        assert_equal DESIRED_VALUE, resolver.get(CONFIG_KEY, { team: { plan: 'pro' } }).string
+      end
+    end
+  end
+
+  def test_jit_can_clobber_existing_context
     config = Prefab::Config.new(
       key: CONFIG_KEY,
       rows: [
+        DEFAULT_ROW,
         Prefab::ConfigRow.new(
+          project_env_id: TEST_ENV_ID,
           values: [
             Prefab::ConditionalValue.new(
               criteria: [
                 Prefab::Criterion.new(
-                  operator: Prefab::Criterion::CriterionOperator::IN_SEG,
-                  value_to_match: Prefab::ConfigValue.new(string: SEGMENT_KEY)
-                )
-              ],
-              value: Prefab::ConfigValue.new(string: IN_SEGMENT_VALUE)
-            ),
-            Prefab::ConditionalValue.new(
-              criteria: [
+                  operator: Prefab::Criterion::CriterionOperator::PROP_IS_ONE_OF,
+                  value_to_match: string_list(%w[pro advanced]),
+                  property_name: 'team.plan'
+                ),
+
                 Prefab::Criterion.new(
-                  operator: Prefab::Criterion::CriterionOperator::NOT_IN_SEG,
-                  value_to_match: Prefab::ConfigValue.new(string: SEGMENT_KEY)
+                  operator: Prefab::Criterion::CriterionOperator::PROP_ENDS_WITH_ONE_OF,
+                  value_to_match: string_list(%w[@example.com]),
+                  property_name: 'user.email'
                 )
               ],
-              value: Prefab::ConfigValue.new(string: NOT_IN_SEGMENT_VALUE)
+              value: Prefab::ConfigValue.new(string: DESIRED_VALUE)
             )
           ]
         )
       ]
     )
 
-    loaded_values = {
-      SEGMENT_KEY => { config: segment_config },
-      CONFIG_KEY => { config: config }
-    }
-
     loader = MockConfigLoader.new
 
-    loader.stub :calc_config, loaded_values do
+    loader.stub :calc_config, { CONFIG_KEY => { config: config } } do
       options = Prefab::Options.new
       resolver = Prefab::ConfigResolver.new(MockBaseClient.new(options), loader)
+      resolver.project_env_id = TEST_ENV_ID
 
-      assert_equal IN_SEGMENT_VALUE, resolver.get(CONFIG_KEY, 'user:1234', {}).string
-      assert_equal IN_SEGMENT_VALUE, resolver.get(CONFIG_KEY, 'user:4567', {}).string
-      assert_equal NOT_IN_SEGMENT_VALUE, resolver.get(CONFIG_KEY, nil, {}).string
-      assert_equal NOT_IN_SEGMENT_VALUE, resolver.get(CONFIG_KEY, 'user:9999', {}).string
+      Prefab::Context.with_context({ user: { email: 'test@hotmail.com' }, team: { plan: 'pro' } }) do
+        assert_equal DEFAULT_VALUE, resolver.get(CONFIG_KEY).string
+        assert_equal DESIRED_VALUE, resolver.get(CONFIG_KEY, { user: { email: 'test@example.com' } }).string
+        assert_equal DEFAULT_VALUE, resolver.get(CONFIG_KEY, { team: { plan: 'freebie' } }).string
+      end
     end
   end
 
@@ -374,4 +418,12 @@ class TestConfigResolver < Minitest::Test
     resolver.update
     resolver
   end
+
+  def assert_equal_context_and_jit(expected_value, resolver, key, properties, type)
+    assert_equal expected_value, resolver.get(key, properties).send(type)
+
+    Prefab::Context.with_context(properties) do
+      assert_equal expected_value, resolver.get(key).send(type)
+    end
+  end
 end

data/test/test_config_value_unwrapper.rb

@@ -41,34 +41,34 @@ class TestConfigValueUnwrapper < Minitest::Test
   def test_unwrapping_weighted_values
     # single value
     config_value = Prefab::ConfigValue.new(weighted_values: weighted_values([['abc', 1]]))
+
     assert_equal 'abc', Prefab::ConfigValueUnwrapper.unwrap(config_value, CONFIG_KEY, {})
 
     # multiple values, evenly distributed
     config_value = Prefab::ConfigValue.new(weighted_values: weighted_values([['abc', 1], ['def', 1], ['ghi', 1]]))
-    assert_equal 'ghi', Prefab::ConfigValueUnwrapper.unwrap(config_value, CONFIG_KEY, lookup_properties('user:123'))
-    assert_equal 'ghi', Prefab::ConfigValueUnwrapper.unwrap(config_value, CONFIG_KEY, lookup_properties('user:456'))
-    assert_equal 'abc', Prefab::ConfigValueUnwrapper.unwrap(config_value, CONFIG_KEY, lookup_properties('user:789'))
-    assert_equal 'def', Prefab::ConfigValueUnwrapper.unwrap(config_value, CONFIG_KEY, lookup_properties('user:012'))
+    assert_equal 'def', Prefab::ConfigValueUnwrapper.unwrap(config_value, CONFIG_KEY, context_with_key('user:000'))
+    assert_equal 'ghi', Prefab::ConfigValueUnwrapper.unwrap(config_value, CONFIG_KEY, context_with_key('user:456'))
+    assert_equal 'abc', Prefab::ConfigValueUnwrapper.unwrap(config_value, CONFIG_KEY, context_with_key('user:789'))
+    assert_equal 'ghi', Prefab::ConfigValueUnwrapper.unwrap(config_value, CONFIG_KEY, context_with_key('user:888'))
 
     # multiple values, unevenly distributed
     config_value = Prefab::ConfigValue.new(weighted_values: weighted_values([['abc', 1], ['def', 99], ['ghi', 1]]))
-    assert_equal 'def', Prefab::ConfigValueUnwrapper.unwrap(config_value, CONFIG_KEY, lookup_properties('user:123'))
-    assert_equal 'def', Prefab::ConfigValueUnwrapper.unwrap(config_value, CONFIG_KEY, lookup_properties('user:456'))
-    assert_equal 'def', Prefab::ConfigValueUnwrapper.unwrap(config_value, CONFIG_KEY, lookup_properties('user:789'))
-    assert_equal 'def', Prefab::ConfigValueUnwrapper.unwrap(config_value, CONFIG_KEY, lookup_properties('user:012'))
-
-    assert_equal 'ghi', Prefab::ConfigValueUnwrapper.unwrap(config_value, CONFIG_KEY, lookup_properties('user:103'))
-    assert_equal 'abc', Prefab::ConfigValueUnwrapper.unwrap(config_value, CONFIG_KEY, lookup_properties('user:119'))
+    assert_equal 'def', Prefab::ConfigValueUnwrapper.unwrap(config_value, CONFIG_KEY, context_with_key('user:123'))
+    assert_equal 'def', Prefab::ConfigValueUnwrapper.unwrap(config_value, CONFIG_KEY, context_with_key('user:456'))
+    assert_equal 'def', Prefab::ConfigValueUnwrapper.unwrap(config_value, CONFIG_KEY, context_with_key('user:789'))
+    assert_equal 'def', Prefab::ConfigValueUnwrapper.unwrap(config_value, CONFIG_KEY, context_with_key('user:012'))
+    assert_equal 'ghi', Prefab::ConfigValueUnwrapper.unwrap(config_value, CONFIG_KEY, context_with_key('user:428'))
+    assert_equal 'abc', Prefab::ConfigValueUnwrapper.unwrap(config_value, CONFIG_KEY, context_with_key('user:548'))
   end
 
   private
 
-  def weighted_values(values_and_weights)
+  def weighted_values(values_and_weights, hash_by_property_name: 'user.key')
     values = values_and_weights.map do |value, weight|
       weighted_value(value, weight)
     end
 
-    Prefab::WeightedValues.new(weighted_values: values)
+    Prefab::WeightedValues.new(weighted_values: values, hash_by_property_name: hash_by_property_name)
   end
 
   def weighted_value(string, weight)
@@ -77,7 +77,7 @@ class TestConfigValueUnwrapper < Minitest::Test
     )
   end
 
-  def lookup_properties(lookup_key)
-    { Prefab::CriteriaEvaluator::LOOKUP_KEY => lookup_key }
+  def context_with_key(key)
+    Prefab::Context.new(user: { key: key })
   end
 end

data/test/test_context.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class TestContext < Minitest::Test
+  EXAMPLE_PROPERTIES = { user: { key: 'some-user-key', name: 'Ted' }, team: { key: 'abc', plan: 'pro' } }.freeze
+
+  def setup
+    Prefab::Context.current = nil
+  end
+
+  def test_initialize_with_empty_context
+    context = Prefab::Context.new({})
+    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')
+  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
+  end
+
+  def test_initialize_with_invalid_argument
+    assert_raises(ArgumentError) { Prefab::Context.new([]) }
+  end
+
+  def test_current
+    context = Prefab::Context.current
+    assert_instance_of Prefab::Context, context
+    assert_empty context.to_h
+  end
+
+  def test_current_set
+    context = Prefab::Context.new(EXAMPLE_PROPERTIES)
+    Prefab::Context.current = context
+    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
+      assert_equal(stringify(EXAMPLE_PROPERTIES), context.to_h)
+      assert_equal('some-user-key', context['user.key'])
+    end
+  end
+
+  def test_with_context_nesting
+    Prefab::Context.with_context(EXAMPLE_PROPERTIES) do
+      Prefab::Context.with_context({ user: { key: 'abc', other: 'different' } }) do
+        context = Prefab::Context.current
+        assert_equal({ 'user' => { 'key' => 'abc', 'other' => 'different' } }, context.to_h)
+      end
+
+      context = Prefab::Context.current
+      assert_equal(stringify(EXAMPLE_PROPERTIES), context.to_h)
+    end
+  end
+
+  def test_setting
+    context = Prefab::Context.new({})
+    context.set('user', { key: 'value' })
+    context[:other] = { key: 'different', something: 'other' }
+    assert_equal(stringify({ user: { key: 'value' }, other: { key: 'different', something: 'other' } }), context.to_h)
+  end
+
+  def test_getting
+    context = Prefab::Context.new(EXAMPLE_PROPERTIES)
+    assert_equal('some-user-key', context.get('user.key'))
+    assert_equal('some-user-key', context['user.key'])
+    assert_equal('pro', context.get('team.plan'))
+    assert_equal('pro', context['team.plan'])
+  end
+
+  def test_dot_notation_getting
+    context = Prefab::Context.new({ 'user' => { 'key' => 'value' } })
+    assert_equal('value', context.get('user.key'))
+    assert_equal('value', context['user.key'])
+  end
+
+  def test_dot_notation_getting_with_symbols
+    context = Prefab::Context.new({ user: { key: 'value' } })
+    assert_equal('value', context.get('user.key'))
+    assert_equal('value', context['user.key'])
+  end
+
+  def test_merge
+    context = Prefab::Context.new(EXAMPLE_PROPERTIES)
+    context.merge!(:other, { key: 'different' })
+    assert_equal(stringify(EXAMPLE_PROPERTIES.merge(other: { key: 'different' })), context.to_h)
+  end
+
+  def test_clear
+    context = Prefab::Context.new(EXAMPLE_PROPERTIES)
+    context.clear
+
+    assert_empty context.to_h
+  end
+
+  private
+
+  def stringify(hash)
+    hash.map { |k, v| [k.to_s, stringify_keys(v)] }.to_h
+  end
+
+  def stringify_keys(value)
+    if value.is_a?(Hash)
+      value.transform_keys(&:to_s)
+    else
+      value
+    end
+  end
+end