splitclient-rb 2.0.1 → 3.0.2

data/lib/engine/api/client.rb

@@ -0,0 +1,29 @@
+module SplitIoClient
+  module Api
+    class Client
+      def call_api(path, config, api_key, params = {})
+        api_client.get(config.base_uri + path, params) do |req|
+          req.headers['Authorization'] = 'Bearer ' + api_key
+          req.headers['SplitSDKVersion'] = SplitIoClient::SplitFactory.sdk_version
+          req.headers['SplitSDKMachineName'] = config.machine_name
+          req.headers['SplitSDKMachineIP'] = config.machine_ip
+          req.headers['Accept-Encoding'] = 'gzip'
+
+          req.options.open_timeout = config.connection_timeout
+          req.options.timeout = config.read_timeout
+
+          config.logger.debug("GET #{config.base_uri + path}") if config.debug_enabled
+        end
+      end
+
+      private
+
+      def api_client
+        @api_client ||= Faraday.new do |builder|
+          builder.use FaradayMiddleware::Gzip
+          builder.adapter :net_http_persistent
+        end
+      end
+    end
+  end
+end

data/lib/engine/api/segments.rb

@@ -0,0 +1,60 @@
+module SplitIoClient
+  module Api
+    class Segments < Client
+      def initialize(api_key, config, metrics, segments_repository)
+        @config = config
+        @metrics = metrics
+        @api_key = api_key
+        @segments_repository = segments_repository
+      end
+
+      def store_segments_by_names(names)
+        start = Time.now
+        prefix = 'segmentChangeFetcher'
+
+        return if names.nil? || names.empty?
+
+        names.each do |name|
+          since = @segments_repository.get_change_number(name)
+          while true
+            fetch_segments(name, prefix, since).each { |segment| @segments_repository.add_to_segment(segment) }
+            @config.logger.debug("Segment #{name} fetched before: #{since}, till: #{@segments_repository.get_change_number(name)}") if @config.debug_enabled
+
+            break if (since.to_i >= @segments_repository.get_change_number(name).to_i)
+            since = @segments_repository.get_change_number(name)
+          end
+        end
+
+        latency = (Time.now - start) * 1000.0
+        @metrics.time(prefix + '.time', latency)
+      end
+
+      private
+
+      def fetch_segments(name, prefix, since)
+        segments = []
+        segment = call_api('/segmentChanges/' + name, @config, @api_key, { since: since })
+
+        if segment.status / 100 == 2
+          segment_content = JSON.parse(segment.body, symbolize_names: true)
+          @segments_repository.set_change_number(name, segment_content[:till])
+          @metrics.count(prefix + '.status.' + segment.status.to_s, 1)
+
+          if @config.debug_enabled
+            @config.logger.debug("\'#{segment_content[:name]}\' segment retrieved.")
+            @config.logger.debug("\'#{segment_content[:name]}\' #{segment_content[:added].size} added keys") if segment_content[:added].size > 0
+            @config.logger.debug("\'#{segment_content[:name]}\' #{segment_content[:removed].size} removed keys") if segment_content[:removed].size > 0
+          end
+          @config.logger.debug("#{segment_content}") if @config.transport_debug_enabled
+
+          segments << segment_content
+        else
+          @config.logger.error('Unexpected result from API call')
+          @metrics.count(prefix + '.status.' + segment.status.to_s, 1)
+        end
+
+        segments
+      end
+    end
+  end
+end

data/lib/engine/api/splits.rb

@@ -0,0 +1,58 @@
+module SplitIoClient
+  module Api
+    class Splits < Client
+      def initialize(api_key, config, metrics)
+        @api_key = api_key
+        @config = config
+        @metrics = metrics
+      end
+
+      def since(since)
+        start = Time.now
+        prefix = 'splitChangeFetcher'
+        splits = call_api('/splitChanges', @config, @api_key, {:since => since})
+
+        if splits.status / 100 == 2
+          result = splits_with_segment_names(splits.body)
+
+          @metrics.count(prefix + '.status.' + splits.status.to_s, 1)
+
+          @config.logger.debug("#{result[:splits].length} splits retrieved. since=#{since}") if @config.debug_enabled and result[:splits].length > 0
+          @config.logger.debug("#{result}") if @config.transport_debug_enabled
+        else
+          @metrics.count(prefix + '.status.' + splits.status.to_s, 1)
+
+          @config.logger.error('Unexpected result from API call')
+        end
+
+        latency = (Time.now - start) * 1000.0
+        @metrics.time(prefix + '.time', latency)
+
+        result
+      end
+
+      private
+
+      def splits_with_segment_names(splits_json)
+        parsed_splits = JSON.parse(splits_json, symbolize_names: true)
+
+        parsed_splits[:segment_names] =
+          parsed_splits[:splits].each_with_object(Set.new) do |split, splits|
+            splits << segment_names(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-engine → engine}/matchers/between_matcher.rb

