unleash 6.4.0 → 6.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a76eb26bedcade3ed88389aa909f7ead99177e336509bc4fd99d85c4703f1405
-  data.tar.gz: 43410bf468ac4fd3b56af79a354eb84794c40c67b6c2d96c27bdf26772b1c54d
+  metadata.gz: 6c28fb398c92bd470282a94e7fe07b910fa4afed65381da67231c60c2b2960c2
+  data.tar.gz: 3a5b78a63ccfcec23ed8eba1e2168a5be7f183ca0c3beac0eb6497d1d4d6678c
 SHA512:
-  metadata.gz: 3e43cbef4ba85e84265f10b9414eba95c92aeb59792a40318e15df37313ee5a6b99ce3c3e3e89d465c56e40fff92e61ed4115766d59b6ee9147c2d2c5920ebf7
-  data.tar.gz: 2401fa3bf2d0f824d7da3cf2e01cc4c20fe740f26d2019f89554adbbc67fdc5c0f4fa65003e143391b14ea2466314db36852edd0ccefca8178f6545e3186170d
+  metadata.gz: 3d66480a2211bc60a0ddb2899d189a7966be1659f8618873233c8e419f2261dc5cf13cf79f747d36039af5f9ce1ead45fb4e3bc4140d420d4d59369a9a995bc4
+  data.tar.gz: ba06afc53ff6d2806d6bbf18cc93e2287ae327f42cb6699f663a3f2f5bb9abc6e3f71ce02ba7fe18f48bdcb9fb1913c2d9cc4a6be2d05bae6f740def1a4281d5

data/CHANGELOG.md

@@ -13,6 +13,11 @@ Note: These changes are not considered notable:
 
 ## [Unreleased]
 
+## [6.4.1] - 2025-12-04
+
+### Changed
+- Bump yggdrasil-engine
+
 ## [6.4.0] - 2025-08-12
 ### Added
 - Experimental streaming support

data/README.md

@@ -28,7 +28,7 @@ You can use this client with [Unleash Enterprise](https://www.getunleash.io/pric
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'unleash', '~> 6.3.0'
+gem 'unleash', '~> 6.4.1'
 ```
 
 And then execute:

data/lib/unleash/backup_file_reader.rb

@@ -0,0 +1,24 @@
+require 'unleash/configuration'
+
+module Unleash
+  class BackupFileReader
+    def self.read!
+      Unleash.logger.debug "read!()"
+
+      backup_file = Unleash.configuration.backup_file
+      return nil unless File.exist?(backup_file)
+
+      File.read(backup_file)
+    rescue IOError => e
+      # :nocov:
+      Unleash.logger.error "Unable to read the backup_file: #{e}"
+      # :nocov:
+      nil
+    rescue StandardError => e
+      # :nocov:
+      Unleash.logger.error "Unable to extract valid data from backup_file. Exception thrown: #{e}"
+      # :nocov:
+      nil
+    end
+  end
+end

data/lib/unleash/backup_file_writer.rb

@@ -0,0 +1,21 @@
+require 'unleash/configuration'
+
+module Unleash
+  class BackupFileWriter
+    def self.save!(toggle_data)
+      Unleash.logger.debug "Will save toggles to disk now"
+
+      backup_file = Unleash.configuration.backup_file
+      backup_file_tmp = "#{backup_file}.tmp-#{Process.pid}"
+
+      File.open(backup_file_tmp, "w") do |file|
+        file.write(toggle_data)
+      end
+      File.rename(backup_file_tmp, backup_file)
+    rescue StandardError => e
+      # This is not really the end of the world. Swallowing the exception.
+      Unleash.logger.error "Unable to save backup file. Exception thrown #{e.class}:'#{e}'"
+      Unleash.logger.error "stacktrace: #{e.backtrace}"
+    end
+  end
+end

data/lib/unleash/spec_version.rb

@@ -1,3 +1,3 @@
 module Unleash
-  CLIENT_SPECIFICATION_VERSION = "5.2.0".freeze
+  CLIENT_SPECIFICATION_VERSION = "5.2.2".freeze
 end

data/lib/unleash/streaming_client_executor.rb

@@ -1,4 +1,6 @@
 require 'unleash/streaming_event_processor'
+require 'unleash/bootstrap/handler'
+require 'unleash/backup_file_reader'
 require 'unleash/util/event_source_wrapper'
 
 module Unleash
@@ -10,6 +12,20 @@ module Unleash
       self.event_source = nil
       self.event_processor = Unleash::StreamingEventProcessor.new(engine)
       self.running = false
+
+      begin
+        # if bootstrap configuration is available, initialize. Otherwise read backup file
+        if Unleash.configuration.use_bootstrap?
+          bootstrap(engine)
+        else
+          read_backup_file!(engine)
+        end
+      rescue StandardError => e
+        # fall back to reading the backup file
+        Unleash.logger.warn "StreamingClientExecutor was unable to initialize, attempting to read from backup file."
+        Unleash.logger.debug "Exception Caught: #{e}"
+        read_backup_file!(engine)
+      end
     end
 
     def run(&_block)
@@ -81,5 +97,18 @@ module Unleash
       Unleash.logger.error "Streaming client #{self.name} threw exception #{e.class}: '#{e}'"
       Unleash.logger.debug "stacktrace: #{e.backtrace}"
     end
+
+    def read_backup_file!(engine)
+      backup_data = Unleash::BackupFileReader.read!
+      engine.take_state(backup_data) if backup_data
+    end
+
+    def bootstrap(engine)
+      bootstrap_payload = Unleash::Bootstrap::Handler.new(Unleash.configuration.bootstrap_config).retrieve_toggles
+      engine.take_state(bootstrap_payload)
+
+      # reset Unleash.configuration.bootstrap_data to free up memory, as we will never use it again
+      Unleash.configuration.bootstrap_config = nil
+    end
   end
 end

data/lib/unleash/streaming_event_processor.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'unleash/backup_file_writer'
 
 module Unleash
   class StreamingEventProcessor
@@ -41,7 +42,8 @@ module Unleash
     def handle_updated_event(event)
       handle_delta_event(event.data)
 
-      # TODO: update backup file
+      full_state = @toggle_engine.get_state
+      Unleash::BackupFileWriter.save!(full_state)
     rescue JSON::ParserError => e
       Unleash.logger.error "Unable to parse JSON from streaming event data. Exception thrown #{e.class}: '#{e}'"
       Unleash.logger.debug "stacktrace: #{e.backtrace}"

data/lib/unleash/toggle_fetcher.rb

@@ -1,5 +1,7 @@
 require 'unleash/configuration'
 require 'unleash/bootstrap/handler'
+require 'unleash/backup_file_writer'
+require 'unleash/backup_file_reader'
 require 'net/http'
 require 'json'
 require 'yggdrasil_engine'
@@ -23,10 +25,10 @@ module Unleash
           fetch
         end
       rescue StandardError => e
-        # fail back to reading the backup file
+        # fall back to reading the backup file
         Unleash.logger.warn "ToggleFetcher was unable to fetch from the network, attempting to read from backup file."
         Unleash.logger.debug "Exception Caught: #{e}"
-        read!
+        read_backup_file!
       end
 
       # once initialized, somewhere else you will want to start a loop with fetch()
@@ -54,25 +56,7 @@ module Unleash
       # always synchronize with the local cache when fetching:
       update_engine_state!(response.body)
 
-      save! response.body
-    end
-
-    def save!(toggle_data)
-      Unleash.logger.debug "Will save toggles to disk now"
-
-      backup_file = Unleash.configuration.backup_file
-      backup_file_tmp = "#{backup_file}.tmp"
-
-      self.toggle_lock.synchronize do
-        File.open(backup_file_tmp, "w") do |file|
-          file.write(toggle_data)
-        end
-        File.rename(backup_file_tmp, backup_file)
-      end
-    rescue StandardError => e
-      # This is not really the end of the world. Swallowing the exception.
-      Unleash.logger.error "Unable to save backup file. Exception thrown #{e.class}:'#{e}'"
-      Unleash.logger.error "stacktrace: #{e.backtrace}"
+      Unleash::BackupFileWriter.save! response.body
     end
 
     private
@@ -88,25 +72,9 @@ module Unleash
       Unleash.logger.error "Failed to hydrate state: #{e.backtrace}"
     end
 
-    def read!
-      Unleash.logger.debug "read!()"
-      backup_file = Unleash.configuration.backup_file
-      return nil unless File.exist?(backup_file)
-
-      backup_data = File.read(backup_file)
-      update_engine_state!(backup_data)
-    rescue IOError => e
-      # :nocov:
-      Unleash.logger.error "Unable to read the backup_file: #{e}"
-      # :nocov:
-    rescue JSON::ParserError => e
-      # :nocov:
-      Unleash.logger.error "Unable to parse JSON from existing backup_file: #{e}"
-      # :nocov:
-    rescue StandardError => e
-      # :nocov:
-      Unleash.logger.error "Unable to extract valid data from backup_file. Exception thrown: #{e}"
-      # :nocov:
+    def read_backup_file!
+      backup_data = Unleash::BackupFileReader.read!
+      update_engine_state!(backup_data) if backup_data
     end
 
     def bootstrap

data/lib/unleash/version.rb

@@ -1,3 +1,3 @@
 module Unleash
-  VERSION = "6.4.0".freeze
+  VERSION = "6.4.1".freeze
 end

data/unleash-client.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.7"
 
   spec.add_dependency "ld-eventsource", "2.2.4" unless RUBY_ENGINE == 'jruby'
-  spec.add_dependency "yggdrasil-engine", "~> 1.0.4"
+  spec.add_dependency "yggdrasil-engine", "~> 1.1.1"
 
   spec.add_dependency "base64", "~> 0.3.0"
   spec.add_dependency "logger", "~> 1.6"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unleash
 version: !ruby/object:Gem::Version
-  version: 6.4.0
+  version: 6.4.1
 platform: ruby
 authors:
 - Renato Arruda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-12 00:00:00.000000000 Z
+date: 2025-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ld-eventsource
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 1.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: base64
   requirement: !ruby/object:Gem::Requirement
@@ -209,6 +209,8 @@ files:
 - examples/simple.rb
 - examples/streaming.rb
 - lib/unleash.rb
+- lib/unleash/backup_file_reader.rb
+- lib/unleash/backup_file_writer.rb
 - lib/unleash/bootstrap/configuration.rb
 - lib/unleash/bootstrap/handler.rb
 - lib/unleash/bootstrap/provider/base.rb
@@ -249,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Unleash feature toggle client.