LibrePortal/scripts/migrate/migrate_progress.sh
librelad 32b2840d73 refactor(migrate)!: rewrite kernel — discover/preflight/apply with JSON progress
Phase 0 of the migration-system refresh. Replaces the 77-line
scripts/migrate/ with a properly-shaped kernel that Phase 1 (WebUI) and
Phase 3 (direct peer SSH) can both build on.

New module layout (6 files):
  migrate_progress.sh   — migrateEmit JSON-per-line helper; opt-in via
                          MIGRATE_JSON_PROGRESS=1, writes to fd 3 if open
                          (clean WebUI streaming channel) else stdout.
  migrate_discover.sh   — migrateDiscoverHosts / migrateDiscoverApps /
                          migrateDiscoverAppDetail (JSON {snapshots, latest_*}).
                          Old migrateDiscoverAppsForHost kept as back-compat.
  migrate_preflight.sh  — migratePreflight emits one JSON object with
                          snapshot{id,date}, destination{installed,running,
                          disk_free_kb}, collision{occurs,default_action,
                          pre_backup_default}, url_rewrite{default_action,
                          per_app_opt_out}, warnings[], errors[].
                          Exit 0 on usable preflight, 1 on hard error.
  migrate_url_rewrite.sh— Host-bound CFG_<APP>_* fields (URL/HOST/DOMAIN/
                          DOMAIN_PREFIX/HOSTNAME/PUBLIC_URL) get rewritten
                          from the destination's install-template after
                          restore — so a moved app stops claiming the
                          source's hostnames. Per-app opt-out via
                          CFG_<APP>_MIGRATE_URL_REWRITE=false. All other
                          fields (DB passwords, API keys, prefs) carry
                          over from the source unchanged.
  migrate_pre_backup.sh — migratePreBackupDestination takes a snapshot of
                          the destination's existing <app> (tagged
                          pre-migrate=<UTC timestamp>) before the wipe.
                          Default ON; opt-out with --no-pre-backup. Safety
                          net for the always-replace collision policy.
  migrate_apply.sh      — migrateApplyApp / migrateApplySystem. Parses
                          --no-pre-backup / --keep-urls / --json-progress
                          opts, runs preflight → pre-backup → restoreAppStart
                          (existing flow) → URL rewrite → re-deploy compose.
                          migrateApp / migrateSystem kept as shims so the
                          old CLI surface still works.

CLI dispatcher (cli_restore_commands.sh + cli_restore_header.sh):
  Existing 'restore migrate app/system/discover' calls all still work.
  New verbs:
    restore migrate list <host> [loc_idx]
    restore migrate preflight <host> <app> [loc_idx]   ← JSON, for the WebUI

Design choices baked in (per the spec):
  - Always-replace collision (no multi-install of an app), safety net is the
    on-by-default pre-migrate backup.
  - URL rewrite by host-bound suffix list, not per-field allowlist — works
    out-of-the-box for new apps without extra config.
  - migrateEmit fd-3 contract is what Phase 1's WebUI will stream; falls
    back to stdout in interactive CLI so dev/debug just works.
  - Transport-agnostic: nothing in this kernel knows whether the backup
    location is local/SSH/S3/Connect — engineSnapshotsJson + engineBackupApp
    do that, so Connect (the future blind-relay) plugs in as 'just another
    location kind' with zero kernel changes.

Smoke-tested: all 13 public functions register; JSON emit produces correct
escaping (quoted strings vs bare numerics) and respects MIGRATE_JSON_PROGRESS.

Signed-off-by: librelad <librelad@digitalangels.vip>
2026-05-26 17:22:54 +01:00

53 lines
1.7 KiB
Bash

#!/bin/bash
# Structured progress emit for migrate flows. Phase 1's WebUI streams these
# JSON-per-line records and renders them. When MIGRATE_JSON_PROGRESS=1 the
# helper writes machine-readable JSON to fd 3 (or stdout if fd 3 isn't open);
# otherwise it's a no-op so the human CLI output stays clean.
#
# Usage:
# migrateEmit phase=preflight status=running
# migrateEmit phase=restore status=running pct=50
# migrateEmit phase=done status=complete duration_seconds=42
#
# Keys with spaces or special chars should be passed pre-quoted (a=foo\ bar)
# or via the explicit setter form (rare — most callers use the simple kv form).
migrateEmit()
{
[[ "$MIGRATE_JSON_PROGRESS" != "1" ]] && return 0
local pair
local first=1
local out='{'
for pair in "$@"; do
local k="${pair%%=*}"
local v="${pair#*=}"
# Numeric values stay bare; everything else gets quoted + escaped.
local rendered
if [[ "$v" =~ ^-?[0-9]+(\.[0-9]+)?$ ]]; then
rendered="$v"
else
local escaped="${v//\\/\\\\}"
escaped="${escaped//\"/\\\"}"
escaped="${escaped//$'\n'/\\n}"
escaped="${escaped//$'\t'/\\t}"
rendered="\"$escaped\""
fi
if (( first )); then
out+="\"$k\":$rendered"
first=0
else
out+=",\"$k\":$rendered"
fi
done
out+='}'
# fd 3 is the structured channel — Phase 1 opens it. If it's not open
# (interactive CLI), fall back to stdout so dev/debug runs still see it.
if { true >&3; } 2>/dev/null; then
printf '%s\n' "$out" >&3
else
printf '%s\n' "$out"
fi
}