roo_on_rails 1.2.0 → 1.3.0

data/gemfiles/rails_5.gemfile.lock

@@ -1,75 +1,88 @@
 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/
   specs:
-    actioncable (5.0.1)
-      actionpack (= 5.0.1)
-      nio4r (~> 1.2)
+    actioncable (5.0.2)
+      actionpack (= 5.0.2)
+      nio4r (>= 1.2, < 3.0)
       websocket-driver (~> 0.6.1)
-    actionmailer (5.0.1)
-      actionpack (= 5.0.1)
-      actionview (= 5.0.1)
-      activejob (= 5.0.1)
+    actionmailer (5.0.2)
+      actionpack (= 5.0.2)
+      actionview (= 5.0.2)
+      activejob (= 5.0.2)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.0.1)
-      actionview (= 5.0.1)
-      activesupport (= 5.0.1)
+    actionpack (5.0.2)
+      actionview (= 5.0.2)
+      activesupport (= 5.0.2)
       rack (~> 2.0)
       rack-test (~> 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.0.1)
-      activesupport (= 5.0.1)
+    actionview (5.0.2)
+      activesupport (= 5.0.2)
       builder (~> 3.1)
       erubis (~> 2.7.0)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    activejob (5.0.1)
-      activesupport (= 5.0.1)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.0.2)
+      activesupport (= 5.0.2)
       globalid (>= 0.3.6)
-    activemodel (5.0.1)
-      activesupport (= 5.0.1)
-    activerecord (5.0.1)
-      activemodel (= 5.0.1)
-      activesupport (= 5.0.1)
+    activemodel (5.0.2)
+      activesupport (= 5.0.2)
+    activerecord (5.0.2)
+      activemodel (= 5.0.2)
+      activesupport (= 5.0.2)
       arel (~> 7.0)
-    activesupport (5.0.1)
+    activesupport (5.0.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
       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 (7.1.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)
@@ -89,7 +102,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)
@@ -99,6 +114,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)
@@ -106,14 +122,18 @@ 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)
-    nio4r (1.2.1)
-    nokogiri (1.7.0.1)
+    nio4r (2.0.0)
+    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)
@@ -123,31 +143,34 @@ GEM
     pry-byebug (3.4.2)
       byebug (~> 9.0)
       pry (~> 0.10)
+    public_suffix (2.0.5)
     rack (2.0.1)
+    rack-protection (1.5.3)
+      rack
     rack-ssl-enforcer (0.2.9)
     rack-test (0.6.3)
       rack (>= 1.0)
     rack-timeout (0.4.2)
-    rails (5.0.1)
-      actioncable (= 5.0.1)
-      actionmailer (= 5.0.1)
-      actionpack (= 5.0.1)
-      actionview (= 5.0.1)
-      activejob (= 5.0.1)
-      activemodel (= 5.0.1)
-      activerecord (= 5.0.1)
-      activesupport (= 5.0.1)
+    rails (5.0.2)
+      actioncable (= 5.0.2)
+      actionmailer (= 5.0.2)
+      actionpack (= 5.0.2)
+      actionview (= 5.0.2)
+      activejob (= 5.0.2)
+      activemodel (= 5.0.2)
+      activerecord (= 5.0.2)
+      activesupport (= 5.0.2)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 5.0.1)
+      railties (= 5.0.2)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.2)
       activesupport (>= 4.2.0, < 6.0)
       nokogiri (~> 1.6)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
-    railties (5.0.1)
-      actionpack (= 5.0.1)
-      activesupport (= 5.0.1)
+    railties (5.0.2)
+      actionpack (= 5.0.2)
+      activesupport (= 5.0.2)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
@@ -155,6 +178,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)
@@ -169,7 +193,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)
@@ -178,10 +215,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)
     websocket-driver (0.6.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.2)
@@ -192,13 +231,18 @@ PLATFORMS
 DEPENDENCIES
   appraisal
   bundler (~> 1.13)
+  codecov
   guard
   guard-rspec
+  memfs
+  pg
   pry-byebug
   rails (~> 5.0)
   rake (~> 10.0)
   roo_on_rails!
   rspec (~> 3.0)
+  simplecov
+  sqlite3
   thor (~> 0.19)
 
 BUNDLED WITH

data/lib/roo_on_rails/checks/environment.rb

@@ -2,12 +2,15 @@ require 'roo_on_rails/checks/env_specific'
 require 'roo_on_rails/checks/github/branch_protection'
 require 'roo_on_rails/checks/heroku/app_exists'
 require 'roo_on_rails/checks/heroku/preboot_enabled'
+require 'roo_on_rails/checks/heroku/app_exists'
+require 'roo_on_rails/checks/sidekiq/settings'
 
 module RooOnRails
   module Checks
     class Environment < EnvSpecific
       requires GitHub::BranchProtection
       requires Heroku::PrebootEnabled
