Show real progress for running restores

marcpope · marcpope · commit a9ee5bab8ac0 · 2026-07-11T23:51:15.000-04:00
Restores showed an indeterminate "Preparing..." bar forever in the
queue and dashboard lists: both compute percent from files_total, which
backups pre-count but restores never had — even though the agent
reports byte-accurate progress from borg extract every 3 seconds and
counts extracted files from --list.

Two-part fix. The restore job now gets files_total at queue time — the
archive's stored file count for full restores, or a ClickHouse catalog
count of the selected paths (normalized to the catalog's leading-slash
form, with selections nested inside other selections deduped). And the
queue rows, queue JS poll, and dashboard active-jobs percent all fall
back to bytes_processed/bytes_total when no file total exists (catalog
down, legacy jobs). Percent is clamped at 100 since extract's item
counter includes directories while catalog counts are file-only.
diff --git a/src/Controllers/ClientController.php b/src/Controllers/ClientController.php
@@ -901,6 +901,56 @@ public function restoreSubmit(int $id): void
         }
 
 
+        // Resolve the expected file count up front so the queue's existing
+        // files-based progress bar works for restores — the agent counts
+        // each extracted file from `borg extract --list` but can't know the
+        // total itself. Full archive: the stored count. Selected paths:
+        // count matching catalog rows. Left NULL when the catalog can't
+        // answer (progress falls back to byte totals).
+        $filesTotal = null;
+        if (empty($selectedFiles)) {
+            $filesTotal = (int) ($archive['file_count'] ?? 0) ?: null;
+        } else {
+            try {
+                $ch = \BBS\Core\ClickHouse::getInstance();
+                if ($ch->isAvailable()) {
+                    // Catalog paths always carry a leading slash (the indexer
+                    // prepends one); selections from the UI may or may not —
+                    // normalize so the prefix match works either way. Then
+                    // drop selections nested inside another selection so
+                    // overlapping prefixes aren't counted twice.
+                    $paths = array_values(array_filter(array_map(
+                        fn($p) => '/' . trim((string) $p, '/'),
+                        $selectedFiles
+                    ), fn($p) => $p !== '/'));
+                    $roots = array_filter($paths, function ($p) use ($paths) {
+                        foreach ($paths as $other) {
+                            if ($other !== $p && str_starts_with($p, $other . '/')) return false;
+                        }
+                        return true;
+                    });
+
+                    $conds = [];
+                    $params = [$id, $archive_id];
+                    foreach ($roots as $p) {
+                        $conds[] = '(path = ? OR startsWith(path, ?))';
+                        $params[] = $p;
+                        $params[] = $p . '/';
+                    }
+                    if ($conds) {
+                        $row = $ch->fetchOne(
+                            "SELECT count() AS cnt FROM file_catalog
+                             WHERE agent_id = ? AND archive_id = ? AND (" . implode(' OR ', $conds) . ")",
+                            $params
+                        );
+                        $filesTotal = (int) ($row['cnt'] ?? 0) ?: null;
+                    }
+                }
+            } catch (\Exception $e) {
+                // Catalog unavailable — byte-based progress still applies
+            }
+        }
+
         // Create restore job
         $jobId = $this->db->insert('backup_jobs', [
             'agent_id' => $id,
@@ -912,6 +962,7 @@ public function restoreSubmit(int $id): void
             'restore_archive_id' => $archive_id,
             'restore_paths' => json_encode($selectedFiles),
             'restore_destination' => $destination ?: null,
+            'files_total' => $filesTotal,
         ]);
 
         $this->db->insert('server_log', [
diff --git a/src/Controllers/DashboardController.php b/src/Controllers/DashboardController.php
@@ -320,6 +320,7 @@ public function apiActiveJson(): void
 
         $activeJobs = $this->db->fetchAll("
             SELECT bj.id, bj.task_type, bj.status, bj.files_total, bj.files_processed,
+                   bj.bytes_total, bj.bytes_processed,
                    a.name as agent_name, r.name as repo_name
             FROM backup_jobs bj
             JOIN agents a ON a.id = bj.agent_id
@@ -350,9 +351,15 @@ public function apiActiveJson(): void
             'queuedJobs'  => $queuedJobs,
             'errorCount'  => $errorCount,
             'activeJobs'  => array_map(static function ($j) {
-                $pct = ((int) ($j['files_total'] ?? 0)) > 0
-                    ? (int) round(((int) $j['files_processed'] / (int) $j['files_total']) * 100)
-                    : null;
+                // File counts when the total is known (backups pre-count;
+                // restores get it from the catalog at queue time), else byte
+                // totals from borg extract's progress stream. Clamped at 100.
+                $pct = null;
+                if (((int) ($j['files_total'] ?? 0)) > 0) {
+                    $pct = min(100, (int) round(((int) $j['files_processed'] / (int) $j['files_total']) * 100));
+                } elseif (((int) ($j['bytes_total'] ?? 0)) > 0 && ((int) ($j['bytes_processed'] ?? 0)) > 0) {
+                    $pct = min(100, (int) round(((int) $j['bytes_processed'] / (int) $j['bytes_total']) * 100));
+                }
                 return [
                     'id'          => (int) $j['id'],
                     'agent_name'  => $j['agent_name'],
diff --git a/src/Views/queue/index.php b/src/Views/queue/index.php
@@ -269,10 +269,23 @@ function jobTypeIcon(string $type): string {
                         <td class="text-nowrap"><?= jobTypeIcon($job['task_type']) ?><?= htmlspecialchars(ucfirst(str_replace('_', ' ', $job['task_type']))) ?></td>
                         <td class="d-none d-md-table-cell"><?= number_format($job['files_total'] ?? 0) ?></td>
                         <td>
+                            <?php
+                            // Percent from file counts when the total is known
+                            // (backups pre-count; restores get it from the
+                            // catalog at queue time), else from byte totals
+                            // (borg extract reports byte offsets). Clamped —
+                            // extract's item counter includes directories, so
+                            // it can slightly overshoot a file-only total.
+                            $pct = null;
+                            if (($job['files_total'] ?? 0) > 0) {
+                                $pct = min(100, round(($job['files_processed'] / $job['files_total']) * 100));
+                            } elseif (($job['bytes_total'] ?? 0) > 0 && ($job['bytes_processed'] ?? 0) > 0) {
+                                $pct = min(100, round(($job['bytes_processed'] / $job['bytes_total']) * 100));
+                            }
+                            ?>
                             <?php if ($job['status'] === 'queued'): ?>
                                 <span class="text-muted">Waiting</span>
-                            <?php elseif (($job['files_total'] ?? 0) > 0): ?>
-                                <?php $pct = round(($job['files_processed'] / $job['files_total']) * 100); ?>
+                            <?php elseif ($pct !== null): ?>
                                 <div class="progress queue-progress" style="height: 18px; min-width: 80px;">
                                     <div class="progress-bar progress-bar-striped progress-bar-animated bg-success" style="width: <?= $pct ?>%">
                                         <?= $pct ?>%
@@ -455,10 +468,17 @@ function jobTypeIcon(type) {
 
     function buildInProgressRow(job) {
         let progress;
+        // Same fallback chain as the PHP render: file counts, then byte
+        // totals (restores without a catalog count), clamped at 100.
+        let pct = null;
+        if ((job.files_total || 0) > 0) {
+            pct = Math.min(100, Math.round((job.files_processed / job.files_total) * 100));
+        } else if ((job.bytes_total || 0) > 0 && (job.bytes_processed || 0) > 0) {
+            pct = Math.min(100, Math.round((job.bytes_processed / job.bytes_total) * 100));
+        }
         if (job.status === 'queued') {
             progress = '<span class="text-muted">Waiting</span>';
-        } else if ((job.files_total || 0) > 0) {
-            const pct = Math.round((job.files_processed / job.files_total) * 100);
+        } else if (pct !== null) {
             progress = '<div class="progress queue-progress" style="height:18px;min-width:80px;">' +
                 '<div class="progress-bar progress-bar-striped progress-bar-animated bg-success" style="width:' + pct + '%">' + pct + '%</div></div>';
         } else if (job.status_message) {
