roo_on_rails 1.20.0 → 2.1.0

data/.circleci/config.yml.erb

@@ -1,18 +1,36 @@
 # To update the build configuration, edit the "builds" array below and run:
 # erb .circleci/config.yml.erb > .circleci/config.yml
+
+
+# The default Ruby containers modify the behaviour of Bundler in a way that breaks
+# the CI since it makes it harder to run multiple apps in a single container
+# See https://github.com/docker-library/docs/pull/1221/files for a summary
+# Unsettting these variables restores the default behaviour:-
+#   * BUNDLE_APP_CONFIG
+#   * 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.2.6', 'rails_3'],
-		['2.3.3', 'rails_3'],
-		['2.2.6', 'rails_4'],
-		['2.3.3', 'rails_4'],
-		['2.4.0', 'rails_4'],
-		['2.2.6', 'rails_5'],
-		['2.3.3', 'rails_5'],
-		['2.4.0', 'rails_5'],
-		['2.2.6', 'rails_5_1'],
-		['2.3.3', 'rails_5_1'],
-		['2.4.0', 'rails_5_1'],
+    ['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.6.5', 'rails_6']
   ]
 %>
 version: 2
@@ -20,11 +38,13 @@ jobs:
 <% builds.each do |ruby,variant| %>
   build_<%= ruby %>_<%= variant %>:
     docker:
-      - image: deliveroo/multiruby
+      - image: ruby:<%= ruby %>-alpine
+        <<: *common_ruby_environment
       - image: postgres:9.6-alpine
         environment:
           PGDATA: /dev/shm/pgdata
-      - image: redis:3-alpine
+          <<: *common_pg_environment_vars
+      - image: redis:4-alpine
     steps:
       - checkout
 
@@ -36,28 +56,50 @@ jobs:
             ln -s /dev/shm/tmp ~/project/tmp
 
       - run:
-          name: Select build variant (Ruby <%= ruby %>, <%= variant %>)
+          name: Setup requirements
+          command: |
+            apk add --update git bash build-base postgresql-dev sqlite-dev tzdata nodejs
+
+      - run:
+          name: Configure bundler
           command: |
-            rbenv local <%= ruby %> ;
-            gem install bundler ;
+            unset \
+              BUNDLE_APP_CONFIG \
+              GEM_HOME \
+              BUNDLE_PATH \
+              BUNDLE_BIN
             bundle config --local gemfile $PWD/gemfiles/<%= variant %>.gemfile
 
       - restore_cache:
-          keys: 
+          keys:
             - v2-bundle-<%= ruby %>-<%= variant %>-{{ .Branch }}
             - v2-bundle-<%= ruby %>-<%= variant %>
             - v2-bundle-<%= ruby %>
 
-      - run: 
-          name: Install dependencies
+      - run:
+          name: Install bundle
           command: |
+            unset \
+              BUNDLE_APP_CONFIG \
+              GEM_HOME \
+              BUNDLE_PATH \
+              BUNDLE_BIN
             bundle install --jobs=3 --retry=3 --path=$PWD/vendor/bundle
 
+      # The default Ruby containers modify the behaviour of Bundler in a way that breaks
+      # the CI since it makes it harder to run multiple apps in a single container
+      # See https://github.com/docker-library/docs/pull/1221/files for a summary
+      # Unsettting the variables restores the default behaviour
       - run:
           name: Run test suite
           command: |
-            unset RACK_ENV &&
-            unset RAILS_ENV &&
+            unset \
+              RACK_ENV \
+              RAILS_ENV \
+              BUNDLE_APP_CONFIG \
+              GEM_HOME \
+              BUNDLE_PATH \
+              BUNDLE_BIN
             bundle exec rspec
 
       - save_cache:

data/.codecov.yml

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

data/Appraisals

@@ -1,24 +1,37 @@
-appraise 'rails-3' do
-  gem 'rails', '~> 3.2'
-  gem 'sqlite3'
-  gem 'sidekiq', '< 5'
-  gem 'pg', '~> 0.11'
-end
-
 appraise 'rails-4' do
   gem 'rails', '~> 4.2'
-  gem 'sqlite3'
+  gem 'sqlite3', '~> 1.3.6'
   gem 'pg', '~> 0.11'
+  gem 'sprockets', '~>3.0'
+  gem 'rake', '13.0.1'
 end
 
 appraise 'rails-5' do
   gem 'rails', '~> 5.0.0'
-  gem 'sqlite3'
+  gem 'sqlite3', '~> 1.3.6'
   gem 'pg', '~> 0.18'
+  gem 'rake', '13.0.1'
 end
 
 appraise 'rails-5-1' do
-  gem 'rails', '~> 5.1'
-  gem 'sqlite3'
+  gem 'rails', '~> 5.1.0'
+  gem 'sqlite3', '~> 1.3.6'
+  gem 'pg', '~> 0.18'
+  gem 'rake', '13.0.1'
+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'
+end
+
+appraise 'rails-6' 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'
 end

data/CHANGELOG.md

@@ -1,3 +1,42 @@
+# v2.1.0
+
+Features:
+
+- Rails 6 compatibility
+
+# v2.0.0-pre.2
+
+Features:
+
+- Removes routemaster
+
+# v2.0.0-pre.1
+
+Features:
+
+- Remove New Relic
+
+# v1.23.0 (2019-04-24)
+
+Features:
+
+- Setting DATABASE_STATEMENT_TIMEOUT to -1 will prevent the app setting any timeout.
+  Setting timeouts from the app conflicts with PGBouncer and should be disabled if
+  using one.
+
+# v1.22.0 (2018-08-29)
+
+Features:
+
+ - Allows specifying `BASE_NEW_RELIC_APP_NAME` instead of `NEW_RELIC_APP_NAME`, which reports to New Relic per Hopper service.
+
+# v1.21.0 (2018-03-27)
+
+Features:
+
+- Rails 5.2 compatibility
+
+
 # v1.20.0 (2018-03-27)
 
 Features:

data/README.md

@@ -17,17 +17,20 @@
 
 - [Installation](#installation)
 - [Library usage](#library-usage)
-  - [New Relic configuration](#new-relic-configuration)
   - [Rack middleware](#rack-middleware)
+    - [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)
   - [Datadog Integration](#datadog-integration)
-  - [Routemaster Client](#routemaster-client)
-  - [API Authentication ](#api-authentication)
+    - [Heroku metrics](#heroku-metrics)
+    - [Custom application metrics](#custom-application-metrics)
+  - [API Authentication](#api-authentication)
 - [Command features](#command-features)
   - [Usage](#usage)
   - [Description](#description)
@@ -48,11 +51,6 @@ Remove the following gems from your Gemfile, as they're provided and configured
 by `roo_on_rails`:
 
 - `dotenv`
-- `newrelic_rpm`
-
-Remove the following configuration files:
-
-- `newrelic.yml` or `config/newrelic.yml`
 
 Also remove any other gem-specific configuration from your repository.
 
@@ -62,23 +60,19 @@ And then execute:
 
 Then re-run your test suite to make sure everything is shipshape.
 
-## Library usage
+## Running specs
 
-### New Relic configuration
+To run the specs locally, you will need to run the following command:
+
+```ruby
+bundle config --local gemfile $PWD/gemfiles/<%= variant %>.gemfile
+```
 
-We enforce configuration of New Relic.
+Where `<%= variant %>` is the Rails version you'd like to test (e.g. `rails_5_2`).
 
-1. Your app must be loaded with a `NEW_RELIC_LICENSE_KEY` environment variable,
-   otherwise it will abort.
-2. No `new_relic.yml` file may be presentin your app. Overrides to New Relic settings
-   through [environment
-   variables](https://docs.newrelic.com/docs/agents/ruby-agent/installation-configuration/ruby-agent-configuration)
-   is permitted.
-3. The `NEW_RELIC_APP_NAME` environment variable must be defined
-   such that the app will be properly registered in New Relic.
+`bundle exec rspec` should then work as normal.
 
-No further configuration is required for production apps as the gem configures
-our standard settings.
+## Library usage
 
 ### Rack middleware
 
@@ -104,6 +98,11 @@ To do this, you can set the `ROO_ON_RAILS_DISABLE_SSL_ENFORCEMENT` to `YES`.
 The database statement timeout will be set to a low value by default. Use
 `DATABASE_STATEMENT_TIMEOUT` (milliseconds, default 200) to customise.
 
+When using a PGBouncer, setting the timeout from the application will cause
+inconsistent results. The timeout should always be set using the RDS parameter
+group in thise case. To prevent the app trying to set a timeout, set
+`DATABASE_STATEMENT_TIMEOUT` to -1.
+
 For database creation and migration (specifically the `db:create`, `db:migrate`,
 `db:migrate:down` and `db:rollback` tasks) a much higher statement timeout is
 set by default. Use `MIGRATION_STATEMENT_TIMEOUT` (milliseconds, default 10000)
@@ -302,16 +301,6 @@ The following tags will automatically be added to all your metrics and their val
   * `HOPPER_APP_NAME`+`HOPPER_ECS_CLUSTER_NAME` – automatically set by Hopper (e.g. `notifications-staging`);
   * Defaults to `unknown`.
 
-### Routemaster Client
-
-When `ROUTEMASTER_ENABLED` is set to `true` we attempt to configure [`routemaster-client`](https://github.com/deliveroo/routemaster-client) on your application. In order for this to happen, set the following environment variables:
-
-* `ROUTEMASTER_URL` – the full URL of your Routemaster application (mandatory)
-* `ROUTEMASTER_UUID` – the UUID of your application, e.g. `logistics-dashboard` (mandatory)
-* `ROUTEMASTER_VERIFY_SSL` – set to false if your Routemaster application is not served with a valid cert. (optional)
-
-If you then want to enable the publishing of events onto the event bus, you need to set `ROUTEMASTER_PUBLISHING_ENABLED` to `true` and implement publishers as needed. An example of how to do this is detailed in [`README.routemaster_client.md`](README.routemaster_client.md).
-
 ### API Authentication
 
 RooOnRails provides a concern which will make adding rotatable API authentication to your service a breeze:

data/appraise

@@ -5,7 +5,7 @@
 require 'yaml'
 
 
-RUBIES = YAML.load_file('.travis.yml')['rvm']
+RUBIES = ['2.4.5', '2.5.5', '2.6.5']
 APPRAISALS = `appraisal list`.strip.split(/\s+/)
 
 # setup

data/exe/roo_on_rails

@@ -36,6 +36,11 @@ module RooOnRails
       end
 
       def run
+        # Force output to be unbuffered, otherwise the CI
+        # tests will fail because the parent app won't see
+        # the log output from the test app
+        $stdout.sync = true
+        $stderr.sync = true
         _assert_argv_length(0..0)
         require 'roo_on_rails/sidekiq/loader'
         RooOnRails::Sidekiq::Loader.run

data/gemfiles/rails_4.gemfile

@@ -7,7 +7,9 @@ gem "guard-rspec"
 gem "appraisal"
 gem "webmock"
 gem "pg", "~> 0.11"
-gem "sqlite3"
+gem "sqlite3", "~> 1.3.6"
 gem "rails", "~> 4.2"
+gem "sprockets", "~>3.0"
+gem "rake", "13.0.1"
 
 gemspec path: "../"

data/gemfiles/rails_5.gemfile

@@ -7,7 +7,8 @@ gem "guard-rspec"
 gem "appraisal"
 gem "webmock"
 gem "pg", "~> 0.18"
-gem "sqlite3"
+gem "sqlite3", "~> 1.3.6"
 gem "rails", "~> 5.0.0"
+gem "rake", "13.0.1"
 
 gemspec path: "../"

data/gemfiles/rails_5_1.gemfile

@@ -7,7 +7,8 @@ gem "guard-rspec"
 gem "appraisal"
 gem "webmock"
 gem "pg", "~> 0.18"
-gem "sqlite3"
-gem "rails", "~> 5.1"
+gem "sqlite3", "~> 1.3.6"
+gem "rails", "~> 5.1.0"
+gem "rake", "13.0.1"
 
 gemspec path: "../"

data/gemfiles/rails_5_2.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "guard"
+gem "guard-rspec"
+gem "appraisal"
+gem "webmock"
+gem "pg", "~> 0.18"
+gem "sqlite3", "~> 1.3.6"
+gem "rails", "~> 5.2.0"
+gem "bootsnap", ">= 1.1.0", require: false
+gem "rake", "13.0.1"
+
+gemspec path: "../"

data/gemfiles/{rails_3.gemfile → rails_6.gemfile}

@@ -6,9 +6,10 @@ gem "guard"
 gem "guard-rspec"
 gem "appraisal"
 gem "webmock"
-gem "pg", "~> 0.11"
-gem "sqlite3"
-gem "rails", "~> 3.2"
-gem "sidekiq", "< 5"
+gem "pg", "~> 0.18"
+gem "sqlite3", "~> 1.4"
+gem "rails", "~> 6.0.3"
+gem "bootsnap", ">= 1.1.0", require: false
+gem "rake", "13.0.1"
 
 gemspec path: "../"

data/lib/roo_on_rails.rb

@@ -5,14 +5,11 @@ 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/new_relic'
   require 'roo_on_rails/railties/database'
   require 'roo_on_rails/railties/http'
-  require 'roo_on_rails/railties/sidekiq'
+  require 'roo_on_rails/railties/sidekiq_integration'
   require 'roo_on_rails/railties/rake_tasks'
   require 'roo_on_rails/railties/google_oauth'
-  require 'roo_on_rails/railties/routemaster'
   require 'roo_on_rails/railties/roo_identity'
 end

data/lib/roo_on_rails/checks/documentation/playbook_template.md

@@ -20,10 +20,6 @@ As a last resort, in an emergency, the following people have experience working
 
 FIXME: A very brief high-level explanation of what this functional area does
 
-#### 🚨 FIXME: a New Relic alert which might be raised - named so it can be searched for
-
-FIXME: A description of the New Relic alert, what it means for the service, and what actions should be taken to remedy the situation.
-
 #### 🚨 FIXME: an action which might need to be taken during an incident
 
 FIXME: A description of how to perform this action, and any side-effects that the on-call engineer should be aware of.

data/lib/roo_on_rails/concerns/require_api_key.rb

@@ -58,7 +58,6 @@ module RooOnRails
         def valid?(service_name, client_key)
           return false unless whitelisted?(service_name)
 
-          NewRelic::Agent.add_custom_attributes(httpBasicUserId: service_name) if defined?(NewRelic)
           ClientApiKeys.instance.valid?(service_name, client_key)
         end