splitclient-rb 8.1.3.pre.rc3 → 8.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c6c7ac46f657ee17dc914ad0772842765a7a7467433fdb220aafe296cd8d34b
-  data.tar.gz: 20a2d0aa34e77924e879eb83af1c9a402cde5c885e2c03fea2942f1221102413
+  metadata.gz: cb1d386fbacf462f6fb540e13b07037fef8bfeab4fcbbda8e1197f63cf64e101
+  data.tar.gz: 758c3e6e1cd5d8a6488d283d5eac29fce2942d0b14eb2757b3825a19bbae86f9
 SHA512:
-  metadata.gz: d4a4df1e037d2f6a7dcce6fa3630ee944bce3dba3f0d5d18f0993c444fbb1642368fd12432ed6bcd2c964f9be44537132f8fd531a9af1c7a6f3fcbb79b0bfd9d
-  data.tar.gz: fd4e5b82086e468404cf3cf5b49d9b9b4befa938bf874f7b74a51f704781e270189e1abc9b3d1243b13225a294e60560877c03d175c33e7098cb4c6ce8c016ec
+  metadata.gz: 9ad6c553a9af8afe5f2c91db3160d6043d7fd3e2f7c7c2e935c061dc0e49bfae59c5ddb47853c416d67ee692bd0c21c1e0d6c1b88dc51d713ead0a64f0c3c7c9
+  data.tar.gz: d4564ffdac1484039e244469b9c845a4def9d817a3a70ab05d1e9b5df78d274a864c2e2c98bb4cc952127b121656ad5522cfa6c6e583fca4422a26953593d157

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @splitio/sdk

data/.github/workflows/ci.yml

@@ -27,7 +27,7 @@ jobs:
       matrix:
         version:
           - '2.5.0'
-          - '3.1.1'
+          - '3.2.2'
 
     steps:
       - name: Checkout code
@@ -56,7 +56,7 @@ jobs:
         run: echo "VERSION=$(cat lib/splitclient-rb/version.rb | grep VERSION | awk -F "'" '{print $2}')" >> $GITHUB_ENV
 
       - name: SonarQube Scan (Push)
-        if: matrix.version == '3.1.1' && github.event_name == 'push'
+        if: matrix.version == '3.2.2' && github.event_name == 'push'
         uses: SonarSource/sonarcloud-github-action@v1.9
         env:
           SONAR_TOKEN: ${{ secrets.SONARQUBE_TOKEN }}
@@ -68,7 +68,7 @@ jobs:
             -Dsonar.projectVersion=${{ env.VERSION }}
 
       - name: SonarQube Scan (Pull Request)
-        if: matrix.version == '3.1.1' && github.event_name == 'pull_request'
+        if: matrix.version == '3.2.2' && github.event_name == 'pull_request'
         uses: SonarSource/sonarcloud-github-action@v1.9
         env:
           SONAR_TOKEN: ${{ secrets.SONARQUBE_TOKEN }}

data/CHANGES.txt

@@ -1,5 +1,8 @@
 CHANGES
 
+8.2.0 (Jul 18, 2023)
+- Improved streaming architecture implementation to apply feature flag updates from the notification received which is now enhanced, improving efficiency and reliability of the whole update system.
+
 8.1.2 (May 15, 2023)
 - Updated terminology on the SDKs codebase to be more aligned with current standard without causing a breaking change. The core change is the term split for feature flag on things like logs and IntelliSense comments.
 

data/lib/splitclient-rb/engine/api/splits.rb

@@ -46,21 +46,11 @@ module SplitIoClient
 
         parsed_splits[:segment_names] =
           parsed_splits[:splits].each_with_object(Set.new) do |split, splits|
-            splits << segment_names(split)
+            splits << Helpers::Util.segment_names_by_feature_flag(split)
           end.flatten
 
         parsed_splits
       end
-
-      def segment_names(split)
-        split[:conditions].each_with_object(Set.new) do |condition, names|
-          condition[:matcherGroup][:matchers].each do |matcher|
-            next if matcher[:userDefinedSegmentMatcherData].nil?
-
-            names << matcher[:userDefinedSegmentMatcherData][:segmentName]
-          end
-        end
-      end
     end
   end
 end

data/lib/splitclient-rb/helpers/util.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Helpers
+    class Util
+      def self.segment_names_by_feature_flag(feature_flag)
+        feature_flag[:conditions].each_with_object(Set.new) do |condition, names|
+          condition[:matcherGroup][:matchers].each do |matcher|
+            next if matcher[:userDefinedSegmentMatcherData].nil?
+
+            names << matcher[:userDefinedSegmentMatcherData][:segmentName]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/splitclient-rb/split_factory.rb

@@ -184,7 +184,7 @@ module SplitIoClient
 
     def build_streaming_components
       @push_status_queue = Queue.new
-      splits_worker = SSE::Workers::SplitsWorker.new(@synchronizer, @config, @splits_repository)
+      splits_worker = SSE::Workers::SplitsWorker.new(@synchronizer, @config, @splits_repository, @runtime_producer, @segment_fetcher)
       segments_worker = SSE::Workers::SegmentsWorker.new(@synchronizer, @config, @segments_repository)
       notification_manager_keeper = SSE::NotificationManagerKeeper.new(@config, @runtime_producer, @push_status_queue)
       notification_processor = SSE::NotificationProcessor.new(@config, splits_worker, segments_worker)

data/lib/splitclient-rb/sse/workers/splits_worker.rb

@@ -4,12 +4,14 @@ module SplitIoClient
   module SSE
     module Workers
       class SplitsWorker
-        def initialize(synchronizer, config, feature_flags_repository)
+        def initialize(synchronizer, config, feature_flags_repository, telemetry_runtime_producer, segment_fetcher)
           @synchronizer = synchronizer
           @config = config
           @feature_flags_repository = feature_flags_repository
           @queue = Queue.new
           @running = Concurrent::AtomicBoolean.new(false)
+          @telemetry_runtime_producer = telemetry_runtime_producer
+          @segment_fetcher = segment_fetcher
         end
 
         def start
@@ -29,7 +31,7 @@ module SplitIoClient
           end
 
           @running.make_false
-          SplitIoClient::Helpers::ThreadHelper.stop(:split_update_worker, @config)
+          Helpers::ThreadHelper.stop(:split_update_worker, @config)
         end
 
         def add_to_queue(notification)
@@ -39,38 +41,47 @@ module SplitIoClient
 
         private
 
-        def return_split_from_json(notification)
-          JSON.parse(
-            SplitIoClient::Helpers::DecryptionHelper.get_encoded_definition(
-              notification.data['c'],
-              notification.data['d']
-            ),
-            symbolize_names: true
-          )
+        def perform_thread
+          @config.threads[:split_update_worker] = Thread.new do
+            @config.logger.debug('starting feature_flags_worker ...') if @config.debug_enabled
+            perform
+          end
         end
 
-        def check_update(notification)
-          @feature_flags_repository.get_change_number == notification.data['pcn'] && !notification.data['d'].nil?
+        def perform
+          while (notification = @queue.pop)
+            @config.logger.debug("feature_flags_worker change_number dequeue #{notification.data['changeNumber']}")
+            case notification.data['type']
+            when SSE::EventSource::EventTypes::SPLIT_UPDATE
+              success = update_feature_flag(notification)
+              @synchronizer.fetch_splits(notification.data['changeNumber']) unless success
+            when SSE::EventSource::EventTypes::SPLIT_KILL
+              kill_feature_flag(notification)
+            end
+          end
         end
 
         def update_feature_flag(notification)
-          return if @feature_flags_repository.get_change_number.to_i > notification.data['changeNumber']
+          return true if @feature_flags_repository.get_change_number.to_i >= notification.data['changeNumber']
+          return false unless !notification.data['d'].nil? && @feature_flags_repository.get_change_number == notification.data['pcn']
 
-          if check_update(notification)
-            begin
-              new_split = return_split_from_json(notification)
-              if SplitIoClient::Engine::Models::Split.archived?(new_split)
-                @feature_flags_repository.remove_split(new_split)
-              else
-                @feature_flags_repository.add_split(new_split)
-              end
-              @feature_flags_repository.set_change_number(notification.data['changeNumber'])
-              return
-            rescue StandardError => e
-              @config.logger.debug("Failed to update Split: #{e.inspect}") if @config.debug_enabled
-            end
+          new_split = return_split_from_json(notification)
+          if Engine::Models::Split.archived?(new_split)
+            @feature_flags_repository.remove_split(new_split)
+          else
+            @feature_flags_repository.add_split(new_split)
+
+            fetch_segments_if_not_exists(new_split)
           end
