Added old spec support

chillaq · chillaq · commit 61e502f817c6 · 2025-05-14T21:12:00.000-07:00
diff --git a/lib/splitclient-rb/cache/fetchers/split_fetcher.rb b/lib/splitclient-rb/cache/fetchers/split_fetcher.rb
@@ -25,8 +25,8 @@ def call
         def fetch_splits(fetch_options = { cache_control_headers: false, till: nil })
           @semaphore.synchronize do
             data = splits_since(@splits_repository.get_change_number, @rule_based_segments_repository.get_change_number, fetch_options)
-            SplitIoClient::Helpers::RepositoryHelper.update_feature_flag_repository(@splits_repository, data[:ff][:d], data[:ff][:t], @config)
-            SplitIoClient::Helpers::RepositoryHelper.update_rule_based_segment_repository(@rule_based_segments_repository, data[:rbs][:d], data[:rbs][:t], @config)
+            SplitIoClient::Helpers::RepositoryHelper.update_feature_flag_repository(@splits_repository, data[:ff][:d], data[:ff][:t], @config, @splits_api.clear_storage)
+            SplitIoClient::Helpers::RepositoryHelper.update_rule_based_segment_repository(@rule_based_segments_repository, data[:rbs][:d], data[:rbs][:t], @config, @splits_api.clear_storage)
             @splits_repository.set_segment_names(data[:segment_names])
             @rule_based_segments_repository.set_segment_names(data[:segment_names])
             @config.logger.debug("segments seen(#{data[:segment_names].length}): #{data[:segment_names].to_a}") if @config.debug_enabled
diff --git a/lib/splitclient-rb/engine/api/client.rb b/lib/splitclient-rb/engine/api/client.rb
@@ -50,6 +50,9 @@ def post_api(url, api_key, data, headers = {}, params = {})
         raise e, 'Split SDK failed to connect to backend to post information', e.backtrace
       end
 
+      def sdk_url_overriden?
+        @config.sdk_url_overriden?
+      end
       private
 
       def api_client
diff --git a/lib/splitclient-rb/engine/api/splits.rb b/lib/splitclient-rb/engine/api/splits.rb
@@ -5,28 +5,68 @@ module Api
     # Retrieves split definitions from the Split Backend
     class Splits < Client
 
+      PROXY_CHECK_INTERVAL_SECONDS = 24 * 60 * 60
+      SPEC_1_1 = "1.1"
+
       def initialize(api_key, config, telemetry_runtime_producer)
         super(config)
         @api_key = api_key
         @telemetry_runtime_producer = telemetry_runtime_producer
         @flag_sets_filter = @config.flag_sets_filter
+        @spec_version = SplitIoClient::Spec::FeatureFlags::SPEC_VERSION
+        @last_proxy_check_timestamp = 0
+        @clear_storage = false
       end
 
       def since(since, since_rbs, fetch_options = { cache_control_headers: false, till: nil, sets: nil})
         start = Time.now
+        
+        if check_last_proxy_check_timestamp
+            puts "switching to new spec"
+            @spec_version = SplitIoClient::Spec::FeatureFlags::SPEC_VERSION
+            @config.logger.debug("Switching to new Feature flag spec #{@spec_version} and fetching.")
+            since = -1
+            since_rbs = -1
+            fetch_options = { cache_control_headers: false, till: nil, sets: nil}
+        end
+
+        if @spec_version == Splits::SPEC_1_1
+          params = { s: @spec_version, since: since }
+        else
+          params = { s: @spec_version, since: since, rbSince: since_rbs }
+        end
 
-        params = { s: SplitIoClient::Spec::FeatureFlags::SPEC_VERSION, since: since, rbSince: since_rbs }
         params[:sets] = @flag_sets_filter.join(",") unless @flag_sets_filter.empty?
         params[:till] = fetch_options[:till] unless fetch_options[:till].nil?
         @config.logger.debug("Fetching from splitChanges with #{params}: ")
         response = get_api("#{@config.base_uri}/splitChanges", @api_key, params, fetch_options[:cache_control_headers])
+
         if response.status == 414
           @config.logger.error("Error fetching feature flags; the amount of flag sets provided are too big, causing uri length error.")
           raise ApiException.new response.body, 414
         end
+
+        if response.status == 400 and sdk_url_overriden? and @spec_version == SplitIoClient::Spec::FeatureFlags::SPEC_VERSION
+            @config.logger.warn("Detected proxy response error, changing spec version from #{@spec_version} to #{Splits::SPEC_1_1} and re-fetching.")
+            @spec_version = Splits::SPEC_1_1
+            @last_proxy_check_timestamp = Time.now
+            return since(since, 0, fetch_options = {cache_control_headers: fetch_options[:cache_control_headers], till: fetch_options[:till],
+                sets: fetch_options[:sets]})          
+        end
+
         if response.success?
