devcycle-ruby-server-sdk 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f9dd2899f5a8f286a66a667fa27623331572f5c35dec9ad363ab0be2e191296
-  data.tar.gz: e0971e7a1bdafc366b2021df303dbfc0f30f230d1c353e435d810805026ab866
+  metadata.gz: a00494492e31ee9cbd1aeb791c0372402ab5a243717e2d14e5cae6b16b41e639
+  data.tar.gz: 8dc6223226365eaca06e35cbdc6ed7006b190e01d378279b3c6a9e22d519b4f4
 SHA512:
-  metadata.gz: 0c2d2b26b6ef08f548c58ecfbca13b2a09ab5643184f2018f9ede3e41ca1a115f17024f577e84ce12c27a23161be3cb7dc0d717569d23f4698b1f0398847dfdf
-  data.tar.gz: 1bfe5568cc56cf86566c9fe9d7480ffb6b3f7edf6907544a3305e99fbe64a163a867aa8f713015172591673889bd688fd81971efd4fbb91ef152433c59637b61
+  metadata.gz: b51d40ce54ccfc9b21742f888877f2522ed464f676aa90016ff4fd2c8d6b12773b8c2eff782c97b4226669a815bc07d0ac77f715b7bfd6d8005b3bf327e60238
+  data.tar.gz: b15efd1fddb5c34a79bc6ffba5dbe16fd7e139e8f0acb75f917ca13696b3ff6787bf09e5fd5d57de4c36848e75ca9694b978d5b83f9746f631291b79b861e82a

data/Gemfile

@@ -6,6 +6,7 @@ gem 'oj'
 gem 'wasmtime'
 gem 'concurrent-ruby'
 gem 'google-protobuf'
+gem 'ld-eventsource'
 
 group :development, :test do
   gem 'sorbet'

data/devcycle-ruby-server-sdk.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'sorbet-runtime', '>= 0.5.11481'
   s.add_runtime_dependency 'oj', '~> 3.0'
   s.add_runtime_dependency 'google-protobuf', '~> 3.22'
+  s.add_runtime_dependency 'ld-eventsource', '~> 2.2.2'
 
 
   s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'

data/lib/devcycle-ruby-server-sdk/localbucketing/config_manager.rb

@@ -5,6 +5,7 @@ require 'concurrent-ruby'
 require 'typhoeus'
 require 'json'
 require 'time'
+require 'ld-eventsource'
 
 module DevCycle
   class ConfigManager
@@ -16,18 +17,21 @@ module DevCycle
     ).void }
     def initialize(sdkKey, local_bucketing, wait_for_init)
       @first_load = true
-      @config_version = "v1"
+      @config_version = "v2"
       @local_bucketing = local_bucketing
       @sdkKey = sdkKey
+      @sse_url = ""
+      @sse_polling = false
       @config_e_tag = ""
       @config_last_modified = ""
       @logger = local_bucketing.options.logger
+      @enable_sse = local_bucketing.options.enable_beta_realtime_updates
       @polling_enabled = true
+      @sse_active = false
       @max_config_retries = 2
-
       @config_poller = Concurrent::TimerTask.new({
                                                    execution_interval: @local_bucketing.options.config_polling_interval_ms.fdiv(1000)
-                                                 }) do |task|
+                                                 }) do |_|
         fetch_config
       end
 
@@ -38,7 +42,7 @@ module DevCycle
     def initialize_config
       begin
         fetch_config
-        @config_poller.execute if @polling_enabled
+        start_polling(false)
       rescue => e
         @logger.error("DevCycle: Error Initializing Config: #{e.message}")
       ensure
@@ -46,8 +50,8 @@ module DevCycle
       end
     end
 
-    def fetch_config
-      return unless @polling_enabled
+    def fetch_config(min_last_modified: -1)
+      return unless @polling_enabled || (@sse_active && @enable_sse)
 
       req = Typhoeus::Request.new(
         get_config_url,
@@ -56,14 +60,24 @@ module DevCycle
         })
 
       begin
-        Date.parse(@config_last_modified)
+        # Blind parse the lastmodified string to check if it's a valid date.
+        # This short circuits the rest of the checks if it's not set
         if @config_last_modified != ""
-          req.options[:headers]["If-Modified-Since"] = Time.httpdate(@config_last_modified)
+          if min_last_modified != -1
+            stored_date = Date.parse(@config_last_modified)
+            parsed_sse_ts = Time.at(min_last_modified)
+            if parsed_sse_ts.utc > stored_date.utc
+              req.options[:headers]["If-Modified-Since"] = parsed_sse_ts.utc.httpdate
+            else
+              req.options[:headers]["If-Modified-Since"] = @config_last_modified
+            end
+          else
+            req.options[:headers]["If-Modified-Since"] = @config_last_modified
+          end
         end
       rescue
       end
 
