ff-ruby-server-sdk 1.4.4 → 1.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9ee87181e0d3822c070ba3c889bf4b339b1c4e7853b046885c98372d25f7a5e
-  data.tar.gz: 3692d620f62ff96a59b17a4bcbd939f245e0ae1befcb9b477bb7389d5beca7e7
+  metadata.gz: 619302fd2168c1df9c8a16375f271e31795465530b880cb51986fbc104577c47
+  data.tar.gz: b778008b460e9db5f86382e6bd62a6bace2ee543a59fb8d4de9df80bd98ff484
 SHA512:
-  metadata.gz: b9c6768454e988de4a4829b9c34d3e168ad43ad5a6d5100ca9671bac272714074b5245fe688aaa0bac81da820f1c172e4cc3fb6ceb577e444b22e833d4578980
-  data.tar.gz: 404694820857c6e8959ac6fdc711bf4119779c0b52f8e48ee56c38e27814a6d7bbe024d7423be9d6e90549c087b68da0add84f7a3911b9a820102da621641d27
+  metadata.gz: fa0fd5bece56084de57aeee050e8dd1ed890981fb868ee50bd44f2219ce3a6b0ac49ffde2c6c8f63131271a57b5f4994d91446f2abfc0bd056ab66a48405c90f
+  data.tar.gz: 4c439844d1780986454e7cf685b236715ae71c2535f7481305f81bc839055fc98691c14d214a1252e5975de7ff894fcceea879a0094ecc06e82a6358fb3ce095

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

@@ -5,13 +5,17 @@ require_relative "inner_client"
 
 class CfClient < Closeable
   include Singleton
-
+  
+  @@instance_mutex = Mutex.new
   def init(api_key, config, connector = nil)
     # Only initialize if @client is nil to avoid reinitialization
-    unless @client
-      @config = config || ConfigBuilder.new.build
-      @client = InnerClient.new(api_key, @config, connector)
-      @config.logger.debug "Client initialized with API key: #{api_key}"
+    
+    @@instance_mutex.synchronize do
+      unless @client
+        @config = config || ConfigBuilder.new.build
+        @client = InnerClient.new(api_key, @config, connector)
+        @config.logger.debug "Client initialized with API key: #{api_key}"
+      end
     end
     @client
   end
@@ -43,6 +47,10 @@ def wait_for_initialization(timeout_ms: nil)
     @client.json_variation(identifier, target, default_value)
   end
 
+  def initialized
+    @client.initialized
+  end
+
   def destroy
 
     close

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

@@ -117,7 +117,9 @@ class Evaluator < Evaluation
 
       if variation != nil
         if callback != nil
-          callback.process_evaluation(flag, target, variation)
+          feature_name = flag.feature
+          variation_identifier = variation.identifier
+          callback.process_evaluation(feature_name, target, variation_identifier)
         end
         return variation
       end

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

@@ -98,6 +98,10 @@ class InnerClient < ClientCallback
     @evaluator.json_variation(identifier, target, default_value, @evaluator_callback)
   end
 
+  def initialized
+    @initialized
+  end
+
   def on_auth_success
 
     SdkCodes::info_sdk_auth_ok @config.logger
@@ -120,9 +124,11 @@ class InnerClient < ClientCallback
   end
 
   def on_auth_failed
-    SdkCodes::warn_auth_failed_srv_defaults @config.logger
-    @initialized = true
-    @condition.signal
+    @my_mutex.synchronize do
+      SdkCodes::warn_auth_failed_srv_defaults @config.logger
+      @initialized = true
+      @condition.broadcast
+    end
   end
 
   def close
@@ -243,7 +249,7 @@ class InnerClient < ClientCallback
 
       SdkCodes.info_sdk_init_ok @config.logger
 
-      @condition.signal
+      @condition.broadcast
       @initialized = true
     end
   end
@@ -257,7 +263,6 @@ class InnerClient < ClientCallback
       remaining = timeout ? timeout / 1000.0 : nil # Convert timeout to seconds
 
       until @initialized
-
         # Break if timeout has elapsed
         if remaining && remaining <= 0
           @config.logger.warn "The SDK has timed out waiting to initialize with supplied timeout #{timeout} ms. The SDK will continue to initialize in the background.  Default variations will be served until the SDK initializes."

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

@@ -21,10 +21,10 @@ class InnerClientFlagEvaluateCallback < FlagEvaluateCallback
     @metrics_processor = metrics_processor
   end
 
-  def process_evaluation(feature_config, target, variation)
+  def process_evaluation(feature_name, target, variation_identifier)
 
-    @logger.debug "Processing evaluation: #{feature_config&.feature || 'nil feature'}, #{target&.identifier || 'nil target'}"
+    @logger.debug "Processing evaluation: #{feature_name || 'nil feature'}, #{variation_identifier || 'nil variation'},  #{target&.identifier || 'nil target'}"
 
