Add queue exit on timeout subroutine to the queue loop. (#90)

* Add queue exit on timeout subroutine to the queue loop. Timeout is configurable through the YAML. 150 secs seems a good base value.

* Implement code review changes

* Refactor queue timeout documentation and update function argument description

* fix wording from game to queue

* fix whitespace

---------

Co-authored-by: Deko <[email protected]>

alune/config.py

@@ -203,3 +203,12 @@ def get_chance_to_buy_xp(self) -> int:
             The chance in percent from 0 to 100.
         """
         return self._config["chances"]["buy_xp"]
+
+    def get_queue_timeout(self) -> int:
+        """
+        Get the queue timeout in seconds.
+
+        Returns:
+            The queue timeout in seconds.
+        """
+        return self._config["queue_timeout"]

alune/images.py

@@ -284,6 +284,7 @@ class Button:
     # Buttons with an image, the variable name must be the same as the image name.
     play = ImageButton(BoundingBox(950, 600, 1200, 650))
     accept = ImageButton(BoundingBox(525, 520, 755, 545))
+    exit_lobby = ImageButton(BoundingBox(50, 600, 130, 680))
     exit_now = ImageButton(
         click_box=BoundingBox(550, 425, 740, 440),
         capture_area=BoundingBox(520, 400, 775, 425),

alune/resources/config.yaml

@@ -8,6 +8,10 @@ log_level: "INFO"
 # Please note that changing this may require changing traits as well.
 game_mode: "normal"
 
+# Timeout for the bot to stay in the queue. 
+# This is the maximum time the bot will wait in the queue before it will exit the queue, in seconds.
+queue_timeout: 150
+
 # The traits you want the bot to roll for.
 # The trait names are almost as written in-game, with spaces replaced by _ and . and : being ignored.
 # For example: admin, star_guardian, mecha_prime, lasercorps

main.py

@@ -77,17 +77,19 @@ async def wait_for_accept_button(adb_instance: ADB):
         search_result = screen.get_button_on_screen(screenshot, Button.accept)
 
 
-async def queue(adb_instance: ADB):
+async def queue(adb_instance: ADB, config: AluneConfig):
     """
     Utility method to queue a match.
 
     Args:
         adb_instance: An instance of the ADB connection to click in.
+        config: An instance of the alune config to use.
     """
     try:
-        await asyncio.wait_for(wait_for_accept_button(adb_instance), timeout=120)
+        await asyncio.wait_for(wait_for_accept_button(adb_instance), timeout=config.get_queue_timeout())
     except asyncio.TimeoutError:
-        logger.warning("Waiting for accept button timed out, re-checking app state")
+        await adb_instance.click_button(Button.exit_lobby)
+        logger.info("Queue exited due to timeout.")
         return
     await adb_instance.click_button(Button.accept)
     await asyncio.sleep(2)
@@ -103,7 +105,7 @@ async def queue(adb_instance: ADB):
     screenshot = await adb_instance.get_screen()
     if screen.get_button_on_screen(screenshot, Button.accept) or screen.get_button_on_screen(screenshot, Button.play):
         logger.debug("Queue was declined by someone else, staying in queue lock state")
-        await queue(adb_instance)
+        await queue(adb_instance, config)
 
 
 _random = Random()
@@ -325,7 +327,7 @@ async def take_app_decision(game_state_image_result: GameStateImageResult, adb_i
         case GameState.LOBBY:
             logger.info("App state is in lobby, locking bot into queue logic.")
             await adb_instance.click_button(Button.play)
-            await queue(adb_instance)
+            await queue(adb_instance, config)
             logger.info("Queue lock released, likely loading into game now.")
         case GameState.IN_GAME:
             logger.info("App state is in game, looping decision making and waiting for the exit button.")