bugsnag-maze-runner 9.30.1 → 9.30.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79a886a6f14b4552e547e542b2d6d35f42b6827e496e9602d4ca8b11cdf06186
-  data.tar.gz: ceaeda0123a4535b959cde022ef1826dc7a9669a8cb34a05acbf0cada5aac172
+  metadata.gz: c7b70886a65bf3d2dca12cbc185bf1acab92602ac09d9f6270545bdafd3e9a10
+  data.tar.gz: ecb634c131f56ba423a5e18ec7e0d7659a65093bf2de372cfe56c7fd1aa90618
 SHA512:
-  metadata.gz: fd60e47ec4afc4f829106babded3ce1a601ae903aec156751b5ed1e325d17e67c825b2d0fa3feb0a05bbbdf94478010db54cb7a73a3be5c8d061b3022e1177f0
-  data.tar.gz: 7bbd4f9c325f663a659a170d6cba9edcf80fd73aa490a630650d67118da49f9fe8a255a58109bdf2af32a698c85826cda884d219485f41d0e21296f87db460f5
+  metadata.gz: ebd58859f86f68ff7494579679a24e62b9355f148a1f4a1310c0da2592f61694a0c0502513e83f623e09b57b1606d2d8a2ac9f99b8cd0d3c292abb436478cae6
+  data.tar.gz: bff5329c5ef8dff56f098db97089ac55e2327352be1c8fe8dd9950b2e676f608a8343d7533be3d74ea215083a87de9adaa0c716a796d97fed2d287fe8f8c926a

data/bin/maze-runner

@@ -18,7 +18,9 @@ require_relative '../lib/maze/api/appium/file_manager'
 require_relative '../lib/maze/api/appium/ui_manager'
 require_relative '../lib/maze/api/cucumber/scenario'
 require_relative '../lib/maze/api/exit_code'
-require_relative '../lib/maze/bugsnag_config'
+require_relative '../lib/maze/error_monitor/selenium_error_middleware'
+require_relative '../lib/maze/error_monitor/assert_error_middleware'
+require_relative '../lib/maze/error_monitor/config'
 require_relative '../lib/maze/client/bb_api_client'
 require_relative '../lib/maze/client/bb_client_utils'
 require_relative '../lib/maze/client/bs_client_utils'

data/lib/features/support/internal_hooks.rb

@@ -80,7 +80,7 @@ end
 # @param config The Cucumber config
 InstallPlugin do |config|
   # Start Bugsnag
-  Maze::BugsnagConfig.start_bugsnag(config)
+  Maze::ErrorMonitor::Config.start_bugsnag(config)
 
   if config.fail_fast?
     # Register exit code handler
@@ -210,22 +210,35 @@ def output_received_requests(request_type)
     request_queue.all.each.with_index(1) do |request, number|
       $stdout.puts "--- #{request_type} #{number} of #{count}"
 
-      $logger.info 'Request body:'
+      $logger.info 'Request:'
       Maze::Loggers::LogUtil.log_hash(Logger::Severity::INFO, request[:body])
-
-      $logger.info 'Request headers:'
-      Maze::Loggers::LogUtil.log_hash(Logger::Severity::INFO, request[:request].header)
+      log_headers(request[:request])
 
       $logger.info 'Request digests:'
       Maze::Loggers::LogUtil.log_hash(Logger::Severity::INFO, request[:digests])
 
-      $logger.info "Response body: #{request[:response].body}"
-      $logger.info 'Response headers:'
-      Maze::Loggers::LogUtil.log_hash(Logger::Severity::INFO, request[:response].header)
+      unless request[:response].nil?
+        $logger.info "Response: #{request[:response].body}"
+        log_headers(request[:response])
+      end
     end
   end
 end
 
+def log_headers(container)
+  header = if container.respond_to?(:header)
+             container.header
+           elsif container.key?('header') || container.key?(:header)
+             container['header'] || container[:header]
+           else
+             nil
+           end
+  unless header.nil?
+    $logger.info 'Headers:'
+    Maze::Loggers::LogUtil.log_hash(Logger::Severity::INFO, header)
+  end
+end
+
 # Check for invalid requests after each scenario.  This is its own hook as failing a scenario (which
 # Maze.scenario.complete may invoke) raises an exception and we need the logic in the other After hook to be performed.
 #

data/lib/maze/error_monitor/assert_error_middleware.rb

