bugsnag 6.26.4 → 6.27.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f5f206e7ff8559ae2b853a2600004877d41d36414ea82b1cce49c41940e34dc
-  data.tar.gz: '08e3054a24b2c3928cd8e130a995525223989d09fdf1d0a5fdaefc71d460bbc0'
+  metadata.gz: 7f8eb06e59bf516cfc5ca7f5539ae3b0fdbd9c4ea86a82252d6c2ea787a7c255
+  data.tar.gz: 01be8584412260118dfb14548808e1c4c4444aadd040bbbd6c6ad5dee3da1dbc
 SHA512:
-  metadata.gz: 785d927eeaf5c3c2d2af5c04b33295dee3ce172354da1434b245e0d706b29d04aa6261c9a55764d9b726e0d6e9f0cf1e4523925925bb5f7118b86954e391b1d9
-  data.tar.gz: f11f3d9508cee3b65a4da040d681aa703710cc2e3718b40292daa5534d4ffdcb929334ef9640bca4901754379848d2bd42e8f63b9211b7eb5d2f758499b9d950
+  metadata.gz: bebc3030e22bbc50423792c701185d061b0d7834c6a741c805cafa6223753e941cd893a73c65792b8726fc6adf9f9c47ea30715c14381f5a2ac87c52d345ba98
+  data.tar.gz: 1923948f57cc1f032eaf249912d6f5e65423c853bc2cffe89b1b198aead96bc34303aa3aec95f9699911176579cbee14797e805986f24aff2834458413dc5066

data/CHANGELOG.md

@@ -1,6 +1,25 @@
 Changelog
 =========
 
+## v6.27.1 (18 June 2024)
+
+### Fixes
+
+* Only read Rack request body if it's rewindable
+  | [#829](https://github.com/bugsnag/bugsnag-ruby/pull/829)
+* Fix circular require warning
+  | [#828](https://github.com/bugsnag/bugsnag-ruby/pull/828)
+
+## v6.27.0 (23 May 2024)
+
+### Enhancements
+
+* Include the Warden scope in user metadata
+  | [#821](https://github.com/bugsnag/bugsnag-ruby/pull/821)
+  | [javierjulio](https://github.com/javierjulio)
+* Add a block variant of `add_on_error`
+  | [#824](https://github.com/bugsnag/bugsnag-ruby/pull/824)
+
 ## v6.26.4 (25 March 2024)
 
 ### Fixes

data/README.md

@@ -1,5 +1,5 @@
 # Bugsnag error monitoring & exception reporter for Ruby
-[![build status](https://travis-ci.com/bugsnag/bugsnag-ruby.svg?branch=master)](https://travis-ci.com/bugsnag/bugsnag-ruby)
+[![build status](https://github.com/bugsnag/bugsnag-ruby/actions/workflows/test-package.yml/badge.svg)](https://github.com/bugsnag/bugsnag-ruby/actions/workflows/test-package.yml?query=branch%3Amaster)
 
 
 The Bugsnag exception reporter for Ruby gives you instant notification of exceptions thrown from your **[Rails](https://www.bugsnag.com/platforms/rails)**, **Sinatra**, **Rack** or **plain Ruby** app. Any uncaught exceptions will trigger a notification to be sent to your Bugsnag project.
@@ -22,7 +22,6 @@ The Bugsnag exception reporter for Ruby gives you instant notification of except
     * [Rake](https://docs.bugsnag.com/platforms/ruby/rake)
     * [Sidekiq](https://docs.bugsnag.com/platforms/ruby/sidekiq)
     * [Other Ruby apps](https://docs.bugsnag.com/platforms/ruby/other)
-    * For [EventMachine](https://rubyeventmachine.com) integration, see [`bugsnag-em`](https://github.com/bugsnag/bugsnag-em)
 3. Relax!
 
 ## Support

data/VERSION

@@ -1 +1 @@
-6.26.4
+6.27.1

data/lib/bugsnag/breadcrumbs/on_breadcrumb_callback_list.rb

@@ -1,5 +1,3 @@
-require "set"
-
 module Bugsnag::Breadcrumbs
   class OnBreadcrumbCallbackList
     def initialize(configuration)

data/lib/bugsnag/breadcrumbs/validator.rb

@@ -1,5 +1,3 @@
-require 'bugsnag/breadcrumbs/breadcrumbs'
-
 module Bugsnag::Breadcrumbs
   ##
   # Validates a given breadcrumb before it is stored

data/lib/bugsnag/cleaner.rb

@@ -1,5 +1,3 @@
-require 'uri'
-
 module Bugsnag
   # @api private
   class Cleaner

data/lib/bugsnag/configuration.rb

@@ -1,20 +1,28 @@
-require "set"
-require "socket"
-require "logger"
-require "bugsnag/middleware_stack"
+require "bugsnag/breadcrumbs/on_breadcrumb_callback_list"
+
+require "bugsnag/endpoint_configuration"
+require "bugsnag/endpoint_validator"
+
+require "bugsnag/middleware/breadcrumbs"
 require "bugsnag/middleware/callbacks"
+require "bugsnag/middleware/classify_error"
+require "bugsnag/middleware/clearance_user"
+require "bugsnag/middleware/delayed_job"
 require "bugsnag/middleware/discard_error_class"
 require "bugsnag/middleware/exception_meta_data"
 require "bugsnag/middleware/ignore_error_class"
-require "bugsnag/middleware/suggestion_data"
-require "bugsnag/middleware/classify_error"
+require "bugsnag/middleware/mailman"
+require "bugsnag/middleware/rack_request"
+require "bugsnag/middleware/rails3_request"
+require "bugsnag/middleware/rake"
 require "bugsnag/middleware/session_data"
-require "bugsnag/middleware/breadcrumbs"
+require "bugsnag/middleware/sidekiq"
+require "bugsnag/middleware/suggestion_data"
+require "bugsnag/middleware/warden_user"
+
+require "bugsnag/middleware_stack"
+
 require "bugsnag/utility/circular_buffer"
-require "bugsnag/breadcrumbs/breadcrumbs"
-require "bugsnag/breadcrumbs/on_breadcrumb_callback_list"
-require "bugsnag/endpoint_configuration"
-require "bugsnag/endpoint_validator"
 
 module Bugsnag
   class Configuration
@@ -569,6 +577,20 @@ module Bugsnag
       @enable_sessions = false
     end
 
+    ##
+    # Add the given block to the list of on_error callbacks
+    #
+    # The on_error callbacks will be called when an error is captured or reported
+    # and are passed a {Bugsnag::Report} object
+    #
+    # Returning false from an on_error callback will cause the error to be ignored
+    # and will prevent any remaining callbacks from being called
+    #
+    # @return [void]
+    def on_error(&block)
+      middleware.use(block)
+    end
+
     ##
     # Add the given callback to the list of on_error callbacks
     #

data/lib/bugsnag/delivery/synchronous.rb

@@ -1,5 +1,4 @@
 require "net/https"
-require "uri"
 
 module Bugsnag
   module Delivery

data/lib/bugsnag/delivery/thread_queue.rb

@@ -1,5 +1,3 @@
-require "thread"
-
 module Bugsnag
   module Delivery
     class ThreadQueue < Synchronous

data/lib/bugsnag/event.rb

@@ -1,5 +1,3 @@
-require "bugsnag/report"
-
 module Bugsnag
   # For now Event is just an alias of Report. This points to the same object so
   # any changes to Report will also affect Event

data/lib/bugsnag/helpers.rb

@@ -1,8 +1,3 @@
-require 'uri'
-require 'set'
-require 'json'
-
-
 module Bugsnag
   module Helpers # rubocop:todo Metrics/ModuleLength
     MAX_STRING_LENGTH = 3072

data/lib/bugsnag/integrations/mongo.rb

@@ -1,5 +1,4 @@
 require 'mongo'
-require 'bugsnag/breadcrumbs/breadcrumbs'
 
 module Bugsnag
   ##

data/lib/bugsnag/integrations/rails/active_job.rb

@@ -1,5 +1,3 @@
-require 'set'
-
 module Bugsnag::Rails
   module ActiveJob
     SEVERITY = 'error'

data/lib/bugsnag/integrations/rails/rails_breadcrumbs.rb

@@ -1,5 +1,3 @@
-require "bugsnag/breadcrumbs/breadcrumbs"
-
 module Bugsnag::Rails
   DEFAULT_RAILS_BREADCRUMBS = [
     {

data/lib/bugsnag/integrations/railtie.rb

@@ -1,10 +1,6 @@
 # Rails 3.x hooks
 
-require "json"
 require "rails"
-require "bugsnag"
-require "bugsnag/middleware/rails3_request"
-require "bugsnag/middleware/rack_request"
 require "bugsnag/integrations/rails/rails_breadcrumbs"
 
 module Bugsnag

data/lib/bugsnag/integrations/rake.rb

@@ -1,4 +1,7 @@
-require 'bugsnag'
+# this file can either be required manually by a user, in which case 'bugsnag'
+# needs to be required, or it can be required automatically in the railtie,
+# in which case 'bugsnag' has already been required
+require 'bugsnag' unless defined?(Bugsnag)
 
 Rake::TaskManager.record_task_metadata = true
 

data/lib/bugsnag/middleware/rack_request.rb

@@ -1,5 +1,3 @@
-require "json"
-
 module Bugsnag::Middleware
   ##
   # Extracts and attaches rack data to an error report
@@ -17,7 +15,15 @@ module Bugsnag::Middleware
 
         request = ::Rack::Request.new(env)
 
-        params = request.params rescue {}
+        params =
+          # if the request body isn't rewindable then we can't read request.POST
+          # which is used internally by request.params
+          if request.body.respond_to?(:rewind)
+            request.params rescue {}
+          else
+            request.GET rescue {}
+          end
+
         client_ip = request.ip.to_s rescue SPOOF
         session = env["rack.session"]
 
@@ -106,7 +112,11 @@ module Bugsnag::Middleware
     end
 
     def add_request_body(report, request, env)
-      body = parsed_request_body(request, env)
+      begin
+        body = parsed_request_body(request, env)
+      rescue StandardError
+        return nil
+      end
 
       # this request may not have a body
       return unless body.is_a?(Hash) && !body.empty?
@@ -115,26 +125,34 @@ module Bugsnag::Middleware
     end
 
     def parsed_request_body(request, env)
-      return request.POST rescue nil if request.form_data?
+      # if the request is not rewindable then either:
+      # - it's been read already and so is impossible to read
+      # - it hasn't been read yet and us reading it will prevent the user from
+      #   reading it themselves
+      # in either case we should avoid attempting to
+      return nil unless request.body.respond_to?(:rewind)
+
+      if request.form_data?
+        begin
+          return request.POST
+        ensure
+          request.body.rewind
+        end
+      end
 
       content_type = env["CONTENT_TYPE"]
 
       return nil if content_type.nil?
+      return nil unless content_type.include?('/json') || content_type.include?('+json')
 
-      if content_type.include?('/json') || content_type.include?('+json')
-        begin
-          body = request.body
+      begin
+        body = request.body
 
-          return JSON.parse(body.read)
-        rescue StandardError
-          return nil
-        ensure
-          # the body must be rewound so other things can read it after we do
-          body.rewind
-        end
+        JSON.parse(body.read)
+      ensure
+        # the body must be rewound so other things can read it after we do
+        body.rewind
       end
-
-      nil
     end
 
     def add_cookies(report, request)

data/lib/bugsnag/middleware/warden_user.rb

@@ -23,7 +23,10 @@ module Bugsnag::Middleware
           # Extract useful user information
           user = {}
           user_object = env["warden"].user({:scope => best_scope, :run_callbacks => false}) rescue nil
+
           if user_object
+            user[:warden_scope] = best_scope
+
             # Build the user info for this scope
             COMMON_USER_FIELDS.each do |field|
               user[field] = user_object.send(field) if user_object.respond_to?(field)

data/lib/bugsnag/report.rb

@@ -1,4 +1,3 @@
-require "json"
 require "pathname"
 require "bugsnag/error"
 require "bugsnag/stacktrace"

data/lib/bugsnag.rb

@@ -1,5 +1,10 @@
 require "rubygems"
 require "thread"
+require "set"
+require "json"
+require "uri"
+require "socket"
+require "logger"
 
 require "bugsnag/version"
 require "bugsnag/utility/feature_data_store"
@@ -21,21 +26,9 @@ require "bugsnag/feature_flag"
 # as it doesn't auto-configure when loaded
 require "bugsnag/integrations/rack"
 
-require "bugsnag/middleware/rack_request"
-require "bugsnag/middleware/warden_user"
-require "bugsnag/middleware/clearance_user"
-require "bugsnag/middleware/callbacks"
-require "bugsnag/middleware/rails3_request"
-require "bugsnag/middleware/sidekiq"
-require "bugsnag/middleware/mailman"
-require "bugsnag/middleware/rake"
-require "bugsnag/middleware/classify_error"
-require "bugsnag/middleware/delayed_job"
-
 require "bugsnag/breadcrumb_type"
 require "bugsnag/breadcrumbs/validator"
 require "bugsnag/breadcrumbs/breadcrumb"
-require "bugsnag/breadcrumbs/breadcrumbs"
 
 require "bugsnag/utility/duplicator"
 require "bugsnag/utility/metadata_delegate"
@@ -309,6 +302,20 @@ module Bugsnag
       configuration.breadcrumbs << breadcrumb unless breadcrumb.ignore?
     end
 
+    ##
+    # Add the given block to the list of on_error callbacks
+    #
+    # The on_error callbacks will be called when an error is captured or reported
+    # and are passed a {Bugsnag::Report} object
+    #
+    # Returning false from an on_error callback will cause the error to be ignored
+    # and will prevent any remaining callbacks from being called
+    #
+    # @return [void]
+    def on_error(&block)
+      configuration.on_error(&block)
+    end
+
     ##
     # Add the given callback to the list of on_error callbacks
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag
 version: !ruby/object:Gem::Version
-  version: 6.26.4
+  version: 6.27.1
 platform: ruby
 authors:
 - James Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-25 00:00:00.000000000 Z
+date: 2024-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -107,7 +107,7 @@ homepage: https://github.com/bugsnag/bugsnag-ruby
 licenses:
 - MIT
 metadata:
-  changelog_uri: https://github.com/bugsnag/bugsnag-ruby/blob/v6.26.4/CHANGELOG.md
+  changelog_uri: https://github.com/bugsnag/bugsnag-ruby/blob/v6.27.1/CHANGELOG.md
   documentation_uri: https://docs.bugsnag.com/platforms/ruby/
   source_code_uri: https://github.com/bugsnag/bugsnag-ruby/
   rubygems_mfa_required: 'true'