prefab-cloud-ruby 0.24.5 → 1.0.0

data/test/test_rate_limit_cache.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'timecop'
+
+class RateLimitCacheTest < Minitest::Test
+  def test_set_and_fresh
+    cache = Prefab::RateLimitCache.new(5)
+    cache.set('key')
+    assert cache.fresh?('key')
+  end
+
+  def test_fresh_with_no_set
+    cache = Prefab::RateLimitCache.new(5)
+    refute cache.fresh?('key')
+  end
+
+  def test_get_after_expiration
+    cache = Prefab::RateLimitCache.new(5)
+
+    Timecop.freeze(Time.now - 6) do
+      cache.set('key')
+      assert cache.fresh?('key')
+    end
+
+    refute cache.fresh?('key')
+
+    # but the data is still there
+    assert cache.data.get('key')
+  end
+
+  def test_prune
+    cache = Prefab::RateLimitCache.new(5)
+
+    Timecop.freeze(Time.now - 6) do
+      cache.set('key')
+      assert cache.fresh?('key')
+    end
+
+    cache.prune
+
+    refute cache.fresh?('key')
+  end
+end

data/test/test_weighted_value_resolver.rb

@@ -8,30 +8,36 @@ class TestWeightedValueResolver < Minitest::Test
   def test_resolving_single_value
     values = weighted_values([['abc', 1]])
     resolver = Prefab::WeightedValueResolver.new(values, KEY, nil)
-    assert_equal 'abc', resolver.resolve.value.string
+    assert_equal 'abc', resolver.resolve[0].value.string
+    assert_equal 0, resolver.resolve[1]
   end
 
   def test_resolving_multiple_values_evenly_distributed
     values = weighted_values([['abc', 1], ['def', 1]])
 
     resolver = Prefab::WeightedValueResolver.new(values, KEY, 'user:001')
-    assert_equal 'abc', resolver.resolve.value.string
+    assert_equal 'abc', resolver.resolve[0].value.string
+    assert_equal 0, resolver.resolve[1]
 
     resolver = Prefab::WeightedValueResolver.new(values, KEY, 'user:456')
-    assert_equal 'def', resolver.resolve.value.string
+    assert_equal 'def', resolver.resolve[0].value.string
+    assert_equal 1, resolver.resolve[1]
   end
 
   def test_resolving_multiple_values_unevenly_distributed
     values = weighted_values([['abc', 1], ['def', 98], ['ghi', 1]])
 
     resolver = Prefab::WeightedValueResolver.new(values, KEY, 'user:456')
-    assert_equal 'def', resolver.resolve.value.string
+    assert_equal 'def', resolver.resolve[0].value.string
+    assert_equal 1, resolver.resolve[1]
 
     resolver = Prefab::WeightedValueResolver.new(values, KEY, 'user:103')
-    assert_equal 'ghi', resolver.resolve.value.string
+    assert_equal 'ghi', resolver.resolve[0].value.string
+    assert_equal 2, resolver.resolve[1]
 
     resolver = Prefab::WeightedValueResolver.new(values, KEY, 'user:119')
-    assert_equal 'abc', resolver.resolve.value.string
+    assert_equal 'abc', resolver.resolve[0].value.string
+    assert_equal 0, resolver.resolve[1]
   end
 
   def test_resolving_multiple_values_with_simulation
@@ -39,7 +45,7 @@ class TestWeightedValueResolver < Minitest::Test
     results = {}
 
     10_000.times do |i|
-      result = Prefab::WeightedValueResolver.new(values, KEY, "user:#{i}").resolve.value.string
+      result = Prefab::WeightedValueResolver.new(values, KEY, "user:#{i}").resolve[0].value.string
       results[result] ||= 0
       results[result] += 1
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prefab-cloud-ruby
 version: !ruby/object:Gem::Version
-  version: 0.24.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Jeff Dwyer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-10 00:00:00.000000000 Z
+date: 2023-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -211,8 +211,9 @@ 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/evaluated_configs_aggregator.rb
-- lib/prefab/evaluated_keys_aggregator.rb
+- lib/prefab/evaluation.rb
+- lib/prefab/evaluation_summary_aggregator.rb
+- lib/prefab/example_contexts_aggregator.rb
 - lib/prefab/exponential_backoff.rb
 - lib/prefab/feature_flag_client.rb
 - lib/prefab/http_connection.rb
@@ -221,10 +222,9 @@ files:
 - lib/prefab/log_path_aggregator.rb
 - lib/prefab/logger_client.rb
 - lib/prefab/murmer3.rb
-- lib/prefab/noop_cache.rb
-- lib/prefab/noop_stats.rb
 - lib/prefab/options.rb
 - lib/prefab/periodic_sync.rb
+- lib/prefab/rate_limit_cache.rb
 - lib/prefab/resolved_config_presenter.rb
 - lib/prefab/sse_logger.rb
 - lib/prefab/time_helpers.rb
@@ -236,6 +236,10 @@ files:
 - test/.prefab.unit_tests.config.yaml
 - test/integration_test.rb
 - test/integration_test_helpers.rb
+- test/support/common_helpers.rb
+- test/support/mock_base_client.rb
+- test/support/mock_config_client.rb
+- test/support/mock_config_loader.rb
 - test/test_client.rb
 - test/test_config_client.rb
 - test/test_config_loader.rb
@@ -245,8 +249,8 @@ files:
 - test/test_context_shape.rb
 - test/test_context_shape_aggregator.rb
 - test/test_criteria_evaluator.rb
-- test/test_evaluated_configs_aggregator.rb
-- test/test_evaluated_keys_aggregator.rb
+- test/test_evaluation_summary_aggregator.rb
+- test/test_example_contexts_aggregator.rb
 - test/test_exponential_backoff.rb
 - test/test_feature_flag_client.rb
 - test/test_helper.rb
@@ -255,6 +259,7 @@ files:
 - test/test_log_path_aggregator.rb
 - test/test_logger.rb
 - test/test_options.rb
+- test/test_rate_limit_cache.rb
 - test/test_weighted_value_resolver.rb
 homepage: http://github.com/prefab-cloud/prefab-cloud-ruby
 licenses:

data/lib/prefab/evaluated_configs_aggregator.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'periodic_sync'
-
-module Prefab
-  class EvaluatedConfigsAggregator
-    include Prefab::PeriodicSync
-
-    attr_reader :data
-
-    def initialize(client:, max_configs:, sync_interval:)
-      @max_configs = max_configs
-      @client = client
-      @name = 'evaluated_configs_aggregator'
-
-      @data = Concurrent::Array.new
-
-      start_periodic_sync(sync_interval)
-    end
-
-    def push(evaluation)
-      return if @data.size >= @max_configs
-
-      @data.push(evaluation)
-    end
-
-    def prepare_data
-      to_ship = @data.dup
-      @data.clear
-
-      to_ship.map { |e| coerce_to_proto(e) }
-    end
-
-    def coerce_to_proto(evaluation)
-      config, result, context = evaluation
-
-      PrefabProto::EvaluatedConfig.new(
-        key: config.key,
-        config_version: config.id,
-        result: result,
-        context: context.to_proto(@client.namespace),
-        timestamp: Prefab::TimeHelpers.now_in_ms
-      )
-    end
-
-    private
-
-    def flush(to_ship, _)
-      @pool.post do
-        log_internal "Uploading evaluated configs for #{to_ship.size}"
-
-        configs = PrefabProto::EvaluatedConfigs.new(configs: to_ship)
-
-        result = @client.post('/api/v1/evaluated-configs', configs)
-
-        log_internal "Uploaded #{to_ship.size} configs: #{result.status}"
-      end
-    end
-  end
-end

data/lib/prefab/evaluated_keys_aggregator.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'periodic_sync'
-
-module Prefab
-  class EvaluatedKeysAggregator
-    include Prefab::PeriodicSync
-
-    attr_reader :data
-
-    def initialize(client:, max_keys:, sync_interval:)
-      @max_keys = max_keys
-      @client = client
-      @name = 'evaluated_keys_aggregator'
-
-      @data = Concurrent::Set.new
-
-      start_periodic_sync(sync_interval)
-    end
-
-    def push(key)
-      return if @data.size >= @max_keys
-
-      @data.add(key)
-    end
-
-    private
-
-    def flush(to_ship, _)
-      @pool.post do
-        log_internal "Uploading evaluated keys for #{to_ship.size}"
-
-        keys = PrefabProto::EvaluatedKeys.new(keys: to_ship.to_a, namespace: @client.namespace)
-
-        result = @client.post('/api/v1/evaluated-keys', keys)
-
-        log_internal "Uploaded #{to_ship.size} keys: #{result.status}"
-      end
-    end
-  end
-end

data/lib/prefab/noop_cache.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Prefab
-  class NoopCache
-    def fetch(_name, _opts)
-      yield
-    end
-
-    def write(name, value, opts = nil); end
-
-    def read(name); end
-
-    def delete(name); end
-  end
-end

data/lib/prefab/noop_stats.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module Prefab
-  class NoopStats
-    # receives increment("prefab.ratelimit.limitcheck", {:tags=>["policy_group:page_view", "pass:true"]})
-    def increment(name, opts = {}); end
-  end
-end

data/test/test_evaluated_configs_aggregator.rb

@@ -1,254 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-require 'timecop'
-
-class TestEvaluatedConfigsAggregator < Minitest::Test
-  MAX_WAIT = 2
-  SLEEP_TIME = 0.01
-
-  def test_push
-    aggregator = Prefab::EvaluatedConfigsAggregator.new(client: new_client, max_configs: 2, sync_interval: 1000)
-
-    aggregator.push([])
-    aggregator.push([])
-
-    assert_equal 2, aggregator.data.size
-
-    # we've reached the limit, so no more
-    aggregator.push([])
-    assert_equal 2, aggregator.data.size
-  end
-
-  def test_coerce_to_proto
-    aggregator = Prefab::EvaluatedConfigsAggregator.new(client: new_client, max_configs: 2, sync_interval: 2)
-
-    Timecop.freeze do
-      coerced = aggregator.coerce_to_proto([
-                                             CONFIG_1,
-                                             DESIRED_VALUE,
-                                             Prefab::Context.new(CONTEXT)
-                                           ])
-
-      assert_equal PrefabProto::EvaluatedConfig.new(
-        key: CONFIG_1.key,
-        config_version: CONFIG_1.id,
-        result: DESIRED_VALUE,
-        context: PrefabProto::ContextSet.new(
-          contexts: [
-            PrefabProto::Context.new(
-              type: "user",
-              values: {
-                "id" => PrefabProto::ConfigValue.new(int: 1),
-                "email_suffix" => PrefabProto::ConfigValue.new(string: "hotmail.com")
-              }
-            ),
-            PrefabProto::Context.new(
-              type: "team",
-              values: {
-                "id" => PrefabProto::ConfigValue.new(int: 2),
-                "name" => PrefabProto::ConfigValue.new(string: "team-name")
-              }
-            ),
-            PrefabProto::Context.new(
-              type: "prefab",
-              values: {
-                "current-time" => PrefabProto::ConfigValue.new(int: Prefab::TimeHelpers.now_in_ms),
-              }
-            ),
-          ]
-        ),
-        timestamp: Prefab::TimeHelpers.now_in_ms
-      ), coerced
-    end
-  end
-
-  def test_sync
-    client = new_client(namespace: 'this.is.a.namespace')
-
-    inject_config(client, CONFIG_1)
-    inject_config(client, CONFIG_2)
-    inject_project_env_id(client, PROJECT_ENV_ID)
-
-    client.get CONFIG_1.key, 'default', CONTEXT
-    client.get CONFIG_1.key, 'default', { user: { email_suffix: "example.com" }, device: { mobile: true } }
-    client.get CONFIG_2.key, 'default', CONTEXT
-
-    # logger items are not reported
-    client.get "#{Prefab::ConfigClient::LOGGING_KEY_PREFIX}something", 'default', CONTEXT
-    client.get "#{Prefab::LoggerClient::BASE_KEY}", 'default', CONTEXT
-
-    requests = wait_for_post_requests(client) do
-      client.evaluated_configs_aggregator.send(:sync)
-    end
-
-    assert_equal [[
-      '/api/v1/evaluated-configs',
-      PrefabProto::EvaluatedConfigs.new(
-        configs: [
-          PrefabProto::EvaluatedConfig.new(
-            key: CONFIG_1.key,
-            config_version: CONFIG_1.id,
-            result: DESIRED_VALUE,
-            context: PrefabProto::ContextSet.new(
-              contexts: [
-                PrefabProto::Context.new(
-                  type: "user",
-                  values: {
-                    "id" => PrefabProto::ConfigValue.new(int: 1),
-                    "email_suffix" => PrefabProto::ConfigValue.new(string: "hotmail.com")
-                  }
-                ),
-                PrefabProto::Context.new(
-                  type: "team",
-                  values: {
-                    "id" => PrefabProto::ConfigValue.new(int: 2),
-                    "name" => PrefabProto::ConfigValue.new(string: "team-name")
-                  }
-                ),
-                PrefabProto::Context.new(
-                  type: "prefab",
-                  values: {
-                    "current-time" => PrefabProto::ConfigValue.new(int: Prefab::TimeHelpers.now_in_ms),
-                    "namespace" => PrefabProto::ConfigValue.new(string: "this.is.a.namespace"),
-                  }
-                ),
-              ]
-            ),
-            timestamp: Prefab::TimeHelpers.now_in_ms
-          ),
-          PrefabProto::EvaluatedConfig.new(
-            key: CONFIG_1.key,
-            config_version: CONFIG_1.id,
-            result: DEFAULT_VALUE,
-            context: PrefabProto::ContextSet.new(
-              contexts: [
-                PrefabProto::Context.new(
-                  type: "user",
-                  values: {
-                    "email_suffix" => PrefabProto::ConfigValue.new(string: "example.com")
-                  }
-                ),
-                PrefabProto::Context.new(
-                  type: "device",
-                  values: {
-                    "mobile" => PrefabProto::ConfigValue.new(bool: true),
-                  }
-                ),
-                PrefabProto::Context.new(
-                  type: "prefab",
-                  values: {
-                    "current-time" => PrefabProto::ConfigValue.new(int: Prefab::TimeHelpers.now_in_ms),
-                    "namespace" => PrefabProto::ConfigValue.new(string: "this.is.a.namespace"),
-                  }
-                )
-
-              ]
-            ),
-            timestamp: Prefab::TimeHelpers.now_in_ms
-          ),
-
-          PrefabProto::EvaluatedConfig.new(
-            key: CONFIG_2.key,
-            config_version: CONFIG_2.id,
-            result: DEFAULT_VALUE,
-            context: PrefabProto::ContextSet.new(
-              contexts: [
-                PrefabProto::Context.new(
-                  type: "user",
-                  values: {
-                    "id" => PrefabProto::ConfigValue.new(int: 1),
-                    "email_suffix" => PrefabProto::ConfigValue.new(string: "hotmail.com")
-                  }
-                ),
-                PrefabProto::Context.new(
-                  type: "team",
-                  values: {
-                    "id" => PrefabProto::ConfigValue.new(int: 2),
-                    "name" => PrefabProto::ConfigValue.new(string: "team-name")
-                  }
-                ),
-                PrefabProto::Context.new(
-                  type: "prefab",
-                  values: {
-                    "current-time" => PrefabProto::ConfigValue.new(int: Prefab::TimeHelpers.now_in_ms),
-                    "namespace" => PrefabProto::ConfigValue.new(string: "this.is.a.namespace"),
-                  }
-                )
-              ]
-            ),
-            timestamp: Prefab::TimeHelpers.now_in_ms
-          )
-
-        ]
-      )
-    ]], requests
-  end
-
-  private
-
-  def new_client(overrides = {})
-    super(**{
-      prefab_datasources: Prefab::Options::DATASOURCES::ALL,
-      initialization_timeout_sec: 0,
-      on_init_failure: Prefab::Options::ON_INITIALIZATION_FAILURE::RETURN,
-      api_key: '123-development-yourapikey-SDK',
-      collect_sync_interval: 1000, # we'll trigger sync manually in our test
-      collect_evaluations: true
-    }.merge(overrides))
-  end
-
-  DEFAULT_VALUE = PrefabProto::ConfigValue.new(string: '❌')
-
-  DESIRED_VALUE = PrefabProto::ConfigValue.new(string: "✅")
-
-  DEFAULT_ROW = PrefabProto::ConfigRow.new(
-    values: [
-      PrefabProto::ConditionalValue.new(
-        value: DEFAULT_VALUE
-      )
-    ]
-  )
-
-  PROJECT_ENV_ID = 1
-
-  CONFIG_1 = PrefabProto::Config.new(
-    id: 1,
-    key: "key.1",
-    rows: [
-      PrefabProto::ConfigRow.new(
-        project_env_id: PROJECT_ENV_ID,
-        values: [
-          PrefabProto::ConditionalValue.new(
-            criteria: [
-              PrefabProto::Criterion.new(
-                operator: PrefabProto::Criterion::CriterionOperator::PROP_IS_ONE_OF,
-                value_to_match: string_list(['hotmail.com', 'gmail.com']),
-                property_name: 'user.email_suffix'
-              )
-            ],
-            value: DESIRED_VALUE
-          )
-        ]
-      ),
-      DEFAULT_ROW
-    ]
-  )
-
-  CONFIG_2 = PrefabProto::Config.new(
-    id: 2,
-    key: "key.2",
-    rows: [DEFAULT_ROW,]
-  )
-
-  CONTEXT = {
-    user: {
-      id: 1,
-      email_suffix: 'hotmail.com'
-    },
-    team: {
-      id: 2,
-      name: 'team-name'
-    }
-  }
-end

data/test/test_evaluated_keys_aggregator.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-class TestEvaluatedKeysAggregator < Minitest::Test
-  MAX_WAIT = 2
-  SLEEP_TIME = 0.01
-
-  def test_push
-    aggregator = Prefab::EvaluatedKeysAggregator.new(client: new_client, max_keys: 2, sync_interval: 1000)
-
-    aggregator.push('key.1')
-    aggregator.push('key.2')
-
-    assert_equal 2, aggregator.data.size
-
-    # we've reached the limit, so no more
-    aggregator.push('key.3')
-    assert_equal 2, aggregator.data.size
-  end
-
-  def test_sync
-    client = new_client(namespace: 'this.is.a.namespace')
-
-    client.get 'key.1', 'default', {}
-    client.get 'key.1', 'default', {}
-    client.get 'key.2', 'default', {}
-
-    requests = wait_for_post_requests(client) do
-      client.evaluated_keys_aggregator.send(:sync)
-    end
-
-    assert_equal [[
-      '/api/v1/evaluated-keys',
-      PrefabProto::EvaluatedKeys.new(
-        keys: ['key.1', 'key.2'],
-        namespace: 'this.is.a.namespace'
-      )
-    ]], requests
-  end
-
-  private
-
-  def new_client(overrides = {})
-    super(**{
-      prefab_datasources: Prefab::Options::DATASOURCES::ALL,
-      initialization_timeout_sec: 0,
-      on_init_failure: Prefab::Options::ON_INITIALIZATION_FAILURE::RETURN,
-      api_key: '123-development-yourapikey-SDK',
-      collect_sync_interval: 1000, # we'll trigger sync manually in our test
-      collect_keys: true
-    }.merge(overrides))
-  end
-end