roo_on_rails 1.22.0 → 2.0.0.pre.pre.1

data/.circleci/config.yml.erb

@@ -1,15 +1,26 @@
 # 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
+
 <%
   builds = [
-		['2.3.4', 'rails_3'],
-		['2.3.4', 'rails_4'],
-		['2.4.1', 'rails_4'],
-		['2.3.4', 'rails_5'],
-		['2.4.1', 'rails_5'],
-		['2.3.4', 'rails_5_1'],
-		['2.4.1', 'rails_5_1'],
-		['2.4.1', 'rails_5_2']
+    ['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']
   ]
 %>
 version: 2
@@ -17,7 +28,7 @@ jobs:
 <% builds.each do |ruby,variant| %>
   build_<%= ruby %>_<%= variant %>:
     docker:
-      - image: deliveroo/multiruby
+      - image: ruby:<%= ruby %>-alpine
       - image: postgres:9.6-alpine
         environment:
           PGDATA: /dev/shm/pgdata
@@ -33,28 +44,50 @@ jobs:
             ln -s /dev/shm/tmp ~/project/tmp
 
       - run:
-          name: Select build variant (Ruby <%= ruby %>, <%= variant %>)
+          name: Setup requirements
           command: |
-            rbenv local <%= ruby %> ;
-            gem install bundler ;
+            apk add --update git bash build-base postgresql-dev sqlite-dev tzdata nodejs
+
+      - run:
+          name: Configure bundler
+          command: |
+            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/Appraisals

@@ -1,10 +1,3 @@
-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'

data/CHANGELOG.md

@@ -1,8 +1,22 @@
+# 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 specifiying `BASE_NEW_RELIC_APP_NAME` instead of `NEW_RELIC_APP_NAME`, which reports to New Relic per Hopper service.
+ - 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)
 

data/README.md

@@ -17,17 +17,21 @@
 
 - [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)
