prefab-cloud-ruby 0 → 0.0.1

data/lib/prefab/options.rb

@@ -1,208 +0,0 @@
-# frozen_string_literal: true
-
-module Prefab
-  # This class contains all the options that can be passed to the Prefab client.
-  class Options
-    attr_reader :api_key
-    attr_reader :logdev
-    attr_reader :log_prefix
-    attr_reader :log_formatter
-    attr_reader :namespace
-    attr_reader :prefab_api_url
-    attr_reader :on_no_default
-    attr_reader :initialization_timeout_sec
-    attr_reader :on_init_failure
-    attr_reader :prefab_config_override_dir
-    attr_reader :prefab_config_classpath_dir
-    attr_reader :prefab_envs
-    attr_reader :collect_sync_interval
-    attr_reader :use_local_cache
-    attr_reader :datafile
-    attr_reader :disable_action_controller_logging
-    attr_accessor :is_fork
-
-    DEFAULT_LOG_FORMATTER = proc { |data|
-      severity = data[:severity]
-      datetime = data[:datetime]
-      progname = data[:progname]
-      path = data[:path]
-      msg = data[:message]
-      log_context = data[:log_context]
-
-      progname = (progname.nil? || progname.empty?) ? path : "#{progname}: #{path}"
-
-      formatted_log_context = log_context.sort.map do |k, v|
-        "#{k}=#{v}"
-      end.join(" ")
-      "#{severity.ljust(5)} #{datetime}:#{' ' if progname}#{progname} #{msg}#{log_context.any? ? " " + formatted_log_context : ""}\n"
-    }
-
-    JSON_LOG_FORMATTER = proc { |data|
-      log_context = data.delete(:log_context)
-      data.merge(log_context).compact.to_json << "\n"
-    }
-
-    COMPACT_LOG_FORMATTER = proc { |data|
-      severity = data[:severity]
-      msg = data[:message]
-      log_context = data[:log_context]
-      log_context["path"] = data[:path] || ""
-
-      formatted_log_context = log_context.sort.map do |k, v|
-        "#{k}=#{v}"
-      end.join(" ")
-      "#{severity.ljust(5)} #{msg&.strip} #{formatted_log_context}\n"
-    }
-
-    module ON_INITIALIZATION_FAILURE
-      RAISE = :raise
-      RETURN = :return
-    end
-
-    module ON_NO_DEFAULT
-      RAISE = :raise
-      RETURN_NIL = :return_nil
-    end
-
-    module DATASOURCES
-      ALL = :all
-      LOCAL_ONLY = :local_only
-    end
-
-    DEFAULT_MAX_PATHS = 1_000
-    DEFAULT_MAX_KEYS = 100_000
-    DEFAULT_MAX_EXAMPLE_CONTEXTS = 100_000
-    DEFAULT_MAX_EVAL_SUMMARIES = 100_000
-
-    private def init(
-      api_key: ENV['PREFAB_API_KEY'],
-      logdev: $stdout,
-      namespace: '',
-      log_formatter: DEFAULT_LOG_FORMATTER,
-      log_prefix: nil,
-      prefab_api_url: ENV['PREFAB_API_URL'] || 'https://api.prefab.cloud',
-      on_no_default: ON_NO_DEFAULT::RAISE, # options :raise, :warn_and_return_nil,
-      initialization_timeout_sec: 10, # how long to wait before on_init_failure
-      on_init_failure: ON_INITIALIZATION_FAILURE::RAISE,
-      prefab_datasources: ENV['PREFAB_DATASOURCES'] == 'LOCAL_ONLY' ? DATASOURCES::LOCAL_ONLY : DATASOURCES::ALL,
-      prefab_config_override_dir: Dir.home,
-      prefab_config_classpath_dir: '.', # where to load local overrides
-      prefab_envs: ENV['PREFAB_ENVS'].nil? ? [] : ENV['PREFAB_ENVS'].split(','),
-      collect_logger_counts: true,
-      collect_max_paths: DEFAULT_MAX_PATHS,
-      collect_sync_interval: nil,
-      context_upload_mode: :periodic_example, # :periodic_example, :shape_only, :none
-      context_max_size: DEFAULT_MAX_EVAL_SUMMARIES,
-      collect_evaluation_summaries: true,
-      collect_max_evaluation_summaries: DEFAULT_MAX_EVAL_SUMMARIES,
-      allow_telemetry_in_local_mode: false,
-      x_datafile: ENV['PREFAB_DATAFILE'],
-      x_use_local_cache: false,
-      disable_action_controller_logging: false
-    )
-      @api_key = api_key
-      @logdev = logdev
-      @namespace = namespace
-      @log_formatter = log_formatter
-      @log_prefix = log_prefix
-      @prefab_api_url = remove_trailing_slash(prefab_api_url)
-      @on_no_default = on_no_default
-      @initialization_timeout_sec = initialization_timeout_sec
-      @on_init_failure = on_init_failure
-      @prefab_datasources = prefab_datasources
-      @datafile = x_datafile
-      @prefab_config_classpath_dir = prefab_config_classpath_dir
-      @prefab_config_override_dir = prefab_config_override_dir
-      @prefab_envs = Array(prefab_envs)
-      @collect_logger_counts = collect_logger_counts
-      @collect_max_paths = collect_max_paths
-      @collect_sync_interval = collect_sync_interval
-      @collect_evaluation_summaries = collect_evaluation_summaries
-      @collect_max_evaluation_summaries = collect_max_evaluation_summaries
-      @allow_telemetry_in_local_mode = allow_telemetry_in_local_mode
-      @use_local_cache = x_use_local_cache
-      @disable_action_controller_logging = disable_action_controller_logging
-      @is_fork = false
-
-      # defaults that may be overridden by context_upload_mode
-      @collect_shapes = false
-      @collect_max_shapes = 0
-      @collect_example_contexts = false
-      @collect_max_example_contexts = 0
-
-      case context_upload_mode
-      when :none
-        # do nothing
-      when :periodic_example
-        @collect_example_contexts = true
-        @collect_max_example_contexts = context_max_size
-      when :shape_only
-        @collect_shapes = true
-        @collect_max_shapes = context_max_size
-      else
-        raise "Unknown context_upload_mode #{context_upload_mode}. Please provide :periodic_example, :shape_only, or :none."
-      end
-    end
-
-    def initialize(options = {})
-      init(**options)
-    end
-
-    def local_only?
-      @prefab_datasources == DATASOURCES::LOCAL_ONLY
-    end
-
-    def datafile?
-      !@datafile.nil?
-    end
-
-    def collect_max_paths
-      return 0 unless telemetry_allowed?(@collect_logger_counts)
-
-      @collect_max_paths
-    end
-
-    def collect_max_shapes
-      return 0 unless telemetry_allowed?(@collect_shapes)
-
-      @collect_max_shapes
-    end
-
-    def collect_max_example_contexts
-      return 0 unless telemetry_allowed?(@collect_example_contexts)
-
-      @collect_max_example_contexts
-    end
-
-    def collect_max_evaluation_summaries
-      return 0 unless telemetry_allowed?(@collect_evaluation_summaries)
-
-      @collect_max_evaluation_summaries
-    end
-
-    # https://api.prefab.cloud -> https://api-prefab-cloud.global.ssl.fastly.net
-    def url_for_api_cdn
-      ENV['PREFAB_CDN_URL'] || "#{@prefab_api_url.gsub(/\./, '-')}.global.ssl.fastly.net"
-    end
-
-    def api_key_id
-      @api_key&.split("-")&.first
-    end
-
-    def for_fork
-      clone = self.clone
-      clone.is_fork = true
-      clone
-    end
-
-    private
-
-    def telemetry_allowed?(option)
-      option && (!local_only? || @allow_telemetry_in_local_mode)
-    end
-
-    def remove_trailing_slash(url)
-      url.end_with?('/') ? url[0..-2] : url
-    end
-  end
-end

data/lib/prefab/periodic_sync.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-module Prefab
-  module PeriodicSync
-    LOG = Prefab::InternalLogger.new("periodsync")
-    def sync
-      return if @data.size.zero?
-
-      LOG.debug "Syncing #{@data.size} items"
-
-      start_at_was = @start_at
-      @start_at = Prefab::TimeHelpers.now_in_ms
-
-      flush(prepare_data, start_at_was)
-    end
-
-    def prepare_data
-      to_ship = @data.dup
-      @data.clear
-
-      on_prepare_data
-
-      to_ship
-    end
-
-    def on_prepare_data
-      # noop -- override as you wish
-    end
-
-    def post(url, data)
-      @client.post(url, data)
-    end
-
-    def start_periodic_sync(sync_interval)
-      @start_at = Prefab::TimeHelpers.now_in_ms
-
-      @sync_interval = calculate_sync_interval(sync_interval)
-
-      Thread.new do
-        LOG.debug "Initialized #{@name} instance_hash=#{@client.instance_hash}"
-
-        loop do
-          sleep @sync_interval.call
-          sync
-        end
-      end
-    end
-
-    def pool
-      @pool ||= Concurrent::ThreadPoolExecutor.new(
-        fallback_policy: :discard,
-        max_queue: 5,
-        max_threads: 4,
-        min_threads: 1,
-        name: @name
-      )
-    end
-
-    private
-
-    def calculate_sync_interval(sync_interval)
-      if sync_interval.is_a?(Numeric)
-        proc { sync_interval }
-      else
-        sync_interval || ExponentialBackoff.new(initial_delay: 8, max_delay: 60 * 5)
-      end
-    end
-  end
-end

