roo_on_rails 2.0.0.pre.pre.2 → 2.2.0

data/.circleci/config.yml.erb

@@ -10,17 +10,34 @@
 #   * GEM_HOME
 #   * BUNDLE_PATH
 #   * BUNDLE_BIN
-
+common_ruby_environment: &common_ruby_environment
+  environment:
+    RAILS_ENV: test
+    PGHOST: 127.0.0.1
+    PGUSER: postgres
+    POSTGRES_HOST_AUTH_METHOD: "trust"
+common_pg_environment_vars: &common_pg_environment_vars
+    POSTGRES_USER: postgres
+    POSTGRES_DB: ror_testapp_test
+    POSTGRES_HOST_AUTH_METHOD: "trust"
 <%
   builds = [
-    ['2.4.6', 'rails_4'],
-    ['2.4.6', 'rails_5'],
-    ['2.4.6', 'rails_5_1'],
-    ['2.4.6', 'rails_5_2'],
-    ['2.5.5', 'rails_4'],
-    ['2.5.5', 'rails_5'],
-    ['2.5.5', 'rails_5_1'],
-    ['2.5.5', 'rails_5_2']
+    ['2.5.9', 'rails_5_2'],
+    ['2.5.9', 'rails_6_0'],
+    ['2.5.9', 'rails_6_1'],
+
+    ['2.6.10', 'rails_5_2'],
+    ['2.6.10', 'rails_6_0'],
+    ['2.6.10', 'rails_6_1'],
+
+    ['2.7.6', 'rails_6_0'],
+    ['2.7.6', 'rails_6_1'],
+
+    ['3.0.4', 'rails_6_0'],
+    ['3.0.4', 'rails_6_1'],
+
+    ['3.1.2', 'rails_6_1'],
+    ['3.1.2', 'rails_7_0']
   ]
 %>
 version: 2
@@ -29,9 +46,11 @@ jobs:
   build_<%= ruby %>_<%= variant %>:
     docker:
       - image: ruby:<%= ruby %>-alpine
+        <<: *common_ruby_environment
       - image: postgres:9.6-alpine
         environment:
           PGDATA: /dev/shm/pgdata
+          <<: *common_pg_environment_vars
       - image: redis:4-alpine
     steps:
       - checkout

data/.codecov.yml

@@ -2,6 +2,9 @@ codecov:
   notify:
     require_ci_to_pass: yes
 
+ignore:
+  - "spec/support"
+
 coverage:
   precision: 2
   round: down

data/.ruby-version

@@ -1 +1 @@
-2.4.1
+2.5.9

data/Appraisals

@@ -1,29 +1,44 @@
-appraise 'rails-4' do
-  gem 'rails', '~> 4.2'
+appraise 'rails-5-2' do
+  gem 'rails', '~> 5.2.0'
+  gem 'bootsnap', '>= 1.1.0', require: false
   gem 'sqlite3', '~> 1.3.6'
-  gem 'pg', '~> 0.11'
-  gem 'sprockets', '~>3.0'
+  gem 'pg', '~> 0.18'
   gem 'rake', '13.0.1'
+  gem 'dotenv', '~> 2.7.6'
 end
 
-appraise 'rails-5' do
-  gem 'rails', '~> 5.0.0'
-  gem 'sqlite3', '~> 1.3.6'
+appraise 'rails-6-0' do
+  gem 'rails', '~> 6.0.3'
+  gem 'bootsnap', '>= 1.1.0', require: false
+  gem 'sqlite3', '~> 1.4'
   gem 'pg', '~> 0.18'
   gem 'rake', '13.0.1'
+  gem 'dotenv', '~> 2.7.6'
 end
 
-appraise 'rails-5-1' do
-  gem 'rails', '~> 5.1.0'
-  gem 'sqlite3', '~> 1.3.6'
-  gem 'pg', '~> 0.18'
-  gem 'rake', '13.0.1'
+appraise 'rails-6-1' do
+  gem 'rails', '~> 6.1.5'
+  gem 'bootsnap', require: false
+  gem 'sqlite3'
+  gem 'pg'
+  gem 'rake'
+  gem 'net-smtp', require: false
+  gem 'net-pop', require: false
+  gem 'net-imap', require: false
+  gem 'webpacker', '~>3.0'
+  gem 'psych', '< 4'
+  gem 'dotenv', '~> 2.7.6'
 end
 
-appraise 'rails-5-2' do
-  gem 'rails', '~> 5.2.0'
-  gem 'bootsnap', '>= 1.1.0', require: false
-  gem 'sqlite3', '~> 1.3.6'
-  gem 'pg', '~> 0.18'
-  gem 'rake', '13.0.1'
+appraise 'rails-7-0' do
+  gem 'rails', '~> 7.0.3'
+  gem 'bootsnap', require: false
+  gem 'sqlite3'
+  gem 'pg'
+  gem 'rake'
+  gem 'net-smtp', require: false
+  gem 'net-pop', require: false
+  gem 'net-imap', require: false
+  gem 'webpacker', '~>3.0'
+  gem 'psych', '< 4'
 end

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+# v2.2.0
+
+Breaking changes:
+
+- Drops Rails 4 support
+- Drops Rails 5.0 support
+- Drops Rails 5.1 support
+- Drops Ruby 2.4 support
+
+Features:
+
+- Adds Rails 6.1 support
+- Adds Rails 7.0 support
+- Adds Ruby 2.7 support
+- Adds Ruby 3.0 support
+- Adds Ruby 3.1 support
+
+# v2.1.2
+
+Bug fix:
+
+- fixes PopulateEnvFromJWT caching issue where a key that couldn't be fetched would be cached
+
+# v2.1.0
+
+Features:
+
+- Rails 6 compatibility
+
 # v2.0.0-pre.2
 
 Features:

data/README.md