+    - [Heroku metrics](#heroku-metrics)
+    - [Custom application metrics](#custom-application-metrics)
   - [Routemaster Client](#routemaster-client)
-  - [API Authentication ](#api-authentication)
+  - [API Authentication](#api-authentication)
 - [Command features](#command-features)
   - [Usage](#usage)
   - [Description](#description)
@@ -48,11 +52,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 +61,19 @@ And then execute:
 
 Then re-run your test suite to make sure everything is shipshape.
 
-## Library usage
+## Running specs
+
+To run the specs locally, you will need to run the following command:
 
-### New Relic configuration
+```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 +99,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)

data/appraise

@@ -5,7 +5,7 @@
 require 'yaml'
 
 
-RUBIES = YAML.load_file('.travis.yml')['rvm']
+RUBIES = ['2.4.5', '2.5.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,7 @@ gem "guard-rspec"
 gem "appraisal"
 gem "webmock"
 gem "pg", "~> 0.11"
-gem "sqlite3"
+gem "sqlite3", "~> 1.3.6"
 gem "rails", "~> 4.2"
 
 gemspec path: "../"

data/gemfiles/rails_5.gemfile

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

data/lib/roo_on_rails.rb

@@ -7,7 +7,6 @@ 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_integration'

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
 

data/lib/roo_on_rails/default.env

@@ -4,15 +4,6 @@ GOOGLE_AUTH_CLIENT_SECRET=''
 GOOGLE_AUTH_ALLOWED_DOMAINS=''
 GOOGLE_AUTH_PATH_PREFIX=/auth
 GOOGLE_AUTH_CONTROLLER=sessions
-NEW_RELIC_LOG=stdout
-NEW_RELIC_AGENT_ENABLED=true
-NEW_RELIC_MONITOR_MODE=true
-NEW_RELIC_BROWSER_MONITORING_AUTO_INSTRUMENT=true
-NEW_RELIC_CAPTURE_PARAMS=true
-NEW_RELIC_TRANSACTION_TRACER_RECORD_SQL=obfuscated
-NEW_RELIC_TRANSACTION_TRACER_RECORD_REDIS_ARGUMENTS=true
-NEW_RELIC_DEVELOPER_MODE=false
-NEW_RELIC_LICENSE_KEY=override-me
 RACK_SERVICE_TIMEOUT=10
 RACK_WAIT_TIMEOUT=30
 ROUTEMASTER_URL=''

data/lib/roo_on_rails/rack/populate_env_from_jwt.rb

@@ -7,15 +7,22 @@ module RooOnRails
     class PopulateEnvFromJWT
       UnacceptableKeyError = Class.new(RuntimeError)
       VALID_PREFIXES_KEY = 'VALID_IDENTITY_URL_PREFIXES'.freeze
+      DEFAULT_MAPPED_URLS = {
+        'https://test.deliveroo.co.uk/' => 'https://orderweb.rooenv-staging.io/',
+        'https://deliveroo.co.uk/' => 'https://orderweb.deliverooapp.com/',
+        'https://identity-staging.deliveroo.com/' => 'https://internal-identity.rooenv-staging.io/',
+        'https://identity.deliveroo.com/' => 'https://internal-identity.deliverooapp.com/'
+      }.freeze
 
       def self.configured?
         ENV[VALID_PREFIXES_KEY].present?
       end
 
-      def initialize(app, logger:, skip_sig_verify: true)
+      def initialize(app, logger:, skip_sig_verify: true, url_mappings: DEFAULT_MAPPED_URLS)
         @app = app
-        @keys = {}
         @logger = logger
+        @url_mappings = url_mappings
+        @keys = @mapped_urls = {}
 
         if skip_sig_verify && non_prod?
           @logger.warn "JWTs signature verifification has been switched off in development."
@@ -34,7 +41,7 @@ module RooOnRails
       rescue UnacceptableKeyError, JSON::JWT::Exception => e
         # Identifying user is clearly attempting to hack or has been given a totally incorrect
         # token, log this and flag as Forbidden, without executing the rest of the middleware stack.
-        ::NewRelic::Agent.notice_error(e) if defined?(NewRelic)
+        Raven.report_exception(e) if defined?(Raven)
         [401, {}, []]
       end
 
@@ -86,7 +93,7 @@ module RooOnRails
         return @keys[key_url] if @keys.key?(key_url)
 
         @logger.info "Downloading identity public key from #{key_url}"
-        json = http_request.get(key_url).body
+        json = http_request.get(mapped_url(key_url)).body
         @keys[key_url] = JSON::JWK.new(json)
       rescue Faraday::ParsingError
         raise JSON::JWT::InvalidFormat, 'Downloaded JWK is not a valid JSON file'
@@ -101,6 +108,20 @@ module RooOnRails
           conf.adapter Faraday.default_adapter
         end
       end
+
+      # Allows us to use internal URLs instead of external ones where appropriate
+      def mapped_url(url)
+        return @mapped_urls[url] unless @mapped_urls[url].nil?
+
+        @url_mappings.each do |prefix, replacement|
+          next unless url.starts_with?(prefix)
+          mapped = url.sub(prefix, replacement)
+          @mapped_urls[url] = mapped
+          return mapped
+        end
+
+        url
+      end
     end
   end
 end

data/lib/roo_on_rails/railties/database.rb

@@ -8,11 +8,14 @@ module RooOnRails
 
             config = ActiveRecord::Base.configurations[Rails.env]
             config['variables'] ||= {}
-            config['variables']['statement_timeout'] = ENV.fetch('DATABASE_STATEMENT_TIMEOUT', 200)
+            statement_timeout = ENV.fetch('DATABASE_STATEMENT_TIMEOUT', 200)
+            # Use -1 to disable setting the statement timeout
+            unless statement_timeout == '-1'
+              config['variables']['statement_timeout'] = statement_timeout
+            end
             if ENV.key?('DATABASE_REAPING_FREQUENCY')
               config['reaping_frequency'] = ENV['DATABASE_REAPING_FREQUENCY']
             end
-
             ActiveRecord::Base.establish_connection
           end
         end

data/lib/roo_on_rails/routemaster/lifecycle_events.rb

@@ -1,5 +1,4 @@
 require 'active_support/concern'
-require 'new_relic/agent'
 require 'roo_on_rails/routemaster/publishers'
 
 module RooOnRails
@@ -31,7 +30,7 @@ module RooOnRails
           begin
             publisher.publish!(force_publish: force_publish)
           rescue => e
-            NewRelic::Agent.notice_error(e)
+            Raven.report_exception(e) if defined?(Raven)
           end
         end
       end

data/lib/roo_on_rails/version.rb

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

data/roo_on_rails.gemspec

@@ -22,7 +22,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'dotenv-rails', '~> 2.1'
-  spec.add_runtime_dependency 'newrelic_rpm'
   spec.add_runtime_dependency 'rails', '>= 3.2.22', '< 5.3'
   spec.add_runtime_dependency 'platform-api', '~> 2.0'
   spec.add_runtime_dependency 'hashie', '~> 3.4'
@@ -38,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'routemaster-client'
   spec.add_runtime_dependency 'json-jwt', '~> 1.8'
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'thor', '~> 0.19'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roo_on_rails
 version: !ruby/object:Gem::Version
-  version: 1.22.0
+  version: 2.0.0.pre.pre.1
 platform: ruby
 authors:
 - Julien Letessier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-03 00:00:00.000000000 Z
+date: 2019-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv-rails
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: newrelic_rpm
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -244,16 +230,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -396,7 +382,6 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - CONTRIBUTING.md
@@ -412,7 +397,6 @@ files:
 - bin/setup
 - exe/roo_on_rails
 - gemfiles/.bundle/config
-- gemfiles/rails_3.gemfile
 - gemfiles/rails_4.gemfile
 - gemfiles/rails_5.gemfile
 - gemfiles/rails_5_1.gemfile
@@ -461,7 +445,6 @@ files:
 - lib/roo_on_rails/railties/google_oauth.rb
 - lib/roo_on_rails/railties/http.rb
 - lib/roo_on_rails/railties/logging.rb
-- lib/roo_on_rails/railties/new_relic.rb
 - lib/roo_on_rails/railties/rake_tasks.rb
 - lib/roo_on_rails/railties/roo_identity.rb
 - lib/roo_on_rails/railties/routemaster.rb
@@ -479,7 +462,6 @@ files:
 - lib/roo_on_rails/sidekiq/sla_metric.rb
 - lib/roo_on_rails/statsd.rb
 - lib/roo_on_rails/tasks/db.rake
-- lib/roo_on_rails/tasks/newrelic.rake
 - lib/roo_on_rails/version.rb
 - roo_on_rails.gemspec
 homepage: https://github.com/deliveroo/roo_on_rails
@@ -497,12 +479,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Scaffolding for building services