prefab-cloud-ruby 0 → 0.0.1

data/CHANGELOG.md

@@ -1,169 +0,0 @@
-# Changelog
-
-## 1.5.0 - 2024-02-12
-
-- Fix potential inconsistent Context behavior (#172)
-
-## 1.4.5 - 2024-01-31
-
-- Refactor out a `should_log?` method (#170)
-
-## 1.4.4 - 2024-01-26
-
-- Raise when ENV var is missing
-
-## 1.4.3 - 2024-01-17
-
-- Updated proto definition file
-
-## 1.4.2 - 2023-12-14
-
-- Use reportable value even for invalid data (#166)
-
-## 1.4.1 - 2023-12-08
-
-- Include version in `get` request (#165)
-
-## 1.4.0 - 2023-11-28
-
-- ActiveJob tagged logger issue (#164)
-- Compact Log Format (#163)
-- Tagged Logging (#161)
-- ContextKey logging thread safety (#162)
-
-## 1.3.2 - 2023-11-15
-
-- Send back cloud.prefab logging telemetry (#160)
-
-## 1.3.1 - 2023-11-14
-
-- Improve path of rails.controller logging & fix strong param include (#159)
-
-## 1.3.0 - 2023-11-13
-
-- Less logging when wifi is off and we load from cache (#157)
-- Alpha: Add Provided & Secret Support (#152)
-- Alpha: x_datafile (#156)
-- Add single line action-controller output under rails.controller (#158)
-
-## 1.2.1 - 2023-11-01
-
-- Update protobuf definitions (#154)
-
-## 1.2.0 - 2023-10-30
-
-- Add `Prefab.get('key')` style usage after a `Prefab.init()` call (#151)
-- Add `add_context_keys` and `with_context_keys` method for LoggerClient (#145)
-
-## 1.1.2 - 2023-10-13
-
-- Add `cloud.prefab.client.criteria_evaluator` `debug` logging of evaluations (#150)
-- Add `x_use_local_cache` for local caching (#148)
-- Tests run in RubyMine (#147)
-
-## 1.1.1 - 2023-10-11
-
-- Migrate happy-path client-initialization logging to `DEBUG` level rather than `INFO` (#144)
-- Add `ConfigClientPresenter` for logging out stats upon successful client initialization (#144)
-- Add support for default context (#146)
-
-## 1.1.0 - 2023-09-18
-
-- Add support for structured logging (#143)
-  - Ability to pass a hash of key/value context pairs to any of the user-facing log methods
-
-## 1.0.1 - 2023-08-17
-
-- Bug fix for StringList w/ ExampleContextsAggregator (#141)
-
-## 1.0.0 - 2023-08-10
-
-- Removed EvaluatedKeysAggregator (#137)
-- Change `collect_evaluation_summaries` default to true (#136)
-- Removed some backwards compatibility shims (#133)
-- Standardizing options (#132)
-  - Note that the default value for `context_upload_mode` is `:periodic_example` which means example contexts will be collected.
-    This enables easy variant override assignment in our UI. More at https://prefab.cloud/blog/feature-flag-variant-assignment/
-
-## 0.24.6 - 2023-07-31
-
-- Logger Client compatibility (#129)
-- Replace EvaluatedConfigs with ExampleContexts (#128)
-- Add ConfigEvaluationSummaries (opt-in for now) (#123)
-
-## 0.24.5 - 2023-07-10
-
-- Report Client Version (#121)
-
-## [0.24.4] - 2023-07-06
-
-- Support Timed Loggers (#119)
-- Added EvaluatedConfigsAggregator (disabled by default) (#118)
-- Added EvaluatedKeysAggregator (disabled by default) (#117)
-- Dropped Ruby 2.6 support (#116)
-- Capture/report context shapes (#115)
-- Added bin/console (#114)
-
-## [0.24.3] - 2023-05-15
-
-- Add JSON log formatter (#106)
-
-# [0.24.2] - 2023-05-12
-
-- Fix bug in FF rollout eval consistency (#108)
-- Simplify forking (#107)
-
-# [0.24.1] - 2023-04-26
-
-- Fix misleading deprecation warning (#105)
-
-# [0.24.0] - 2023-04-26
-
-- Backwards compatibility for JIT context (#104)
-- Remove upsert (#103)
-- Add resolver presenter and `on_update` callback (#102)
-- Deprecate `lookup_key` and introduce Context (#99)
-
-# [0.23.8] - 2023-04-21
-
-- Update protobuf (#101)
-
-# [0.23.7] - 2023-04-21
-
-- Guard against ActiveJob not being loaded (#100)
-
-# [0.23.6] - 2023-04-17
-
-- Fix bug in FF rollout eval consistency (#98)
-- Add tests for block-form of logging (#96)
-
-# [0.23.5] - 2023-04-13
-
-- Cast the value to string when checking presence in string list (#95)
-
-# [0.23.4] - 2023-04-12
-
-- Remove GRPC (#93)
-
-# [0.23.3] - 2023-04-07
-
-- Use exponential backoff for log level uploading (#92)
-
-# [0.23.2] - 2023-04-04
-
-- Move log collection logs from INFO to DEBUG (#91)
-- Fix: Handle trailing slash in PREFAB_API_URL (#90)
-
-# [0.23.1] - 2023-03-30
-
-- ActiveStorage not defined in Rails < 5.2 (#87)
-
-# [0.23.0] - 2023-03-28
-
-- Convenience for setting Rails.logger (#85)
-- Log evaluation according to rules (#81)
-
-# [0.22.0] - 2023-03-15
-
-- Report log paths and usages (#79)
-- Accept hash or keyword args in `initialize` (#78)

data/CODEOWNERS

@@ -1 +0,0 @@
-*    @prefab-cloud/prefabdevs @prefab-cloud/prefabmaintainers @prefab-cloud/prefabadmins

data/README.md

@@ -1,94 +0,0 @@
-# prefab-cloud-ruby
-
-Ruby Client for Prefab Feature Flags, Dynamic log levels, and Config as a Service: https://www.prefab.cloud
-
-```ruby
-client = Prefab::Client.new
-
-context = {
-  user: {
-    team_id: 432,
-    id: 123,
-    subscription_level: 'pro',
-    email: "alice@example.com"
-  }
-}
-
-result = client.enabled? "my-first-feature-flag", context
-
-puts "my-first-feature-flag is: #{result}"
-```
-
-See full documentation https://docs.prefab.cloud/docs/ruby-sdk/ruby
-
-## Supports
-
-- Feature Flags
-- Dynamic log levels
-- Live Config
-- WebUI for tweaking config, log levels, and feature flags
-
-## Important note about Forking and realtime updates
-
-Many ruby web servers fork. When the process is forked, the current realtime update stream is disconnected. If you're using Puma or Unicorn, do the following.
-
-```ruby
-#config/initializers/prefab.rb
-$prefab = Prefab::Client.new
-$prefab.set_rails_loggers
-```
-
-```ruby
-#puma.rb
-on_worker_boot do
-  $prefab = $prefab.fork
-  $prefab.set_rails_loggers
-end
-```
-
-```ruby
-# unicorn.rb
-after_fork do |server, worker|
-  $prefab = $prefab.fork
-  $prefab.set_rails_loggers
-end
-```
-
-## Logging & Debugging
-
-In classpath or ~/.prefab.default.config.yaml set
-
-```
-log-level:
-  cloud.prefab: debug
-```
-
-To debug issues before this config file has been read, set env var
-
-```
-PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL=debug
-```
-
-## Contributing to prefab-cloud-ruby
-
-- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-- Fork the project.
-- Start a feature/bugfix branch.
-- Commit and push until you are happy with your contribution.
-- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-## Release
-
-```shell
-update the changelog
-update VERSION
-bundle exec rake gemspec:generate
-git commit & push
-REMOTE_BRANCH=main LOCAL_BRANCH=main bundle exec rake release
-```
-
-## Copyright
-
-Copyright (c) 2023 Jeff Dwyer. See LICENSE.txt for further details.

data/bin/console

@@ -1,21 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'irb'
-require 'bundler/setup'
-
-gemspec = Dir.glob(File.expand_path("../../*.gemspec", __FILE__)).first
-spec = Gem::Specification.load(gemspec)
-
-# Add the require paths to the $LOAD_PATH
-spec.require_paths.each do |path|
-  full_path = File.expand_path("../" + path, __dir__)
-  $LOAD_PATH.unshift(full_path) unless $LOAD_PATH.include?(full_path)
-end
-
-spec.require_paths.each do |path|
-  require "./lib/prefab-cloud-ruby"
-end
-
-# Start an IRB session
-IRB.start(__FILE__)

data/compile_protos.sh

@@ -1,18 +0,0 @@
-#!/usr/bin/env bash
-
-set -e
-
-gem install grpc-tools
-
-(
-  cd ../prefab-cloud
-  git pull --rebase
-)
-
-grpc_tools_ruby_protoc -I ../prefab-cloud/ --ruby_out=lib --grpc_out=lib prefab.proto
-
-gsed -i 's/^module Prefab$/module PrefabProto/g' lib/prefab_pb.rb
-
-# on M1 you need to
-# 1. run in rosetta
-# 2. mv gems/2.6.0/gems/grpc-tools-1.43.1/bin/x86_64-macos x86-macos

data/lib/prefab/config_client_presenter.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Prefab
-  class ConfigClientPresenter
-    def initialize(size:, source:, project_id:, project_env_id:, api_key_id:)
-      @size = size
-      @source = source
-      @project_id = project_id
-      @project_env_id = project_env_id
-      @api_key_id = api_key_id
-    end
-
-    def to_s
-      "Configuration Loaded count=#{@size} source=#{@source} project=#{@project_id} project-env=#{@project_env_id} prefab.api-key-id=#{@api_key_id}"
-    end
-  end
-end
-

data/lib/prefab/config_value_unwrapper.rb

@@ -1,115 +0,0 @@
-# frozen_string_literal: true
-
-module Prefab
-  class ConfigValueUnwrapper
-    LOG = Prefab::InternalLogger.new(ConfigValueUnwrapper)
-    CONFIDENTIAL_PREFIX = "*****"
-    attr_reader :weighted_value_index
-
-    def initialize(config_value, resolver, weighted_value_index = nil)
-      @config_value = config_value
-      @resolver = resolver
-      @weighted_value_index = weighted_value_index
-    end
-
-    def reportable_wrapped_value
-      if @config_value.confidential || @config_value.decrypt_with&.length&.positive?
-        # Unique hash for differentiation
-        Prefab::ConfigValueWrapper.wrap("#{CONFIDENTIAL_PREFIX}#{Digest::MD5.hexdigest(unwrap)[0, 5]}")
-      else
-        @config_value
-      end
-    end
-
-    def reportable_value
-      Prefab::ConfigValueUnwrapper.new(reportable_wrapped_value, @resolver, @weighted_value_index).unwrap
-    end
-
-    def raw_config_value
-      @config_value
-    end
-
-    # this will return the actual value of confidential, use reportable_value unless you need it
-    def unwrap
-      raw = case @config_value.type
-            when :int, :string, :double, :bool, :log_level
-              @config_value.public_send(@config_value.type)
-            when :string_list
-              @config_value.string_list.values
-            else
-              LOG.error "Unknown type: #{@config_value.type}"
-              raise "Unknown type: #{@config_value.type}"
-            end
-      if @config_value.has_decrypt_with?
-        decryption_key = @resolver.get(@config_value.decrypt_with)&.unwrapped_value
-        if decryption_key.nil?
-          LOG.warn "No value for decryption key #{@config_value.decrypt_with} found."
-          return ""
-        else
-          unencrypted = Prefab::Encryption.new(decryption_key).decrypt(raw)
-          return unencrypted
-        end
-      end
-
-      raw
-    end
-
-    def self.deepest_value(config_value, config, context, resolver)
-      if config_value&.type == :weighted_values
-        value, index = Prefab::WeightedValueResolver.new(
-          config_value.weighted_values.weighted_values,
-          config.key,
-          context.get(config_value.weighted_values.hash_by_property_name)
-        ).resolve
-
-        new(deepest_value(value.value, config, context, resolver).raw_config_value, resolver, index)
-
-      elsif config_value&.type == :provided
-        if :ENV_VAR == config_value.provided.source
-          raw = ENV[config_value.provided.lookup]
-          if raw.nil?
-            raise Prefab::Errors::MissingEnvVarError.new("Missing environment variable #{config_value.provided.lookup}")
-          else
-            coerced = coerce_into_type(raw, config, config_value.provided.lookup)
-            new(Prefab::ConfigValueWrapper.wrap(coerced, confidential: config_value.confidential), resolver)
-          end
-        else
-          raise "Unknown Provided Source #{config_value.provided.source}"
-        end
-      else
-        new(config_value, resolver)
-      end
-    end
-
-    # Don't allow env vars to resolve to a value_type other than the config's value_type
-    def self.coerce_into_type(value_string, config, env_var_name)
-      case config.value_type
-      when :INT then Integer(value_string)
-      when :DOUBLE then Float(value_string)
-      when :STRING then String(value_string)
-      when :STRING_LIST then
-        maybe_string_list = YAML.load(value_string)
-        case maybe_string_list
-        when Array
-          maybe_string_list
-        else
-          raise raise Prefab::Errors::EnvVarParseError.new(value_string, config, env_var_name)
-        end
-      when :BOOL then
-        maybe_bool = YAML.load(value_string)
-        case maybe_bool
-        when TrueClass, FalseClass
-          maybe_bool
-        else
-          raise Prefab::Errors::EnvVarParseError.new(value_string, config, env_var_name)
-        end
-      when :NOT_SET_VALUE_TYPE
-        YAML.load(value_string)
-      else
-        raise Prefab::Errors::EnvVarParseError.new(value_string, config, env_var_name)
-      end
-    rescue ArgumentError
-      raise Prefab::Errors::EnvVarParseError.new(value_string, config, env_var_name)
-    end
-  end
-end

data/lib/prefab/config_value_wrapper.rb

@@ -1,18 +0,0 @@
-module Prefab
-  class ConfigValueWrapper
-    def self.wrap(value, confidential: nil)
-      case value
-      when Integer
-        PrefabProto::ConfigValue.new(int: value, confidential: confidential)
-      when Float
-        PrefabProto::ConfigValue.new(double: value, confidential: confidential)
-      when TrueClass, FalseClass
-        PrefabProto::ConfigValue.new(bool: value, confidential: confidential)
-      when Array
-        PrefabProto::ConfigValue.new(string_list: PrefabProto::StringList.new(values: value.map(&:to_s)), confidential: confidential)
-      else
-        PrefabProto::ConfigValue.new(string: value.to_s, confidential: confidential)
-      end
-    end
-  end
-end

data/lib/prefab/context.rb

@@ -1,179 +0,0 @@
-# frozen_string_literal: true
-
-module Prefab
-  class Context
-    BLANK_CONTEXT_NAME = ''
-
-    class NamedContext
-      attr_reader :name
-
-      def initialize(name, hash)
-        @hash = {}
-        @name = name.to_s
-
-        merge!(hash)
-      end
-
-      def get(parts)
-        @hash[parts]
-      end
-
-      def merge!(other)
-        @hash = @hash.merge(other.transform_keys(&:to_s))
-      end
-
-      def to_h
-        @hash
-      end
-
-      def key
-        "#{@name}:#{get('key')}"
-      end
-
-      def to_proto
-        PrefabProto::Context.new(
-          type: name,
-          values: to_h.transform_values do |value|
-            ConfigValueWrapper.wrap(value)
-          end
-        )
-      end
-    end
-
-    THREAD_KEY = :prefab_context
-    attr_reader :contexts, :seen_at
-
-    class << self
-      def current=(context)
-        Thread.current[THREAD_KEY] = context
-      end
-
-      def current
-        Thread.current[THREAD_KEY] ||= new
-      end
-
-      def with_context(context)
-        old_context = Thread.current[THREAD_KEY]
-        Thread.current[THREAD_KEY] = new(context)
-        yield
-      ensure
-        Thread.current[THREAD_KEY] = old_context
-      end
-
-      def with_merged_context(context)
-        old_context = Thread.current[THREAD_KEY]
-        Thread.current[THREAD_KEY] = merge_with_current(context)
-        yield
-      ensure
-        Thread.current[THREAD_KEY] = old_context
-      end
-
-      def clear_current
-        Thread.current[THREAD_KEY] = nil
-      end
-
-      def merge_with_current(new_context_properties = {})
-        new(current.to_h.merge(new_context_properties.to_h))
-      end
-    end
-
-    def initialize(context = {})
-      @contexts = {}
-      @seen_at = Time.now.utc.to_i
-
-      if context.is_a?(NamedContext)
-        @contexts[context.name] = context
-      elsif context.is_a?(Hash)
-        context.map do |name, values|
-          if values.is_a?(Hash)
-            @contexts[name.to_s] = NamedContext.new(name, values)
-          else
-            warn '[DEPRECATION] Prefab contexts should be a hash with a key of the context name and a value of a hash.'
-
-            @contexts[BLANK_CONTEXT_NAME] ||= NamedContext.new(BLANK_CONTEXT_NAME, {})
-            @contexts[BLANK_CONTEXT_NAME].merge!({ name => values })
-          end
-        end
-      else
-        raise ArgumentError, 'must be a Hash or a NamedContext'
-      end
-    end
-
-    def blank?
-      contexts.empty?
-    end
-
-    def set(name, hash)
-      @contexts[name.to_s] = NamedContext.new(name, hash)
-    end
-
-    def get(property_key)
-      name, key = property_key.split('.', 2)
-
-      if key.nil?
-        name = BLANK_CONTEXT_NAME
-        key = property_key
-      end
-
-      contexts[name]&.get(key)
-    end
-
-    def to_h
-      contexts.transform_values(&:to_h)
-    end
-
-    def clear
-      @contexts = {}
-    end
-
-    def context(name)
-      contexts[name.to_s] || NamedContext.new(name, {})
-    end
-
-    def merge_default(defaults)
-      defaults.keys.each do |name|
-        set(name, context(name).merge!(defaults[name]))
-      end
-
-      self
-    end
-
-    def to_proto(namespace)
-      prefab_context = {
-        'current-time' => ConfigValueWrapper.wrap(Prefab::TimeHelpers.now_in_ms)
-      }
-
-      prefab_context['namespace'] = ConfigValueWrapper.wrap(namespace) if namespace&.length&.positive?
-
-      PrefabProto::ContextSet.new(
-        contexts: contexts.map do |name, context|
-          context.to_proto
-        end.concat([PrefabProto::Context.new(type: 'prefab',
-                                             values: prefab_context)])
-      )
-    end
-
-    def slim_proto
-      PrefabProto::ContextSet.new(
-        contexts: contexts.map do |_, context|
-          context.to_proto
-        end
-      )
-    end
-
-    def grouped_key
-      contexts.map do |_, context|
-        context.key
-      end.sort.join('|')
-    end
-
-    include Comparable
-    def <=>(other)
-      if other.is_a?(Prefab::Context)
-        to_h <=> other.to_h
-      else
-        super
-      end
-    end
-  end
-end

data/lib/prefab/context_shape.rb

@@ -1,20 +0,0 @@
-module Prefab
-  class ContextShape
-    MAPPING = {
-      Integer => 1,
-      String => 2,
-      Float => 4,
-      TrueClass => 5,
-      FalseClass => 5,
-      Array => 10,
-    }.freeze
-
-    # We default to String if the type isn't a primitive we support.
-    # This is because we do a `to_s` in the CriteriaEvaluator.
-    DEFAULT = MAPPING[String]
-
-    def self.field_type_number(value)
-      MAPPING.fetch(value.class, DEFAULT)
-    end
-  end
-end