rollbar 2.23.2 → 3.3.0

data/gemfiles/rails61.gemfile

@@ -0,0 +1,54 @@
+require 'rubygems/version'
+
+source 'https://rubygems.org'
+
+is_jruby = defined?(JRUBY_VERSION) || (defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby')
+
+gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
+gem 'jruby-openssl', :platform => :jruby
+gem 'rails', '~> 6.1.3'
+gem 'sqlite3', '~> 1.4', :platform => [:ruby, :mswin, :mingw]
+
+gem 'rspec-rails', '~> 4.0.2'
+
+gem 'rake'
+
+gem 'sidekiq', '>= 2.13.0'
+
+platforms :rbx do
+  gem 'minitest'
+  gem 'racc'
+  gem 'rubinius-developer_tools'
+  gem 'rubysl', '~> 2.0' if RUBY_VERSION.start_with?('2')
+end
+
+gem 'sucker_punch', '~> 2.0'
+
+# We need last sinatra that uses rack 2.x
+gem 'sinatra', :git => 'https://github.com/sinatra/sinatra'
+
+gem 'codacy-coverage'
+gem 'database_cleaner'
+gem 'delayed_job', '4.1.9', :require => false
+gem 'generator_spec'
+gem 'girl_friday', '>= 0.11.1'
+gem 'redis'
+gem 'resque'
+gem 'secure_headers', '~> 6.3.2', :require => false
+gem 'simplecov'
+
+unless is_jruby
+  # JRuby doesn't support fork, which is required for this test helper.
+  gem 'rspec-command'
+end
+
+gem 'mime-types'
+
+gem 'webmock', :require => false
+
+gem 'aws-sdk-sqs'
+gem 'shoryuken'
+
+gem 'capistrano', :require => false
+
+gemspec :path => '../'

data/lib/generators/rollbar/rollbar_generator.rb

@@ -5,7 +5,8 @@ require 'generators/rollbar/rollbar_generator'
 module Rollbar
   module Generators
     class RollbarGenerator < ::Rails::Generators::Base
-      argument :access_token, :type => :string, :banner => 'access_token', :default => :use_env_sentinel
+      argument :access_token, :type => :string, :banner => 'access_token',
+                              :default => :use_env_sentinel
 
       source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
 
@@ -13,32 +14,35 @@ module Rollbar
         say 'creating initializer...'
         if access_token_configured?
           say "It looks like you've already configured Rollbar."
-          say 'To re-create the config file, remove it first: config/initializers/rollbar.rb'
+          say 'To re-create the config file, remove it first: ' \
+            'config/initializers/rollbar.rb'
           exit
         end
 
         begin
           require 'ey_config'
         rescue LoadError
+          # Skip loading
         end
 
         if defined? EY::Config
           say 'Access token will be read from Engine Yard configuration'
+        elsif access_token === :use_env_sentinel
+          say 'Generator run without an access token; assuming you want to ' \
+            'configure using an environment variable.'
+          say "You'll need to add an environment variable ROLLBAR_ACCESS_TOKEN " \
+            'with your access token:'
+          say "\n$ export ROLLBAR_ACCESS_TOKEN=yourtokenhere"
+          say "\nIf that's not what you wanted to do:"
+          say "\n$ rm config/initializers/rollbar.rb"
+          say '$ rails generate rollbar yourtokenhere'
+          say "\n"
         else
-          if access_token === :use_env_sentinel
-            say 'Generator run without an access token; assuming you want to configure using an environment variable.'
-            say "You'll need to add an environment variable ROLLBAR_ACCESS_TOKEN with your access token:"
-            say "\n$ export ROLLBAR_ACCESS_TOKEN=yourtokenhere"
-            say "\nIf that's not what you wanted to do:"
-            say "\n$ rm config/initializers/rollbar.rb"
-            say '$ rails generate rollbar yourtokenhere'
-            say "\n"
-          else
-            say 'access token: ' << access_token
-          end
+          say 'access token: ' << access_token
         end
 
-        template 'initializer.rb', 'config/initializers/rollbar.rb', :assigns => { :access_token => access_token_expr }
+        template 'initializer.erb', 'config/initializers/rollbar.rb',
+                 :assigns => { :access_token => access_token_expr }
 
         # TODO: run rake test task
       end

data/lib/rails/rollbar_runner.rb

@@ -4,7 +4,10 @@ require 'rollbar'
 # Rails.root is not present here.
 # RSpec needs ENV['DUMMYAPP_PATH'] in order to have a valid path.
 # Dir.pwd is used in normal operation.
-APP_PATH = File.expand_path('config/application', (ENV['DUMMYAPP_PATH'] || Dir.pwd))
+APP_PATH = File.expand_path(
+  'config/application',
+  (ENV['DUMMYAPP_PATH'] || Dir.pwd)
+)
 
 module Rails
   class RollbarRunner
@@ -39,7 +42,7 @@ module Rails
     end
 
     def eval_runner
-      if Rails.version >= '5.1.0'
+      if Gem::Version.new(Rails.version) >= Gem::Version.new('5.1.0')
         rails5_runner
       else
         legacy_runner
@@ -49,12 +52,14 @@ module Rails
     def legacy_runner
       string_to_eval = File.read(runner_path)
 
-      ::Rails.module_eval(<<-EOL, __FILE__, __LINE__ + 2)
+      ::Rails.module_eval(<<-FILE, __FILE__, __LINE__ + 1)
           #{string_to_eval}
-      EOL
+      FILE
     end
 
     def rails5_runner
+      require 'rails/command'
+
       Rails::Command.invoke 'runner', ARGV
     end
 
@@ -66,11 +71,15 @@ module Rails
     end
 
     def runner_path
-      railties_gem_dir + '/lib/rails/commands/runner.rb'
+      "#{railties_gem_dir}/lib/rails/commands/runner.rb"
     end
 
     def railties_gem
-      resolver_class = Gem::Specification.respond_to?(:find_by_name) ? GemResolver : LegacyGemResolver
+      resolver_class = if Gem::Specification.respond_to?(:find_by_name)
+                         GemResolver
+                       else
+                         LegacyGemResolver
+                       end
       gem = resolver_class.new.railties_gem
 
       abort 'railties gem not found' unless gem

data/lib/rollbar/capistrano.rb

@@ -34,8 +34,12 @@ module Rollbar
           _cset(:rollbar_role)  { :app }
           _cset(:rollbar_user)  { ENV['USER'] || ENV['USERNAME'] }
           _cset(:rollbar_env)   { fetch(:rails_env, 'production') }
-          _cset(:rollbar_token) { abort("Please specify the Rollbar access token, set :rollbar_token, 'your token'") }
-          _cset(:rollbar_revision) { current_revision }
+          _cset(:rollbar_token) do
+            abort(
+              "Please specify the Rollbar access token, set :rollbar_token, 'your token'"
+            )
+          end
+          _cset(:rollbar_revision) { real_revision }
           _cset(:rollbar_comment) { nil }
         end
       end
@@ -51,7 +55,9 @@ module Rollbar
           :task => :deploy_started,
           :configuration => configuration
         ) do
-          ::Rollbar::CapistranoTasks.deploy_started(configuration, configuration.logger, configuration.dry_run)
+          ::Rollbar::CapistranoTasks.deploy_started(
+            configuration, configuration.logger, configuration.dry_run
+          )
         end
       end
 
@@ -61,17 +67,17 @@ module Rollbar
           :task => :deploy_succeeded,
           :configuration => configuration
         ) do
-          ::Rollbar::CapistranoTasks.deploy_succeeded(configuration, configuration.logger, configuration.dry_run)
+          ::Rollbar::CapistranoTasks.deploy_succeeded(
+            configuration, configuration.logger, configuration.dry_run
+          )
         end
       end
 
-      def load_task(configuration:, desc:, task:)
+      def load_task(configuration:, desc:, task:, &block)
         configuration.load do
           namespace :rollbar do
             desc(desc)
-            task(task) do
-              yield
-            end
+            task(task, &block)
           end
         end
       end
@@ -79,4 +85,6 @@ module Rollbar
   end
 end
 
-Rollbar::Capistrano2.load_into(Capistrano::Configuration.instance) if Capistrano::Configuration.instance
+if Capistrano::Configuration.instance
+  Rollbar::Capistrano2.load_into(Capistrano::Configuration.instance)
+end

data/lib/rollbar/capistrano3.rb

@@ -8,7 +8,10 @@ require 'rollbar/capistrano_tasks'
 
 namespace :rollbar do
   # dry_run? wasn't introduced till Capistrano 3.5.0; use the old fetch(:sshkit_backed)
-  set :dry_run, (proc { ::Capistrano::Configuration.env.fetch(:sshkit_backend) == ::SSHKit::Backend::Printer })
+  set :dry_run, (proc {
+                   ::Capistrano::Configuration.env.fetch(:sshkit_backend) ==
+                     ::SSHKit::Backend::Printer
+                 })
 
   desc 'Send deployment started notification to Rollbar.'
   task :deploy_started do
@@ -49,7 +52,10 @@ namespace :load do
   task :defaults do
     set :rollbar_user,      (proc { fetch :local_user, ENV['USER'] || ENV['USERNAME'] })
     set :rollbar_env,       (proc { fetch :rails_env, 'production' })
-    set :rollbar_token,     (proc { abort "Please specify the Rollbar access token, set :rollbar_token, 'your token'" })
+    set :rollbar_token,     (proc {
+                               abort 'Please specify the Rollbar access token, ' \
+                                     "set :rollbar_token, 'your token'"
+                             })
     set :rollbar_role,      (proc { :app })
     set :rollbar_revision,  (proc { fetch :current_revision })
   end

