VibecoderMcSwaggins commited on
Commit
332c22e
Β·
1 Parent(s): 45bec41

docs(spec): Clarify Phase 2 sequence and mark smoke tests as PLANNED

Browse files

- Add implementation status note for smoke tests (PLANNED, not implemented)
- Define Phase 2 PR sequence: Smoke Tests FIRST, then Priorities 4-7
- Mark Appendix as historical with status column for refactored items
- Ensures regression testing infrastructure exists before further refactors

Files changed (1) hide show
  1. SPEC_ARCHITECTURAL_DEBT.md +36 -12
SPEC_ARCHITECTURAL_DEBT.md CHANGED
@@ -230,6 +230,10 @@ class WorkflowState:
230
 
231
  **CRITICAL**: Each phase MUST pass smoke tests before merge. Unit tests alone are insufficient.
232
 
 
 
 
 
233
  ### Smoke Test Infrastructure
234
 
235
  Add to `Makefile`:
@@ -339,17 +343,37 @@ Implement **Priority 1, 2, and 3** before merging PR #124.
339
  ### Phase 2: Future PRs (Separate Tickets)
340
  Create GitHub issues for Priority 4-8. Do NOT bloat the current bug fix PR.
341
 
 
 
 
 
 
 
 
 
 
 
 
 
 
342
  ---
343
 
344
- ## Appendix: Line Number Reference
345
-
346
- | Item | Current Location |
347
- |------|------------------|
348
- | `_handle_timeout()` | Lines 201-248 |
349
- | `_force_synthesis()` | Lines 250-297 |
350
- | Redundant imports (timeout) | Lines 207-208 |
351
- | Redundant imports (force) | Lines 257-258 |
352
- | Magic string detection | Line 385 |
353
- | `_get_event_type_for_agent()` | Lines 582-602 |
354
- | Module imports | Lines 18-48 |
355
- | `run()` method | Lines 299-456 |
 
 
 
 
 
 
 
 
230
 
231
  **CRITICAL**: Each phase MUST pass smoke tests before merge. Unit tests alone are insufficient.
232
 
233
+ > **Implementation Status**: PLANNED (Part of Priority 8)
234
+ > The smoke tests below are documented but NOT YET IMPLEMENTED.
235
+ > They should be created as a prerequisite before starting Priority 4-8 refactors.
236
+
237
  ### Smoke Test Infrastructure
238
 
239
  Add to `Makefile`:
 
343
  ### Phase 2: Future PRs (Separate Tickets)
344
  Create GitHub issues for Priority 4-8. Do NOT bloat the current bug fix PR.
345
 
346
+ **IMPORTANT**: Before starting ANY Priority 4-7 refactors, FIRST implement Priority 8 (Smoke Tests).
347
+ This ensures we can detect regressions from refactoring. Sequence:
348
+
349
+ 1. **PR: Smoke Test Infrastructure** (Priority 8) - MUST BE FIRST
350
+ - Create `tests/e2e/test_smoke.py`
351
+ - Add `make smoke-free` and `make smoke-paid` to Makefile
352
+ - Verify both Free Tier and Paid Tier produce synthesis
353
+
354
+ 2. **PR: Dead Config Cleanup** (Priority 4)
355
+ 3. **PR: Prompt Unification** (Priority 5)
356
+ 4. **PR: Factory Registry Pattern** (Priority 6)
357
+ 5. **PR: WorkflowState Dataclass** (Priority 7)
358
+
359
  ---
360
 
361
+ ## Appendix: Line Number Reference (Historical)
362
+
363
+ > **Note**: These line numbers were from BEFORE Phase 1 refactoring.
364
+ > After PR #124 merge, the following methods were consolidated:
365
+ > - `_handle_timeout()` β†’ DELETED (merged into `_synthesize_fallback`)
366
+ > - `_force_synthesis()` β†’ DELETED (merged into `_synthesize_fallback`)
367
+ > - Redundant imports β†’ REMOVED (centralized at module level)
368
+ > - Magic strings β†’ REPLACED with constants
369
+
370
+ | Item (Pre-Refactor) | Original Location | Status |
371
+ |---------------------|-------------------|--------|
372
+ | `_handle_timeout()` | Lines 201-248 | DELETED |
373
+ | `_force_synthesis()` | Lines 250-297 | DELETED |
374
+ | Redundant imports (timeout) | Lines 207-208 | REMOVED |
375
+ | Redundant imports (force) | Lines 257-258 | REMOVED |
376
+ | Magic string detection | Line 385 | REFACTORED |
377
+ | `_get_event_type_for_agent()` | Lines 582-602 | REFACTORED |
378
+ | Module imports | Lines 18-48 | UPDATED |
379
+ | `run()` method | Lines 299-456 | UPDATED |