ff-ruby-server-sdk 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91515d01fe58895653204c1eda4d36e0d48298afb8849104a92c8bcab341d9d4
-  data.tar.gz: 2f9d430480d7b50071ade6b2ff20c8b6e6be9a82908abcfcc2f9d7bd620c435c
+  metadata.gz: 6887a6e72ac05dffee1a385833108097515b8f11a32df209a581d11b174b958c
+  data.tar.gz: dc8ba8218ad7951c2ecefc8f82df088a69dd713153d9c511c5fa9cf1c113fb72
 SHA512:
-  metadata.gz: 5de27ffb1a3f4ee42dde0627a300becf96ca59cd8b38c87caddcc3f5ea481d4665db1c27c673ea325244381e735f2fdb0166153cf83925618662753871b4442d
-  data.tar.gz: 817e2c49ea331c6629a8e6495f17a520219dab73e77deab535eda29a7d13d5cdc682fcaae0da00527d5ef08e0dc90f2ed2df4a2d1f78dabcb1ce28b552740ffd
+  metadata.gz: b99aa618e90bc98dcbb810ec32724d51d1d253b8b8d0857cf0e14cc2c04399f4253ff9d402eaf97c0f818bbf9b41bc82ada6cd105335b18ddd2009fb9a59dc66
+  data.tar.gz: 9bb2ab662306eed3d77e5220e465692d2c23f4b56887fac393ce5b6190479a00339f3f6b2cd3d918c726ff27cd2d4a11af3b1db5f1921d9148d89020c42020ce

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.2.0] ** BREAKING **
+
+- [FFM-9804] - The percentage rollout hash algorithm was slightly different compared to other Feature Flags SDKs, which resulted 
+in a different bucket allocation for the same target. While the overall percentage distribution was correct with the previous
+algorithm; this fix ensures that the same target will get the same allocation per SDK. We are marking as a breaking change
+as existing targets may get different allocations in a percentage rollout flag. 
+
 # [1.1.0]
 
 - [FFM-7285] - Remove Metrics queue and implement Map for better memory usage

data/Gemfile

@@ -9,19 +9,19 @@ gem "minitest", "~> 5.0"
 gem "standard", "~> 1.3"
 
 # Caching support:
-gem "rufus-scheduler"
-gem "libcache"
-gem "jwt"
-gem "moneta"
+gem "rufus-scheduler", "~> 3.8"
+gem "libcache", "0.4.2"
+gem "jwt", "~> 2.3"
+gem "moneta", "~> 1.4"
 
 # SSE support:
-gem "rest-client"
+gem "rest-client", "~> 2.1"
 
 # Concurrency support:
-gem "concurrent-ruby", "1.1.10", require: "concurrent"
+gem "concurrent-ruby", "~> 1.1", require: "concurrent"
 
 # Evaluator dependencies:
-gem "murmurhash3"
+gem "murmurhash3", "~> 0.1.6"
 
 gem "typhoeus"
 

data/lib/ff/ruby/server/sdk/api/evaluator.rb

@@ -181,20 +181,24 @@ class Evaluator < Evaluation
   end
 
   def get_normalized_number(property, bucket_by)
-
-    joined = property.to_s + ":" + bucket_by.to_s
-    hash = MurmurHash3::V32.str_hash(joined, joined.length)
+    joined = bucket_by.to_s + ":" + property.to_s
+    hash = MurmurHash3::V32.str_hash(joined, 0)
     (hash % 100) + 1
   end
 
   def is_enabled(target, bucket_by, percentage)
-
     property = get_attr_value(target, bucket_by)
 
-    if property != nil
+    if property == nil
+      old_bb = bucket_by
+      bucket_by = "identifier"
+      property = get_attr_value(target, bucket_by)
+      SdkCodes.warn_bucket_by_attr_not_found @logger, old_bb, property
+    end
 
+    if property != nil
       bucket_id = get_normalized_number(property, bucket_by)
-
+      @logger.debug "MM3 percentage_check=%s bucket_by=%s value=%s bucket=%s" % [percentage, bucket_by, property, bucket_id]
       return percentage > 0 && bucket_id <= percentage
     end
 
