airbrake 10.0.0 → 13.0.3

data/lib/airbrake/rake/tasks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'airbrake-ruby'
 
 namespace :airbrake do
@@ -51,11 +53,11 @@ namespace :airbrake do
     raise Airbrake::Error, 'airbrake-ruby is not configured' unless Airbrake.configured?
 
     deploy_params = {
-      environment: ENV['ENVIRONMENT'],
-      username: ENV['USERNAME'],
-      revision: ENV['REVISION'],
-      repository: ENV['REPOSITORY'],
-      version: ENV['VERSION'],
+      environment: ENV.fetch('ENVIRONMENT', nil),
+      username: ENV.fetch('USERNAME', nil),
+      revision: ENV.fetch('REVISION', nil),
+      repository: ENV.fetch('REPOSITORY', nil),
+      version: ENV.fetch('VERSION', nil),
     }
     promise = Airbrake.notify_deploy(deploy_params)
     promise.then do
@@ -66,10 +68,10 @@ namespace :airbrake do
 
   desc 'Install a Heroku deploy hook to notify Airbrake of deploys'
   task :install_heroku_deploy_hook do
-    app = ENV['HEROKU_APP']
+    app = ENV.fetch('HEROKU_APP', nil)
 
     config = Bundler.with_clean_env do
-      `heroku config --shell#{ " --app #{app}" if app }`
+      `heroku config --shell#{" --app #{app}" if app}`
     end
 
     heroku_env = config.each_line.with_object({}) do |line, h|
@@ -83,11 +85,11 @@ namespace :airbrake do
 
     unless (env = heroku_env['RAILS_ENV'])
       env = 'production'
-      puts "Airbrake couldn't identify your app's environment, so the '#{env}'" \
-           " environment will be used."
+      puts "Airbrake couldn't identify your app's environment, " \
+           "so the '#{env}' environment will be used."
     end
 
-    unless (repo = ENV['REPOSITORY_URL'])
+    unless (repo = ENV.fetch('REPOSITORY_URL', nil))
       repo = `git remote get-url origin 2>/dev/null`.chomp
       if repo.empty?
         puts "Airbrake couldn't identify your app's repository."
@@ -97,14 +99,14 @@ namespace :airbrake do
       end
     end
 
-    url = "https://airbrake.io/api/v3/projects/#{id}/heroku-deploys?key=#{key}"
+    url = ["https://airbrake.io/api/v3/projects/#{id}/heroku-deploys?key=#{key}"]
     url << "&environment=#{env}"
     url << "&repository=#{repo}" unless repo.empty?
 
-    command = %(heroku addons:create deployhooks:http --url="#{url}")
+    command = [%(heroku addons:create deployhooks:http --url="#{url.join}")]
     command << " --app #{app}" if app
 
-    puts "$ #{command}"
+    puts "$ #{command.join}"
     Bundler.with_clean_env { puts `#{command}` }
   end
 end

data/lib/airbrake/rake.rb

@@ -1,63 +1,66 @@
+# frozen_string_literal: true
+
 # This is not bulletproof, but if this file is executed before a task
 # definition, we can grab tasks descriptions and locations.
 # See: https://goo.gl/ksn6PE
 Rake::TaskManager.record_task_metadata = true
 
-module Rake
-  # Redefine +Rake::Task#execute+, so it can report errors to Airbrake.
-  class Task
-    # Store the original method to use it later.
-    alias execute_without_airbrake execute
-
-    # A wrapper around the original +#execute+, that catches all errors and
-    # notifies Airbrake.
-    #
-    # rubocop:disable Lint/RescueException
-    def execute(args = nil)
-      execute_without_airbrake(args)
-    rescue Exception => ex
-      notify_airbrake(ex, args)
-      raise ex
-    end
-    # rubocop:enable Lint/RescueException
+module Airbrake
+  module Rake
+    # Redefine +Rake::Task#execute+, so it can report errors to Airbrake.
+    module Task
+      # A wrapper around the original +#execute+, that catches all errors and
+      # notifies Airbrake.
+      #
+      # rubocop:disable Lint/RescueException
+      def execute(args = nil)
+        super(args)
+      rescue Exception => ex
+        notify_airbrake(ex, args)
+        raise ex
+      end
+      # rubocop:enable Lint/RescueException
 
-    private
+      private
 
-    def notify_airbrake(exception, args)
-      notice = Airbrake.build_notice(exception)
-      notice[:context][:component] = 'rake'
-      notice[:context][:action] = name
-      notice[:params].merge!(
-        rake_task: task_info,
-        execute_args: args,
-        argv: ARGV.join(' '),
-      )
+      def notify_airbrake(exception, args)
+        notice = Airbrake.build_notice(exception)
+        notice[:context][:component] = 'rake'
+        notice[:context][:action] = name
+        notice[:params].merge!(
+          rake_task: task_info,
+          execute_args: args,
+          argv: ARGV.join(' '),
+        )
 
-      Airbrake.notify_sync(notice)
-    end
+        Airbrake.notify_sync(notice)
+      end
 
-    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize
-    def task_info
-      info = {}
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize
+      def task_info
+        info = {}
 
-      info[:name] = name
-      info[:timestamp] = timestamp.to_s
-      info[:investigation] = investigation
+        info[:name] = name
+        info[:timestamp] = timestamp.to_s
+        info[:investigation] = investigation
 
-      info[:full_comment] = full_comment if full_comment
-      info[:arg_names] = arg_names if arg_names.any?
-      info[:arg_description] = arg_description if arg_description
-      info[:locations] = locations if locations.any?
-      info[:sources] = sources if sources.any?
+        info[:full_comment] = full_comment if full_comment
+        info[:arg_names] = arg_names if arg_names.any?
+        info[:arg_description] = arg_description if arg_description
+        info[:locations] = locations if locations.any?
+        info[:sources] = sources if sources.any?
 
-      if prerequisite_tasks.any?
-        info[:prerequisite_tasks] = prerequisite_tasks.map do |p|
-          p.__send__(:task_info)
+        if prerequisite_tasks.any?
+          info[:prerequisite_tasks] = prerequisite_tasks.map do |p|
+            p.__send__(:task_info)
+          end
         end
-      end
 
-      info
+        info
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize
     end
-    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize
   end
 end
+
+Rake::Task.prepend(Airbrake::Rake::Task)

data/lib/airbrake/resque.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Resque
   module Failure
     # Provides Resque integration with Airbrake.
@@ -28,32 +30,33 @@ module Resque
   end
 end
 
-module Resque
-  # Measures elapsed time of a job and notifies Airbrake of the execution
-  # status.
-  #
-  # @since v9.6.0
-  class Job
-    # Store the original method to use it later.
-    alias perform_without_airbrake perform
-
-    def perform
-      timing = Airbrake::Benchmark.measure do
-        perform_without_airbrake
+module Airbrake
+  module Resque
+    # Measures elapsed time of a job and notifies Airbrake of the execution
+    # status.
+    #
+    # @since v9.6.0
+    module Job
+      def perform
+        timing = Airbrake::Benchmark.measure do
+          super
+        end
+      rescue StandardError => exception
+        Airbrake.notify_queue_sync(
+          queue: payload['class'],
+          error_count: 1,
+          timing: 0.01,
+        )
+        raise exception
+      else
+        Airbrake.notify_queue_sync(
+          queue: payload['class'],
+          error_count: 0,
+          timing: timing,
+        )
       end
-    rescue StandardError => exception
-      Airbrake.notify_queue_sync(
-        queue: payload['class'],
-        error_count: 1,
-        timing: 0.01,
-      )
-      raise exception
-    else
-      Airbrake.notify_queue_sync(
-        queue: payload['class'],
-        error_count: 0,
-        timing: timing,
-      )
     end
   end
 end
+
+Resque::Job.prepend(Airbrake::Resque::Job)

data/lib/airbrake/shoryuken.rb

@@ -1,12 +1,12 @@
+# frozen_string_literal: true
+
 module Airbrake
   module Shoryuken
     # Provides integration with Shoryuken.
     class ErrorHandler
       # rubocop:disable Lint/RescueException
-      def call(worker, queue, _sqs_msg, body)
-        timing = Airbrake::Benchmark.measure do
-          yield
-        end
+      def call(worker, queue, _sqs_msg, body, &block)
+        timing = Airbrake::Benchmark.measure(&block)
       rescue Exception => exception
         notify_airbrake(exception, worker, queue, body)
         Airbrake.notify_queue(

data/lib/airbrake/sidekiq/retryable_jobs_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Airbrake
   module Sidekiq
     # Filter that can ignore notices from jobs that failed but will be retried

data/lib/airbrake/sidekiq.rb

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
+
 require 'airbrake/sidekiq/retryable_jobs_filter'
 
 module Airbrake
   module Sidekiq
     # Provides integration with Sidekiq v2+.
     class ErrorHandler
-      def call(_worker, context, _queue)
-        timing = Airbrake::Benchmark.measure do
-          yield
-        end
+      def call(_worker, context, _queue, &block)
+        timing = Airbrake::Benchmark.measure(&block)
       rescue Exception => exception # rubocop:disable Lint/RescueException
         notify_airbrake(exception, context)
         Airbrake.notify_queue(
@@ -27,7 +27,7 @@ module Airbrake
       private
 
       def notify_airbrake(exception, context)
-        Airbrake.notify(exception, context) do |notice|
+        Airbrake.notify(exception, job: context) do |notice|
           notice[:context][:component] = 'sidekiq'
           notice[:context][:action] = action(context)
         end
@@ -36,9 +36,10 @@ module Airbrake
       # @return [String] job's name. When ActiveJob is present, retrieve
       #   job_class. When used directly, use worker's name
       def action(context)
-        klass = context['class'] || context[:job] && context[:job]['class']
+        klass = context['class'] || (context[:job] && context[:job]['class'])
         return klass unless context[:job] && context[:job]['args'].first.is_a?(Hash)
         return klass unless (job_class = context[:job]['args'].first['job_class'])
+
         job_class
       end
     end

data/lib/airbrake/sneakers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Airbrake
   module Sneakers
     # Provides integration with Sneakers.
@@ -10,17 +12,21 @@ module Airbrake
       # @see https://github.com/airbrake/airbrake/issues/850
       IGNORED_KEYS = %i[delivery_tag consumer channel].freeze
 
-      def call(exception, worker = nil, **context)
+      # rubocop:disable Style/OptionalArguments
+      def call(exception, worker = nil, context)
+        # Later versions add a middle argument.
         Airbrake.notify(exception, filter_context(context)) do |notice|
           notice[:context][:component] = 'sneakers'
           notice[:context][:action] = worker.class.to_s
         end
       end
+      # rubocop:enable Style/OptionalArguments
 
       private
 
       def filter_context(context)
         return context unless context[:delivery_info]
+
         h = context.dup
         h[:delivery_info] = context[:delivery_info].reject do |k, _v|
           IGNORED_KEYS.include?(k)
@@ -33,34 +39,34 @@ end
 
 Sneakers.error_reporters << Airbrake::Sneakers::ErrorReporter.new
 
-module Sneakers
-  # @todo Migrate to Sneakers v2.12.0 middleware API when it's released
-  # @see https://github.com/jondot/sneakers/pull/364
-  module Worker
-    # Sneakers v2.7.0+ renamed `do_work` to `process_work`.
-    if method_defined?(:process_work)
-      alias process_work_without_airbrake process_work
-    else
-      alias process_work_without_airbrake do_work
-    end
-
-    def process_work(delivery_info, metadata, msg, handler)
-      timing = Airbrake::Benchmark.measure do
-        process_work_without_airbrake(delivery_info, metadata, msg, handler)
+module Airbrake
+  module Sneakers
+    # @todo Migrate to Sneakers v2.12.0 middleware API when it's released
+    # @see https://github.com/jondot/sneakers/pull/364
+    module Worker
+      # Sneakers v2.7.0+ renamed `do_work` to `process_work`.
+      define_method(
+        ::Sneakers::Worker.method_defined?(:process_work) ? :process_work : :do_work,
+      ) do |delivery_info, metadata, msg, handler|
+        timing = Airbrake::Benchmark.measure do
+          super(delivery_info, metadata, msg, handler)
+        end
+      rescue Exception => exception # rubocop:disable Lint/RescueException
+        Airbrake.notify_queue(
+          queue: self.class.to_s,
+          error_count: 1,
+          timing: 0.01,
+        )
+        raise exception
+      else
+        Airbrake.notify_queue(
+          queue: self.class.to_s,
+          error_count: 0,
+          timing: timing,
+        )
       end
-    rescue Exception => exception # rubocop:disable Lint/RescueException
-      Airbrake.notify_queue(
-        queue: self.class.to_s,
-        error_count: 1,
-        timing: 0.01,
-      )
-      raise exception
-    else
-      Airbrake.notify_queue(
-        queue: self.class.to_s,
-        error_count: 0,
-        timing: timing,
-      )
     end
   end
 end
+
+Sneakers::Worker.prepend(Airbrake::Sneakers::Worker)

data/lib/airbrake/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # We use Semantic Versioning v2.0.0
 # More information: http://semver.org/
 module Airbrake
-  AIRBRAKE_VERSION = '10.0.0'.freeze
+  AIRBRAKE_VERSION = '13.0.3'
 end

data/lib/airbrake.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'shellwords'
 require 'English'
 

data/lib/generators/airbrake_generator.rb

@@ -1,22 +1,21 @@
+# frozen_string_literal: true
+
 # Creates the Airbrake initializer file for Rails apps.
 #
 # @example Invokation from terminal
-#   rails generate airbrake PROJECT_KEY PROJECT_ID [NAME]
+#   rails generate airbrake [NAME]
 #
 class AirbrakeGenerator < Rails::Generators::Base
   # Adds current directory to source paths, so we can find the template file.
   source_root File.expand_path(__dir__)
 
-  argument :project_id, required: false
-  argument :project_key, required: false
-
   # Makes the NAME option optional, which allows to subclass from Base, so we
   # can pass arguments to the ERB template.
   #
-  # @see http://asciicasts.com/episodes/218-making-generators-in-rails-3
+  # @see https://asciicasts.com/episodes/218-making-generators-in-rails-3.html
   argument :name, type: :string, default: 'application'
 
-  desc 'Configures the Airbrake notifier with your project id and project key'
+  desc 'Configures the Airbrake notifier'
   def generate_layout
     template 'airbrake_initializer.rb.erb', 'config/initializers/airbrake.rb'
   end

data/lib/generators/airbrake_initializer.rb.erb

@@ -1,78 +1,80 @@
-# Airbrake is an online tool that provides robust exception tracking in your Rails
-# applications. In doing so, it allows you to easily review errors, tie an error
-# to an individual piece of code, and trace the cause back to recent
-# changes. Airbrake enables for easy categorization, searching, and prioritization
-# of exceptions so that when errors occur, your team can quickly determine the
-# root cause.
+# frozen_string_literal: true
+
+# Airbrake is an online tool that provides robust exception tracking in your
+# Rails applications. In doing so, it allows you to easily review errors, tie an
+# error to an individual piece of code, and trace the cause back to recent
+# changes. Airbrake enables for easy categorization, searching, and
+# prioritization of exceptions so that when errors occur, your team can quickly
+# determine the root cause.
 #
 # Configuration details:
 # https://github.com/airbrake/airbrake-ruby#configuration
-Airbrake.configure do |c|
-  # You must set both project_id & project_key. To find your project_id and
-  # project_key navigate to your project's General Settings and copy the values
-  # from the right sidebar.
-  # https://github.com/airbrake/airbrake-ruby#project_id--project_key
-<% if project_id -%>
-  c.project_id = <%= project_id %>
-<% else -%>
-  c.project_id = ENV['AIRBRAKE_PROJECT_ID']
-<% end -%>
-<% if project_key -%>
-  c.project_key = '<%= project_key %>'
-<% else -%>
-  c.project_key = ENV['AIRBRAKE_API_KEY']
-<% end -%>
+if (project_id = ENV['AIRBRAKE_PROJECT_ID']) &&
+   project_key = (ENV['AIRBRAKE_PROJECT_KEY'] || ENV['AIRBRAKE_API_KEY'])
+  Airbrake.configure do |c|
+    # You must set both project_id & project_key. To find your project_id and
+    # project_key navigate to your project's General Settings and copy the
+    # values from the right sidebar.
+    # https://github.com/airbrake/airbrake-ruby#project_id--project_key
+    c.project_id = project_id
+    c.project_key = project_key
 
-  # Configures the root directory of your project. Expects a String or a
-  # Pathname, which represents the path to your project. Providing this option
-  # helps us to filter out repetitive data from backtrace frames and link to
-  # GitHub files from our dashboard.
-  # https://github.com/airbrake/airbrake-ruby#root_directory
-  c.root_directory = Rails.root
+    # Configures the root directory of your project. Expects a String or a
+    # Pathname, which represents the path to your project. Providing this option
+    # helps us to filter out repetitive data from backtrace frames and link to
+    # GitHub files from our dashboard.
+    # https://github.com/airbrake/airbrake-ruby#root_directory
+    c.root_directory = Rails.root
 
-  # By default, Airbrake Ruby outputs to STDOUT. In Rails apps it makes sense to
-  # use the Rails' logger.
-  # https://github.com/airbrake/airbrake-ruby#logger
-  c.logger = Airbrake::Rails.logger
+    # By default, Airbrake Ruby outputs to STDOUT. In Rails apps it makes sense
+    # to use the Rails' logger.
+    # https://github.com/airbrake/airbrake-ruby#logger
+    c.logger = Airbrake::Rails.logger
 
-  # Configures the environment the application is running in. Helps the Airbrake
-  # dashboard to distinguish between exceptions occurring in different
-  # environments.
-  # NOTE: This option must be set in order to make the 'ignore_environments'
-  # option work.
-  # https://github.com/airbrake/airbrake-ruby#environment
-  c.environment = Rails.env
+    # Configures the environment the application is running in. Helps the
+    # Airbrake dashboard to distinguish between exceptions occurring in
+    # different environments.
+    # NOTE: This option must be set in order to make the 'ignore_environments'
+    # option work.
+    # https://github.com/airbrake/airbrake-ruby#environment
+    c.environment = Rails.env
 
-  # Setting this option allows Airbrake to filter exceptions occurring in
-  # unwanted environments such as :test.
-  # NOTE: This option *does not* work if you don't set the 'environment' option.
-  # https://github.com/airbrake/airbrake-ruby#ignore_environments
-  c.ignore_environments = %w[test]
+    # Setting this option allows Airbrake to filter exceptions occurring in
+    # unwanted environments such as :test.  NOTE: This option *does not* work if
+    # you don't set the 'environment' option.
+    # https://github.com/airbrake/airbrake-ruby#ignore_environments
+    c.ignore_environments = %w[test]
 
-  # A list of parameters that should be filtered out of what is sent to
-  # Airbrake. By default, all "password" attributes will have their contents
-  # replaced.
-  # https://github.com/airbrake/airbrake-ruby#blacklist_keys
-  c.blacklist_keys = [/password/i, /authorization/i]
+    # A list of parameters that should be filtered out of what is sent to
+    # Airbrake. By default, all "password" attributes will have their contents
+    # replaced.
+    # https://github.com/airbrake/airbrake-ruby#blocklist_keys
+    c.blocklist_keys = [/password/i, /authorization/i]
 
-  # Alternatively, you can integrate with Rails' filter_parameters.
-  # Read more: https://goo.gl/gqQ1xS
-  # c.blacklist_keys = Rails.application.config.filter_parameters
-end
+    # Alternatively, you can integrate with Rails' filter_parameters.
+    # Read more: https://goo.gl/gqQ1xS
+    # c.blocklist_keys = Rails.application.config.filter_parameters
+  end
 
-# A filter that collects request body information. Enable it if you are sure you
-# don't send sensitive information to Airbrake in your body (such as passwords).
-# https://github.com/airbrake/airbrake#requestbodyfilter
-# Airbrake.add_filter(Airbrake::Rack::RequestBodyFilter.new)
+  # A filter that collects request body information. Enable it if you are sure you
+  # don't send sensitive information to Airbrake in your body (such as passwords).
+  # https://github.com/airbrake/airbrake#requestbodyfilter
+  # Airbrake.add_filter(Airbrake::Rack::RequestBodyFilter.new)
 
-# Attaches thread & fiber local variables along with general thread information.
-# Airbrake.add_filter(Airbrake::Filters::ThreadFilter.new)
+  # Attaches thread & fiber local variables along with general thread information.
+  # Airbrake.add_filter(Airbrake::Filters::ThreadFilter.new)
 
-# Attaches loaded dependencies to the notice object
-# (under context/versions/dependencies).
-# Airbrake.add_filter(Airbrake::Filters::DependencyFilter.new)
+  # Attaches loaded dependencies to the notice object
+  # (under context/versions/dependencies).
+  # Airbrake.add_filter(Airbrake::Filters::DependencyFilter.new)
 
-# If you want to convert your log messages to Airbrake errors, we offer an
-# integration with the Logger class from stdlib.
-# https://github.com/airbrake/airbrake#logger
-# Rails.logger = Airbrake::AirbrakeLogger.new(Rails.logger)
+  # If you want to convert your log messages to Airbrake errors, we offer an
+  # integration with the Logger class from stdlib.
+  # https://github.com/airbrake/airbrake#logger
+  # Rails.logger = Airbrake::AirbrakeLogger.new(Rails.logger)
+else
+  Rails.logger.warn(
+    "#{__FILE__}: Airbrake project id or project key is not set. " \
+    "Skipping Airbrake configuration"
+  )
+end