-    @metrics_processor.register_evaluation(target, feature_config, variation)
+    @metrics_processor.register_evaluation(target, feature_name, variation_identifier)
   end
 end

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

@@ -6,12 +6,9 @@ require_relative "../dto/target"
 require_relative "../../sdk/version"
 require_relative "../common/closeable"
 require_relative "../common/sdk_codes"
-require_relative "../api/metrics_event"
 require_relative "../api/summary_metrics"
 
 class MetricsProcessor < Closeable
-  GLOBAL_TARGET = Target.new(identifier: "__global__cf_target", name: "Global Target").freeze
-
   def init(connector, config, callback)
 
     unless connector.kind_of?(Connector)
@@ -79,8 +76,8 @@ class MetricsProcessor < Closeable
     @config.logger.debug "Closing metrics processor"
   end
 
-  def register_evaluation(target, feature_config, variation)
-    register_evaluation_metric(feature_config, variation)
+  def register_evaluation(target, feature_name, variation_identifier)
+    register_evaluation_metric(feature_name, variation_identifier)
     if target
       register_target_metric(target)
     end
@@ -88,29 +85,24 @@ class MetricsProcessor < Closeable
 
   private
 
-  def register_evaluation_metric(feature_config, variation)
+  def register_evaluation_metric(feature_name, variation_identifier)
     # Guard clause to ensure feature_config, @global_target, and variation are valid.
     # While they should be, this adds protection for an edge case we are seeing where the the ConcurrentMap (now replaced with our own thread safe hash)
     # seemed to be accessing invalid areas of memory and seg faulting.
     # Issue being tracked in FFM-12192, and once resolved, can remove these checks in a future release && once the issue is resolved.
-    if feature_config.nil? || !feature_config.respond_to?(:feature) || feature_config.feature.nil?
-      @config.logger.warn("Skipping invalid MetricsEvent: feature_config is missing or incomplete. feature_config=#{feature_config.inspect}")
+    unless feature_name && !feature_name.empty?
+      @config.logger.warn("Skipping invalid MetricsEvent: feature_config is missing or incomplete. feature_config=#{feature_name.inspect}")
       return
     end
 
-    if GLOBAL_TARGET.nil? || !GLOBAL_TARGET.respond_to?(:identifier) || GLOBAL_TARGET.identifier.nil?
-      @config.logger.warn("Skipping invalid MetricsEvent: global_target is missing or incomplete. global_target=#{GLOBAL_TARGET.inspect}")
+    unless variation_identifier && !variation_identifier.empty?
+      @config.logger.warn("Skipping iInvalid MetricsEvent: variation is missing or incomplete. variation=#{variation_identifier.inspect}")
       return
     end
 
-    if variation.nil? || !variation.respond_to?(:identifier) || variation.identifier.nil?
-      @config.logger.warn("Skipping iInvalid MetricsEvent: variation is missing or incomplete. variation=#{variation.inspect}")
-      return
-    end
-
-    event = MetricsEvent.new(feature_config, GLOBAL_TARGET, variation, @config.logger)
     @metric_maps_mutex.synchronize do
-      @evaluation_metrics[event] = (@evaluation_metrics[event] || 0) + 1
+      key = "#{feature_name}\0#{variation_identifier}"
+      @evaluation_metrics[key] = (@evaluation_metrics[key] || 0) + 1
     end
   end
 
@@ -185,31 +177,28 @@ class MetricsProcessor < Closeable
 
     total_count = 0
     evaluation_metrics_clone.each do |key, value|
-      # While Components should not be missing, this adds protection for an edge case we are seeing with very large
-      # project sizes.  Issue being tracked in FFM-12192, and once resolved, can feasibly remove
-      # these checks in a future release.
-      # Initialize an array to collect missing components
-      missing_components = []
-
-      # Check each required component and add to missing_components if absent
-      missing_components << 'feature_config' unless key.respond_to?(:feature_config) && key.feature_config
-      missing_components << 'variation' unless key.respond_to?(:variation) && key.variation
-      missing_components << 'target' unless key.respond_to?(:target) && key.target
-      missing_components << 'count' if value.nil?
-
-      # If any components are missing, log a detailed warning and skip processing
-      unless missing_components.empty?
-        @config.logger.warn "Skipping invalid metrics event: missing #{missing_components.join(', ')} in key: #{key.inspect}, full details: #{key.inspect}"
+      feature_name, variation_identifier = key.split("\0", 2)
+
+      # Although feature_name and variation_identifier should always be present,
+      # this guard provides protection against an edge case where keys reference
+      # other objects in memory. In versions <= 1.4.4, we were keying on the MetricsEvent
+      # class (now deleted). To remediate this, we have transitioned to using strings as keys.
+      # This issue is being tracked in FFM-12192. Once resolved, these checks can be safely
+      # removed in a future release.
+      # If any required data is missing, log a detailed warning and skip processing.
+      unless feature_name && variation_identifier && value.is_a?(Integer) && value > 0
+        @config.logger.warn "Skipping invalid metrics event: missing or invalid feature_name, variation_identifier, or count. Key: #{key.inspect}, Count: #{value.inspect}"
         next
       end
 
       total_count += value
