warn, not error, on startup

Author: mafredri

registry/coder-labs/modules/archive/README.md

@@ -97,7 +97,9 @@ module "archive" {
   archive_name = "my-archive"
   compression  = "gzip"
 
-  # Waits up to 5 minutes for /tmp/my-archive.tar.gz to be present.
+  # Waits up to 5 minutes for /tmp/my-archive.tar.gz to be present, note that
+  # using a long timeout will delay every workspace start by this much until the
+  # archive is present.
   extract_on_start             = true
   extract_wait_timeout_seconds = 300
 }
@@ -114,7 +116,7 @@ module "archive" {
 - `directory` (string, default: `"~"`): Working directory used for tar with `-C`.
 - `create_on_stop` (bool, default: `false`): If true, registers a `run_on_stop` script that invokes the create wrapper on workspace stop.
 - `extract_on_start` (bool, default: `false`): If true, the installer waits up to `extract_wait_timeout_seconds` for the archive path to appear and extracts it on start.
-- `extract_wait_timeout_seconds` (number, default: `300`): Timeout for `extract_on_start`.
+- `extract_wait_timeout_seconds` (number, default: `5`): Timeout for `extract_on_start`.
 
 ## Outputs
 

registry/coder-labs/modules/archive/main.tf

@@ -69,7 +69,7 @@ variable "extract_on_start" {
 variable "extract_wait_timeout_seconds" {
   description = "Timeout (seconds) to wait for an archive when extract_on_start is true."
   type        = number
-  default     = 300
+  default     = 5
 }
 
 # Provide a stable script filename and sensible defaults.

registry/coder-labs/modules/archive/run.sh

@@ -64,5 +64,12 @@ echo "Installed extract script to:  $EXTRACT_WRAPPER_PATH"
 if [[ $EXTRACT_ON_START = true ]]; then
   . "$LIB_PATH"
 
-  archive_wait_and_extract "$EXTRACT_WAIT_TIMEOUT"
+  archive_wait_and_extract "$EXTRACT_WAIT_TIMEOUT" quiet || {
+    exit_code=$?
+    if [[ $exit_code -eq 2 ]]; then
+      echo "WARNING: Archive not found in backup path (this is expected with new workspaces)."
+    else
+      exit $exit_code
+    fi
+  }
 fi

registry/coder-labs/modules/archive/scripts/archive-lib.sh

@@ -1,8 +1,6 @@
 #!/usr/bin/env bash
 set -euo pipefail
 
-# set -x
-
 log() {
   printf '%s\n' "$@" >&2
 }
@@ -253,6 +251,7 @@ archive_wait_and_extract() {
   load_defaults
 
   local timeout="${1:-300}"
+  local quiet="${2:-}"
   local file="${DEFAULT_ARCHIVE_PATH}"
 
   local start now
@@ -273,6 +272,8 @@ archive_wait_and_extract() {
     sleep 5
   done
 
-  printf 'ERROR: Timed out waiting for archive: %s\n' "$file" >&2
-  return 1
+  if [[ -z $quiet ]]; then
+    printf 'ERROR: Timed out waiting for archive: %s\n' "$file" >&2
+  fi
+  return 2
 }