西风逍遥游
31880f0021
`examples/<name>/` was a tested surface in name only. The source-quality job had no examples check at all, and scripts/smoke_examples.sh accepted any process that had not printed one of its error markers: a project that died during startup, exited after a single frame, or crashed without a marker was reported as PASS. Nothing stopped a malformed or unregistered example from reaching dev, which is how 14 examples arrived without READMEs and 20 were never registered in the overview table. Source side - scripts/check_examples.py classifies every directory under examples/ as either runnable (main.nut plus a config.nut that assigns the engine `config` table) or as a reviewed non-runnable sample listed in NON_RUNNABLE_EXAMPLES with a reason. Both kinds must own a README.md and appear in examples/README.md. Stale exemptions and overview links to missing directories fail as well. - `make check/examples` and a new source-quality CI step run the gate. - scripts/tests/test_check_examples.py covers it and pins each failure mode against fixtures. Runtime side - scripts/smoke_examples.sh now enforces liveness, not just marker absence: every runnable example must still be running after MIN_RUN_SECONDS (default 2s; CI passes 2s), and a process that dies inside that window fails whatever its exit code. A clean self-exit after the window passes with an explicit note instead of being silently accepted as a pass. - The Linux CI step sets MIN_RUN_SECONDS=2 and keeps RUN_SECONDS=6, so the job's wall clock is unchanged (13.7 min of its 20 min budget on dev). Windows / GBK - scripts/utf8_stdio.py re-encodes stdout/stderr as UTF-8 and every scripts/*.py program calls it as the first statement of its __main__ block. On a Chinese Windows a redirected stream falls back to the ANSI code page (cp936), and printing a character that code page cannot encode (arrows, superscripts, bullet separators, emoji - all common in this repository) raised UnicodeEncodeError and turned a checker into a traceback. - The mirror image is input: read_text() without encoding= decoded UTF-8 repository text as cp936 and raised UnicodeDecodeError. - scripts/tests/test_utf8_stdio.py enforces both conventions for every script and test module; text file I/O and child-process decoding now pass encoding="utf-8" explicitly. - Unit-test invocations run with `python3 -X utf8` so the runner's own output never follows the host code page. Violations the new gates found on top of dev, fixed here: 14 examples shipped without a README (fluid3d, mesh-impact-lab, mesh-modifier-lab, spline-tube-lab on the earlier dev tip, plus pcg-depth-of-field, pcg-detail-overwrite, pcg-layer-culling, pcg-location-system, pcg-runtime-orchestration, pcg-scene-player-culling, pcg-snow-wind, pcg-thunder-strike, pcg-ui-scaler and pcg-underwater added by #397), 20 were missing from the overview table (those 14 plus archspace-editor, geometry-stroke-lab, interior-mapping, layered-animation, triplanar-decal, terrain-stamping), and scripts/export_meshret_onnx.py had no UTF-8 stdio guard. Verified locally: `python -m ruff check scripts` (All checks passed); scripts/check_test_manifest.py; scripts/check_quality_metadata.py; scripts/check_architecture_contracts.py --base HEAD; scripts/check_nodiscard.py; `make -n check/examples`; scripts/check_examples.py (125 examples: 118 runnable, 7 reviewed non-runnable); and `python -X utf8 -m unittest discover -s scripts/tests -p "test_*.py"` (155 tests, OK). The runtime half of the contract needs a Linux headless build, so it is verified by the CI examples smoke step rather than locally.
78 lines
2.5 KiB
Python
78 lines
2.5 KiB
Python
#!/usr/bin/env python3
|
|
"""Serve the EVEngine WebGPU build directory with cross-origin isolation.
|
|
|
|
The Emscripten build runs the engine on pthreads and needs SharedArrayBuffer,
|
|
so the page MUST be served with COOP/COEP headers -- opening eve.html via
|
|
file:// will not work. This server adds those headers plus no-store caching so
|
|
rebuilt eve.js / eve.wasm / eve.data are always picked up.
|
|
|
|
Usage (from the repo root):
|
|
python scripts/serve_webgpu.py # serves build/webgpu-web/src/engine :8090
|
|
python scripts/serve_webgpu.py <engine-dir> [port]
|
|
"""
|
|
|
|
import argparse
|
|
import http.server
|
|
import os
|
|
import sys
|
|
from pathlib import Path
|
|
import utf8_stdio
|
|
|
|
|
|
class PlaygroundHandler(http.server.SimpleHTTPRequestHandler):
|
|
def end_headers(self):
|
|
# Required for Emscripten pthreads / SharedArrayBuffer.
|
|
self.send_header("Cross-Origin-Opener-Policy", "same-origin")
|
|
self.send_header("Cross-Origin-Embedder-Policy", "require-corp")
|
|
# The engine files are regenerated on every build; never cache them.
|
|
self.send_header("Cache-Control", "no-store")
|
|
super().end_headers()
|
|
|
|
def log_message(self, fmt, *args):
|
|
sys.stderr.write("[serve] %s\n" % (fmt % args))
|
|
|
|
|
|
def main():
|
|
default_dir = (
|
|
Path(__file__).resolve().parent.parent
|
|
/ "build" / "webgpu-web" / "src" / "engine"
|
|
)
|
|
parser = argparse.ArgumentParser(
|
|
description="Serve the EVEngine WebGPU build (COOP/COEP)."
|
|
)
|
|
parser.add_argument(
|
|
"engine_dir",
|
|
nargs="?",
|
|
type=Path,
|
|
default=default_dir,
|
|
help="Directory containing eve.html (default: %(default)s)",
|
|
)
|
|
parser.add_argument("port", nargs="?", type=int, default=8090,
|
|
help="Port (default: 8090)")
|
|
args = parser.parse_args()
|
|
|
|
engine_dir = args.engine_dir.resolve()
|
|
if not (engine_dir / "eve.html").is_file():
|
|
print("error: %s does not contain eve.html" % engine_dir)
|
|
print(
|
|
"Build first:\n"
|
|
" emcmake cmake -B build/webgpu-web -G Ninja -DCMAKE_BUILD_TYPE=Release\n"
|
|
" cmake --build build/webgpu-web"
|
|
)
|
|
return 1
|
|
|
|
os.chdir(engine_dir)
|
|
httpd = http.server.ThreadingHTTPServer(("127.0.0.1", args.port), PlaygroundHandler)
|
|
print("Serving %s" % engine_dir)
|
|
print("Open http://127.0.0.1:%d/eve.html in Chrome/Edge 113+ (WebGPU enabled)." % args.port)
|
|
try:
|
|
httpd.serve_forever()
|
|
except KeyboardInterrupt:
|
|
pass
|
|
return 0
|
|
|
|
|
|
if __name__ == "__main__":
|
|
utf8_stdio.enable_utf8_stdio()
|
|
sys.exit(main())
|