bugsnag-maze-runner 8.9.0 → 8.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03c53d6f8594ce559c2f2fb6296617d9b9f18227220b3a1148f297de154b8d60
-  data.tar.gz: 3ce0a4585f6caac3ed1291f8a9ca8921926dbe551dd298ea6d8c8299136a67c5
+  metadata.gz: f0ea35795ffa2a45ce5190bde9317c508e631958504e47da4c8eaac20a5244b6
+  data.tar.gz: 90220645b3c2bcc5cfbb9823792bc8aee868e8fd6054fc7f6384dde01d55c5ea
 SHA512:
-  metadata.gz: cf7ef0e05814ee96ddcc363de952c0f56cce6c98721ef3bf79ad7ade296d7390d5dc513efb1ac83645aba734a957c685fea9290d4980cf0de5986544340d34ae
-  data.tar.gz: 7a967300d0dfcba750dfbce12c31a70e3793d98c822d35de70ec9838658e8436bad3962668bd70a50ff087236c74b174332b899406e906f42cbdf2475b643aea
+  metadata.gz: da920e3f04b2ae46e0c6eaae5796569c267ca59f1e3f8371af49109488fe5cbda31b68f36e3bd7b44cd9fac182afdc0d0ccc818872c01cda8fcf1d4b7722a705
+  data.tar.gz: 2379fbc274fffdd37834b5041393403036ff4f995bcc20845e462d51fe20672e0b0abb53172bb5e5059ec2a013af4ba2e0f3ca941d7522125b293438b6ca40f3

data/lib/maze/client/appium/base_client.rb

@@ -9,6 +9,7 @@ module Maze
 
         def initialize
           @session_ids = []
+          @start_attempts = 0
         end
 
         def start_session
@@ -47,51 +48,38 @@ module Maze
           raise 'Method not implemented by this class'
         end
 
-        def start_driver(config)
-          retry_failure = retry_start_driver?
-          driver = nil
-          until Maze.driver
-            begin
-
-
-              # Proc to start the driver
-              start_driver_closure = Proc.new do
-                begin
-                  config.capabilities = device_capabilities
-                  driver = Maze::Driver::Appium.new config.appium_server_url,
-                                                    config.capabilities,
-                                                    config.locator
-
-                  result = driver.start_driver
-                  if result
-                    # Log details of this session
-                    $logger.info "Created Appium session: #{driver.session_id}"
-                    @session_ids << driver.session_id
-                    udid = driver.session_capabilities['udid']
-                    $logger.info "Running on device: #{udid}" unless udid.nil?
-                  end
-                  result
-                rescue => error
-                  Bugsnag.notify error
-                  $logger.error "Session creation failed: #{error}"
-                  false
-                end
-              end
+        def attempt_start_driver(config)
+          config.capabilities = device_capabilities
+          driver = Maze::Driver::Appium.new config.appium_server_url,
+                                            config.capabilities,
+                                            config.locator
+
+          result = driver.start_driver
+          if result
+            # Log details of this session
+            $logger.info "Created Appium session: #{driver.session_id}"
+            @session_ids << driver.session_id
+            udid = driver.session_capabilities['udid']
+            $logger.info "Running on device: #{udid}" unless udid.nil?
+          end
+          driver
+        end
 
+        def start_driver(config, max_attempts = 5)
 
-              # Invoke the proc, with or without retries
-              if retry_failure
-                wait = Maze::Wait.new(interval: 10, timeout: 60)
-                success = wait.until(&start_driver_closure)
-              else
-                success = start_driver_closure.call
-              end
+          attempts = 0
 
-              unless success
-                $logger.error 'Failed to create Appium driver, exiting'
-                exit(::Maze::Api::ExitCode::SESSION_CREATION_FAILURE)
-              end
+          while attempts < max_attempts && Maze.driver.nil?
+            attempts += 1
+            start_error = nil
+            begin
+              Maze.driver = attempt_start_driver(config)
+            rescue => error
+              $logger.error "Session creation failed: #{error}"
+              start_error = error
+            end
 
+            if Maze.driver
               # Infer OS version if necessary when running locally
               if Maze.config.farm == :local && Maze.config.os_version.nil?
                 version = case Maze.config.os
@@ -103,23 +91,23 @@ module Maze
                 $logger.info "Inferred OS version to be #{version}"
                 Maze.config.os_version = version
               end
-
-              Maze.driver = driver
-            rescue ::Selenium::WebDriver::Error::UnknownError => original_exception
-              $logger.warn "Attempt to acquire #{config.device} device from farm #{config.farm} failed"
-              $logger.warn "Exception: #{original_exception.message}"
-              if config.device_list.empty?
-                $logger.error 'No further devices to try - raising original exception'
-                raise original_exception
+            else
+              interval = handle_error(start_error)
+              if interval && attempts < max_attempts
+                $logger.warn "Failed to create Appium driver, retrying in #{interval} seconds"
+                Kernel::sleep interval
               else
-                config.device = config.device_list.first
-                config.device_list = config.device_list.drop(1)
-                $logger.warn "Retrying driver initialisation using next device: #{config.device}"
+                $logger.error 'Failed to create Appium driver, exiting'
+                Kernel::exit(::Maze::Api::ExitCode::SESSION_CREATION_FAILURE)
               end
             end
           end
         end
 
+        def handle_error(error)
+          raise 'Method not implemented by this class'
+        end
+
         def start_scenario
           # Launch the app on macOS
           Maze.driver.get(Maze.config.app) if Maze.config.os == 'macos'

data/lib/maze/client/appium/bb_client.rb

@@ -13,8 +13,29 @@ module Maze
           end
         end
 
-        def retry_start_driver?
-          false
+        def handle_error(error)
+          # Retry interval depends on the error message
+          return nil if error.nil?
+
+          interval = nil
+          notify = true
+
+          if error.message.include? 'no sessionId in returned payload'
+            # This will happen naturally due to a race condition in how we access devices
+            # Do not notify, but wait long enough for most ghost sessions on BitBar to terminate.
+            interval = 60
+            notify = false
+          elsif error.message.include? 'You reached the account concurrency limit'
+            # In theory this shouldn't happen, but back off if it does
+            interval = 300
+          elsif error.message.include? 'There are no devices available'
+            interval = 120
+          else
+            # Do not retry in any other case
+          end
+
+          Bugsnag.notify error if notify
+          interval
         end
 
         def start_scenario
@@ -29,12 +50,18 @@ module Maze
         end
 
         def device_capabilities
+          # Doubling up on capabilities in both the `appium:options` and `appium` sub dictionaries.
+          # See PLAT-11087
           config = Maze.config
           capabilities = {
             'appium:options' => {
               'noReset' => true,
               'newCommandTimeout' => 600
             },
+            'appium' => {
+              'noReset' => true,
+              'newCommandTimeout' => 600
+            },
             'bitbar:options' => {
               # Some capabilities probably belong in the top level
               # of the hash, but BitBar picks them up from here.

data/lib/maze/client/appium/bb_devices.rb

@@ -20,8 +20,7 @@ module Maze
               $logger.trace "Got group ids #{device_group_ids} for #{device_or_group_names}"
               group_count, device = api_client.find_device_in_groups(device_group_ids)
               if device.nil?
-                # TODO: Retry rather than fail, see PLAT-7377
-                Maze::Helper.error_exit 'There are no devices available'
+                raise 'There are no devices available'
               else
                 $logger.info "#{group_count} device(s) currently available in group(s) '#{device_or_group_names}'"
               end
@@ -92,6 +91,8 @@ module Maze
           end
 
           def make_android_hash(device)
+            # Doubling up on capabilities in both the `appium:options` and `appium` sub dictionaries.
+            # See PLAT-11087
             hash = {
               'platformName' => 'Android',
               'deviceName' => 'Android Phone',
@@ -100,6 +101,11 @@ module Maze
                 'autoGrantPermissions' => true,
                 'uiautomator2ServerInstallTimeout' => 60000
               },
+              'appium' => {
+                'automationName' => 'UiAutomator2',
+                'autoGrantPermissions' => true,
+                'uiautomator2ServerInstallTimeout' => 60000
+              },
               'bitbar:options' => {
                 'device' => device,
               }
@@ -108,6 +114,8 @@ module Maze
           end
 
           def make_ios_hash(device)
+            # Doubling up on capabilities in both the `appium:options` and `appium` sub dictionaries.
+            # See PLAT-11087
             {
               'platformName' => 'iOS',
               'deviceName' => 'iPhone device',
@@ -115,6 +123,10 @@ module Maze
                 'automationName' => 'XCUITest',
                 'shouldTerminateApp' => 'true'
               },
+              'appium' => {
+                'automationName' => 'XCUITest',
+                'shouldTerminateApp' => 'true'
+              },
               'bitbar:options' => {
                 'device' => device
               }

data/lib/maze/client/appium/bs_client.rb

@@ -15,8 +15,18 @@ module Maze
           end
         end
 
-        def retry_start_driver?
-          Maze.config.device_list.nil? || Maze.config.device_list.empty?
+        # On BrowserStack, wait 10 seconds before retrying if there is another device in the list
+        def handle_error(error)
+          Bugsnag.notify error unless error.nil?
+          if Maze.config.device_list.nil? || config.device_list.empty?
+            $logger.error 'No further devices to try'
+            nil
+          else
+            config.device = config.device_list.first
+            config.device_list = config.device_list.drop(1)
+            $logger.warn "Retrying driver initialisation using next device: #{config.device}"
+            10
+          end
         end
 
         def start_scenario

data/lib/maze/client/appium/local_client.rb

@@ -48,6 +48,10 @@ module Maze
           capabilities
         end
 
+        def retry_start_driver?
+          false
+        end
+
         def log_run_intro
           # Nothing to do
         end

data/lib/maze.rb

@@ -7,7 +7,7 @@ require_relative 'maze/timers'
 # Glues the various parts of MazeRunner together that need to be accessed globally,
 # providing an alternative to the proliferation of global variables or singletons.
 module Maze
-  VERSION = '8.9.0'
+  VERSION = '8.10.0'
 
   class << self
     attr_accessor :check, :driver, :internal_hooks, :mode, :start_time, :dynamic_retry, :public_address,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag-maze-runner
 version: !ruby/object:Gem::Version
-  version: 8.9.0
+  version: 8.10.0
 platform: ruby
 authors:
 - Steve Kirkland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-19 00:00:00.000000000 Z
+date: 2023-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber