prefab-cloud-ruby 1.8.3 → 1.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddab427174fc8ee9580364b7f55becb58806d98b94968ee3d903ce67e9b01268
-  data.tar.gz: 181cdf62f18a7c9b09846746597273230f6b13100b302ef4531693f0a3d07085
+  metadata.gz: 221fd3505c561f550efb45c86fcdf1ea79a7afd442ef6d2c351d9f0ce433c391
+  data.tar.gz: e85a75665a06ed8350e9fe6d44bc5c7462eb1d5d698f2b58a8ae2890472740e2
 SHA512:
-  metadata.gz: 784b5d8e0229ec1e953d16a2442561a1cc67e18fc4f398f4878ac4672256892a0d6c314b06b9cd835a8309d184d47a2280d348b8afd396f977c6c57248d7c2b9
-  data.tar.gz: '0865454d8eab0548aff23e3caa338d037babc8d9a49165424e6b8822d6a5f5b5ba67e8395752bebedb9666ff5cd3f1eac46f4d4df66abc1c8f2274770e4d634f'
+  metadata.gz: 34a83eabd765201e831bc00d6b4472f1b67f6eb9271f5cd77f33de7a55571acbd323f2c6ee2c8df8a3df0602f577a3a30daebe983403d0e61870a14f6bcd7b74
+  data.tar.gz: fc6f2e0616a62dee54415d1290d163a055391afee5ba62f158aad5d19192ebd129507305dd6cda9735bf8b184e9c7e94657f1005384907150a0049c14cc8c6fe

data/.github/workflows/ruby.yml

@@ -25,7 +25,7 @@ jobs:
         ruby-version: ['2.7', '3.0', '3.3']
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         submodules: recursive
     - name: Set up Ruby

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 1.8.5 - 2024-09-27
+
+- Fix JS bootstrapping and improve performance (#206)
+- Promote `datafile` from `x_datafile` (#205)
+
+## 1.8.4 - 2024-09-19
+
+- Use `stream` subdomain for SSE (#203)
+
 ## 1.8.3 - 2024-09-16
 
 - Add JavaScript stub & bootstrapping (#200)

data/Gemfile.lock

@@ -62,7 +62,7 @@ GEM
       faraday (>= 0.8, < 2)
       hashie (~> 3.5, >= 3.5.2)
       oauth2 (~> 1.0)
-    google-protobuf (3.25.3)
+    google-protobuf (3.25.5)
     googleapis-common-protos-types (1.14.0)
       google-protobuf (~> 3.18)
     hashie (3.6.0)
@@ -152,7 +152,7 @@ GEM
       concurrent-ruby (~> 1.0)
     uuid (2.3.9)
       macaddr (~> 1.0)
-    webrick (1.8.1)
+    webrick (1.8.2)
 
 PLATFORMS
   ruby

data/VERSION

@@ -1 +1 @@
-1.8.3
+1.8.5

data/lib/prefab/config_value_unwrapper.rb

@@ -30,7 +30,7 @@ module Prefab
     end
 
     # this will return the actual value of confidential, use reportable_value unless you need it
-    def unwrap
+    def unwrap(raw_json: false)
       raw = case @config_value.type
             when :int, :string, :double, :bool, :log_level
               @config_value.public_send(@config_value.type)
@@ -39,7 +39,11 @@ module Prefab
             when :duration
               Prefab::Duration.new(@config_value.duration.definition)
             when :json
-              JSON.parse(@config_value.json.json)
+              if raw_json
+                @config_value.json.json
+              else
+                JSON.parse(@config_value.json.json)
+              end
             else
               LOG.error "Unknown type: #{@config_value.type}"
               raise "Unknown type: #{@config_value.type}"

data/lib/prefab/javascript_stub.rb

@@ -3,50 +3,37 @@
 module Prefab
   class JavaScriptStub
     LOG = Prefab::InternalLogger.new(self)
+    CAMELS = {}
 
     def initialize(client = nil)
       @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)
+      configs, warnings = data(context, :bootstrap)
       <<~JS
         window._prefabBootstrap = {
-          configs: #{JSON.dump(configs)},
+          evaluations: #{JSON.dump(configs)},
           context: #{JSON.dump(context)}
         }
         #{log_warnings(warnings)}
       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)
-      configs, warnings = data(context)
+    def generate_stub(context, callback = nil)
+      configs, warnings = data(context, :stub)
       <<~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
@@ -55,7 +42,7 @@ module Prefab
     private
 
     def underlying_value(value)
-      v = Prefab::ConfigValueUnwrapper.new(value, @client.resolver).unwrap
+      v = Prefab::ConfigValueUnwrapper.new(value, @client.resolver).unwrap(raw_json: true)
       case v
       when Google::Protobuf::RepeatedField
         v.to_a
@@ -70,11 +57,11 @@ 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
 
-    def data(context)
+    def data(context, mode)
       permitted = {}
       warnings = []
       resolver_keys = @client.resolver.keys
@@ -83,8 +70,13 @@ module Prefab
         begin
           config = @client.resolver.raw(key)
 
-          if config.config_type == :FEATURE_FLAG || config.send_to_client_sdk
-            permitted[key] = underlying_value(@client.resolver.get(key, context).value)
+          if config.config_type == :FEATURE_FLAG || config.send_to_client_sdk || config.config_type == :LOG_LEVEL
+            value = @client.resolver.get(key, context).value
+            if mode == :bootstrap
+              permitted[key] = { value: { to_camel_case(value.type) => underlying_value(value) } }
+            else
+              permitted[key] = underlying_value(value)
+            end
           end
         rescue StandardError => e
           LOG.warn("Could not resolve key #{key}: #{e}")
@@ -95,5 +87,13 @@ module Prefab
 
       [permitted, warnings]
     end
+
+    def to_camel_case(str)
+      CAMELS[str] ||= begin
+        str.to_s.split('_').map.with_index { |word, index|
+          index == 0 ? word : word.capitalize
+        }.join
+      end
+    end
   end
 end

data/lib/prefab/options.rb

@@ -66,6 +66,7 @@ module Prefab
       collect_evaluation_summaries: true,
       collect_max_evaluation_summaries: DEFAULT_MAX_EVAL_SUMMARIES,
       allow_telemetry_in_local_mode: false,
+      datafile: ENV['PREFAB_DATAFILE'],
       x_datafile: ENV['PREFAB_DATAFILE'],
       x_use_local_cache: false,
       global_context: {}
@@ -76,7 +77,13 @@ module Prefab
       @initialization_timeout_sec = initialization_timeout_sec
       @on_init_failure = on_init_failure
       @prefab_datasources = prefab_datasources
-      @datafile = x_datafile
+
+      @datafile = datafile || x_datafile
+
+      if !x_datafile.nil?
+        warn '[DEPRECATION] x_datafile is deprecated. Please provide `datafile` instead'
+      end
+
       @prefab_config_classpath_dir = prefab_config_classpath_dir
       @prefab_config_override_dir = prefab_config_override_dir
       @prefab_envs = Array(prefab_envs)

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.5 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "prefab-cloud-ruby".freeze
-  s.version = "1.8.3"
+  s.version = "1.8.5"
 
   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-27"
   s.description = "Feature Flags, Live Config, and Dynamic Log Levels as a service".freeze
   s.email = "jdwyer@prefab.cloud".freeze
   s.extra_rdoc_files = [
@@ -84,6 +84,7 @@ Gem::Specification.new do |s|
     "prefab-cloud-ruby.gemspec",
     "test/.prefab.default.config.yaml",
     "test/.prefab.unit_tests.config.yaml",
+    "test/fixtures/datafile.json",
     "test/integration_test.rb",
     "test/integration_test_helpers.rb",
     "test/support/common_helpers.rb",

data/test/fixtures/datafile.json

@@ -0,0 +1,87 @@
+{
+  "configs": [
+    {
+      "id": "16825372746571694",
+      "projectId": "202",
+      "key": "log-level",
+      "changedBy": {
+        "email": "jeffrey.chupp@prefab.cloud"
+      },
+      "configType": "DELETED"
+    },
+    {
+      "id": "17271108409487302",
+      "projectId": "202",
+      "key": "flag.list.environments",
+      "changedBy": {
+        "email": "jeffrey.chupp@prefab.cloud"
+      },
+      "rows": [
+        {
+          "projectEnvId": "308",
+          "values": [
+            {
+              "criteria": [
+                {
+                  "propertyName": "user.key",
+                  "operator": "PROP_IS_ONE_OF",
+                  "valueToMatch": {
+                    "stringList": {
+                      "values": [
+                        "5905ecd1-9bbf-4711-a663-4f713628a78c"
+                      ]
+                    }
+                  }
+                }
+              ],
+              "value": {
+                "bool": true
+              }
+            },
+            {
+              "value": {
+                "bool": true
+              }
+            }
+          ]
+        }
+      ],
+      "allowableValues": [
+        {
+          "bool": false
+        },
+        {
+          "bool": true
+        }
+      ],
+      "configType": "FEATURE_FLAG",
+      "valueType": "BOOL"
+    },
+    {
+      "id": "17271831941669987",
+      "projectId": "202",
+      "key": "my.test.string",
+      "changedBy": {
+        "userId": "3",
+        "apiKeyId": "481"
+      },
+      "rows": [
+        {
+          "values": [
+            {
+              "value": {
+                "string": "hello world"
+              }
+            }
+          ]
+        }
+      ],
+      "configType": "CONFIG",
+      "valueType": "STRING"
+    }
+  ],
+  "configServicePointer": {
+    "projectId": "202",
+    "projectEnvId": "308"
+  }
+}

data/test/test_client.rb

@@ -427,6 +427,14 @@ class TestClient < Minitest::Test
     refute client.is_ff?('does_not_exist')
   end
 
+  def test_with_datafile
+    datafile = "#{Dir.pwd}/test/fixtures/datafile.json"
+    client = new_client(datafile: datafile, prefab_datasources: :all)
+
+    assert client.get('flag.list.environments')
+    assert_equal "hello world", client.get('my.test.string')
+  end
+
   private
 
   def basic_value_config

data/test/test_javascript_stub.rb

@@ -48,6 +48,34 @@ class JavascriptStubTest < Minitest::Test
       rows: [DEFAULT_ROW]
     )
 
+    json_config = PrefabProto::Config.new(
+      id: 234,
+      key: 'json-config',
+      config_type: PrefabProto::ConfigType::CONFIG,
+      send_to_client_sdk: true,
+      rows: [
+        PrefabProto::ConfigRow.new(
+          values: [
+            PrefabProto::ConditionalValue.new(value: PrefabProto::ConfigValue.new(json: PrefabProto::Json.new(json: '{"key":"value"}')))
+          ]
+        )
+      ]
+    )
+
+    duration_config = PrefabProto::Config.new(
+      id: 236,
+      key: 'duration-config',
+      config_type: PrefabProto::ConfigType::CONFIG,
+      send_to_client_sdk: true,
+      rows: [
+        PrefabProto::ConfigRow.new(
+          values: [
+            PrefabProto::ConditionalValue.new(value: PrefabProto::ConfigValue.new(duration: PrefabProto::IsoDuration.new(definition: "P4DT12H30M5S")))
+          ]
+        )
+      ]
+    )
+
     ff = PrefabProto::Config.new(
       id: 456,
       key: 'feature-flag',
@@ -72,7 +100,7 @@ class JavascriptStubTest < Minitest::Test
     )
 
     @client = new_client(
-      config: [log_level, config_for_sdk, config_not_for_sdk, ff],
+      config: [log_level, config_for_sdk, config_not_for_sdk, ff, json_config, duration_config],
       project_env_id: PROJECT_ENV_ID,
       collect_evaluation_summaries: true,
       prefab_config_override_dir: '/tmp',
@@ -85,20 +113,29 @@ class JavascriptStubTest < Minitest::Test
   def test_bootstrap
     result = Prefab::JavaScriptStub.new(@client).bootstrap({})
 
+
+    File.open('/tmp/prefab_config.json', 'w') do |f|
+      f.write(result)
+    end
     assert_equal %(
 window._prefabBootstrap = {
-  configs: {"basic-config":"default_value","feature-flag":false},
+  evaluations: {"log-level":{"value":{"logLevel":"INFO"}},"basic-config":{"value":{"string":"default_value"}},"feature-flag":{"value":{"bool":false}},"json-config":{"value":{"json":"{\\"key\\":\\"value\\"}"}},"duration-config":{"value":{"duration":{"ms":390605000.0,"seconds":390605.0}}}},
   context: {}
 }
     ).strip, result.strip
 
     result = Prefab::JavaScriptStub.new(@client).bootstrap({ user: { email: 'gmail.com' } })
 
+    File.open('/tmp/prefab_config.json', 'w') do |f|
+      f.write(result)
+    end
+
     assert_equal %(
 window._prefabBootstrap = {
-  configs: {"basic-config":"default_value","feature-flag":true},
+  evaluations: {"log-level":{"value":{"logLevel":"INFO"}},"basic-config":{"value":{"string":"default_value"}},"feature-flag":{"value":{"bool":true}},"json-config":{"value":{"json":"{\\"key\\":\\"value\\"}"}},"duration-config":{"value":{"duration":{"ms":390605000.0,"seconds":390605.0}}}},
   context: {"user":{"email":"gmail.com"}}
 }
+
     ).strip, result.strip
   end
 
@@ -107,25 +144,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,"json-config":"{\\"key\\":\\"value\\"}","duration-config":{"ms":390605000.0,"seconds":390605.0}};
 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,"json-config":"{\\"key\\":\\"value\\"}","duration-config":{"ms":390605000.0,"seconds":390605.0}};
 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_options.rb

@@ -85,4 +85,9 @@ class TestOptions < Minitest::Test
     options = Prefab::Options.new(context_upload_mode: :none)
     assert_equal 0, options.collect_max_shapes
   end
+
+  def test_loading_a_datafile
+    options = Prefab::Options.new(datafile: "#{Dir.pwd}/test/fixtures/datafile.json")
+    assert_equal "#{Dir.pwd}/test/fixtures/datafile.json", options.datafile
+  end
 end

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.5
 platform: ruby
 authors:
 - Jeff Dwyer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-16 00:00:00.000000000 Z
+date: 2024-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -285,6 +285,7 @@ files:
 - prefab-cloud-ruby.gemspec
 - test/.prefab.default.config.yaml
 - test/.prefab.unit_tests.config.yaml
+- test/fixtures/datafile.json
 - test/integration_test.rb
 - test/integration_test_helpers.rb
 - test/support/common_helpers.rb