exception_handling 2.9.0 → 2.10.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98d4a360c553e3d8505ddf0d0de7d4028416f3e1bd62f513b9848dfa95de7cf3
-  data.tar.gz: 4e4ee581d5fb7f4490b1db162ba49113eee07b748a32f0854a53801633156a73
+  metadata.gz: c5c1447aa42d931a3c1536f82ca2f9ed8131736d993eb663cbb1b48b14450839
+  data.tar.gz: b62e05ededb07b0b0eb9cb40187c5fb98ae1bf57c6a94577174be6161c011199
 SHA512:
-  metadata.gz: f6b7f7e6d8ccd286e97aec2bc28833a041108a3b16043dfe437f688bbdf45a034c5b3f407ccffa06d26bfe949e7e1aa164747ea4e797fac4ace4f2dc7fce9c34
-  data.tar.gz: fea43abeaf0400f78a975037c5e881b9a41e07b20b934fda5ac7bf35b59ca652daee4ccaa1503abafe818ad3b741edc1ec1a3665ce32e7fdc15ee91f1bb1afb4
+  metadata.gz: 2bb9077980b89d4535e53447b18e0cdf7d188e497c48e1d51db30a22ad31474d6b006f64023e12003775d21633960a5a99420f48ffeea783a3c219976f3570c3
+  data.tar.gz: 4c0e1c5712b3250255808d49faf9c4af26e78cd218a45b720fae552edf104366d168deb4ce86732910e46082bf4539c3d42978a1fd07d49ab6bbb0045b1a1cc8

data/.github/workflows/pipeline.yml

@@ -0,0 +1,27 @@
+---
+name: Pipeline
+on: [push]
+jobs:
+  tests:
+    name: Unit Tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6]
+        gemfile:
+        - Gemfile
+        - gemfiles/rails_4.gemfile
+        - gemfiles/rails_5.gemfile
+        - gemfiles/rails_6.gemfile
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler: 1.17.3
+        bundler-cache: true
+    - name: Unit tests
+      run: bundle exec rspec

data/CHANGELOG.md

@@ -4,6 +4,14 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.10.0] - Unreleased
+### Removed
+- Remove custom object inspection
+  This removed Honeybadger-specific callbacks (`lib/exception_handling/honeybadger_callbacks.rb`)
+
+### Deprecated
+- Deprecated use of Honeybadger fork
+
 ## [2.9.0] - 2020-03-02
 ### Added
 - Automatically registers with the `escalate` gem's `on_escalate` callback.

data/Gemfile

@@ -2,12 +2,17 @@
 
 source 'https://rubygems.org'
 
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  "https://github.com/#{repo_name}.git"
+end
+
 gemspec
 
 gem 'actionmailer', '< 6.1'
 gem 'activesupport', '< 6.1'
 gem 'appraisal', '~> 2.2'
-gem 'honeybadger', '3.3.1-1', git: 'git@github.com:Invoca/honeybadger-ruby', ref: 'bb5f2b8a86e4147c38a6270d39ad610fab4dd5e6'
+gem 'honeybadger'
 gem 'pry'
 gem 'pry-byebug'
 gem 'rake'

data/Gemfile.lock

@@ -1,19 +1,12 @@
-GIT
-  remote: git@github.com:Invoca/honeybadger-ruby
-  revision: bb5f2b8a86e4147c38a6270d39ad610fab4dd5e6
-  ref: bb5f2b8a86e4147c38a6270d39ad610fab4dd5e6
-  specs:
-    honeybadger (3.3.1.pre.1)
-
 PATH
   remote: .
   specs:
-    exception_handling (2.9.0)
+    exception_handling (2.10.0.pre.1)
       actionmailer (>= 4.2, < 7.0)
       actionpack (>= 4.2, < 7.0)
       activesupport (>= 4.2, < 7.0)
       contextual_logger (~> 0.7)
-      escalate (~> 0.2)
+      escalate (~> 0.3)
       eventmachine (~> 1.0)
       invoca-utils (~> 0.3)
 
@@ -63,16 +56,16 @@ GEM
     crass (1.0.6)
     diff-lcs (1.4.4)
     erubi (1.10.0)
-    escalate (0.2.0)
-      activesupport
+    escalate (0.3.0)
     eventmachine (1.2.7)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
+    honeybadger (4.11.0)
     i18n (1.8.9)
       concurrent-ruby (~> 1.0)
     invoca-utils (0.4.1)
     jaro_winkler (1.5.3)
-    json (2.5.1)
+    json (2.6.1)
     loofah (2.9.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -146,7 +139,7 @@ DEPENDENCIES
   activesupport (< 6.1)
   appraisal (~> 2.2)
   exception_handling!
-  honeybadger (= 3.3.1.pre.1)!
+  honeybadger
   pry
   pry-byebug
   rake

data/exception_handling.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'actionpack',        '>= 4.2', '< 7.0'
   spec.add_dependency 'activesupport',     '>= 4.2', '< 7.0'
   spec.add_dependency 'contextual_logger', '~> 0.7'
-  spec.add_dependency 'escalate',          '~> 0.2'
+  spec.add_dependency 'escalate',          '~> 0.3'
   spec.add_dependency 'eventmachine',      '~> 1.0'
   spec.add_dependency 'invoca-utils',      '~> 0.3'
 end

data/gemfiles/rails_4.gemfile

@@ -5,8 +5,7 @@ source "https://rubygems.org"
 gem "actionmailer", "~> 4.2"
 gem "activesupport", "~> 4.2"
 gem "appraisal", "~> 2.2"
-gem "escalate", "0.2.0.pre.1"
-gem "honeybadger", "3.3.1-1", git: "git@github.com:Invoca/honeybadger-ruby", ref: "bb5f2b8a86e4147c38a6270d39ad610fab4dd5e6"
+gem "honeybadger"
 gem "pry"
 gem "pry-byebug"
 gem "rake"

data/gemfiles/rails_5.gemfile

@@ -5,8 +5,7 @@ source "https://rubygems.org"
 gem "actionmailer", "~> 5.2"
 gem "activesupport", "~> 5.2"
 gem "appraisal", "~> 2.2"
-gem "escalate", "0.2.0.pre.1"
-gem "honeybadger", "3.3.1-1", git: "git@github.com:Invoca/honeybadger-ruby", ref: "bb5f2b8a86e4147c38a6270d39ad610fab4dd5e6"
+gem "honeybadger"
 gem "pry"
 gem "pry-byebug"
 gem "rake"

data/gemfiles/rails_6.gemfile

@@ -5,8 +5,7 @@ source "https://rubygems.org"
 gem "actionmailer", "~> 6.0"
 gem "activesupport", "~> 6.0"
 gem "appraisal", "~> 2.2"
-gem "escalate", "0.2.0.pre.1"
-gem "honeybadger", "3.3.1-1", git: "git@github.com:Invoca/honeybadger-ruby", ref: "bb5f2b8a86e4147c38a6270d39ad610fab4dd5e6"
+gem "honeybadger"
 gem "pry"
 gem "pry-byebug"
 gem "rake"

data/lib/exception_handling/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ExceptionHandling
-  VERSION = '2.9.0'
+  VERSION = '2.10.0.pre.1'
 end

data/lib/exception_handling.rb

@@ -14,7 +14,6 @@ require 'exception_handling/log_stub_error'
 require 'exception_handling/exception_description'
 require 'exception_handling/exception_catalog'
 require 'exception_handling/exception_info'
-require 'exception_handling/honeybadger_callbacks'
 require 'exception_handling/escalate_callback'
 
 _ = ActiveSupport::HashWithIndifferentAccess

data/spec/unit/exception_handling/escalate_callback_spec.rb

@@ -47,7 +47,7 @@ module ExceptionHandling
           expect(logger).to_not receive(:fatal)
           expect(ExceptionHandling).to receive(:log_error).with(exception, location_message, context_hash)
 
-          TestGem.escalate(exception, location_message, context_hash)
+          TestGem.escalate(exception, location_message, context: context_hash)
         end
       end
 
@@ -73,7 +73,7 @@ module ExceptionHandling
           expect(logger).to_not receive(:fatal)
           expect(ExceptionHandling).to receive(:log_error).with(exception, location_message, context_hash)
 
-          TestGem.escalate(exception, location_message, context_hash)
+          TestGem.escalate(exception, location_message, context: context_hash)
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exception_handling
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 2.10.0.pre.1
 platform: ruby
 authors:
 - Invoca
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2022-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -90,14 +90,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
@@ -133,9 +133,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/pipeline.yml"
 - ".gitignore"
-- ".jenkins/Jenkinsfile"
-- ".jenkins/ruby_build_pod.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
@@ -148,7 +147,6 @@ files:
 - Rakefile
 - config/exception_filters.yml
 - exception_handling.gemspec
-- gemfiles/.bundle/config
 - gemfiles/rails_4.gemfile
 - gemfiles/rails_5.gemfile
 - gemfiles/rails_6.gemfile
@@ -157,7 +155,6 @@ files:
 - lib/exception_handling/exception_catalog.rb
 - lib/exception_handling/exception_description.rb
 - lib/exception_handling/exception_info.rb
-- lib/exception_handling/honeybadger_callbacks.rb
 - lib/exception_handling/log_stub_error.rb
 - lib/exception_handling/logging_methods.rb
 - lib/exception_handling/mailer.rb
@@ -173,7 +170,6 @@ files:
 - spec/unit/exception_handling/exception_catalog_spec.rb
 - spec/unit/exception_handling/exception_description_spec.rb
 - spec/unit/exception_handling/exception_info_spec.rb
-- spec/unit/exception_handling/honeybadger_callbacks_spec.rb
 - spec/unit/exception_handling/log_error_stub_spec.rb
 - spec/unit/exception_handling/logging_methods_spec.rb
 - spec/unit/exception_handling/mailer_spec.rb
@@ -188,7 +184,7 @@ licenses: []
 metadata:
   source_code_uri: https://github.com/Invoca/exception_handling
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -199,12 +195,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Invoca's exception handling logger/emailer layer, based on exception_notifier.
   Works with Rails or EventMachine or EventMachine+Synchrony.
@@ -217,7 +213,6 @@ test_files:
 - spec/unit/exception_handling/exception_catalog_spec.rb
 - spec/unit/exception_handling/exception_description_spec.rb
 - spec/unit/exception_handling/exception_info_spec.rb
-- spec/unit/exception_handling/honeybadger_callbacks_spec.rb
 - spec/unit/exception_handling/log_error_stub_spec.rb
 - spec/unit/exception_handling/logging_methods_spec.rb
 - spec/unit/exception_handling/mailer_spec.rb

data/.jenkins/Jenkinsfile

@@ -1,113 +0,0 @@
-#!/usr/bin/groovy
-@Library('jenkins-pipeline@v0.4.5')
-import com.invoca.docker.*;
-pipeline {
-  agent {
-    kubernetes {
-      defaultContainer "ruby"
-      yamlFile ".jenkins/ruby_build_pod.yml"
-    }
-  }
-
-  environment {
-    GITHUB_TOKEN = credentials('github_token')
-    GITHUB_KEY = credentials('github_key')
-    BUNDLE_GEM__FURY__IO = credentials('gemfury_deploy_token')
-  }
-
-  stages {
-    stage('Setup') {
-      steps {
-        script {
-          updateGitHubStatus('clean-build', 'pending', 'Unit tests.')
-          sh '''
-            # get SSH setup inside the container
-            eval `ssh-agent -s`
-            echo "$GITHUB_KEY" | ssh-add -
-            mkdir -p /root/.ssh
-            ssh-keyscan -t rsa github.com > /root/.ssh/known_hosts
-
-            bundle install
-            bundle exec appraisal install
-          '''
-        }
-      }
-    }
-    stage('Appraisals') {
-      parallel {
-        stage('Current') {
-          environment {
-            JUNIT_OUTPUT = 'spec/reports/current'
-          }
-
-          steps {
-            sh "bundle exec rspec --format RspecJunitFormatter --out ${JUNIT_OUTPUT}/rspec.xml"
-          }
-
-          post {
-            always { junit "${JUNIT_OUTPUT}/*.xml" }
-          }
-        }
-
-        stage('Rails 4') {
-          environment {
-            JUNIT_OUTPUT = 'spec/reports/rails-4'
-          }
-
-          steps {
-            sh "bundle exec appraisal rails-4 rspec --format RspecJunitFormatter --out ${JUNIT_OUTPUT}/rspec.xml"
-          }
-
-          post {
-            always { junit "${JUNIT_OUTPUT}/*.xml" }
-          }
-        }
-
-        stage('Rails 5') {
-          environment {
-            JUNIT_OUTPUT = 'spec/reports/rails-5'
-          }
-
-          steps {
-            sh "bundle exec appraisal rails-5 rspec --format RspecJunitFormatter --out ${JUNIT_OUTPUT}/rspec.xml"
-          }
-
-          post {
-            always { junit "${JUNIT_OUTPUT}/*.xml" }
-          }
-        }
-
-        stage('Rails 6') {
-          environment {
-            JUNIT_OUTPUT = 'spec/reports/rails-6'
-          }
-
-          steps {
-            sh "bundle exec appraisal rails-6 rspec --format RspecJunitFormatter --out ${JUNIT_OUTPUT}/rspec.xml"
-          }
-
-          post {
-            always { junit "${JUNIT_OUTPUT}/*.xml" }
-          }
-        }
-      }
-
-      post {
-        success { updateGitHubStatus('clean-build', 'success', 'Unit tests.') }
-        failure { updateGitHubStatus('clean-build', 'failure', 'Unit tests.') }
-      }
-    }
-  }
-}
-
-void updateGitHubStatus(String context, String status, String description) {
-  gitHubStatus([
-    repoSlug:    'Invoca/exception_handling',
-    sha:         env.GIT_COMMIT,
-    description: description,
-    context:     context,
-    targetURL:   env.RUN_DISPLAY_URL,
-    token:       env.GITHUB_TOKEN,
-    status:      status
-  ])
-}

data/.jenkins/ruby_build_pod.yml

@@ -1,18 +0,0 @@
----
-apiVersion: v1
-kind: Pod
-metadata:
-  labels:
-  jenkins/exception-handling: 'true'
-  namespace: jenkins
-  name: exception-handling
-spec:
-  containers:
-  - name: ruby
-    image: ruby:2.6.5
-    tty: true
-    resources:
-    requests:
-      memory: "100Mi"
-    command:
-      - cat

data/gemfiles/.bundle/config

@@ -1,2 +0,0 @@
----
-BUNDLE_RETRY: "1"

data/lib/exception_handling/honeybadger_callbacks.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-module ExceptionHandling
-  module HoneybadgerCallbacks
-    class << self
-      def register_callbacks
-        if ExceptionHandling.honeybadger_defined?
-          Honeybadger.local_variable_filter(&method(:local_variable_filter))
-        end
-      end
-
-      private
-
-      def inspect_object(object, filter_keys)
-        inspection_output = object.inspect
-
-        if contains_filter_key?(filter_keys, inspection_output)
-          filtered_object(object)
-        else
-          inspection_output
-        end
-      rescue => ex
-        details = if object.respond_to?(:to_pk)
-                    " @pk=#{object.to_pk}"
-                  elsif object.respond_to?(:id)
-                    " @id=#{object.id}"
-                  end
-
-        "#<#{object.class.name}#{details} [error '#{ex.class.name}: #{ex.message}' while calling #inspect]>"
-      end
-
-      def local_variable_filter(_symbol, object, filter_keys)
-        case object
-        # Honeybadger will filter these data types for us
-        when String, Hash, Array, Set, Numeric, TrueClass, FalseClass, NilClass
-          object
-        else # handle other Ruby objects, intended for POROs
-          inspect_object(object, filter_keys)
-        end
-      end
-
-      def contains_filter_key?(filter_keys, string)
-        filter_keys&.any? { |key| string.include?(key) }
-      end
-
-      def filtered_object(object)
-        # make the output look similar to inspect
-        # use [FILTERED], just like honeybadger does
-        if object.respond_to?(:to_pk)
-          "#<#{object.class.name} @pk=#{object.to_pk}, [FILTERED]>"
-        elsif object.respond_to?(:id)
-          "#<#{object.class.name} @id=#{object.id}, [FILTERED]>"
-        else
-          "#<#{object.class.name} [FILTERED]>"
-        end
-      end
-    end
-  end
-end

data/spec/unit/exception_handling/honeybadger_callbacks_spec.rb

@@ -1,122 +0,0 @@
-# frozen_string_literal: true
-
-require File.expand_path('../../spec_helper',  __dir__)
-
-module ExceptionHandling
-  describe HoneybadgerCallbacks do
-
-    class TestPoroWithAttribute
-      attr_reader :test_attribute
-
-      def initialize
-        @test_attribute = 'test'
-      end
-    end
-
-    class TestPoroWithFilteredAttribute
-      attr_reader :password
-
-      def initialize
-        @password = 'secret'
-      end
-    end
-
-    class TestPoroWithFilteredAttributeAndId < TestPoroWithFilteredAttribute
-      attr_reader :id
-
-      def initialize
-        super
-        @id = 1
-      end
-    end
-
-    class TestPoroWithFilteredAttributePkAndId < TestPoroWithFilteredAttributeAndId
-      def to_pk
-        'TestPoroWithFilteredAttributePkAndId_1'
-      end
-    end
-
-    class TestRaiseOnInspect < TestPoroWithAttribute
-      def inspect
-        raise "some error"
-      end
-    end
-
-    class TestRaiseOnInspectWithId < TestRaiseOnInspect
-      def id
-        123
-      end
-    end
-
-    class TestRaiseOnInspectWithToPk < TestRaiseOnInspect
-      def to_pk
-        "SomeRecord-123"
-      end
-    end
-
-    context "register_callbacks" do
-      it "store the callbacks in the honeybadger object" do
-        HoneybadgerCallbacks.register_callbacks
-        result = Honeybadger.config.local_variable_filter.call(:variable_name, 'test', [])
-        expect(result).to eq('test')
-      end
-    end
-
-    context "local_variable_filter" do
-      it "not inspect String, Hash, Array, Set, Numeric, TrueClass, FalseClass, NilClass" do
-        [
-          ['test', String],
-          [{ a: 1 }, Hash],
-          [[1, 2], Array],
-          [Set.new([1, 2]), Set],
-          [4.5, Numeric],
-          [true, TrueClass],
-          [false, FalseClass],
-          [nil, NilClass]
-        ].each do |object, expected_class|
-          result = HoneybadgerCallbacks.send(:local_variable_filter, :variable_name, object, [])
-          expect(result.is_a?(expected_class)).to be_truthy
-        end
-      end
-
-      it "inspect other classes" do
-        result = HoneybadgerCallbacks.send(:local_variable_filter, :variable_name, TestPoroWithAttribute.new, ['password'])
-        expect(result).to match(/#<ExceptionHandling::TestPoroWithAttribute:.* @test_attribute="test">/)
-      end
-
-      context "when inspect raises exceptions" do
-        it "handle exceptions for objects" do
-          result = HoneybadgerCallbacks.send(:local_variable_filter, :variable_name, TestRaiseOnInspect.new, ['password'])
-          expect(result).to eq("#<ExceptionHandling::TestRaiseOnInspect [error 'RuntimeError: some error' while calling #inspect]>")
-        end
-
-        it "handle exceptions for objects responding to id" do
-          result = HoneybadgerCallbacks.send(:local_variable_filter, :variable_name, TestRaiseOnInspectWithId.new, ['password'])
-          expect(result).to eq("#<ExceptionHandling::TestRaiseOnInspectWithId @id=123 [error 'RuntimeError: some error' while calling #inspect]>")
-        end
-
-        it "handle exceptions for objects responding to to_pk" do
-          result = HoneybadgerCallbacks.send(:local_variable_filter, :variable_name, TestRaiseOnInspectWithToPk.new, ['password'])
-          expect(result).to eq("#<ExceptionHandling::TestRaiseOnInspectWithToPk @pk=SomeRecord-123 [error 'RuntimeError: some error' while calling #inspect]>")
-        end
-      end
-
-      context "not inspect objects that contain filter keys" do
-        it "use to_pk if available, even if id is available" do
-          result = HoneybadgerCallbacks.send(:local_variable_filter, :variable_name, TestPoroWithFilteredAttributePkAndId.new, ['password'])
-          expect(result).to match(/#<ExceptionHandling::TestPoroWithFilteredAttributePkAndId @pk=TestPoroWithFilteredAttributePkAndId_1, \[FILTERED\]>/)
-        end
-
-        it "use id if to_pk is not available" do
-          result = HoneybadgerCallbacks.send(:local_variable_filter, :variable_name, TestPoroWithFilteredAttributeAndId.new, ['password'])
-          expect(result).to match(/#<ExceptionHandling::TestPoroWithFilteredAttributeAndId @id=1, \[FILTERED\]>/)
-        end
-
-        it "print the object name if no id or to_pk" do
-          result = HoneybadgerCallbacks.send(:local_variable_filter, :variable_name, TestPoroWithFilteredAttribute.new, ['password'])
-          expect(result).to match(/#<ExceptionHandling::TestPoroWithFilteredAttribute \[FILTERED\]>/)
-        end
-      end
-    end
-  end
-end