prefab-cloud-ruby 1.7.2 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90c54906938e69580ab5b2aad4407560268e01d90ed4f2d3f595c51a1a308b9a
-  data.tar.gz: 632d29a45418a731cf6bb536dacc32aadcc2f8559326f8b195069250a71ac4ff
+  metadata.gz: b8b27e64dfd37c521a1d0397cbfa40d0f3c1ce5d1f42e339b116cfb4da7c9f58
+  data.tar.gz: 9b4f432823d5653b73cd6f33ccf0a6630f0d69d6ba7ea6e9155254ca3da3e26e
 SHA512:
-  metadata.gz: 1921b09367845ee76bd84604f002bffc735139c3765417053ab8e5b73f059a1e909dec105249e38933f0dcf1f1d2bab9374c33c7703c79952da3617a22108817
-  data.tar.gz: acfdbd82dbef635e9e3703ed3d3b9111d5a47e5382465406cd688b80c1104e6479fcb80ef2dc243be0fc9f6c8d3b2ab265a1541345ca7017e92dbbff6b7511ca
+  metadata.gz: df2e756faf5af90410e442d87d861ee5d6507fb9dd681201bb2c56418f8ddc662cb87d100dde617a501c563a04452d8f712e56ea784a94bc2a67c380a992dfc5
+  data.tar.gz: 2883ed43fb3c579d60efed468c7011ac6a76eb40e2f58737b5f8a7525c337ee5cbbbdbc0b5e3cad160e15c0c13c62ae22cdf1bd14827515f58347e5f13b4aa3b

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.8.1 - 2024-09-03
+
+- Fix SSE reconnection bug (#197)
+
+## 1.8.0 - 2024-08-22
+
+- Load config from belt and failover to suspenders (#195)
+
 ## 1.7.2 - 2024-06-24
 
 - Support JSON config values (#194)

data/Gemfile.lock

@@ -101,7 +101,7 @@ GEM
       rake (~> 13.0)
     macaddr (1.7.2)
       systemu (~> 2.6.5)
-    mini_portile2 (2.8.5)
+    mini_portile2 (2.8.7)
     minitest (5.22.3)
     minitest-focus (1.4.0)
       minitest (>= 4, < 6)
@@ -114,7 +114,7 @@ GEM
     multi_xml (0.6.0)
     multipart-post (2.4.0)
     mutex_m (0.2.0)
-    nokogiri (1.16.3)
+    nokogiri (1.16.7)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     oauth2 (1.4.11)
@@ -126,7 +126,7 @@ GEM
     psych (5.1.2)
       stringio
     public_suffix (5.0.4)
-    racc (1.7.3)
+    racc (1.8.1)
     rack (3.0.10)
     rake (13.1.0)
     rchardet (1.8.0)

data/VERSION

@@ -1 +1 @@
-1.7.2
+1.8.1

data/dev/console

@@ -17,5 +17,11 @@ spec.require_paths.each do |path|
   require "./lib/prefab-cloud-ruby"
 end
 
+SemanticLogger.add_appender(io: $stdout)
+
+if !ENV['PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL']
+  puts "run with PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL=debug (or trace) for more output"
+end
+
 # Start an IRB session
 IRB.start(__FILE__)

data/lib/prefab/client.rb

@@ -8,7 +8,7 @@ module Prefab
     MAX_SLEEP_SEC = 10
     BASE_SLEEP_SEC = 0.5
 
-    attr_reader :namespace, :interceptor, :api_key, :prefab_api_url, :options, :instance_hash
+    attr_reader :namespace, :interceptor, :api_key, :options, :instance_hash
 
     def initialize(options = Prefab::Options.new)
       @options = options.is_a?(Prefab::Options) ? options : Prefab::Options.new(options)
@@ -23,9 +23,6 @@ module Prefab
       else
         @api_key = @options.api_key
         raise Prefab::Errors::InvalidApiKeyError, @api_key if @api_key.nil? || @api_key.empty? || api_key.count('-') < 1
-
-        @prefab_api_url = @options.prefab_api_url
-        LOG.debug "Prefab Connecting to: #{@prefab_api_url}"
       end
 
       context.clear
@@ -48,6 +45,10 @@ module Prefab
       @config_client ||= Prefab::ConfigClient.new(self, timeout)
     end
 
+    def stop
+      @config_client.stop
+    end
+
     def feature_flag_client
       @feature_flag_client ||= Prefab::FeatureFlagClient.new(self)
     end
@@ -111,7 +112,7 @@ module Prefab
     end
 
     def post(path, body)
-      Prefab::HttpConnection.new(@options.prefab_api_url, @api_key).post(path, body)
+      Prefab::HttpConnection.new(@options.telemetry_destination, @api_key).post(path, body)
     end
 
     def inspect

data/lib/prefab/config_client.rb

@@ -3,19 +3,15 @@
 module Prefab
   class ConfigClient
     LOG = Prefab::InternalLogger.new(self)
-    RECONNECT_WAIT = 5
     DEFAULT_CHECKPOINT_FREQ_SEC = 60
-    SSE_READ_TIMEOUT = 300
     STALE_CACHE_WARN_HOURS = 5
-    AUTH_USER = 'authuser'
+
     def initialize(base_client, timeout)
       @base_client = base_client
       @options = base_client.options
       LOG.debug 'Initialize ConfigClient'
       @timeout = timeout
 
-      @stream_lock = Concurrent::ReadWriteLock.new
-
       @checkpoint_freq_secs = DEFAULT_CHECKPOINT_FREQ_SEC
 
       @config_loader = Prefab::ConfigLoader.new(@base_client)
@@ -34,9 +30,27 @@ module Prefab
       end
     end
 
+    def stop
+      @sse_config_client&.close
+    end
+
     def start_streaming
-      @stream_lock.with_write_lock do
-        start_sse_streaming_connection_thread(@config_loader.highwater_mark) if @streaming_thread.nil?
+      Thread.new do
+        # wait for the config loader to have a highwater mark before we connect the SSE
+        loop do
+          break if @config_loader.highwater_mark > 0
+
+          sleep 0.1
+        end
+
+        stream_lock = Concurrent::ReadWriteLock.new
+        @sse_config_client = Prefab::SSEConfigClient.new(@options, @config_loader)
+
+        @sse_config_client.start do |configs|
+          stream_lock.with_write_lock do
+            load_configs(configs, :sse)
+          end
+        end
       end
     end
 
@@ -104,29 +118,24 @@ module Prefab
     end
 
     def load_checkpoint
-      success = load_checkpoint_api_cdn
-
-      return if success
-
-      success = load_checkpoint_api
-
+      success = load_source_checkpoint
       return if success
 
       success = load_cache
-
       return if success
 
       LOG.warn 'No success loading checkpoints'
     end
 
-    def load_checkpoint_api_cdn
-      conn = Prefab::HttpConnection.new("#{@options.url_for_api_cdn}/api/v1/configs/0", @base_client.api_key)
-      load_url(conn, :remote_cdn_api)
-    end
+    def load_source_checkpoint
+      @options.config_sources.each do |source|
+        conn = Prefab::HttpConnection.new("#{source}/api/v1/configs/0", @base_client.api_key)
+        result = load_url(conn, :remote_api)
 
-    def load_checkpoint_api
-      conn = Prefab::HttpConnection.new("#{@options.prefab_api_url}/api/v1/configs/0", @base_client.api_key)
-      load_url(conn, :remote_api)
+        return true if result
+      end
+
+      return false
     end
 
     def load_url(conn, source)
@@ -263,26 +272,5 @@ module Prefab
       LOG.info presenter.to_s
       LOG.debug to_s
     end
-
-    def start_sse_streaming_connection_thread(start_at_id)
-      auth = "#{AUTH_USER}:#{@base_client.api_key}"
-      auth_string = Base64.strict_encode64(auth)
-      headers = {
-        'x-prefab-start-at-id' => start_at_id,
-        'Authorization' => "Basic #{auth_string}",
-        'X-PrefabCloud-Client-Version' => "prefab-cloud-ruby-#{Prefab::VERSION}"
-      }
-      url = "#{@base_client.prefab_api_url}/api/v1/sse/config"
-      LOG.debug "SSE Streaming Connect to #{url} start_at #{start_at_id}"
-      @streaming_thread = SSE::Client.new(url,
-                                          headers: headers,
-                                          read_timeout: SSE_READ_TIMEOUT,
-                                          logger: Prefab::InternalLogger.new(SSE::Client)) do |client|
-        client.on_event do |event|
-          configs = PrefabProto::Configs.decode(Base64.decode64(event.data))
-          load_configs(configs, :sse)
-        end
-      end
-    end
   end
 end

data/lib/prefab/context_shape_aggregator.rb

@@ -46,16 +46,22 @@ module Prefab
       pool.post do
         LOG.debug "Uploading context shapes for #{to_ship.values.size}"
 
-        shapes = PrefabProto::ContextShapes.new(
-          shapes: to_ship.map do |name, shape|
-            PrefabProto::ContextShape.new(
-              name: name,
-              field_types: shape
-            )
-          end
+        events = PrefabProto::TelemetryEvents.new(
+          instance_hash: instance_hash,
+          events: [
+            PrefabProto::TelemetryEvent.new(context_shapes:
+              PrefabProto::ContextShapes.new(
+                shapes: to_ship.map do |name, shape|
+                  PrefabProto::ContextShape.new(
+                    name: name,
+                    field_types: shape
+                  )
+                end
+              ))
+          ]
         )
 
-        result = post('/api/v1/context-shapes', shapes)
+        result = post('/api/v1/telemetry', events)
 
         LOG.debug "Uploaded #{to_ship.values.size} shapes: #{result.status}"
       end

data/lib/prefab/criteria_evaluator.rb

@@ -45,11 +45,13 @@ module Prefab
     end
 
     def PROP_IS_ONE_OF(criterion, properties)
-      matches?(criterion, value_from_properties(criterion, properties), properties)
+      Array(value_from_properties(criterion, properties)).any? do |prop|
+        matches?(criterion, prop, properties)
+      end
     end
 
     def PROP_IS_NOT_ONE_OF(criterion, properties)
-      !matches?(criterion, value_from_properties(criterion, properties), properties)
+      !PROP_IS_ONE_OF(criterion, properties)
     end
 
     def PROP_ENDS_WITH_ONE_OF(criterion, properties)
@@ -57,7 +59,7 @@ module Prefab
     end
 
     def PROP_DOES_NOT_END_WITH_ONE_OF(criterion, properties)
-      !prop_ends_with_one_of?(criterion, value_from_properties(criterion, properties))
+      !PROP_ENDS_WITH_ONE_OF(criterion, properties)
     end
 
     def HIERARCHICAL_MATCH(criterion, properties)

data/lib/prefab/internal_logger.rb

@@ -2,7 +2,8 @@ module Prefab
   class InternalLogger < SemanticLogger::Logger
 
     def initialize(klass)
-      super(klass, :warn)
+      default_level = ENV['PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL'] ? ENV['PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL'].downcase.to_sym : :warn
+      super(klass, default_level)
       instances << self
     end
 

data/lib/prefab/log_path_aggregator.rb

@@ -51,15 +51,16 @@ module Prefab
           aggregate[path]['logger_name'] = path
         end
 
-        loggers = PrefabProto::Loggers.new(
-          loggers: aggregate.values,
-          start_at: start_at_was,
-          end_at: Prefab::TimeHelpers.now_in_ms,
-          instance_hash: @client.instance_hash,
-          namespace: @client.namespace
+        loggers = PrefabProto::LoggersTelemetryEvent.new(loggers: aggregate.values,
+                                                         start_at: start_at_was,
+                                                         end_at: Prefab::TimeHelpers.now_in_ms)
+
+        events = PrefabProto::TelemetryEvents.new(
+          instance_hash: instance_hash,
+          events: [PrefabProto::TelemetryEvent.new(loggers: loggers)]
         )
 
-        result = post('/api/v1/known-loggers', loggers)
+        result = post('/api/v1/telemetry', events)
 
         LOG.debug "Uploaded #{to_ship.size} paths: #{result.status}"
       end

data/lib/prefab/options.rb

@@ -5,7 +5,10 @@ module Prefab
   class Options
     attr_reader :api_key
     attr_reader :namespace
-    attr_reader :prefab_api_url
+    attr_reader :sources
+    attr_reader :sse_sources
+    attr_reader :telemetry_destination
+    attr_reader :config_sources
     attr_reader :on_no_default
     attr_reader :initialization_timeout_sec
     attr_reader :on_init_failure
@@ -38,10 +41,16 @@ module Prefab
     DEFAULT_MAX_EXAMPLE_CONTEXTS = 100_000
     DEFAULT_MAX_EVAL_SUMMARIES = 100_000
 
+    DEFAULT_SOURCES = [
+      "https://belt.prefab.cloud",
+      "https://suspenders.prefab.cloud",
+    ].freeze
+
     private def init(
+      sources: nil,
       api_key: ENV['PREFAB_API_KEY'],
       namespace: '',
-      prefab_api_url: ENV['PREFAB_API_URL'] || 'https://api.prefab.cloud',
+      prefab_api_url: nil,
       on_no_default: ON_NO_DEFAULT::RAISE, # options :raise, :warn_and_return_nil,
       initialization_timeout_sec: 10, # how long to wait before on_init_failure
       on_init_failure: ON_INITIALIZATION_FAILURE::RAISE,
@@ -63,7 +72,6 @@ module Prefab
     )
       @api_key = api_key
       @namespace = namespace
-      @prefab_api_url = remove_trailing_slash(prefab_api_url)
       @on_no_default = on_no_default
       @initialization_timeout_sec = initialization_timeout_sec
       @on_init_failure = on_init_failure
@@ -88,6 +96,25 @@ module Prefab
       @collect_example_contexts = false
       @collect_max_example_contexts = 0
 
+      if ENV['PREFAB_API_URL_OVERRIDE'] && ENV['PREFAB_API_URL_OVERRIDE'].length > 0
+        sources = ENV['PREFAB_API_URL_OVERRIDE']
+      end
+
+      @sources = Array(sources || DEFAULT_SOURCES).map {|source| remove_trailing_slash(source) }
+
+      @sse_sources = @sources
+      @config_sources = @sources
+
+      @telemetry_destination = @sources.select do |source|
+        source.start_with?('https://') && (source.include?("belt") || source.include?("suspenders"))
+      end.map do |source|
+        source.sub(/(belt|suspenders)\./, 'telemetry.')
+      end[0]
+
+      if prefab_api_url
+        warn '[DEPRECATION] prefab_api_url is deprecated. Please provide `sources` if you need to override the default sources'
+      end
+
       case context_upload_mode
       when :none
         # do nothing
@@ -140,11 +167,6 @@ module Prefab
       @collect_max_evaluation_summaries
     end
 
-    # https://api.prefab.cloud -> https://api-prefab-cloud.global.ssl.fastly.net
-    def url_for_api_cdn
-      ENV['PREFAB_CDN_URL'] || "#{@prefab_api_url.gsub(/\./, '-')}.global.ssl.fastly.net"
-    end
-
     def api_key_id
       @api_key&.split("-")&.first
     end

data/lib/prefab/periodic_sync.rb

@@ -32,6 +32,10 @@ module Prefab
       @client.post(url, data)
     end
 
+    def instance_hash
+      @client.instance_hash
+    end
+
     def start_periodic_sync(sync_interval)
       @start_at = Prefab::TimeHelpers.now_in_ms
 

data/lib/prefab/sse_config_client.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Prefab
+  class SSEConfigClient
+    SSE_READ_TIMEOUT = 300
+    SECONDS_BETWEEN_RECONNECT = 5
+    AUTH_USER = 'authuser'
+    LOG = Prefab::InternalLogger.new(self)
+
+    def initialize(options, config_loader)
+      @options = options
+      @config_loader = config_loader
+      @connected = false
+    end
+
+    def close
+      @retry_thread&.kill
+      @client&.close
+    end
+
+    def start(&load_configs)
+      if @options.sse_sources.empty?
+        LOG.debug 'No SSE sources configured'
+        return
+      end
+
+      @client = connect(&load_configs)
+
+      closed_count = 0
+
+      @retry_thread = Thread.new do
+        loop do
+          sleep 1
+
+          if @client.closed?
+            closed_count += 1
+
+            if closed_count > SECONDS_BETWEEN_RECONNECT
+              closed_count = 0
+              @client = connect(&load_configs)
+            end
+          end
+        end
+      end
+    end
+
+    def connect(&load_configs)
+      url = "#{source}/api/v1/sse/config"
+      LOG.debug "SSE Streaming Connect to #{url} start_at #{@config_loader.highwater_mark}"
+
+      SSE::Client.new(url,
+                      headers: headers,
+                      read_timeout: SSE_READ_TIMEOUT,
+                      logger: Prefab::InternalLogger.new(SSE::Client)) do |client|
+        client.on_event do |event|
+          configs = PrefabProto::Configs.decode(Base64.decode64(event.data))
+          load_configs.call(configs, :sse)
+        end
+
+        client.on_error do |error|
+          LOG.error "SSE Streaming Error: #{error.inspect} for url #{url}"
+
+          if error.is_a?(HTTP::ConnectionError)
+            LOG.debug "Closing SSE connection for url #{url}"
+            client.close
+          end
+        end
+      end
+    end
+
+    def headers
+      auth = "#{AUTH_USER}:#{@options.api_key}"
+      auth_string = Base64.strict_encode64(auth)
+      return {
+        'x-prefab-start-at-id' => @config_loader.highwater_mark,
+        'Authorization' => "Basic #{auth_string}",
+        'Accept' => 'text/event-stream',
+        'X-PrefabCloud-Client-Version' => "prefab-cloud-ruby-#{Prefab::VERSION}"
+      }
+    end
+
+    def source
+      @source_index = @source_index.nil? ? 0 : @source_index + 1
+
+      if @source_index >= @options.sse_sources.size
+        @source_index = 0
+      end
+
+      return @options.sse_sources[@source_index]
+    end
+  end
+end

data/lib/prefab-cloud-ruby.rb

@@ -46,6 +46,7 @@ require 'prefab/context'
 require 'prefab/logger_client'
 require 'active_support/deprecation'
 require 'active_support'
+require 'prefab/sse_config_client'
 require 'prefab/client'
 require 'prefab/config_client_presenter'
 require 'prefab/config_client'

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.7.2 ruby lib
+# stub: prefab-cloud-ruby 1.8.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "prefab-cloud-ruby".freeze
-  s.version = "1.7.2"
+  s.version = "1.8.1"
 
   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-06-24"
+  s.date = "2024-09-03"
   s.description = "Feature Flags, Live Config, and Dynamic Log Levels as a service".freeze
   s.email = "jdwyer@prefab.cloud".freeze
   s.extra_rdoc_files = [
@@ -74,6 +74,7 @@ Gem::Specification.new do |s|
     "lib/prefab/prefab.rb",
     "lib/prefab/rate_limit_cache.rb",
     "lib/prefab/resolved_config_presenter.rb",
+    "lib/prefab/sse_config_client.rb",
     "lib/prefab/time_helpers.rb",
     "lib/prefab/weighted_value_resolver.rb",
     "lib/prefab/yaml_config_parser.rb",
@@ -113,6 +114,7 @@ Gem::Specification.new do |s|
     "test/test_options.rb",
     "test/test_prefab.rb",
     "test/test_rate_limit_cache.rb",
+    "test/test_sse_config_client.rb",
     "test/test_weighted_value_resolver.rb"
   ]
   s.homepage = "http://github.com/prefab-cloud/prefab-cloud-ruby".freeze

data/test/integration_test.rb

@@ -20,6 +20,10 @@ class IntegrationTest
     @test_client = capture_telemetry(base_client)
   end
 
+  def teardown
+    test_client.stop
+  end
+
   def test_type
     if @data
       :telemetry
@@ -53,7 +57,11 @@ class IntegrationTest
   def parse_client_overrides(overrides)
     Hash[
       (overrides || {}).map do |(k, v)|
-        [k.to_sym, v]
+        if k.to_s == "prefab_api_url"
+          [:sources, [v]]
+        else
+          [k.to_sym, v]
+        end
       end
     ]
   end
@@ -127,17 +135,22 @@ class IntegrationTest
       prefab_envs: ['unit_tests'],
       prefab_datasources: Prefab::Options::DATASOURCES::ALL,
       api_key: ENV['PREFAB_INTEGRATION_TEST_API_KEY'],
-      prefab_api_url: 'https://api.staging-prefab.cloud',
+      sources: [
+        'https://belt.staging-prefab.cloud',
+        'https://suspenders.staging-prefab.cloud',
+      ],
       global_context: @global_context || {},
     }.merge(@client_overrides))
   end
 
   def capture_telemetry(client)
+    super_method = client.method(:post)
+
     client.define_singleton_method(:post) do |url, data|
       client.instance_variable_set(:@last_data_sent, data)
       client.instance_variable_set(:@last_post_endpoint, url)
 
-      result = super(url, data)
+      result = super_method.call(url, data)
 
       client.instance_variable_set(:@last_post_result, result)
 

data/test/integration_test_helpers.rb

@@ -2,16 +2,12 @@
 
 module IntegrationTestHelpers
   SUBMODULE_PATH = 'test/prefab-cloud-integration-test-data'
-  RAISE_IF_NO_TESTS_FOUND = ENV['PREFAB_INTEGRATION_TEST_RAISE'] == 'true'
 
   def self.find_integration_tests
     files = find_test_files
 
     if files.none?
-      message = "No integration tests found"
-      raise message if RAISE_IF_NO_TESTS_FOUND
-
-      puts message
+      raise "No integration tests found"
     end
 
     files
@@ -44,7 +40,7 @@ module IntegrationTestHelpers
         end
       end
 
-      [aggregator, ->(data) { data.loggers }, expected_loggers.values]
+      [aggregator, ->(data) { data.events[0].loggers.loggers }, expected_loggers.values]
     when "context_shape"
       aggregator = it.test_client.context_shape_aggregator
 
@@ -59,7 +55,7 @@ module IntegrationTestHelpers
         )
       end
 
-      [aggregator, ->(data) { data.shapes }, expected]
+      [aggregator, ->(data) { data.events[0].context_shapes.shapes }, expected]
     when "evaluation_summary"
       aggregator = it.test_client.evaluation_summary_aggregator
 

data/test/support/common_helpers.rb

@@ -47,11 +47,14 @@ module CommonHelpers
     ENV[key] = old_value
   end
 
+  EFFECTIVELY_NEVER = 99_999 # we sync manually
+
   DEFAULT_NEW_CLIENT_OPTIONS = {
     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,
+    collect_sync_interval: EFFECTIVELY_NEVER,
   }.freeze
 
   def new_client(overrides = {})

data/test/test_context_shape_aggregator.rb

@@ -98,30 +98,36 @@ class TestContextShapeAggregator < Minitest::Test
 
     assert_equal [
       [
-        '/api/v1/context-shapes',
-        PrefabProto::ContextShapes.new(shapes: [
-                                         PrefabProto::ContextShape.new(
-                                           name: 'user', field_types: {
-                                             'age' => 4, 'dob' => 2, 'email' => 2, 'name' => 2
-                                           }
-                                         ),
-                                         PrefabProto::ContextShape.new(
-                                           name: 'subscription', field_types: {
-                                             'plan' => 2, 'free' => 5, 'trial' => 5
-                                           }
-                                         ),
-                                         PrefabProto::ContextShape.new(
-                                           name: 'device', field_types: {
-                                             'version' => 1, 'os' => 2, 'name' => 2
-                                           }
-                                         )
-                                       ])
+        '/api/v1/telemetry',
+        PrefabProto::TelemetryEvents.new(
+          instance_hash: client.instance_hash,
+          events: [
+            PrefabProto::TelemetryEvent.new(context_shapes:
+
+            PrefabProto::ContextShapes.new(shapes: [
+                                             PrefabProto::ContextShape.new(
+                                               name: 'user', field_types: {
+                                                 'age' => 4, 'dob' => 2, 'email' => 2, 'name' => 2
+                                               }
+                                             ),
+                                             PrefabProto::ContextShape.new(
+                                               name: 'subscription', field_types: {
+                                                 'plan' => 2, 'free' => 5, 'trial' => 5
+                                               }
+                                             ),
+                                             PrefabProto::ContextShape.new(
+                                               name: 'device', field_types: {
+                                                 'version' => 1, 'os' => 2, 'name' => 2
+                                               }
+                                             )
+                                           ]))
+          ]
+        )
       ]
     ], requests
 
-
     assert_logged [
-      "No success loading checkpoints",
+      'No success loading checkpoints',
       "Couldn't Initialize In 0. Key some.key. Returning what we have"
     ]
   end

data/test/test_example_contexts_aggregator.rb

@@ -4,8 +4,6 @@ require 'test_helper'
 require 'timecop'
 
 class TestExampleContextsAggregator < Minitest::Test
-  EFFECTIVELY_NEVER = 99_999 # we sync manually
-
   def test_record
     aggregator = Prefab::ExampleContextsAggregator.new(client: MockBaseClient.new, max_contexts: 2,
                                                        sync_interval: EFFECTIVELY_NEVER)

data/test/test_integration.rb

@@ -8,10 +8,19 @@ require 'yaml'
 class TestIntegration < Minitest::Test
   IntegrationTestHelpers.find_integration_tests.map do |test_file|
     tests = YAML.load(File.read(test_file))['tests']
+    test_names = []
 
     tests.each do |test|
       test['cases'].each do |test_case|
-        define_method(:"test_#{test['name']}_#{test_case['name']}") do
+        new_name = "test_#{test['name']}_#{test_case['name']}"
+
+        if test_names.include?(new_name)
+          raise "Duplicate test name: #{new_name}"
+        end
+
+        test_names << new_name
+
+        define_method(:"#{new_name}") do
           it = IntegrationTest.new(test_case)
 
           IntegrationTestHelpers.with_block_context_maybe(it.block_context) do
@@ -38,7 +47,7 @@ class TestIntegration < Minitest::Test
 
               wait_for -> { it.last_post_result&.status == 200 }
 
-              assert it.endpoint == it.last_post_endpoint
+              assert_equal "/api/v1/telemetry", it.last_post_endpoint
 
               actual = get_actual_data[it.last_data_sent]
 
@@ -56,6 +65,8 @@ class TestIntegration < Minitest::Test
                 "Prefab::ConfigClient -- Couldn't Initialize In 0.01. Key any-key. Returning what we have"
               ]
             end
+          ensure
+            it.teardown
           end
         end
       end

data/test/test_log_path_aggregator.rb

@@ -32,15 +32,27 @@ class TestLogPathAggregator < Minitest::Test
         client.log_path_aggregator.send(:sync)
       end
 
-      assert_equal '/api/v1/known-loggers', requests[0][0]
-      sent_logger = requests[0][1]
-      assert_equal 'this.is.a.namespace', sent_logger.namespace
-      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_equal [
+        [
+          '/api/v1/telemetry',
+          PrefabProto::TelemetryEvents.new(
+            instance_hash: client.instance_hash,
+            events: [
+              PrefabProto::TelemetryEvent.new(loggers:
+
+              PrefabProto::LoggersTelemetryEvent.new(loggers: [
+                                                       PrefabProto::Logger.new(
+                                                         logger_name: 'test.test_log_path_aggregator.test_sync',
+                                                         infos: 2,
+                                                         errors: 3
+                                                       )
+                                                     ],
+                                                     start_at: Prefab::TimeHelpers.now_in_ms,
+                                                     end_at: Prefab::TimeHelpers.now_in_ms,))
+            ]
+          )
+        ]
+      ], requests
     end
   end
 

data/test/test_options.rb

@@ -5,18 +5,31 @@ 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
+  def test_api_override_env_var
+    assert_equal Prefab::Options::DEFAULT_SOURCES, Prefab::Options.new.sources
 
-    with_env 'PREFAB_API_URL', 'https://api.prefab.cloud' do
-      assert_equal 'https://api.prefab.cloud', Prefab::Options.new.prefab_api_url
+    # blank doesn't take effect
+    with_env('PREFAB_API_URL_OVERRIDE', '') do
+      assert_equal Prefab::Options::DEFAULT_SOURCES, Prefab::Options.new.sources
     end
 
-    with_env 'PREFAB_API_URL', 'https://api.prefab.cloud/' do
-      assert_equal 'https://api.prefab.cloud', Prefab::Options.new.prefab_api_url
+    # non-blank does take effect
+    with_env('PREFAB_API_URL_OVERRIDE', 'https://override.example.com') do
+      assert_equal ["https://override.example.com"], Prefab::Options.new.sources
     end
   end
 
+  def test_overriding_sources
+    assert_equal Prefab::Options::DEFAULT_SOURCES, Prefab::Options.new.sources
+
+    # a plain string ends up wrapped in an array
+    source = 'https://example.com'
+    assert_equal [source], Prefab::Options.new(sources: source).sources
+
+    sources = ['https://example.com', 'https://example2.com']
+    assert_equal sources, Prefab::Options.new(sources: sources).sources
+  end
+
   def test_works_with_named_arguments
     assert_equal API_KEY, Prefab::Options.new(api_key: API_KEY).api_key
   end

data/test/test_sse_config_client.rb

@@ -0,0 +1,65 @@
+require 'test_helper'
+
+class TestSSEConfigClient < Minitest::Test
+  def test_client
+    sources = [
+      "https://api.staging-prefab.cloud/",
+    ]
+
+    options = Prefab::Options.new(sources: sources, api_key: ENV['PREFAB_INTEGRATION_TEST_API_KEY'])
+
+    config_loader = OpenStruct.new(highwater_mark: 4)
+
+    client = Prefab::SSEConfigClient.new(options, config_loader)
+
+    assert_equal 4, client.headers['x-prefab-start-at-id']
+
+    result = nil
+
+    # fake our load_configs block
+    client.start do |c, source|
+      result = c
+      assert_equal :sse, source
+    end
+
+    wait_for -> { !result.nil? }
+
+    assert result.configs.size > 30
+  ensure
+    client.close
+  end
+
+  def test_failing_over
+    sources = [
+      "https://does.not.exist.staging-prefab.cloud/",
+      "https://api.staging-prefab.cloud/",
+    ]
+
+    options = Prefab::Options.new(sources: sources, api_key: ENV['PREFAB_INTEGRATION_TEST_API_KEY'])
+
+    config_loader = OpenStruct.new(highwater_mark: 4)
+
+    client = Prefab::SSEConfigClient.new(options, config_loader)
+
+    assert_equal 4, client.headers['x-prefab-start-at-id']
+
+    result = nil
+
+    # fake our load_configs block
+    client.start do |c, source|
+      result = c
+      assert_equal :sse, source
+    end
+
+    wait_for -> { !result.nil? }, max_wait: 10
+
+    assert result.configs.size > 30
+  ensure
+    client.close
+
+    assert_logged [
+      /failed to connect: .*https:\/\/does.not.exist/,
+      /HTTP::ConnectionError/,
+    ]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prefab-cloud-ruby
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.8.1
 platform: ruby
 authors:
 - Jeff Dwyer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-24 00:00:00.000000000 Z
+date: 2024-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -261,6 +261,7 @@ files:
 - lib/prefab/prefab.rb
 - lib/prefab/rate_limit_cache.rb
 - lib/prefab/resolved_config_presenter.rb
+- lib/prefab/sse_config_client.rb
 - lib/prefab/time_helpers.rb
 - lib/prefab/weighted_value_resolver.rb
 - lib/prefab/yaml_config_parser.rb
@@ -300,6 +301,7 @@ files:
 - test/test_options.rb
 - test/test_prefab.rb
 - test/test_rate_limit_cache.rb
+- test/test_sse_config_client.rb
 - test/test_weighted_value_resolver.rb
 homepage: http://github.com/prefab-cloud/prefab-cloud-ruby
 licenses: