ff-ruby-server-sdk 1.1.4 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7f4259f611fd7b153a81babb2ae42b476e9033b0a12939b3794f30d21352c0e
-  data.tar.gz: 5d30db5e2c24751816423a609139a1ad4226e679862338bc186c7112366dcb21
+  metadata.gz: 0dee84b9df38fbf84679cc05accc99fcca8f0c44ae7df00b5786ea34c2990569
+  data.tar.gz: bdcdad8c786cb642a4261801c25f140511dd1a6789696d33b3a59d913e42c591
 SHA512:
-  metadata.gz: b8603ebf3b69522413921870f2db3cae4dec9924b4df094cb5c4686986737b313f27bcdf872e7e3b8a20be403dccb78799ae3a0d6f87dd6161f827a68bef9a0b
-  data.tar.gz: cb6d07f58cbd1350fb250c5b42b19268991b3bf6b9026f6d73dece570e0c1d110f15475137866714f991ab7bb9088a322264c260c059fca4c52d8776b11b0eab
+  metadata.gz: 168e0964f465430c0639560daaf8ae72d161e6153e268e2fc0f62da5a6a19dca36bbfa03af069b99d2c8de4a246491d61e0206e7a3cfb94403c0eaa24c8b20ef
+  data.tar.gz: 1daa90440c9bc18c305433eee228ed241400625b757e23442ec02b9df998e9d98b52cba1aa71917438b8a5d9e6d7462705e7fd58ccfc936ea52a13c77cc9725c

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# [1.2.1]
+
+- [FFM-10177] - Ruby SDK - Use pessimistic version operator for minor versions
+
+# [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

@@ -1,31 +1,4 @@
 # frozen_string_literal: true
 
 source "https://rubygems.org"
-
 gemspec
-
-gem "rake", "~> 13.0"
-gem "minitest", "~> 5.0"
-gem "standard", "~> 1.3"
-
-# Caching support:
-gem "rufus-scheduler"
-gem "libcache"
-gem "jwt"
-gem "moneta"
-
-# SSE support:
-gem "rest-client"
-
-# Concurrency support:
-gem "concurrent-ruby", "1.1.10", require: "concurrent"
-
-# Evaluator dependencies:
-gem "murmurhash3"
-
-gem "typhoeus"
-
-group :test do
-  gem 'simplecov', '~> 0.21.2'
-end
-

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/version.rb

@@ -5,7 +5,7 @@ module Ff
     module Server
       module Sdk
 
-        VERSION = "1.1.4"
+        VERSION = "1.2.1"
       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.4"
+export ff_ruby_sdk_version="1.2.1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ff-ruby-server-sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.1
 platform: ruby
 authors:
 - 'Miloš Vasić, cyr.: Милош Васић'
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-15 00:00:00.000000000 Z
+date: 2023-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -56,16 +56,16 @@ dependencies:
   name: rufus-scheduler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.1
+        version: '3.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.1
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: libcache
   requirement: !ruby/object:Gem::Requirement
@@ -84,58 +84,58 @@ dependencies:
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: moneta
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.10
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.10
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: murmurhash3
   requirement: !ruby/object:Gem::Requirement
@@ -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>