fix: detect stale static bundles in build pipeline and at runtime (#1064) (#1121)

* fix: detect stale static bundles in build pipeline and at runtime (#1064)

Add a packaging-time sanity check and a backend startup self-check that
verifies index.html only references /assets/*.js and /assets/*.css files
that actually exist on disk. This is the most common root cause of the
'Preparing backend...' / blank-page bug seen on the Windows immutable
Release packages: vite emits a fresh index.html with new content hashes,
but the desktop packaging step picks up a stale static/ directory, so
the browser receives a 404 (returned as application/json) for the main
bundle and refuses to execute it.

- scripts/check_static_assets.py: cross-platform sanity script.
- scripts/build-backend{.ps1,-macos.sh}: run the script after npm build
  on the source static/, and again after PyInstaller on the packaged
  static directory; fail the build on mismatch.
- api/app.py: log an actionable ERROR when an inconsistency is detected
  at startup so the root cause appears in logs/desktop.log instead of
  surfacing as a silent blank page.
- api/app.py: replace the StaticFiles mount with an explicit /assets/*
  route so misses return a plain-text 404 with a JS/CSS Content-Type,
  not the default JSON error response that masked diagnosis in #1064.
- tests/test_static_assets_consistency.py: 7 deterministic tests for
  both code paths.

Refs #1064 #1065 #1050
This commit is contained in:
mumu
2026-04-25 20:22:59 +08:00
committed by GitHub
parent 9a08ba47fa
commit 0924dce274
6 changed files with 545 additions and 6 deletions

View File

@@ -30,6 +30,9 @@ fi
npm run build
popd >/dev/null
log "Verifying static asset references (source)..."
"${PYTHON_BIN}" "${SCRIPT_DIR}/check_static_assets.py" "${ROOT_DIR}/static"
log "Building backend executable..."
if ! "${PYTHON_BIN}" -m PyInstaller --version >/dev/null 2>&1; then
"${PYTHON_BIN}" -m pip install pyinstaller
@@ -109,4 +112,15 @@ popd >/dev/null
cp -R "${ROOT_DIR}/dist/stock_analysis" "${ROOT_DIR}/dist/backend/stock_analysis"
log "Verifying static asset references (packaged)..."
packaged_static="${ROOT_DIR}/dist/backend/stock_analysis/_internal/static"
if [[ ! -d "${packaged_static}" ]]; then
packaged_static="${ROOT_DIR}/dist/backend/stock_analysis/static"
fi
if [[ -d "${packaged_static}" ]]; then
"${PYTHON_BIN}" "${SCRIPT_DIR}/check_static_assets.py" "${packaged_static}"
else
log "WARNING: could not locate packaged static directory under dist/backend/stock_analysis; skipping post-package check."
fi
log "Backend build completed."

View File

@@ -15,6 +15,12 @@ if ([string]::IsNullOrWhiteSpace($pythonBin)) {
Write-Host "Using Python: $pythonBin"
Write-Host 'Verifying static asset references (source)...'
& $pythonBin "${PSScriptRoot}\check_static_assets.py" 'static'
if ($LASTEXITCODE -ne 0) {
throw "Static asset sanity check failed for source static/. See GitHub #1064."
}
function Test-PythonCode {
param(
[string]$Python,
@@ -124,4 +130,18 @@ if (!(Test-Path 'dist\stock_analysis')) {
Copy-Item -Path 'dist\stock_analysis' -Destination 'dist\backend\stock_analysis' -Recurse -Force
Write-Host 'Verifying static asset references (packaged)...'
$packagedStatic = Join-Path 'dist\backend\stock_analysis' '_internal\static'
if (-not (Test-Path $packagedStatic)) {
$packagedStatic = Join-Path 'dist\backend\stock_analysis' 'static'
}
if (Test-Path $packagedStatic) {
& $pythonBin "${PSScriptRoot}\check_static_assets.py" $packagedStatic
if ($LASTEXITCODE -ne 0) {
throw "Static asset sanity check failed for packaged $packagedStatic. See GitHub #1064."
}
} else {
Write-Warning "Could not locate packaged static directory under dist\backend\stock_analysis; skipping post-package check."
}
Write-Host 'Backend build completed.'

View File

@@ -0,0 +1,122 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
Static frontend sanity check for the desktop / server packaging pipeline.
Validates that ``index.html`` only references ``/assets/*.js`` and
``/assets/*.css`` files that actually exist on disk. A mismatch here is the
most common cause of the "Preparing backend..." / blank-page bug reported in
GitHub issues #1064, #1065, #1050: vite re-builds with a new content hash,
but the packaging step picks up a stale ``static/`` directory or copies the
files out of sync, so the browser receives a 404 (often as JSON) for the
main bundle and refuses to execute it.
Usage:
python scripts/check_static_assets.py [<static_dir>]
Exits 0 when consistent, non-zero with a human-readable message otherwise.
"""
from __future__ import annotations
import re
import sys
from pathlib import Path
from typing import List, Tuple
# Match src="/assets/foo.js" or href="/assets/foo.css", with single or double
# quotes. Vite emits absolute paths by default (``base: '/'``).
_ASSET_PATTERN = re.compile(
r"""(?:src|href)\s*=\s*["'](/assets/[^"']+)["']""",
re.IGNORECASE,
)
def _parse_referenced_assets(index_html: str) -> List[str]:
"""Return the unique list of ``/assets/...`` paths referenced by ``index.html``."""
seen: List[str] = []
for match in _ASSET_PATTERN.finditer(index_html):
ref = match.group(1)
if ref not in seen:
seen.append(ref)
return seen
def check_static_dir(static_dir: Path) -> Tuple[List[str], List[str]]:
"""
Inspect ``static_dir`` and return ``(referenced, missing)``.
``referenced`` is the list of ``/assets/...`` paths declared in
``index.html``. ``missing`` is the subset that does not exist on disk.
Raises ``FileNotFoundError`` if ``index.html`` itself is missing.
"""
index_html_path = static_dir / "index.html"
if not index_html_path.is_file():
raise FileNotFoundError(f"index.html not found under {static_dir}")
html = index_html_path.read_text(encoding="utf-8", errors="replace")
referenced = _parse_referenced_assets(html)
missing: List[str] = []
for ref in referenced:
# ref looks like "/assets/index-xxx.js"; strip the leading slash so
# it resolves relative to ``static_dir``.
candidate = static_dir / ref.lstrip("/")
if not candidate.is_file():
missing.append(ref)
return referenced, missing
def main(argv: List[str]) -> int:
if len(argv) > 1:
static_dir = Path(argv[1]).resolve()
else:
static_dir = (Path(__file__).resolve().parent.parent / "static").resolve()
print(f"[check_static_assets] inspecting {static_dir}")
try:
referenced, missing = check_static_dir(static_dir)
except FileNotFoundError as exc:
print(f"[check_static_assets] ERROR: {exc}", file=sys.stderr)
print(
"[check_static_assets] Hint: build the frontend first via "
"`cd apps/dsa-web && npm install && npm run build`.",
file=sys.stderr,
)
return 2
if not referenced:
print(
"[check_static_assets] WARNING: index.html does not reference any "
"/assets/* files; this is unusual for a vite build.",
file=sys.stderr,
)
return 0
if missing:
print(
"[check_static_assets] ERROR: index.html references assets that "
"are not present on disk:",
file=sys.stderr,
)
for ref in missing:
print(f" - {ref}", file=sys.stderr)
print(
"[check_static_assets] This produces a blank page on first load "
"(see GitHub #1064 / #1065). Re-run the frontend build and make "
"sure the packaging step copies the freshly generated static/ "
"directory.",
file=sys.stderr,
)
return 1
print(
f"[check_static_assets] OK: {len(referenced)} asset reference(s) "
f"resolved successfully."
)
return 0
if __name__ == "__main__":
sys.exit(main(sys.argv))