Add build cancellation feature to cloud-init process</message>

<message>Implement a new API endpoint for cancelling ongoing cloud-init builds, allowing users to request a build cancellation via the dashboard. Update the dashboard UI to include a cancel button that appears during the build process, enhancing user experience by providing control over long-running operations. Modify the build script to check for cancellation requests, ensuring that builds can be stopped gracefully. This feature improves usability and responsiveness in the cloud-init image building workflow.
2026-02-23 10:21:06 +02:00
parent e13ad3d8f9
commit ec973cc2b3
5 changed files with 90 additions and 2 deletions
--- a/emmc-provisioning/dashboard/app.py
+++ b/emmc-provisioning/dashboard/app.py
@@ -44,6 +44,7 @@ GOLDEN_IMAGE = Path(os.environ.get("CM4_GOLDEN_IMAGE", str(BASE_DIR / "golden.im
 NETWORK_DEVICES_FILE = Path(os.environ.get("CM4_NETWORK_DEVICES_FILE", str(BASE_DIR / "network_devices.json")))
 BUILD_STATUS_FILE = Path(os.environ.get("CM4_BUILD_STATUS_FILE", str(BASE_DIR / "build_cloudinit_status.json")))
 BUILD_REQUEST_FILE = Path(os.environ.get("CM4_BUILD_REQUEST_FILE", str(BASE_DIR / "build_cloudinit_request.json")))
+BUILD_CANCEL_FILE = BUILD_REQUEST_FILE.parent / "build_cloudinit_cancel"
 SHRINK_REQUEST_FILE = Path(os.environ.get("CM4_SHRINK_REQUEST_FILE", str(BASE_DIR / "shrink_request.json")))
 SHRINK_STATUS_FILE = Path(os.environ.get("CM4_SHRINK_STATUS_FILE", str(BASE_DIR / "shrink_status.json")))
 FIRST_BOOT_STATUS_FILE = Path(os.environ.get("CM4_FIRST_BOOT_STATUS_FILE", str(BASE_DIR / "first_boot_status.json")))
@@ -1616,6 +1617,18 @@ def api_build_cloudinit_status():
    return jsonify(_build_status_read())


+@app.route("/api/build-cloudinit-cancel", methods=["POST"])
+@require_admin
+def api_build_cloudinit_cancel():
+    """Request cancellation of the current build (host script checks for cancel file)."""
+    try:
+        BUILD_CANCEL_FILE.parent.mkdir(parents=True, exist_ok=True)
+        BUILD_CANCEL_FILE.write_text("")
+        return jsonify({"ok": True, "message": "Cancel requested. Build will stop at next check."})
+    except OSError as e:
+        return jsonify({"ok": False, "error": str(e)}), 500
+
+
@app.route("/api/build-cloudinit", methods=["POST"])
@require_admin
 def api_build_cloudinit():
--- a/emmc-provisioning/dashboard/templates/cloudinit_build.html
+++ b/emmc-provisioning/dashboard/templates/cloudinit_build.html
@@ -76,7 +76,10 @@
        <span class="mono" style="font-size:0.85rem; margin-left:0.25rem;">+ date suffix</span>
      </div>
      <div style="margin-bottom:0.5rem;"><label><input type="checkbox" id="buildSetGolden" /> Set as golden after build</label></div>
-      <div style="margin-bottom:0.75rem;"><button type="button" id="buildCloudInitBtn" class="btn btn-primary">Download &amp; build</button></div>
+      <div style="margin-bottom:0.75rem;">
+        <button type="button" id="buildCloudInitBtn" class="btn btn-primary">Download &amp; build</button>
+        <button type="button" id="buildCloudInitCancelBtn" class="btn btn-outline" style="display:none; margin-left:0.5rem;">Cancel build</button>
+      </div>
      <div id="buildCloudInitStatus" class="mono" style="min-height:1.2em;"></div>
    </div>

@@ -136,15 +139,27 @@
      authFetch('/api/build-cloudinit-status').then(function(r) { return r.json(); }).then(function(d) {
        var el = document.getElementById('buildCloudInitStatus');
        var btn = document.getElementById('buildCloudInitBtn');
+        var cancelBtn = document.getElementById('buildCloudInitCancelBtn');
        var busy = ['resolving','downloading','decompressing','injecting','finalizing'].indexOf(d.phase) >= 0;
        if (btn) btn.disabled = busy;
+        if (cancelBtn) { cancelBtn.style.display = busy ? 'inline-block' : 'none'; cancelBtn.disabled = false; }
        if (d.phase === 'idle' && !d.message) el.textContent = '';
        else if (d.phase === 'done') { el.textContent = 'Done: ' + (d.output_name || '') + ' — see Admin page Cloud-init images.'; }
        else if (d.phase === 'error') el.textContent = 'Error: ' + (d.error || '');
+        else if (d.phase === 'cancelled') el.textContent = 'Build cancelled.';
        else el.textContent = (d.phase || '') + ': ' + (d.message || '');
        if (busy) setTimeout(fetchBuildStatus, 5000);
      }).catch(function() {});
    }
+    function cancelBuild() {
+      var cancelBtn = document.getElementById('buildCloudInitCancelBtn');
+      if (cancelBtn) cancelBtn.disabled = true;
+      document.getElementById('buildCloudInitStatus').textContent = 'Cancelling…';
+      authFetch('/api/build-cloudinit-cancel', { method: 'POST', headers: {'Content-Type':'application/json'} }).then(function(r) { return r.json(); }).then(function(d) {
+        if (d.ok) setTimeout(fetchBuildStatus, 2000);
+        else { alert(d.error || 'Cancel failed'); if (cancelBtn) cancelBtn.disabled = false; }
+      }).catch(function() { if (cancelBtn) cancelBtn.disabled = false; });
+    }
    function startBuild() {
      var btn = document.getElementById('buildCloudInitBtn');
      if (btn) btn.disabled = true;
@@ -211,6 +226,8 @@
    }

    document.getElementById('buildCloudInitBtn').onclick = startBuild;
+    var cancelBuildBtn = document.getElementById('buildCloudInitCancelBtn');
+    if (cancelBuildBtn) cancelBuildBtn.onclick = cancelBuild;
    document.getElementById('buildVariant').onchange = function() {
      authFetch('/api/raspios-latest-url?variant=' + encodeURIComponent(document.getElementById('buildVariant').value)).then(function(r) { return r.json(); }).then(function(d) {
        document.getElementById('buildRaspiosUrl').textContent = (d.ok && d.filename) ? d.filename : (d.error || '');
--- a/emmc-provisioning/dashboard/templates/home.html
+++ b/emmc-provisioning/dashboard/templates/home.html
@@ -52,6 +52,11 @@
    .progress-fill { height: 100%; background: var(--accent); transition: width 0.3s; }
    .progress-fill.indeterminate { width: 35%; animation: slide 1.2s ease-in-out infinite; }
    @keyframes slide { 0% { transform: translateX(-100%); } 100% { transform: translateX(400%); } }
+    .firstboot-progress-wrap { margin-top: 0.6rem; height: 6px; background: var(--border); border-radius: 3px; overflow: hidden; }
+    .firstboot-progress-fill { height: 100%; background: linear-gradient(90deg, var(--accent-dim), var(--accent)); border-radius: 3px; transition: width 0.4s ease-out; }
+    .firstboot-progress-fill.animated { background: linear-gradient(90deg, var(--accent-dim), var(--accent) 50%, var(--accent-dim)); background-size: 200% 100%; animation: firstboot-shimmer 1.5s ease-in-out infinite; }
+    @keyframes firstboot-shimmer { 0% { background-position: 100% 0; } 100% { background-position: -100% 0; } }
+    .firstboot-step-label { font-size: 0.8rem; color: var(--text-dim); margin-bottom: 0.35rem; }
    .device-item {
      display: flex; align-items: center; justify-content: space-between; gap: 0.75rem;
      padding: 0.6rem 0.75rem; background: var(--bg-secondary); border: 1px solid var(--border); border-radius: var(--radius-sm);
@@ -110,7 +115,11 @@

        <div id="firstBootCard" class="card" style="margin-bottom: 1rem; display:none;">
          <h2 class="card-title">First-boot progress</h2>
-          <div id="firstBootStatus" class="status-row">
+          <p id="firstBootStepLabel" class="firstboot-step-label">Step 0 of 13</p>
+          <div id="firstBootProgressWrap" class="firstboot-progress-wrap" style="display:none;">
+            <div id="firstBootProgressFill" class="firstboot-progress-fill" style="width:0%;"></div>
+          </div>
+          <div id="firstBootStatus" class="status-row" style="margin-top: 0.5rem;">
            <span id="firstBootStep" class="status-pill idle"></span>
            <span id="firstBootMsg" class="status-msg"></span>
          </div>
@@ -239,6 +248,7 @@
    function fmtSize(n) { if (n >= 1e9) return (n/1e9).toFixed(1)+' GB'; if (n >= 1e6) return (n/1e6).toFixed(1)+' MB'; return (n/1e3).toFixed(0)+' KB'; }
    function fmtDate(ts) { return new Date(ts*1000).toLocaleString(); }
    function fetchStatus() { fetch('/api/status').then(function(r){ return r.json(); }).then(renderStatus).catch(function(){ renderStatus({ phase: 'error', message: 'Could not load status.' }); }); }
+    const FIRST_BOOT_TOTAL_STEPS = 13;
    function renderFirstBootStatus(data) {
      const phase = data.phase || 'idle';
      const card = document.getElementById('firstBootCard');
@@ -246,8 +256,23 @@
      card.style.display = 'block';
      const stepEl = document.getElementById('firstBootStep');
      const msgEl = document.getElementById('firstBootMsg');
+      const stepLabelEl = document.getElementById('firstBootStepLabel');
+      const progressWrap = document.getElementById('firstBootProgressWrap');
+      const progressFill = document.getElementById('firstBootProgressFill');
      const ipWrap = document.getElementById('firstBootIpWrap');
      const ipEl = document.getElementById('firstBootIp');
+      var stepNum = parseInt(data.step, 10) || 0;
+      if (phase === 'done') stepNum = FIRST_BOOT_TOTAL_STEPS;
+      var progress = stepNum > 0 ? (stepNum / FIRST_BOOT_TOTAL_STEPS * 100) : 0;
+      var inProgress = (phase === 'started' || phase === 'running');
+      stepLabelEl.textContent = 'Step ' + stepNum + ' of ' + FIRST_BOOT_TOTAL_STEPS + (data.step_name ? ' · ' + data.step_name : '');
+      if (inProgress || phase === 'done' || phase === 'error') {
+        progressWrap.style.display = 'block';
+        progressFill.style.width = progress + '%';
+        if (inProgress) progressFill.classList.add('animated'); else progressFill.classList.remove('animated');
+      } else {
+        progressWrap.style.display = 'none';
+      }
      stepEl.textContent = data.step ? 'Step ' + data.step : (phase === 'done' ? 'Done' : phase);
      stepEl.className = 'status-pill ' + (phase === 'done' ? 'done' : phase === 'error' ? 'error' : 'flashing');
      msgEl.textContent = data.message || (phase === 'done' && data.ip ? 'First-boot finished. Device IP: ' + data.ip : '');
--- a/emmc-provisioning/dashboard/templates/index.html
+++ b/emmc-provisioning/dashboard/templates/index.html
@@ -448,6 +448,7 @@
      </div>
      <div style="margin-bottom:0.75rem;">
        <button type="button" id="buildCloudInitBtn" class="btn btn-primary">Download &amp; build cloud-init image</button>
+        <button type="button" id="buildCloudInitCancelBtn" class="btn btn-outline" style="display:none; margin-left:0.5rem;">Cancel build</button>
      </div>
      <div id="buildCloudInitStatus" class="backups-mono" style="font-size:0.85rem; min-height:1.5em; margin-bottom:0.5rem;"></div>
      <details style="margin-top:0.5rem;">
@@ -893,9 +894,11 @@
      fetch('/api/build-cloudinit-status').then(function(r) { return r.json(); }).then(function(d) {
        var el = document.getElementById('buildCloudInitStatus');
        var btn = document.getElementById('buildCloudInitBtn');
+        var cancelBtn = document.getElementById('buildCloudInitCancelBtn');
        if (!el) return;
        var busy = ['resolving','downloading','decompressing','injecting','finalizing'].indexOf(d.phase) >= 0;
        if (btn) btn.disabled = busy;
+        if (cancelBtn) { cancelBtn.style.display = busy ? 'inline-block' : 'none'; cancelBtn.disabled = false; }
        if (d.phase === 'idle' && !d.message) {
          el.textContent = '';
        } else if (d.phase === 'done') {
@@ -904,12 +907,26 @@
          fetchGoldenInfo();
        } else if (d.phase === 'error') {
          el.textContent = 'Error: ' + (d.error || d.message || 'Unknown');
+        } else if (d.phase === 'cancelled') {
+          el.textContent = 'Build cancelled.';
        } else {
          el.textContent = (d.phase || '') + ': ' + (d.message || '');
        }
        if (busy) setTimeout(fetchBuildStatus, 5000);
      }).catch(function() {});
    }
+    function cancelBuildCloudInit() {
+      var cancelBtn = document.getElementById('buildCloudInitCancelBtn');
+      if (cancelBtn) cancelBtn.disabled = true;
+      document.getElementById('buildCloudInitStatus').textContent = 'Cancelling…';
+      fetch('/api/build-cloudinit-cancel', { method: 'POST', headers: { 'Content-Type': 'application/json' } })
+        .then(function(r) { return r.json(); })
+        .then(function(d) {
+          if (d.ok) setTimeout(fetchBuildStatus, 2000);
+          else alert(d.error || 'Cancel request failed');
+        })
+        .catch(function() { if (cancelBtn) cancelBtn.disabled = false; });
+    }

    function startBuildCloudInit() {
      var btn = document.getElementById('buildCloudInitBtn');
@@ -993,6 +1010,8 @@
    fetchCloudInitTemplates();
    var buildBtn = document.getElementById('buildCloudInitBtn');
    if (buildBtn) buildBtn.onclick = startBuildCloudInit;
+    var cancelBuildBtn = document.getElementById('buildCloudInitCancelBtn');
+    if (cancelBuildBtn) cancelBuildBtn.onclick = cancelBuildCloudInit;
    var variantSel = document.getElementById('buildVariant');
    if (variantSel) variantSel.onchange = fetchRaspiosUrl;
    var templateLoadBtn = document.getElementById('buildTemplateLoad');