prefab-cloud-ruby 1.8.3 → 1.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddab427174fc8ee9580364b7f55becb58806d98b94968ee3d903ce67e9b01268
-  data.tar.gz: 181cdf62f18a7c9b09846746597273230f6b13100b302ef4531693f0a3d07085
+  metadata.gz: ec8c47fb2fe1945e2d189198fbb2ecb8b2eee9d77537ac6569196659931badf4
+  data.tar.gz: 58afaf18e4541429db3e4204f7bc2c19340028d894b84a75d7195aac39fd6b37
 SHA512:
-  metadata.gz: 784b5d8e0229ec1e953d16a2442561a1cc67e18fc4f398f4878ac4672256892a0d6c314b06b9cd835a8309d184d47a2280d348b8afd396f977c6c57248d7c2b9
-  data.tar.gz: '0865454d8eab0548aff23e3caa338d037babc8d9a49165424e6b8822d6a5f5b5ba67e8395752bebedb9666ff5cd3f1eac46f4d4df66abc1c8f2274770e4d634f'
+  metadata.gz: 7ed0b65787d13a25a301a75481cff40db9b7dc1b036aea75c5e241b0bdddfd26577317b013830c7533ad0da51b7d087c3e59df5d8c38c07382509cfbc8d9eeb1
+  data.tar.gz: c57bb8881f6a61b252013c118240bc64b8ffaa248caafd234747f1897dd3d67aab6b02b72a3c1e8b164feb689590587475fe5d605f13c1ac4b5c0b426e45f137

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.8.4 - 2024-09-19
+
+- Use `stream` subdomain for SSE (#203)
+
 ## 1.8.3 - 2024-09-16
 
 - Add JavaScript stub & bootstrapping (#200)

data/VERSION

@@ -1 +1 @@
-1.8.3
+1.8.4

data/lib/prefab/javascript_stub.rb

@@ -8,16 +8,6 @@ module Prefab
       @client = client || Prefab.instance
     end
 
-    # Generate the JavaScript snippet to bootstrap the client SDK. This will
-    # include the configuration values that are permitted to be sent to the
-    # client SDK.
-    #
-    # If the context provided to the client SDK is not the same as the context
-    # used to generate the configuration values, the client SDK will still
-    # generate a fetch to get the correct values for the context.
-    #
-    # Any keys that could not be resolved will be logged as a warning to the
-    # console.
     def bootstrap(context)
       configs, warnings = data(context)
       <<~JS
@@ -29,24 +19,20 @@ module Prefab
       JS
     end
 
-    # Generate the JavaScript snippet to *replace* the client SDK. Use this to
-    # get `prefab.get` and `prefab.isEnabled` functions on the window object.
-    #
-    # Only use this if you are not using the client SDK and do not need
-    # client-side context.
-    #
-    # Any keys that could not be resolved will be logged as a warning to the
-    # console.
-    def generate_stub(context)
+    def generate_stub(context, callback = nil)
       configs, warnings = data(context)
       <<~JS
         window.prefab = window.prefab || {};
         window.prefab.config = #{JSON.dump(configs)};
         window.prefab.get = function(key) {
-          return window.prefab.config[key];
+          var value = window.prefab.config[key];
+        #{callback && "  #{callback}(key, value);"}
+          return value;
         };
         window.prefab.isEnabled = function(key) {
-          return window.prefab.config[key] === true;
+          var value = window.prefab.config[key] === true;
+        #{callback && "  #{callback}(key, value);"}
+          return value;
         };
         #{log_warnings(warnings)}
       JS
@@ -70,7 +56,7 @@ module Prefab
       return '' if warnings.empty?
 
       <<~JS
-        console.warn('The following keys could not be resolved:', #{JSON.dump(@warnings)});
+        console.warn('The following keys could not be resolved:', #{JSON.dump(warnings)});
       JS
     end
 
@@ -83,7 +69,7 @@ module Prefab
         begin
           config = @client.resolver.raw(key)
 
-          if config.config_type == :FEATURE_FLAG || config.send_to_client_sdk
+          if config.config_type == :FEATURE_FLAG || config.send_to_client_sdk || config.config_type == :LOG_LEVEL
             permitted[key] = underlying_value(@client.resolver.get(key, context).value)
           end
         rescue StandardError => e

data/lib/prefab/prefab.rb

@@ -78,14 +78,40 @@ module Prefab
     @singleton.is_ff?(key)
   end
 
+  # Generate the JavaScript snippet to bootstrap the client SDK. This will
+  # include the configuration values that are permitted to be sent to the
+  # client SDK.
+  #
+  # If the context provided to the client SDK is not the same as the context
+  # used to generate the configuration values, the client SDK will still
+  # generate a fetch to get the correct values for the context.
+  #
+  # Any keys that could not be resolved will be logged as a warning to the
+  # console.
   def self.bootstrap_javascript(context)
     ensure_initialized
     Prefab::JavaScriptStub.new(@singleton).bootstrap(context)
   end
 
-  def self.generate_javascript_stub(context)
+  # Generate the JavaScript snippet to *replace* the client SDK. Use this to
+  # get `prefab.get` and `prefab.isEnabled` functions on the window object.
+  #
+  # Only use this if you are not using the client SDK and do not need
+  # client-side context.
+  #
+  # Any keys that could not be resolved will be logged as a warning to the
+  # console.
+  #
+  # You can pass an optional callback function to be called with the key and
+  # value of each configuration value. This can be useful for logging,
+  # tracking experiment exposure, etc.
+  #
+  # e.g.
+  # - `Prefab.generate_javascript_stub(context, "reportExperimentExposure")`
+  # - `Prefab.generate_javascript_stub(context, "(key,value)=>{console.log({eval: 'eval', key,value})}")`
+  def self.generate_javascript_stub(context, callback = nil)
     ensure_initialized
-    Prefab::JavaScriptStub.new(@singleton).generate_stub(context)
+    Prefab::JavaScriptStub.new(@singleton).generate_stub(context, callback)
   end
 
   private

data/lib/prefab/sse_config_client.rb

@@ -106,7 +106,7 @@ module Prefab
         @source_index = 0
       end
 
-      return @prefab_options.sse_sources[@source_index]
+      return @prefab_options.sse_sources[@source_index].sub(/(belt|suspenders)\./, 'stream.')
     end
   end
 end

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.8.3 ruby lib
+# stub: prefab-cloud-ruby 1.8.4 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "prefab-cloud-ruby".freeze
-  s.version = "1.8.3"
+  s.version = "1.8.4"
 
   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-09-16"
+  s.date = "2024-09-19"
   s.description = "Feature Flags, Live Config, and Dynamic Log Levels as a service".freeze
   s.email = "jdwyer@prefab.cloud".freeze
   s.extra_rdoc_files = [

data/test/test_javascript_stub.rb

@@ -87,7 +87,7 @@ class JavascriptStubTest < Minitest::Test
 
     assert_equal %(
 window._prefabBootstrap = {
-  configs: {"basic-config":"default_value","feature-flag":false},
+  configs: {"log-level":"INFO","basic-config":"default_value","feature-flag":false},
   context: {}
 }
     ).strip, result.strip
@@ -96,7 +96,7 @@ window._prefabBootstrap = {
 
     assert_equal %(
 window._prefabBootstrap = {
-  configs: {"basic-config":"default_value","feature-flag":true},
+  configs: {"log-level":"INFO","basic-config":"default_value","feature-flag":true},
   context: {"user":{"email":"gmail.com"}}
 }
     ).strip, result.strip
@@ -107,25 +107,33 @@ window._prefabBootstrap = {
 
     assert_equal %(
 window.prefab = window.prefab || {};
-window.prefab.config = {"basic-config":"default_value","feature-flag":false};
+window.prefab.config = {"log-level":"INFO","basic-config":"default_value","feature-flag":false};
 window.prefab.get = function(key) {
-  return window.prefab.config[key];
+  var value = window.prefab.config[key];
+
+  return value;
 };
 window.prefab.isEnabled = function(key) {
-  return window.prefab.config[key] === true;
+  var value = window.prefab.config[key] === true;
+
+  return value;
 };
     ).strip, result.strip
 
-    result = Prefab::JavaScriptStub.new(@client).generate_stub({ user: { email: 'gmail.com' } })
+    result = Prefab::JavaScriptStub.new(@client).generate_stub({ user: { email: 'gmail.com' } }, "myEvalCallback")
 
     assert_equal %(
 window.prefab = window.prefab || {};
-window.prefab.config = {"basic-config":"default_value","feature-flag":true};
+window.prefab.config = {"log-level":"INFO","basic-config":"default_value","feature-flag":true};
 window.prefab.get = function(key) {
-  return window.prefab.config[key];
+  var value = window.prefab.config[key];
+  myEvalCallback(key, value);
+  return value;
 };
 window.prefab.isEnabled = function(key) {
-  return window.prefab.config[key] === true;
+  var value = window.prefab.config[key] === true;
+  myEvalCallback(key, value);
+  return value;
 };
 
     ).strip, result.strip

data/test/test_sse_config_client.rb

@@ -6,7 +6,7 @@ require 'webrick'
 class TestSSEConfigClient < Minitest::Test
   def test_client
     sources = [
-      'https://api.staging-prefab.cloud/'
+      'https://belt.staging-prefab.cloud/'
     ]
 
     options = Prefab::Options.new(sources: sources, api_key: ENV.fetch('PREFAB_INTEGRATION_TEST_API_KEY', nil))
@@ -16,6 +16,7 @@ class TestSSEConfigClient < Minitest::Test
     client = Prefab::SSEConfigClient.new(options, config_loader)
 
     assert_equal 4, client.headers['x-prefab-start-at-id']
+    assert_equal "https://stream.staging-prefab.cloud", client.source
 
     result = nil
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prefab-cloud-ruby
 version: !ruby/object:Gem::Version
-  version: 1.8.3
+  version: 1.8.4
 platform: ruby
 authors:
 - Jeff Dwyer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-16 00:00:00.000000000 Z
+date: 2024-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby