sentry-user_informer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fd2992ca3d29f4d3b22055eee55f8d5f56d9a0382d74c24f18705b87f90c3f43
+  data.tar.gz: 21e50f2a8e5a3616a97ced8c24fc4ef1d4898918bea5b26d516e2649807fa038
+SHA512:
+  metadata.gz: a92f5b740de1e0014b4072c2d879312b0cda05691dae65c8435dc960f103b711e7fb2c18d6d1628257ca815c7ea6ca7f1cebeaf978dad6ecc424a4bd0768186d
+  data.tar.gz: c9fcf001a81e34b1c143d7043c2fcbbd0de75b595412b14b412b8033d9a28f2d424ad9c2bbd9ecf79f337a4034058959637c0d9efdbd3fe8758d949323402fe1

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/sentry/user_informer/version.rb

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

data/lib/sentry/user_informer.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Sentry
+  module UserInformer
+    SENTRY_EVENT_ID = "sentry_event_id"
+    class << self
+      attr_accessor :placeholder, :template
+    end
+    self.placeholder = "<!-- SENTRY-USER-INFORMER -->"
+    self.template =
+      "<br/><br/>Error number: <a href='https://sentry.io/organizations/foo/issues/?query=%{event_id}'>%{event_id}</a>" # rubocop:disable Style/FormatStringToken
+
+    # render captured exception so users can click it
+    # testing: set `config.consider_all_requests_local = false` and add `raise 'testing'` to an action
+    class ExceptionRenderer
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        Thread.current[Sentry::UserInformer::SENTRY_EVENT_ID] = nil # reset to not keep old exception around
+        status, headers, body = @app.call(env)
+        if (event_id = Thread.current[Sentry::UserInformer::SENTRY_EVENT_ID])
+          replacement = format(Sentry::UserInformer.template, event_id: event_id)
+          body = body.map { |chunk| chunk.gsub(Sentry::UserInformer.placeholder, replacement) }
+          headers["Content-Length"] = body.sum(&:bytesize).to_s # not sure if this is needed, but it does not hurt
+        end
+        [status, headers, body]
+      end
+    end
+  end
+end
+
+if defined?(::Rails::Railtie)
+  raise "Load sentry-rails before sentry-user_informer" unless defined?(Sentry::Rails)
+  # override capture_exception to store the exception in globally since it does not have access to any other state
+  Sentry::Rails::CaptureExceptions.prepend(
+    Module.new do
+      def capture_exception(_exception)
+        event = super
+        Thread.current[Sentry::UserInformer::SENTRY_EVENT_ID] = event&.event_id
+        event
+      end
+    end
+  )
+
+  module Sentry
+    module UserInformer
+      class Railtie < ::Rails::Railtie
+        initializer("sentry.user_informer") do |app|
+          app.config.middleware.insert_before ActionDispatch::ShowExceptions, Sentry::UserInformer::ExceptionRenderer
+        end
+      end
+    end
+  end
+end

data/lib/sentry-user_informer.rb

@@ -0,0 +1,4 @@
+# rubocop:disable Naming/FileName
+# frozen_string_literal: true
+require "sentry/user_informer"
+# rubocop:enable Naming/FileName

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: sentry-user_informer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-07-13 00:00:00.000000000 Z
+dependencies:
+- !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: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+- !ruby/object:Gem::Dependency
+  name: sentry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+description: 
+email: michael@grosser.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- lib/sentry-user_informer.rb
+- lib/sentry/user_informer.rb
+- lib/sentry/user_informer/version.rb
+homepage: https://github.com/grosser/sentry-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.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: show link to errors on exception page
+test_files: []