data/lib/rollbar/capistrano_tasks.rb

@@ -13,23 +13,31 @@ module Rollbar
           capistrano.set(:rollbar_deploy_id, 123) if dry_run
 
           skip_in_dry_run(logger, dry_run) do
-            if result[:success] && (deploy_id = result[:data] && result[:data][:deploy_id])
+            if result[:success] &&
+               (deploy_id = result[:data] &&
+               result[:data][:deploy_id])
               capistrano.set :rollbar_deploy_id, deploy_id
             else
-              logger.error 'Unable to report deploy to Rollbar' + (result[:message] ? ': ' + result[:message] : '')
+              message = format_message('Unable to report deploy to Rollbar',
+                                       result[:message])
+              log_error(logger, message)
             end
           end
         end
       end
 
       def deploy_succeeded(capistrano, logger, dry_run)
-        deploy_update(capistrano, logger, dry_run, :desc => 'Setting deployment status to `succeeded` in Rollbar') do
+        deploy_update(
+          capistrano, logger, dry_run,
+          :desc => 'Setting deployment status to `succeeded` in Rollbar'
+        ) do
           report_deploy_succeeded(capistrano, dry_run)
         end
       end
 
       def deploy_failed(capistrano, logger, dry_run)
-        deploy_update(capistrano, logger, dry_run, :desc => 'Setting deployment status to `failed` in Rollbar') do
+        deploy_update(capistrano, logger, dry_run,
+                      :desc => 'Setting deployment status to `failed` in Rollbar') do
           report_deploy_failed(capistrano, dry_run)
         end
       end
@@ -40,6 +48,8 @@ module Rollbar
         capistrano_300_warning(logger)
         logger.info opts[:desc] if opts[:desc]
         yield
+      rescue StandardError => e
+        log_error logger, "Error reporting to Rollbar: #{e.inspect}"
       end
 
       def deploy_update(capistrano, logger, dry_run, opts = {})
@@ -53,7 +63,9 @@ module Rollbar
               if result[:success]
                 logger.info 'Updated deploy status in Rollbar'
               else
-                logger.error 'Unable to update deploy status in Rollbar' + (result[:message] ? ': ' + result[:message] : '')
+                message = format_message('Unable to update deploy status in Rollbar',
+                                         result[:message])
+                log_error(logger, message)
               end
             end
           end
@@ -61,7 +73,13 @@ module Rollbar
       end
 
       def capistrano_300_warning(logger)
-        logger.warn("You need to upgrade capistrano to '>= 3.1' version in order to correctly report deploys to Rollbar. (On 3.0, the reported revision will be incorrect.)") if ::Capistrano::VERSION =~ /^3\.0/
+        unless ::Capistrano.const_defined?('VERSION') && ::Capistrano::VERSION =~ /^3\.0/
+          return
+        end
+
+        logger.warn('You need to upgrade capistrano to >= 3.1 version in order'\
+          'to correctly report deploys to Rollbar. (On 3.0, the reported revision'\
+          'will be incorrect.)')
       end
 
       def report_deploy_started(capistrano, dry_run)
@@ -83,6 +101,7 @@ module Rollbar
       def report_deploy_succeeded(capistrano, dry_run)
         ::Rollbar::Deploy.update(
           {
+            :comment => capistrano.fetch(:rollbar_comment),
             :proxy => :ENV,
             :dry_run => dry_run
           },
@@ -95,6 +114,7 @@ module Rollbar
       def report_deploy_failed(capistrano, dry_run)
         ::Rollbar::Deploy.update(
           {
+            :comment => capistrano.fetch(:rollbar_comment),
             :proxy => :ENV,
             :dry_run => dry_run
           },
@@ -108,7 +128,8 @@ module Rollbar
         if capistrano.fetch(:rollbar_deploy_id)
           yield
         else
-          logger.error 'Failed to update the deploy in Rollbar. No deploy id available.'
+          log_error logger,
+                    'Failed to update the deploy in Rollbar. No deploy id available.'
         end
       end
 
@@ -121,10 +142,25 @@ module Rollbar
       end
 
       def debug_request_response(logger, result)
-        # NOTE: in Capistrano debug messages go to log/capistrano.log but not to stdout even if log_level == :debug
+        # NOTE: in Capistrano debug messages go to log/capistrano.log but not to
+        # stdout even if log_level == :debug
         logger.debug result[:request_info]
         logger.debug result[:response_info] if result[:response_info]
       end
+
+      def format_message(*args)
+        args.compact.join(': ')
+      end
+
+      def log_error(logger, message)
+        # Capistrano 2.x doesn't have the #error method,
+        # so we use #important if #error isn't present
+        if logger.respond_to?(:error)
+          logger.error message
+        elsif logger.respond_to?(:important)
+          logger.important message
+        end
+      end
     end
   end
 end