-
       if @config_e_tag != ""
         req.options[:headers]['If-None-Match'] = @config_e_tag
       end
@@ -77,28 +91,33 @@ module DevCycle
           @logger.debug("Config not modified, using cache, etag: #{@config_e_tag}, last modified: #{@config_last_modified}")
           break
         when 200
-          @logger.debug("New config received, etag: #{resp.headers['Etag']} LM:#{resp.headers['Last-Modified']}")
-          lm_header = resp.headers['Last-Modified']
+          @logger.debug("New config received, etag: #{resp.headers['Etag']} LastModified:#{resp.headers['Last-Modified']}")
           begin
-            lm_timestamp = Time.rfc2822(lm_header)
+            if @config_last_modified == ""
+              set_config(resp.body, resp.headers['Etag'], resp.headers['Last-Modified'])
+              return
+            end
+
+            lm_timestamp = Time.rfc2822(resp.headers['Last-Modified'])
             current_lm = Time.rfc2822(@config_last_modified)
             if lm_timestamp == "" && @config_last_modified == "" || (current_lm.utc < lm_timestamp.utc)
-              set_config(resp.body, resp.headers['Etag'], lm_header)
-              @logger.debug("New config stored, etag: #{@config_e_tag}, last modified: #{lm_header}")
+              set_config(resp.body, resp.headers['Etag'], resp.headers['Last-Modified'])
             else
-              @logger.warn("Config response was an older config than currently stored config.")
+              @logger.warn("Config last-modified was an older date than currently stored config.")
             end
           rescue
-            @logger.warn("Failed to parse last modified header, setting config.")
-            set_config(resp.body, resp.headers['Etag'], lm_header)
+            @logger.warn("Failed to parse last modified header, setting config anyway.")
+            set_config(resp.body, resp.headers['Etag'], resp.headers['Last-Modified'])
           end
           break
         when 403
           stop_polling
+          stop_sse
           @logger.error("Failed to download DevCycle config; Invalid SDK Key.")
           break
         when 404
           stop_polling
+          stop_sse
           @logger.error("Failed to download DevCycle config; Config not found.")
           break
         when 500...599
@@ -110,7 +129,6 @@ module DevCycle
           break
         end
       end
-
       nil
     end
 
@@ -118,11 +136,21 @@ module DevCycle
       if !JSON.parse(config).is_a?(Hash)
         raise("Invalid JSON body parsed from Config Response")
       end
-
+      parsed_config = JSON.parse(config)
+
+      if parsed_config['sse'] != nil
+        raw_url = "#{parsed_config['sse']['hostname']}#{parsed_config['sse']['path']}"
+        if @sse_url != raw_url && raw_url != ""
+          stop_sse
+          @sse_url = raw_url
+          init_sse(@sse_url)
+        end
+      end
       @local_bucketing.store_config(config)
       @config_e_tag = etag
       @config_last_modified = lastmodified
       @local_bucketing.has_config = true
+      @logger.debug("New config stored, etag: #{@config_e_tag}, last modified: #{@config_last_modified}")
     end
 
     def get_config_url
@@ -130,14 +158,70 @@ module DevCycle
       "#{configBasePath}/config/#{@config_version}/server/#{@sdkKey}.json"
     end
 
-    def stop_polling
+    def start_polling(sse)
+      if sse
+        @config_poller.shutdown if @config_poller.running?
+        @config_poller = Concurrent::TimerTask.new({ execution_interval: 60 * 10 }) do |_|
+          fetch_config
+        end
+        @sse_polling = sse
+      end
+      @polling_enabled = true
+      @config_poller.execute if @polling_enabled && (!@sse_active || sse)
+    end
+
+    def stop_polling()
       @polling_enabled = false
       @config_poller.shutdown if @config_poller.running?
     end
 
+    def stop_sse
+      return unless @enable_sse
+      @sse_active = false
+      @sse_polling = false
+      @sse_client.close if @sse_client
+      start_polling(@sse_polling)
+    end
+
     def close
       @config_poller.shutdown if @config_poller.running?
       nil
     end
+
+    def init_sse(path)
+      return unless @enable_sse
+      @logger.debug("Initializing SSE with url: #{path}")
+      @sse_active = true
+      @sse_client = SSE::Client.new(path) do |client|
+        client.on_event do |event|
+
+          parsed_json = JSON.parse(event.data)
+          handle_sse(parsed_json)
+        end
+        client.on_error do |error|
+          @logger.debug("SSE Error: #{error.message}")
+        end
+      end
+    end
+
+    def handle_sse(event_data)
+      unless @sse_polling
+        stop_polling
+        start_polling(true)
+      end
+      if event_data["data"] == nil
+        return
+      end
+      @logger.debug("SSE: Message received: #{event_data["data"]}")
+      parsed_event_data = JSON.parse(event_data["data"])
+
+      last_modified = parsed_event_data["lastModified"]
+      event_type = parsed_event_data["type"]
+
+      if event_type == "refetchConfig" || event_type == nil
+        @logger.debug("SSE: Re-fetching new config with TS: #{last_modified}")
+        fetch_config(min_last_modified: last_modified / 1000)
+      end
+    end
   end
 end

data/lib/devcycle-ruby-server-sdk/localbucketing/event_queue.rb

@@ -26,6 +26,7 @@ module DevCycle
       @flush_mutex = Mutex.new
       @local_bucketing = local_bucketing
       @local_bucketing.init_event_queue(@client_uuid, options)
+
     end
 
     def close

data/lib/devcycle-ruby-server-sdk/localbucketing/options.rb

@@ -3,6 +3,7 @@ module DevCycle
     attr_reader :config_polling_interval_ms
     attr_reader :enable_edge_db
     attr_reader :enable_cloud_bucketing
+    attr_reader :enable_beta_realtime_updates
     attr_reader :config_cdn_uri
     attr_reader :events_api_uri
     attr_reader :bucketing_api_uri
@@ -14,6 +15,7 @@ module DevCycle
       disable_custom_event_logging: false,
       disable_automatic_event_logging: false,
       config_polling_interval_ms: 10_000,
+      enable_beta_realtime_updates: false,
       request_timeout_ms: 5_000,
       max_event_queue_size: 2_000,
       flush_event_queue_size: 1_000,
@@ -71,6 +73,7 @@ module DevCycle
 
       @disable_custom_event_logging = disable_custom_event_logging
       @disable_automatic_event_logging = disable_automatic_event_logging
+      @enable_beta_realtime_updates = enable_beta_realtime_updates
       @config_cdn_uri = config_cdn_uri
       @events_api_uri = events_api_uri
       @bucketing_api_uri = "https://bucketing-api.devcyle.com"

data/lib/devcycle-ruby-server-sdk/localbucketing/update_wasm.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-BUCKETING_LIB_VERSION="1.24.2"
+BUCKETING_LIB_VERSION="1.25.3"
 WAT_DOWNLOAD=0
 rm bucketing-lib.release.wasm
 wget "https://unpkg.com/@devcycle/bucketing-assembly-script@$BUCKETING_LIB_VERSION/build/bucketing-lib.release.wasm"

data/lib/devcycle-ruby-server-sdk/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.3.0
 =end
 
 module DevCycle
-  VERSION = '3.0.0'
+  VERSION = '3.2.0'
 end

data/spec/api/devcycle_api_spec.rb

@@ -18,9 +18,14 @@ require 'json'
 # Please update as you see appropriate
 describe 'DevCycle::Client' do
   before(:all) do
+    sdk_key = ENV["DEVCYCLE_SERVER_SDK_KEY"]
+    if sdk_key.nil?
+      puts("SDK KEY NOT SET - SKIPPING INIT")
+      return
+    end
     # run before each test
     options = DevCycle::Options.new(enable_cloud_bucketing: true)
-    @api_instance = DevCycle::Client.new("dvc_server_token_hash", options)
+    @api_instance = DevCycle::Client.new(sdk_key, options)
     
     @user = DevCycle::User.new({
         user_id: 'test-user',
@@ -57,12 +62,12 @@ describe 'DevCycle::Client' do
   # @param user
   # @param [Hash] opts the optional parameters
   # @return [Variable]
-  describe 'get_variable_by_key activate-flag' do
+  describe 'get_variable_by_key ruby-example-tests' do
     it 'should work' do
-      result = @api_instance.variable(@user, "activate-flag", false)
+      result = @api_instance.variable(@user, "ruby-example-tests-default", false)
       expect(result.isDefaulted).to eq true
 
-      result = @api_instance.variable_value(@user, "activate-flag", true)
+      result = @api_instance.variable_value(@user, "ruby-example-tests-default", true)
       expect(result).to eq true
     end
   end
@@ -75,11 +80,11 @@ describe 'DevCycle::Client' do
   # @return [Variable]
   describe 'get_variable_by_key test' do
     it 'should work' do
-      result = @api_instance.variable(@user, "test", false)
+      result = @api_instance.variable(@user, "ruby-example-tests", false)
       expect(result.isDefaulted).to eq false
       expect(result.value).to eq true
 
-      result = @api_instance.variable_value(@user, "test", true)
+      result = @api_instance.variable_value(@user, "ruby-example-tests", true)
       expect(result).to eq true
     end
   end
@@ -93,7 +98,7 @@ describe 'DevCycle::Client' do
     it 'should work' do
       result = @api_instance.all_variables(@user)
 
-      expect(result.length).to eq 5
+      expect(result.length >= 1).to eq true
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devcycle-ruby-server-sdk
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - DevCycleHQ
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-17 00:00:00.000000000 Z
+date: 2024-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -100,6 +100,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.22'
+- !ruby/object:Gem::Dependency
+  name: ld-eventsource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement