docs: correct stale bubblewrap references in v1 spec + live docstring

Janitorial item 6 in 2026-05-15-janitorial-cleanup.md. The v1 sandbox
design (2026-05-08-l4d2-script-overlays-design.md) was approved
2026-05-08 and superseded the same day by the v2 systemd-only design
(2026-05-08-l4d2-script-sandbox-v2-systemd.md). The current
left4me-script-sandbox helper uses systemd-run in service-unit mode;
no bwrap binary is invoked. The v1 spec still described bubblewrap as
the engine.

- v1 spec gets a top-of-file banner pointing at v2 as the supersede.
  Body preserved; the rest of the v1 design (overlay-type unification,
  resource caps, helper auth) is still valid — only the sandbox engine
  changed.
- l4d2web/services/overlay_builders.py: ScriptBuilder docstring
  "bubblewrap + systemd-run" → "hardened systemd-run transient
  service" (the as-built reality).
- scripts/tests/test_script_sandbox.py: stray "/bwrap" in a comment
  cleaned up. Negative regression assertions (`assert "bwrap" not in
  text`) intentionally retained as the guard against accidental
  re-introduction.
- Plan docs left untouched (historical action snapshots).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
mwiegand 2026-05-15 12:12:31 +02:00
parent 160911fbca
commit 8f30dd7754
No known key found for this signature in database
4 changed files with 23 additions and 5 deletions

View file

@ -1,5 +1,14 @@
# L4D2 Script Overlays Design # L4D2 Script Overlays Design
> **Sandbox engine superseded by [`2026-05-08-l4d2-script-sandbox-v2-systemd.md`](2026-05-08-l4d2-script-sandbox-v2-systemd.md).**
> The v1 design below specifies `bubblewrap` + `systemd-run --scope` as the
> sandbox engine. The v2 design (approved 2026-05-08, same day) replaced that
> with `systemd-run` in service-unit mode and dropped `bubblewrap` entirely.
> The current implementation in `scripts/libexec/left4me-script-sandbox`
> follows v2; this v1 design is preserved for archaeology. The rest of the
> design (overlay-type unification, resource caps, helper auth model, etc.)
> still applies — only the sandbox-engine choice changed.
**Goal:** Add a single new overlay type, `script`, that lets users author arbitrary build recipes as bash and runs them inside a `bubblewrap` + `systemd-run --scope` sandbox. The new type subsumes the existing `l4d2center_maps` and `cedapug_maps` managed-globals overlay types, both of which are removed in the same change. After this work the overlay type list is exactly `workshop` (unchanged) and `script` (new). **Goal:** Add a single new overlay type, `script`, that lets users author arbitrary build recipes as bash and runs them inside a `bubblewrap` + `systemd-run --scope` sandbox. The new type subsumes the existing `l4d2center_maps` and `cedapug_maps` managed-globals overlay types, both of which are removed in the same change. After this work the overlay type list is exactly `workshop` (unchanged) and `script` (new).
**Approval status:** User-approved design direction. Implementation proceeds in lockstep with the companion plan at `docs/superpowers/plans/2026-05-08-l4d2-script-overlays.md`. **Approval status:** User-approved design direction. Implementation proceeds in lockstep with the companion plan at `docs/superpowers/plans/2026-05-08-l4d2-script-overlays.md`.

View file

@ -126,7 +126,16 @@ open decision. Three options listed there:
**Action**: pick one as part of the broader deploy-dir-rethink **Action**: pick one as part of the broader deploy-dir-rethink
work, or as an isolated decision now. work, or as an isolated decision now.
### 6. `bubblewrap` references in spec docs ### 6. `bubblewrap` references in spec docs [RESOLVED]
**Resolution**: v1 design spec (`2026-05-08-l4d2-script-overlays-design.md`)
got a top-of-file banner pointing at the v2 spec; body left as-is for
archaeology. Stale docstring in `l4d2web/services/overlay_builders.py`
corrected to "hardened systemd-run transient service." Stray "/bwrap"
in a test comment cleaned up. Plan-doc references left in place
(historical action snapshots).
**What**: `docs/superpowers/specs/2026-05-08-l4d2-script-overlays-design.md` **What**: `docs/superpowers/specs/2026-05-08-l4d2-script-overlays-design.md`
(if it still exists) describes the sandbox as using `bubblewrap`. (if it still exists) describes the sandbox as using `bubblewrap`.

View file

@ -366,9 +366,9 @@ def run_sandboxed_script(
class ScriptBuilder: class ScriptBuilder:
"""Run an arbitrary user-authored bash script against the overlay dir """Run an arbitrary user-authored bash script against the overlay dir
inside a bubblewrap + systemd-run sandbox. The script sees the overlay inside a hardened systemd-run transient service. The script sees the
dir as RW `/overlay` and a curated host RO mount; everything else is overlay dir as RW `/overlay` and a curated host RO mount; everything
isolated. After exit, enforce a 20 GB cap on `du -sb /overlay`.""" else is isolated. After exit, enforce a 20 GB cap on `du -sb /overlay`."""
def build( def build(
self, self,

View file

@ -166,6 +166,6 @@ def test_script_sandbox_helper_dry_run_mode(tmp_path):
# simulates `id -u l4d2-sandbox` resolving to a valid number. # simulates `id -u l4d2-sandbox` resolving to a valid number.
helper_text = SCRIPT_SANDBOX_HELPER.read_text() helper_text = SCRIPT_SANDBOX_HELPER.read_text()
# We can't actually exec this without root + a real sandbox user; just # We can't actually exec this without root + a real sandbox user; just
# verify the dry-run guard short-circuits before systemd-run / bwrap. # verify the dry-run guard short-circuits before systemd-run runs.
assert 'LEFT4ME_SCRIPT_SANDBOX_DRY_RUN' in helper_text assert 'LEFT4ME_SCRIPT_SANDBOX_DRY_RUN' in helper_text
assert 'exit 0' in helper_text assert 'exit 0' in helper_text