airbrake-user_informer 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 880658bfa2c986774561bdcd7d851404950f20ff
+  data.tar.gz: ed26530caf93e86083f04289ecf0317364055eba
+SHA512:
+  metadata.gz: afe2a504ef6933b4aeed35dba74aa94716f4b5d88f9858d46c81e07817d97129235733892584bc258d4685424eb6b10cb39726435a7272c229b72c2eebfa89ce
+  data.tar.gz: f7b5db144470a7a2811024621794bd6a03d40d20cbbde3a7deab72b3687ee07c8caa14bd073e30c2bbb2c0904814891516f210420acd74bc2c296c571b686bd8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (C) 2013 Michael Grosser <michael@grosser.it>
+
+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/lib/airbrake/user_informer/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Airbrake
+  module UserInformer
+    VERSION = "0.1.3"
+  end
+end

data/lib/airbrake/user_informer.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+module Airbrake
+  module UserInformer
+    module MiddlewareExtension
+      def notify_airbrake(_, env)
+        if Airbrake.user_information
+          env[Middleware::ENV_KEY] = super
+        else
+          super
+        end
+      end
+    end
+
+    # stolen from https://github.com/airbrake/airbrake/blob/v4.3.8/lib/airbrake/user_informer.rb
+    class Middleware
+      ENV_KEY = "airbrake.promise"
+      PLACEHOLDER = "<!-- AIRBRAKE ERROR -->"
+      TIMEOUT = 1.0 # seconds
+      STEPS = 100
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        status, headers, body = @app.call(env)
+
+        if (replacement = Airbrake.user_information) && error_id = wait_for_error(env[ENV_KEY])
+          replacement = replacement.gsub(/\{\{\s*error_id\s*\}\}/, error_id.to_s)
+          body = replace_placeholder(replacement, body, headers)
+        end
+        [status, headers, body]
+      end
+
+      private
+
+      # wait till airbrake is done reporting ... stop when it fails to report
+      # TODO: use something nicer than sleep
+      def wait_for_error(promise)
+        return unless promise
+        done = false
+        error_id = nil
+        promise.then { |notice| error_id = done = notice["id"] }
+        promise.rescue { |_notice| done = true }
+        STEPS.times do
+          break if done
+          sleep TIMEOUT / STEPS
+        end
+        error_id
+      end
+
+      # - body interface is .each so we cannot use anything else
+      # - always call .close on the old body so it can get garbage collected if it is a File
+      def replace_placeholder(replacement, body, headers)
+        new_body = []
+        body.each { |chunk| new_body << chunk.gsub(PLACEHOLDER, replacement) }
+        headers["Content-Length"] = new_body.inject(0) { |sum, x| sum + x.bytesize }.to_s
+        new_body
+      ensure
+        body.close if body && body.respond_to?(:close)
+      end
+    end
+  end
+end
+
+class << Airbrake
+  attr_accessor :user_information
+end
+
+if defined?(::Rails::Railtie)
+  raise "Load airbrake before airbrake-user_informer" unless defined?(Airbrake::Rack)
+  Airbrake::Rack::Middleware.prepend(Airbrake::UserInformer::MiddlewareExtension)
+
+  module Airbrake
+    module UserInformer
+      class Railtie < ::Rails::Railtie
+        initializer("airbrake.user_informer") do |app|
+          insertion_point = (::Rails::VERSION::MAJOR >= 5 ? ::Rack::Runtime : "Rack::Runtime")
+          app.config.middleware.insert_before(insertion_point, Airbrake::UserInformer::Middleware)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: airbrake-user_informer
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: airbrake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+- !ruby/object:Gem::Dependency
+  name: airbrake-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: 
+email: michael@grosser.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- lib/airbrake/user_informer.rb
+- lib/airbrake/user_informer/version.rb
+homepage: https://github.com/grosser/airbrake-user_informer
+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.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Show exception ids on error pages so users or support can track them down
+  faster
+test_files: []