prefab-cloud-ruby 1.8.8.pre.1 → 1.8.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9485b9faf8e79e7e95f3eb69fb0e9f13c8ab4f1cc9c5f3b8d637f5822ed3ba3b
-  data.tar.gz: efb3287eb90d718ee8ddf3f4461b756a228bb619b21ddf9a6224d994a6a180fc
+  metadata.gz: d367fac3af817df60008ab3c698329f6eafb48903524b834ad23caf91c35ee57
+  data.tar.gz: ff9a6a62b7dfc16765582d2e9198eee72e80b83da1968de8c5138ce865180ecc
 SHA512:
-  metadata.gz: 943920075095daaee6f2defc658cea5ac17f77534936d1ba7783bc4993b994cd867515d3dc83ced057ff26ce2cf74ea1acb1b62e0bbe7cad651b9af9c84fe359
-  data.tar.gz: df03d8f2ba7f57f40ccad2e96b5ca73c42a7f4b27f5524506fe6a95a030420a852b62c2e987d70b49d8e441bf092b5fcc37b1fd57183460824979cb6284d5d1e
+  metadata.gz: f6f678df72fc31514aa9f259da3fbffacc910974dab7abb1c2ccaa09929add8dba10746a421130ab3a2cc01ffc8c75695eb102d7e8cace0aa32d42266d449c37
+  data.tar.gz: 98f92995deb4c40c7f6abf820654576d48d39a825e7d0b9e3bbd9d7a5bde23e692559ed603054f3e72cec7c9b3c75b8d9ecb47976fe0e0e51165cf298b288ffc

data/.github/pull_request_template.md

@@ -0,0 +1,8 @@
+## Description
+*(Brief overview of what this PR changes and/or why the changes are needed)*
+
+## Testing & Validation
+*(Outline the steps needed to be taken to verify the changes.)*
+
+## Rollout
+*(Optional section: Provide rollout and rollback procedures, when outside the bounds or requiring additional work beyond standard deployment)*

data/.github/workflows/ruby.yml

@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0', '3.3']
+        ruby-version: ['3.0','3.1','3.2','3.3']
 
     steps:
     - uses: actions/checkout@v4

data/.tool-versions

@@ -1 +1 @@
-ruby 3.0.3
+ruby 3.2.7

data/CHANGELOG.md

@@ -1,78 +1,91 @@
 # Changelog
 
+## 1.8.9 - 2025-04-15
+
+- Fix support for virtual context `prefab.current-time` [#229]
+
+## 1.8.8 - 2025-02-28
+
+- Add conditional fetch support for configurations [#226]
+- Operator support for string starts with, contains [#212]
+- Operator support for regex, semver (protobuf update) [#215]
+- Operator support for date comparison (before/after) [#221]
+- Operator support for numeric comparisons [#220]
+
+
 ## 1.8.7 - 2024-10-25
 
-- Add option symbolize_json_names (#211)
+- Add option symbolize_json_names [#211]
 
 
 ## 1.8.6 - 2024-10-07
 
-- Fix deprecation warning caused by x_datafile being set by default (#208)
+- Fix deprecation warning caused by x_datafile being set by default [#208]
 
 ## 1.8.5 - 2024-09-27
 
-- Fix JS bootstrapping and improve performance (#206)
-- Promote `datafile` from `x_datafile` (#205)
+- 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)
+- Use `stream` subdomain for SSE [#203]
 
 ## 1.8.3 - 2024-09-16
 
-- Add JavaScript stub & bootstrapping (#200)
+- Add JavaScript stub & bootstrapping [#200]
 
 ## 1.8.2 - 2024-09-03
 
-- Forbid bad semantic_logger version (#198)
+- Forbid bad semantic_logger version [#198]
 
 ## 1.8.1 - 2024-09-03
 
-- Fix SSE reconnection bug (#197)
+- Fix SSE reconnection bug [#197]
 
 ## 1.8.0 - 2024-08-22
 
-- Load config from belt and failover to suspenders (#195)
+- Load config from belt and failover to suspenders [#195]
 
 ## 1.7.2 - 2024-06-24
 
-- Support JSON config values (#194)
+- Support JSON config values [#194]
 
 ## 1.7.1 - 2024-04-11
 
-- Ergonomics (#191)
+- Ergonomics [#191]
 
 ## 1.7.0 - 2024-04-10
 
-- Add duration support (#187)
+- Add duration support [#187]
 
 ## 1.6.2 - 2024-03-29
 
-- Fix context telemetry when JIT and Block contexts are combined (#185)
-- Remove logger prefix (#186)
+- Fix context telemetry when JIT and Block contexts are combined [#185]
+- Remove logger prefix [#186]
 
 ## 1.6.1 - 2024-03-28
 
-- Performance optimizations (#178)
-- Global context (#182)
+- Performance optimizations [#178]
+- Global context [#182]
 
 ## 1.6.0 - 2024-03-27
 
-- Use semantic_logger for internal logging (#173)
-- Remove Prefab::LoggerClient as a logger for end users (#173)
-- Provide log_filter for end users (#173)
+- Use semantic_logger for internal logging [#173]
+- Remove Prefab::LoggerClient as a logger for end users [#173]
+- Provide log_filter for end users [#173]
 
 ## 1.5.1 - 2024-02-22
 
-- Fix: Send context shapes by default (#174)
+- Fix: Send context shapes by default [#174]
 
 ## 1.5.0 - 2024-02-12
 
-- Fix potential inconsistent Context behavior (#172)
+- Fix potential inconsistent Context behavior [#172]
 
 ## 1.4.5 - 2024-01-31
 
-- Refactor out a `should_log?` method (#170)
+- Refactor out a `should_log?` method [#170]
 
 ## 1.4.4 - 2024-01-26
 
@@ -84,152 +97,152 @@
 
 ## 1.4.2 - 2023-12-14
 
-- Use reportable value even for invalid data (#166)
+- Use reportable value even for invalid data [#166]
 
 ## 1.4.1 - 2023-12-08
 
-- Include version in `get` request (#165)
+- Include version in `get` request [#165]
 
 ## 1.4.0 - 2023-11-28
 
-- ActiveJob tagged logger issue (#164)
-- Compact Log Format (#163)
-- Tagged Logging (#161)
-- ContextKey logging thread safety (#162)
+- ActiveJob tagged logger issue [#164]
+- Compact Log Format [#163]
+- Tagged Logging [#161]
+- ContextKey logging thread safety [#162]
 
 ## 1.3.2 - 2023-11-15
 
-- Send back cloud.prefab logging telemetry (#160)
+- Send back cloud.prefab logging telemetry [#160]
 
 ## 1.3.1 - 2023-11-14
 
-- Improve path of rails.controller logging & fix strong param include (#159)
+- Improve path of rails.controller logging & fix strong param include [#159]
 
 ## 1.3.0 - 2023-11-13
 
-- Less logging when wifi is off and we load from cache (#157)
-- Alpha: Add Provided & Secret Support (#152)
-- Alpha: x_datafile (#156)
-- Add single line action-controller output under rails.controller (#158)
+- Less logging when wifi is off and we load from cache [#157]
+- Alpha: Add Provided & Secret Support [#152]
+- Alpha: x_datafile [#156]
+- Add single line action-controller output under rails.controller [#158]
 
 ## 1.2.1 - 2023-11-01
 
-- Update protobuf definitions (#154)
+- Update protobuf definitions [#154]
 
 ## 1.2.0 - 2023-10-30
 
-- Add `Prefab.get('key')` style usage after a `Prefab.init()` call (#151)
-- Add `add_context_keys` and `with_context_keys` method for LoggerClient (#145)
+- Add `Prefab.get('key')` style usage after a `Prefab.init()` call [#151]
+- Add `add_context_keys` and `with_context_keys` method for LoggerClient [#145]
 
 ## 1.1.2 - 2023-10-13
 
-- Add `cloud.prefab.client.criteria_evaluator` `debug` logging of evaluations (#150)
-- Add `x_use_local_cache` for local caching (#148)
-- Tests run in RubyMine (#147)
+- Add `cloud.prefab.client.criteria_evaluator` `debug` logging of evaluations [#150]
+- Add `x_use_local_cache` for local caching [#148]
+- Tests run in RubyMine [#147]
 
 ## 1.1.1 - 2023-10-11
 
-- Migrate happy-path client-initialization logging to `DEBUG` level rather than `INFO` (#144)
-- Add `ConfigClientPresenter` for logging out stats upon successful client initialization (#144)
-- Add support for default context (#146)
+- Migrate happy-path client-initialization logging to `DEBUG` level rather than `INFO` [#144]
+- Add `ConfigClientPresenter` for logging out stats upon successful client initialization [#144]
+- Add support for default context [#146]
 
 ## 1.1.0 - 2023-09-18
 
-- Add support for structured logging (#143)
+- Add support for structured logging [#143]
   - Ability to pass a hash of key/value context pairs to any of the user-facing log methods
 
 ## 1.0.1 - 2023-08-17
 
-- Bug fix for StringList w/ ExampleContextsAggregator (#141)
+- Bug fix for StringList w/ ExampleContextsAggregator [#141]
 
 ## 1.0.0 - 2023-08-10
 
-- Removed EvaluatedKeysAggregator (#137)
-- Change `collect_evaluation_summaries` default to true (#136)
-- Removed some backwards compatibility shims (#133)
-- Standardizing options (#132)
+- Removed EvaluatedKeysAggregator [#137]
+- Change `collect_evaluation_summaries` default to true [#136]
+- Removed some backwards compatibility shims [#133]
+- Standardizing options [#132]
   - Note that the default value for `context_upload_mode` is `:periodic_example` which means example contexts will be collected.
     This enables easy variant override assignment in our UI. More at https://prefab.cloud/blog/feature-flag-variant-assignment/
 
 ## 0.24.6 - 2023-07-31
 
-- Logger Client compatibility (#129)
-- Replace EvaluatedConfigs with ExampleContexts (#128)
-- Add ConfigEvaluationSummaries (opt-in for now) (#123)
+- Logger Client compatibility [#129]
+- Replace EvaluatedConfigs with ExampleContexts [#128]
+- Add ConfigEvaluationSummaries (opt-in for now) [#123]
 
 ## 0.24.5 - 2023-07-10
 
-- Report Client Version (#121)
+- Report Client Version [#121]
 
 ## [0.24.4] - 2023-07-06
 
-- Support Timed Loggers (#119)
-- Added EvaluatedConfigsAggregator (disabled by default) (#118)
-- Added EvaluatedKeysAggregator (disabled by default) (#117)
-- Dropped Ruby 2.6 support (#116)
-- Capture/report context shapes (#115)
-- Added bin/console (#114)
+- Support Timed Loggers [#119]
+- Added EvaluatedConfigsAggregator (disabled by default) [#118]
+- Added EvaluatedKeysAggregator (disabled by default) [#117]
+- Dropped Ruby 2.6 support [#116]
+- Capture/report context shapes [#115]
+- Added bin/console [#114]
 
 ## [0.24.3] - 2023-05-15
 
-- Add JSON log formatter (#106)
+- Add JSON log formatter [#106]
 
 # [0.24.2] - 2023-05-12
 
-- Fix bug in FF rollout eval consistency (#108)
-- Simplify forking (#107)
+- Fix bug in FF rollout eval consistency [#108]
+- Simplify forking [#107]
 
 # [0.24.1] - 2023-04-26
 
-- Fix misleading deprecation warning (#105)
+- Fix misleading deprecation warning [#105]
 
 # [0.24.0] - 2023-04-26
 
-- Backwards compatibility for JIT context (#104)
-- Remove upsert (#103)
-- Add resolver presenter and `on_update` callback (#102)
-- Deprecate `lookup_key` and introduce Context (#99)
+- Backwards compatibility for JIT context [#104]
+- Remove upsert [#103]
+- Add resolver presenter and `on_update` callback [#102]
+- Deprecate `lookup_key` and introduce Context [#99]
 
 # [0.23.8] - 2023-04-21
 
-- Update protobuf (#101)
+- Update protobuf [#101]
 
 # [0.23.7] - 2023-04-21
 
-- Guard against ActiveJob not being loaded (#100)
+- Guard against ActiveJob not being loaded [#100]
 
 # [0.23.6] - 2023-04-17
 
-- Fix bug in FF rollout eval consistency (#98)
-- Add tests for block-form of logging (#96)
+- Fix bug in FF rollout eval consistency [#98]
+- Add tests for block-form of logging [#96]
 
 # [0.23.5] - 2023-04-13
 
-- Cast the value to string when checking presence in string list (#95)
+- Cast the value to string when checking presence in string list [#95]
 
 # [0.23.4] - 2023-04-12
 
-- Remove GRPC (#93)
+- Remove GRPC [#93]
 
 # [0.23.3] - 2023-04-07
 
-- Use exponential backoff for log level uploading (#92)
+- Use exponential backoff for log level uploading [#92]
 
 # [0.23.2] - 2023-04-04
 
-- Move log collection logs from INFO to DEBUG (#91)
-- Fix: Handle trailing slash in PREFAB_API_URL (#90)
+- Move log collection logs from INFO to DEBUG [#91]
+- Fix: Handle trailing slash in PREFAB_API_URL [#90]
 
 # [0.23.1] - 2023-03-30
 
-- ActiveStorage not defined in Rails < 5.2 (#87)
+- ActiveStorage not defined in Rails < 5.2 [#87]
 
 # [0.23.0] - 2023-03-28
 
-- Convenience for setting Rails.logger (#85)
-- Log evaluation according to rules (#81)
+- Convenience for setting Rails.logger [#85]
+- Log evaluation according to rules [#81]
 
 # [0.22.0] - 2023-03-15
 
-- Report log paths and usages (#79)
-- Accept hash or keyword args in `initialize` (#78)
+- Report log paths and usages [#79]
+- Accept hash or keyword args in `initialize` [#78]

data/VERSION

@@ -1 +1 @@
-1.8.8.pre.1
+1.8.9

data/compile_protos.sh

@@ -2,14 +2,16 @@
 
 set -e
 
+PROTO_ROOT="${PROTO_ROOT:-..}"
+
 gem install grpc-tools
 
 (
-  cd ../prefab-cloud
+  cd "$PROTO_ROOT/prefab-cloud"
   git pull --rebase
 )
 
-grpc_tools_ruby_protoc -I ../prefab-cloud/ --ruby_out=lib --grpc_out=lib prefab.proto
+grpc_tools_ruby_protoc -I "$PROTO_ROOT/prefab-cloud/" --ruby_out=lib --grpc_out=lib prefab.proto
 
 gsed -i 's/^module Prefab$/module PrefabProto/g' lib/prefab_pb.rb
 

data/lib/prefab/caching_http_connection.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Prefab
+  class CachingHttpConnection
+    CACHE_SIZE = 2.freeze
+    CacheEntry = Struct.new(:data, :etag, :expires_at)
+
+    class << self
+      def cache
+        @cache ||= FixedSizeHash.new(CACHE_SIZE)
+      end
+
+      def reset_cache!
+        @cache = FixedSizeHash.new(CACHE_SIZE)
+      end
+    end
+
+    def initialize(uri, api_key)
+      @connection = HttpConnection.new(uri, api_key)
+    end
+
+    def get(path)
+      now = Time.now.to_i
+      cache_key = "#{@connection.uri}#{path}"
+      cached = self.class.cache[cache_key]
+
+      # Check if we have a valid cached response
+      if cached&.data && cached.expires_at && now < cached.expires_at
+        return Faraday::Response.new(
+          status: 200,
+          body: cached.data,
+          response_headers: {
+            'ETag' => cached.etag,
+            'X-Cache' => 'HIT',
+            'X-Cache-Expires-At' => cached.expires_at.to_s
+          }
+        )
+      end
+
+      # Make request with conditional GET if we have an ETag
+      response = if cached&.etag
+                   @connection.get(path, { 'If-None-Match' => cached.etag })
+                 else
+                   @connection.get(path)
+                 end
+
+      # Handle 304 Not Modified
+      if response.status == 304 && cached&.data
+        return Faraday::Response.new(
+          status: 200,
+          body: cached.data,
+          response_headers: {
+            'ETag' => cached.etag,
+            'X-Cache' => 'HIT',
+            'X-Cache-Expires-At' => cached.expires_at.to_s
+          }
+        )
+      end
+
+      # Parse caching headers
+      cache_control = response.headers['Cache-Control'].to_s
+      etag = response.headers['ETag']
+
+      # Always add X-Cache header
+      response.headers['X-Cache'] = 'MISS'
+
+      # Don't cache if no-store is present
+      return response if cache_control.include?('no-store')
+
+      # Calculate expiration
+      max_age = cache_control.match(/max-age=(\d+)/)&.captures&.first&.to_i
+      expires_at = max_age ? now + max_age : nil
+
+      # Cache the response if we have caching headers
+      if etag || expires_at
+        self.class.cache[cache_key] = CacheEntry.new(
+          response.body,
+          etag,
+          expires_at
+        )
+      end
+
+      response
+    end
+
+    # Delegate other methods to the underlying connection
+    def post(path, body)
+      @connection.post(path, body)
+    end
+
+    def uri
+      @connection.uri
+    end
+  end
+end

data/lib/prefab/config_client.rb

@@ -118,7 +118,7 @@ module Prefab
     end
 
     def load_checkpoint
-      success = load_source_checkpoint
+      success = load_source_checkpoint(:start_at_id => @config_loader.highwater_mark)
       return if success
 
       success = load_cache
@@ -127,11 +127,10 @@ module Prefab
       LOG.warn 'No success loading checkpoints'
     end
 
-    def load_source_checkpoint
+    def load_source_checkpoint(start_at_id: 0)
       @options.config_sources.each do |source|
-        conn = Prefab::HttpConnection.new("#{source}/api/v1/configs/0", @base_client.api_key)
+        conn = Prefab::CachingHttpConnection.new("#{source}/api/v1/configs/#{start_at_id}", @base_client.api_key)
         result = load_url(conn, :remote_api)
-
         return true if result
       end
 
@@ -146,18 +145,18 @@ module Prefab
         cache_configs(configs)
         true
       else
-        LOG.info "Checkpoint #{source} failed to load. Response #{resp.status}"
+        LOG.info "Checkpoint #{source} [#{conn.uri}] failed to load. Response #{resp.status}"
         false
       end
     rescue Faraday::ConnectionFailed => e
       if !initialized?
-        LOG.warn "Connection Fail loading #{source} checkpoint."
+        LOG.warn "Connection Fail loading #{source} [#{conn.uri}] checkpoint."
       else
-        LOG.debug "Connection Fail loading #{source} checkpoint."
+        LOG.debug "Connection Fail loading #{source} [#{conn.uri}] checkpoint."
       end
       false
     rescue StandardError => e
-      LOG.warn "Unexpected #{source} problem loading checkpoint #{e} #{conn}"
+      LOG.warn "Unexpected #{source} [#{conn.uri}] problem loading checkpoint #{e} #{conn}"
       LOG.debug e.backtrace
       false
     end

data/lib/prefab/context.rb

@@ -200,12 +200,6 @@ module Prefab
     end
 
     def to_proto(namespace)
-      prefab_context = {
-        'current-time' => ConfigValueWrapper.wrap(Prefab::TimeHelpers.now_in_ms)
-      }
-
-      prefab_context['namespace'] = ConfigValueWrapper.wrap(namespace) if namespace&.length&.positive?
-
       reportable_contexts = {}
 
       reportable_tree.each do |ctx|
@@ -217,8 +211,7 @@ module Prefab
       PrefabProto::ContextSet.new(
         contexts: reportable_contexts.map do |name, context|
           context.to_proto
-        end.concat([PrefabProto::Context.new(type: 'prefab',
-                                             values: prefab_context)])
+        end
       )
     end