@@ -21,9 +21,6 @@
     - [Disabling SSL enforcement](#disabling-ssl-enforcement)
   - [Database configuration](#database-configuration)
   - [Sidekiq](#sidekiq)
-  - [HireFire](#hirefire)
-    - [For Web Dynos](#for-web-dynos)
-    - [For Sidekiq Workers](#for-sidekiq-workers)
   - [Logging](#logging)
   - [Identity](#identity)
   - [Google OAuth authentication](#google-oauth-authentication)
@@ -137,48 +134,6 @@ NB. If you are migrating to SLA-based queue names, do not set `SIDEKIQ_ENABLED`
 to `true` before your old queues have finished processing (this will prevent
 Sidekiq from seeing the old queues at all).
 
-### HireFire
-
-#### For Web Dynos
-
-Web dynos can be autoscaled by HireFire _only_ if it has been configured to use the `Web.Logplex.Load` source and the Heroku runtime metrics lab feature has been enabled:
-
-```bash
-$ heroku labs:enable log-runtime-metrics -a your-service-name-here
-```
-
-You will also need a log drain for HireFire, but the RooOnRails helper below should configure this for you. You can check with
-
-```bash
-$ heroku drains | grep hirefire
-https://logdrain.hirefire.io (d.00000000-0000-0000-0000-000000000000)
-
-# No drain? Add with:
-$ heroku drains:add -a your-service-name-here https://logdrain.hirefire.io
-```
-
-([HireFire docs for set up](https://help.hirefire.io/guides/logplex/load-logplex))
-
-#### For Sidekiq Workers
-
-When `HIREFIRE_TOKEN` is set an endpoint will be mounted at `/hirefire` that
-reports the required worker count as a function of queue latency. By default we
-add queue names in the style 'within1day', so if we notice an average latency in
-that queue of more than an set threshold we'll request one more worker. If we
-notice less than a threshold we'll request one less worker. These settings can
-be customised via the following ENV variables
-
-- `WORKER_INCREASE_THRESHOLD` (default 0.5)
-- `WORKER_DECREASE_THRESHOLD` (default 0.1)
-
-When setting the manager up in the HireFire web ui, the following settings must
-be used:
-
-- name: 'worker'
-- type: 'Worker.HireFire.JobQueue'
-- ratio: 1
-- decrementable: 'true'
-
 ### Logging
 
 For clearer and machine-parseable log output, the Rails logger is replaced by an
@@ -382,6 +337,11 @@ The command is designed to fix issues in many cases.
 Pull requests are welcome on GitHub at
 `https://github.com/deliveroo/roo_on_rails`.
 
+## Releasing
+
+1. Bump the version number in `lib/roo_on_rails/version.rb
+1. Add an entry to the changelog
+1. After merging to master release e.g. `bundle exec rake release`
 
 ## License
 

data/appraise

@@ -4,8 +4,7 @@
 #
 require 'yaml'
 
-
-RUBIES = ['2.4.5', '2.5.5']
+RUBIES = ['2.5.9', '2.6.10', '2.7.6', '3.0.4', '3.1.2'].freeze
 APPRAISALS = `appraisal list`.strip.split(/\s+/)
 
 # setup
@@ -14,7 +13,7 @@ RUBIES.each do |ruby|
   system 'rbenv version'
   system 'rbenv exec ruby -v'
   system 'rbenv exec bundle check || rbenv exec bundle install'
-  system "rbenv exec appraisal install"
+  system 'rbenv exec appraisal install'
 end
 
 # tests

data/gemfiles/rails_5_2.gemfile

@@ -7,8 +7,10 @@ gem "guard-rspec"
 gem "appraisal"
 gem "webmock"
 gem "pg", "~> 0.18"
-gem "sqlite3"
+gem "sqlite3", "~> 1.3.6"
 gem "rails", "~> 5.2.0"
 gem "bootsnap", ">= 1.1.0", require: false
+gem "rake", "13.0.1"
+gem "dotenv", "~> 2.7.6"
 
 gemspec path: "../"

data/gemfiles/{rails_5.gemfile → rails_6_0.gemfile}

@@ -7,7 +7,10 @@ gem "guard-rspec"
 gem "appraisal"
 gem "webmock"
 gem "pg", "~> 0.18"
-gem "sqlite3", "~> 1.3.6"
-gem "rails", "~> 5.0.0"
+gem "sqlite3", "~> 1.4"
+gem "rails", "~> 6.0.3"
+gem "bootsnap", ">= 1.1.0", require: false
+gem "rake", "13.0.1"
+gem "dotenv", "~> 2.7.6"
 
 gemspec path: "../"

data/gemfiles/rails_6_1.gemfile

@@ -0,0 +1,21 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "guard"
+gem "guard-rspec"
+gem "appraisal"
+gem "webmock"
+gem "pg"
+gem "sqlite3"
+gem "rails", "~> 6.1.5"
+gem "bootsnap", require: false
+gem "rake"
+gem "net-smtp", require: false
+gem "net-pop", require: false
+gem "net-imap", require: false
+gem "webpacker", "~>3.0"
+gem "psych", "< 4"
+gem "dotenv", "~> 2.7.6"
+
+gemspec path: "../"

data/gemfiles/rails_7_0.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "guard"
+gem "guard-rspec"
+gem "appraisal"
+gem "webmock"
+gem "pg"
+gem "sqlite3"
+gem "rails", "~> 6.1.5"
+gem "bootsnap", require: false
+gem "rake"
+gem "net-smtp", require: false
+gem "net-pop", require: false
+gem "net-imap", require: false
+gem "webpacker", "~>3.0"
+gem "psych", "< 4"
+
+gemspec path: "../"

data/lib/roo_on_rails/logger.rb

@@ -1,12 +1,7 @@
 require 'delegate'
 require 'roo_on_rails/logfmt'
 require 'rails/version'
-
-if Rails::VERSION::MAJOR < 4
-  require 'logger'
-else
-  require 'active_support/logger'
-end
+require 'active_support/logger'
 
 module RooOnRails
   # A compatible replacement for the standard Logger to provide context, similar
@@ -36,7 +31,7 @@ module RooOnRails
   class Logger < SimpleDelegator
     def initialize(io = STDOUT)
       @show_timestamp = io.tty?
-      logger = _default_logger_class.new(io).tap do |l|
+      logger = ActiveSupport::Logger.new(io).tap do |l|
         l.formatter = method(:_formatter)
       end
       super(logger)
@@ -113,13 +108,5 @@ module RooOnRails
       thread_key = @_context_stack_key ||= "roo_on_rails:logging_context:#{object_id}".freeze
       Thread.current[thread_key] ||= [{}]
     end
-
-    def _default_logger_class
-      if Rails::VERSION::MAJOR < 4
-        ::Logger
-      else
-        ActiveSupport::Logger
-      end
-    end
   end
 end

data/lib/roo_on_rails/rack/populate_env_from_jwt.rb

@@ -22,7 +22,8 @@ module RooOnRails
         @app = app
         @logger = logger
         @url_mappings = url_mappings
-        @keys = @mapped_urls = {}
+        @keys = {}
+        @mapped_urls = {}
 
         if skip_sig_verify && non_prod?
           @logger.warn "JWTs signature verifification has been switched off in development."

data/lib/roo_on_rails/railties/database.rb

@@ -3,9 +3,34 @@ module RooOnRails
     class Database < Rails::Railtie
       initializer 'roo_on_rails.database', after: 'active_record.initialize_database' do
         ActiveSupport.on_load :active_record do
-          Rails.logger.with(initializer: 'roo_on_rails.database') do |log|
-            log.debug 'loading'
+          Rails.logger.debug('[roo_on_rails.database] loading')
 
+          if Gem::Version.new(Rails.version) >= Gem::Version.new('6.1')
+            configs = ActiveRecord::Base.configurations.configurations
+            old_url_config = ActiveRecord::Base.configurations.configs_for(env_name: Rails.env, name: 'primary')
+            new_config_hash = old_url_config.configuration_hash.deep_dup
+            new_config_hash[:variables] ||= {}
+            statement_timeout = ENV.fetch('DATABASE_STATEMENT_TIMEOUT', 200)
+            # Use -1 to disable setting the statement timeout
+            new_config_hash[:variables][:statement_timeout] = statement_timeout unless statement_timeout == '-1'
+            new_config_hash[:reaping_frequency] = ENV['DATABASE_REAPING_FREQUENCY'] if ENV.key?('DATABASE_REAPING_FREQUENCY')
+            if old_url_config.respond_to?(:url)
+              new_url_config = ActiveRecord::DatabaseConfigurations::UrlConfig.new(
+                old_url_config.env_name,
+                old_url_config.name,
+                old_url_config.url,
+                new_config_hash
+              )
+            else
+              new_url_config = ActiveRecord::DatabaseConfigurations::HashConfig.new(
+                old_url_config.env_name,
+                old_url_config.name,
+                new_config_hash
+              )
+            end
+            configs.delete(old_url_config)
+            configs << new_url_config
+          else
             config = ActiveRecord::Base.configurations[Rails.env]
             config['variables'] ||= {}
             statement_timeout = ENV.fetch('DATABASE_STATEMENT_TIMEOUT', 200)
@@ -16,8 +41,9 @@ module RooOnRails
             if ENV.key?('DATABASE_REAPING_FREQUENCY')
               config['reaping_frequency'] = ENV['DATABASE_REAPING_FREQUENCY']
             end
-            ActiveRecord::Base.establish_connection
           end
+
+          ActiveRecord::Base.establish_connection
         end
       end
     end

data/lib/roo_on_rails/railties/env.rb

@@ -1,11 +1,9 @@
 module RooOnRails
   class Railtie < Rails::Railtie
     initializer 'roo_on_rails.default_env' do
-      Rails.logger.with initializer: 'roo_on_rails.default_env' do |log|
-        log.debug 'loading'
-        require 'roo_on_rails/environment'
-        RooOnRails::Environment.load
-      end
+      Rails.logger.debug '[roo_on_rails.default_env] loading'
+      require 'roo_on_rails/environment'
+      RooOnRails::Environment.load
     end
   end
 end

data/lib/roo_on_rails/railties/google_oauth.rb

@@ -4,12 +4,10 @@ module RooOnRails
   module Railties
     class GoogleOAuth < Rails::Railtie
       initializer 'roo_on_rails.google_auth.middleware' do |app|
-        Rails.logger.with initializer: 'roo_on_rails.google_auth' do |log|
-          next unless Config.google_auth_enabled?
-          log.debug 'loading'
-          _add_middleware(app)
-          _add_routes(app)
-        end
+        next unless Config.google_auth_enabled?
+        Rails.logger.debug '[roo_on_rails.google_auth] loading'
+        _add_middleware(app)
+        _add_routes(app)
       end
 
       private

data/lib/roo_on_rails/railties/http.rb

@@ -2,45 +2,43 @@ module RooOnRails
   module Railties
     class HTTP < Rails::Railtie
       initializer 'roo_on_rails.http' do |app|
-        Rails.logger.with initializer: 'roo_on_rails.http' do |log|
-          log.debug 'loading'
+        Rails.logger.debug '[roo_on_rails.http] loading'
 
-          require 'rack/timeout/base'
-          require 'rack/ssl-enforcer'
-          require 'roo_on_rails/rack/safe_timeouts'
+        require 'rack/timeout/base'
+        require 'rack/ssl-enforcer'
+        require 'roo_on_rails/rack/safe_timeouts'
 
-          ::Rack::Timeout::Logger.level = ::Logger::WARN
+        ::Rack::Timeout::Logger.level = ::Logger::WARN
 
-          app.config.middleware.insert_before(
-            ::Rack::Runtime,
-            ::Rack::Timeout,
-            service_timeout: ENV.fetch('RACK_SERVICE_TIMEOUT', 15).to_i,
-            wait_timeout: ENV.fetch('RACK_WAIT_TIMEOUT', 30).to_i
-          )
+        app.config.middleware.insert_before(
+          ::Rack::Runtime,
+          ::Rack::Timeout,
+          service_timeout: ENV.fetch('RACK_SERVICE_TIMEOUT', 15).to_i,
+          wait_timeout: ENV.fetch('RACK_WAIT_TIMEOUT', 30).to_i
+        )
 
-          middleware_to_insert_before = Rails::VERSION::MAJOR < 4 ? ::ActionDispatch::Cookies : ::Rack::Head
+        middleware_to_insert_before = ::Rack::Head
 
-          # This needs to be inserted low in the stack, before Rails returns the
-          # thread-current connection to the pool.
-          if defined?(ActiveRecord)
-            app.config.middleware.insert_before(
-              middleware_to_insert_before,
-              RooOnRails::Rack::SafeTimeouts
-            )
-          end
+        # This needs to be inserted low in the stack, before Rails returns the
+        # thread-current connection to the pool.
+        if defined?(ActiveRecord)
+          app.config.middleware.insert_before(
+            middleware_to_insert_before,
+            RooOnRails::Rack::SafeTimeouts
+          )
+        end
 
-          if ENV.fetch('ROO_ON_RAILS_RACK_DEFLATE', 'YES').to_s =~ /\A(YES|TRUE|ON|1)\Z/i
-            app.config.middleware.use ::Rack::Deflater
-          end
+        if ENV.fetch('ROO_ON_RAILS_RACK_DEFLATE', 'YES').to_s =~ /\A(YES|TRUE|ON|1)\Z/i
+          app.config.middleware.use ::Rack::Deflater
+        end
 
-          # Don't use SslEnforcer in test environment as it breaks Capybara
-          unless Rails.env.test? ||
-                 ENV.fetch('ROO_ON_RAILS_DISABLE_SSL_ENFORCEMENT', '') =~ /\A(YES|TRUE|ON|1)\Z/i
-            app.config.middleware.insert_before(
-              middleware_to_insert_before,
-              ::Rack::SslEnforcer
-            )
-          end
+        # Don't use SslEnforcer in test environment as it breaks Capybara
+        unless Rails.env.test? ||
+               ENV.fetch('ROO_ON_RAILS_DISABLE_SSL_ENFORCEMENT', '') =~ /\A(YES|TRUE|ON|1)\Z/i
+          app.config.middleware.insert_before(
+            middleware_to_insert_before,
+            ::Rack::SslEnforcer
+          )
         end
       end
     end

data/lib/roo_on_rails/railties/roo_identity.rb

@@ -4,13 +4,14 @@ module RooOnRails
   module Railties
     class RooIdentity < Rails::Railtie
       initializer 'roo_on_rails.roo_identity.middleware' do |app|
-        Rails.logger.with initializer: 'roo_on_rails.roo_identity' do |log|
-          if RooOnRails::Rack::PopulateEnvFromJWT.configured?
-            log.debug 'loading'
-            _add_middleware(app, log)
-          else
-            log.warn 'not configured, roo.identity will be unavailable'
-          end
+        if RooOnRails::Rack::PopulateEnvFromJWT.configured?
+          Rails.logger.debug '[roo_on_rails.roo_identity.middleware] loading'
+          _add_middleware(app, Rails.logger)
+        else
+          Rails.logger.warn(
+            '[roo_on_rails.roo_identity.middleware] ' \
+            ' not configured, roo.identity will be unavailable'
+          )
         end
       end
 
@@ -19,7 +20,10 @@ module RooOnRails
       def _add_middleware(app, log)
         app.config.middleware.use RooOnRails::Rack::PopulateEnvFromJWT, logger: log
       rescue LoadError
-        log.error 'the json-jwt gem is not in the bundle so Roo Identity will not be available'
+        log.error(
+          '[roo_on_rails.roo_identity.middleware] ' \
+          'the json-jwt gem is not in the bundle so Roo Identity will not be available'
+        )
       end
     end
   end

data/lib/roo_on_rails/railties/sidekiq_integration.rb

@@ -8,27 +8,15 @@ module RooOnRails
   module Railties
     class SidekiqIntegration < Rails::Railtie
       initializer 'roo_on_rails.sidekiq' do |app|
-        Rails.logger.with initializer: 'roo_on_rails.sidekiq' do |log|
-          unless RooOnRails::Config.sidekiq_enabled?
-            log.debug 'skipping'
-            next
-          end
-
-          log.debug 'loading'
-          require 'hirefire-resource'
-
-          config_sidekiq
-          config_sidekiq_metrics
-          config_hirefire(app)
+        unless RooOnRails::Config.sidekiq_enabled?
+          Rails.logger.debug '[roo_on_rails.sidekiq] skipping'
+          next
         end
-      end
 
-      def config_hirefire(app)
-        unless ENV['HIREFIRE_TOKEN']
-          Rails.logger.warn 'No HIREFIRE_TOKEN token set, auto scaling not enabled'
-          return
-        end
-        add_middleware(app)
+        Rails.logger.debug '[roo_on_rails.sidekiq] loading'
+
+        config_sidekiq
+        config_sidekiq_metrics
       end
 
       def config_sidekiq

data/lib/roo_on_rails/tasks/db.rake

@@ -8,12 +8,37 @@ if defined?(ActiveRecord)
 
     namespace :migrate do
       task extend_statement_timeout: :environment do
-        if ActiveRecord::VERSION::MAJOR >= 4
+        rails_version = Gem::Version.new(Rails.version)
+
+        if rails_version < Gem::Version.new('6.1')
           config = ActiveRecord::Base.configurations[Rails.env]
           config['variables'] ||= {}
           config['variables']['statement_timeout'] = ENV.fetch('MIGRATION_STATEMENT_TIMEOUT', 10_000)
-          ActiveRecord::Base.establish_connection
+        else
+          configs = ActiveRecord::Base.configurations.configurations
+          old_url_config = ActiveRecord::Base.configurations.configs_for(env_name: Rails.env, name: 'primary')
+          new_config_hash = old_url_config.configuration_hash.deep_dup
+          new_config_hash[:variables] ||= {}
+          new_config_hash[:variables][:statement_timeout] = ENV.fetch('MIGRATION_STATEMENT_TIMEOUT', 10_000)
+          if old_url_config.respond_to?(:url)
+            new_url_config = ActiveRecord::DatabaseConfigurations::UrlConfig.new(
+              old_url_config.env_name,
+              old_url_config.name,
+              old_url_config.url,
+              new_config_hash
+            )
+          else
+            new_url_config = ActiveRecord::DatabaseConfigurations::HashConfig.new(
+              old_url_config.env_name,
+              old_url_config.name,
+              new_config_hash
+            )
+          end
+          configs.delete(old_url_config)
+          configs << new_url_config
         end
+
+        ActiveRecord::Base.establish_connection
       end
     end
   end

data/lib/roo_on_rails/version.rb

@@ -1,3 +1,3 @@
 module RooOnRails
-  VERSION = '2.0.0-pre.2'.freeze
+  VERSION = '2.2.0'.freeze
 end

data/lib/roo_on_rails.rb

@@ -5,7 +5,6 @@ end
 
 if defined?(Rails)
   require 'dotenv/rails-now'
-  require 'roo_on_rails/railties/logging'
   require 'roo_on_rails/railties/env'
   require 'roo_on_rails/railties/database'
   require 'roo_on_rails/railties/http'