fix(exec): more informative error msg on timeout (#3584)

garden-io · Jan 25, 2023 · 0808531 · 0808531
1 parent 2d8bf03
commit 0808531
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 11 deletions.
diff --git a/core/src/plugins/exec/exec.ts b/core/src/plugins/exec/exec.ts
@@ -726,6 +726,7 @@ async function deployPersistentExecService({
 
   if (devModeSpec.statusCommand) {
     let ready = false
+    let lastStatusResult: execa.ExecaReturnBase<string> | undefined
 
     while (!ready) {
       await sleep(persistentLocalProcRetryIntervalMs)
@@ -734,12 +735,37 @@ async function deployPersistentExecService({
       const timeElapsedSec = (now.getTime() - startedAt.getTime()) / 1000
 
       if (timeElapsedSec > devModeSpec.timeout) {
-        throw new TimeoutError(`Timed out waiting for local service ${serviceName} to be ready`, {
-          serviceName,
-          statusCommand: devModeSpec.statusCommand,
-          pid: proc.pid,
-          timeout: devModeSpec.timeout,
-        })
+        let lastResultDescription = ""
+        if (lastStatusResult) {
+          lastResultDescription = dedent`\n\nThe last exit code was ${lastStatusResult.exitCode}.\n\n`
+          if (lastStatusResult.stderr) {
+            lastResultDescription += `Command error output:\n${lastStatusResult.stderr}\n\n`
+          }
+          if (lastStatusResult.stdout) {
+            lastResultDescription += `Command output:\n${lastStatusResult.stdout}\n\n`
+          }
+        }
+
+        throw new TimeoutError(
+          dedent`Timed out waiting for local service ${serviceName} to be ready.
+
+          Garden timed out waiting for the command ${chalk.gray(devModeSpec.statusCommand)}
+          to return status code 0 (success) after waiting for ${devModeSpec.timeout} seconds.
+          ${lastResultDescription}
+          Possible next steps:
+
+          Find out why the configured status command fails.
+
+          In case the service just needs more time to become ready, you can adjust the ${chalk.gray("timeout")} value
+          in your service definition to a value that is greater than the time needed for your service to become ready.
+          `,
+          {
+            serviceName,
+            statusCommand: devModeSpec.statusCommand,
+            pid: proc.pid,
+            timeout: devModeSpec.timeout,
+          }
+        )
       }
 
       const result = await run({
@@ -751,6 +777,7 @@ async function deployPersistentExecService({
         opts: { reject: false },
       })
 
+      lastStatusResult = result
       ready = result.exitCode === 0
     }
   }

diff --git a/core/test/data/test-project-exec/module-local-persistent/garden.yml b/core/test/data/test-project-exec/module-local-persistent/garden.yml
@@ -19,6 +19,6 @@ services:
     persistent: true
     devMode:
       command: [/bin/sh -c "while true; do sleep 10000; done"]
-      statusCommand: [/bin/sh -c "exit 1"]
-      timeout: 1
+      statusCommand: [/bin/sh -c "echo Status command output; exit 1"]
+      timeout: 3
     deployCommand: []
diff --git a/core/test/unit/src/plugins/exec/exec.ts b/core/test/unit/src/plugins/exec/exec.ts
@@ -830,9 +830,11 @@ describe("exec plugin", () => {
           expect(pid).to.be.a("number")
           expect(pid).to.be.greaterThan(0)
           expect(error.detail.serviceName).to.eql("dev-mode-timeout")
-          expect(error.detail.statusCommand).to.eql([`/bin/sh -c "exit 1"`])
-          expect(error.detail.timeout).to.eql(1)
-          expect(error.message).to.eql(`Timed out waiting for local service dev-mode-timeout to be ready`)
+          expect(error.detail.statusCommand).to.eql([`/bin/sh -c "echo Status command output; exit 1"`])
+          expect(error.detail.timeout).to.eql(3)
+          expect(error.message).to.include(`Timed out waiting for local service dev-mode-timeout to be ready.`)
+          expect(error.message).to.include(`The last exit code was 1.`)
+          expect(error.message).to.include(`Command output:\nStatus command output`)
         })
       })
     })