data/lib/prefab/prefab.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module Prefab
-  @@lock = Concurrent::ReadWriteLock.new
-
-  def self.init(options = Prefab::Options.new)
-    unless @singleton.nil?
-      Prefab::LoggerClient.instance.warn 'Prefab already initialized.'
-      return @singleton
-    end
-
-    @@lock.with_write_lock {
-      @singleton = Prefab::Client.new(options)
-    }
-  end
-
-  def self.fork
-    ensure_initialized
-    @@lock.with_write_lock {
-      @singleton = @singleton.fork
-    }
-  end
-
-  def self.set_rails_loggers
-    ensure_initialized
-    @singleton.set_rails_loggers
-  end
-
-  def self.get(key, properties = NO_DEFAULT_PROVIDED)
-    ensure_initialized key
-    @singleton.get(key, properties)
-  end
-
-  def self.enabled?(feature_name, jit_context = NO_DEFAULT_PROVIDED)
-    ensure_initialized feature_name
-    @singleton.enabled?(feature_name, jit_context)
-  end
-
-  def self.with_context(properties, &block)
-    ensure_initialized
-    @singleton.with_context(properties, &block)
-  end
-
-  def self.instance
-    ensure_initialized
-    @singleton
-  end
-
-  private
-
-  def self.ensure_initialized(key = nil)
-    if not defined? @singleton or @singleton.nil?
-      raise Prefab::Errors::UninitializedError.new(key)
-    end
-  end
-end

data/lib/prefab/rate_limit_cache.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module Prefab
-  # A key-based rate limiter that considers a key to be fresh if it has been
-  # seen within the last `duration` seconds.
-  #
-  # This is used to rate limit the number of times we send a given context
-  # to the server.
-  #
-  # Because expected usage is to immediately `set` on a `fresh?` miss, we do
-  # not prune the data structure on `fresh?` calls. Instead, we manually invoke
-  # `prune` periodically from the cache consumer.
-  class RateLimitCache
-    attr_reader :data
-
-    def initialize(duration)
-      @data = Concurrent::Map.new
-      @duration = duration
-    end
-
-    def fresh?(key)
-      timestamp = @data[key]
-
-      return false unless timestamp
-      return false if Time.now.utc.to_i - timestamp > @duration
-
-      true
-    end
-
-    def set(key)
-      @data[key] = Time.now.utc.to_i
-    end
-
-    def prune
-      now = Time.now.utc.to_i
-      @data.each_pair do |key, (timestamp, _)|
-        @data.delete(key) if now - timestamp > @duration
-      end
-    end
-  end
-end

data/lib/prefab/resolved_config_presenter.rb

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-module Prefab
-  class ResolvedConfigPresenter
-    class ConfigRow
-      include Comparable
-
-      attr_reader :key, :value, :match, :source
-
-      def initialize(key, value, match, source)
-        @key = key
-        @value = value
-        @match = match
-        @source = source
-      end
-
-      def <=>(other)
-        inspect <=> other.inspect
-      end
-
-      def inspect
-        [@key, @value, @match, @source].inspect
-      end
-    end
-
-    def initialize(resolver, lock, local_store)
-      @resolver = resolver
-      @lock = lock
-      @local_store = local_store
-    end
-
-    def each(&block)
-      to_h.each(&block)
-    end
-
-    def to_h
-      hash = {}
-
-      Prefab::Context.with_context({}) do
-        @lock.with_read_lock do
-          @local_store.keys.sort.each do |k|
-            v = @local_store[k]
-
-            if v.nil?
-              hash[k] = ConfigRow.new(k, nil, nil, nil)
-            else
-              value = @resolver.evaluate(v[:config])&.reportable_value
-              hash[k] = ConfigRow.new(k, value, v[:match], v[:source])
-            end
-          end
-        end
-      end
-
-      hash
-    end
-
-    def to_s
-      str = "\n"
-
-      Prefab::Context.with_context({}) do
-        @lock.with_read_lock do
-          @local_store.keys.sort.each do |k|
-            v = @local_store[k]
-            elements = [k.slice(0..49).ljust(50)]
-            if v.nil?
-              elements << 'tombstone'
-            else
-              value = begin
-                @resolver.evaluate(v[:config])&.reportable_value
-              rescue StandardError => e
-                "ERROR EVALUATING: #{e.class} #{e.message}"
-              end
-              elements << value.to_s.slice(0..34).ljust(35)
-              elements << value.class.to_s.slice(0..6).ljust(7)
-              elements << "Match: #{v[:match]}".slice(0..29).ljust(30)
-              elements << "Source: #{v[:source]}"
-            end
-            str += elements.join(' | ') << "\n"
-          end
-        end
-      end
-
-      str
-    end
-  end
-end

data/lib/prefab/time_helpers.rb

@@ -1,7 +0,0 @@
-module Prefab
-  module TimeHelpers
-    def self.now_in_ms
-      ::Time.now.utc.to_i * 1000
-    end
-  end
-end

data/lib/prefab/weighted_value_resolver.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module Prefab
-  class WeightedValueResolver
-    MAX_32_FLOAT = 4_294_967_294.0
-
-    def initialize(weights, config_key, context_hash_value)
-      @weights = weights
-      @config_key = config_key
-      @context_hash_value = context_hash_value
-    end
-
-    def resolve
-      percent = @context_hash_value ? user_percent : rand
-
-      index = variant_index(percent)
-
-      [@weights[index], index]
-    end
-
-    def user_percent
-      to_hash = "#{@config_key}#{@context_hash_value}"
-      int_value = Murmur3.murmur3_32(to_hash)
-      int_value / MAX_32_FLOAT
-    end
-
-    def variant_index(percent_through_distribution)
-      distribution_space = @weights.inject(0) { |sum, v| sum + v.weight }
-      bucket = distribution_space * percent_through_distribution
-
-      sum = 0
-      @weights.each_with_index do |variant_weight, index|
-        return index if bucket < sum + variant_weight.weight
-
-        sum += variant_weight.weight
-      end
-
-      # In the event that all weights are zero, return the last variant
-      @weights.size - 1
-    end
-  end
-end

data/lib/prefab/yaml_config_parser.rb

@@ -1,34 +0,0 @@
-require 'yaml'
-
-module Prefab
-  class YAMLConfigParser
-    LOG = Prefab::InternalLogger.new(YAMLConfigParser)
-
-    def initialize(file, client)
-      @file = file
-      @client = client
-    end
-
-    def merge(config)
-      yaml = load
-
-      yaml.each do |k, v|
-        config = Prefab::LocalConfigParser.parse(k, v, config, @file)
-      end
-
-      config
-    end
-
-    private
-
-    def load
-      if File.exist?(@file)
-        LOG.info "Load #{@file}"
-        YAML.load_file(@file)
-      else
-        LOG.info "No file #{@file}"
-        {}
-      end
-    end
-  end
-end

data/lib/prefab-cloud-ruby.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-module Prefab
-  NO_DEFAULT_PROVIDED = :no_default_provided
-  VERSION = File.read(File.dirname(__FILE__) + '/../VERSION').strip
-end
-
-require 'concurrent/atomics'
-require 'concurrent'
-require 'faraday'
-require 'openssl'
-require 'ld-eventsource'
-require 'prefab_pb'
-require 'prefab/time_helpers'
-require 'prefab/error'
-require 'prefab/evaluation'
-require 'prefab/encryption'
-require 'prefab/exponential_backoff'
-require 'prefab/errors/initialization_timeout_error'
-require 'prefab/errors/invalid_api_key_error'
-require 'prefab/errors/missing_default_error'
-require 'prefab/errors/env_var_parse_error'
-require 'prefab/errors/missing_env_var_error'
-require 'prefab/errors/uninitialized_error'
-require 'prefab/options'
-require 'prefab/static_logger'
-require 'prefab/internal_logger'
-require 'prefab/rate_limit_cache'
-require 'prefab/context_shape_aggregator'
-require 'prefab/example_contexts_aggregator'
-require 'prefab/evaluation_summary_aggregator'
-require 'prefab/log_path_aggregator'
-require 'prefab/sse_logger'
-require 'prefab/weighted_value_resolver'
-require 'prefab/config_value_wrapper'
-require 'prefab/config_value_unwrapper'
-require 'prefab/criteria_evaluator'
-require 'prefab/config_loader'
-require 'prefab/context_shape'
-require 'prefab/local_config_parser'
-require 'prefab/yaml_config_parser'
-require 'prefab/resolved_config_presenter'
-require 'prefab/config_resolver'
-require 'prefab/http_connection'
-require 'prefab/context'
-require 'prefab/logger_client'
-require 'active_support/deprecation'
-require 'active_support'
-require 'action_controller/metal/strong_parameters'
-require 'prefab/logging/formatter_base'
-require 'prefab/log_subscribers/action_controller_subscriber'
-require 'prefab/client'
-require 'prefab/config_client_presenter'
-require 'prefab/config_client'
-require 'prefab/feature_flag_client'
-require 'prefab/prefab'
-require 'prefab/murmer3'