@@ -206,13 +210,11 @@ class Evaluator < Evaluation
     if distribution != nil
 
       variation = nil
-
+      total_percentage = 0
       distribution.variations.each do |weighted_variation|
-
         variation = weighted_variation.variation
-
-        if is_enabled(target, distribution.bucket_by, weighted_variation.weight)
-
+        total_percentage = total_percentage + weighted_variation.weight
+        if is_enabled(target, distribution.bucket_by, total_percentage)
           return variation
         end
       end

data/lib/ff/ruby/server/sdk/common/sdk_codes.rb

@@ -54,6 +54,13 @@ class SdkCodes
     logger.warn SdkCodes.sdk_err_msg(6001, "identifier=%s, target=%s, default=%s" % [identifier, target.identifier, default])
   end
 
+  def self.warn_bucket_by_attr_not_found(logger, attr_name, new_value)
+    if new_value == nil
+      new_value = "NOT FOUND"
+    end
+    logger.warn SdkCodes.sdk_err_msg(6002, "missing=%s, using value=%s" % [attr_name, new_value])
+  end
+
   private
 
   @map =
@@ -77,6 +84,7 @@ class SdkCodes
       # SDK_EVAL_6xxx
       6000 => "Evaluated variation successfully",
       6001 => "Default variation was served",
+      6002 => "BucketBy attribute not found in target attributes, falling back to 'identifier':",
       # SDK_METRICS_7xxx
       7000 => "Metrics thread started",
       7001 => "Metrics thread exited",

data/lib/ff/ruby/server/sdk/dto/target.rb

@@ -12,7 +12,7 @@ class Target
 
     @name = name
     @identifier = identifier
-    @attributes = attributes
+    @attributes = attributes == nil ? {} : attributes.transform_keys(&:to_sym)
     @is_private = is_private
     @private_attributes = Set[]
   end

data/lib/ff/ruby/server/sdk/version.rb

@@ -5,7 +5,7 @@ module Ff
     module Server
       module Sdk
 
-        VERSION = "1.1.3"
+        VERSION = "1.2.0"
       end
     end
   end

data/scripts/sdk_specs.sh

@@ -1,4 +1,4 @@
 #!/bin/bash
 
 export ff_ruby_sdk="ff-ruby-server-sdk"
-export ff_ruby_sdk_version="1.1.3"
+export ff_ruby_sdk_version="1.2.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ff-ruby-server-sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - 'Miloš Vasić, cyr.: Милош Васић'
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-24 00:00:00.000000000 Z
+date: 2023-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -178,9 +178,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".idea/.gitignore"
-- ".run/example.run.xml"
-- ".run/sdk_test.rb.run.xml"
 - ".standard.yml"
 - CHANGELOG.md
 - Gemfile

data/.run/example.run.xml

@@ -1,21 +0,0 @@
-<component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="example" type="RubyRunConfigurationType" factoryName="Ruby">
-    <module name="ff-ruby-server-sdk" />
-    <RUBY_RUN_CONFIG NAME="RUBY_ARGS" VALUE="" />
-    <RUBY_RUN_CONFIG NAME="WORK DIR" VALUE="$MODULE_DIR$/lib/ff/ruby/server/sdk" />
-    <RUBY_RUN_CONFIG NAME="SHOULD_USE_SDK" VALUE="false" />
-    <RUBY_RUN_CONFIG NAME="ALTERN_SDK_NAME" VALUE="" />
-    <RUBY_RUN_CONFIG NAME="myPassParentEnvs" VALUE="true" />
-    <EXTENSION ID="BundlerRunConfigurationExtension" bundleExecEnabled="false" />
-    <EXTENSION ID="JRubyRunConfigurationExtension" NailgunExecEnabled="false" />
-    <EXTENSION ID="RubyCoverageRunConfigurationExtension" track_test_folders="true" runner="rcov" ENABLE_BRANCH_COVERAGE="true" ENABLE_FORKED_COVERAGE="true">
-      <COVERAGE_PATTERN ENABLED="true">
-        <PATTERN REGEXPS="/.rvm/" INCLUDED="false" />
-      </COVERAGE_PATTERN>
-    </EXTENSION>
-    <EXTENSION ID="org.jetbrains.plugins.ruby.rails.run.RailsRunConfigurationExtension" SCRATCH_USE_RAILS_RUNNER="false" />
-    <RUBY_RUN_CONFIG NAME="SCRIPT_PATH" VALUE="$MODULE_DIR$/example/example.rb" />
-    <RUBY_RUN_CONFIG NAME="SCRIPT_ARGS" VALUE="" />
-    <method v="2" />
-  </configuration>
-</component>

data/.run/sdk_test.rb.run.xml

@@ -1,33 +0,0 @@
-<component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="SDK test" type="TestUnitRunConfigurationType" factoryName="Test::Unit/Shoulda/Minitest">
-    <module name="ff-ruby-server-sdk" />
-    <predefined_log_file enabled="true" id="RUBY_TESTUNIT" />
-    <RTEST_RUN_CONFIG_SETTINGS_ID NAME="RUBY_ARGS" VALUE="-Ilib:test" />
-    <RTEST_RUN_CONFIG_SETTINGS_ID NAME="WORK DIR" VALUE="$MODULE_DIR$" />
-    <RTEST_RUN_CONFIG_SETTINGS_ID NAME="SHOULD_USE_SDK" VALUE="false" />
-    <RTEST_RUN_CONFIG_SETTINGS_ID NAME="ALTERN_SDK_NAME" VALUE="" />
-    <RTEST_RUN_CONFIG_SETTINGS_ID NAME="myPassParentEnvs" VALUE="true" />
-    <envs>
-      <env name="JRUBY_OPTS" value="-X+O" />
-    </envs>
-    <EXTENSION ID="BundlerRunConfigurationExtension" bundleExecEnabled="false" />
-    <EXTENSION ID="JRubyRunConfigurationExtension" NailgunExecEnabled="false" />
-    <EXTENSION ID="RubyCoverageRunConfigurationExtension" track_test_folders="true" runner="rcov" ENABLE_BRANCH_COVERAGE="true" ENABLE_FORKED_COVERAGE="true">
-      <COVERAGE_PATTERN ENABLED="true">
-        <PATTERN REGEXPS="/.rvm/" INCLUDED="false" />
-      </COVERAGE_PATTERN>
-    </EXTENSION>
-    <EXTENSION ID="org.jetbrains.plugins.ruby.rails.run.RailsRunConfigurationExtension" SCRATCH_USE_RAILS_RUNNER="false" />
-    <RTEST_RUN_CONFIG_SETTINGS_ID NAME="TESTS_FOLDER_PATH" VALUE="" />
-    <RTEST_RUN_CONFIG_SETTINGS_ID NAME="TEST_SCRIPT_PATH" VALUE="$MODULE_DIR$/test/ff/ruby/server/sdk/sdk_test.rb" />
-    <RTEST_RUN_CONFIG_SETTINGS_ID NAME="TEST_SCRIPTS_PATHS" VALUE="$MODULE_DIR$/test/ff/ruby/server/sdk/sdk_test.rb" />
-    <RTEST_RUN_CONFIG_SETTINGS_ID NAME="TEST_FILE_MASK" VALUE="" />
-    <RTEST_RUN_CONFIG_SETTINGS_ID NAME="TEST_METHOD_NAME" VALUE="" />
-    <RTEST_RUN_CONFIG_SETTINGS_ID NAME="TEST_TEST_TYPE" VALUE="CUSTOM_SET_OF_FILES" />
-    <RTEST_RUN_CONFIG_SETTINGS_ID NAME="DRB" VALUE="false" />
-    <RTEST_RUN_CONFIG_SETTINGS_ID NAME="ZEUS" VALUE="false" />
-    <RTEST_RUN_CONFIG_SETTINGS_ID NAME="SPRING" VALUE="false" />
-    <RTEST_RUN_CONFIG_SETTINGS_ID NAME="RUNNER_OPTIONS" VALUE="" />
-    <method v="2" />
-  </configuration>
-</component>