@@ -0,0 +1,25 @@
+module Maze
+  module ErrorMonitor
+    class AssertErrorMiddleware
+      IGNORE_CLASS_NAME = 'Test::Unit::AssertionFailedError'
+
+      # @param middleware [#call] The next middleware to call
+      def initialize(middleware)
+        @middleware = middleware
+      end
+
+      def call(report)
+        # Only ignore automated notifies with assertion errors
+        automated = report.unhandled
+
+        class_match = report.raw_exceptions.any? do |ex|
+          ex.class.name.eql?(IGNORE_CLASS_NAME)
+        end
+
+        report.ignore! if automated && class_match
+
+        @middleware.call(report)
+      end
+    end
+  end
+end

data/lib/maze/error_monitor/config.rb

@@ -0,0 +1,59 @@
+require 'bugsnag'
+
+# Contains logic for running Bugsnag
+module Maze
+  module ErrorMonitor
+      # This class is responsible for configuring Bugsnag
+      # and setting up the middleware for error reporting.
+      #
+      # @api private
+      #
+      # @see https://docs.bugsnag.com/platforms/ruby/rails/
+      # @see https://docs.bugsnag.com/platforms/ruby/rails/middleware/
+    class Config
+      class << self
+        def start_bugsnag(cucumber_config)
+          # Use MAZE_BUGSNAG_API_KEY explicitly to avoid collisions with test env
+          return unless Maze.config.enable_bugsnag && ENV['MAZE_BUGSNAG_API_KEY']
+
+          Bugsnag.configure do |config|
+            config.api_key = ENV['MAZE_BUGSNAG_API_KEY']
+            config.app_version = Maze::VERSION
+            config.add_metadata(:'test driver', {
+              'driver type': Maze.driver.class,
+              'device farm': Maze.config.farm,
+              'capabilities': Maze.config.capabilities
+            }) if Maze.driver
+
+            if ENV['BUILDKITE']
+              metadata = {
+                'pipeline': ENV['BUILDKITE_PIPELINE_NAME'],
+                'repo': ENV['BUILDKITE_REPO'],
+                'build url': ENV['BUILDKITE_BUILD_URL'],
+                'branch': ENV['BUILDKITE_BRANCH'],
+                'builder': ENV['BUILDKITE_BUILD_CREATOR'],
+                'message': ENV['BUILDKITE_MESSAGE'],
+                'step': ENV['BUILDKITE_LABEL']
+              }
+              if ENV['BUILDKITE_JOB_ID']
+                metadata['job url'] = ENV['BUILDKITE_BUILD_URL'] + "#" + ENV['BUILDKITE_JOB_ID']
+              end
+            end
+            config.middleware.use(AssertErrorMiddleware)
+            config.middleware.use(SeleniumErrorMiddleware)
+            config.add_metadata(:'buildkite', metadata)
+            config.project_root = Dir.pwd
+          end
+
+          Bugsnag.start_session
+
+          at_exit do
+            if $!
+              Bugsnag.notify($!)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/maze/error_monitor/selenium_error_middleware.rb

@@ -0,0 +1,39 @@
+module Maze
+  module ErrorMonitor
+    class SeleniumErrorMiddleware
+
+      def initialize(middleware)
+        @middleware = middleware
+      end
+
+      def call(report)
+        first_ex = report.raw_exceptions.first
+        if first_ex.class.name.start_with?('Selenium::WebDriver')
+          report.grouping_hash = first_ex.class.name.to_s + sanitise(first_ex.message.to_s)
+        end
+
+        @middleware.call(report)
+      end
+
+      def sanitise(message)
+        regexes = [
+          {
+            pattern: /(An unknown server-side error occurred while processing the command. Original error: ')(.*)(' is still running after 500ms timeout)/,
+            replacement: '\1APP_NAME\3'
+          },
+          {
+            pattern: /(unexpected end of stream on )(http:\/\/[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}:[0-9]{1,5}\/\.\.\.)/,
+            replacement: '\1URL'
+          }
+        ]
+
+        regex = regexes.find{|r| message =~ r[:pattern]}
+        if regex
+          message.gsub(regex[:pattern], regex[:replacement])
+        else
+          message
+        end
+      end
+    end
+  end
+end

data/lib/maze.rb

@@ -8,7 +8,7 @@ require_relative 'maze/timers'
 # providing an alternative to the proliferation of global variables or singletons.
 module Maze
 
-  VERSION = '9.30.1'
+  VERSION = '9.30.2'
 
   class << self
     attr_accessor :check, :driver, :internal_hooks, :mode, :start_time, :dynamic_retry, :public_address,

data/lib/utils/selenium_money_patch.rb

@@ -6,8 +6,8 @@ module Selenium
         def initialize(response)
           if response.is_a? String
             super(response)
-          elsif response.is_a? Selenium::WebDriver::Remote::Response
-            super("Status code #{response.code}.  Payload: #{response.payload.inspect}")
+          elsif response.is_a?(Selenium::WebDriver::Remote::Response) && response.payload.key?('message')
+            super("Status code #{response.code}: #{response.payload['message']}")
           else
             super(response.inspect)
           end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag-maze-runner
 version: !ruby/object:Gem::Version
-  version: 9.30.1
+  version: 9.30.2
 platform: ruby
 authors:
 - Steve Kirkland
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-02 00:00:00.000000000 Z
+date: 2025-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -451,7 +451,6 @@ files:
 - lib/maze/assertions/request_set_assertions.rb
 - lib/maze/aws/sam.rb
 - lib/maze/aws_public_ip.rb
-- lib/maze/bugsnag_config.rb
 - lib/maze/checks/assert_check.rb
 - lib/maze/checks/noop_check.rb
 - lib/maze/client/appium.rb
@@ -479,6 +478,9 @@ files:
 - lib/maze/document_server.rb
 - lib/maze/driver/appium.rb
 - lib/maze/driver/browser.rb
+- lib/maze/error_monitor/assert_error_middleware.rb
+- lib/maze/error_monitor/config.rb
+- lib/maze/error_monitor/selenium_error_middleware.rb
 - lib/maze/errors.rb
 - lib/maze/generator.rb
 - lib/maze/helper.rb

data/lib/maze/bugsnag_config.rb

@@ -1,89 +0,0 @@
-require 'bugsnag'
-
-# Contains logic for running Bugsnag
-module Maze
-  class BugsnagConfig
-    class << self
-      def start_bugsnag(cucumber_config)
-        # Use MAZE_BUGSNAG_API_KEY explicitly to avoid collisions with test env
-        return unless Maze.config.enable_bugsnag && ENV['MAZE_BUGSNAG_API_KEY']
-
-        Bugsnag.configure do |config|
-          config.api_key = ENV['MAZE_BUGSNAG_API_KEY']
-          config.app_version = Maze::VERSION
-          config.add_metadata(:'test driver', {
-            'driver type': Maze.driver.class,
-            'device farm': Maze.config.farm,
-            'capabilities': Maze.config.capabilities
-          }) if Maze.driver
-
-          if ENV['BUILDKITE']
-            metadata = {
-              'pipeline': ENV['BUILDKITE_PIPELINE_NAME'],
-              'repo': ENV['BUILDKITE_REPO'],
-              'build url': ENV['BUILDKITE_BUILD_URL'],
-              'branch': ENV['BUILDKITE_BRANCH'],
-              'builder': ENV['BUILDKITE_BUILD_CREATOR'],
-              'message': ENV['BUILDKITE_MESSAGE'],
-              'step': ENV['BUILDKITE_LABEL']
-            }
-            if ENV['BUILDKITE_JOB_ID']
-              metadata['job url'] = ENV['BUILDKITE_BUILD_URL'] + "#" + ENV['BUILDKITE_JOB_ID']
-            end
-          end
-          config.middleware.use(AssertErrorMiddleware)
-          config.middleware.use(AmbiguousErrorMiddleware)
-          config.add_metadata(:'buildkite', metadata)
-          config.project_root = Dir.pwd
-        end
-
-        Bugsnag.start_session
-
-        at_exit do
-          if $!
-            Bugsnag.notify($!)
-          end
-        end
-      end
-    end
-
-    class AssertErrorMiddleware
-      IGNORE_CLASS_NAME = 'Test::Unit::AssertionFailedError'
-
-      # @param middleware [#call] The next middleware to call
-      def initialize(middleware)
-        @middleware = middleware
-      end
-
-      def call(report)
-        # Only ignore automated notifies with assertion errors
-        automated = report.unhandled
-
-        class_match = report.raw_exceptions.any? do |ex|
-          ex.class.name.eql?(IGNORE_CLASS_NAME)
-        end
-
-        report.ignore! if automated && class_match
-
-        @middleware.call(report)
-      end
-    end
-
-    class AmbiguousErrorMiddleware
-      AMBIGUOUS_ERROR_CLASSES = %w[Selenium::WebDriver::Error::ServerError Selenium::WebDriver::Error::UnknownError]
-
-      def initialize(middleware)
-        @middleware = middleware
-      end
-
-      def call(report)
-        first_ex = report.raw_exceptions.first
-        if AMBIGUOUS_ERROR_CLASSES.include?(first_ex.class.name)
-          report.grouping_hash = first_ex.class.name.to_s + first_ex.message.to_s
-        end
-
-        @middleware.call(report)
-      end
-    end
-  end
-end