prefab-cloud-ruby 1.6.0.pre2 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20317c94cd1f107434e8d4df80851ecaecf026cc406dc421e0f36a769f1cbda1
-  data.tar.gz: 5efce4e6ab0ada5a01257c41e716726e591eab2e91ec70fa9f57e220cfd1cd5d
+  metadata.gz: e0cc90e8b5acc15676a5101e6cbd902e37e38781ebb6d6fb33c892f938df3bbc
+  data.tar.gz: 68e1dbb144273aa9c54fb11efdf9333f2260a8805705d2aff47885719d995b7f
 SHA512:
-  metadata.gz: 5bdf94c45e6c0a9c3e49939f392670cf0ed499eb5dfdbe63a8bfdf63ad6f501dbea7e6802b6053e2ee472d006663bfd353d2fe73be10ff5f68e06a574430e88b
-  data.tar.gz: f29975d152647db4ba6ee3249732790dc89ed709d50b313a228c809f63b5ba770fae06f529a9ce6d213c12f1f6f6904ecb84f007824bcbfef6b88fe0f34c4f01
+  metadata.gz: 9518b4ab1b19e6f7532fd29146b26bd0fd4e3527dbc4fde041b61b712a843db95f6f9355d8afb0b2496436aab711ec5f4a57075dbaf80c7afd4bb85c35d92b53
+  data.tar.gz: d2f4806025b4c965792653149ac9976b47ed4f687bbbb9b73cf58af091a55d4ad03affe49e6cd55aba132fa1a49f422f73900a2d295abb3afb2867cf204bb533

data/.github/workflows/ruby.yml

@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0', '3.1']
+        ruby-version: ['2.7', '3.0', '3.3']
 
     steps:
     - uses: actions/checkout@v3
@@ -36,7 +36,9 @@ jobs:
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+        bundler-cache: false # runs 'bundle install' and caches installed gems automatically
+    - name: Install dependencies
+      run: bundle install --without development --jobs 4 --retry 3
     - name: Run tests
       run: bundle exec rake
       env:

data/CHANGELOG.md

@@ -1,11 +1,20 @@
 # Changelog
 
-## Unreleased
+## 1.6.1 - 2024-03-28
+
+- Performance optimizations (#178)
+- Global context (#182)
+
+## 1.6.0 - 2024-03-27
 
 - Use semantic_logger for internal logging (#173)
 - Remove Prefab::LoggerClient as a logger for end users (#173)
 - Provide log_filter for end users (#173)
 
+## 1.5.1 - 2024-02-22
+
+- Fix: Send context shapes by default (#174)
+
 ## 1.5.0 - 2024-02-12
 
 - Fix potential inconsistent Context behavior (#172)

data/Gemfile

@@ -7,8 +7,7 @@ gem 'google-protobuf', platforms: :ruby
 gem 'ld-eventsource'
 gem 'uuid'
 
-gem 'activesupport',  '>= 4'
-gem 'actionpack',  '>= 4'
+gem 'activesupport', '>= 4'
 
 gem 'semantic_logger', require: "semantic_logger/sync"
 

data/Gemfile.lock

@@ -1,23 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.1.2)
-      actionview (= 7.1.2)
-      activesupport (= 7.1.2)
-      nokogiri (>= 1.8.5)
-      racc
-      rack (>= 2.2.4)
-      rack-session (>= 1.0.1)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.2)
-      rails-html-sanitizer (~> 1.6)
-    actionview (7.1.2)
-      activesupport (= 7.1.2)
-      builder (~> 3.1)
-      erubi (~> 1.11)
-      rails-dom-testing (~> 2.2)
-      rails-html-sanitizer (~> 1.6)
-    activesupport (7.1.2)
+    activesupport (7.1.3.2)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -27,34 +11,48 @@ GEM
       minitest (>= 5.1)
       mutex_m
       tzinfo (~> 2.0)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
     ansi (1.5.0)
     base64 (0.2.0)
-    benchmark-ips (2.10.0)
-    bigdecimal (3.1.4)
+    benchmark-ips (2.13.0)
+    bigdecimal (3.1.7)
     builder (3.2.4)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
-    crass (1.0.6)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
-    docile (1.3.5)
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
-    drb (2.2.0)
-      ruby2_keywords
-    erubi (1.12.0)
-    faraday (1.3.0)
+    docile (1.4.0)
+    domain_name (0.6.20240107)
+    drb (2.2.1)
+    faraday (1.10.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
       faraday-net_http (~> 1.0)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
     faraday-net_http (1.0.1)
-    ffi (1.15.5)
-    ffi-compiler (1.0.1)
-      ffi (>= 1.0.0)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    ffi (1.16.3)
+    ffi-compiler (1.3.2)
+      ffi (>= 1.15.5)
       rake
-    git (1.13.0)
+    git (1.19.1)
       addressable (~> 2.8)
       rchardet (~> 1.8)
     github_api (0.19.0)
@@ -63,20 +61,21 @@ GEM
       faraday (>= 0.8, < 2)
       hashie (~> 3.5, >= 3.5.2)
       oauth2 (~> 1.0)
-    google-protobuf (3.22.2)
-    googleapis-common-protos-types (1.5.0)
-      google-protobuf (~> 3.14)
+    google-protobuf (3.25.3)
+    googleapis-common-protos-types (1.14.0)
+      google-protobuf (~> 3.18)
     hashie (3.6.0)
-    highline (2.0.3)
-    http (5.0.1)
-      addressable (~> 2.3)
+    highline (3.0.1)
+    http (5.2.0)
+      addressable (~> 2.8)
+      base64 (~> 0.1)
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
-      llhttp-ffi (~> 0.3.0)
-    http-cookie (1.0.4)
+      llhttp-ffi (~> 0.5.0)
+    http-cookie (1.0.5)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
-    i18n (1.14.1)
+    i18n (1.14.4)
       concurrent-ruby (~> 1.0)
     juwelier (2.4.9)
       builder
@@ -90,34 +89,32 @@ GEM
       rake
       rdoc
       semver2
-    jwt (2.2.2)
+    jwt (2.8.1)
+      base64
     kamelcase (0.0.2)
       semver2 (~> 3)
-    ld-eventsource (2.2.0)
+    ld-eventsource (2.2.2)
       concurrent-ruby (~> 1.0)
       http (>= 4.4.1, < 6.0.0)
-    llhttp-ffi (0.3.1)
+    llhttp-ffi (0.5.0)
       ffi-compiler (~> 1.0)
       rake (~> 13.0)
-    loofah (2.21.4)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.12.0)
     macaddr (1.7.2)
       systemu (~> 2.6.5)
-    mini_portile2 (2.8.2)
-    minitest (5.16.2)
-    minitest-focus (1.3.1)
+    mini_portile2 (2.8.5)
+    minitest (5.22.3)
+    minitest-focus (1.4.0)
       minitest (>= 4, < 6)
-    minitest-reporters (1.5.0)
+    minitest-reporters (1.6.1)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
     multi_json (1.15.0)
     multi_xml (0.6.0)
-    multipart-post (2.1.1)
+    multipart-post (2.4.0)
     mutex_m (0.2.0)
-    nokogiri (1.15.2)
+    nokogiri (1.16.3)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     oauth2 (1.4.11)
@@ -126,41 +123,32 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 4)
-    psych (3.3.1)
-    public_suffix (4.0.6)
-    racc (1.7.0)
-    rack (3.0.6.1)
-    rack-session (2.0.0)
-      rack (>= 3.0.0)
-    rack-test (2.1.0)
-      rack (>= 1.3)
-    rails-dom-testing (2.2.0)
-      activesupport (>= 5.0.0)
-      minitest
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.6.0)
-      loofah (~> 2.21)
-      nokogiri (~> 1.14)
-    rake (13.0.6)
+    psych (5.1.2)
+      stringio
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rack (3.0.10)
+    rake (13.1.0)
     rchardet (1.8.0)
-    rdoc (6.3.3)
-    ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.4)
+    rdoc (6.6.3.1)
+      psych (>= 4.0.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
     semantic_logger (4.15.0)
       concurrent-ruby (~> 1.0)
     semver2 (3.4.2)
-    simplecov (0.18.5)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    stringio (3.1.0)
     systemu (2.6.5)
     thread_safe (0.3.6)
-    timecop (0.9.4)
+    timecop (0.9.8)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.8)
     uuid (2.3.9)
       macaddr (~> 1.0)
 
@@ -168,7 +156,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  actionpack (>= 4)
   activesupport (>= 4)
   benchmark-ips
   bundler

data/README.md

@@ -34,7 +34,7 @@ Many ruby web servers fork. When the process is forked, the current realtime upd
 
 ```ruby
 #config/application.rb
-Prefab.init # reads PREFAB_API_KEY env var
+Prefab.init # reads PREFAB_API_KEY env var by default
 ```
 
 ```ruby
@@ -53,23 +53,51 @@ end
 
 ## Logging & Debugging
 
-To use dynamic logging. Install https://logger.rocketjob.io/rails.html and then add Prefab as a dynamic filter.
+To use dynamic logging, we recommend [semantic logger]. Add semantic_logger to your Gemfile and then we'll configure our app to use it.
 
+### Plain ol' Ruby
+
+```ruby
+# Gemfile
+gem "semantic_logger"
 ```
+
+```ruby
+require "semantic_logger"
+require "prefab"
+
+Prefab.init
+
+SemanticLogger.sync!
+SemanticLogger.default_level = :trace # Prefab will take over the filtering
+SemanticLogger.add_appender(
+  io: $stdout,
+  formatter: :json,
+  filter: Prefab.log_filter,
+)
+```
+
+### With Rails
+
+```ruby
+# Gemfile
 gem "amazing_print"
 gem "rails_semantic_logger"
 ```
+
 ```ruby
-#application.rb
+# config/application.rb
+Prefab.init
+
+# config/initializers/logging.rb
 SemanticLogger.sync!
 SemanticLogger.default_level = :trace # Prefab will take over the filtering
 SemanticLogger.add_appender(
   io: $stdout,
-  formatter: Rails.env.development? ? :default : :json,
+  formatter: Rails.env.development? ? :color : :json,
   filter: Prefab.log_filter,
 )
-Prefab.init
-````
+```
 
 ```ruby
 #puma.rb
@@ -102,3 +130,5 @@ REMOTE_BRANCH=main LOCAL_BRANCH=main bundle exec rake release
 ## Copyright
 
 Copyright (c) 2024 Prefab, Inc. See LICENSE.txt for further details.
+
+[semantic logger]: https://logger.rocketjob.io/

data/Rakefile

@@ -9,42 +9,45 @@ rescue Bundler::BundlerError => e
   warn 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
+
 require 'rake'
-require 'juwelier'
-Juwelier::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
-  gem.name = 'prefab-cloud-ruby'
-  gem.homepage = 'http://github.com/prefab-cloud/prefab-cloud-ruby'
-  gem.license = 'MIT'
-  gem.summary = %(Prefab Ruby Infrastructure)
-  gem.description = %(Feature Flags, Live Config, and Dynamic Log Levels as a service)
-  gem.email = 'jdwyer@prefab.cloud'
-  gem.authors = ['Jeff Dwyer']
+task default: :test
 
-  # dependencies defined in Gemfile
-end
-Juwelier::RubygemsDotOrgTasks.new
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
+unless ENV['CI']
+  require 'juwelier'
+  Juwelier::Tasks.new do |gem|
+    # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+    gem.name = 'prefab-cloud-ruby'
+    gem.homepage = 'http://github.com/prefab-cloud/prefab-cloud-ruby'
+    gem.license = 'MIT'
+    gem.summary = %(Prefab Ruby Infrastructure)
+    gem.description = %(Feature Flags, Live Config, and Dynamic Log Levels as a service)
+    gem.email = 'jdwyer@prefab.cloud'
+    gem.authors = ['Jeff Dwyer']
 
-desc 'Code coverage detail'
-task :simplecov do
-  ENV['COVERAGE'] = 'true'
-  Rake::Task['test'].execute
-end
+    # dependencies defined in Gemfile
+  end
+  Juwelier::RubygemsDotOrgTasks.new
+  require 'rake/testtask'
+  Rake::TestTask.new(:test) do |test|
+    test.libs << 'lib' << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
 
-task default: :test
+  desc 'Code coverage detail'
+  task :simplecov do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task['test'].execute
+  end
 
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ''
+  require 'rdoc/task'
+  Rake::RDocTask.new do |rdoc|
+    version = File.exist?('VERSION') ? File.read('VERSION') : ''
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "prefab-cloud-ruby #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+    rdoc.rdoc_dir = 'rdoc'
+    rdoc.title = "prefab-cloud-ruby #{version}"
+    rdoc.rdoc_files.include('README*')
+    rdoc.rdoc_files.include('lib/**/*.rb')
+  end
 end

data/VERSION

@@ -1 +1 @@
-1.6.0.pre2
+1.6.1

data/dev/allocation_stats

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+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
+
+require 'prefab-cloud-ruby'
+
+$prefab = Prefab::Client.new(collect_logger_counts: false, collect_evaluation_summaries: false,
+                             context_upload_mode: :none)
+$prefab.get('prefab.auth.allowed_origins')
+
+puts '-' * 80
+
+require 'allocation_stats'
+
+$runs = 100
+
+def measure(description)
+  puts "Measuring #{description}..."
+  stats = $prefab.with_context(user: { email_suffix: 'yahoo.com' }) do
+    AllocationStats.trace do
+      $runs.times do
+        yield
+      end
+    end
+  end
+
+  allocations = stats.allocations(alias_paths: true).group_by(:sourcefile, :sourceline, :class)
+
+  if ENV['TOP']
+    puts allocations.sort_by_size.to_text.split("\n").first(20)
+  end
+
+  puts "Total allocations: #{allocations.all.values.map(&:size).sum}"
+  puts "Total memory: #{allocations.all.values.flatten.map(&:memsize).sum}"
+  puts stats.gc_profiler_report
+end
+
+measure "no-JIT context (#{$runs} runs)" do
+  $prefab.get('prefab.auth.allowed_origins')
+end
+
+puts "\n\n"
+
+measure "with JIT context (#{$runs} runs)" do
+  $prefab.get('prefab.auth.allowed_origins', { a: { b: "c" } })
+end

data/dev/benchmark

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+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
+
+require 'prefab-cloud-ruby'
+require 'benchmark/ips'
+
+prefab = Prefab::Client.new(collect_logger_counts: false, collect_evaluation_summaries: false,
+                            context_upload_mode: :none)
+
+prefab.get('prefab.auth.allowed_origins')
+
+prefab.with_context(user: { email_suffix: 'yahoo.com' }) do
+  Benchmark.ips do |x|
+    x.report("noop") do
+    end
+
+    x.report('prefab.get') do
+      prefab.get('prefab.auth.allowed_origins')
+    end
+
+    x.report('prefab.get with jit context') do
+      prefab.get('prefab.auth.allowed_origins', { a: { b: "c" } })
+    end
+  end
+end

data/lib/prefab/client.rb

@@ -29,6 +29,9 @@ module Prefab
       end
 
       context.clear
+
+      Prefab::Context.global_context = @options.global_context
+
       # start config client
       config_client
     end
@@ -51,6 +54,7 @@ module Prefab
 
     def log_path_aggregator
       return nil if @options.collect_max_paths <= 0
+
       @log_path_aggregator ||= LogPathAggregator.new(client: self, max_paths: @options.collect_max_paths,
                                                      sync_interval: @options.collect_sync_interval)
     end
@@ -87,14 +91,7 @@ module Prefab
     end
 
     def set_rails_loggers
-      Rails.logger = log
-      ActionView::Base.logger = log
-      ActionController::Base.logger = log
-      ActiveJob::Base.logger = log if defined?(ActiveJob)
-      ActiveRecord::Base.logger = log
-      ActiveStorage.logger = log if defined?(ActiveStorage)
-
-      LogSubscribers::ActionControllerSubscriber.attach_to :action_controller unless @options.disable_action_controller_logging
+      warn '[DEPRECATION] `set_rails_loggers` is deprecated since 1.6. Please use semantic_logger or `Prefab.log_filter` instead.'
     end
 
     def on_update(&block)

data/lib/prefab/config_client.rb

@@ -60,7 +60,7 @@ module Prefab
         @base_client.example_contexts_aggregator.record(context)
       end
 
-      evaluation = _get(key, context)
+      evaluation = _get(key, properties)
 
       @base_client.context_shape_aggregator&.push(context)
 
@@ -168,7 +168,7 @@ module Prefab
         ]
       end.to_h
 
-      @config_resolver.default_context = default_contexts || {}
+      Prefab::Context.default_context = default_contexts || {}
 
       configs.configs.each do |config|
         @config_loader.set(config, source)

data/lib/prefab/config_resolver.rb

@@ -5,8 +5,6 @@ module Prefab
     attr_accessor :project_env_id # this will be set by the config_client when it gets an API response
     attr_reader :local_store
 
-    attr_accessor :default_context
-
     def initialize(base_client, config_loader)
       @lock = Concurrent::ReadWriteLock.new
       @local_store = {}
@@ -14,7 +12,6 @@ module Prefab
       @project_env_id = 0 # we don't know this yet, it is set from the API results
       @base_client = base_client
       @on_update = nil
-      @default_context = {}
       make_local
     end
 
@@ -59,11 +56,13 @@ module Prefab
     end
 
     def make_context(properties)
-      if properties == NO_DEFAULT_PROVIDED || properties.nil?
+      if properties.is_a?(Context)
+        properties
+      elsif properties == NO_DEFAULT_PROVIDED || properties.nil?
         Context.current
       else
-        Context.merge_with_current(properties)
-      end.merge_default(default_context || {})
+        Context.join(parent: Context.current, hash: properties, id: :jit)
+      end
     end
 
     private