ff-ruby-server-sdk 0.0.2 → 1.0.0

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

@@ -0,0 +1,297 @@
+require "time"
+require "concurrent-ruby"
+
+require_relative "../dto/target"
+require_relative "../../sdk/version"
+require_relative "../common/closeable"
+require_relative "../api/metrics_event"
+require_relative "../api/summary_metrics"
+
+class MetricsProcessor < Closeable
+
+  def initialize(
+
+    connector,
+    config,
+    callback
+  )
+
+    unless connector.kind_of?(Connector)
+
+      raise "The 'connector' must be of '" + Connector.to_s + "' data type"
+    end
+
+    unless callback.kind_of?(MetricsCallback)
+
+      raise "The 'callback' must be of '" + MetricsCallback.to_s + "' data type"
+    end
+
+    unless config.kind_of?(Config)
+
+      raise "The 'config' must be of '" + Config.to_s + "' data type"
+    end
+
+    @config = config
+    @callback = callback
+    @connector = connector
+
+    @sdk_type = "SDK_TYPE"
+    @global_target_set = Set[]
+    @staging_target_set = Set[]
+    @target_attribute = "target"
+    @global_target = "__global__cf_target" # <--- This target identifier is used to aggregate and send data for all
+    #                                             targets as a summary
+
+    @ready = false
+    @jar_version = ""
+    @server = "server"
+    @sdk_version = "SDK_VERSION"
+    @sdk_language = "SDK_LANGUAGE"
+    @global_target_name = "Global Target"
+    @feature_name_attribute = "featureName"
+    @variation_identifier_attribute = "variationIdentifier"
+
+    @queue = SizedQueue.new(@config.buffer_size)
+    @executor = Concurrent::FixedThreadPool.new(100)
+
+    @callback.on_metrics_ready
+  end
+
+  def start
+
+    @config.logger.info "Starting metrics processor with request interval: " + @config.frequency.to_s
+    start_async
+  end
+
+  def stop
+
+    @config.logger.info "Stopping metrics processor"
+    stop_async
+  end
+
+  def close
+
+    stop
+    @config.logger.info "Closing metrics processor"
+  end
+
+  def push_to_queue(
+
+    target,
+    feature_config,
+    variation
+  )
+
+    @executor.post do
+
+      @config.logger.debug "Pushing to the metrics queue: START"
+
+      event = MetricsEvent.new(feature_config, target, variation)
+      @queue.push(event)
+
+      @config.logger.debug "Pushing to the metrics queue: END, queue size: " + @queue.size.to_s
+
+    end
+  end
+
+  def send_data_and_reset_cache(data)
+
+    @config.logger.debug "Reading from queue and building cache"
+
+    @jar_version = get_version
+
+    unless data.empty?
+
+      map = {}
+
+      data.each do |event|
+
+        new_value = 1
+        current = map[event]
+
+        if current != nil
+
+          new_value = current + 1
+        end
+
+        map[event] = new_value
+      end
+
+      metrics = prepare_summary_metrics_body(map)
+
+      if !metrics.metrics_data.empty? && !metrics.target_data.empty?
+
+        start_time = (Time.now.to_f * 1000).to_i
+
+        @connector.post_metrics(metrics)
+
+        end_time = (Time.now.to_f * 1000).to_i
+
+        if end_time - start_time > @config.metrics_service_acceptable_duration
+
+          @config.logger.debug "Metrics service API duration=[" + (end_time - start_time).to_s + "]"
+        end
+      end
+
+      @global_target_set.merge(@staging_target_set)
+      @staging_target_set.clear
+    end
+  end
+
+  protected
+
+  def run_one_iteration
+
+    @config.logger.debug "Async metrics iteration: " + @thread.to_s
+
+    data = []
+
+    until @queue.empty?
+
+      item = @queue.pop
+      data.push(item)
+    end
+
+    send_data_and_reset_cache(data)
+  end
+
+  def prepare_summary_metrics_body(data)
+
+    summary_metrics_data = {}
+    metrics = OpenapiClient::Metrics.new({ :target_data => [], :metrics_data => [] })
+
+    add_target_data(
+
+      metrics,
+      Target.new(
+
+        name = @global_target_name,
+        identifier = @global_target
+      )
+    )
+
+    data.each do |key, value|
+
+      target = key.target
+
+      add_target_data(metrics, target)
+
+      summary_metrics = prepare_summary_metrics_key(key)
+
+      summary_metrics_data[summary_metrics] = value
+    end
+
+    summary_metrics_data.each do |key, 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_name }))
+      metrics_data.attributes.push(OpenapiClient::KeyValue.new({ :key => @variation_identifier_attribute, :value => key.variation_identifier }))
+      metrics_data.attributes.push(OpenapiClient::KeyValue.new({ :key => @target_attribute, :value => @global_target }))
+      metrics_data.attributes.push(OpenapiClient::KeyValue.new({ :key => @sdk_type, :value => @server }))
+      metrics_data.attributes.push(OpenapiClient::KeyValue.new({ :key => @sdk_language, :value => "ruby" }))
+      metrics_data.attributes.push(OpenapiClient::KeyValue.new({ :key => @sdk_version, :value => @jar_version }))
+
+      metrics.metrics_data.push(metrics_data)
+    end
+
+    metrics
+  end
+
+  private
+
+  def start_async
+
+    @config.logger.debug "Async starting: " + self.to_s
+
+    @ready = true
+
+    @thread = Thread.new do
+
+      @config.logger.debug "Async started: " + self.to_s
+
+      while @ready do
+
+        unless @initialized
+
+          @initialized = true
+          @config.logger.info "Metrics processor initialized"
+        end
+
+        sleep(@config.frequency)
+
+        run_one_iteration
+      end
+    end
+
+    @thread.run
+  end
+
+  def stop_async
+
+    @queue.clear
+
+    @ready = false
+    @initialized = false
+  end
+
+  def prepare_summary_metrics_key(key)
+
+    SummaryMetrics.new(
+
+      feature_name = key.feature_config.feature,
+      variation_identifier = key.variation.identifier,
+      variation_value = key.variation.value
+    )
+  end
+
+  def add_target_data(metrics, target)
+
+    target_data = OpenapiClient::TargetData.new({ :attributes => [] })
+    private_attributes = target.private_attributes
+
+    if !@staging_target_set.include?(target) && !@global_target_set.include?(target) && !target.is_private
+
+      @staging_target_set.add(target)
+
+      attributes = target.attributes
+
+      attributes.each do |k, v|
+
+        key_value = OpenapiClient::KeyValue.new
+
+        if !private_attributes.empty?
+
+          unless private_attributes.include?(k)
+
+            key_value = OpenapiClient::KeyValue.new({ :key => k, :value => v.to_s })
+          end
+        else
+
+          key_value = OpenapiClient::KeyValue.new({ :key => k, :value => v.to_s })
+        end
+
+        target_data.attributes.push(key_value)
+      end
+
+      target_data.identifier = target.identifier
+
+      if target.name == nil || target.name == ""
+
+        target_data.name = target.identifier
+      else
+
+        target_data.name = target.name
+      end
+
+      metrics.target_data.push(target_data)
+    end
+  end
+
+  def get_version
+
+    Ff::Ruby::Server::Sdk::VERSION
+  end
+end

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

@@ -0,0 +1,20 @@
+class Operators
+
+  def initialize
+    super
+
+    raise "Abstract"
+  end
+
+  # Static:
+  class << self
+
+    @@SEGMENT_MATCH = "SEGMENT_MATCH"
+
+    def SEGMENT_MATCH
+
+      @@SEGMENT_MATCH
+    end
+
+  end # Static - End
+end

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

@@ -0,0 +1,164 @@
+require_relative "../common/closeable"
+
+class PollingProcessor < Closeable
+
+  def initialize(
+
+    connector,
+    repository,
+    poll_interval_in_sec,
+    callback,
+    logger = nil
+  )
+
+    @callback = callback
+    @connector = connector
+    @repository = repository
+    @poll_interval_in_sec = poll_interval_in_sec
+
+    if logger != nil
+
+      @logger = logger
+    else
+
+      @logger = Logger.new(STDOUT)
+    end
+  end
+
+  def retrieve_flags
+
+    flags = []
+
+    @logger.info "Fetching flags started"
+
+    result = @connector.get_flags
+
+    if result != nil
+
+      @logger.info "Flags are fetched"
+
+      result.each { |fc|
+
+        if fc != nil
+
+          @repository.set_flag(fc.feature, fc)
+          flags.push(fc)
+        end
+      }
+    end
+
+    @logger.info "Fetching flags finished"
+
+    flags
+  end
+
+  def retrieve_segments
+
+    segments = []
+
+    @logger.info "Fetching segments started"
+
+    result = @connector.get_segments
+
+    if result != nil
+
+      @logger.info "Segments are fetched"
+
+      result.each { |s|
+
+        if s != nil
+
+          @repository.set_flag(s.identifier, s)
+          flags.push(s)
+        end
+      }
+    end
+
+    @logger.info "Fetching segments finished"
+
+    segments
+  end
+
+  def start_async
+
+    @logger.debug "Async starting: " + self.to_s
+
+    @ready = true
+
+    @thread = Thread.new do
+
+      @logger.debug "Async started: " + self.to_s
+
+      while @ready do
+
+        @logger.debug "Async poll iteration"
+
+        if @callback != nil
+
+          @callback.on_poller_iteration(self)
+        end
+
+        begin
+
+          retrieve_flags
+          retrieve_segments
+
+          unless @initialized
+
+            @initialized = true
+            @logger.info "PollingProcessor initialized"
+
+            if @callback != nil
+
+              @callback.on_poller_ready(self)
+            end
+          end
+
+        rescue OpenapiClient::ApiError => e
+
+          if @callback != nil
+
+            @callback.on_poller_error(e)
+          end
+        end
+
+        sleep(@poll_interval_in_sec)
+      end
+    end
+
+    @thread.run
+  end
+
+  def stop_async
+
+    @ready = false
+    @initialized = false
+  end
+
+  def start
+
+    @logger.info "Starting PollingProcessor with request interval: " + @poll_interval_in_sec.to_s
+    start_async
+  end
+
+  def stop
+
+    @logger.info "Stopping PollingProcessor"
+    stop_async
+    unless @ready
+
+      @logger.info "PollingProcessor stopped"
+    end
+  end
+
+  def close
+
+    stop
+    @logger.info "Closing PollingProcessor"
+  end
+
+  def is_ready
+
+    @ready && @initialized
+  end
+end

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

@@ -0,0 +1,28 @@
+class RepositoryCallback
+
+  def initialize
+    super
+
+    @tbi = "To be implemented"
+  end
+
+  def on_flag_stored(identifier)
+
+    raise @tbi
+  end
+
+  def on_flag_deleted(identifier)
+
+    raise @tbi
+  end
+
+  def on_segment_stored(identifier)
+
+    raise @tbi
+  end
+
+  def on_segment_deleted(identifier)
+
+    raise @tbi
+  end
+end