Skip to content

Commit af9af34

Browse files
author
DavidQ
committed
PLAN_PR_DEV_CONSOLE_AND_DEBUG_OVERLAY
- defined dev console and debug overlay plan - locked diagnostics, command, and panel contract direction - formalized render ordering and engine mapping boundaries - documented hot reload interaction, validation, and test expectations
1 parent 7060f86 commit af9af34

8 files changed

Lines changed: 693 additions & 110 deletions

docs/dev/CODEX_COMMANDS.md

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,31 +5,25 @@ codex_commands.md
55

66
# CODEX COMMANDS
77

8-
## APPLY_PR_RUNTIME_SCENE_LOADER_AND_HOT_RELOAD
8+
## APPLY_PR_DEV_CONSOLE_AND_DEBUG_OVERLAY
99

10-
MODEL: GPT-5.3-codex
10+
MODEL: GPT-5.4
1111
REASONING: high
1212

1313
COMMAND:
14-
Apply APPLY_PR_RUNTIME_SCENE_LOADER_AND_HOT_RELOAD as a focused implementation PR.
14+
Apply APPLY_PR_DEV_CONSOLE_AND_DEBUG_OVERLAY as a focused implementation PR.
1515

1616
Requirements:
17-
- Implement the approved runtime scene loader and hot reload flow only
18-
- Keep orchestration above engine core; do not pollute engine systems with tool-specific quirks
19-
- Consume existing approved render pipeline/composition contracts rather than inventing new ones
20-
- Preserve deterministic render order
21-
- Add structured validation-aware reload behavior
22-
- Preserve last-known-good scene on reload failure
23-
- Add focused automated tests for load, reload, validation failure, disposal, and repeated reload stability
17+
- Implement only the approved dev console and debug overlay contracts
18+
- Keep diagnostics orchestration above engine core
19+
- Consume approved runtime scene loader and render pipeline contracts
20+
- Preserve deterministic render order with debug overlay last and console surface after overlay
21+
- Add structured validation and failure isolation for adapters, commands, and panels
22+
- Preserve hot reload survival behavior and last-known-good runtime safety
23+
- Add focused tests for contracts, ordering, failure isolation, and reload stability
2424
- Keep changes surgical and architecture-aligned
25-
- Do not introduce destructive runtime-breaking changes unless absolutely required and documented
26-
- Produce repo-structured implementation delta ZIP at:
27-
<project folder>/tmp/APPLY_PR_RUNTIME_SCENE_LOADER_AND_HOT_RELOAD_delta.zip
28-
29-
Expected documentation updates:
30-
- docs/dev/change_summary.txt
31-
- docs/dev/file_tree.txt
32-
- docs/dev/validation_checklist.txt
25+
- Update docs/dev reports after validation
3326

34-
Commit comment source:
35-
- docs/dev/commit_comment.txt
27+
Package:
28+
- Produce repo-structured implementation delta ZIP at:
29+
<project folder>/tmp/APPLY_PR_DEV_CONSOLE_AND_DEBUG_OVERLAY_delta.zip

docs/dev/COMMIT_COMMENT.txt

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1 @@
1-
Toolbox Aid
2-
David Quesenberry
3-
04/05/2026
4-
commit_comment.txt
5-
6-
apply(runtime): implement runtime scene loader and validation-aware hot reload with deterministic ordering and last-known-good fallback
1+
docs: build dev console and debug overlay contract bundle

docs/dev/NEXT_COMMAND.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ David Quesenberry
33
04/05/2026
44
next_command.txt
55

6-
PLAN_PR_DEV_CONSOLE_AND_DEBUG_OVERLAY
6+
APPLY_PR_DEV_CONSOLE_AND_DEBUG_OVERLAY

docs/dev/change_summary.txt

Lines changed: 11 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -3,48 +3,14 @@ David Quesenberry
33
04/05/2026
44
change_summary.txt
55

6-
APPLY_PR_RUNTIME_SCENE_LOADER_AND_HOT_RELOAD summary
7-
8-
Implemented focused runtime orchestration module:
9-
- Added `tools/shared/runtimeSceneLoaderHotReload.js`
10-
- Keeps orchestration above engine core and consumes existing approved render pipeline contracts
11-
- Uses `runRenderContractRuntimePath` for contract validation/normalization/composition/sequencing
12-
- Preserves deterministic runtime domain ordering: parallax -> tilemap -> sprite -> vector -> overlay
13-
14-
Implemented runtime responsibilities:
15-
- `createSceneCompositionLoader` for composition/asset-document contract loading
16-
- `createRuntimeSceneLoader` for deterministic runtime domain assembly
17-
- `createHotReloadCoordinator` for validation-aware reload and scene-state management
18-
- `createWatcherBridge` for change-event normalization and watcher boundary isolation
19-
20-
Implemented reload safety behavior:
21-
- Contract validation is required before applying reload
22-
- Reload rejects invalid changes with structured reports
23-
- Last-known-good runtime scene remains active on reload failure
24-
- Targeted reload domains supported when changed paths map to composition references
25-
- Full reload used for composition changes or unknown path impact
26-
- Replaced domain handles are disposed with guarded error reporting
27-
28-
Implemented focused automated coverage:
29-
- Added `tests/tools/RuntimeSceneLoaderHotReload.test.mjs`
30-
- Covers initial load success
31-
- Covers targeted reload success
32-
- Covers validation failure fallback to last-known-good
33-
- Covers watcher bridge normalization/coalescing behavior
34-
- Covers repeated reload stability and disposal behavior
35-
36-
Test harness integration:
37-
- Updated `tests/run-tests.mjs` to include `RuntimeSceneLoaderHotReload`
38-
39-
Validation:
40-
- `node --check tools/shared/runtimeSceneLoaderHotReload.js`
41-
- `node --check tests/tools/RuntimeSceneLoaderHotReload.test.mjs`
42-
- `node --check tests/run-tests.mjs`
43-
- Targeted test run for `RuntimeSceneLoaderHotReload` passed
44-
- Full suite run passed (`112/112 explicit run() tests passed`)
45-
46-
Scope guardrails honored:
47-
- No engine-core API rewrites
48-
- No tool-specific quirks moved into engine systems
49-
- No unrelated refactors
50-
- Changes remain surgical and architecture-aligned
6+
BUILD_PR_DEV_CONSOLE_AND_DEBUG_OVERLAY summary
7+
8+
- Added docs-only BUILD contract for development console and debug overlay
9+
- Defined formal diagnostics contract with structured error envelope
10+
- Defined command registry contract with deterministic conflict handling and no-eval rule
11+
- Defined overlay panel contract with deterministic ordering and failure isolation
12+
- Locked deterministic render order with debug overlay last and console surface after overlay
13+
- Locked public engine mappings and boundary rules
14+
- Defined hot reload survival rules for diagnostics shell state and duplication prevention
15+
- Defined validation gates and test requirements for future APPLY implementation
16+
- Updated docs/dev command, commit, validation checklist, file tree, and next command artifacts

docs/dev/file_tree.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ David Quesenberry
33
04/05/2026
44
file_tree.txt
55

6-
tools/shared/runtimeSceneLoaderHotReload.js
7-
tests/tools/RuntimeSceneLoaderHotReload.test.mjs
8-
tests/run-tests.mjs
6+
docs/pr/BUILD_PR_DEV_CONSOLE_AND_DEBUG_OVERLAY.md
7+
docs/dev/codex_commands.md
8+
docs/dev/commit_comment.txt
99
docs/dev/change_summary.txt
10-
docs/dev/file_tree.txt
1110
docs/dev/validation_checklist.txt
12-
docs/dev/commit_comment.txt
11+
docs/dev/file_tree.txt
12+
docs/dev/next_command.txt

docs/dev/validation_checklist.txt

Lines changed: 14 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -3,37 +3,18 @@ David Quesenberry
33
04/05/2026
44
validation_checklist.txt
55

6-
APPLY_PR_RUNTIME_SCENE_LOADER_AND_HOT_RELOAD validation checklist
6+
BUILD_PR_DEV_CONSOLE_AND_DEBUG_OVERLAY validation checklist
77

8-
Runtime scene loader and hot reload flow
9-
[x] Runtime scene loader orchestration implemented above engine core
10-
[x] Existing approved render/composition contract runtime path is consumed
11-
[x] Deterministic runtime domain ordering preserved
12-
[x] Structured validation-aware reload behavior implemented
13-
[x] Last-known-good scene preserved on reload failure
14-
[x] Composition-driven targeted/full reload decision rules implemented
15-
16-
Watcher bridge boundaries
17-
[x] Watcher bridge normalizes project-relative path events
18-
[x] Watcher bridge remains orchestration boundary and does not own scene assembly
19-
[x] Watcher events can be coalesced by path before reload application
20-
21-
Automated tests
22-
[x] Load success test added
23-
[x] Reload success test added
24-
[x] Validation failure fallback test added
25-
[x] Disposal behavior test added
26-
[x] Repeated reload stability test added
27-
[x] New test wired into `tests/run-tests.mjs`
28-
29-
Execution evidence
30-
[x] `node --check tools/shared/runtimeSceneLoaderHotReload.js`
31-
[x] `node --check tests/tools/RuntimeSceneLoaderHotReload.test.mjs`
32-
[x] `node --check tests/run-tests.mjs`
33-
[x] Targeted runtime scene loader/hot reload test run passed
34-
[x] Full test suite passed (`112/112 explicit run() tests passed`)
35-
36-
Scope safety
37-
[x] No destructive runtime-breaking changes introduced
38-
[x] No unrelated sample/game/tool refactors introduced
39-
[x] Changes kept focused to approved APPLY scope
8+
[x] Bundle is docs-only
9+
[x] No implementation code included
10+
[x] Workflow preserved: PLAN_PR -> BUILD_PR -> APPLY_PR
11+
[x] Diagnostics contract defined
12+
[x] Command registry contract defined
13+
[x] Overlay panel contract defined
14+
[x] Deterministic render order defined with debug overlay last
15+
[x] Engine mappings locked to public adapters only
16+
[x] Hot reload survival rules defined
17+
[x] Validation and test requirements defined
18+
[x] `docs/dev/commit_comment.txt` has no file header
19+
[x] Command and commit artifacts are in docs/dev
20+
[x] Repo-relative bundle structure preserved

0 commit comments

Comments
 (0)