+      requires Sidekiq::Settings
 
       def call
         # nothing to do

data/lib/roo_on_rails/checks/github/branch_protection.rb

@@ -52,7 +52,7 @@ module RooOnRails
         end
 
         def ensure_coverage_status_check!(contexts)
-          return if (contexts & coverage_contexts) == coverage_contexts
+          return if (contexts & coverage_contexts).sort == coverage_contexts.sort
           fail! 'no code coverage status checks'
         end
 
@@ -92,7 +92,7 @@ module RooOnRails
 
         def ci_context
           if Pathname.new('.travis.yml').exist? then 'continuous-integration/travis-ci'
-          else 'ci/circle-ci'
+          else 'ci/circleci'
           end
         end
 

data/lib/roo_on_rails/checks/helpers.rb

@@ -13,7 +13,10 @@ module RooOnRails
       def self.included(by)
         by.class_eval do
           extend Forwardable
-          delegate %i[ask say set_color] => :'RooOnRails::Checks::Helpers::Receiver.instance'
+          delegate %i(say ask yes? no? create_file
+                      add_file remove_file copy_file
+                      template directory inside inject_into_file
+                      append_to_file) => :'RooOnRails::Checks::Helpers::Receiver.instance'
         end
       end
 
@@ -23,5 +26,3 @@ module RooOnRails
     end
   end
 end
-
-

data/lib/roo_on_rails/checks/sidekiq/settings.rb

@@ -0,0 +1,20 @@
+require 'roo_on_rails/checks/sidekiq/sidekiq'
+require 'roo_on_rails/checks/base'
+require 'thor'
+
+module RooOnRails
+  module Checks
+    module Sidekiq
+      class Settings < Base
+        requires Sidekiq
+        def intro
+          'Checking Sidekiq settings.yml...'
+        end
+
+        def call
+          fail! 'Custom Sidekiq settings found.' if File.exist?('config/sidekiq.yml')
+        end
+      end
+    end
+  end
+end

data/lib/roo_on_rails/checks/sidekiq/sidekiq.rb

@@ -0,0 +1,37 @@
+require 'roo_on_rails/checks/base'
+require 'thor'
+
+module RooOnRails
+  module Checks
+    module Sidekiq
+      class Sidekiq < Base
+        WORKER_PROCFILE_LINE = 'worker: bundle exec roo_on_rails sidekiq'.freeze
+
+        def intro
+          'Checking Sidekiq Setup...'
+        end
+
+        def call
+          unless ENV.fetch('SIDEKIQ_ENABLED', 'true').to_s =~ /\A(YES|TRUE|ON|1)\Z/i
+            pass 'SIDEKIQ_ENABLED is set to false'
+            return
+          end
+          check_for_procfile
+        end
+
+        def fix
+          if File.exist?('Procfile')
+            append_to_file 'Procfile', "\n#{WORKER_PROCFILE_LINE}"
+          else
+            create_file 'Procfile', WORKER_PROCFILE_LINE
+          end
+        end
+
+        def check_for_procfile
+          return if File.exist?('Procfile') && File.read('Procfile').include?('worker')
+          fail! "No Procfile found with a 'worker' command"
+        end
+      end
+    end
+  end
+end

data/lib/roo_on_rails/context_logging.rb

@@ -0,0 +1,106 @@
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/object/blank'
+require 'active_support/version'
+require 'logger'
+require 'roo_on_rails/logfmt'
+
+module RooOnRails
+  # Wraps any standard logger to provide context, similar to `ActiveSupport::TaggedLogging`
+  # but with key/value pairs that are appended to the end of the text.
+  #
+  #   logger = RooOnRails::ContextLogging.new(ActiveSupport::Logger.new($stdout))
+  #   logger.with(a: 1, b: 2) { logger.info 'Stuff' }                   # Logs "Stuff a=1 b=2"
+  #   logger.with(a: 1) { logger.with(b: 2) { logger.info('Stuff') } }  # Logs "Stuff a=1 b=2"
+  #
+  # The above methods persist the context in thread local storage so it will be attached to
+  # any logs made within the scope of the block, even in called methods. However, if your
+  # context only applies to the current log then you can chain off the `with` method.
+  #
+  #   logger.with(a: 1, b: 2).info('Stuff')                   # Logs "Stuff a=1 b=2"
+  #   logger.with(a: 1) { logger.with(b: 2).info('Stuff')  }  # Logs "Stuff a=1 b=2"
+  #
+  # Hashes, arrays and any complex object that supports `#to_json` will be output in escaped
+  # JSON format so that it can be parsed out of the attribute values.
+  module ContextLogging
+    module Formatter
+      def call(severity, timestamp, progname, msg)
+        super(severity, timestamp, progname, "#{msg}#{context_text}")
+      end
+
+      def with(**context)
+        Thread.handle_interrupt(Exception => :never) do
+          current_context.push(context)
+          begin
+            Thread.handle_interrupt(Exception => :immediate) do
+              yield self
+            end
+          ensure
+            current_context.pop
+          end
+        end
+      end
+
+      def clear_context!
+        current_context.clear
+      end
+
+      private
+
+      def current_context
+        # We use our object ID here to avoid conflicting with other instances
+        thread_key = @logging_context_key ||= "roo_on_rails:logging_context:#{object_id}".freeze
+        Thread.current[thread_key] ||= []
+      end
+
+      def context_text
+        context = current_context
+        return nil if context.empty?
+
+        merged_context = context.each_with_object({}) { |ctx, acc| acc.merge!(ctx) }
+        ' ' + Logfmt.dump(merged_context)
+      end
+    end
+
+    class LoggerProxy
+      def initialize(logger, context)
+        @logger = logger
+        @context = context
+      end
+
+      %i[debug info warn error fatal unknown].each do |severity|
+        define_method severity do |message|
+          @logger.with(**@context) { @logger.public_send(severity, message) }
+        end
+      end
+    end
+
+    def self.new(logger)
+      # Ensure we set a default formatter so we aren't extending nil!
+      logger.formatter ||=
+        if ActiveSupport::VERSION::MAJOR >= 4
+          require 'active_support/logger'
+          ActiveSupport::Logger::SimpleFormatter.new
+        else
+          require 'active_support/core_ext/logger'
+          ::Logger::SimpleFormatter.new
+        end
+      logger.formatter.extend(Formatter)
+      logger.extend(self)
+    end
+
+    delegate :clear_context!, to: :formatter
+
+    def with(**context)
+      if block_given?
+        formatter.with(**context) { yield self }
+      else
+        LoggerProxy.new(self, context)
+      end
+    end
+
+    def flush
+      clear_context!
+      super if defined?(super)
+    end
+  end
+end

data/lib/roo_on_rails/default.env

@@ -9,3 +9,6 @@ NEW_RELIC_DEVELOPER_MODE=false
 NEW_RELIC_LICENSE_KEY=override-me
 RACK_SERVICE_TIMEOUT=10
 RACK_WAIT_TIMEOUT=30
+SIDEKIQ_ENABLED=true
+SIDEKIQ_THREADS=25
+SIDEKIQ_DATABASE_REAPING_FREQUENCY=10

data/lib/roo_on_rails/environment.rb

@@ -0,0 +1,9 @@
+require 'dotenv'
+module RooOnRails
+  class Environment
+    def self.load
+      Dotenv.load
+      Dotenv.load File.expand_path('../default.env', __FILE__)
+    end
+  end
+end

data/lib/roo_on_rails/harness.rb

@@ -1,6 +1,7 @@
 require 'thor'
 require 'hashie'
 require 'roo_on_rails/checks/environment'
+require 'roo_on_rails/environment'
 
 module RooOnRails
   class Harness

data/lib/roo_on_rails/logfmt.rb

@@ -0,0 +1,44 @@
+require 'json'
+
+module RooOnRails
+  # A generator for the logfmt log format.
+  #
+  # @see https://brandur.org/logfmt The original description of logfmt
+  # @see https://godoc.org/github.com/kr/logfmt The 'reference' parser
+  module Logfmt
+    class << self
+      SPACE = 0x20
+      QUOTE = 0x22
+      EQUALS = 0x3d
+
+      def dump(hash)
+        return nil if hash.nil? || hash.empty?
+
+        hash.map { |k, v| "#{k}=#{dump_value(v)}" }.join(' ')
+      end
+
+      private
+
+      def dump_value(v)
+        str = case v
+              when String then v
+              when Symbol then v.to_s
+              when Array, Hash then JSON.dump(v)
+              else v.respond_to?(:to_json) ? v.to_json : v.inspect
+              end
+        escape(str)
+      end
+
+      def escape(str)
+        return str if ident?(str)
+
+        escaped = str.gsub(/(["\\])/, '\\\\\1')
+        %("#{escaped}")
+      end
+
+      def ident?(str)
+        str.bytes.all? { |b| b > SPACE && b != EQUALS && b != QUOTE }
+      end
+    end
+  end
+end

data/lib/roo_on_rails/rack/safe_timeouts.rb

@@ -18,7 +18,7 @@ module RooOnRails
 
       def call(env)
         @app.call(env)
-      rescue Rack::Timeout::Error, Rack::Timeout::RequestTimeoutException
+      rescue ::Rack::Timeout::Error, ::Rack::Timeout::RequestTimeoutException
         Rails.logger.warn('Clearing ActiveRecord connection cache due to timeout')
         ActiveRecord::Base.connection.clear_cache!
         raise

data/lib/roo_on_rails/railtie.rb

@@ -1,10 +1,10 @@
 $stderr.puts 'loading roo_on_rails railtie'
-
+require 'roo_on_rails/environment'
 module RooOnRails
   class Railtie < Rails::Railtie
     initializer 'roo_on_rails.default_env' do
       $stderr.puts 'initializer roo_on_rails.default_env'
-      Dotenv.load File.expand_path('../default.env', __FILE__)
+      RooOnRails::Environment.load
     end
 
     # initializer 'roo_on_rails.print_env' do

data/lib/roo_on_rails/railties/database.rb

@@ -0,0 +1,18 @@
+module RooOnRails
+  module Railties
+    class Database < Rails::Railtie
+      if ActiveRecord::VERSION::MAJOR >= 4
+        initializer 'roo_on_rails.database', after: 'active_record.initialize_database' do
+          $stderr.puts 'initializer roo_on_rails.database'
+
+          config = ActiveRecord::Base.configurations[Rails.env]
+          config['variables'] ||= {}
+          config['variables']['statement_timeout'] = ENV.fetch('DATABASE_STATEMENT_TIMEOUT', 200)
+          config['reaping_frequency'] = ENV['DATABASE_REAPING_FREQUENCY']
+
+          ActiveRecord::Base.establish_connection
+        end
+      end
+    end
+  end
+end

data/lib/roo_on_rails/railties/http.rb

@@ -28,10 +28,13 @@ module RooOnRails
           app.config.middleware.use ::Rack::Deflater
         end
 
-        app.config.middleware.insert_before(
-          ActionDispatch::Cookies,
-          ::Rack::SslEnforcer
-        )
+        # Don't use SslEnforcer in test environment as it breaks Capybara
+        unless Rails.env.test?
+          app.config.middleware.insert_before(
+            ActionDispatch::Cookies,
+            ::Rack::SslEnforcer
+          )
+        end
       end
     end
   end

data/lib/roo_on_rails/railties/rake_tasks.rb

@@ -0,0 +1,11 @@
+module RooOnRails
+  module Railties
+    class RakeTasks < Rails::Railtie
+      rake_tasks do
+        $stderr.puts 'initializer roo_on_rails.rake_tasks'
+
+        Dir[File.join(__dir__, '..', 'tasks', '*.rake')].each { |f| load f }
+      end
+    end
+  end
+end

data/lib/roo_on_rails/railties/sidekiq.rb

@@ -0,0 +1,42 @@
+require 'sidekiq'
+require 'roo_on_rails/sidekiq/settings'
+require 'roo_on_rails/sidekiq/sla_metric'
+
+module RooOnRails
+  module Railties
+    class Sidekiq < Rails::Railtie
+      initializer 'roo_on_rails.sidekiq' do |app|
+        require 'hirefire-resource'
+        $stderr.puts 'initializer roo_on_rails.sidekiq'
+        break unless ENV.fetch('SIDEKIQ_ENABLED', 'true').to_s =~ /\A(YES|TRUE|ON|1)\Z/i
+        config_sidekiq
+        config_hirefire(app)
+      end
+
+      def config_hirefire(app)
+        unless ENV['HIREFIRE_TOKEN']
+          warn 'No HIREFIRE_TOKEN token set, auto scaling not enabled'
+          return
+        end
+        add_middleware(app)
+      end
+
+      def config_sidekiq
+        ::Sidekiq.configure_server do |x|
+          x.options[:concurrency] = RooOnRails::Sidekiq::Settings.concurrency.to_i
+          x.options[:queues] = RooOnRails::Sidekiq::Settings.queues
+        end
+      end
+
+      def add_middleware(app)
+        $stderr.puts 'HIREFIRE_TOKEN set'
+        app.middleware.use HireFire::Middleware
+        HireFire::Resource.configure do |config|
+          config.dyno(:worker) do
+            RooOnRails::Sidekiq::SlaMetric.queue
+          end
+        end
+      end
+    end
+  end
+end

data/lib/roo_on_rails/sidekiq/loader.rb

@@ -0,0 +1,13 @@
+require 'roo_on_rails/environment'
+module RooOnRails
+  module Sidekiq
+    class Loader
+      def self.run
+        RooOnRails::Environment.load
+        ENV['RAILS_MAX_THREADS'] = (ENV.fetch('SIDEKIQ_THREADS').to_i + 1).to_s
+        ENV['DATABASE_REAPING_FREQUENCY'] = ENV['SIDEKIQ_DATABASE_REAPING_FREQUENCY']
+        exec 'sidekiq'
+      end
+    end
+  end
+end