@@ -18,6 +18,8 @@ module SplitIoClient
         param_value = get_formatted_value(attributes[@attribute.to_sym])
         matches = param_value.is_a?(Integer) ? ((param_value >= @start_value) && (param_value <= @end_value)) : false
       end
+
+      matches
     end
 
     def equals?(obj)

data/lib/{splitclient-engine → engine}/matchers/combining_matcher.rb

@@ -1,4 +1,4 @@
-require 'splitclient-engine/matchers/combiners'
+require 'engine/matchers/combiners'
 
 module SplitIoClient
   #

data/lib/{splitclient-engine → engine}/matchers/user_defined_segment_matcher.rb

@@ -7,13 +7,10 @@ module SplitIoClient
 
     attr_reader :matcher_type
 
-    @segment = nil
-
-    def initialize(segment)
+    def initialize(segments_repository, segment_name)
       @matcher_type = "IN_SEGMENT"
-      unless segment.nil?
-        @segment = segment
-      end
+      @segments_repository = segments_repository
+      @segment_name = segment_name
     end
 
     #
@@ -23,11 +20,7 @@ module SplitIoClient
     #
     # @return [boolean] evaluation of the key against the segment
     def match?(key, attributes)
-      matches = false
-      unless @segment.users.nil?
-        matches = @segment.users.include?(key)
-      end
-      matches
+      @segments_repository.in_segment?(@segment_name, key)
     end
 
     #
@@ -47,15 +40,5 @@ module SplitIoClient
         false
       end
     end
-
-    #
-    # function to print string value for this matcher
-    #
-    # @reutrn [string] string value of this matcher
-    def to_s
-      'in segment ' + @segment.name
-    end
-
   end
-
 end

data/lib/{splitclient-engine → engine}/parser/condition.rb

@@ -45,9 +45,9 @@ module SplitIoClient
     #returns UserDefinedSegmentMatcher[object]
     def matcher_in_segment params
       matcher = params[:matcher]
-      segments = params[:segments]
-      segment = segments.get_segment(matcher[:userDefinedSegmentMatcherData][:segmentName])
-      segment.is_empty? ? UserDefinedSegmentMatcher.new(nil) : UserDefinedSegmentMatcher.new(segment)
+      segment_name = matcher[:userDefinedSegmentMatcherData] && matcher[:userDefinedSegmentMatcherData][:segmentName]
+
+      UserDefinedSegmentMatcher.new(params[:segments_repository], segment_name)
     end
 
     #returns WhitelistMatcher[object] the whitelist for this condition in case it has a whitelist matcher
@@ -125,10 +125,8 @@ module SplitIoClient
 
     #
     # @return [boolean] true if the condition is empty false otherwise
-    def is_empty?
-      @data.empty? ? true : false
+    def empty?
+      @data.empty?
     end
-
   end
-
 end

data/lib/{splitclient-engine → engine}/parser/split.rb

@@ -46,8 +46,8 @@ module SplitIoClient
 
     #
     # @return [boolean] true if the condition is empty false otherwise
-    def is_empty?
-      @data.empty? ? true : false
+    def empty?
+      @data.empty?
     end
 
     #
@@ -63,6 +63,14 @@ module SplitIoClient
       conditions_list
     end
 
+    def to_h
+      {
+        name: name,
+        seed: seed,
+        status: status,
+        killed: killed?,
+        conditions: conditions
+      }
+    end
   end
-
 end

data/lib/{splitclient-engine → engine}/parser/split_adapter.rb

@@ -31,21 +31,26 @@ module SplitIoClient
 
     attr_reader :impressions_producer
 
+    attr_reader :splits_repository, :segments_repository
+
     #
     # Creates a new split api adapter instance that consumes split api endpoints
     #
     # @param api_key [String] the API key for your split account
     #
     # @return [SplitIoClient] split.io client instance
-    def initialize(api_key, config)
+    def initialize(api_key, config, splits_repository, segments_repository, sdk_blocker)
 
       @api_key = api_key
       @config = config
-      @parsed_splits = SplitParser.new(@config.logger)
-      @parsed_segments = SegmentParser.new(@config.logger)
       @impressions = Impressions.new(100)
       @metrics = Metrics.new(100)
 
+      @splits_repository = splits_repository
+      @segments_repository = segments_repository
+
+      @sdk_blocker = sdk_blocker
+
       @api_client = Faraday.new do |builder|
         builder.use FaradayMiddleware::Gzip
         builder.adapter :net_http_persistent
@@ -55,6 +60,7 @@ module SplitIoClient
       @segments_consumer = create_segments_api_consumer
       @metrics_producer = create_metrics_api_producer
       @impressions_producer = create_impressions_api_producer
+
     end
 
     #
@@ -64,78 +70,11 @@ module SplitIoClient
     #
     # @return [void]
     def create_splits_api_consumer
-      Thread.new do
-        loop do
-          begin
-            #splits fetcher
-            splits_arr = []
-            data = get_splits(@parsed_splits.since)
-            if data
-              data[:splits].each do |split|
-                splits_arr << SplitIoClient::Split.new(split)
-              end
-            end
-
-            if @parsed_splits.is_empty?
-              @parsed_splits.splits = splits_arr
-            else
-              refresh_splits(splits_arr)
-            end
-            @parsed_splits.since = data[:till]
-
-            random_interval = randomize_interval @config.features_refresh_rate
-            sleep(random_interval)
-          rescue StandardError => error
-            @config.log_found_exception(__method__.to_s, error)
-          end
-        end
-      end
+      SplitIoClient::Cache::Stores::SplitStore.new(@splits_repository, @config, @api_key, @metrics, @sdk_blocker).call
     end
 
     def create_segments_api_consumer
-      Thread.new do
-        loop do
-          begin
-            #segments fetcher
-            segments_arr = []
-            segment_data = get_segments(@parsed_splits.get_used_segments)
-            segment_data.each do |segment|
-              segments_arr << SplitIoClient::Segment.new(segment)
-            end
-            if @parsed_segments.is_empty?
-              @parsed_segments.segments = segments_arr
-              @parsed_segments.segments.map { |s| s.refresh_users(s.added, s.removed) }
-            else
-              refresh_segments(segments_arr)
-            end
-
-            random_interval = randomize_interval @config.segments_refresh_rate
-            sleep(random_interval)
-          rescue StandardError => error
-            @config.log_found_exception(__method__.to_s, error)
-          end
-        end
-      end
-    end
-
-    #
-    # helper method to execute a get request to the provided endpoint
-    #
-    # @param path [string] api endpoint path
-    # @param params [object] hash of params that will be added to the request
-    #
-    # @return [object] response to the request
-    def call_api(path, params = {})
-      @api_client.get @config.base_uri + path, params do |req|
-        req.headers['Authorization'] = 'Bearer ' + @api_key
-        req.headers['SplitSDKVersion'] = SplitIoClient::SplitFactory.sdk_version
-        req.headers['SplitSDKMachineName'] = @config.machine_name
-        req.headers['SplitSDKMachineIP'] = @config.machine_ip
-        req.headers['Accept-Encoding'] = 'gzip'
-        req.options.open_timeout = @config.connection_timeout
-        req.options.timeout = @config.read_timeout
-        @config.logger.debug("GET #{@config.base_uri + path}") if @config.debug_enabled
-      end
+      SplitIoClient::Cache::Stores::SegmentStore.new(@segments_repository, @config, @api_key, @metrics, @sdk_blocker).call
     end
 
     #
@@ -159,105 +98,6 @@ module SplitIoClient
       end
     end
 
-    #
-    # helper method to fetch splits by using the appropriate api endpoint
-    #
-    # @param since [int] since value for the last fetch
-    #
-    # @return splits [object] splits structure in json format
-    def get_splits(since)
-      result = nil
-      start = Time.now
-      prefix = 'splitChangeFetcher'
-
-      splits = call_api('/splitChanges', {:since => since})
-
-      if splits.status / 100 == 2
-        result = JSON.parse(splits.body, symbolize_names: true)
-        @metrics.count(prefix + '.status.' + splits.status.to_s, 1)
-        @config.logger.info("#{result[:splits].length} splits retrieved.")
-        @config.logger.debug("#{result}") if @config.debug_enabled
-      else
-        @config.logger.error('Unexpected result from API call')
-        @metrics.count(prefix + '.status.' + splits.status.to_s, 1)
-      end
-
-      latency = (Time.now - start) * 1000.0
-      @metrics.time(prefix + '.time', latency)
-
-      result
-    end
-
-    #
-    # helper method to refresh splits values after a new fetch with changes
-    #
-    # @param splits_arr [object] array of splits to refresh
-    #
-    # @return [void]
-    def refresh_splits(splits_arr)
-      feature_names = splits_arr.map { |s| s.name }
-      @parsed_splits.splits.delete_if { |sp| feature_names.include?(sp.name) }
-      @parsed_splits.splits += splits_arr
-    end
-
-    #
-    # helper method to fetch segments by using the appropriate api endpoint
-    #
-    # @param names [object] array of segment names that must be fetched
-    #
-    # @return segments [object] segments structure in json format
-    def get_segments(names)
-      segments = []
-      start = Time.now
-      prefix = 'segmentChangeFetcher'
-
-      names.each do |name|
-        curr_segment = @parsed_segments.get_segment(name)
-        since = curr_segment.nil? ? -1 : curr_segment.till
-
-        while true
-          segment = call_api('/segmentChanges/' + name, {:since => since})
-
-          if segment.status / 100 == 2
-            segment_content = JSON.parse(segment.body, symbolize_names: true)
-            @parsed_segments.since = segment_content[:till]
-            @metrics.count(prefix + '.status.' + segment.status.to_s, 1)
-            @config.logger.info("\'#{segment_content[:name]}\' segment retrieved.")
-            @config.logger.debug("#{segment_content}") if @config.debug_enabled
-            segments << segment_content
-          else
-            @config.logger.error('Unexpected result from API call')
-            @metrics.count(prefix + '.status.' + segment.status.to_s, 1)
-          end
-          break if (since.to_i >= @parsed_segments.since.to_i)
-          since = @parsed_segments.since
-        end
-      end
-
-      latency = (Time.now - start) * 1000.0
-      @metrics.time(prefix + '.time', latency)
-
-      segments
-    end
-
-    #
-    # helper method to refresh segments values after a new fetch with changes
-    #
-    # @param segments_arr [object] array of segments to refresh
-    #
-    # @return [void]
-    def refresh_segments(segments_arr)
-      segment_names = @parsed_segments.segments.map { |s| s.name }
-      segments_arr.each do |s|
-        if segment_names.include?(s.name)
-          segment_to_update = @parsed_segments.get_segment(s.name)
-          segment_to_update.refresh_users(s.added, s.removed)
-        else
-          @parsed_segments.segments << s
-        end
-      end
-    end
-
     #
     # @return parsed_splits [object] parsed splits for this adapter
     def parsed_splits
@@ -315,7 +155,7 @@ module SplitIoClient
     # @return [void]
     def post_impressions
       if @impressions.queue.empty?
-        @config.logger.info('No impressions to report.')
+        @config.logger.debug('No impressions to report.') if @config.debug_enabled
       else
         popped_impressions = @impressions.clear
         test_impression_array = []
@@ -333,7 +173,7 @@ module SplitIoClient
           end
 
           if filtered.empty?
-            @config.logger.info('No impressions to report post filtering.')
+            @config.logger.debug('No impressions to report post filtering.') if @config.debug_enabled
           else
             test_impression = {}
             key_impressions = []
@@ -351,8 +191,7 @@ module SplitIoClient
         if res.status / 100 != 2
           @config.logger.error("Unexpected status code while posting impressions: #{res.status}")
         else
-          @config.logger.info("Impressions reported.")
-          @config.logger.debug("#{test_impression_array}")if @config.debug_enabled
+          @config.logger.debug("Impressions reported: #{test_impression_array}") if @config.debug_enabled
         end
       end
     end
@@ -365,7 +204,7 @@ module SplitIoClient
     # @return [void]
     def post_metrics
       if @metrics.latencies.empty?
-        @config.logger.info('No latencies to report.')
+        @config.logger.debug('No latencies to report.') if @config.debug_enabled
       else
         @metrics.latencies.each do |l|
           metrics_time = {}
@@ -374,15 +213,14 @@ module SplitIoClient
           if res.status / 100 != 2
             @config.logger.error("Unexpected status code while posting time metrics: #{res.status}")
           else
-            @config.logger.info("Metric time reported.")
-            @config.logger.debug("#{metrics_time}") if @config.debug_enabled
+            @config.logger.debug("Metric time reported: #{metrics_time}") if @config.debug_enabled
           end
         end
       end
       @metrics.latencies.clear
 
       if @metrics.counts.empty?
-        @config.logger.info('No counts to report.')
+        @config.logger.debug('No counts to report.') if @config.debug_enabled
       else
         @metrics.counts.each do |c|
           metrics_count = {}
@@ -391,15 +229,14 @@ module SplitIoClient
           if res.status / 100 != 2
             @config.logger.error("Unexpected status code while posting count metrics: #{res.status}")
           else
-            @config.logger.info("Metric counts reported.")
-            @config.logger.debug("#{metrics_count}") if @config.debug_enabled
+            @config.logger.debug("Metric counts reported: #{metrics_count}") if @config.debug_enabled
           end
         end
       end
       @metrics.counts.clear
 
       if @metrics.gauges.empty?
-        @config.logger.info('No gauges to report.')
+        @config.logger.debug('No gauges to report.') if @config.debug_enabled
       else
         @metrics.gauges.each do |g|
           metrics_gauge = {}
@@ -408,8 +245,7 @@ module SplitIoClient
           if res.status / 100 != 2
             @config.logger.error("Unexpected status code while posting gauge metrics: #{res.status}")
           else
-            @config.logger.info("Metric gauge reported.")
-            @config.logger.debug("#{metrics_gauge}") if @config.debug_enabled
+            @config.logger.debug("Metric gauge reported: #{metrics_gauge}") if @config.debug_enabled
           end
         end
       end