active_job_exception_handler 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35ef233d0b45467e77ddedf1db4781f7afc49995
+  data.tar.gz: 0c1ebe0c56515afba4788383388b5875b4c9dfca
+SHA512:
+  metadata.gz: 8b69f694263edf50d59ed2549d45d835fdb73a5d6d88c87ed4973f306157d57f76717af04353d8e51afba97e312b4e5321a5f58a0f881cef31dae2495ea89ce6
+  data.tar.gz: 827d1b59aa93ffda14c7ae64a7ebbbbad186ae73ce8c94e5fce9b3333002cb870d8fe7f39becda6283d92b52c98307f2fb85596aa3ae31ad7b09951e71449b2f

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2017 []().
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,149 @@
+# ActiveJobExceptionHandler
+
+[![Gem Version](https://badge.fury.io/rb/active_job_exception_handler.svg)](http://badge.fury.io/rb/active_job_exception_handler)
+
+<!-- Tocer[start]: Auto-generated, don't remove. -->
+
+# Table of Contents
+
+- [Features](#features)
+- [Screencasts](#screencasts)
+- [Requirements](#requirements)
+- [Setup](#setup)
+- [Usage](#usage)
+- [Tests](#tests)
+- [Versioning](#versioning)
+- [Code of Conduct](#code-of-conduct)
+- [Contributions](#contributions)
+- [License](#license)
+- [History](#history)
+- [Credits](#credits)
+
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
+
+# Features
+
+# Screencasts
+
+# Requirements
+
+0. [Ruby 2.4.1](https://www.ruby-lang.org)
+
+# Setup
+
+For a secure install, type the following (recommended):
+
+    gem cert --add <(curl --location --silent /gem-public.pem)
+    gem install active_job_exception_handler --trust-policy MediumSecurity
+
+NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification
+while allowing the installation of unsigned dependencies since they are beyond the scope of this
+gem.
+
+For an insecure install, type the following (not recommended):
+
+    gem install active_job_exception_handler
+
+Add the following to your Gemfile:
+
+    gem "active_job_exception_handler"
+
+# Usage
+
+Initialize it like this:
+
+```ruby
+class ApplicationJob < ActiveJob::Base
+
+  before_perform :initialize_exception_handler
+
+  def perform(normal:, credentials: {}, spawn_job_id:, exception_handler: default_exception_handler)
+    @exception_handler = exception_handler
+    initialize_exception_handling
+
+    exception_handler.process! do
+      return if skip?
+      collector.run run_options
+      emitter.flush!
+      kapost_client.update_credentials(adapter.updated_tokens) if adapter.refreshed_tokens?
+      perform_successful
+    end
+  end
+
+  protected
+
+  def exception_handler
+    @exception_handler ||= ExceptionHandler.new(exception_context: exception_context)
+  end
+
+  def exception_context
+    ExceptionContext.new(
+      source: self.class.name,
+      queue: queue_name,
+      args: arguments
+    )
+  end
+
+  def initialize_exception_handling
+    # implement this method to define how errors are handled
+  end
+end
+```
+
+And then use it in jobs like this:
+
+```ruby
+class MyJob < ApplicationJob
+
+  def perform(...)
+    # ...
+  end
+
+  protected
+
+  def initialize_exception_handling
+    exception_handler.add HTTPServerError, :retryables # Transient HTTP error
+    exception_handler.add HTTPAuthenticationError, :unretryables # User credentials are wrong, don't retry
+    exception_handler.add HTTPNotFoundError, :ignorables # Page is gone, we don't care anymore
+  end
+
+end
+```
+
+# Tests
+
+To test, run:
+
+    bundle exec rake
+
+# Versioning
+
+Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
+
+- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
+- Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
+
+# Code of Conduct
+
+Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By
+participating in this project you agree to abide by its terms.
+
+# Contributions
+
+Read [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+# License
+
+Copyright (c) 2017 []().
+Read [LICENSE](LICENSE.md) for details.
+
+# History
+
+Read [CHANGES](CHANGES.md) for details.
+Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).
+
+# Credits
+
+Developed by [Paul Sadauskas]() and [Brooke Kuhlmann]() at
+[Kapost](www.kapost.com).

data/lib/active_job_exception_handler.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+class ExceptionHandler
+  RetryableError = Class.new(StandardError)
+
+  TYPES = %i[ignorables retryables unretryables].freeze
+
+  attr_reader(*TYPES)
+  attr_reader :error
+
+  def initialize(exception_context:,
+                 rescue_retryable_errors:,
+                 exception_processors: [ExceptionHandlerStatsdProcessor.new,
+                                        ExceptionHandlerActionableFaultProcessor.new],
+                 logger: ActiveSupport::TaggedLogging.new(Logger.new(STDOUT)))
+    @exception_context = exception_context
+    @exception_processors = exception_processors
+    @rescue_retryable_errors = rescue_retryable_errors
+    @logger = logger
+    @error = nil
+    @ignorables = []
+    @retryables = [Timeout::Error, Net::HTTPError, Errno::ECONNREFUSED]
+    @unretryables = []
+  end
+
+  def add(error, type)
+    fail(StandardError, "Invalid error category: #{type}.") unless TYPES.include?(type)
+    public_send(type) << error
+  end
+
+  def error?
+    error.present?
+  end
+
+  def process!
+    yield if block_given?
+
+  rescue *ignorables => error
+    handle_ignorable(error)
+
+  rescue *retryables => error
+    handle_retryable(error)
+
+  rescue *unretryables => error
+    handle_unretryable(error)
+
+  rescue StandardError => error
+    handle_unknown(error)
+  end
+
+  private
+
+  attr_reader :exception_context, :logger, :rescue_retryable_errors, :exception_processors
+
+  # Common actions that we want to perform for any type of error
+  def common_actions(error, type)
+    @error = error
+
+    log error, type
+
+    exception_processors.each do |processor|
+      processor.process(error, type, exception_context)
+    end
+  end
+
+  # Exceptions that we can't do anything about
+  def handle_ignorable(error)
+    common_actions(error, :ignorables)
+  end
+
+  # Transient exceptions that might go away upon a retry.
+  # Raise `ExceptionHandler::RetryableError` so shoryuken will pick up the
+  # job according to the retry intervals.
+  # Configure honeybadger to ignore this exception in the initializer.
+  #
+  # NOTE: Retries only apply to ApplicationJobs and
+  # don't have meaning for other objects like Collectors.
+  def handle_retryable(error)
+    common_actions(error, :retryables)
+
+    fail RetryableError unless rescue_retryable_errors
+  end
+
+  # Exceptions that we can't do anything about, but want to be notified on.  This
+  # category should include errors where we might want to notify the customer, so
+  # they can take some action
+  def handle_unretryable(error)
+    common_actions(error, :unretryables)
+  end
+
+  # Unknown errors
+  # - Instrument and bubble out
+  def handle_unknown(error)
+    common_actions(error, :unknown)
+
+    fail error
+  end
+
+  def log(error, type)
+    return unless ENV["DUMP_EXCEPTIONS"]
+
+    logger.tagged self.class do |tagged_logger|
+      tagged_logger.info "Caught #{type} error: #{error.message}"
+      tagged_logger.info error.backtrace.join("\n")
+    end
+  end
+
+  class ExceptionContext
+    include Virtus.model
+    include ActiveModel::Validations
+
+    attribute :source, String
+    attribute :queue, String
+    attribute :args, Array
+
+    validates :source, :queue, :args, presence: true
+  end
+end

data/lib/active_job_exception_handler/exception_context.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ActiveJobExceptionHandler
+end

data/lib/active_job_exception_handler/identity.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ActiveJobExceptionHandler
+  # Gem identity information.
+  module Identity
+    def self.name
+      "active_job_exception_handler"
+    end
+
+    def self.label
+      "ActiveJobExceptionHandler"
+    end
+
+    def self.version
+      "0.0.1"
+    end
+
+    def self.version_label
+      "#{label} #{version}"
+    end
+  end
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: active_job_exception_handler
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Paul Sadauskas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: gemsmith
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry-state
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+description: 
+email:
+- psadauskas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.md
+files:
+- LICENSE.md
+- README.md
+- lib/active_job_exception_handler.rb
+- lib/active_job_exception_handler/exception_context.rb
+- lib/active_job_exception_handler/identity.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []