roo_on_rails 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 414e52a1f4a204155e8ac72fb782b1c3f8e02fbf
-  data.tar.gz: 455803293bc94052f1fb00d760d75bd93fc219d8
+  metadata.gz: 8f0cf22be3d0412ce55d496e5bbb8bb9f79db969
+  data.tar.gz: a84b3635f83120868e711a40bb891a977d27afaa
 SHA512:
-  metadata.gz: 023dd6254c42da164c858dad3e521a464df7835431a623b6c7444012e03a71a272a11d80f939791443520f27c230795d9c700402f79c25c1e45b116f14c20fc5
-  data.tar.gz: 96a9cabce8b2bb63f686ec4e3a03bed076a0589a961467d2fe464957731d985530cdd314a41ba81cdc5db1c6e19a52714a134e77d02262a9292df79e851a5164
+  metadata.gz: 34ffa0d2d2da72f352cf30a988e390c5aca2013bd492f006d64b6ca8470612822b046084f3d6094af197abbec52b33ca159aa075c5660599588e12ec685890bb
+  data.tar.gz: fc11d895cd22c56458d2a03c95639a79c55ae20a02168db587efd6ecbfd90e8136e08a0507b32cc025406f5f5d10bb0c030e41c8bf0390059562b7a1aacd9c60

data/.travis.yml

@@ -23,3 +23,5 @@ matrix:
     - rvm: ruby-head
     - rvm: 2.4.0
       gemfile: gemfiles/rails_3.gemfile
+services:
+  - redis-server

data/Appraisals

@@ -1,12 +1,17 @@
-appraise "rails-3" do
+appraise 'rails-3' do
+  gem 'rails', '~> 3.2'
   gem 'sqlite3'
-  gem "rails", "~> 3.2"
+  gem 'sidekiq', '< 5'
 end
 
-appraise "rails-4" do
-  gem "rails", "~> 4.2"
+appraise 'rails-4' do
+  gem 'rails', '~> 4.2'
+  gem 'sqlite3'
+  gem 'pg'
 end
 
-appraise "rails-5" do
-  gem "rails", "~> 5.0"
+appraise 'rails-5' do
+  gem 'rails', '~> 5.0'
+  gem 'sqlite3'
+  gem 'pg'
 end

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+# v1.3.0 (2017-04-28)
+
+Features:
+
+- Sets database statement timeout to 200ms by default (#13).
+- Sets migration statement timeout to 10s by default (#16, #17)
+- Adds Sidekiq and Hirefire (workers) integration (#11)
+- Adds the ability to tag logs with key/value pairs (#20)
+
+Fixes:
+
+- Use correct GitHub context name for CircleCI (#12)
+- Do not depend on sort order for Codecov GitHub contexts (#12)
+- Do not add `Rack::SslEnforcer` middleware in test environment (#15)
+- Fix for "undefined constant: RooOnRails::Rack::Timeout" (#18)
+
 # v1.2.0 (2017-03-21)
 
 Features:

data/README.md

@@ -50,7 +50,6 @@ Running the `roo_on_rails` script currently checks for:
 - presence of the Heroku preboot flag;
 - correct Github master branch protection.
 
-
 ### New Relic configuration
 
 We enforce configuration of New Relic.
@@ -95,6 +94,48 @@ We'll insert the following middlewares into the rails stack:
 2. `Rack::SslEnforcer`: enforces HTTPS.
 3. `Rack::Deflater`: compresses responses from the application, can be disabled with `ROO_ON_RAILS_RACK_DEFLATE` (default: 'YES').
 
+### Database configuration
+
+The database statement timeout will be set to a low value by default. Use `DATABASE_STATEMENT_TIMEOUT` (milliseconds, default 200) to customise.
+
+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) to customise.
+
+_Note: This configuration is not supported in Rails 3 and will be skipped. Set statement timeouts directly in the database._
+
+### Sidekiq
+
+When `SIDEKIQ_ENABLED` is set we'll:
+
+ - check for the existence of a worker line in your Procfile
+ - add SLA style queues to your worker list
+ - check for a HIREFIRE_TOKEN and if it's set enable SLA based autoscaling
+
+The following ENV are available:
+
+ - `SIDEKIQ_ENABLED`
+ - `SIDEKIQ_THREADS` (default: 25) - Sets sidekiq concurrency value
+ - `SIDEKIQ_DATABASE_REAPING_FREQUENCY` (default: 10) - For sidekiq processes the amount of time in seconds rails will wait before attempting to find and recover connections from dead threads
+
+### Logging
+
+For clearer and machine-parseable log output, there in an extension to be able to add context to your logs which is output as [logfmt](https://brandur.org/logfmt) key/value pairs after the log message.
+
+```ruby
+# in application.rb
+
+Rails.logger = RooOnRails::ContextLogging.new(ActiveSupport::Logger.new($stdout))
+```
+
+You can then add context using the `with` method:
+
+```ruby
+logger.with(a: 1, b: 2) { logger.info 'Stuff' }
+logger.with(a: 1) { logger.with(b: 2) { logger.info('Stuff') } }
+logger.with(a: 1, b: 2).info('Stuff')
+```
+
+See the [class documentation](/deliveroo/roo_on_rails/tree/master/lib/roo_on_rails/context_logging.rb) for further details.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/deliveroo/roo_on_rails.

data/exe/roo_on_rails

@@ -1,9 +1,13 @@
 #!/usr/bin/env ruby
 require 'rubygems'
-require 'pry'
 require 'roo_on_rails/config'
 require 'roo_on_rails/harness'
+require 'roo_on_rails/sidekiq/loader'
 
-module RooOnRails
-  Harness.new(try_fix: true, context: Config.load).run
+if ARGV.include? 'sidekiq'
+  RooOnRails::Sidekiq::Loader.run
+else
+  module RooOnRails
+    Harness.new(try_fix: true, context: Config.load).run
+  end
 end

data/gemfiles/rails_3.gemfile

@@ -5,7 +5,8 @@ source "https://rubygems.org"
 gem "guard"
 gem "guard-rspec"
 gem "appraisal"
-gem "sqlite3"
 gem "rails", "~> 3.2"
+gem "sqlite3"
+gem "sidekiq", "< 5"
 
 gemspec :path => "../"

data/gemfiles/rails_3.gemfile.lock

@@ -1,14 +1,17 @@
 PATH
-  remote: ../
+  remote: ..
   specs:
-    roo_on_rails (1.1.0)
+    roo_on_rails (1.3.0)
       dotenv-rails (~> 2.1)
       hashie (~> 3.4)
+      hirefire-resource
       newrelic_rpm (~> 3.17)
+      octokit
       platform-api (~> 0.8)
       rack-ssl-enforcer
       rack-timeout
       rails (>= 3.2.22, < 5.1)
+      sidekiq
 
 GEM
   remote: https://rubygems.org/
@@ -40,22 +43,33 @@ GEM
     activesupport (3.2.22.5)
       i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
-    appraisal (2.1.0)
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    appraisal (2.2.0)
       bundler
       rake
       thor (>= 0.14.0)
     arel (3.0.3)
     builder (3.0.4)
     byebug (9.0.6)
+    codecov (0.1.10)
+      json
+      simplecov
+      url
     coderay (1.1.1)
+    concurrent-ruby (1.0.5)
+    connection_pool (2.2.1)
     diff-lcs (1.3)
+    docile (1.1.5)
     dotenv (2.2.0)
     dotenv-rails (2.2.0)
       dotenv (= 2.2.0)
       railties (>= 3.2, < 5.1)
     erubis (2.7.0)
     excon (0.55.0)
-    ffi (1.9.17)
+    faraday (0.12.1)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.18)
     formatador (0.2.5)
     guard (2.14.1)
       formatador (>= 0.2.4)
@@ -77,6 +91,7 @@ GEM
       excon
       multi_json (>= 1.9.2)
     hike (1.2.3)
+    hirefire-resource (0.4.0)
     i18n (0.8.1)
     journey (1.0.4)
     json (1.8.6)
@@ -88,14 +103,18 @@ GEM
     mail (2.5.4)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
+    memfs (1.0.0)
     method_source (0.8.2)
     mime-types (1.25.1)
     multi_json (1.12.1)
+    multipart-post (2.0.0)
     nenv (0.3.0)
     newrelic_rpm (3.18.1.330)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
+    octokit (4.7.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
     platform-api (0.8.0)
       heroics (~> 0.0.17)
     polyglot (0.3.5)
@@ -106,9 +125,12 @@ GEM
     pry-byebug (3.4.2)
       byebug (~> 9.0)
       pry (~> 0.10)
+    public_suffix (2.0.5)
     rack (1.4.7)
     rack-cache (1.7.0)
       rack (>= 0.4)
+    rack-protection (1.5.3)
+      rack
     rack-ssl (1.3.4)
       rack
     rack-ssl-enforcer (0.2.9)
@@ -136,6 +158,7 @@ GEM
       ffi (>= 0.5.0)
     rdoc (3.12.2)
       json (~> 1.4)
+    redis (3.3.3)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
@@ -150,7 +173,20 @@ GEM
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
     ruby_dep (1.5.0)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
     shellany (0.0.1)
+    sidekiq (4.2.10)
+      concurrent-ruby (~> 1.0)
+      connection_pool (~> 2.2, >= 2.2.0)
+      rack-protection (>= 1.5.0)
+      redis (~> 3.2, >= 3.2.1)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     slop (3.6.0)
     sprockets (2.2.3)
       hike (~> 1.2)
@@ -163,7 +199,8 @@ GEM
     treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.52)
+    tzinfo (0.3.53)
+    url (0.3.2)
 
 PLATFORMS
   ruby
@@ -171,13 +208,17 @@ PLATFORMS
 DEPENDENCIES
   appraisal
   bundler (~> 1.13)
+  codecov
   guard
   guard-rspec
+  memfs
   pry-byebug
   rails (~> 3.2)
   rake (~> 10.0)
   roo_on_rails!
   rspec (~> 3.0)
+  sidekiq (< 5)
+  simplecov
   sqlite3
   thor (~> 0.19)
 

data/gemfiles/rails_4.gemfile

@@ -6,5 +6,7 @@ gem "guard"
 gem "guard-rspec"
 gem "appraisal"
 gem "rails", "~> 4.2"
+gem "sqlite3"
+gem "pg"
 
 gemspec :path => "../"

data/gemfiles/rails_4.gemfile.lock

@@ -1,14 +1,17 @@
 PATH
-  remote: ../
+  remote: ..
   specs:
-    roo_on_rails (1.1.0)
+    roo_on_rails (1.3.0)
       dotenv-rails (~> 2.1)
       hashie (~> 3.4)
+      hirefire-resource
       newrelic_rpm (~> 3.17)
+      octokit
       platform-api (~> 0.8)
       rack-ssl-enforcer
       rack-timeout
       rails (>= 3.2.22, < 5.1)
+      sidekiq
 
 GEM
   remote: https://rubygems.org/
@@ -47,26 +50,36 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    appraisal (2.1.0)
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    appraisal (2.2.0)
       bundler
       rake
       thor (>= 0.14.0)
     arel (6.0.4)
     builder (3.2.3)
     byebug (9.0.6)
+    codecov (0.1.10)
+      json
+      simplecov
+      url
     coderay (1.1.1)
     concurrent-ruby (1.0.5)
+    connection_pool (2.2.1)
     diff-lcs (1.3)
+    docile (1.1.5)
     dotenv (2.2.0)
     dotenv-rails (2.2.0)
       dotenv (= 2.2.0)
       railties (>= 3.2, < 5.1)
     erubis (2.7.0)
     excon (0.55.0)
-    ffi (1.9.17)
+    faraday (0.12.1)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.18)
     formatador (0.2.5)
-    globalid (0.3.7)
-      activesupport (>= 4.1.0)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
     guard (2.14.1)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -86,7 +99,9 @@ GEM
       erubis (~> 2.0)
       excon
       multi_json (>= 1.9.2)
+    hirefire-resource (0.4.0)
     i18n (0.8.1)
+    json (2.1.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
@@ -96,6 +111,7 @@ GEM
     lumberjack (1.0.11)
     mail (2.6.4)
       mime-types (>= 1.16, < 4)
+    memfs (1.0.0)
     method_source (0.8.2)
     mime-types (3.1)
       mime-types-data (~> 3.2015)
@@ -103,13 +119,17 @@ GEM
     mini_portile2 (2.1.0)
     minitest (5.10.1)
     multi_json (1.12.1)
+    multipart-post (2.0.0)
     nenv (0.3.0)
     newrelic_rpm (3.18.1.330)
-    nokogiri (1.7.0.1)
+    nokogiri (1.7.1)
       mini_portile2 (~> 2.1.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
+    octokit (4.7.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    pg (0.20.0)
     platform-api (0.8.0)
       heroics (~> 0.0.17)
     pry (0.10.4)
@@ -119,7 +139,10 @@ GEM
     pry-byebug (3.4.2)
       byebug (~> 9.0)
       pry (~> 0.10)
+    public_suffix (2.0.5)
     rack (1.6.5)
+    rack-protection (1.5.3)
+      rack
     rack-ssl-enforcer (0.2.9)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -152,6 +175,7 @@ GEM
     rb-fsevent (0.9.8)
     rb-inotify (0.9.8)
       ffi (>= 0.5.0)
+    redis (3.3.3)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
@@ -166,7 +190,20 @@ GEM
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
     ruby_dep (1.5.0)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
     shellany (0.0.1)
+    sidekiq (5.0.0)
+      concurrent-ruby (~> 1.0)
+      connection_pool (~> 2.2, >= 2.2.0)
+      rack-protection (>= 1.5.0)
+      redis (~> 3.3, >= 3.3.3)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     slop (3.6.0)
     sprockets (3.7.1)
       concurrent-ruby (~> 1.0)
@@ -175,10 +212,12 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
+    sqlite3 (1.3.13)
     thor (0.19.4)
     thread_safe (0.3.6)
-    tzinfo (1.2.2)
+    tzinfo (1.2.3)
       thread_safe (~> 0.1)
+    url (0.3.2)
 
 PLATFORMS
   ruby
@@ -186,13 +225,18 @@ PLATFORMS
 DEPENDENCIES
   appraisal
   bundler (~> 1.13)
+  codecov
   guard
   guard-rspec
+  memfs
+  pg
   pry-byebug
   rails (~> 4.2)
   rake (~> 10.0)
   roo_on_rails!
   rspec (~> 3.0)
+  simplecov
+  sqlite3
   thor (~> 0.19)
 
 BUNDLED WITH

data/gemfiles/rails_5.gemfile

@@ -6,5 +6,7 @@ gem "guard"
 gem "guard-rspec"
 gem "appraisal"
 gem "rails", "~> 5.0"
+gem "sqlite3"
+gem "pg"
 
 gemspec :path => "../"