+
       metrics_data = OpenapiClient::MetricsData.new({ :attributes => [] })
       metrics_data.timestamp = (Time.now.to_f * 1000).to_i
       metrics_data.count = value
       metrics_data.metrics_type = "FFMETRICS"
-      metrics_data.attributes.push(OpenapiClient::KeyValue.new({ :key => @feature_name_attribute, :value => key.feature_config.feature }))
-      metrics_data.attributes.push(OpenapiClient::KeyValue.new({ :key => @variation_identifier_attribute, :value => key.variation.identifier }))
+      metrics_data.attributes.push(OpenapiClient::KeyValue.new({ :key => @feature_name_attribute, :value => feature_name }))
+      metrics_data.attributes.push(OpenapiClient::KeyValue.new({ :key => @variation_identifier_attribute, :value => variation_identifier }))
       metrics_data.attributes.push(OpenapiClient::KeyValue.new({ :key => @target_attribute, :value => @global_target_identifier }))
       metrics_data.attributes.push(OpenapiClient::KeyValue.new({ :key => @sdk_type, :value => @server }))
       metrics_data.attributes.push(OpenapiClient::KeyValue.new({ :key => @sdk_language, :value => "ruby" }))

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

@@ -5,7 +5,7 @@ module Ff
     module Server
       module Sdk
 
-        VERSION = "1.4.4"
+        VERSION = "1.4.6"
       end
     end
   end

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

@@ -17,7 +17,6 @@ require_relative "sdk/api/cf_client"
 require_relative "sdk/api/evaluation"
 require_relative "sdk/api/inner_client"
 require_relative "sdk/api/auth_service"
-require_relative "sdk/api/metrics_event"
 require_relative "sdk/api/default_cache"
 require_relative "sdk/api/config_builder"
 require_relative "sdk/api/file_map_store"

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.4.4"
+export ff_ruby_sdk_version="1.4.6"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ff-ruby-server-sdk
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.4.6
 platform: ruby
 authors:
 - 'Miloš Vasić, cyr.: Милош Васић'
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-18 00:00:00.000000000 Z
+date: 2025-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -253,7 +252,6 @@ files:
 - lib/ff/ruby/server/sdk/api/inner_client_repository_callback.rb
 - lib/ff/ruby/server/sdk/api/inner_client_updater.rb
 - lib/ff/ruby/server/sdk/api/metrics_callback.rb
-- lib/ff/ruby/server/sdk/api/metrics_event.rb
 - lib/ff/ruby/server/sdk/api/metrics_processor.rb
 - lib/ff/ruby/server/sdk/api/operators.rb
 - lib/ff/ruby/server/sdk/api/polling_processor.rb
@@ -289,7 +287,6 @@ metadata:
   homepage_uri: https://www.harness.io/
   source_code_uri: https://github.com/harness/ff-ruby-server-sdk
   changelog_uri: https://github.com/harness/ff-ruby-server-sdk/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -305,8 +302,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Harness is a feature management platform that helps teams to build better
   software and to test features quicker.

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

@@ -1,53 +0,0 @@
-class MetricsEvent
-
-  attr_accessor :feature_config, :target, :variation
-
-  def initialize(feature_config, target, variation, logger)
-
-    @target = target
-    @variation = variation
-    @feature_config = feature_config
-    @logger = logger
-    freeze
-  end
-
-  def ==(other)
-    eql?(other)
-  end
-
-  def eql?(other)
-    # Guard clause other is the same type.
-    # While it should be, this adds protection for an edge case we are seeing with very large
-    # project sizes. Issue being tracked in FFM-12192, and once resolved, can feasibly remove
-    # these checks in a future release.
-    unless other.is_a?(MetricsEvent)
-      # We should always have a logger available except when we've deep cloned this class.  We don't do any
-      # equality check on clones in metrics code anyway, so this is just a safety check.
-      if @logger
-        @logger.warn("Warning: Attempted to compare MetricsEvent with #{other.class.name}")
-      end
-      return false
-    end
-
-    feature_config.feature == other.feature_config.feature and
-      variation.identifier == other.variation.identifier and
-      target.identifier == other.target.identifier
-  end
-
-  def hash
-    feature_config.feature.hash | variation.identifier.hash | target.identifier.hash
-  end
-
-
-  # Exclude logger from serialization
-  def marshal_dump
-    [@feature_config, @target, @variation]
-  end
-
-  def marshal_load(array)
-    @feature_config, @target, @variation = array
-    @logger = nil
-  end
-
-
-end