openhuman/scripts/ci-cancel-aware.sh

#!/usr/bin/env bash

set -euo pipefail

if [ "$#" -eq 0 ]; then
  echo "usage: $0 <command> [args...]" >&2
  exit 64
fi

OS_NAME="$(uname -s 2>/dev/null || echo unknown)"
CHILD_PID=""
RECEIVED_SIGNAL=""
CHILD_OWNS_PROCESS_GROUP=0
WATCHDOG_PID=""

is_windows_shell() {
  case "$OS_NAME" in
    MINGW*|MSYS*|CYGWIN*|Windows_NT) return 0 ;;
    *) return 1 ;;
  esac
}

collect_descendants_unix() {
  local pid="$1"
  local child=""
  while IFS= read -r child; do
    [ -n "$child" ] || continue
    collect_descendants_unix "$child"
    printf '%s\n' "$child"
  done < <(pgrep -P "$pid" 2>/dev/null || true)
}

terminate_tree_term() {
  local pid="$1"
  if is_windows_shell; then
    taskkill //PID "$pid" //T >/dev/null 2>&1 || true
    return
  fi

  if [ "$CHILD_OWNS_PROCESS_GROUP" = "1" ]; then
    kill -TERM -- "-$pid" 2>/dev/null || true
  fi

  local descendants=""
  descendants="$(collect_descendants_unix "$pid")"
  if [ -n "$descendants" ]; then
    while IFS= read -r child; do
      [ -n "$child" ] || continue
      kill -TERM "$child" 2>/dev/null || true
    done <<< "$descendants"
  fi
  kill -TERM "$pid" 2>/dev/null || true
}

terminate_tree_kill() {
  local pid="$1"
  if is_windows_shell; then
    taskkill //PID "$pid" //T //F >/dev/null 2>&1 || true
    return
  fi

  if [ "$CHILD_OWNS_PROCESS_GROUP" = "1" ]; then
    kill -KILL -- "-$pid" 2>/dev/null || true
  fi

  local descendants=""
  descendants="$(collect_descendants_unix "$pid")"
  if [ -n "$descendants" ]; then
    while IFS= read -r child; do
      [ -n "$child" ] || continue
      kill -KILL "$child" 2>/dev/null || true
    done <<< "$descendants"
  fi
  kill -KILL "$pid" 2>/dev/null || true
}

forward_cancel() {
  local signal="$1"
  RECEIVED_SIGNAL="$signal"
  if [ -n "$CHILD_PID" ] && kill -0 "$CHILD_PID" 2>/dev/null; then
    echo "[ci-cancel-aware] received $signal, terminating process tree rooted at $CHILD_PID" >&2
    terminate_tree_term "$CHILD_PID"
  fi
}

# Signal traps alone cannot stop builds inside `container:` jobs: the runner
# delivers SIGINT/SIGTERM to the host-side `docker exec` client, which does
# NOT forward them into the container (actions/runner#1503). Observed on run
# 28692500745: cancelled jobs kept building for 23-28 minutes to natural
# completion. This watchdog polls the Actions API for the run's cancellation
# and delivers the TERM ourselves, from inside the container.
#
# Requires: GH_TOKEN or GITHUB_TOKEN in the environment with `actions: read`
# (workflows set `env: GH_TOKEN: ${{ github.token }}` at the top level).
# Silently disabled outside GitHub Actions or when no token is available.
start_cancel_watchdog() {
  [ "${CI_CANCEL_WATCHDOG:-1}" = "1" ] || return 0
  [ -n "${GITHUB_ACTIONS:-}" ] || return 0
  [ -n "${GITHUB_RUN_ID:-}" ] && [ -n "${GITHUB_REPOSITORY:-}" ] || return 0
  local token="${GH_TOKEN:-${GITHUB_TOKEN:-}}"
  if [ -z "$token" ]; then
    echo "[ci-cancel-aware] watchdog disabled: no GH_TOKEN/GITHUB_TOKEN in env" >&2
    return 0
  fi
  if ! command -v curl >/dev/null 2>&1; then
    echo "[ci-cancel-aware] watchdog disabled: curl not available" >&2
    return 0
  fi

  local api="${GITHUB_API_URL:-https://api.github.com}"
  local url="${api}/repos/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}"
  local interval="${CI_CANCEL_POLL_SECONDS:-20}"
  local self=$$
  (
    # The parent's `set -euo pipefail` is inherited; a poll where conclusion
    # is still null makes grep exit 1 and must not kill the watchdog loop.
    set +e +o pipefail
    while :; do
      sleep "$interval"
      # Extract the run's top-level status/conclusion without jq.
      run_json="$(curl -sf --max-time 10 \
        -H "Authorization: Bearer ${token}" \
        -H "Accept: application/vnd.github+json" \
        "$url" 2>/dev/null | head -c 4096)" || continue
      status="$(printf '%s' "$run_json" | tr -d ' \n' | grep -o '"status":"[a-z_]*"' | head -1 | cut -d'"' -f4)"
      conclusion="$(printf '%s' "$run_json" | tr -d ' \n' | grep -o '"conclusion":"[a-z_]*"' | head -1 | cut -d'"' -f4)"
      if [ "$status" = "cancelled" ] || [ "$status" = "completed" ] || [ "$conclusion" = "cancelled" ]; then
        echo "[ci-cancel-aware] watchdog: run status=${status:-?} conclusion=${conclusion:-?} — cancelling build" >&2
        kill -TERM "$self" 2>/dev/null || true
        exit 0
      fi
    done
  ) &
  WATCHDOG_PID=$!
  echo "[ci-cancel-aware] cancellation watchdog polling every ${interval}s (run ${GITHUB_RUN_ID})" >&2
}

cleanup() {
  local status=$?
  trap - EXIT INT TERM HUP

  if [ -n "$WATCHDOG_PID" ]; then
    kill "$WATCHDOG_PID" 2>/dev/null || true
  fi

  if [ -n "$CHILD_PID" ] && kill -0 "$CHILD_PID" 2>/dev/null; then
    terminate_tree_term "$CHILD_PID"
    for _ in $(seq 1 10); do
      if ! kill -0 "$CHILD_PID" 2>/dev/null; then
        break
      fi
      sleep 1
    done
    if kill -0 "$CHILD_PID" 2>/dev/null; then
      echo "[ci-cancel-aware] forcing process tree shutdown for pid $CHILD_PID" >&2
      terminate_tree_kill "$CHILD_PID"
    fi
    wait "$CHILD_PID" 2>/dev/null || true
  fi

  if [ -n "$RECEIVED_SIGNAL" ]; then
    case "$RECEIVED_SIGNAL" in
      INT) return 130 ;;
      TERM|HUP) return 143 ;;
      *) return "$status" ;;
    esac
  fi

  return "$status"
}

start_child() {
  if ! is_windows_shell && command -v setsid >/dev/null 2>&1; then
    setsid "$@" &
    CHILD_OWNS_PROCESS_GROUP=1
  else
    "$@" &
    CHILD_OWNS_PROCESS_GROUP=0
  fi
  CHILD_PID=$!
}

trap 'forward_cancel INT' INT
trap 'forward_cancel TERM' TERM
trap 'forward_cancel HUP' HUP
trap cleanup EXIT

echo "[ci-cancel-aware] exec: $(printf '%q ' "$@")" >&2
start_cancel_watchdog
start_child "$@"

set +e
wait "$CHILD_PID"
status=$?
set -e

# A trapped cancellation can interrupt wait before the child exits. Keep
# CHILD_PID set so the EXIT cleanup can escalate from TERM to KILL.
if ! kill -0 "$CHILD_PID" 2>/dev/null; then
  CHILD_PID=""
fi
exit "$status"