-          @synchronizer.fetch_splits(notification.data['changeNumber'])
+
+          @feature_flags_repository.set_change_number(notification.data['changeNumber'])
+          @telemetry_runtime_producer.record_updates_from_sse(Telemetry::Domain::Constants::SPLITS)
+
+          true
+        rescue StandardError => e
+          @config.logger.debug("Failed to update Split: #{e.inspect}") if @config.debug_enabled
+
+          false
         end
 
         def kill_feature_flag(notification)
@@ -85,23 +96,18 @@ module SplitIoClient
           @synchronizer.fetch_splits(notification.data['changeNumber'])
         end
 
-        def perform
-          while (notification = @queue.pop)
-            @config.logger.debug("feature_flags_worker change_number dequeue #{notification.data['changeNumber']}")
-            case notification.data['type']
-            when SSE::EventSource::EventTypes::SPLIT_UPDATE
-              update_feature_flag(notification)
-            when SSE::EventSource::EventTypes::SPLIT_KILL
-              kill_feature_flag(notification)
-            end
-          end
+        def return_split_from_json(notification)
+          split_json = Helpers::DecryptionHelper.get_encoded_definition(notification.data['c'], notification.data['d'])
+
+          JSON.parse(split_json, symbolize_names: true)
         end
 
-        def perform_thread
-          @config.threads[:split_update_worker] = Thread.new do
-            @config.logger.debug('starting feature_flags_worker ...') if @config.debug_enabled
-            perform
-          end
+        def fetch_segments_if_not_exists(feature_flag)
+          segment_names = Helpers::Util.segment_names_by_feature_flag(feature_flag)
+          return if segment_names.nil?
+
+          @feature_flags_repository.set_segment_names(segment_names)
+          @segment_fetcher.fetch_segments_if_not_exists(segment_names)
         end
       end
     end

data/lib/splitclient-rb/telemetry/domain/constants.rb

@@ -36,6 +36,8 @@ module SplitIoClient
         TREATMENT_WITH_CONFIG = 'treatmentWithConfig'
         TREATMENTS_WITH_CONFIG = 'treatmentsWithConfig'
         TRACK = 'track'
+
+        SPLITS = 'splits'
       end
     end
   end

data/lib/splitclient-rb/telemetry/domain/structs.rb

@@ -22,11 +22,14 @@ module SplitIoClient
     # ls: lastSynchronization, ml: clientMethodLatencies, me: clientMethodExceptions, he: httpErros, hl: httpLatencies,
     # tr: tokenRefreshes, ar: authRejections, iq: impressionsQueued, ide: impressionsDeduped, idr: impressionsDropped,
     # spc: splitsCount, sec: segmentCount, skc: segmentKeyCount, sl: sessionLengthMs, eq: eventsQueued, ed: eventsDropped,
-    # se: streamingEvents, t: tags
-    Usage = Struct.new(:ls, :ml, :me, :he, :hl, :tr, :ar, :iq, :ide, :idr, :spc, :sec, :skc, :sl, :eq, :ed, :se, :t)
+    # se: streamingEvents, t: tags, ufs: updates from sse
+    Usage = Struct.new(:ls, :ml, :me, :he, :hl, :tr, :ar, :iq, :ide, :idr, :spc, :sec, :skc, :sl, :eq, :ed, :se, :t, :ufs)
 
     # t: treatment, ts: treatments, tc: treatmentWithConfig, tcs: treatmentsWithConfig, tr: track
     ClientMethodLatencies = Struct.new(:t, :ts, :tc, :tcs, :tr)
     ClientMethodExceptions = Struct.new(:t, :ts, :tc, :tcs, :tr)
+
+    # sp: splits
+    UpdatesFromSSE = Struct.new(:sp)
   end
 end

data/lib/splitclient-rb/telemetry/memory/memory_runtime_consumer.rb

@@ -94,6 +94,13 @@ module SplitIoClient
         @adapter.session_length.value
       end
 
+      def pop_updates_from_sse
+        splits = @adapter.updates_from_sse[Domain::Constants::SPLITS]
+        @adapter.updates_from_sse[Domain::Constants::SPLITS] = 0
+
+        UpdatesFromSSE.new(splits)
+      end
+
       private
 
       def find_last_synchronization(type)

data/lib/splitclient-rb/telemetry/memory/memory_runtime_producer.rb

@@ -76,6 +76,12 @@ module SplitIoClient
       rescue StandardError => e
         @config.log_found_exception(__method__.to_s, e)
       end
+
+      def record_updates_from_sse(event)
+        @adapter.updates_from_sse[event] += 1
+      rescue StandardError => e
+        @config.log_found_exception(__method__.to_s, e)
+      end
     end
   end
 end

