From c8253b1b45085363629824e265bb072c38b99fcd Mon Sep 17 00:00:00 2001
From: Jeroen Gunneweg <info@gunnie.nl>
Date: Fri, 6 Jun 2025 17:10:03 +0200
Subject: [PATCH] Add configurable timeout for brancher creation

Introduced a new option, `hn_brancher_timeout`, to configure the timeout for brancher Hypernode creation. Updated the DeployRunner to utilize this option and added relevant documentation to the README for its usage. The default timeout remains 1500 seconds if not explicitly set.
---
 README.md            | 24 ++++++++++++++++++------
 src/DeployRunner.php |  7 +++++--
 2 files changed, 23 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index e942dcd..7ca193b 100644
--- a/README.md
+++ b/README.md
@@ -40,17 +40,20 @@ docker build -t "$DOCKER_TAG" -f "./ci/build/Dockerfile" \
 ```
 
 This will give you a locally built image:
-```console
-$ docker images | grep hypernode_deploy_dev
+```bash
+docker images | grep hypernode_deploy_dev
 localhost/hypernode_deploy_dev  latest      5280aaef3a82  52 seconds ago  842 MB
 ```
 
+For a Magento application, make sure you git clone a fresh version or remove <code>app/etc/env.php</code> first.
+
 That you could then use like:
-```console
-$ rm -Rf vendor
-$ docker run --rm -it --env SSH_PRIVATE_KEY="$(cat ~/.ssh/yourdeploykey | base64)" -v ${PWD}:/build hypernode_deploy_dev:latest hypernode-deploy build -vvv
-$ docker run --rm -it --env SSH_PRIVATE_KEY="$(cat ~/.ssh/yourdeploykey | base64)" -v ${PWD}:/build hypernode_deploy_dev:latest hypernode-deploy deploy staging -vvv
+```bash
+rm -Rf vendor
+docker run --rm -it --env SSH_PRIVATE_KEY="$(cat ~/.ssh/yourdeploykey | base64)" -v ${PWD}:/build hypernode_deploy_dev:latest hypernode-deploy build -vvv
+docker run --rm -it --env SSH_PRIVATE_KEY="$(cat ~/.ssh/yourdeploykey | base64)" -v ${PWD}:/build hypernode_deploy_dev:latest hypernode-deploy deploy staging -vvv
 ```
+FYI: If you deploy to a brancher node you probably need the HYPERNODE_API_TOKEN environment variable. Get it from the parent server, located at <code>/etc/hypernode/hypernode_api_token</code>.
 
 ## Tests
 
@@ -61,3 +64,12 @@ To run the static tests, please run the following commands:
 composer --working-dir tools install
 tools/vendor/bin/grumphp run --config tools/grumphp.yml
 ```
+
+## Configurable Brancher options
+
+### Brancher timeout
+The default timeout for Brancher creation is 1500 seconds. To change this, add the following in your <code>deploy.php</code>:
+```php
+$brancherStage = $configuration->addStage('stage_name', 'host');
+$brancherStage->addBrancherServer('parent_to_base_brancher_on', [], ['hn_brancher_timeout' => 2700])
+```
diff --git a/src/DeployRunner.php b/src/DeployRunner.php
index e9c7692..185c97f 100644
--- a/src/DeployRunner.php
+++ b/src/DeployRunner.php
@@ -34,6 +34,7 @@ class DeployRunner
 {
     public const TASK_BUILD = 'build';
     public const TASK_DEPLOY = 'deploy';
+    public const OPTION_HN_BRANCHER_TIMEOUT = 'hn_brancher_timeout';
 
     private TaskFactory $taskFactory;
     private InputInterface $input;
@@ -275,7 +276,7 @@ private function maybeConfigureBrancherServer(Server $server, bool $reuseBranche
             $settings = $serverOptions[Server::OPTION_HN_BRANCHER_SETTINGS] ?? [];
             $labels = $serverOptions[Server::OPTION_HN_BRANCHER_LABELS] ?? [];
 
-            $this->log->info(sprintf('Creating an brancher Hypernode based on %s.', $parentApp));
+            $this->log->info(sprintf('Creating a brancher Hypernode based on %s.', $parentApp));
             if ($settings) {
                 $this->log->info(
                     sprintf('Settings to be applied: [%s].', implode(', ', $settings))
@@ -299,7 +300,9 @@ private function maybeConfigureBrancherServer(Server $server, bool $reuseBranche
 
             try {
                 $this->log->info('Waiting for brancher Hypernode to become available...');
-                $this->brancherHypernodeManager->waitForAvailability($brancherApp);
+                $timeout = $serverOptions[self::OPTION_HN_BRANCHER_TIMEOUT] ?? 1500;
+                $this->log->info(sprintf('Timeout for brancher creation is set at %d seconds.', $timeout));
+                $this->brancherHypernodeManager->waitForAvailability($brancherApp, $timeout);
                 $this->log->info('Brancher Hypernode has become available!');
             } catch (CreateBrancherHypernodeFailedException | TimeoutException $e) {
                 if (in_array($brancherApp, $this->brancherHypernodesRegistered)) {