-          result = objects_with_segment_names(response.body)
+          result = JSON.parse(response.body, symbolize_names: true)
+          if @spec_version == Splits::SPEC_1_1
+            result = convert_to_newSPEC(result)
+          end
+          
+          result = objects_with_segment_names(result)
           
+          if @spec_version == SplitIoClient::Spec::FeatureFlags::SPEC_VERSION
+            @clear_storage = @last_proxy_check_timestamp != 0
+            @last_proxy_check_timestamp = 0
+          end
+
           unless result[:ff][:d].empty?
             @config.split_logger.log_if_debug("#{result[:ff][:d].length} feature flags retrieved. since=#{since}")
           end
@@ -52,10 +92,13 @@ def since(since, since_rbs, fetch_options = { cache_control_headers: false, till
         end
       end
 
+      def clear_storage
+        @clear_storage
+      end
+
       private
 
-      def objects_with_segment_names(objects_json)
-        parsed_objects = JSON.parse(objects_json, symbolize_names: true)
+      def objects_with_segment_names(parsed_objects)
         parsed_objects[:segment_names] = Set.new
         parsed_objects[:segment_names] =
           parsed_objects[:ff][:d].each_with_object(Set.new) do |split, splits|
@@ -76,6 +119,14 @@ def objects_with_segment_names(objects_json)
         
         parsed_objects
       end
+
+      def check_last_proxy_check_timestamp
+        @spec_version == Splits::SPEC_1_1 and ((Time.now - @last_proxy_check_timestamp) >= Splits::PROXY_CHECK_INTERVAL_SECONDS)
+      end
+
+      def convert_to_newSPEC(body)
+        {:ff => {:d => body[:splits], :s => body[:since], :t => body[:till]}, :rbs => {:d => [], :s => -1, :t => -1}}
+      end
     end
   end
 end
diff --git a/lib/splitclient-rb/helpers/repository_helper.rb b/lib/splitclient-rb/helpers/repository_helper.rb
@@ -3,7 +3,7 @@
 module SplitIoClient
   module Helpers
     class RepositoryHelper
-      def self.update_feature_flag_repository(feature_flag_repository, feature_flags, change_number, config)
+      def self.update_feature_flag_repository(feature_flag_repository, feature_flags, change_number, config, clear_storage)
         to_add = []
         to_delete = []
         feature_flags.each do |feature_flag|
@@ -23,10 +23,11 @@ def self.update_feature_flag_repository(feature_flag_repository, feature_flags,
           config.logger.debug("storing feature flag (#{feature_flag[:name]})") if config.debug_enabled
           to_add.push(feature_flag)
         end
+        feature_flag_repository.clear if clear_storage
         feature_flag_repository.update(to_add, to_delete, change_number)
       end
 
-      def self.update_rule_based_segment_repository(rule_based_segment_repository, rule_based_segments, change_number, config)
+      def self.update_rule_based_segment_repository(rule_based_segment_repository, rule_based_segments, change_number, config, clear_storage)
         to_add = []
         to_delete = []
         rule_based_segments.each do |rule_based_segment|
@@ -39,6 +40,8 @@ def self.update_rule_based_segment_repository(rule_based_segment_repository, rul
           config.logger.debug("storing rule based segment (#{rule_based_segment[:name]})") if config.debug_enabled
           to_add.push(rule_based_segment)
         end
+        rule_based_segment_repository.clear if clear_storage
+
         rule_based_segment_repository.update(to_add, to_delete, change_number)
       end
     end
diff --git a/lib/splitclient-rb/split_config.rb b/lib/splitclient-rb/split_config.rb
@@ -645,6 +645,10 @@ def consumer?
       @mode.equal?(:consumer)
     end
 
+    def sdk_url_overriden?
+      return @base_uri != SplitConfig.default_base_uri
+    end
+    
     #
     # gets the hostname where the sdk gem is running
     #
diff --git a/lib/splitclient-rb/sse/workers/splits_worker.rb b/lib/splitclient-rb/sse/workers/splits_worker.rb
@@ -71,7 +71,7 @@ def update_feature_flag(notification)
           new_split = return_object_from_json(notification)
           SplitIoClient::Helpers::RepositoryHelper.update_feature_flag_repository(@feature_flags_repository,
                                                                                   [new_split],
-                                                                                  notification.data['changeNumber'], @config)
+                                                                                  notification.data['changeNumber'], @config, false)
           fetch_segments_if_not_exists(Helpers::Util.segment_names_by_object(new_split, "IN_SEGMENT"), @feature_flags_repository)
           if fetch_rule_based_segments_if_not_exists(Helpers::Util.segment_names_by_object(new_split, "IN_RULE_BASED_SEGMENT"), notification.data['changeNumber'])
             return true
@@ -93,7 +93,7 @@ def update_rule_based_segment(notification)
           new_rb_segment = return_object_from_json(notification)
           SplitIoClient::Helpers::RepositoryHelper.update_rule_based_segment_repository(@rule_based_segment_repository,
                                                                                   [new_rb_segment],
-                                                                                  notification.data['changeNumber'], @config)
+                                                                                  notification.data['changeNumber'], @config, false)
           fetch_segments_if_not_exists(Helpers::Util.segment_names_by_object(new_rb_segment, "IN_SEGMENT"), @rule_based_segment_repository)
 
 # TODO: enable when telemetry spec is added
diff --git a/spec/engine/api/splits_spec.rb b/spec/engine/api/splits_spec.rb
@@ -21,7 +21,7 @@
       stub_request(:get, 'https://sdk.split.io/api/splitChanges?s=1.3&since=-1&rbSince=-1')
         .to_return(status: 200, body: splits)
 
-      parsed_splits = splits_api.send(:objects_with_segment_names, splits)
+      parsed_splits = splits_api.send(:objects_with_segment_names, JSON.parse(splits, symbolize_names: true))
 
       expect(parsed_splits[:segment_names]).to eq(Set.new(%w[demo employees]))
     end
@@ -183,4 +183,53 @@
       )
     end
   end
+
+  context 'old spec tests' do
+    let(:old_spec_splits) { File.read(File.expand_path(File.join(File.dirname(__FILE__), '../../test_data/rule_based_segments/split_old_spec.json'))) }
+    let(:config) do
+      SplitIoClient::SplitConfig.new(
+        logger: Logger.new(log),
+        debug_enabled: true,
+        transport_debug_enabled: true,
+        base_uri: "https://proxy-server/api"
+      )
+    end
+    let(:log) { StringIO.new }
+    let(:telemetry_runtime_producer) { SplitIoClient::Telemetry::RuntimeProducer.new(config) }
+    let(:splits_api) { described_class.new('', config, telemetry_runtime_producer) }
+
+    it 'switch to old spec url whith proper conditions' do
+      stub_request(:get, 'https://proxy-server/api/splitChanges?s=1.3&since=-1&rbSince=-1')
+        .to_return(status: 400, body: '')
+      stub_request(:get, 'https://proxy-server/api/splitChanges?s=1.1&since=-1')
+        .to_return(status: 200, body: old_spec_splits)
+
+      parsed_splits = splits_api.since(-1, -1)
+
+      expect(parsed_splits[:ff][:d].length()).to eq(7)
+      expect(parsed_splits[:ff][:t]).to eq(1457726098069)
+      expect(parsed_splits[:ff][:s]).to eq(-1)
+      expect(parsed_splits[:rbs]).to eq({:d => [], :s => -1, :t => -1})
+      expect(splits_api.clear_storage).to eq(false)
+    end
+
+    it 'check new spec after last proxy timestamp expires' do
+      stub_request(:get, 'https://proxy-server/api/splitChanges?s=1.3&since=-1&rbSince=-1')
+        .to_return({status: 400, body: ''}, {status: 200, body: splits})
+      stub_request(:get, 'https://proxy-server/api/splitChanges?s=1.1&since=-1')
+        .to_return(status: 200, body: old_spec_splits)
+
+      parsed_splits = splits_api.since(-1, -1)
+      expect(parsed_splits[:ff][:d].length()).to eq(7)
+      expect(splits_api.instance_variable_get(:@spec_version)).to eq(SplitIoClient::Api::Splits::SPEC_1_1)
+
+      SplitIoClient::Api::Splits::PROXY_CHECK_INTERVAL_SECONDS = 1
+      sleep 1
+      parsed_splits = splits_api.since(-1, -1)
+      expect(splits_api.clear_storage).to eq(true)
+      expect(parsed_splits[:ff][:d].length()).to eq(2)
+      expect(parsed_splits[:rbs][:d].length()).to eq(1)
+      expect(splits_api.instance_variable_get(:@spec_version)).to eq(SplitIoClient::Spec::FeatureFlags::SPEC_VERSION)
+    end
+  end
 end
diff --git a/spec/integrations/old_spec_client_spec.rb b/spec/integrations/old_spec_client_spec.rb
@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe SplitIoClient do
+  context 'old spec tests' do
+    let(:old_spec_splits) { File.read(File.expand_path(File.join(File.dirname(__FILE__), '../test_data/rule_based_segments/split_old_spec.json'))) }
+
+    it 'check new spec after last proxy timestamp expires' do
+      splits_rbs = File.read(File.join(SplitIoClient.root, 'spec/test_data/rule_based_segments/rule_base_segments.json'))
+
+      stub_request(:get, 'https://proxy-server/api/splitChanges?s=1.3&since=-1&rbSince=-1')
+        .to_return({status: 400, body: ''}, {status: 200, body: splits_rbs})
+      stub_request(:get, "https://sdk.split.io/api/splitChanges?rbSince=1506703262916&s=1.3&since=1506703262916")
+        .to_return(status: 200, body: '')
+        stub_request(:get, 'https://proxy-server/api/splitChanges?s=1.1&since=-1')
+        .to_return(status: 200, body: old_spec_splits)
+      stub_request(:get, "https://proxy-server/api/splitChanges?s=1.1&since=1457726098069")
+        .to_return(status: 200, body: '')
+      stub_request(:post, "https://telemetry.split.io/api/v1/metrics/config")
+        .to_return(status: 200, body: '')
+
+      factory_old_spec =
+        SplitIoClient::SplitFactory.new('test_api_key',
+          {impressions_mode: :none,
+          features_refresh_rate: 2,
+          base_uri: "https://proxy-server/api",
+          streaming_enabled: false})
+
+      SplitIoClient::Api::Splits::PROXY_CHECK_INTERVAL_SECONDS = 1
+      client_old_spec = factory_old_spec.client
+      client_old_spec.block_until_ready
+      expect(client_old_spec.get_treatment('whitelisted_user', 'whitelist_feature')).to eq('on')
+
+      sleep 1
+      split_fetcher = factory_old_spec.instance_variable_get(:@split_fetcher)
+      split_fetcher.fetch_splits
+      sleep 1
+      expect(client_old_spec.get_treatment('bilal@split.io', 'rbs_feature_flag', {:email => 'bilal@split.io'})).to eq('on')
+    end
+  end
+end
diff --git a/spec/test_data/rule_based_segments/split_old_spec.json b/spec/test_data/rule_based_segments/split_old_spec.json
@@ -141,70 +141,6 @@
           ],
           "sets": ["set3"]
       },
-      {
-          "orgId": null,
-          "environment": null,
-          "trafficTypeId": null,
-          "trafficTypeName": null,
-          "name": "sample_feature",
-          "seed": 1548363147,
-          "status": "ACTIVE",
-          "killed": false,
-          "changeNumber": 123,
-          "defaultTreatment": "off",
-          "configurations": {
-              "on": "{\"size\":15,\"test\":20}"
-          },
-          "conditions": [
-              {
-                  "matcherGroup": {
-                      "combiner": "AND",
-                      "matchers": [
-                          {
-                              "matcherType": "IN_SEGMENT",
-                              "negate": false,
-                              "userDefinedSegmentMatcherData": {
-                                  "segmentName": "employees"
-                              },
-                              "whitelistMatcherData": null
-                          }
-                      ]
-                  },
-                  "partitions": [
-                      {
-                          "treatment": "on",
-                          "size": 100
-                      }
-                  ]
-              },
-              {
-                  "matcherGroup": {
-                      "combiner": "AND",
-                      "matchers": [
-                          {
-                              "matcherType": "IN_SEGMENT",
-                              "negate": false,
-                              "userDefinedSegmentMatcherData": {
-                                  "segmentName": "human_beigns"
-                              },
-                              "whitelistMatcherData": null
-                          }
-                      ]
-                  },
-                  "partitions": [
-                      {
-                          "treatment": "on",
-                          "size": 30
-                      },
-                      {
-                          "treatment": "off",
-                          "size": 70
-                      }
-                  ]
-              }
-          ],
-          "sets": ["set1"]
-      },
       {
           "orgId": null,
           "environment": null,

Original file line number	Diff line number	Diff line change
`@@ -645,6 +645,10 @@ def consumer?`
`645`	`645`	`@mode.equal?(:consumer)`
`646`	`646`	`end`
`647`	`647`
	`648`	`+ def sdk_url_overriden?`
	`649`	`+ return @base_uri != SplitConfig.default_base_uri`
	`650`	`+ end`
	`651`	`+`
`648`	`652`	`#`
`649`	`653`	`# gets the hostname where the sdk gem is running`
`650`	`654`	`#`