data/lib/splitclient-rb/telemetry/memory/memory_synchronizer.rb

@@ -34,7 +34,8 @@ module SplitIoClient
                           @telemetry_runtime_consumer.events_stats(Domain::Constants::EVENTS_QUEUED),
                           @telemetry_runtime_consumer.events_stats(Domain::Constants::EVENTS_DROPPED),
                           @telemetry_runtime_consumer.pop_streaming_events,
-                          @telemetry_runtime_consumer.pop_tags)
+                          @telemetry_runtime_consumer.pop_tags,
+                          @telemetry_runtime_consumer.pop_updates_from_sse)
 
         @telemetry_api.record_stats(format_stats(usage))
       rescue StandardError => e
@@ -163,7 +164,8 @@ module SplitIoClient
           eQ: usage.eq,
           eD: usage.ed,
           sE: usage.se,
-          t: usage.t
+          t: usage.t,
+          ufs: usage.ufs.to_h
         }
       end
 

data/lib/splitclient-rb/telemetry/runtime_consumer.rb

@@ -14,7 +14,8 @@ module SplitIoClient
                      :pop_auth_rejections,
                      :pop_token_refreshes,
                      :pop_streaming_events,
-                     :session_length
+                     :session_length,
+                     :pop_updates_from_sse
 
       def initialize(config)
         @runtime = SplitIoClient::Telemetry::MemoryRuntimeConsumer.new(config)

data/lib/splitclient-rb/telemetry/runtime_producer.rb

@@ -14,7 +14,8 @@ module SplitIoClient
                      :record_auth_rejections,
                      :record_token_refreshes,
                      :record_streaming_event,
-                     :record_session_length
+                     :record_session_length,
+                     :record_updates_from_sse
 
       def initialize(config)
         @runtime = SplitIoClient::Telemetry::MemoryRuntimeProducer.new(config)

data/lib/splitclient-rb/telemetry/storages/memory.rb

@@ -16,7 +16,8 @@ module SplitIoClient
                     :auth_rejections,
                     :token_refreshes,
                     :streaming_events,
-                    :session_length
+                    :session_length,
+                    :updates_from_sse
 
         def initialize
           init_latencies
@@ -32,6 +33,7 @@ module SplitIoClient
           init_streaming_events
           init_session_length
           init_tags
+          init_updates_from_sse
         end
 
         def init_latencies
@@ -133,6 +135,12 @@ module SplitIoClient
         def init_session_length
           @session_length = Concurrent::AtomicFixnum.new(0)
         end
+
+        def init_updates_from_sse
+          @updates_from_sse = Concurrent::Hash.new
+
+          @updates_from_sse[Domain::Constants::SPLITS] = 0
+        end
       end
     end
   end

data/lib/splitclient-rb/version.rb

@@ -1,3 +1,3 @@
 module SplitIoClient
-  VERSION = '8.1.3.pre.rc3'
+  VERSION = '8.2.0'
 end

data/lib/splitclient-rb.rb

@@ -42,6 +42,7 @@ require 'splitclient-rb/clients/split_client'
 require 'splitclient-rb/managers/split_manager'
 require 'splitclient-rb/helpers/thread_helper'
 require 'splitclient-rb/helpers/decryption_helper'
+require 'splitclient-rb/helpers/util'
 require 'splitclient-rb/split_factory'
 require 'splitclient-rb/split_factory_builder'
 require 'splitclient-rb/split_config'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splitclient-rb
 version: !ruby/object:Gem::Version
-  version: 8.1.3.pre.rc3
+  version: 8.2.0
 platform: ruby
 authors:
 - Split Software
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-28 00:00:00.000000000 Z
+date: 2023-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: allocation_stats
@@ -410,6 +410,7 @@ extensions:
 - ext/murmurhash/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/CODEOWNERS"
 - ".github/pull_request_template.md"
 - ".github/workflows/ci.yml"
 - ".github/workflows/update-license-year.yml"
@@ -519,6 +520,7 @@ files:
 - lib/splitclient-rb/exceptions.rb
 - lib/splitclient-rb/helpers/decryption_helper.rb
 - lib/splitclient-rb/helpers/thread_helper.rb
+- lib/splitclient-rb/helpers/util.rb
 - lib/splitclient-rb/managers/split_manager.rb
 - lib/splitclient-rb/split_config.rb
 - lib/splitclient-rb/split_factory.rb
@@ -577,9 +579,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.3
 signing_key: