chore: archive v1.1 phase directories to milestones
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Claude Opus 4.6
@@ -0,0 +1,216 @@
|
||||
---
|
||||
phase: 05-waveform-types-and-bank-decoupling
|
||||
plan: 01
|
||||
type: execute
|
||||
wave: 1
|
||||
depends_on: []
|
||||
files_modified:
|
||||
- synth/config.go
|
||||
- synth/layer.go
|
||||
- synth/waveform_test.go
|
||||
autonomous: true
|
||||
requirements:
|
||||
- WAVE-01
|
||||
- WAVE-02
|
||||
|
||||
must_haves:
|
||||
truths:
|
||||
- "WaveformType enum exists with five values: WaveformCustom (0), WaveformSine, WaveformSquare, WaveformSawtooth, WaveformTriangle"
|
||||
- "WaveformPresetHarmonics returns correct bandlimited harmonic series for each waveform type"
|
||||
- "All generated partials are below Nyquist frequency (22050 Hz)"
|
||||
- "WaveformCustom returns nil, preserving existing hand-tuned harmonics"
|
||||
- "NewLayer resolves waveform presets at construction time, not at render time"
|
||||
- "Existing tests still pass — no regression in v1.0 behavior"
|
||||
artifacts:
|
||||
- path: "synth/config.go"
|
||||
provides: "WaveformType enum and WaveformPresetHarmonics function"
|
||||
contains: "WaveformType"
|
||||
exports: ["WaveformType", "WaveformCustom", "WaveformSine", "WaveformSquare", "WaveformSawtooth", "WaveformTriangle", "WaveformPresetHarmonics"]
|
||||
- path: "synth/layer.go"
|
||||
provides: "Waveform resolution in NewLayer"
|
||||
contains: "WaveformPresetHarmonics"
|
||||
- path: "synth/waveform_test.go"
|
||||
provides: "Tests for waveform preset generation and bandlimiting"
|
||||
key_links:
|
||||
- from: "synth/layer.go"
|
||||
to: "synth/config.go"
|
||||
via: "NewLayer calls WaveformPresetHarmonics when cfg.WaveformType != WaveformCustom"
|
||||
pattern: "WaveformPresetHarmonics\\(cfg\\.WaveformType"
|
||||
---
|
||||
|
||||
<objective>
|
||||
Add four waveform types (sine, square, sawtooth, triangle) to the synthesis engine using bandlimited additive synthesis.
|
||||
|
||||
Purpose: Enables per-traffic-class waveform selection (WAVE-01) with aliasing-free generation (WAVE-02). This is the foundation that Phase 6 config loading will expose to users.
|
||||
Output: WaveformType enum, WaveformPresetHarmonics() function, NewLayer waveform resolution, and comprehensive tests.
|
||||
</objective>
|
||||
|
||||
<execution_context>
|
||||
@$HOME/.claude/get-shit-done/workflows/execute-plan.md
|
||||
@$HOME/.claude/get-shit-done/templates/summary.md
|
||||
</execution_context>
|
||||
|
||||
<context>
|
||||
@.planning/PROJECT.md
|
||||
@.planning/ROADMAP.md
|
||||
@.planning/STATE.md
|
||||
@.planning/phases/05-waveform-types-and-bank-decoupling/05-CONTEXT.md
|
||||
@.planning/phases/05-waveform-types-and-bank-decoupling/05-RESEARCH.md
|
||||
|
||||
@synth/config.go
|
||||
@synth/layer.go
|
||||
@synth/oscillator.go
|
||||
|
||||
<interfaces>
|
||||
<!-- Key types and contracts the executor needs. Extracted from codebase. -->
|
||||
|
||||
From synth/config.go:
|
||||
```go
|
||||
type HarmonicDef struct {
|
||||
Ratio int
|
||||
Amplitude float64
|
||||
}
|
||||
|
||||
type FreqConfig struct {
|
||||
BaseHz float64
|
||||
Harmonics []HarmonicDef
|
||||
Pan float64
|
||||
}
|
||||
|
||||
const SampleRate = 44100
|
||||
```
|
||||
|
||||
From synth/oscillator.go:
|
||||
```go
|
||||
func (o *Oscillator) Advance(harmonics []HarmonicDef) float64
|
||||
```
|
||||
|
||||
From synth/layer.go:
|
||||
```go
|
||||
func NewLayer(cfg FreqConfig, sampleRate int, tau float64) *Layer
|
||||
func (l *Layer) AdvanceSample() float64 // calls l.Osc.Advance(l.Config.Harmonics)
|
||||
```
|
||||
</interfaces>
|
||||
</context>
|
||||
|
||||
<tasks>
|
||||
|
||||
<task type="auto" tdd="true">
|
||||
<name>Task 1: Add WaveformType enum and WaveformPresetHarmonics function</name>
|
||||
<files>synth/config.go, synth/waveform_test.go</files>
|
||||
<read_first>synth/config.go, synth/oscillator.go, synth/layer.go</read_first>
|
||||
<behavior>
|
||||
- TestWaveformPresetHarmonics_Sine: WaveformPresetHarmonics(WaveformSine, 440.0, 44100) returns exactly []HarmonicDef{{Ratio: 1, Amplitude: 1.0}}
|
||||
- TestWaveformPresetHarmonics_Square: WaveformPresetHarmonics(WaveformSquare, 440.0, 44100) returns odd harmonics (1,3,5,...) with amplitude 1/k, all below Nyquist
|
||||
- TestWaveformPresetHarmonics_Sawtooth: WaveformPresetHarmonics(WaveformSawtooth, 440.0, 44100) returns all harmonics (1,2,3,...) with amplitude 1/k, all below Nyquist
|
||||
- TestWaveformPresetHarmonics_Triangle: WaveformPresetHarmonics(WaveformTriangle, 440.0, 44100) returns odd harmonics with alternating sign and 1/k^2 amplitude, all below Nyquist
|
||||
- TestWaveformPresetHarmonics_Custom: WaveformPresetHarmonics(WaveformCustom, 440.0, 44100) returns nil
|
||||
- TestBandlimitedHarmonicsNoAliasing: For each non-custom waveform type, at every ClassFreqConfigs base frequency, no harmonic's Ratio*baseHz exceeds 22050
|
||||
- TestWaveformPresetHarmonics_SquareOddOnly: All returned ratios for square are odd numbers
|
||||
- TestWaveformPresetHarmonics_TriangleOddOnly: All returned ratios for triangle are odd numbers
|
||||
- TestWaveformPresetHarmonics_SawtoothConsecutive: Returned ratios for sawtooth are consecutive integers starting at 1
|
||||
</behavior>
|
||||
<action>
|
||||
Per D-01 and D-02, add to synth/config.go:
|
||||
|
||||
1. Define WaveformType as `type WaveformType int` with five constants:
|
||||
```go
|
||||
const (
|
||||
WaveformCustom WaveformType = iota // zero value: use FreqConfig.Harmonics as-is
|
||||
WaveformSine
|
||||
WaveformSquare
|
||||
WaveformSawtooth
|
||||
WaveformTriangle
|
||||
)
|
||||
```
|
||||
|
||||
2. Add `WaveformType WaveformType` field to the `FreqConfig` struct (after Pan). Zero value is WaveformCustom, so all existing ClassFreqConfigs entries automatically use their hand-tuned harmonics (per D-03).
|
||||
|
||||
3. Add function `WaveformPresetHarmonics(wt WaveformType, baseHz float64, sampleRate int) []HarmonicDef`:
|
||||
- WaveformCustom: return nil
|
||||
- WaveformSine: return `[]HarmonicDef{{Ratio: 1, Amplitude: 1.0}}`
|
||||
- WaveformSquare: loop `k := 1; float64(k)*baseHz < nyquist; k += 2` — append `HarmonicDef{Ratio: k, Amplitude: 1.0 / float64(k)}`
|
||||
- WaveformSawtooth: loop `k := 1; float64(k)*baseHz < nyquist; k++` — append `HarmonicDef{Ratio: k, Amplitude: 1.0 / float64(k)}`
|
||||
- WaveformTriangle: loop `k := 1; float64(k)*baseHz < nyquist; k += 2` with alternating sign — append `HarmonicDef{Ratio: k, Amplitude: sign / float64(k*k)}`, then `sign = -sign` (start `sign := 1.0`)
|
||||
- Nyquist is `float64(sampleRate) / 2.0`
|
||||
|
||||
4. Do NOT modify ClassFreqConfigs entries — they retain their hand-tuned harmonics with the default WaveformCustom zero value (per D-03).
|
||||
|
||||
5. Create synth/waveform_test.go (package synth_test) with all tests from the behavior block. Use `synth.WaveformPresetHarmonics(...)` calls. The bandlimit test should iterate all ClassFreqConfigs entries, call WaveformPresetHarmonics for each of {WaveformSine, WaveformSquare, WaveformSawtooth, WaveformTriangle} with that entry's BaseHz, and assert `float64(h.Ratio) * baseHz < 22050.0` for every returned HarmonicDef.
|
||||
</action>
|
||||
<verify>
|
||||
<automated>cd /home/dev/workspace/yoloyolo && go test ./synth/... -run "TestWaveformPreset|TestBandlimited" -v</automated>
|
||||
</verify>
|
||||
<acceptance_criteria>
|
||||
- synth/config.go contains `type WaveformType int`
|
||||
- synth/config.go contains `WaveformCustom WaveformType = iota`
|
||||
- synth/config.go contains `WaveformSine`, `WaveformSquare`, `WaveformSawtooth`, `WaveformTriangle`
|
||||
- synth/config.go contains `func WaveformPresetHarmonics(wt WaveformType, baseHz float64, sampleRate int) []HarmonicDef`
|
||||
- FreqConfig struct contains `WaveformType WaveformType`
|
||||
- synth/waveform_test.go exists and contains `TestWaveformPresetHarmonics` and `TestBandlimitedHarmonicsNoAliasing`
|
||||
- `go test ./synth/... -run "TestWaveformPreset|TestBandlimited"` exits 0
|
||||
- `go test ./synth/...` exits 0 (no regression in existing tests)
|
||||
</acceptance_criteria>
|
||||
<done>WaveformType enum exported with 5 values, WaveformPresetHarmonics generates correct bandlimited series for all 4 waveform types, returns nil for WaveformCustom, all tests pass including existing suite</done>
|
||||
</task>
|
||||
|
||||
<task type="auto">
|
||||
<name>Task 2: Wire waveform resolution into NewLayer</name>
|
||||
<files>synth/layer.go, synth/waveform_test.go</files>
|
||||
<read_first>synth/layer.go, synth/config.go, synth/waveform_test.go</read_first>
|
||||
<action>
|
||||
Per D-02 and research Pattern 2, modify `NewLayer` in synth/layer.go to resolve waveform presets at construction time:
|
||||
|
||||
1. In `NewLayer(cfg FreqConfig, sampleRate int, tau float64) *Layer`, add waveform resolution BEFORE creating the Layer. Insert at the top of the function:
|
||||
```go
|
||||
if cfg.WaveformType != WaveformCustom {
|
||||
cfg.Harmonics = WaveformPresetHarmonics(cfg.WaveformType, cfg.BaseHz, sampleRate)
|
||||
}
|
||||
```
|
||||
This overwrites cfg.Harmonics (the local copy, not the original) with the bandlimited preset. The rest of NewLayer is unchanged — it stores cfg in `Layer.Config`, so `AdvanceSample` calls `l.Osc.Advance(l.Config.Harmonics)` with the resolved harmonics.
|
||||
|
||||
2. Add two tests to synth/waveform_test.go:
|
||||
|
||||
`TestNewLayerResolvesWaveformPreset`: Create a `synth.FreqConfig{BaseHz: 440.0, WaveformType: synth.WaveformSquare}` with empty Harmonics. Call `synth.NewLayer(cfg, synth.SampleRate, 1.0)`. Assert the returned layer's `Config.Harmonics` has length > 1 (preset was resolved). Verify the first harmonic has Ratio=1.
|
||||
|
||||
`TestNewLayerPreservesCustomHarmonics`: Create a `synth.FreqConfig{BaseHz: 440.0, Harmonics: []synth.HarmonicDef{{Ratio: 1, Amplitude: 1.0}, {Ratio: 2, Amplitude: 0.4}}}` with WaveformType left at zero (WaveformCustom). Call `synth.NewLayer(cfg, synth.SampleRate, 1.0)`. Assert harmonics length is exactly 2 and second harmonic Amplitude is 0.4.
|
||||
|
||||
`TestSineRegressionVsCustomHarmonics`: Create two layers — one with `WaveformType: synth.WaveformSine` and empty Harmonics, one with `WaveformType: synth.WaveformCustom` and `Harmonics: []synth.HarmonicDef{{Ratio: 1, Amplitude: 1.0}}`. Advance both 100 samples (calling layer.AdvanceSample on each). Assert samples are identical (both are pure sine at same frequency). Use a target amplitude of 1.0 by calling UpdateTarget(1, 1) first.
|
||||
|
||||
Note: The Layer struct fields Config, Osc are exported (capital first letter), so external tests (package synth_test) can access them. However AdvanceSample needs the layer to have a non-zero amplitude — call `layer.UpdateTarget(1, 1)` before advancing to set target to whisper+rate level, then advance enough samples for EMA to converge, OR use a very small tau like 0.001 for fast convergence in tests.
|
||||
</action>
|
||||
<verify>
|
||||
<automated>cd /home/dev/workspace/yoloyolo && go test ./synth/... -v -count=1</automated>
|
||||
</verify>
|
||||
<acceptance_criteria>
|
||||
- synth/layer.go NewLayer function contains `if cfg.WaveformType != WaveformCustom`
|
||||
- synth/layer.go NewLayer function contains `WaveformPresetHarmonics(cfg.WaveformType, cfg.BaseHz, sampleRate)`
|
||||
- synth/waveform_test.go contains `TestNewLayerResolvesWaveformPreset`
|
||||
- synth/waveform_test.go contains `TestNewLayerPreservesCustomHarmonics`
|
||||
- synth/waveform_test.go contains `TestSineRegressionVsCustomHarmonics`
|
||||
- `go test ./synth/...` exits 0 (all existing tests still pass)
|
||||
</acceptance_criteria>
|
||||
<done>NewLayer resolves waveform presets at construction time. Custom harmonics are preserved when WaveformType is zero. Sine preset produces identical output to single-harmonic custom config. All tests pass.</done>
|
||||
</task>
|
||||
|
||||
</tasks>
|
||||
|
||||
<verification>
|
||||
- `go test ./synth/... -v` — all tests pass, including new waveform tests and all existing tests
|
||||
- `go test ./encode/...` — encode package still compiles and passes (no changes to it in this plan)
|
||||
- `go vet ./synth/...` — no warnings
|
||||
</verification>
|
||||
|
||||
<success_criteria>
|
||||
- WaveformType enum with 5 values is exported from synth package
|
||||
- WaveformPresetHarmonics produces correct harmonic series for all 4 waveform types
|
||||
- All generated harmonics are below Nyquist (no aliasing)
|
||||
- WaveformCustom preserves existing hand-tuned harmonics
|
||||
- NewLayer resolves presets at construction time (not render time)
|
||||
- Sine waveform preset produces identical output to v1.0 single-harmonic custom
|
||||
- All existing synth and encode tests pass without modification
|
||||
</success_criteria>
|
||||
|
||||
<output>
|
||||
After completion, create `.planning/phases/05-waveform-types-and-bank-decoupling/05-01-SUMMARY.md`
|
||||
</output>
|
||||
+78
@@ -0,0 +1,78 @@
|
||||
---
|
||||
phase: 05-waveform-types-and-bank-decoupling
|
||||
plan: "01"
|
||||
subsystem: synth
|
||||
tags: [waveform, additive-synthesis, bandlimiting, enum, tdd]
|
||||
dependency_graph:
|
||||
requires: []
|
||||
provides: [WaveformType enum, WaveformPresetHarmonics, NewLayer waveform resolution]
|
||||
affects: [synth/config.go, synth/layer.go]
|
||||
tech_stack:
|
||||
added: []
|
||||
patterns: [TDD red-green, bandlimited additive synthesis, zero-value backward compat]
|
||||
key_files:
|
||||
created:
|
||||
- synth/waveform_test.go
|
||||
modified:
|
||||
- synth/config.go
|
||||
- synth/layer.go
|
||||
decisions:
|
||||
- "ClassFreqConfigs converted from positional to named struct literals (required by new WaveformType field)"
|
||||
- "FreqConfig.WaveformType zero value is WaveformCustom, ensuring all existing entries auto-preserve hand-tuned harmonics"
|
||||
metrics:
|
||||
duration: "~3 min"
|
||||
completed_date: "2026-03-26"
|
||||
tasks: 2
|
||||
files: 3
|
||||
requirements:
|
||||
- WAVE-01
|
||||
- WAVE-02
|
||||
---
|
||||
|
||||
# Phase 5 Plan 01: Waveform Types and WaveformPresetHarmonics Summary
|
||||
|
||||
WaveformType enum with four bandlimited presets (sine, square, sawtooth, triangle) added to synth package with construction-time resolution in NewLayer.
|
||||
|
||||
## What Was Built
|
||||
|
||||
- **`WaveformType int` enum** in `synth/config.go` with five constants: `WaveformCustom` (0), `WaveformSine`, `WaveformSquare`, `WaveformSawtooth`, `WaveformTriangle`
|
||||
- **`WaveformPresetHarmonics(wt, baseHz, sampleRate)`** function that generates bandlimited harmonic series — all partials below Nyquist (sampleRate/2)
|
||||
- **`FreqConfig.WaveformType` field** added; zero value `WaveformCustom` ensures full backward compatibility with all 14 existing `ClassFreqConfigs` entries
|
||||
- **`NewLayer` waveform resolution** — presets resolved at construction time, stored in `Layer.Config.Harmonics`, so `AdvanceSample` requires no changes
|
||||
- **`synth/waveform_test.go`** with 12 tests covering all preset shapes, bandlimit enforcement, odd-only ratios, consecutive ratios, nil return for Custom, regression vs hand-tuned harmonics, and NewLayer construction behavior
|
||||
|
||||
## Tasks Completed
|
||||
|
||||
| Task | Description | Commit | Files |
|
||||
|------|-------------|--------|-------|
|
||||
| 1 (RED) | Failing waveform tests | 88dee31 | synth/waveform_test.go |
|
||||
| 1 (GREEN) | WaveformType enum + WaveformPresetHarmonics | 82d1e37 | synth/config.go |
|
||||
| 2 | Wire waveform resolution into NewLayer + 3 more tests | 7f64714 | synth/layer.go, synth/waveform_test.go |
|
||||
|
||||
## Verification
|
||||
|
||||
- `go test ./synth/... -v`: 41 tests, all pass (28 existing + 12 new waveform + 1 regression)
|
||||
- `go test ./encode/...`: 3 tests pass (no regressions)
|
||||
- `go vet ./synth/...`: clean
|
||||
|
||||
## Deviations from Plan
|
||||
|
||||
### Auto-fixed Issues
|
||||
|
||||
**1. [Rule 1 - Bug] ClassFreqConfigs positional struct literals broken by new field**
|
||||
- **Found during:** Task 1 GREEN phase
|
||||
- **Issue:** Adding `WaveformType WaveformType` field to `FreqConfig` caused compile errors on all 14 positional struct literals in `ClassFreqConfigs` ("too few values in struct literal")
|
||||
- **Fix:** Converted all 14 entries from positional `{65.0, []HarmonicDef{...}, 0.0}` syntax to named field `{BaseHz: 65.0, Harmonics: []HarmonicDef{...}, Pan: 0.0}` syntax. WaveformType field implicitly zero (WaveformCustom), preserving hand-tuned harmonics as per D-03.
|
||||
- **Files modified:** synth/config.go (ClassFreqConfigs block)
|
||||
- **Commit:** 82d1e37
|
||||
|
||||
## Known Stubs
|
||||
|
||||
None — all waveform preset logic is fully implemented and wired.
|
||||
|
||||
## Self-Check: PASSED
|
||||
|
||||
- synth/waveform_test.go: FOUND
|
||||
- synth/config.go (WaveformType): FOUND (verified by go test passing)
|
||||
- synth/layer.go (NewLayer resolution): FOUND (verified by TestNewLayerResolvesWaveformPreset)
|
||||
- Commits 88dee31, 82d1e37, 7f64714: all present in git log
|
||||
@@ -0,0 +1,350 @@
|
||||
---
|
||||
phase: 05-waveform-types-and-bank-decoupling
|
||||
plan: 02
|
||||
type: execute
|
||||
wave: 2
|
||||
depends_on:
|
||||
- "05-01"
|
||||
files_modified:
|
||||
- synth/bank.go
|
||||
- synth/bank_test.go
|
||||
- synth/config_test.go
|
||||
- encode/mp3.go
|
||||
autonomous: true
|
||||
requirements:
|
||||
- WAVE-01
|
||||
- WAVE-02
|
||||
|
||||
must_haves:
|
||||
truths:
|
||||
- "NewBank accepts a config map parameter instead of reading the ClassFreqConfigs global"
|
||||
- "GainPerLayer is computed dynamically as 1.0/len(configs) inside NewBank"
|
||||
- "RenderWindow iterates b.layers instead of classify.AllClasses() in both loops"
|
||||
- "encode.RunSynthesis passes synth.ClassFreqConfigs as the default config map"
|
||||
- "All 14 built-in classes still produce the same audio output as v1.0"
|
||||
- "No-clip guarantee holds with dynamic gain scaling"
|
||||
artifacts:
|
||||
- path: "synth/bank.go"
|
||||
provides: "Decoupled OscillatorBank with injected config map"
|
||||
contains: "gainPerLayer"
|
||||
exports: ["NewBank", "OscillatorBank", "RenderWindow"]
|
||||
- path: "encode/mp3.go"
|
||||
provides: "Updated NewBank call site"
|
||||
contains: "synth.ClassFreqConfigs"
|
||||
- path: "synth/bank_test.go"
|
||||
provides: "Updated tests for new NewBank signature"
|
||||
- path: "synth/config_test.go"
|
||||
provides: "Updated TestNumLayersMatchesAllClasses"
|
||||
key_links:
|
||||
- from: "encode/mp3.go"
|
||||
to: "synth/bank.go"
|
||||
via: "synth.NewBank(1.0, synth.ClassFreqConfigs)"
|
||||
pattern: "NewBank\\(1\\.0,\\s*synth\\.ClassFreqConfigs\\)"
|
||||
- from: "synth/bank.go"
|
||||
to: "synth/layer.go"
|
||||
via: "NewLayer(cfg, SampleRate, tau) for each config map entry"
|
||||
pattern: "NewLayer\\(cfg,\\s*SampleRate"
|
||||
- from: "synth/bank.go"
|
||||
to: "synth/config.go"
|
||||
via: "gainPerLayer computed from len(cfgs)"
|
||||
pattern: "1\\.0\\s*/\\s*float64\\(len\\("
|
||||
---
|
||||
|
||||
<objective>
|
||||
Decouple OscillatorBank from the global ClassFreqConfigs variable and fix GainPerLayer to be dynamic.
|
||||
|
||||
Purpose: Creates the injection seam for Phase 6 config loading (D-05) and fixes gain scaling for variable class counts (D-04). After this plan, NewBank accepts any config map — not just the hardcoded 14 built-in classes.
|
||||
Output: Updated bank.go with new NewBank signature, updated encode/mp3.go call site, updated tests.
|
||||
</objective>
|
||||
|
||||
<execution_context>
|
||||
@$HOME/.claude/get-shit-done/workflows/execute-plan.md
|
||||
@$HOME/.claude/get-shit-done/templates/summary.md
|
||||
</execution_context>
|
||||
|
||||
<context>
|
||||
@.planning/PROJECT.md
|
||||
@.planning/ROADMAP.md
|
||||
@.planning/STATE.md
|
||||
@.planning/phases/05-waveform-types-and-bank-decoupling/05-CONTEXT.md
|
||||
@.planning/phases/05-waveform-types-and-bank-decoupling/05-RESEARCH.md
|
||||
@.planning/phases/05-waveform-types-and-bank-decoupling/05-01-SUMMARY.md
|
||||
|
||||
@synth/bank.go
|
||||
@synth/bank_test.go
|
||||
@synth/config_test.go
|
||||
@encode/mp3.go
|
||||
|
||||
<interfaces>
|
||||
<!-- Key types and contracts from Plan 01 output -->
|
||||
|
||||
From synth/config.go (after Plan 01):
|
||||
```go
|
||||
type WaveformType int
|
||||
|
||||
const (
|
||||
WaveformCustom WaveformType = iota
|
||||
WaveformSine
|
||||
WaveformSquare
|
||||
WaveformSawtooth
|
||||
WaveformTriangle
|
||||
)
|
||||
|
||||
type FreqConfig struct {
|
||||
BaseHz float64
|
||||
Harmonics []HarmonicDef
|
||||
Pan float64
|
||||
WaveformType WaveformType
|
||||
}
|
||||
|
||||
func WaveformPresetHarmonics(wt WaveformType, baseHz float64, sampleRate int) []HarmonicDef
|
||||
|
||||
var ClassFreqConfigs = map[classify.TrafficClass]FreqConfig{ ... } // 14 entries, all WaveformCustom
|
||||
```
|
||||
|
||||
From synth/layer.go (after Plan 01):
|
||||
```go
|
||||
func NewLayer(cfg FreqConfig, sampleRate int, tau float64) *Layer
|
||||
// Now resolves WaveformPresetHarmonics at construction if cfg.WaveformType != WaveformCustom
|
||||
```
|
||||
|
||||
From classify package:
|
||||
```go
|
||||
type TrafficClass string
|
||||
type WindowSnapshot struct {
|
||||
Counts map[TrafficClass]int64
|
||||
TotalPackets int64
|
||||
WindowIndex int
|
||||
}
|
||||
func AllClasses() []TrafficClass
|
||||
```
|
||||
</interfaces>
|
||||
</context>
|
||||
|
||||
<tasks>
|
||||
|
||||
<task type="auto">
|
||||
<name>Task 1: Decouple NewBank and fix GainPerLayer</name>
|
||||
<files>synth/bank.go, encode/mp3.go</files>
|
||||
<read_first>synth/bank.go, synth/config.go, encode/mp3.go, synth/layer.go</read_first>
|
||||
<action>
|
||||
Per D-04 and D-05, refactor bank.go and update the single caller in encode/mp3.go:
|
||||
|
||||
1. In synth/bank.go, add `gainPerLayer float64` field to `OscillatorBank` struct:
|
||||
```go
|
||||
type OscillatorBank struct {
|
||||
layers map[classify.TrafficClass]*Layer
|
||||
tau float64
|
||||
gainPerLayer float64
|
||||
}
|
||||
```
|
||||
|
||||
2. Change `NewBank` signature from `NewBank(tau float64)` to `NewBank(tau float64, cfgs map[classify.TrafficClass]FreqConfig)`:
|
||||
```go
|
||||
func NewBank(tau float64, cfgs map[classify.TrafficClass]FreqConfig) *OscillatorBank {
|
||||
b := &OscillatorBank{
|
||||
layers: make(map[classify.TrafficClass]*Layer, len(cfgs)),
|
||||
tau: tau,
|
||||
gainPerLayer: 1.0 / float64(len(cfgs)),
|
||||
}
|
||||
for class, cfg := range cfgs {
|
||||
b.layers[class] = NewLayer(cfg, SampleRate, tau)
|
||||
}
|
||||
return b
|
||||
}
|
||||
```
|
||||
Key changes: iterate `cfgs` (not `classify.AllClasses()`), compute `gainPerLayer` dynamically from `len(cfgs)` (per D-04).
|
||||
|
||||
3. Update `RenderWindow` method — change BOTH loops from `classify.AllClasses()` to `b.layers`:
|
||||
|
||||
Loop 1 (UpdateTarget): Change from:
|
||||
```go
|
||||
for _, class := range classify.AllClasses() {
|
||||
count := snap.Counts[class]
|
||||
b.layers[class].UpdateTarget(count, maxCount)
|
||||
}
|
||||
```
|
||||
To:
|
||||
```go
|
||||
for class, layer := range b.layers {
|
||||
count := snap.Counts[class]
|
||||
layer.UpdateTarget(count, maxCount)
|
||||
}
|
||||
```
|
||||
|
||||
Loop 2 (Render): Change from:
|
||||
```go
|
||||
for _, class := range classify.AllClasses() {
|
||||
layer := b.layers[class]
|
||||
sample := layer.AdvanceSample()
|
||||
gainL, gainR := PanGains(layer.Config.Pan)
|
||||
sumL += sample * GainPerLayer * gainL
|
||||
sumR += sample * GainPerLayer * gainR
|
||||
}
|
||||
```
|
||||
To:
|
||||
```go
|
||||
for _, layer := range b.layers {
|
||||
sample := layer.AdvanceSample()
|
||||
gainL, gainR := PanGains(layer.Config.Pan)
|
||||
sumL += sample * b.gainPerLayer * gainL
|
||||
sumR += sample * b.gainPerLayer * gainR
|
||||
}
|
||||
```
|
||||
Note: use `b.gainPerLayer` (the instance field) NOT the package constant `GainPerLayer`.
|
||||
|
||||
4. Update the `RenderWindow` doc comment to remove "Per D-10: each layer gets GainPerLayer (1/11)" — replace with "Each layer gets 1/N of the total gain where N is the number of layers."
|
||||
|
||||
5. Remove the `classify` import from bank.go ONLY IF it is no longer used. After the changes, `classify.TrafficClass` is still used in the `cfgs` parameter type and `b.layers` map type, and `classify.WindowSnapshot` is used in `RenderWindow`. So the import stays. However, `classify.AllClasses()` is no longer called — verify it is not referenced anywhere in bank.go.
|
||||
|
||||
6. In encode/mp3.go, change the single `NewBank` call from:
|
||||
```go
|
||||
bank := synth.NewBank(1.0)
|
||||
```
|
||||
To:
|
||||
```go
|
||||
bank := synth.NewBank(1.0, synth.ClassFreqConfigs)
|
||||
```
|
||||
This preserves v1.0 behavior exactly.
|
||||
</action>
|
||||
<verify>
|
||||
<automated>cd /home/dev/workspace/yoloyolo && go build ./... && go vet ./synth/... ./encode/...</automated>
|
||||
</verify>
|
||||
<acceptance_criteria>
|
||||
- synth/bank.go OscillatorBank struct contains `gainPerLayer float64`
|
||||
- synth/bank.go NewBank signature is `func NewBank(tau float64, cfgs map[classify.TrafficClass]FreqConfig) *OscillatorBank`
|
||||
- synth/bank.go NewBank contains `gainPerLayer: 1.0 / float64(len(cfgs))`
|
||||
- synth/bank.go NewBank iterates `for class, cfg := range cfgs` (NOT classify.AllClasses())
|
||||
- synth/bank.go RenderWindow UpdateTarget loop uses `for class, layer := range b.layers`
|
||||
- synth/bank.go RenderWindow render loop uses `for _, layer := range b.layers`
|
||||
- synth/bank.go RenderWindow render loop uses `b.gainPerLayer` (NOT the GainPerLayer constant)
|
||||
- synth/bank.go does NOT contain `classify.AllClasses()`
|
||||
- encode/mp3.go contains `synth.NewBank(1.0, synth.ClassFreqConfigs)`
|
||||
- `go build ./...` exits 0
|
||||
</acceptance_criteria>
|
||||
<done>NewBank accepts injected config map. GainPerLayer is dynamic. RenderWindow iterates b.layers in both loops. encode/mp3.go passes ClassFreqConfigs as default. Project compiles.</done>
|
||||
</task>
|
||||
|
||||
<task type="auto">
|
||||
<name>Task 2: Update tests for new NewBank signature and dynamic gain</name>
|
||||
<files>synth/bank_test.go, synth/config_test.go</files>
|
||||
<read_first>synth/bank_test.go, synth/config_test.go, synth/bank.go, synth/config.go</read_first>
|
||||
<action>
|
||||
Per Pitfall 4 from research, update all tests that call NewBank or reference NumLayers:
|
||||
|
||||
1. In synth/bank_test.go, update ALL `NewBank(...)` calls to pass `ClassFreqConfigs`:
|
||||
|
||||
- `TestNewBankHas14Layers`: Change `NewBank(1.0)` to `NewBank(1.0, ClassFreqConfigs)`. Keep the assertion `len(b.layers) != 14` and the loop verifying each class has a layer. (This test uses internal package access since it's `package synth`.)
|
||||
|
||||
- `TestRenderWindowOutputLength`: Change `NewBank(1.0)` to `NewBank(1.0, ClassFreqConfigs)`.
|
||||
|
||||
- `TestRenderWindowSilentWhenNoTraffic`: Change `NewBank(1.0)` to `NewBank(1.0, ClassFreqConfigs)`.
|
||||
|
||||
- `TestRenderWindowNonZeroWithTraffic`: Change `NewBank(1.0)` to `NewBank(1.0, ClassFreqConfigs)`.
|
||||
|
||||
- `TestMixerNoClip`: Change `NewBank(0.01)` to `NewBank(0.01, ClassFreqConfigs)`. Also change `classify.AllClasses()` in the count setup loop to iterate `ClassFreqConfigs` keys instead:
|
||||
```go
|
||||
for class := range ClassFreqConfigs {
|
||||
counts[class] = 1000
|
||||
}
|
||||
```
|
||||
And update TotalPackets to `int64(len(ClassFreqConfigs)) * 1000`.
|
||||
|
||||
- `TestStereoPan`: Change `NewBank(0.01)` to `NewBank(0.01, ClassFreqConfigs)`.
|
||||
|
||||
- `TestMultipleWindowsEMAConvergence`: Change `NewBank(1.0)` to `NewBank(1.0, ClassFreqConfigs)`.
|
||||
|
||||
2. Add a new test `TestNewBankDynamicGain` to synth/bank_test.go:
|
||||
```go
|
||||
func TestNewBankDynamicGain(t *testing.T) {
|
||||
// Create a config map with only 3 classes
|
||||
cfgs := map[classify.TrafficClass]FreqConfig{
|
||||
classify.ClassICMP: ClassFreqConfigs[classify.ClassICMP],
|
||||
classify.ClassDNS: ClassFreqConfigs[classify.ClassDNS],
|
||||
classify.ClassHTTPS: ClassFreqConfigs[classify.ClassHTTPS],
|
||||
}
|
||||
b := NewBank(0.01, cfgs)
|
||||
if len(b.layers) != 3 {
|
||||
t.Errorf("NewBank with 3 configs has %d layers, want 3", len(b.layers))
|
||||
}
|
||||
// Verify gainPerLayer is 1/3
|
||||
expected := 1.0 / 3.0
|
||||
if b.gainPerLayer != expected {
|
||||
t.Errorf("gainPerLayer = %v, want %v", b.gainPerLayer, expected)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
3. Add a test `TestNewBankCustomConfigNoClip` to synth/bank_test.go to verify no-clip with a non-14 config:
|
||||
```go
|
||||
func TestNewBankCustomConfigNoClip(t *testing.T) {
|
||||
cfgs := map[classify.TrafficClass]FreqConfig{
|
||||
classify.ClassICMP: ClassFreqConfigs[classify.ClassICMP],
|
||||
classify.ClassDNS: ClassFreqConfigs[classify.ClassDNS],
|
||||
}
|
||||
b := NewBank(0.01, cfgs)
|
||||
counts := map[classify.TrafficClass]int64{
|
||||
classify.ClassICMP: 1000,
|
||||
classify.ClassDNS: 1000,
|
||||
}
|
||||
snap := classify.WindowSnapshot{Counts: counts, TotalPackets: 2000, WindowIndex: 0}
|
||||
for i := 0; i < 10; i++ {
|
||||
for _, frame := range b.RenderWindow(snap) {
|
||||
if frame[0] > 1.0 || frame[0] < -1.0 || frame[1] > 1.0 || frame[1] < -1.0 {
|
||||
t.Fatalf("clipped with 2-class config: L=%v R=%v", frame[0], frame[1])
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
4. In synth/config_test.go, update `TestNumLayersMatchesAllClasses`:
|
||||
Change from asserting `synth.NumLayers != len(classify.AllClasses())` to asserting `len(synth.ClassFreqConfigs) == len(classify.AllClasses())`:
|
||||
```go
|
||||
func TestNumLayersMatchesAllClasses(t *testing.T) {
|
||||
if len(synth.ClassFreqConfigs) != len(classify.AllClasses()) {
|
||||
t.Errorf("ClassFreqConfigs has %d entries but AllClasses() has %d entries",
|
||||
len(synth.ClassFreqConfigs), len(classify.AllClasses()))
|
||||
}
|
||||
}
|
||||
```
|
||||
This preserves the invariant that every built-in class has a config entry, without depending on the NumLayers constant.
|
||||
</action>
|
||||
<verify>
|
||||
<automated>cd /home/dev/workspace/yoloyolo && go test ./synth/... ./encode/... -v -count=1</automated>
|
||||
</verify>
|
||||
<acceptance_criteria>
|
||||
- synth/bank_test.go contains no calls to `NewBank(1.0)` or `NewBank(0.01)` — all calls have two arguments
|
||||
- synth/bank_test.go contains `TestNewBankDynamicGain` with assertion `b.gainPerLayer != expected`
|
||||
- synth/bank_test.go contains `TestNewBankCustomConfigNoClip`
|
||||
- synth/bank_test.go TestMixerNoClip iterates `ClassFreqConfigs` keys (not `classify.AllClasses()`)
|
||||
- synth/config_test.go TestNumLayersMatchesAllClasses asserts `len(synth.ClassFreqConfigs) == len(classify.AllClasses())`
|
||||
- synth/config_test.go TestNumLayersMatchesAllClasses does NOT reference `synth.NumLayers`
|
||||
- `go test ./synth/... ./encode/...` exits 0
|
||||
- `go test ./...` exits 0
|
||||
</acceptance_criteria>
|
||||
<done>All tests updated to new NewBank two-argument signature. Dynamic gain verified with custom config maps. No-clip test passes with non-14 class counts. TestNumLayersMatchesAllClasses updated. Full test suite green.</done>
|
||||
</task>
|
||||
|
||||
</tasks>
|
||||
|
||||
<verification>
|
||||
- `go test ./... -v` — full suite passes with no failures
|
||||
- `go vet ./...` — no warnings
|
||||
- `go build ./...` — compiles cleanly
|
||||
- grep confirms no remaining `classify.AllClasses()` in bank.go
|
||||
- grep confirms no remaining single-arg `NewBank(` calls in production or test code
|
||||
</verification>
|
||||
|
||||
<success_criteria>
|
||||
- NewBank accepts (tau, cfgs) — no global state dependency
|
||||
- GainPerLayer computed as 1.0/len(cfgs) — correct for any class count
|
||||
- RenderWindow iterates b.layers in both loops — no classify.AllClasses() calls
|
||||
- encode.RunSynthesis passes ClassFreqConfigs — v1.0 behavior preserved
|
||||
- No-clip guarantee holds for 2-class, 3-class, and 14-class configs
|
||||
- Full test suite green (synth + encode + all other packages)
|
||||
</success_criteria>
|
||||
|
||||
<output>
|
||||
After completion, create `.planning/phases/05-waveform-types-and-bank-decoupling/05-02-SUMMARY.md`
|
||||
</output>
|
||||
+80
@@ -0,0 +1,80 @@
|
||||
---
|
||||
phase: 05-waveform-types-and-bank-decoupling
|
||||
plan: "02"
|
||||
subsystem: synth
|
||||
tags: [bank, decoupling, dynamic-gain, injection-seam, refactor]
|
||||
dependency_graph:
|
||||
requires: [05-01]
|
||||
provides: [NewBank injected config map, gainPerLayer dynamic computation]
|
||||
affects: [synth/bank.go, encode/mp3.go, synth/bank_test.go, synth/config_test.go]
|
||||
tech_stack:
|
||||
added: []
|
||||
patterns: [dependency injection, dynamic gain scaling, config map injection]
|
||||
key_files:
|
||||
created: []
|
||||
modified:
|
||||
- synth/bank.go
|
||||
- encode/mp3.go
|
||||
- synth/bank_test.go
|
||||
- synth/config_test.go
|
||||
decisions:
|
||||
- "NewBank now accepts (tau float64, cfgs map[classify.TrafficClass]FreqConfig) — no global state dependency"
|
||||
- "gainPerLayer computed as 1.0/float64(len(cfgs)) so any N-class config auto-scales to avoid clipping"
|
||||
- "RenderWindow iterates b.layers directly in both loops — no classify.AllClasses() dependency"
|
||||
- "encode/mp3.go passes synth.ClassFreqConfigs as default — v1.0 behavior preserved exactly"
|
||||
metrics:
|
||||
duration: "~4 min"
|
||||
completed_date: "2026-03-26"
|
||||
tasks: 2
|
||||
files: 4
|
||||
requirements:
|
||||
- WAVE-01
|
||||
- WAVE-02
|
||||
---
|
||||
|
||||
# Phase 5 Plan 02: Bank Decoupling and Dynamic GainPerLayer Summary
|
||||
|
||||
OscillatorBank decoupled from global ClassFreqConfigs via injected config map, with gainPerLayer computed dynamically as 1/N so any class count produces correct no-clip mixing.
|
||||
|
||||
## What Was Built
|
||||
|
||||
- **`OscillatorBank.gainPerLayer float64`** field added to struct — computed at construction time as `1.0 / float64(len(cfgs))`
|
||||
- **`NewBank(tau float64, cfgs map[classify.TrafficClass]FreqConfig)`** — new two-argument signature replaces global ClassFreqConfigs dependency; iterates cfgs map directly to create layers
|
||||
- **`RenderWindow` UpdateTarget loop** — refactored from `classify.AllClasses()` iteration to `for class, layer := range b.layers`, making it work for any config map
|
||||
- **`RenderWindow` render loop** — refactored to use `b.gainPerLayer` (instance field) instead of `GainPerLayer` constant, enabling correct scaling for non-14 class counts
|
||||
- **`encode/mp3.go` call site** — updated to `synth.NewBank(1.0, synth.ClassFreqConfigs)`, preserving v1.0 behavior exactly
|
||||
- **Updated test suite** — all 7 existing `NewBank` calls updated to two-argument form; two new tests added: `TestNewBankDynamicGain` (verifies 1/3 gain for 3-class config) and `TestNewBankCustomConfigNoClip` (verifies no-clip with 2-class config)
|
||||
- **`TestNumLayersMatchesAllClasses`** updated to assert `len(synth.ClassFreqConfigs) == len(classify.AllClasses())` without depending on `synth.NumLayers`
|
||||
|
||||
## Tasks Completed
|
||||
|
||||
| Task | Description | Commit | Files |
|
||||
|------|-------------|--------|-------|
|
||||
| 1 | Decouple NewBank and fix GainPerLayer | 43307c3 | synth/bank.go, encode/mp3.go |
|
||||
| 2 | Update tests for new NewBank signature and dynamic gain | b2b5ab6 | synth/bank_test.go, synth/config_test.go |
|
||||
|
||||
## Verification
|
||||
|
||||
- `go test ./synth/... ./encode/... -v`: 44 tests, all pass (41 existing + 2 new bank tests)
|
||||
- `go test ./...`: all 6 packages pass (aggregate, capture, classify, cmd, encode, synth)
|
||||
- `go vet ./...`: clean
|
||||
- `go build ./...`: clean
|
||||
- `classify.AllClasses()` not referenced in bank.go (confirmed via grep)
|
||||
- No single-argument `NewBank(` calls remain in production or test code
|
||||
|
||||
## Deviations from Plan
|
||||
|
||||
None — plan executed exactly as written.
|
||||
|
||||
## Known Stubs
|
||||
|
||||
None — all decoupling logic is fully implemented and wired.
|
||||
|
||||
## Self-Check: PASSED
|
||||
|
||||
- synth/bank.go: FOUND (verified by go build)
|
||||
- encode/mp3.go NewBank call updated: FOUND (synth.NewBank(1.0, synth.ClassFreqConfigs))
|
||||
- synth/bank_test.go TestNewBankDynamicGain: FOUND (verified by go test)
|
||||
- synth/bank_test.go TestNewBankCustomConfigNoClip: FOUND (verified by go test)
|
||||
- synth/config_test.go TestNumLayersMatchesAllClasses updated: FOUND
|
||||
- Commits 43307c3, b2b5ab6: both present in git log
|
||||
@@ -0,0 +1,86 @@
|
||||
# Phase 5: Waveform Types and Bank Decoupling - Context
|
||||
|
||||
**Gathered:** 2026-03-26
|
||||
**Status:** Ready for planning
|
||||
|
||||
<domain>
|
||||
## Phase Boundary
|
||||
|
||||
Extend the synthesis oscillator to support four waveform types (sine, square, sawtooth, triangle) using bandlimited additive synthesis, and decouple the OscillatorBank from the hardcoded `ClassFreqConfigs` global and `classify.AllClasses()` iteration — making it accept an injected config map instead.
|
||||
|
||||
</domain>
|
||||
|
||||
<decisions>
|
||||
## Implementation Decisions
|
||||
|
||||
### Waveform Presets
|
||||
- **D-01:** Use bandlimited additive synthesis with 8-12 partials per waveform type. Square wave uses odd harmonics (1,3,5,...,11), sawtooth uses all harmonics (1-12), triangle uses odd harmonics with 1/n^2 amplitude rolloff. This is the standard approach for aliasing-free waveform generation.
|
||||
- **D-02:** Add a `WaveformType` enum to `FreqConfig` (`Sine`, `Square`, `Sawtooth`, `Triangle`). When waveform is set, generate the `[]HarmonicDef` from the preset formula. When waveform is unset/custom, use the existing hand-tuned `Harmonics` array.
|
||||
|
||||
### Built-in Harmonics Migration
|
||||
- **D-03:** (Claude's Discretion) Decide whether built-in classes keep their hand-tuned HarmonicDef arrays or migrate to waveform presets. Recommended approach: keep existing harmonics as-is for v1.0 classes (preserves sound character), default them to `WaveformType = ""` (custom). Waveform presets only take effect when explicitly set via config in Phase 6.
|
||||
|
||||
### GainPerLayer Scaling
|
||||
- **D-04:** Fix GainPerLayer now in Phase 5 — compute dynamically as `1.0 / float64(len(layers))` inside `NewBank` instead of using the hardcoded `NumLayers=14` constant. This establishes the correct foundation before Phase 7 adds dynamic class counts.
|
||||
|
||||
### Bank Decoupling
|
||||
- **D-05:** (Claude's Discretion) Change `NewBank` to accept a `map[classify.TrafficClass]FreqConfig` parameter instead of reading the `ClassFreqConfigs` global. This is the injection seam that Phase 6 will use to pass merged config. The existing `ClassFreqConfigs` var remains as the default map.
|
||||
|
||||
</decisions>
|
||||
|
||||
<canonical_refs>
|
||||
## Canonical References
|
||||
|
||||
**Downstream agents MUST read these before planning or implementing.**
|
||||
|
||||
### Synthesis Architecture
|
||||
- `synth/oscillator.go` — Current sine-only Oscillator with phase accumulator and `Advance([]HarmonicDef)`
|
||||
- `synth/config.go` — `FreqConfig`, `HarmonicDef`, `ClassFreqConfigs` global, constants (`SampleRate`, `NumLayers`, `GainPerLayer`)
|
||||
- `synth/bank.go` — `NewBank(tau)` iterates `classify.AllClasses()` and reads `ClassFreqConfigs` global
|
||||
- `synth/layer.go` — `Layer` with EMA smoothing, uses `FreqConfig` from config.go
|
||||
|
||||
### Research
|
||||
- `.planning/research/ARCHITECTURE.md` — Integration points and build order for v1.1
|
||||
- `.planning/research/PITFALLS.md` — Pitfall A3 (aliasing) and A6 (bank class mismatch)
|
||||
|
||||
No external specs — requirements fully captured in decisions above.
|
||||
|
||||
</canonical_refs>
|
||||
|
||||
<code_context>
|
||||
## Existing Code Insights
|
||||
|
||||
### Reusable Assets
|
||||
- `Oscillator.Advance([]HarmonicDef)` — Already supports additive synthesis via harmonic series. Waveform presets just need different `[]HarmonicDef` arrays, not a new oscillator type.
|
||||
- `FreqConfig` struct — Has `BaseHz`, `Harmonics`, `Pan`. Adding `WaveformType` field is backward-compatible.
|
||||
|
||||
### Established Patterns
|
||||
- Phase accumulator in `Oscillator` wraps at 1.0 — all harmonic ratios are integer multiples of the fundamental.
|
||||
- `Layer` delegates to `Oscillator.Advance()` — waveform change is transparent to the layer.
|
||||
- `ClassFreqConfigs` is a package-level `var` (not `const`) — can be replaced by parameter injection without breaking existing tests.
|
||||
|
||||
### Integration Points
|
||||
- `NewBank(tau)` → `NewBank(tau, configs map[TrafficClass]FreqConfig)` — single signature change
|
||||
- `bank.RenderWindow()` iterates `classify.AllClasses()` — must iterate `b.layers` map keys instead
|
||||
- `encode.RunSynthesis` calls `NewBank(1.0)` — will need to pass config map (Phase 6 concern, but seam established here)
|
||||
|
||||
</code_context>
|
||||
|
||||
<specifics>
|
||||
## Specific Ideas
|
||||
|
||||
No specific requirements — standard bandlimited synthesis approach with 8-12 partials as user requested.
|
||||
|
||||
</specifics>
|
||||
|
||||
<deferred>
|
||||
## Deferred Ideas
|
||||
|
||||
None — discussion stayed within phase scope.
|
||||
|
||||
</deferred>
|
||||
|
||||
---
|
||||
|
||||
*Phase: 05-waveform-types-and-bank-decoupling*
|
||||
*Context gathered: 2026-03-26*
|
||||
+58
@@ -0,0 +1,58 @@
|
||||
# Phase 5: Waveform Types and Bank Decoupling - Discussion Log
|
||||
|
||||
> **Audit trail only.** Do not use as input to planning, research, or execution agents.
|
||||
> Decisions are captured in CONTEXT.md — this log preserves the alternatives considered.
|
||||
|
||||
**Date:** 2026-03-26
|
||||
**Phase:** 05-waveform-types-and-bank-decoupling
|
||||
**Areas discussed:** Waveform presets, GainPerLayer scaling
|
||||
|
||||
---
|
||||
|
||||
## Waveform presets
|
||||
|
||||
### Harmonic richness
|
||||
|
||||
| Option | Description | Selected |
|
||||
|--------|-------------|----------|
|
||||
| Bandlimited (8-12 partials) | Accurate waveform shapes, no aliasing. Standard for quality synthesis. | ✓ |
|
||||
| Lightweight (4-6 partials) | Recognizably different but softer/rounder. Less CPU. | |
|
||||
| You decide | Claude picks based on Nyquist and ambient use case | |
|
||||
|
||||
**User's choice:** Bandlimited (8-12 partials)
|
||||
**Notes:** None
|
||||
|
||||
### Built-in class harmonics
|
||||
|
||||
| Option | Description | Selected |
|
||||
|--------|-------------|----------|
|
||||
| Keep current harmonics | Built-in classes retain hand-tuned arrays. Waveform presets only via config. | |
|
||||
| Migrate to sine preset | Switch to pure fundamental. Simpler but loses v1.0 character. | |
|
||||
| You decide | Claude picks best approach for preserving v1.0 sound | ✓ |
|
||||
|
||||
**User's choice:** You decide (Claude's Discretion)
|
||||
**Notes:** None
|
||||
|
||||
---
|
||||
|
||||
## GainPerLayer scaling
|
||||
|
||||
| Option | Description | Selected |
|
||||
|--------|-------------|----------|
|
||||
| Fix now in Phase 5 | Compute dynamically as 1/len(layers). Clean foundation for Phase 7. | ✓ |
|
||||
| Defer to Phase 7 | Keep NumLayers=14 constant. Fix when user classes land. | |
|
||||
| You decide | Claude picks timing based on complexity | |
|
||||
|
||||
**User's choice:** Fix now in Phase 5
|
||||
**Notes:** None
|
||||
|
||||
---
|
||||
|
||||
## Claude's Discretion
|
||||
|
||||
- Built-in class harmonics migration strategy (D-03)
|
||||
- Bank config injection API design (D-05)
|
||||
|
||||
## Deferred Ideas
|
||||
|
||||
None
|
||||
+439
@@ -0,0 +1,439 @@
|
||||
# Phase 5: Waveform Types and Bank Decoupling - Research
|
||||
|
||||
**Researched:** 2026-03-26
|
||||
**Domain:** Go additive synthesis, oscillator architecture, dependency injection
|
||||
**Confidence:** HIGH
|
||||
|
||||
---
|
||||
|
||||
<user_constraints>
|
||||
## User Constraints (from CONTEXT.md)
|
||||
|
||||
### Locked Decisions
|
||||
|
||||
- **D-01:** Use bandlimited additive synthesis with 8-12 partials per waveform type. Square wave uses odd harmonics (1,3,5,...,11), sawtooth uses all harmonics (1-12), triangle uses odd harmonics with 1/n^2 amplitude rolloff. This is the standard approach for aliasing-free waveform generation.
|
||||
- **D-02:** Add a `WaveformType` enum to `FreqConfig` (`Sine`, `Square`, `Sawtooth`, `Triangle`). When waveform is set, generate the `[]HarmonicDef` from the preset formula. When waveform is unset/custom, use the existing hand-tuned `Harmonics` array.
|
||||
- **D-04:** Fix GainPerLayer now in Phase 5 — compute dynamically as `1.0 / float64(len(layers))` inside `NewBank` instead of using the hardcoded `NumLayers=14` constant. This establishes the correct foundation before Phase 7 adds dynamic class counts.
|
||||
|
||||
### Claude's Discretion
|
||||
|
||||
- **D-03:** Decide whether built-in classes keep their hand-tuned HarmonicDef arrays or migrate to waveform presets. Recommended approach: keep existing harmonics as-is for v1.0 classes (preserves sound character), default them to `WaveformType = ""` (custom). Waveform presets only take effect when explicitly set via config in Phase 6.
|
||||
- **D-05:** Change `NewBank` to accept a `map[classify.TrafficClass]FreqConfig` parameter instead of reading the `ClassFreqConfigs` global. This is the injection seam that Phase 6 will use to pass merged config. The existing `ClassFreqConfigs` var remains as the default map.
|
||||
|
||||
### Deferred Ideas (OUT OF SCOPE)
|
||||
|
||||
None — discussion stayed within phase scope.
|
||||
|
||||
</user_constraints>
|
||||
|
||||
<phase_requirements>
|
||||
## Phase Requirements
|
||||
|
||||
| ID | Description | Research Support |
|
||||
|----|-------------|------------------|
|
||||
| WAVE-01 | User can set waveform type per traffic class (sine, square, sawtooth, triangle) | D-02: `WaveformType` field on `FreqConfig`; `WaveformPresetHarmonics()` generates the right `[]HarmonicDef` at layer-construction time. `NewBank` iterates the injected config map, so each class can carry a distinct waveform. |
|
||||
| WAVE-02 | Non-sine waveforms use bandlimited additive synthesis (no aliasing artifacts) | D-01: Harmonic truncation at Nyquist (22050 Hz) is built into `WaveformPresetHarmonics()`. Existing `Oscillator.Advance([]HarmonicDef)` already sums sine partials — waveform type only changes WHICH harmonics are passed, not the summation math. No naive waveform math is ever used. |
|
||||
|
||||
</phase_requirements>
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
Phase 5 makes two independent but related changes to the `synth` package: (1) it extends the oscillator to support four waveform types via bandlimited additive synthesis, and (2) it decouples `OscillatorBank.NewBank` from the package-level `ClassFreqConfigs` global by accepting an injected config map.
|
||||
|
||||
Both changes are contained entirely within the `synth` package and `encode/mp3.go`. No new packages are introduced. The existing `Oscillator.Advance([]HarmonicDef)` engine already supports additive synthesis — the waveform extension simply generates different harmonic series at construction time rather than at sample-render time. The bank decoupling is a signature change to `NewBank` with a one-line follow-up in `encode/mp3.go`.
|
||||
|
||||
The build order is: waveform enum and `WaveformPresetHarmonics()` function first (pure math, independently testable), then wire `WaveformType` through `FreqConfig` and `NewLayer`, then change `NewBank` signature and fix `GainPerLayer`. Each step leaves existing tests green.
|
||||
|
||||
**Primary recommendation:** Generate bandlimited `[]HarmonicDef` slices from the waveform preset at layer construction time (inside `NewLayer` or `NewBank`) — never at sample-render time. This keeps `Oscillator.Advance` unchanged and avoids per-sample branching.
|
||||
|
||||
---
|
||||
|
||||
## Standard Stack
|
||||
|
||||
### Core
|
||||
|
||||
No new external libraries are required. All waveform math uses `math.Sin` from Go's standard library. The existing dependency set is sufficient.
|
||||
|
||||
| Technology | Version | Purpose | Why Standard |
|
||||
|------------|---------|---------|--------------|
|
||||
| `math.Sin` (stdlib) | Go 1.24 | Sine partial summation in `Oscillator.Advance` | Already the engine for all synthesis; waveform types extend what series is passed to it |
|
||||
| `github.com/gopacket/gopacket` | v1.5.0 | Packet decode (unchanged) | No change — listed for completeness |
|
||||
| `github.com/sjzar/go-lame` | v0.0.9 | MP3 encoding (unchanged) | No change — listed for completeness |
|
||||
|
||||
**Installation:** No new dependencies. `go.mod` unchanged.
|
||||
|
||||
---
|
||||
|
||||
## Architecture Patterns
|
||||
|
||||
### Recommended Project Structure (unchanged)
|
||||
|
||||
```
|
||||
synth/
|
||||
├── config.go FreqConfig (+ WaveformType field), HarmonicDef, ClassFreqConfigs, WaveformPresetHarmonics()
|
||||
├── oscillator.go Oscillator — unchanged (Advance still takes []HarmonicDef)
|
||||
├── layer.go NewLayer passes cfg.WaveformType-derived harmonics to oscillator
|
||||
├── bank.go NewBank(tau, cfgs map[TrafficClass]FreqConfig) — decoupled
|
||||
└── mixer.go Unchanged
|
||||
encode/
|
||||
└── mp3.go RunSynthesis passes synth.ClassFreqConfigs as default to NewBank
|
||||
```
|
||||
|
||||
### Pattern 1: Bandlimited Harmonic Series Generation
|
||||
|
||||
**What:** A function `WaveformPresetHarmonics(waveformType WaveformType, baseHz float64, sampleRate int) []HarmonicDef` computes the correct partial series for each waveform, truncating at Nyquist to prevent aliasing. Called once at layer-construction time; result stored in the layer's oscillator call path.
|
||||
|
||||
**When to use:** Whenever `FreqConfig.WaveformType` is not `WaveformCustom` (the zero-value indicating hand-tuned harmonics).
|
||||
|
||||
**Example:**
|
||||
```go
|
||||
// In synth/config.go
|
||||
type WaveformType int
|
||||
|
||||
const (
|
||||
WaveformCustom WaveformType = iota // zero value: use FreqConfig.Harmonics as-is
|
||||
WaveformSine
|
||||
WaveformSquare
|
||||
WaveformSawtooth
|
||||
WaveformTriangle
|
||||
)
|
||||
|
||||
// WaveformPresetHarmonics returns a bandlimited harmonic series for the given waveform type.
|
||||
// Partials above Nyquist (sampleRate/2) are excluded to prevent aliasing.
|
||||
// Returns nil if waveformType is WaveformCustom (caller uses FreqConfig.Harmonics directly).
|
||||
func WaveformPresetHarmonics(wt WaveformType, baseHz float64, sampleRate int) []HarmonicDef {
|
||||
nyquist := float64(sampleRate) / 2.0
|
||||
switch wt {
|
||||
case WaveformSine:
|
||||
return []HarmonicDef{{Ratio: 1, Amplitude: 1.0}}
|
||||
case WaveformSquare:
|
||||
// Odd harmonics: 1, 3, 5, ... with amplitude 1/k, truncate at Nyquist
|
||||
var defs []HarmonicDef
|
||||
for k := 1; float64(k)*baseHz < nyquist; k += 2 {
|
||||
defs = append(defs, HarmonicDef{Ratio: k, Amplitude: 1.0 / float64(k)})
|
||||
}
|
||||
return defs
|
||||
case WaveformSawtooth:
|
||||
// All harmonics: 1, 2, 3, ... with amplitude 1/k, truncate at Nyquist
|
||||
var defs []HarmonicDef
|
||||
for k := 1; float64(k)*baseHz < nyquist; k++ {
|
||||
defs = append(defs, HarmonicDef{Ratio: k, Amplitude: 1.0 / float64(k)})
|
||||
}
|
||||
return defs
|
||||
case WaveformTriangle:
|
||||
// Odd harmonics with alternating sign, amplitude 1/k^2, truncate at Nyquist
|
||||
sign := 1.0
|
||||
var defs []HarmonicDef
|
||||
for k := 1; float64(k)*baseHz < nyquist; k += 2 {
|
||||
defs = append(defs, HarmonicDef{Ratio: k, Amplitude: sign / float64(k*k)})
|
||||
sign = -sign
|
||||
}
|
||||
return defs
|
||||
default: // WaveformCustom
|
||||
return nil
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Pattern 2: Harmonic Resolution in NewLayer
|
||||
|
||||
**What:** `NewLayer` resolves which harmonic array the oscillator will use. If `cfg.WaveformType` is `WaveformCustom` (zero value), use `cfg.Harmonics`. Otherwise call `WaveformPresetHarmonics` and store the result on `Layer.Config.Harmonics` so `AdvanceSample` needs no change.
|
||||
|
||||
**When to use:** Every `NewLayer` call. The resolution is a one-time cost at construction.
|
||||
|
||||
**Example:**
|
||||
```go
|
||||
func NewLayer(cfg FreqConfig, sampleRate int, tau float64) *Layer {
|
||||
if cfg.WaveformType != WaveformCustom {
|
||||
cfg.Harmonics = WaveformPresetHarmonics(cfg.WaveformType, cfg.BaseHz, sampleRate)
|
||||
}
|
||||
return &Layer{
|
||||
Config: cfg,
|
||||
Osc: NewOscillator(cfg.BaseHz, sampleRate),
|
||||
alpha: EMAAlpha(tau, sampleRate),
|
||||
whisper: WhisperFloor,
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
`AdvanceSample` is unchanged — it still calls `l.Osc.Advance(l.Config.Harmonics)`.
|
||||
|
||||
### Pattern 3: NewBank Signature with Injected Config Map
|
||||
|
||||
**What:** `NewBank` gains a second parameter: `cfgs map[classify.TrafficClass]FreqConfig`. It iterates the map's keys to build layers, instead of ranging over `classify.AllClasses()`. `GainPerLayer` is computed dynamically from `len(cfgs)` instead of the `NumLayers` constant.
|
||||
|
||||
**When to use:** All callers of `NewBank`. `encode/mp3.go` passes `synth.ClassFreqConfigs` as the default, preserving v1.0 behavior.
|
||||
|
||||
**Example:**
|
||||
```go
|
||||
func NewBank(tau float64, cfgs map[classify.TrafficClass]FreqConfig) *OscillatorBank {
|
||||
b := &OscillatorBank{
|
||||
layers: make(map[classify.TrafficClass]*Layer, len(cfgs)),
|
||||
tau: tau,
|
||||
gainPerLayer: 1.0 / float64(len(cfgs)),
|
||||
}
|
||||
for class, cfg := range cfgs {
|
||||
b.layers[class] = NewLayer(cfg, SampleRate, tau)
|
||||
}
|
||||
return b
|
||||
}
|
||||
```
|
||||
|
||||
`OscillatorBank` gains a `gainPerLayer float64` field. `RenderWindow` uses `b.gainPerLayer` instead of the package-level `GainPerLayer` constant. The constant `GainPerLayer` and `NumLayers` can be deprecated (kept for any external referencing tests but no longer used in bank logic).
|
||||
|
||||
`RenderWindow` iterates `b.layers` directly instead of `classify.AllClasses()`:
|
||||
|
||||
```go
|
||||
for _, layer := range b.layers {
|
||||
sample := layer.AdvanceSample()
|
||||
gainL, gainR := PanGains(layer.Config.Pan)
|
||||
sumL += sample * b.gainPerLayer * gainL
|
||||
sumR += sample * b.gainPerLayer * gainR
|
||||
}
|
||||
```
|
||||
|
||||
**Note:** `RenderWindow` currently also iterates `classify.AllClasses()` when calling `UpdateTarget`. This must also change to iterate the `snap.Counts` map (or iterate `b.layers` keys and look up each class in `snap.Counts`):
|
||||
|
||||
```go
|
||||
for class, layer := range b.layers {
|
||||
count := snap.Counts[class]
|
||||
layer.UpdateTarget(count, maxCount)
|
||||
}
|
||||
```
|
||||
|
||||
### Anti-Patterns to Avoid
|
||||
|
||||
- **Generating harmonics at sample-render time:** Do not call `WaveformPresetHarmonics` inside `Oscillator.Advance` or `Layer.AdvanceSample`. This costs ~10 allocations per frame at 44100 Hz and changes the per-sample hot path. Generate once at construction time.
|
||||
- **Adding a new oscillator type per waveform:** The existing `Oscillator` + `[]HarmonicDef` is already a general additive engine. A new `SquareOscillator` type would duplicate phase management, EMA wiring, and all tests. There is no need.
|
||||
- **Removing the `NumLayers` and `GainPerLayer` constants immediately:** Tests in `synth/config_test.go` (specifically `TestNumLayersMatchesAllClasses`) reference `synth.NumLayers`. The constant must remain exported (even if bank no longer uses it internally) until the test is updated. Update the test as part of D-04.
|
||||
- **Iterating `classify.AllClasses()` in RenderWindow:** After D-05, `b.layers` is the authoritative set of active classes. The two remaining loops in `RenderWindow` that range over `classify.AllClasses()` must both change to iterate `b.layers`, or they will break when Phase 7 adds user-defined classes that are not in `AllClasses()`.
|
||||
|
||||
---
|
||||
|
||||
## Don't Hand-Roll
|
||||
|
||||
| Problem | Don't Build | Use Instead | Why |
|
||||
|---------|-------------|-------------|-----|
|
||||
| Aliasing-free waveforms | Direct time-domain `sign(sin(phase))`, `2*frac(phase)-1` | Bandlimited additive synthesis via `WaveformPresetHarmonics()` | Direct math has infinite harmonics; aliases above Nyquist fold into the audible range as buzzing distortion — worst at 330 Hz+ (SSH, SMTP, DHCP) |
|
||||
| Per-sample waveform dispatch | `switch waveform { case square: return sign(sin(...)) }` in `Advance()` | Preset `[]HarmonicDef` computed at construction | Avoids per-sample branching; reuses existing `Oscillator.Advance` without any signature change |
|
||||
| Dynamic gain normalization | Hand-derive scaling formula per class count | `1.0 / float64(len(cfgs))` | Already the correct formula; the existing `NumLayers=14` constant was a specialization of this |
|
||||
|
||||
**Key insight:** The additive synthesis engine (`Oscillator.Advance([]HarmonicDef)`) is already general. Waveform type support is purely a matter of which harmonic series you feed it, not how the oscillator itself works.
|
||||
|
||||
---
|
||||
|
||||
## Common Pitfalls
|
||||
|
||||
### Pitfall 1: Naive Waveform Math Produces Audible Aliasing (Pitfall A3)
|
||||
|
||||
**What goes wrong:** Implementing `square(phase) = sign(sin(2π·phase))` or `sawtooth(phase) = 2·frac(phase) - 1` directly. These have infinite harmonics; above Nyquist they fold back into the audible range as aliasing. At SSH (330 Hz) and higher, the effect is audible buzzing that sounds like corruption.
|
||||
|
||||
**Why it happens:** The mathematical waveforms are not bandlimited. Sampling them at 44100 Hz aliases all energy above 22050 Hz back into audible frequencies.
|
||||
|
||||
**How to avoid:** Use `WaveformPresetHarmonics()` which truncates the harmonic series at `float64(k)*baseHz < nyquist`. The existing `Oscillator.Advance` sums sinusoids, which are already bandlimited by nature.
|
||||
|
||||
**Warning signs:** Square/sawtooth sounds buzzy or harsh at frequencies above ~300 Hz. Aliasing cannot be removed after the fact.
|
||||
|
||||
### Pitfall 2: Generating Harmonics at Sample-Render Time
|
||||
|
||||
**What goes wrong:** Calling `WaveformPresetHarmonics()` inside `Advance()` or `AdvanceSample()` on every sample. At 44100 Hz per channel this creates 44100 slice allocations per second, causing GC pressure and measurable latency in the render loop.
|
||||
|
||||
**Why it happens:** Placing the preset logic in `Advance` seems clean because it keeps the oscillator self-contained.
|
||||
|
||||
**How to avoid:** Resolve harmonics once in `NewLayer` (at construction). Store the result in `Layer.Config.Harmonics`. `AdvanceSample` needs no change.
|
||||
|
||||
**Warning signs:** CPU profile shows allocations in `synth.WaveformPresetHarmonics` during `RenderWindow`.
|
||||
|
||||
### Pitfall 3: Both RenderWindow Loops Still Iterate classify.AllClasses()
|
||||
|
||||
**What goes wrong:** `RenderWindow` has two loops that call `classify.AllClasses()`: one for `UpdateTarget` and one for rendering. After `NewBank` switches to iterating the injected map, if both `RenderWindow` loops still use `classify.AllClasses()`, Phase 7 user-defined classes will aggregate counts but never have their target updated, producing silence with no error.
|
||||
|
||||
**Why it happens:** Updating `NewBank`'s construction loop is the obvious change; the two `RenderWindow` loops are easy to miss.
|
||||
|
||||
**How to avoid:** Change all three loops in `bank.go` simultaneously. Use `for class, layer := range b.layers` in both `RenderWindow` loops.
|
||||
|
||||
**Warning signs:** User-defined class layers produce silence when traffic is present (Phase 7 symptom), or `TestMixerNoClip` fails if the layer count changes.
|
||||
|
||||
### Pitfall 4: TestNewBankHas14Layers and TestNumLayersMatchesAllClasses Break Without Updates
|
||||
|
||||
**What goes wrong:** `synth/bank_test.go:TestNewBankHas14Layers` calls `NewBank(1.0)` with the old one-argument signature. `synth/config_test.go:TestNumLayersMatchesAllClasses` asserts `synth.NumLayers == len(classify.AllClasses())`. Both tests fail on compile or assertion the moment `NewBank` gains a parameter.
|
||||
|
||||
**Why it happens:** These tests were written against the v1.0 API.
|
||||
|
||||
**How to avoid:** Update both tests as part of the same commit that changes `NewBank`. `TestNewBankHas14Layers` should call `NewBank(1.0, synth.ClassFreqConfigs)`. `TestNumLayersMatchesAllClasses` should be updated to assert `len(synth.ClassFreqConfigs) == len(classify.AllClasses())` or deleted if the invariant is no longer meaningful.
|
||||
|
||||
**Warning signs:** Compile error on `NewBank(1.0)` after the signature change.
|
||||
|
||||
### Pitfall 5: Triangle Wave Amplitude Is Much Lower Than Other Waveforms
|
||||
|
||||
**What goes wrong:** Triangle uses `1/k^2` amplitude rolloff (vs `1/k` for square/sawtooth). The total weight of the normalized series is much lower (sum of `1/k^2` for odd k converges to `π^2/8 ≈ 1.23` vs `π/4 ≈ 0.79` for square), but after normalization in `Oscillator.Advance` (`sum / totalWeight`) the peak amplitude is ~1.0. However, because fewer harmonics contribute significantly, the RMS energy is lower than a square wave at the same amplitude setting. This means triangle layers sound subjectively quieter even at the same volume setting.
|
||||
|
||||
**Why it happens:** The 1/k^2 rolloff is acoustically intentional (triangle is the smoothest non-sine waveform) but it may surprise developers comparing oscilloscope peak values vs perceived loudness.
|
||||
|
||||
**How to avoid:** This is a design characteristic, not a bug. Document it. If perceptual loudness matching is needed in Phase 6, the user can adjust the `GainPerLayer` or per-class amplitude in config. Do not "fix" by changing amplitudes — that would break the standard triangle wave definition.
|
||||
|
||||
**Warning signs:** Triangle-waveform layer sounds noticeably quieter than square/sawtooth at the same traffic level.
|
||||
|
||||
---
|
||||
|
||||
## Code Examples
|
||||
|
||||
Verified patterns from direct code inspection of the existing codebase:
|
||||
|
||||
### How Oscillator.Advance Currently Works (unchanged)
|
||||
|
||||
```go
|
||||
// synth/oscillator.go — existing, unchanged by this phase
|
||||
func (o *Oscillator) Advance(harmonics []HarmonicDef) float64 {
|
||||
sum := 0.0
|
||||
totalWeight := 0.0
|
||||
for _, h := range harmonics {
|
||||
sum += h.Amplitude * math.Sin(2*math.Pi*o.phase*float64(h.Ratio))
|
||||
totalWeight += h.Amplitude
|
||||
}
|
||||
o.phase += o.freq / o.sr
|
||||
if o.phase >= 1.0 {
|
||||
o.phase -= 1.0
|
||||
}
|
||||
if totalWeight > 0 {
|
||||
return sum / totalWeight
|
||||
}
|
||||
return 0
|
||||
}
|
||||
```
|
||||
|
||||
The normalization (`sum / totalWeight`) ensures the output is bounded in [-1, 1] regardless of how many partials are summed. Waveform presets with `1/k` amplitudes naturally produce a well-normalized output from this engine.
|
||||
|
||||
### Partial Count vs Frequency for Phase 5 Presets
|
||||
|
||||
At 44100 Hz sample rate (Nyquist = 22050 Hz):
|
||||
|
||||
| Waveform | BaseHz | Max Partial | Partial Count |
|
||||
|----------|--------|-------------|---------------|
|
||||
| Square | 65 Hz | k=675 (odd) | ~338 partials |
|
||||
| Square | 1047 Hz | k=41 (odd) | ~21 partials |
|
||||
| Sawtooth | 65 Hz | k=339 | 339 partials |
|
||||
| Sawtooth | 1047 Hz | k=21 | 21 partials |
|
||||
| Triangle | 65 Hz | k=675 (odd) | ~338 partials |
|
||||
| Triangle | 1047 Hz | k=41 (odd) | ~21 partials |
|
||||
|
||||
The D-01 decision specifies "8-12 partials" as a practical cap. The Nyquist-truncation formula above naturally produces more partials for low-frequency oscillators. The planner should consider whether to implement a hard cap at 12 partials (simpler, slightly more aliasing at very low frequencies) or use the full Nyquist-truncated series (more accurate, still inaudible aliasing). Both are correct implementations of WAVE-02.
|
||||
|
||||
**Recommendation (Claude's Discretion):** Use the Nyquist-truncation formula without an additional hard cap. For very low-frequency bases (65 Hz), 300+ partials is still fast in the inner loop since the sum is simple float64 multiply-and-add. The audible difference between 12 and 300 partials at 65 Hz is significant; the 12-partial cap would noticeably affect sound character. Reserve the 8-12 cap language as an approximation, not an implementation constraint.
|
||||
|
||||
### encode/mp3.go Change (the only caller of NewBank)
|
||||
|
||||
```go
|
||||
// encode/mp3.go — current call
|
||||
bank := synth.NewBank(1.0)
|
||||
|
||||
// encode/mp3.go — updated call (passes default config, behavior identical)
|
||||
bank := synth.NewBank(1.0, synth.ClassFreqConfigs)
|
||||
```
|
||||
|
||||
This is the only external call site. No other files reference `synth.NewBank`.
|
||||
|
||||
---
|
||||
|
||||
## State of the Art
|
||||
|
||||
| Old Approach | Current Approach | When Changed | Impact |
|
||||
|--------------|------------------|--------------|--------|
|
||||
| `NumLayers=14` hardcoded constant for gain scaling | `1.0 / float64(len(cfgs))` computed dynamically | Phase 5 (D-04) | Gain scaling stays correct as class count varies in Phase 7 |
|
||||
| `NewBank` reads `ClassFreqConfigs` global | `NewBank(tau, cfgs)` accepts injected map | Phase 5 (D-05) | Bank is now testable without global mutation; Phase 6 can pass merged configs |
|
||||
| Sine-only oscillator | Four waveform types via bandlimited additive synthesis | Phase 5 | User-selectable timbres per traffic class; WAVE-01/02 satisfied |
|
||||
|
||||
**Deprecated/outdated after this phase:**
|
||||
- `NumLayers` constant: still exported but no longer used in bank logic. Can be removed in a cleanup phase.
|
||||
- `GainPerLayer` constant: same status as `NumLayers`.
|
||||
- `bank.go` ranging over `classify.AllClasses()`: replaced by ranging over `b.layers` in all three loops.
|
||||
|
||||
---
|
||||
|
||||
## Environment Availability
|
||||
|
||||
Step 2.6: SKIPPED — phase is purely code changes within the existing Go module. No external tools, services, runtimes, databases, or CLIs beyond the project's own build toolchain are required. Existing `go test ./synth/...` confirms the baseline passes.
|
||||
|
||||
---
|
||||
|
||||
## Validation Architecture
|
||||
|
||||
### Test Framework
|
||||
|
||||
| Property | Value |
|
||||
|----------|-------|
|
||||
| Framework | Go testing (`testing` stdlib) |
|
||||
| Config file | None — standard `go test` |
|
||||
| Quick run command | `go test ./synth/... ./encode/...` |
|
||||
| Full suite command | `go test ./...` |
|
||||
|
||||
### Phase Requirements → Test Map
|
||||
|
||||
| Req ID | Behavior | Test Type | Automated Command | File Exists? |
|
||||
|--------|----------|-----------|-------------------|-------------|
|
||||
| WAVE-01 | WaveformType field added to FreqConfig; zero value (WaveformCustom) preserves existing behavior | unit | `go test ./synth/... -run TestWaveformCustomPreservesHarmonics` | ❌ Wave 0 |
|
||||
| WAVE-01 | WaveformPresetHarmonics returns correct partial series for square, sawtooth, triangle, sine | unit | `go test ./synth/... -run TestWaveformPresetHarmonics` | ❌ Wave 0 |
|
||||
| WAVE-01 | NewBank accepts injected config map; layer count equals map size | unit | `go test ./synth/... -run TestNewBankAcceptsConfigMap` | ❌ Wave 0 (replaces TestNewBankHas14Layers) |
|
||||
| WAVE-02 | All partials in preset harmonic series are below Nyquist (sampleRate/2) | unit | `go test ./synth/... -run TestBandlimitedHarmonicsNoAliasing` | ❌ Wave 0 |
|
||||
| WAVE-02 | Sine waveform (WaveformSine preset) produces same output as single-harmonic custom config | unit | `go test ./synth/... -run TestSineRegressionVsCustomHarmonics` | ❌ Wave 0 |
|
||||
| WAVE-01+02 | GainPerLayer computed dynamically; no clip with N-class config map | unit | `go test ./synth/... -run TestMixerNoClip` | ✅ exists (update to new NewBank signature) |
|
||||
| WAVE-01 | encode.RunSynthesis compiles and passes synth.ClassFreqConfigs to NewBank | unit/smoke | `go test ./encode/...` | ✅ exists (update call site) |
|
||||
|
||||
### Sampling Rate
|
||||
|
||||
- **Per task commit:** `go test ./synth/... ./encode/...`
|
||||
- **Per wave merge:** `go test ./...`
|
||||
- **Phase gate:** Full suite green before `/gsd:verify-work`
|
||||
|
||||
### Wave 0 Gaps
|
||||
|
||||
- [ ] `synth/waveform_test.go` (or additions to `synth/oscillator_test.go`) — covers WAVE-01 (preset harmonics correctness) and WAVE-02 (bandlimit enforcement)
|
||||
- [ ] Update `synth/bank_test.go:TestNewBankHas14Layers` to use new two-argument `NewBank` signature
|
||||
- [ ] Update `synth/config_test.go:TestNumLayersMatchesAllClasses` to reflect dynamic gain approach
|
||||
|
||||
---
|
||||
|
||||
## Open Questions
|
||||
|
||||
1. **Hard cap on partial count (8-12 partials per D-01 vs Nyquist truncation)**
|
||||
- What we know: D-01 says "8-12 partials." Nyquist truncation produces up to ~340 partials for a 65 Hz sawtooth. Both approaches satisfy WAVE-02.
|
||||
- What's unclear: Was "8-12 partials" a maximum cap or a minimum floor for realistic waveforms?
|
||||
- Recommendation: Use Nyquist truncation without hard cap. At 44100 Hz the summation loop is fast. Document the choice. If the user hears no meaningful difference between 12 and 340 partials at 65 Hz (perceptually similar) then reconsider in Phase 6 when user testing begins.
|
||||
|
||||
2. **TestHarmonicsNonEmpty breaks if WaveformCustom harmonics are empty for a class**
|
||||
- What we know: `synth/config_test.go:TestHarmonicsNonEmpty` asserts every `ClassFreqConfigs` entry has `len(cfg.Harmonics) >= 2`. All built-in entries retain their hand-tuned harmonics (D-03), so this test continues to pass.
|
||||
- What's unclear: If a future entry in `ClassFreqConfigs` uses `WaveformType = WaveformSine` with an empty `Harmonics` slice, the test would fail. This is not a Phase 5 concern since D-03 says keep existing harmonics as-is.
|
||||
- Recommendation: No action needed in Phase 5. Note for Phase 6 if user-configured classes with preset waveforms and empty Harmonics are added to the default config.
|
||||
|
||||
---
|
||||
|
||||
## Sources
|
||||
|
||||
### Primary (HIGH confidence)
|
||||
|
||||
- Direct code inspection: `synth/oscillator.go`, `synth/config.go`, `synth/bank.go`, `synth/layer.go`, `synth/bank_test.go`, `synth/config_test.go`, `synth/oscillator_test.go`, `encode/mp3.go` — exact current implementation confirmed
|
||||
- `.planning/research/PITFALLS.md` — Pitfall A3 (aliasing), verified against DSP literature in that document
|
||||
- `.planning/research/ARCHITECTURE.md` — Integration point analysis, build order, confirmed against actual code
|
||||
|
||||
### Secondary (MEDIUM confidence)
|
||||
|
||||
- `.planning/phases/05-waveform-types-and-bank-decoupling/05-CONTEXT.md` — User decisions D-01 through D-05
|
||||
- DSP theory: harmonic series for square (odd, 1/k), sawtooth (all, 1/k), triangle (odd, alternating sign, 1/k^2) — standard result, confirmed in PITFALLS.md sources (WolfSound, CCRMA, McGill)
|
||||
|
||||
### Tertiary (LOW confidence)
|
||||
|
||||
None. All findings grounded in direct code inspection or established DSP theory.
|
||||
|
||||
---
|
||||
|
||||
## Metadata
|
||||
|
||||
**Confidence breakdown:**
|
||||
- Standard stack: HIGH — no new libraries; all changes are within existing codebase
|
||||
- Architecture: HIGH — based on direct inspection of all affected files; build order verified against existing test structure
|
||||
- Pitfalls: HIGH — aliasing pitfall from DSP literature; API-break pitfalls from direct test-file inspection
|
||||
|
||||
**Research date:** 2026-03-26
|
||||
**Valid until:** Stable — pure Go math and internal refactor; no external API dependencies that could change
|
||||
+81
@@ -0,0 +1,81 @@
|
||||
---
|
||||
phase: 5
|
||||
slug: waveform-types-and-bank-decoupling
|
||||
status: draft
|
||||
nyquist_compliant: false
|
||||
wave_0_complete: false
|
||||
created: 2026-03-26
|
||||
---
|
||||
|
||||
# Phase 5 — Validation Strategy
|
||||
|
||||
> Per-phase validation contract for feedback sampling during execution.
|
||||
|
||||
---
|
||||
|
||||
## Test Infrastructure
|
||||
|
||||
| Property | Value |
|
||||
|----------|-------|
|
||||
| **Framework** | Go testing (`testing` stdlib) |
|
||||
| **Config file** | None — standard `go test` |
|
||||
| **Quick run command** | `go test ./synth/... ./encode/...` |
|
||||
| **Full suite command** | `go test ./...` |
|
||||
| **Estimated runtime** | ~5 seconds |
|
||||
|
||||
---
|
||||
|
||||
## Sampling Rate
|
||||
|
||||
- **After every task commit:** Run `go test ./synth/... ./encode/...`
|
||||
- **After every plan wave:** Run `go test ./...`
|
||||
- **Before `/gsd:verify-work`:** Full suite must be green
|
||||
- **Max feedback latency:** 5 seconds
|
||||
|
||||
---
|
||||
|
||||
## Per-Task Verification Map
|
||||
|
||||
| Task ID | Plan | Wave | Requirement | Test Type | Automated Command | File Exists | Status |
|
||||
|---------|------|------|-------------|-----------|-------------------|-------------|--------|
|
||||
| 05-01-01 | 01 | 1 | WAVE-01 | unit | `go test ./synth/... -run TestWaveformCustomPreservesHarmonics` | ❌ W0 | ⬜ pending |
|
||||
| 05-01-02 | 01 | 1 | WAVE-01 | unit | `go test ./synth/... -run TestWaveformPresetHarmonics` | ❌ W0 | ⬜ pending |
|
||||
| 05-01-03 | 01 | 1 | WAVE-01 | unit | `go test ./synth/... -run TestNewBankAcceptsConfigMap` | ❌ W0 | ⬜ pending |
|
||||
| 05-01-04 | 01 | 1 | WAVE-02 | unit | `go test ./synth/... -run TestBandlimitedHarmonicsNoAliasing` | ❌ W0 | ⬜ pending |
|
||||
| 05-01-05 | 01 | 1 | WAVE-02 | unit | `go test ./synth/... -run TestSineRegressionVsCustomHarmonics` | ❌ W0 | ⬜ pending |
|
||||
| 05-02-01 | 02 | 1 | WAVE-01+02 | unit | `go test ./synth/... -run TestMixerNoClip` | ✅ exists (update) | ⬜ pending |
|
||||
| 05-02-02 | 02 | 1 | WAVE-01 | unit/smoke | `go test ./encode/...` | ✅ exists (update) | ⬜ pending |
|
||||
|
||||
*Status: ⬜ pending · ✅ green · ❌ red · ⚠️ flaky*
|
||||
|
||||
---
|
||||
|
||||
## Wave 0 Requirements
|
||||
|
||||
- [ ] `synth/waveform_test.go` — stubs for WAVE-01 (preset harmonics correctness) and WAVE-02 (bandlimit enforcement)
|
||||
- [ ] Update `synth/bank_test.go:TestNewBankHas14Layers` to use new two-argument `NewBank` signature
|
||||
- [ ] Update `synth/config_test.go:TestNumLayersMatchesAllClasses` to reflect dynamic gain approach
|
||||
|
||||
*Existing test infrastructure covers framework and tooling — no new framework install needed.*
|
||||
|
||||
---
|
||||
|
||||
## Manual-Only Verifications
|
||||
|
||||
| Behavior | Requirement | Why Manual | Test Instructions |
|
||||
|----------|-------------|------------|-------------------|
|
||||
| Audible tonal distinction between waveforms | WAVE-01 | Subjective audio quality | Generate MP3 with each waveform type; listen and confirm distinct timbres |
|
||||
| No audible aliasing or buzzing | WAVE-02 | Perceptual audio quality | Play sawtooth/square at low frequencies (65 Hz); confirm clean sound |
|
||||
|
||||
---
|
||||
|
||||
## Validation Sign-Off
|
||||
|
||||
- [ ] All tasks have `<automated>` verify or Wave 0 dependencies
|
||||
- [ ] Sampling continuity: no 3 consecutive tasks without automated verify
|
||||
- [ ] Wave 0 covers all MISSING references
|
||||
- [ ] No watch-mode flags
|
||||
- [ ] Feedback latency < 5s
|
||||
- [ ] `nyquist_compliant: true` set in frontmatter
|
||||
|
||||
**Approval:** pending
|
||||
+126
@@ -0,0 +1,126 @@
|
||||
---
|
||||
phase: 05-waveform-types-and-bank-decoupling
|
||||
verified: 2026-03-26T00:00:00Z
|
||||
status: passed
|
||||
score: 12/12 must-haves verified
|
||||
re_verification: false
|
||||
gaps: []
|
||||
human_verification: []
|
||||
---
|
||||
|
||||
# Phase 5: Waveform Types and Bank Decoupling Verification Report
|
||||
|
||||
**Phase Goal:** Add waveform types (sine, square, sawtooth, triangle) with bandlimited synthesis; decouple OscillatorBank from global config for custom sound mapping injection.
|
||||
**Verified:** 2026-03-26
|
||||
**Status:** passed
|
||||
**Re-verification:** No — initial verification
|
||||
|
||||
---
|
||||
|
||||
## Goal Achievement
|
||||
|
||||
### Observable Truths
|
||||
|
||||
Plan 01 truths:
|
||||
|
||||
| # | Truth | Status | Evidence |
|
||||
|----|-------|--------|----------|
|
||||
| 1 | WaveformType enum exists with five values: WaveformCustom (0), WaveformSine, WaveformSquare, WaveformSawtooth, WaveformTriangle | VERIFIED | `synth/config.go` lines 16-24: `type WaveformType int` with five `iota` constants in correct order |
|
||||
| 2 | WaveformPresetHarmonics returns correct bandlimited harmonic series for each waveform type | VERIFIED | `synth/config.go` lines 29-59: correct loop logic for each waveform; all 9 waveform tests pass |
|
||||
| 3 | All generated partials are below Nyquist frequency (22050 Hz) | VERIFIED | `TestBandlimitedHarmonicsNoAliasing` iterates all ClassFreqConfigs × all 4 waveform types — passes |
|
||||
| 4 | WaveformCustom returns nil, preserving existing hand-tuned harmonics | VERIFIED | `synth/config.go` line 33: `case WaveformCustom: return nil`; `TestWaveformPresetHarmonics_Custom` passes |
|
||||
| 5 | NewLayer resolves waveform presets at construction time, not at render time | VERIFIED | `synth/layer.go` lines 25-27: preset resolution at top of `NewLayer`; `TestNewLayerResolvesWaveformPreset` and `TestSineRegressionVsCustomHarmonics` pass |
|
||||
| 6 | Existing tests still pass — no regression in v1.0 behavior | VERIFIED | `go test ./...` — all 6 packages pass (aggregate, capture, classify, cmd/netsynth, encode, synth) |
|
||||
|
||||
Plan 02 truths:
|
||||
|
||||
| # | Truth | Status | Evidence |
|
||||
|----|-------|--------|----------|
|
||||
| 7 | NewBank accepts a config map parameter instead of reading the ClassFreqConfigs global | VERIFIED | `synth/bank.go` line 17: `func NewBank(tau float64, cfgs map[classify.TrafficClass]FreqConfig) *OscillatorBank` |
|
||||
| 8 | GainPerLayer is computed dynamically as 1.0/len(configs) inside NewBank | VERIFIED | `synth/bank.go` line 21: `gainPerLayer: 1.0 / float64(len(cfgs))`; `TestNewBankDynamicGain` asserts `b.gainPerLayer == 1.0/3.0` for 3-class config |
|
||||
| 9 | RenderWindow iterates b.layers instead of classify.AllClasses() in both loops | VERIFIED | `synth/bank.go` lines 42-55: both loops use `range b.layers`; `classify.AllClasses()` absent from bank.go |
|
||||
| 10 | encode.RunSynthesis passes synth.ClassFreqConfigs as the default config map | VERIFIED | `encode/mp3.go` line 57: `bank := synth.NewBank(1.0, synth.ClassFreqConfigs)` |
|
||||
| 11 | All 14 built-in classes still produce the same audio output as v1.0 | VERIFIED | `TestNewBankHas14Layers`, `TestMixerNoClip`, `TestMultipleWindowsEMAConvergence`, `TestStereoPan` all pass |
|
||||
| 12 | No-clip guarantee holds with dynamic gain scaling | VERIFIED | `TestMixerNoClip` (14-class), `TestNewBankCustomConfigNoClip` (2-class) both pass |
|
||||
|
||||
**Score:** 12/12 truths verified
|
||||
|
||||
---
|
||||
|
||||
### Required Artifacts
|
||||
|
||||
| Artifact | Provides | Status | Details |
|
||||
|----------|----------|--------|---------|
|
||||
| `synth/config.go` | WaveformType enum and WaveformPresetHarmonics function | VERIFIED | Exports all 5 enum values, `WaveformPresetHarmonics`, and `FreqConfig.WaveformType` field |
|
||||
| `synth/layer.go` | Waveform resolution in NewLayer | VERIFIED | Lines 25-27 resolve presets at construction; `WaveformPresetHarmonics` called correctly |
|
||||
| `synth/waveform_test.go` | Tests for waveform preset generation and bandlimiting | VERIFIED | 12 test functions including all specified behavioral tests |
|
||||
| `synth/bank.go` | Decoupled OscillatorBank with injected config map | VERIFIED | `gainPerLayer` field present, `NewBank` takes `cfgs` param, both `RenderWindow` loops use `b.layers` |
|
||||
| `encode/mp3.go` | Updated NewBank call site | VERIFIED | Line 57 passes `synth.ClassFreqConfigs` as second arg |
|
||||
| `synth/bank_test.go` | Updated tests for new NewBank signature | VERIFIED | All calls are two-argument; `TestNewBankDynamicGain` and `TestNewBankCustomConfigNoClip` present |
|
||||
| `synth/config_test.go` | Updated TestNumLayersMatchesAllClasses | VERIFIED | Line 62: asserts `len(synth.ClassFreqConfigs) == len(classify.AllClasses())`; no reference to `synth.NumLayers` |
|
||||
|
||||
---
|
||||
|
||||
### Key Link Verification
|
||||
|
||||
| From | To | Via | Status | Details |
|
||||
|------|----|-----|--------|---------|
|
||||
| `synth/layer.go` | `synth/config.go` | `NewLayer` calls `WaveformPresetHarmonics(cfg.WaveformType, cfg.BaseHz, sampleRate)` | WIRED | Line 26: exact call present; conditional on `cfg.WaveformType != WaveformCustom` |
|
||||
| `encode/mp3.go` | `synth/bank.go` | `synth.NewBank(1.0, synth.ClassFreqConfigs)` | WIRED | Line 57: exact pattern matches; no single-arg NewBank calls anywhere in codebase |
|
||||
| `synth/bank.go` | `synth/layer.go` | `NewLayer(cfg, SampleRate, tau)` for each config map entry | WIRED | Lines 23-25: iterates `cfgs`, calls `NewLayer(cfg, SampleRate, tau)` for each |
|
||||
| `synth/bank.go` | `synth/config.go` | `gainPerLayer` computed from `len(cfgs)` | WIRED | Line 21: `1.0 / float64(len(cfgs))` |
|
||||
|
||||
---
|
||||
|
||||
### Data-Flow Trace (Level 4)
|
||||
|
||||
Not applicable. Phase 5 artifacts are synthesis engine components (type definitions, pure functions, struct methods) — not UI components or pages that render dynamic data from an external source. Data flow is exercised directly by the test suite.
|
||||
|
||||
---
|
||||
|
||||
### Behavioral Spot-Checks
|
||||
|
||||
| Behavior | Command | Result | Status |
|
||||
|----------|---------|--------|--------|
|
||||
| All synth tests pass including new waveform tests | `go test ./synth/... -v -count=1` | 30 tests pass, 0 failures | PASS |
|
||||
| Full project builds without errors | `go build ./...` | Exit 0, no output | PASS |
|
||||
| go vet finds no issues | `go vet ./synth/... ./encode/...` | Exit 0, no output | PASS |
|
||||
| Full test suite passes | `go test ./...` | 6 packages pass, 0 failures | PASS |
|
||||
|
||||
---
|
||||
|
||||
### Requirements Coverage
|
||||
|
||||
| Requirement | Source Plan | Description | Status | Evidence |
|
||||
|-------------|-------------|-------------|--------|----------|
|
||||
| WAVE-01 | 05-01, 05-02 | User can set waveform type per traffic class (sine, square, sawtooth, triangle) | SATISFIED | `WaveformType` field on `FreqConfig`; `NewBank` accepts any config map with any `WaveformType` per entry; waveform resolution in `NewLayer` |
|
||||
| WAVE-02 | 05-01, 05-02 | Non-sine waveforms use bandlimited additive synthesis (no aliasing artifacts) | SATISFIED | `WaveformPresetHarmonics` loops terminate at `float64(k)*baseHz < nyquist`; `TestBandlimitedHarmonicsNoAliasing` verifies no harmonic exceeds 22050 Hz across all base frequencies |
|
||||
|
||||
No orphaned requirements: REQUIREMENTS.md traceability table maps WAVE-01 and WAVE-02 to Phase 5 only; both are covered.
|
||||
|
||||
---
|
||||
|
||||
### Anti-Patterns Found
|
||||
|
||||
None. Grep scan of all phase-modified files (`synth/config.go`, `synth/layer.go`, `synth/bank.go`, `synth/waveform_test.go`, `synth/bank_test.go`, `synth/config_test.go`, `encode/mp3.go`) found no TODO/FIXME/placeholder comments, no empty implementations, no hardcoded empty returns, and no stubbed handlers.
|
||||
|
||||
| File | Line | Pattern | Severity | Impact |
|
||||
|------|------|---------|----------|--------|
|
||||
| — | — | — | — | — |
|
||||
|
||||
---
|
||||
|
||||
### Human Verification Required
|
||||
|
||||
None. All phase-5 behaviors are exercised by automated tests with deterministic numeric assertions. No visual rendering, real-time playback, or external service integration was introduced.
|
||||
|
||||
---
|
||||
|
||||
### Gaps Summary
|
||||
|
||||
No gaps. All 12 must-have truths are verified. Both requirement IDs (WAVE-01, WAVE-02) are satisfied. The full test suite passes with zero failures across all packages.
|
||||
|
||||
---
|
||||
|
||||
_Verified: 2026-03-26_
|
||||
_Verifier: Claude (gsd-verifier)_
|
||||
@@ -0,0 +1,323 @@
|
||||
---
|
||||
phase: 06-config-package-and-sound-overrides
|
||||
plan: 01
|
||||
type: tdd
|
||||
wave: 1
|
||||
depends_on: []
|
||||
files_modified:
|
||||
- config/config.go
|
||||
- config/config_test.go
|
||||
- go.mod
|
||||
- go.sum
|
||||
autonomous: true
|
||||
requirements:
|
||||
- CFG-01
|
||||
- CFG-02
|
||||
- CFG-04
|
||||
- CFG-05
|
||||
|
||||
must_haves:
|
||||
truths:
|
||||
- "Load with explicit path to valid TOML returns merged config map with overrides applied"
|
||||
- "Load with no config file found returns default ClassFreqConfigs unchanged"
|
||||
- "Load with unknown TOML key returns error naming the bad key"
|
||||
- "Load with partial override (only frequency set) leaves waveform unchanged"
|
||||
- "Load with partial override (only waveform set) leaves frequency unchanged"
|
||||
- "Load with unknown class name logs warning and does not error"
|
||||
artifacts:
|
||||
- path: "config/config.go"
|
||||
provides: "Load function, parse, validate, merge, discover"
|
||||
exports: ["Load"]
|
||||
- path: "config/config_test.go"
|
||||
provides: "Table-driven tests for CFG-01 through CFG-05"
|
||||
min_lines: 100
|
||||
key_links:
|
||||
- from: "config/config.go"
|
||||
to: "synth/config.go"
|
||||
via: "imports synth.FreqConfig, synth.WaveformType, synth.ClassFreqConfigs, synth.WaveformPresetHarmonics"
|
||||
pattern: "synth\\.FreqConfig|synth\\.ClassFreqConfigs|synth\\.WaveformPresetHarmonics"
|
||||
- from: "config/config.go"
|
||||
to: "classify/types.go"
|
||||
via: "imports classify.TrafficClass, classify.AllClasses"
|
||||
pattern: "classify\\.TrafficClass|classify\\.AllClasses"
|
||||
- from: "config/config.go"
|
||||
to: "github.com/BurntSushi/toml"
|
||||
via: "toml.DecodeFile, md.Undecoded()"
|
||||
pattern: "toml\\.DecodeFile|Undecoded"
|
||||
---
|
||||
|
||||
<objective>
|
||||
Create the `config` package with TOML loading, unknown-key validation, partial-merge semantics, and auto-discovery logic. This is the core of Phase 6 — all config behavior except CLI flag wiring.
|
||||
|
||||
Purpose: Implements CFG-01 (TOML override), CFG-02 (auto-discovery), CFG-04 (partial override), CFG-05 (unknown key error). The package exposes a single `Load(configPath string)` function that returns a ready-to-use `map[classify.TrafficClass]synth.FreqConfig`.
|
||||
|
||||
Output: `config/config.go`, `config/config_test.go`, updated `go.mod`/`go.sum`
|
||||
</objective>
|
||||
|
||||
<execution_context>
|
||||
@$HOME/.claude/get-shit-done/workflows/execute-plan.md
|
||||
@$HOME/.claude/get-shit-done/templates/summary.md
|
||||
</execution_context>
|
||||
|
||||
<context>
|
||||
@.planning/PROJECT.md
|
||||
@.planning/ROADMAP.md
|
||||
@.planning/STATE.md
|
||||
@.planning/phases/06-config-package-and-sound-overrides/06-CONTEXT.md
|
||||
@.planning/phases/06-config-package-and-sound-overrides/06-RESEARCH.md
|
||||
|
||||
<interfaces>
|
||||
<!-- Key types and contracts the executor needs. Extracted from codebase. -->
|
||||
|
||||
From synth/config.go:
|
||||
```go
|
||||
type WaveformType int
|
||||
const (
|
||||
WaveformCustom WaveformType = iota
|
||||
WaveformSine
|
||||
WaveformSquare
|
||||
WaveformSawtooth
|
||||
WaveformTriangle
|
||||
)
|
||||
|
||||
type HarmonicDef struct {
|
||||
Ratio int
|
||||
Amplitude float64
|
||||
}
|
||||
|
||||
type FreqConfig struct {
|
||||
BaseHz float64
|
||||
Harmonics []HarmonicDef
|
||||
Pan float64
|
||||
WaveformType WaveformType
|
||||
}
|
||||
|
||||
var ClassFreqConfigs = map[classify.TrafficClass]FreqConfig{ /* 14 entries */ }
|
||||
func WaveformPresetHarmonics(wt WaveformType, baseHz float64, sampleRate int) []HarmonicDef
|
||||
const SampleRate = 44100
|
||||
```
|
||||
|
||||
From classify/types.go:
|
||||
```go
|
||||
type TrafficClass string
|
||||
const (
|
||||
ClassICMP TrafficClass = "ICMP"
|
||||
ClassDNS TrafficClass = "DNS"
|
||||
ClassHTTPS TrafficClass = "HTTPS"
|
||||
ClassHTTP TrafficClass = "HTTP"
|
||||
ClassSSH TrafficClass = "SSH"
|
||||
ClassSMTP TrafficClass = "SMTP"
|
||||
ClassNTP TrafficClass = "NTP"
|
||||
ClassDHCP TrafficClass = "DHCP"
|
||||
ClassOtherTCP TrafficClass = "other-TCP"
|
||||
ClassOtherUDP TrafficClass = "other-UDP"
|
||||
ClassUnknown1 TrafficClass = "unknown-1"
|
||||
ClassUnknown2 TrafficClass = "unknown-2"
|
||||
ClassUnknown3 TrafficClass = "unknown-3"
|
||||
ClassUnknown4 TrafficClass = "unknown-4"
|
||||
)
|
||||
func AllClasses() []TrafficClass
|
||||
```
|
||||
|
||||
Go module path: `github.com/netsynth/netsynth`
|
||||
</interfaces>
|
||||
</context>
|
||||
|
||||
<feature>
|
||||
<name>Config package: TOML load, validate, merge</name>
|
||||
<files>config/config.go, config/config_test.go</files>
|
||||
<behavior>
|
||||
- Test: Load(explicitPath) with valid TOML `[sounds.ICMP]\nfrequency = 100.0` returns map where ICMP.BaseHz == 100.0 and all other classes unchanged (CFG-01, CFG-04)
|
||||
- Test: Load(explicitPath) with `[sounds.ICMP]\nwaveform = "square"` returns map where ICMP.WaveformType == WaveformSquare and ICMP.BaseHz unchanged (CFG-04)
|
||||
- Test: Load(explicitPath) with `[sounds.ICMP]\nfrequncy = 440` returns error containing "frequncy" (CFG-05)
|
||||
- Test: Load("") in a directory with no netsynth.toml returns default ClassFreqConfigs map with no error (CFG-02)
|
||||
- Test: Load(explicitPath) where file does not exist returns error containing "not found" (CFG-03 prep)
|
||||
- Test: Load(explicitPath) with `[sounds.BOGUS]\nfrequency = 100.0` returns no error but stderr contains "unknown class" (D-09)
|
||||
- Test: Load(explicitPath) with `[sounds.ICMP]\nfrequency = 100.0\nwaveform = "square"` returns ICMP with both overrides applied and harmonics regenerated
|
||||
- Test: Load(explicitPath) with `[sounds.ICMP]\nwaveform = "invalid"` returns error containing "invalid waveform"
|
||||
- Test: All 14 default classes present in result map regardless of override count
|
||||
</behavior>
|
||||
<implementation>
|
||||
Create `config/config.go` with:
|
||||
1. `SoundOverride` struct with pointer fields `Frequency *float64` and `Waveform *string` (toml tags)
|
||||
2. `rawConfig` struct with `Sounds map[string]SoundOverride` (toml tag "sounds")
|
||||
3. `Load(configPath string) (map[classify.TrafficClass]synth.FreqConfig, error)` — public entry point
|
||||
4. `resolvePath(configPath string) (path string, explicit bool, err error)` — handles D-05 discovery order
|
||||
5. `discoverPath() string` — probes ./netsynth.toml then ~/.config/netsynth/config.toml
|
||||
6. `parseFile(path string) (rawConfig, error)` — uses toml.DecodeFile + md.Undecoded() for CFG-05
|
||||
7. `validate(raw rawConfig) error` — validates waveform strings
|
||||
8. `merge(defaults map[classify.TrafficClass]synth.FreqConfig, overrides map[string]SoundOverride) map[classify.TrafficClass]synth.FreqConfig` — per-field overlay
|
||||
9. `copyDefaults() map[classify.TrafficClass]synth.FreqConfig` — shallow copy of ClassFreqConfigs
|
||||
10. `parseWaveform(s string) (synth.WaveformType, error)` — string-to-enum map
|
||||
11. `validWaveforms` map: "sine"->WaveformSine, "square"->WaveformSquare, "sawtooth"->WaveformSawtooth, "triangle"->WaveformTriangle
|
||||
|
||||
Add `github.com/BurntSushi/toml@v1.6.0` to go.mod via `go get`.
|
||||
|
||||
Per D-03: Per-field overlay merge — only non-nil pointer fields override defaults.
|
||||
Per D-07: Unknown keys detected via md.Undecoded(), error names the key.
|
||||
Per D-09: Unknown class names in [sounds.<name>] produce warning to stderr, not error.
|
||||
Per D-05: Discovery order: --config > ./netsynth.toml > ~/.config/netsynth/config.toml.
|
||||
Per D-06: Only one config file loaded, first found wins.
|
||||
Per D-08: Type mismatches produce clear error with field name.
|
||||
Per D-11: All validation happens before returning — fail fast.
|
||||
|
||||
When frequency is overridden and WaveformType != WaveformCustom, regenerate Harmonics via WaveformPresetHarmonics(cfg.WaveformType, newBaseHz, synth.SampleRate).
|
||||
When waveform is overridden, regenerate Harmonics via WaveformPresetHarmonics(newWt, cfg.BaseHz, synth.SampleRate).
|
||||
</implementation>
|
||||
</feature>
|
||||
|
||||
<tasks>
|
||||
|
||||
<task type="auto" tdd="true">
|
||||
<name>Task 1: Config package — TDD red-green-refactor</name>
|
||||
<files>config/config.go, config/config_test.go, go.mod, go.sum</files>
|
||||
<read_first>
|
||||
synth/config.go (FreqConfig, WaveformType, ClassFreqConfigs, WaveformPresetHarmonics, SampleRate)
|
||||
classify/types.go (TrafficClass, AllClasses, class constants)
|
||||
go.mod (current dependencies)
|
||||
.planning/phases/06-config-package-and-sound-overrides/06-RESEARCH.md (patterns 1-5, pitfalls 1-4)
|
||||
</read_first>
|
||||
<behavior>
|
||||
- TestLoadPartialOverrideFrequency: Load TOML `[sounds.ICMP]\nfrequency = 100.0` -> ICMP.BaseHz == 100.0, ICMP.WaveformType == synth.WaveformCustom (unchanged), DNS.BaseHz == 110.0 (unchanged)
|
||||
- TestLoadPartialOverrideWaveform: Load TOML `[sounds.ICMP]\nwaveform = "square"` -> ICMP.WaveformType == synth.WaveformSquare, ICMP.BaseHz == 65.0 (unchanged), len(ICMP.Harmonics) > 0
|
||||
- TestLoadBothOverrides: Load TOML `[sounds.ICMP]\nfrequency = 100.0\nwaveform = "square"` -> ICMP.BaseHz == 100.0, ICMP.WaveformType == synth.WaveformSquare
|
||||
- TestLoadUnknownKey: Load TOML `[sounds.ICMP]\nfrequncy = 440` -> error != nil, error contains "frequncy"
|
||||
- TestLoadNoConfig: Load("") in temp dir with no netsynth.toml -> err == nil, result has 14 entries, ICMP.BaseHz == 65.0
|
||||
- TestLoadExplicitMissing: Load("/nonexistent/file.toml") -> error != nil, error contains "not found"
|
||||
- TestLoadUnknownClass: Load TOML `[sounds.BOGUS]\nfrequency = 100.0` -> err == nil, result has 14 entries (BOGUS not present)
|
||||
- TestLoadInvalidWaveform: Load TOML `[sounds.ICMP]\nwaveform = "invalid"` -> error != nil, error contains "invalid waveform"
|
||||
- TestLoadAllDefaultsPresent: Load with any valid override -> len(result) == 14
|
||||
</behavior>
|
||||
<action>
|
||||
**RED phase:** Create `config/config_test.go` with all 9 test functions listed in behavior above. Each test:
|
||||
- Creates a temp TOML file with `os.CreateTemp(t.TempDir(), "*.toml")`
|
||||
- Calls `config.Load(tmpFile.Name())` (or `config.Load("")` for no-config test)
|
||||
- Asserts expected outcomes
|
||||
|
||||
For TestLoadNoConfig: use `t.Chdir(t.TempDir())` (Go 1.24 testing.T.Chdir) to ensure no netsynth.toml exists in working directory.
|
||||
|
||||
Create a minimal `config/config.go` with just `package config` and a stub `Load` function returning nil, nil so the test file compiles. Run `go test ./config/... -count=1` — all tests must FAIL (red).
|
||||
|
||||
**GREEN phase:** Implement `config/config.go` fully:
|
||||
|
||||
1. Run `go get github.com/BurntSushi/toml@v1.6.0` to add the dependency.
|
||||
|
||||
2. Package declaration and imports:
|
||||
```
|
||||
package config
|
||||
imports: errors, fmt, io/fs, os, path/filepath, strings
|
||||
github.com/BurntSushi/toml
|
||||
github.com/netsynth/netsynth/classify
|
||||
github.com/netsynth/netsynth/synth
|
||||
```
|
||||
|
||||
3. Types:
|
||||
- `SoundOverride` struct: `Frequency *float64 \`toml:"frequency"\``, `Waveform *string \`toml:"waveform"\``
|
||||
- `rawConfig` struct: `Sounds map[string]SoundOverride \`toml:"sounds"\``
|
||||
|
||||
4. `validWaveforms` var: map[string]synth.WaveformType with entries "sine"->WaveformSine, "square"->WaveformSquare, "sawtooth"->WaveformSawtooth, "triangle"->WaveformTriangle
|
||||
|
||||
5. `Load(configPath string) (map[classify.TrafficClass]synth.FreqConfig, error)`:
|
||||
- Call resolvePath(configPath) -> path, explicit, err
|
||||
- If err != nil, return nil, err
|
||||
- If path == "", return copyDefaults(), nil (CFG-02: silent default)
|
||||
- Call parseFile(path) -> raw, err
|
||||
- If err != nil AND explicit AND errors.Is(err, fs.ErrNotExist): return nil, fmt.Errorf("config file not found: %s", configPath)
|
||||
- If err != nil (other): return nil, err
|
||||
- Call validate(raw) -> err; if err, return nil, err
|
||||
- Return merge(copyDefaults(), raw.Sounds), nil
|
||||
|
||||
6. `resolvePath(configPath string) (string, bool, error)`:
|
||||
- If configPath != "": return configPath, true, nil
|
||||
- path := discoverPath()
|
||||
- return path, false, nil
|
||||
|
||||
7. `discoverPath() string`:
|
||||
- Check `os.Stat("netsynth.toml")` — if err == nil, return "netsynth.toml"
|
||||
- dir, err := os.UserConfigDir(); if err != nil, return ""
|
||||
- p := filepath.Join(dir, "netsynth", "config.toml")
|
||||
- Check os.Stat(p) — if err == nil, return p
|
||||
- return ""
|
||||
|
||||
8. `parseFile(path string) (rawConfig, error)`:
|
||||
- var raw rawConfig
|
||||
- md, err := toml.DecodeFile(path, &raw)
|
||||
- If err != nil, return raw, err (this handles file-not-found and parse errors including D-08 type mismatches)
|
||||
- undecoded := md.Undecoded()
|
||||
- If len(undecoded) > 0: keyPath := strings.Join(undecoded[0].String() ... ) — actually undecoded is []toml.Key where Key is []string. Use `undecoded[0].String()` which returns dot-joined path. Return raw, fmt.Errorf("config: unknown key %q — check spelling", undecoded[0].String())
|
||||
- Return raw, nil
|
||||
|
||||
9. `validate(raw rawConfig) error`:
|
||||
- For each className, override in raw.Sounds:
|
||||
- If override.Waveform != nil: call parseWaveform(*override.Waveform); if err, return err
|
||||
|
||||
10. `parseWaveform(s string) (synth.WaveformType, error)`:
|
||||
- If wt, ok := validWaveforms[s]; ok: return wt, nil
|
||||
- valid := []string{"sine", "square", "sawtooth", "triangle"}
|
||||
- Return 0, fmt.Errorf("config: invalid waveform %q — valid values: %s", s, strings.Join(valid, ", "))
|
||||
|
||||
11. `copyDefaults() map[classify.TrafficClass]synth.FreqConfig`:
|
||||
- result := make(map[...], len(synth.ClassFreqConfigs))
|
||||
- For k, v := range synth.ClassFreqConfigs: result[k] = v
|
||||
- Return result
|
||||
- Comment: "Shallow copy is safe because merge assigns fresh Harmonics slices from WaveformPresetHarmonics, never mutates the original."
|
||||
|
||||
12. `merge(defaults map[classify.TrafficClass]synth.FreqConfig, overrides map[string]SoundOverride) map[classify.TrafficClass]synth.FreqConfig`:
|
||||
- For className, override := range overrides:
|
||||
- class := classify.TrafficClass(className)
|
||||
- cfg, known := defaults[class]
|
||||
- If !known: fmt.Fprintf(os.Stderr, "Warning: config: unknown class %q (ignored)\n", className); continue (D-09)
|
||||
- If override.Frequency != nil:
|
||||
- cfg.BaseHz = *override.Frequency
|
||||
- If cfg.WaveformType != synth.WaveformCustom: cfg.Harmonics = synth.WaveformPresetHarmonics(cfg.WaveformType, cfg.BaseHz, synth.SampleRate)
|
||||
- If override.Waveform != nil:
|
||||
- wt, _ := parseWaveform(*override.Waveform) (already validated)
|
||||
- cfg.WaveformType = wt
|
||||
- cfg.Harmonics = synth.WaveformPresetHarmonics(wt, cfg.BaseHz, synth.SampleRate)
|
||||
- defaults[class] = cfg
|
||||
- Return defaults
|
||||
|
||||
Run `go test ./config/... -count=1` — all tests must PASS (green).
|
||||
|
||||
**REFACTOR:** Review for clarity. Run `go vet ./config/...` clean.
|
||||
</action>
|
||||
<verify>
|
||||
<automated>cd /home/dev/workspace/yoloyolo && go test ./config/... -count=1 -v</automated>
|
||||
</verify>
|
||||
<acceptance_criteria>
|
||||
- config/config.go contains `func Load(configPath string) (map[classify.TrafficClass]synth.FreqConfig, error)`
|
||||
- config/config.go contains `type SoundOverride struct` with `Frequency *float64` and `Waveform *string`
|
||||
- config/config.go contains `type rawConfig struct` with `Sounds map[string]SoundOverride`
|
||||
- config/config.go contains `toml.DecodeFile` call
|
||||
- config/config.go contains `md.Undecoded()` call
|
||||
- config/config.go contains `validWaveforms` map with 4 entries
|
||||
- config/config.go contains `os.UserConfigDir()` call in discoverPath
|
||||
- config/config_test.go contains at least 9 test functions (TestLoad*)
|
||||
- go.mod contains `github.com/BurntSushi/toml`
|
||||
- `go test ./config/... -count=1` exits 0
|
||||
- `go vet ./config/...` exits 0
|
||||
</acceptance_criteria>
|
||||
<done>
|
||||
config package exists with Load function that handles TOML parsing, unknown-key detection, partial-merge, auto-discovery, and waveform validation. All 9+ tests pass. BurntSushi/toml dependency in go.mod.
|
||||
</done>
|
||||
</task>
|
||||
|
||||
</tasks>
|
||||
|
||||
<verification>
|
||||
- `go test ./config/... -count=1 -v` — all tests pass
|
||||
- `go vet ./config/...` — no issues
|
||||
- `go build ./config/...` — compiles cleanly
|
||||
</verification>
|
||||
|
||||
<success_criteria>
|
||||
- config.Load("path/to/valid.toml") returns merged map with overrides applied (CFG-01)
|
||||
- config.Load("") with no config file returns defaults silently (CFG-02)
|
||||
- config.Load("") with partial TOML returns map where unset fields retain defaults (CFG-04)
|
||||
- config.Load("path/to/typo.toml") with unknown key returns error naming the key (CFG-05)
|
||||
- All 14 default classes always present in result map
|
||||
</success_criteria>
|
||||
|
||||
<output>
|
||||
After completion, create `.planning/phases/06-config-package-and-sound-overrides/06-01-SUMMARY.md`
|
||||
</output>
|
||||
+130
@@ -0,0 +1,130 @@
|
||||
---
|
||||
phase: 06-config-package-and-sound-overrides
|
||||
plan: 01
|
||||
subsystem: config
|
||||
tags: [toml, BurntSushi/toml, config-loading, partial-merge, validation]
|
||||
|
||||
# Dependency graph
|
||||
requires:
|
||||
- phase: 05-waveform-types-and-bank-decoupling
|
||||
provides: WaveformType enum, WaveformPresetHarmonics, FreqConfig.WaveformType field
|
||||
- phase: 01-capture-and-classification
|
||||
provides: classify.TrafficClass, classify.AllClasses, 14 class constants
|
||||
|
||||
provides:
|
||||
- config.Load(configPath string) returns map[classify.TrafficClass]synth.FreqConfig
|
||||
- SoundOverride struct with pointer fields for partial-merge semantics
|
||||
- TOML file parsing with unknown-key detection via BurntSushi/toml Undecoded()
|
||||
- Auto-discovery of ./netsynth.toml and ~/.config/netsynth/config.toml
|
||||
- Per-field overlay merge preserving unspecified defaults
|
||||
- Waveform string validation before merge (fail fast)
|
||||
|
||||
affects:
|
||||
- 06-02 (CLI flag wiring: --config flag passes configPath to config.Load)
|
||||
- encode package (RunSynthesis will accept merged config map from config.Load)
|
||||
|
||||
# Tech tracking
|
||||
tech-stack:
|
||||
added: ["github.com/BurntSushi/toml v1.6.0 — TOML parsing with MetaData.Undecoded() for unknown-key detection"]
|
||||
patterns:
|
||||
- "Pointer fields (*float64, *string) in decode struct for partial-override semantics (nil = not set)"
|
||||
- "parseFile → validate → merge pipeline for fail-fast config loading (D-11)"
|
||||
- "Dedicated config package for testable isolation from Cobra/CLI concerns"
|
||||
|
||||
key-files:
|
||||
created:
|
||||
- config/config.go
|
||||
- config/config_test.go
|
||||
modified:
|
||||
- go.mod
|
||||
- go.sum
|
||||
|
||||
key-decisions:
|
||||
- "Used BurntSushi/toml v1.6.0 over pelletier/go-toml v2 — Undecoded() returns structured []Key (not formatted string), easier to extract key name for error messages"
|
||||
- "Shallow copy in copyDefaults() is safe because merge reconstructs Harmonics via WaveformPresetHarmonics rather than mutating the original slice"
|
||||
- "Unknown class names produce stderr warning (not error) per D-09, preparing for Phase 7 user-defined classes"
|
||||
|
||||
patterns-established:
|
||||
- "Config package is independent of cmd/ — no Cobra imports, fully unit-testable"
|
||||
- "Merge functions take defaults map by value and modify in place, returning it"
|
||||
|
||||
requirements-completed: [CFG-01, CFG-02, CFG-04, CFG-05]
|
||||
|
||||
# Metrics
|
||||
duration: 3min
|
||||
completed: 2026-03-26
|
||||
---
|
||||
|
||||
# Phase 6 Plan 01: Config Package Summary
|
||||
|
||||
**TOML-based config loader with pointer-field partial merge, BurntSushi/toml Undecoded() unknown-key detection, and XDG auto-discovery at ./netsynth.toml and ~/.config/netsynth/config.toml**
|
||||
|
||||
## Performance
|
||||
|
||||
- **Duration:** ~3 min
|
||||
- **Started:** 2026-03-26T19:55:08Z
|
||||
- **Completed:** 2026-03-26T19:57:45Z
|
||||
- **Tasks:** 1 (TDD: red → green)
|
||||
- **Files modified:** 4 (config/config.go, config/config_test.go, go.mod, go.sum)
|
||||
|
||||
## Accomplishments
|
||||
|
||||
- Created `config` package with single `Load(configPath string)` public API
|
||||
- Implemented pointer-field partial merge: only non-nil fields override defaults (CFG-04)
|
||||
- Added BurntSushi/toml Undecoded() for field-level typo detection (CFG-05)
|
||||
- Auto-discovery of netsynth.toml in working dir and ~/.config/netsynth/config.toml (CFG-02)
|
||||
- Explicit file missing returns clear error; auto-discovery missing is silent (CFG-02/CFG-03)
|
||||
- Harmonics regenerated via WaveformPresetHarmonics when waveform or frequency is overridden
|
||||
- All 9 tests pass; go vet clean
|
||||
|
||||
## Task Commits
|
||||
|
||||
Each task committed atomically via TDD:
|
||||
|
||||
1. **RED - Failing tests** - `b9ec05a` (test): 9 test functions for CFG-01 through CFG-05
|
||||
2. **GREEN - Full implementation** - `1f877e7` (feat): config.Load, merge, validate, discover
|
||||
|
||||
_Note: TDD task has two commits (RED test stub → GREEN implementation)_
|
||||
|
||||
## Files Created/Modified
|
||||
|
||||
- `config/config.go` - Load(), SoundOverride, rawConfig, merge, validate, discoverPath
|
||||
- `config/config_test.go` - 9 test functions covering all CFG requirements
|
||||
- `go.mod` - Added github.com/BurntSushi/toml v1.6.0
|
||||
- `go.sum` - Updated checksum for new dependency
|
||||
|
||||
## Decisions Made
|
||||
|
||||
- **BurntSushi/toml over pelletier/go-toml v2**: Undecoded() returns `[]toml.Key` ([]string slices) — structured, allowing exact key name extraction for error messages. pelletier's DisallowUnknownFields returns a formatted string (harder to extract just the key name).
|
||||
- **Shallow copy in copyDefaults()**: Safe because merge code always replaces `Harmonics` with a freshly generated slice from WaveformPresetHarmonics rather than mutating the original. Documented with comment for future maintainers.
|
||||
- **Unknown class warning (not error)**: Following D-09 to emit `fmt.Fprintf(os.Stderr, "Warning: ...")` for unknown class names. Phase 7 user-defined classes will be valid, so this is by design.
|
||||
|
||||
## Deviations from Plan
|
||||
|
||||
None - plan executed exactly as written. The worktree needed a rebase onto master to include phase 05 code (WaveformType, WaveformPresetHarmonics) before starting — this was a prerequisite resolution, not a deviation.
|
||||
|
||||
## Issues Encountered
|
||||
|
||||
- Worktree was based on remote origin/master (pre-phase-05). Rebased onto local master to get WaveformType and WaveformPresetHarmonics before implementation. No code conflicts.
|
||||
|
||||
## User Setup Required
|
||||
|
||||
None - no external service configuration required. BurntSushi/toml is fetched automatically via `go get`.
|
||||
|
||||
## Next Phase Readiness
|
||||
|
||||
- `config.Load()` is ready for wiring into `cmd/netsynth/main.go` via `--config` flag (Plan 06-02)
|
||||
- `encode.RunSynthesis` signature change (accept `freqCfgs map[classify.TrafficClass]synth.FreqConfig`) is needed in Plan 06-02
|
||||
- All 14 default classes always present in result map — safe to pass directly to `synth.NewBank()`
|
||||
|
||||
## Self-Check: PASSED
|
||||
|
||||
- FOUND: config/config.go
|
||||
- FOUND: config/config_test.go
|
||||
- FOUND: .planning/phases/06-config-package-and-sound-overrides/06-01-SUMMARY.md
|
||||
- FOUND: b9ec05a (RED commit — failing tests)
|
||||
- FOUND: 1f877e7 (GREEN commit — full implementation)
|
||||
|
||||
---
|
||||
*Phase: 06-config-package-and-sound-overrides*
|
||||
*Completed: 2026-03-26*
|
||||
@@ -0,0 +1,262 @@
|
||||
---
|
||||
phase: 06-config-package-and-sound-overrides
|
||||
plan: 02
|
||||
type: execute
|
||||
wave: 2
|
||||
depends_on: ["06-01"]
|
||||
files_modified:
|
||||
- encode/mp3.go
|
||||
- encode/mp3_test.go
|
||||
- cmd/netsynth/main.go
|
||||
autonomous: true
|
||||
requirements:
|
||||
- CFG-03
|
||||
|
||||
must_haves:
|
||||
truths:
|
||||
- "User passes --config /path/to/file.toml and the tool uses that file for sound overrides"
|
||||
- "User passes --config /nonexistent.toml and the tool exits with a clear error before capture"
|
||||
- "User runs without --config and auto-discovery kicks in (or defaults used silently)"
|
||||
- "RunSynthesis uses the merged config map instead of hardcoded ClassFreqConfigs"
|
||||
artifacts:
|
||||
- path: "cmd/netsynth/main.go"
|
||||
provides: "--config flag, config.Load call, passing merged map to RunSynthesis"
|
||||
contains: "configPath"
|
||||
- path: "encode/mp3.go"
|
||||
provides: "RunSynthesis with freqCfgs parameter"
|
||||
contains: "freqCfgs map[classify.TrafficClass]synth.FreqConfig"
|
||||
- path: "encode/mp3_test.go"
|
||||
provides: "Updated tests for new RunSynthesis signature"
|
||||
key_links:
|
||||
- from: "cmd/netsynth/main.go"
|
||||
to: "config/config.go"
|
||||
via: "config.Load(configPath)"
|
||||
pattern: "config\\.Load"
|
||||
- from: "cmd/netsynth/main.go"
|
||||
to: "encode/mp3.go"
|
||||
via: "encode.RunSynthesis(snapshots, outputPath, freqCfgs)"
|
||||
pattern: "encode\\.RunSynthesis.*freqCfgs"
|
||||
- from: "encode/mp3.go"
|
||||
to: "synth/bank.go"
|
||||
via: "synth.NewBank(1.0, freqCfgs) using passed-in config"
|
||||
pattern: "synth\\.NewBank.*freqCfgs"
|
||||
---
|
||||
|
||||
<objective>
|
||||
Wire the config package into the CLI and synthesis pipeline. Add `--config` flag to Cobra, call `config.Load` at startup, change `RunSynthesis` signature to accept the merged config map, and update all call sites.
|
||||
|
||||
Purpose: Completes CFG-03 (explicit --config flag) and D-10 (RunSynthesis signature change). After this plan, the end-to-end flow works: user creates TOML -> tool loads it -> synthesis uses overridden frequencies/waveforms.
|
||||
|
||||
Output: Updated `cmd/netsynth/main.go`, `encode/mp3.go`, `encode/mp3_test.go`
|
||||
</objective>
|
||||
|
||||
<execution_context>
|
||||
@$HOME/.claude/get-shit-done/workflows/execute-plan.md
|
||||
@$HOME/.claude/get-shit-done/templates/summary.md
|
||||
</execution_context>
|
||||
|
||||
<context>
|
||||
@.planning/PROJECT.md
|
||||
@.planning/ROADMAP.md
|
||||
@.planning/STATE.md
|
||||
@.planning/phases/06-config-package-and-sound-overrides/06-CONTEXT.md
|
||||
@.planning/phases/06-config-package-and-sound-overrides/06-01-SUMMARY.md
|
||||
|
||||
<interfaces>
|
||||
<!-- Key types and contracts the executor needs. -->
|
||||
|
||||
From config/config.go (created in Plan 01):
|
||||
```go
|
||||
// Load finds, parses, validates, and merges a config file.
|
||||
// configPath is the --config flag value; empty string triggers auto-discovery.
|
||||
func Load(configPath string) (map[classify.TrafficClass]synth.FreqConfig, error)
|
||||
```
|
||||
|
||||
From encode/mp3.go (current signature to change):
|
||||
```go
|
||||
// Current:
|
||||
func RunSynthesis(snapshots []classify.WindowSnapshot, outputPath string) error
|
||||
// New:
|
||||
func RunSynthesis(snapshots []classify.WindowSnapshot, outputPath string, freqCfgs map[classify.TrafficClass]synth.FreqConfig) error
|
||||
```
|
||||
|
||||
From cmd/netsynth/main.go (existing flags pattern):
|
||||
```go
|
||||
var (
|
||||
ifaceName string
|
||||
listIfaces bool
|
||||
verbose bool
|
||||
outputPath string
|
||||
bpfFilter string
|
||||
readPath string
|
||||
)
|
||||
// Flag registration pattern:
|
||||
rootCmd.Flags().StringVar(&bpfFilter, "filter", "", "BPF filter expression")
|
||||
```
|
||||
|
||||
From synth/config.go:
|
||||
```go
|
||||
var ClassFreqConfigs = map[classify.TrafficClass]FreqConfig{ /* 14 entries */ }
|
||||
```
|
||||
</interfaces>
|
||||
</context>
|
||||
|
||||
<tasks>
|
||||
|
||||
<task type="auto">
|
||||
<name>Task 1: Change RunSynthesis signature and update encode tests</name>
|
||||
<files>encode/mp3.go, encode/mp3_test.go</files>
|
||||
<read_first>
|
||||
encode/mp3.go (current RunSynthesis signature and body)
|
||||
encode/mp3_test.go (current test calls to RunSynthesis)
|
||||
synth/config.go (ClassFreqConfigs, FreqConfig type)
|
||||
classify/types.go (TrafficClass type)
|
||||
</read_first>
|
||||
<action>
|
||||
**encode/mp3.go changes:**
|
||||
|
||||
1. Add `freqCfgs map[classify.TrafficClass]synth.FreqConfig` as third parameter to RunSynthesis:
|
||||
```
|
||||
func RunSynthesis(snapshots []classify.WindowSnapshot, outputPath string, freqCfgs map[classify.TrafficClass]synth.FreqConfig) error
|
||||
```
|
||||
|
||||
2. Change line 57 from:
|
||||
```
|
||||
bank := synth.NewBank(1.0, synth.ClassFreqConfigs)
|
||||
```
|
||||
to:
|
||||
```
|
||||
bank := synth.NewBank(1.0, freqCfgs)
|
||||
```
|
||||
|
||||
3. No other changes to encode/mp3.go.
|
||||
|
||||
**encode/mp3_test.go changes:**
|
||||
|
||||
4. Update `TestMP3Valid` (line 56): change `RunSynthesis(snaps, tmpPath)` to `RunSynthesis(snaps, tmpPath, synth.ClassFreqConfigs)`.
|
||||
|
||||
5. Update `TestZeroPacketError` (line 101): change `RunSynthesis([]classify.WindowSnapshot{}, tmpPath)` to `RunSynthesis([]classify.WindowSnapshot{}, tmpPath, synth.ClassFreqConfigs)`.
|
||||
|
||||
6. Update `TestZeroPacketError` (line 121): change `RunSynthesis(zeroSnaps, tmpPath2)` to `RunSynthesis(zeroSnaps, tmpPath2, synth.ClassFreqConfigs)`.
|
||||
|
||||
The `synth` import is already present in mp3_test.go.
|
||||
</action>
|
||||
<verify>
|
||||
<automated>cd /home/dev/workspace/yoloyolo && go build ./encode/... && go test ./encode/... -count=1 -run TestZeroPacketError</automated>
|
||||
</verify>
|
||||
<acceptance_criteria>
|
||||
- encode/mp3.go contains `func RunSynthesis(snapshots []classify.WindowSnapshot, outputPath string, freqCfgs map[classify.TrafficClass]synth.FreqConfig) error`
|
||||
- encode/mp3.go contains `synth.NewBank(1.0, freqCfgs)` (not synth.ClassFreqConfigs)
|
||||
- encode/mp3_test.go contains `RunSynthesis(snaps, tmpPath, synth.ClassFreqConfigs)`
|
||||
- encode/mp3_test.go contains `RunSynthesis([]classify.WindowSnapshot{}, tmpPath, synth.ClassFreqConfigs)`
|
||||
- encode/mp3_test.go contains `RunSynthesis(zeroSnaps, tmpPath2, synth.ClassFreqConfigs)`
|
||||
- `go build ./encode/...` exits 0
|
||||
- `go test ./encode/... -count=1 -run TestZeroPacketError` exits 0
|
||||
</acceptance_criteria>
|
||||
<done>
|
||||
RunSynthesis accepts injected config map. All encode tests updated and passing.
|
||||
</done>
|
||||
</task>
|
||||
|
||||
<task type="auto">
|
||||
<name>Task 2: Add --config flag and wire config.Load into main.go</name>
|
||||
<files>cmd/netsynth/main.go</files>
|
||||
<read_first>
|
||||
cmd/netsynth/main.go (full file — flag definitions, run function, runLiveMode, runPcapMode)
|
||||
config/config.go (Load function signature)
|
||||
encode/mp3.go (updated RunSynthesis signature from Task 1)
|
||||
</read_first>
|
||||
<action>
|
||||
**cmd/netsynth/main.go changes:**
|
||||
|
||||
1. Add `configPath` to the var block (after `readPath`):
|
||||
```go
|
||||
configPath string // NEW: --config flag (CFG-03)
|
||||
```
|
||||
|
||||
2. Add import for config package in the import block:
|
||||
```go
|
||||
"github.com/netsynth/netsynth/config"
|
||||
```
|
||||
Also add import for `synth` package (needed for ClassFreqConfigs fallback reference — though config.Load handles this internally):
|
||||
No — `synth` is NOT needed in main.go. `config.Load` returns the full map. Only add `config` import.
|
||||
|
||||
3. Add flag registration in main() after the `readPath` flag line (line 44):
|
||||
```go
|
||||
rootCmd.Flags().StringVar(&configPath, "config", "", "Path to TOML config file (default: auto-discover)")
|
||||
```
|
||||
|
||||
4. In the `run` function, add config loading AFTER the BPF filter validation block (after line 80) and BEFORE output path resolution (before line 83). This is per D-11 (fail fast on config errors before capture):
|
||||
```go
|
||||
// Load config (CFG-01 through CFG-05, D-11: fail fast)
|
||||
freqCfgs, err := config.Load(configPath)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
```
|
||||
|
||||
5. The `freqCfgs` variable must be accessible in both `runLiveMode` and `runPcapMode`. Two approaches:
|
||||
- Option A: Pass freqCfgs to both functions (cleanest).
|
||||
- Option B: Store in a package-level var (simpler change).
|
||||
|
||||
Use Option A. Change signatures:
|
||||
- `runLiveMode(cmd *cobra.Command) error` -> `runLiveMode(cmd *cobra.Command, freqCfgs map[classify.TrafficClass]synth.FreqConfig) error`
|
||||
- `runPcapMode(cmd *cobra.Command) error` -> `runPcapMode(cmd *cobra.Command, freqCfgs map[classify.TrafficClass]synth.FreqConfig) error`
|
||||
|
||||
This requires adding `synth` import after all:
|
||||
```go
|
||||
"github.com/netsynth/netsynth/synth"
|
||||
```
|
||||
|
||||
Update call sites in `run()`:
|
||||
- Line 92: `return runPcapMode(cmd)` -> `return runPcapMode(cmd, freqCfgs)`
|
||||
- Line 94: `return runLiveMode(cmd)` -> `return runLiveMode(cmd, freqCfgs)`
|
||||
|
||||
6. In `runLiveMode`, change the RunSynthesis call (line 147):
|
||||
From: `encode.RunSynthesis(collectedSnapshots, outputPath)`
|
||||
To: `encode.RunSynthesis(collectedSnapshots, outputPath, freqCfgs)`
|
||||
|
||||
7. In `runPcapMode`, change the RunSynthesis call (line 215):
|
||||
From: `encode.RunSynthesis(collectedSnapshots, outputPath)`
|
||||
To: `encode.RunSynthesis(collectedSnapshots, outputPath, freqCfgs)`
|
||||
|
||||
After all changes, run `go build ./cmd/netsynth/...` to verify compilation.
|
||||
</action>
|
||||
<verify>
|
||||
<automated>cd /home/dev/workspace/yoloyolo && go build ./cmd/netsynth/... && go vet ./cmd/netsynth/... && go test ./... -count=1 2>&1 | tail -20</automated>
|
||||
</verify>
|
||||
<acceptance_criteria>
|
||||
- cmd/netsynth/main.go contains `configPath string`
|
||||
- cmd/netsynth/main.go contains `rootCmd.Flags().StringVar(&configPath, "config", ""`
|
||||
- cmd/netsynth/main.go contains `config.Load(configPath)`
|
||||
- cmd/netsynth/main.go contains `"github.com/netsynth/netsynth/config"` in imports
|
||||
- cmd/netsynth/main.go contains `encode.RunSynthesis(collectedSnapshots, outputPath, freqCfgs)` (two occurrences — one in runLiveMode, one in runPcapMode)
|
||||
- cmd/netsynth/main.go contains `runLiveMode(cmd, freqCfgs)` and `runPcapMode(cmd, freqCfgs)`
|
||||
- `go build ./cmd/netsynth/...` exits 0
|
||||
- `go vet ./cmd/netsynth/...` exits 0
|
||||
- `go test ./... -count=1` exits 0 (full suite green)
|
||||
</acceptance_criteria>
|
||||
<done>
|
||||
--config flag registered in Cobra. config.Load called at startup before capture. Merged config map flows through to RunSynthesis in both live and pcap modes. Full test suite passes.
|
||||
</done>
|
||||
</task>
|
||||
|
||||
</tasks>
|
||||
|
||||
<verification>
|
||||
- `go build ./...` compiles entire project
|
||||
- `go test ./... -count=1` all tests pass
|
||||
- `go vet ./...` no issues
|
||||
- `./netsynth --help` shows `--config` flag in output
|
||||
</verification>
|
||||
|
||||
<success_criteria>
|
||||
- --config flag appears in CLI help output (CFG-03)
|
||||
- Explicit --config with missing file produces error before capture (CFG-03)
|
||||
- RunSynthesis uses injected config map, not hardcoded ClassFreqConfigs (D-10)
|
||||
- Full test suite passes including encode and config package tests
|
||||
</success_criteria>
|
||||
|
||||
<output>
|
||||
After completion, create `.planning/phases/06-config-package-and-sound-overrides/06-02-SUMMARY.md`
|
||||
</output>
|
||||
+119
@@ -0,0 +1,119 @@
|
||||
---
|
||||
phase: 06-config-package-and-sound-overrides
|
||||
plan: 02
|
||||
subsystem: cmd/encode
|
||||
tags: [cli, config, RunSynthesis, dependency-injection, cobra]
|
||||
|
||||
# Dependency graph
|
||||
requires:
|
||||
- phase: 06-01
|
||||
provides: config.Load(configPath string) returns map[classify.TrafficClass]synth.FreqConfig
|
||||
- phase: 05-waveform-types-and-bank-decoupling
|
||||
provides: NewBank(tau, cfgs) with injected config map, FreqConfig.WaveformType
|
||||
|
||||
provides:
|
||||
- --config flag in CLI (CFG-03)
|
||||
- config.Load called at startup before capture (D-11 fail fast)
|
||||
- RunSynthesis(snapshots, outputPath, freqCfgs) with injected config map (D-10)
|
||||
- Merged config flows end-to-end: TOML file -> config.Load -> RunSynthesis -> NewBank
|
||||
|
||||
affects:
|
||||
- encode/mp3.go (RunSynthesis signature changed)
|
||||
- cmd/netsynth/main.go (--config flag, config.Load, pass freqCfgs through pipeline)
|
||||
|
||||
# Tech tracking
|
||||
tech-stack:
|
||||
added: []
|
||||
patterns:
|
||||
- "Dependency injection: config map flows from main() through runLiveMode/runPcapMode to RunSynthesis to NewBank"
|
||||
- "Fail-fast config loading: config.Load called after BPF validation, before capture starts (D-11)"
|
||||
- "Explicit configPath string var for --config flag, empty string triggers auto-discovery"
|
||||
|
||||
key-files:
|
||||
created: []
|
||||
modified:
|
||||
- encode/mp3.go
|
||||
- encode/mp3_test.go
|
||||
- cmd/netsynth/main.go
|
||||
|
||||
key-decisions:
|
||||
- "Option A for freqCfgs propagation: pass as parameter to runLiveMode/runPcapMode rather than package-level var — explicit data flow, easier to test"
|
||||
- "config.Load called before output path resolution — config errors abort before any state changes"
|
||||
|
||||
patterns-established:
|
||||
- "Config map injected at call boundary (main -> run -> runLiveMode/runPcapMode -> RunSynthesis -> NewBank)"
|
||||
|
||||
requirements-completed: [CFG-03]
|
||||
|
||||
# Metrics
|
||||
duration: 2min
|
||||
completed: 2026-03-26
|
||||
---
|
||||
|
||||
# Phase 6 Plan 02: CLI Config Wiring Summary
|
||||
|
||||
**--config flag added to Cobra, config.Load wired at startup, RunSynthesis signature changed to accept injected freqCfgs map — end-to-end config flow from TOML file to synthesis**
|
||||
|
||||
## Performance
|
||||
|
||||
- **Duration:** ~2 min
|
||||
- **Started:** 2026-03-26T20:01:59Z
|
||||
- **Completed:** 2026-03-26T20:04:27Z
|
||||
- **Tasks:** 2
|
||||
- **Files modified:** 3 (encode/mp3.go, encode/mp3_test.go, cmd/netsynth/main.go)
|
||||
|
||||
## Accomplishments
|
||||
|
||||
- Changed `RunSynthesis` third parameter: accepts `freqCfgs map[classify.TrafficClass]synth.FreqConfig` (D-10)
|
||||
- Updated all 3 RunSynthesis call sites in encode tests to pass `synth.ClassFreqConfigs`
|
||||
- Added `configPath string` var and `--config` flag registration in Cobra (CFG-03)
|
||||
- Imported `config` and `synth` packages into cmd/netsynth/main.go
|
||||
- Wired `config.Load(configPath)` into `run()` after BPF validation, before capture (D-11)
|
||||
- Changed `runLiveMode` and `runPcapMode` signatures to accept `freqCfgs` parameter
|
||||
- Updated both `encode.RunSynthesis` call sites to pass `freqCfgs`
|
||||
- Full test suite passes: 7 packages, all green
|
||||
|
||||
## Task Commits
|
||||
|
||||
1. **Task 1** - `3dfcbbe` feat(06-02): add freqCfgs parameter to RunSynthesis
|
||||
2. **Task 2** - `413cceb` feat(06-02): wire --config flag and config.Load into CLI pipeline
|
||||
|
||||
## Files Created/Modified
|
||||
|
||||
- `encode/mp3.go` - RunSynthesis now accepts `freqCfgs map[classify.TrafficClass]synth.FreqConfig`; uses `freqCfgs` in `synth.NewBank(1.0, freqCfgs)` call
|
||||
- `encode/mp3_test.go` - Updated 3 RunSynthesis calls to pass `synth.ClassFreqConfigs` as third arg
|
||||
- `cmd/netsynth/main.go` - `configPath` var, `--config` flag, `config` and `synth` imports, `config.Load` call, updated function signatures, updated RunSynthesis calls
|
||||
|
||||
## Decisions Made
|
||||
|
||||
- **Option A for freqCfgs propagation**: Pass config map as function parameter to `runLiveMode`/`runPcapMode` rather than storing in a package-level variable. Cleaner data flow, functions remain testable in isolation.
|
||||
- **config.Load position in run()**: Called after BPF filter validation, before output path resolution and capture start. Config errors abort immediately before any I/O begins (D-11).
|
||||
|
||||
## Deviations from Plan
|
||||
|
||||
None - plan executed exactly as written. The worktree required a rebase onto local master to include phase 05 bank-decoupling code (NewBank 2-arg signature) and phase 06-01 config package before implementation could begin — this is expected prerequisite resolution, not a deviation.
|
||||
|
||||
## Issues Encountered
|
||||
|
||||
- Worktree was based on origin/master (commit 41e2278, pre-phase-05). Rebased onto local master (936aeea) to get WaveformType, 2-arg NewBank, and config package. No code conflicts.
|
||||
|
||||
## User Setup Required
|
||||
|
||||
None.
|
||||
|
||||
## Next Phase Readiness
|
||||
|
||||
- Full end-to-end config flow is wired: user creates netsynth.toml -> `--config` passes path -> `config.Load` merges -> `RunSynthesis` uses merged map -> `NewBank` synthesizes with custom frequencies/waveforms
|
||||
- Phase 06-03 (if any) can build on this wired pipeline for additional config features
|
||||
|
||||
## Self-Check: PASSED
|
||||
|
||||
- FOUND: encode/mp3.go — contains `func RunSynthesis(snapshots []classify.WindowSnapshot, outputPath string, freqCfgs map[classify.TrafficClass]synth.FreqConfig) error`
|
||||
- FOUND: encode/mp3_test.go — contains `RunSynthesis(snaps, tmpPath, synth.ClassFreqConfigs)`
|
||||
- FOUND: cmd/netsynth/main.go — contains `configPath string`, `config.Load(configPath)`, `runLiveMode(cmd, freqCfgs)`
|
||||
- FOUND: 3dfcbbe (Task 1 commit)
|
||||
- FOUND: 413cceb (Task 2 commit)
|
||||
|
||||
---
|
||||
*Phase: 06-config-package-and-sound-overrides*
|
||||
*Completed: 2026-03-26*
|
||||
@@ -0,0 +1,111 @@
|
||||
# Phase 6: Config Package and Sound Overrides - Context
|
||||
|
||||
**Gathered:** 2026-03-26
|
||||
**Status:** Ready for planning
|
||||
|
||||
<domain>
|
||||
## Phase Boundary
|
||||
|
||||
Add a TOML-based configuration system that lets users override frequency and waveform per traffic class, with auto-discovery from standard paths, explicit `--config` flag, partial override semantics (only specified fields change), and strict unknown-key validation. Wire the merged config into the synthesis pipeline via the injection seam created in Phase 5.
|
||||
|
||||
Requirements covered: CFG-01 through CFG-05.
|
||||
|
||||
</domain>
|
||||
|
||||
<decisions>
|
||||
## Implementation Decisions
|
||||
|
||||
### TOML Schema Design
|
||||
- **D-01:** Use keyed TOML tables `[sounds.<classname>]` for per-class overrides. Each table supports `frequency` (float64, Hz) and `waveform` (string: "sine", "square", "sawtooth", "triangle"). Class names match `classify.TrafficClass` string values (e.g., `[sounds.ICMP]`, `[sounds.HTTPS]`).
|
||||
- **D-02:** Top-level structure is flat — no deeply nested hierarchies. Future phases (custom rules) will add `[[rules]]` array-of-tables at the top level.
|
||||
|
||||
### Config Merge Semantics
|
||||
- **D-03:** Per-field overlay merge — only fields explicitly set in TOML override defaults. Unspecified fields retain their built-in values. For example, setting only `frequency` for ICMP leaves its waveform and harmonics unchanged. This satisfies CFG-04 (partial override without replicating entire config).
|
||||
- **D-04:** Merge produces a `map[classify.TrafficClass]FreqConfig` that is passed to `synth.NewBank()` via the injection seam from Phase 5. The default map is `synth.ClassFreqConfigs`.
|
||||
|
||||
### Auto-Discovery and Precedence
|
||||
- **D-05:** Discovery order (most-specific wins): `--config <path>` > `./netsynth.toml` > `~/.config/netsynth/config.toml`. If `--config` is specified and the file does not exist, exit with a clear error before capture begins (CFG-03). If no config is found via auto-discovery, proceed silently with defaults (CFG-02).
|
||||
- **D-06:** Only one config file is loaded — no multi-file merge. The first found in precedence order wins entirely.
|
||||
|
||||
### Validation and Error Reporting
|
||||
- **D-07:** Unknown keys cause an immediate startup error naming the unrecognized key (CFG-05). Use TOML strict decoding to detect unknown keys. Suggest the closest valid key name if edit distance is small (nice-to-have, Claude's discretion on implementation).
|
||||
- **D-08:** Type mismatches (e.g., `frequency = "not a number"`) produce a clear error with field name and expected type, before capture begins.
|
||||
- **D-09:** Unknown class names in `[sounds.<classname>]` produce a warning (not error) — this prepares for Phase 7 where user-defined class names are valid.
|
||||
|
||||
### Pipeline Wiring
|
||||
- **D-10:** `encode.RunSynthesis` signature changes to accept the merged config map (or loads config internally). The `--config` flag is added to the Cobra root command in `cmd/netsynth/main.go`.
|
||||
- **D-11:** Config loading happens once at startup, before any capture begins — fail fast on all config errors.
|
||||
|
||||
### Claude's Discretion
|
||||
- TOML library choice (BurntSushi/toml vs pelletier/go-toml) — researcher should evaluate both
|
||||
- Whether to create a dedicated `config` package or keep loading in `cmd/netsynth`
|
||||
- Waveform string-to-WaveformType mapping implementation details
|
||||
- Edit distance algorithm for typo suggestions (or skip if complexity isn't justified)
|
||||
|
||||
</decisions>
|
||||
|
||||
<canonical_refs>
|
||||
## Canonical References
|
||||
|
||||
**Downstream agents MUST read these before planning or implementing.**
|
||||
|
||||
### Injection Seam (Phase 5 output)
|
||||
- `synth/bank.go` — `NewBank(tau float64, cfgs map[classify.TrafficClass]FreqConfig)` — the injection point for merged config
|
||||
- `synth/config.go` — `ClassFreqConfigs` default map, `FreqConfig` struct with `WaveformType` field, `WaveformPresetHarmonics()` function
|
||||
- `encode/mp3.go` — `RunSynthesis()` calls `synth.NewBank(1.0, synth.ClassFreqConfigs)` — the call site to modify
|
||||
|
||||
### CLI Entry Point
|
||||
- `cmd/netsynth/main.go` — Cobra command setup, flag definitions, `run()` function that dispatches to live/pcap modes
|
||||
|
||||
### Requirements
|
||||
- `.planning/REQUIREMENTS.md` — CFG-01 through CFG-05 acceptance criteria
|
||||
|
||||
### Prior Context
|
||||
- `.planning/phases/05-waveform-types-and-bank-decoupling/05-CONTEXT.md` — Phase 5 decisions (D-02 WaveformType, D-05 bank injection seam)
|
||||
|
||||
No external specs — requirements fully captured in decisions above.
|
||||
|
||||
</canonical_refs>
|
||||
|
||||
<code_context>
|
||||
## Existing Code Insights
|
||||
|
||||
### Reusable Assets
|
||||
- `synth.ClassFreqConfigs` — Default config map (14 entries), serves as base for merge
|
||||
- `synth.WaveformType` enum — Maps to TOML waveform strings (sine/square/sawtooth/triangle)
|
||||
- `synth.NewBank(tau, cfgs)` — Already accepts injected config map (Phase 5)
|
||||
- `classify.TrafficClass` (string type) — Keys for config map, matches TOML section names
|
||||
- `classify.AllClasses()` — Returns all 14 built-in class names for validation
|
||||
|
||||
### Established Patterns
|
||||
- Cobra for CLI flags — add `--config` flag in same pattern as existing flags
|
||||
- `encode.RunSynthesis` is the single call site for synthesis — modification point is narrow
|
||||
- Package-level vars (`ClassFreqConfigs`, `DefaultRules`) serve as defaults — config system overlays on top
|
||||
|
||||
### Integration Points
|
||||
- `cmd/netsynth/main.go:run()` — Config loading inserts between flag parsing and capture start
|
||||
- `encode.RunSynthesis()` — Must receive merged config map (currently hardcoded to `synth.ClassFreqConfigs`)
|
||||
- `synth.FreqConfig.WaveformType` field — Set from TOML waveform string after parsing
|
||||
|
||||
</code_context>
|
||||
|
||||
<specifics>
|
||||
## Specific Ideas
|
||||
|
||||
No specific requirements — standard TOML config pattern with partial merge semantics.
|
||||
|
||||
</specifics>
|
||||
|
||||
<deferred>
|
||||
## Deferred Ideas
|
||||
|
||||
- `--print-config` command (CFG-06) — scoped to Phase 7
|
||||
- Custom classification rules (`[[rules]]` TOML blocks) — scoped to Phase 7
|
||||
- Config hot-reload — explicitly out of scope per REQUIREMENTS.md
|
||||
|
||||
</deferred>
|
||||
|
||||
---
|
||||
|
||||
*Phase: 06-config-package-and-sound-overrides*
|
||||
*Context gathered: 2026-03-26*
|
||||
+75
@@ -0,0 +1,75 @@
|
||||
# Phase 6: Config Package and Sound Overrides - Discussion Log
|
||||
|
||||
> **Audit trail only.** Do not use as input to planning, research, or execution agents.
|
||||
> Decisions are captured in CONTEXT.md — this log preserves the alternatives considered.
|
||||
|
||||
**Date:** 2026-03-26
|
||||
**Phase:** 06-config-package-and-sound-overrides
|
||||
**Areas discussed:** TOML structure, Config merge, Auto-discovery precedence, Error reporting
|
||||
**Mode:** --auto (all areas auto-selected, recommended defaults chosen)
|
||||
|
||||
---
|
||||
|
||||
## TOML Structure
|
||||
|
||||
| Option | Description | Selected |
|
||||
|--------|-------------|----------|
|
||||
| Keyed table `[sounds.<classname>]` | Natural TOML pattern, matches traffic class names | ✓ |
|
||||
| Flat key-value pairs | Simpler but doesn't scale to per-class overrides | |
|
||||
| Nested `[sounds.<classname>.audio]` | Unnecessary nesting depth | |
|
||||
|
||||
**User's choice:** [auto] Keyed table `[sounds.<classname>]` (recommended default)
|
||||
**Notes:** Matches classify.TrafficClass string values directly. Supports `frequency` and `waveform` fields per class.
|
||||
|
||||
---
|
||||
|
||||
## Config Merge Semantics
|
||||
|
||||
| Option | Description | Selected |
|
||||
|--------|-------------|----------|
|
||||
| Per-field overlay | Only specified fields override defaults (CFG-04) | ✓ |
|
||||
| Full section replace | Setting any field in a class replaces all fields | |
|
||||
| Deep merge with arrays | Overkill for flat config structure | |
|
||||
|
||||
**User's choice:** [auto] Per-field overlay (recommended default)
|
||||
**Notes:** Satisfies CFG-04 requirement. User sets one field, everything else keeps defaults.
|
||||
|
||||
---
|
||||
|
||||
## Auto-Discovery Precedence
|
||||
|
||||
| Option | Description | Selected |
|
||||
|--------|-------------|----------|
|
||||
| Local > user > flag | Most-specific wins: --config > ./netsynth.toml > ~/.config/ | ✓ |
|
||||
| Flag only | Simpler but no auto-discovery (violates CFG-02) | |
|
||||
| Multi-file merge | Load and merge all found configs | |
|
||||
|
||||
**User's choice:** [auto] Local > user-level > flag (recommended default)
|
||||
**Notes:** Standard CLI convention. Only one file loaded — no multi-file merge complexity.
|
||||
|
||||
---
|
||||
|
||||
## Error Reporting
|
||||
|
||||
| Option | Description | Selected |
|
||||
|--------|-------------|----------|
|
||||
| Fail-fast with key name + suggestion | Exit at startup, name the bad key (CFG-05) | ✓ |
|
||||
| Warning and continue | Tolerant but hides mistakes | |
|
||||
| Strict with no suggestions | Simpler but less helpful | |
|
||||
|
||||
**User's choice:** [auto] Fail-fast with key name and optional typo suggestion (recommended default)
|
||||
**Notes:** Matches CFG-05 requirement. Unknown class names are warnings (not errors) to prepare for Phase 7.
|
||||
|
||||
---
|
||||
|
||||
## Claude's Discretion
|
||||
|
||||
- TOML library choice
|
||||
- Package organization (dedicated `config` package vs inline)
|
||||
- Waveform string mapping implementation
|
||||
- Edit distance for typo suggestions
|
||||
|
||||
## Deferred Ideas
|
||||
|
||||
- `--print-config` (CFG-06) — Phase 7
|
||||
- Custom rules `[[rules]]` — Phase 7
|
||||
+590
@@ -0,0 +1,590 @@
|
||||
# Phase 6: Config Package and Sound Overrides - Research
|
||||
|
||||
**Researched:** 2026-03-26
|
||||
**Domain:** Go TOML config loading, partial merge semantics, CLI flag wiring
|
||||
**Confidence:** HIGH
|
||||
|
||||
---
|
||||
|
||||
<user_constraints>
|
||||
## User Constraints (from CONTEXT.md)
|
||||
|
||||
### Locked Decisions
|
||||
|
||||
- **D-01:** Use keyed TOML tables `[sounds.<classname>]` for per-class overrides. Each table supports `frequency` (float64, Hz) and `waveform` (string: "sine", "square", "sawtooth", "triangle"). Class names match `classify.TrafficClass` string values (e.g., `[sounds.ICMP]`, `[sounds.HTTPS]`).
|
||||
- **D-02:** Top-level structure is flat — no deeply nested hierarchies. Future phases (custom rules) will add `[[rules]]` array-of-tables at the top level.
|
||||
- **D-03:** Per-field overlay merge — only fields explicitly set in TOML override defaults. Unspecified fields retain their built-in values. For example, setting only `frequency` for ICMP leaves its waveform and harmonics unchanged. This satisfies CFG-04 (partial override without replicating entire config).
|
||||
- **D-04:** Merge produces a `map[classify.TrafficClass]FreqConfig` that is passed to `synth.NewBank()` via the injection seam from Phase 5. The default map is `synth.ClassFreqConfigs`.
|
||||
- **D-05:** Discovery order (most-specific wins): `--config <path>` > `./netsynth.toml` > `~/.config/netsynth/config.toml`. If `--config` is specified and the file does not exist, exit with a clear error before capture begins (CFG-03). If no config is found via auto-discovery, proceed silently with defaults (CFG-02).
|
||||
- **D-06:** Only one config file is loaded — no multi-file merge. The first found in precedence order wins entirely.
|
||||
- **D-07:** Unknown keys cause an immediate startup error naming the unrecognized key (CFG-05). Use TOML strict decoding to detect unknown keys. Suggest the closest valid key name if edit distance is small (nice-to-have, Claude's discretion on implementation).
|
||||
- **D-08:** Type mismatches (e.g., `frequency = "not a number"`) produce a clear error with field name and expected type, before capture begins.
|
||||
- **D-09:** Unknown class names in `[sounds.<classname>]` produce a warning (not error) — this prepares for Phase 7 where user-defined class names are valid.
|
||||
- **D-10:** `encode.RunSynthesis` signature changes to accept the merged config map (or loads config internally). The `--config` flag is added to the Cobra root command in `cmd/netsynth/main.go`.
|
||||
- **D-11:** Config loading happens once at startup, before any capture begins — fail fast on all config errors.
|
||||
|
||||
### Claude's Discretion
|
||||
|
||||
- TOML library choice (BurntSushi/toml vs pelletier/go-toml) — researcher should evaluate both
|
||||
- Whether to create a dedicated `config` package or keep loading in `cmd/netsynth`
|
||||
- Waveform string-to-WaveformType mapping implementation details
|
||||
- Edit distance algorithm for typo suggestions (or skip if complexity isn't justified)
|
||||
|
||||
### Deferred Ideas (OUT OF SCOPE)
|
||||
|
||||
- `--print-config` command (CFG-06) — scoped to Phase 7
|
||||
- Custom classification rules (`[[rules]]` TOML blocks) — scoped to Phase 7
|
||||
- Config hot-reload — explicitly out of scope per REQUIREMENTS.md
|
||||
|
||||
</user_constraints>
|
||||
|
||||
<phase_requirements>
|
||||
## Phase Requirements
|
||||
|
||||
| ID | Description | Research Support |
|
||||
|----|-------------|------------------|
|
||||
| CFG-01 | User can create a TOML config file that overrides default sound mappings | `[sounds.<classname>]` table pattern decodes into `map[string]SoundOverride`; per-field merge into `synth.ClassFreqConfigs` clone |
|
||||
| CFG-02 | Tool auto-discovers config from `./netsynth.toml` or `~/.config/netsynth/config.toml` (silent if absent) | `os.Stat` probe + `os.UserConfigDir()` for XDG path; `errors.Is(err, fs.ErrNotExist)` for silent miss |
|
||||
| CFG-03 | User can specify an explicit config path via `--config` flag (error if file missing) | Cobra `StringVar` flag; fail-fast `os.Stat` check returns error before capture begins |
|
||||
| CFG-04 | User can override individual values without replicating the entire default config (partial override) | Pointer fields (`*float64`, `*string`) in the TOML decode struct allow distinguishing "explicitly zero" from "not set"; overlay merge copies only non-nil fields |
|
||||
| CFG-05 | Unknown keys in config file produce a clear error with the typo'd key name | BurntSushi/toml `MetaData.Undecoded()` returns unmatched keys after decode; format as error message |
|
||||
|
||||
</phase_requirements>
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
Phase 6 adds a `config` package responsible for loading a TOML config file, validating it, and merging it over the `synth.ClassFreqConfigs` default map. The merge output is a `map[classify.TrafficClass]synth.FreqConfig` that is handed to `synth.NewBank()` — the injection seam already exists from Phase 5.
|
||||
|
||||
The core technical challenge is **partial override semantics**: a user who sets only `frequency` for ICMP must not accidentally clear its waveform. This requires the decode struct to use pointer fields (`*float64`, `*string`) so that absent keys remain `nil` at decode time. The merge loop then only copies non-nil values over the defaults.
|
||||
|
||||
Unknown-key detection uses BurntSushi/toml v1.6.0's `MetaData.Undecoded()` method, which is reliable because it operates on the actual set of keys the parser traversed. The alternative (pelletier/go-toml v2.3.0's `DisallowUnknownFields`) is also viable but adds a dependency with a different API surface and returns human-formatted error strings rather than structured key lists — less useful for the "suggest closest valid key" nice-to-have.
|
||||
|
||||
**Primary recommendation:** Use `github.com/BurntSushi/toml` v1.6.0. Use a dedicated `config` package. Implement partial merge with pointer fields in the TOML decode struct.
|
||||
|
||||
## Standard Stack
|
||||
|
||||
### Core
|
||||
|
||||
| Library | Version | Purpose | Why Standard |
|
||||
|---------|---------|---------|--------------|
|
||||
| `github.com/BurntSushi/toml` | v1.6.0 | TOML parsing and MetaData for unknown-key detection | Simpler API than pelletier v2; `Undecoded()` returns structured `[]Key` (not formatted error strings); `DecodeFile()` is a one-liner; v1.6.0 published December 2025 |
|
||||
|
||||
### Supporting
|
||||
|
||||
| Library | Version | Purpose | When to Use |
|
||||
|---------|---------|---------|-------------|
|
||||
| `os` (stdlib) | Go 1.24 | File existence checks, `UserConfigDir()` for XDG path | Always — no external dependency needed for discovery logic |
|
||||
| `errors`/`fs` (stdlib) | Go 1.24 | `errors.Is(err, fs.ErrNotExist)` for silent-miss on auto-discovery | Always |
|
||||
|
||||
### Alternatives Considered
|
||||
|
||||
| Instead of | Could Use | Tradeoff |
|
||||
|------------|-----------|----------|
|
||||
| `BurntSushi/toml v1.6.0` | `pelletier/go-toml v2.3.0` | go-toml has `DisallowUnknownFields()` built-in (cleaner API) but returns `StrictMissingError` with a formatted string — harder to extract just the key name for a "did you mean?" suggestion. BurntSushi returns `[]toml.Key` which is structured. For this use case, BurntSushi is easier to work with. |
|
||||
| Pointer fields for partial override | Separate "is-set" booleans | Pointer fields are idiomatic in Go for "optional" semantics. Booleans add field count and are error-prone. |
|
||||
| Dedicated `config` package | Inline in `cmd/netsynth` | A `config` package makes the loader independently testable without a Cobra dependency. Given the complexity (validation, merge, discovery), a separate package is justified. |
|
||||
|
||||
**Installation:**
|
||||
```bash
|
||||
go get github.com/BurntSushi/toml@v1.6.0
|
||||
```
|
||||
|
||||
**Version verification (confirmed 2026-03-26):**
|
||||
```
|
||||
github.com/BurntSushi/toml v1.6.0 (December 18, 2025)
|
||||
github.com/pelletier/go-toml/v2 v2.3.0 (March 24, 2026 — alternative)
|
||||
```
|
||||
|
||||
## Architecture Patterns
|
||||
|
||||
### Recommended Project Structure
|
||||
|
||||
```
|
||||
config/
|
||||
├── config.go # Load(), Merge(), Validate() — public API
|
||||
└── config_test.go # table-driven tests for all CFG requirements
|
||||
```
|
||||
|
||||
The `config` package has one exported function signature the planner cares about:
|
||||
|
||||
```go
|
||||
// Load finds, parses, validates, and merges a config file.
|
||||
// configPath is the --config flag value; empty string triggers auto-discovery.
|
||||
// Returns the merged FreqConfig map (defaults + overrides) ready for synth.NewBank.
|
||||
// Returns an error on: file-not-found when --config is explicit, parse errors,
|
||||
// unknown keys, type mismatches. Returns no error (uses defaults) when no config
|
||||
// is found during auto-discovery.
|
||||
func Load(configPath string) (map[classify.TrafficClass]synth.FreqConfig, error)
|
||||
```
|
||||
|
||||
### Pattern 1: TOML Decode Struct with Pointer Fields
|
||||
|
||||
**What:** The TOML config file maps to a Go struct where every overridable field is a pointer. `nil` means "not set by user"; non-nil means "user explicitly specified this value."
|
||||
|
||||
**When to use:** Whenever you need to distinguish "field absent from config" from "field set to zero value" — mandatory for partial override semantics (CFG-04).
|
||||
|
||||
```go
|
||||
// Source: BurntSushi/toml documentation + partial-override pattern
|
||||
// config/config.go
|
||||
|
||||
// SoundOverride holds optional per-class sound parameters from TOML.
|
||||
// Pointer fields: nil = not set (keep default), non-nil = user override.
|
||||
type SoundOverride struct {
|
||||
Frequency *float64 `toml:"frequency"`
|
||||
Waveform *string `toml:"waveform"`
|
||||
}
|
||||
|
||||
// rawConfig is the top-level TOML decode target.
|
||||
type rawConfig struct {
|
||||
Sounds map[string]SoundOverride `toml:"sounds"`
|
||||
}
|
||||
```
|
||||
|
||||
### Pattern 2: Unknown-Key Detection with MetaData.Undecoded()
|
||||
|
||||
**What:** After decoding, check `md.Undecoded()` for any keys in the TOML file that did not map to a field in the decode struct. Return an error naming the first unrecognized key.
|
||||
|
||||
**When to use:** Required for CFG-05. Also the mechanism to detect field-level typos within a `[sounds.ICMP]` block (e.g., `frequncy` vs `frequency`).
|
||||
|
||||
```go
|
||||
// Source: pkg.go.dev/github.com/BurntSushi/toml
|
||||
// config/config.go
|
||||
|
||||
func parse(path string) (rawConfig, error) {
|
||||
var raw rawConfig
|
||||
md, err := toml.DecodeFile(path, &raw)
|
||||
if err != nil {
|
||||
return raw, fmt.Errorf("config parse error: %w", err)
|
||||
}
|
||||
if undecoded := md.Undecoded(); len(undecoded) > 0 {
|
||||
// undecoded[0] is a toml.Key ([]string); join for human-readable path
|
||||
keyPath := strings.Join(undecoded[0], ".")
|
||||
return raw, fmt.Errorf("config: unknown key %q — check spelling", keyPath)
|
||||
}
|
||||
return raw, nil
|
||||
}
|
||||
```
|
||||
|
||||
**IMPORTANT NOTE on nested map + Undecoded():** When the decode struct uses `map[string]SoundOverride` for `[sounds]`, the TOML library cannot know what map keys are "valid" — all string keys are valid map keys. This means `Undecoded()` will NOT catch a misspelled class name like `[sounds.ICMP_typo]` (it IS decoded, just into a wrong map key). However, `Undecoded()` WILL catch field-level typos within a class block like `[sounds.ICMP]` with `frequncy = 440` because `frequncy` doesn't match any `SoundOverride` field. Class-name validation is handled separately in the merge step (D-09: log a warning for unknown class names).
|
||||
|
||||
### Pattern 3: Per-Field Overlay Merge
|
||||
|
||||
**What:** Iterate over the default `ClassFreqConfigs` map, copy it, then for each entry found in the TOML overrides, copy only the non-nil pointer fields into the working copy.
|
||||
|
||||
**When to use:** This is the CFG-04 implementation. Must run after parse and validation.
|
||||
|
||||
```go
|
||||
// config/config.go
|
||||
|
||||
func merge(
|
||||
defaults map[classify.TrafficClass]synth.FreqConfig,
|
||||
overrides map[string]SoundOverride,
|
||||
) map[classify.TrafficClass]synth.FreqConfig {
|
||||
// Deep-copy defaults
|
||||
result := make(map[classify.TrafficClass]synth.FreqConfig, len(defaults))
|
||||
for k, v := range defaults {
|
||||
result[k] = v
|
||||
}
|
||||
|
||||
for className, override := range overrides {
|
||||
class := classify.TrafficClass(className)
|
||||
cfg, known := result[class]
|
||||
if !known {
|
||||
// D-09: unknown class name = warning, not error (Phase 7 may define it)
|
||||
fmt.Fprintf(os.Stderr, "Warning: config: unknown class %q (ignored)\n", className)
|
||||
continue
|
||||
}
|
||||
if override.Frequency != nil {
|
||||
cfg.BaseHz = *override.Frequency
|
||||
// When frequency changes, regenerate harmonics if a waveform preset is active
|
||||
if cfg.WaveformType != synth.WaveformCustom {
|
||||
cfg.Harmonics = synth.WaveformPresetHarmonics(cfg.WaveformType, cfg.BaseHz, synth.SampleRate)
|
||||
}
|
||||
}
|
||||
if override.Waveform != nil {
|
||||
wt, err := parseWaveform(*override.Waveform)
|
||||
if err != nil {
|
||||
// Validation catches this before merge; this is a safety guard
|
||||
continue
|
||||
}
|
||||
cfg.WaveformType = wt
|
||||
cfg.Harmonics = synth.WaveformPresetHarmonics(wt, cfg.BaseHz, synth.SampleRate)
|
||||
}
|
||||
result[class] = cfg
|
||||
}
|
||||
return result
|
||||
}
|
||||
```
|
||||
|
||||
### Pattern 4: Waveform String-to-Type Mapping
|
||||
|
||||
**What:** A simple switch converts the TOML `waveform` string to `synth.WaveformType`. Validation happens before merge.
|
||||
|
||||
```go
|
||||
// config/config.go
|
||||
|
||||
var validWaveforms = map[string]synth.WaveformType{
|
||||
"sine": synth.WaveformSine,
|
||||
"square": synth.WaveformSquare,
|
||||
"sawtooth": synth.WaveformSawtooth,
|
||||
"triangle": synth.WaveformTriangle,
|
||||
}
|
||||
|
||||
func parseWaveform(s string) (synth.WaveformType, error) {
|
||||
if wt, ok := validWaveforms[s]; ok {
|
||||
return wt, nil
|
||||
}
|
||||
valid := []string{"sine", "square", "sawtooth", "triangle"}
|
||||
return 0, fmt.Errorf("config: invalid waveform %q — valid values: %s", s, strings.Join(valid, ", "))
|
||||
}
|
||||
```
|
||||
|
||||
### Pattern 5: Auto-Discovery with os.UserConfigDir
|
||||
|
||||
**What:** Check paths in precedence order. Return the path of the first file found, or `""` (empty) if none found. Never log anything for a missing auto-discovered file.
|
||||
|
||||
```go
|
||||
// config/config.go
|
||||
|
||||
func discoverPath() string {
|
||||
// 1. Working directory
|
||||
if _, err := os.Stat("netsynth.toml"); err == nil {
|
||||
return "netsynth.toml"
|
||||
}
|
||||
// 2. XDG config dir
|
||||
dir, err := os.UserConfigDir()
|
||||
if err != nil {
|
||||
return ""
|
||||
}
|
||||
p := filepath.Join(dir, "netsynth", "config.toml")
|
||||
if _, err := os.Stat(p); err == nil {
|
||||
return p
|
||||
}
|
||||
return ""
|
||||
}
|
||||
```
|
||||
|
||||
`os.UserConfigDir()` returns `$XDG_CONFIG_HOME` or `$HOME/.config` on Linux (Go stdlib, no extra dependency). Confirmed by Go source: returns `$XDG_CONFIG_HOME` if set, else `$HOME/.config` on Unix.
|
||||
|
||||
### Pattern 6: encode.RunSynthesis Signature Change
|
||||
|
||||
**What:** `RunSynthesis` currently calls `synth.NewBank(1.0, synth.ClassFreqConfigs)` hardcoded. Phase 6 changes the signature to accept the merged config map.
|
||||
|
||||
The simplest approach: pass the merged config map as a parameter (rather than loading config inside `encode`). This keeps `encode` unaware of config loading and makes testing easier.
|
||||
|
||||
```go
|
||||
// encode/mp3.go — updated signature
|
||||
func RunSynthesis(
|
||||
snapshots []classify.WindowSnapshot,
|
||||
outputPath string,
|
||||
freqCfgs map[classify.TrafficClass]synth.FreqConfig,
|
||||
) error {
|
||||
// ...
|
||||
bank := synth.NewBank(1.0, freqCfgs) // was: synth.ClassFreqConfigs
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
Caller in `cmd/netsynth/main.go` passes the result of `config.Load(configPath)`.
|
||||
|
||||
### Anti-Patterns to Avoid
|
||||
|
||||
- **Decode into `map[string]interface{}`:** Loses type safety, makes unknown-field detection harder, requires runtime type assertions. Use typed structs.
|
||||
- **Load config inside `encode` package:** Couples audio encoding to config I/O; breaks test isolation. Config loading belongs in `cmd/netsynth/main.go` (calls `config.Load`) or a dedicated `config` package.
|
||||
- **Validate waveform strings after merge:** Validate before merging so the error is caught at startup (D-11), not silently ignored.
|
||||
- **Deep-copy using `=` assignment on map values:** `synth.FreqConfig` contains a `[]HarmonicDef` slice; a simple struct copy shares the underlying array. Use an explicit copy of the slice if you mutate `Harmonics` during merge. (The merge code above reconstructs harmonics from the preset, so this is safe — but important to be aware of.)
|
||||
|
||||
## Don't Hand-Roll
|
||||
|
||||
| Problem | Don't Build | Use Instead | Why |
|
||||
|---------|-------------|-------------|-----|
|
||||
| TOML parsing | Custom parser | `BurntSushi/toml` v1.6.0 | TOML 1.1 compliance, error messages, datetime support, tested at scale |
|
||||
| Unknown-key detection | Post-parse key comparison | `md.Undecoded()` from BurntSushi | Already built into the library; handles nested paths correctly |
|
||||
| XDG config path | Manual `$HOME/.config` string concat | `os.UserConfigDir()` stdlib | Handles `$XDG_CONFIG_HOME` override correctly, platform-portable |
|
||||
|
||||
**Key insight:** The partial-override merge logic is the one piece that must be written from scratch — no library does "overlay a sparse map of optional overrides over a typed defaults map." But it is ~20 lines of straightforward Go.
|
||||
|
||||
## Runtime State Inventory
|
||||
|
||||
Step 2.5 SKIPPED — this is a new feature addition, not a rename/refactor/migration phase. No runtime state is being renamed or migrated.
|
||||
|
||||
## Common Pitfalls
|
||||
|
||||
### Pitfall 1: Undecoded() Does Not Catch Unknown Class Names
|
||||
|
||||
**What goes wrong:** Developer assumes `md.Undecoded()` will catch `[sounds.ICMP_TYPO]` as an unknown key and provide CFG-05 coverage for class-name typos.
|
||||
|
||||
**Why it happens:** `map[string]SoundOverride` decodes any string as a valid map key — the TOML parser has no way to know which class names are valid. `Undecoded()` only catches keys that don't match ANY field (struct field name, map key, or slice element). Since all map keys are valid, no class name is "undecodeable."
|
||||
|
||||
**How to avoid:** Separate the two concerns. Field-level unknown keys (e.g., `frequncy`) ARE caught by `Undecoded()`. Class-name typos are caught in the merge step by checking whether `classify.TrafficClass(className)` exists in `synth.ClassFreqConfigs`. The CONTEXT.md decision D-09 says unknown class names produce a warning (not error) to allow for Phase 7 user-defined classes — so this is by design.
|
||||
|
||||
**Warning signs:** Test for both: write a test with `[sounds.ICMP]` containing `frequncy = 440` (should error) AND a test with `[sounds.ICMP_TYPO]` containing `frequency = 440` (should warn, not error).
|
||||
|
||||
### Pitfall 2: Partial Override Accidentally Clears WaveformType
|
||||
|
||||
**What goes wrong:** User sets only `frequency = 300` for ICMP. After merge, ICMP's `WaveformType` is reset to `WaveformCustom` because the merge loop creates a new `FreqConfig{}` instead of starting from the default.
|
||||
|
||||
**Why it happens:** Copy-by-value from defaults is skipped, or merge starts from a zero-value struct.
|
||||
|
||||
**How to avoid:** Always start the merge from the DEFAULT `FreqConfig` for that class. The merge loop copies `defaults[class]` first, then overlays only non-nil pointer fields.
|
||||
|
||||
**Warning signs:** Test case: set only `frequency` for a class with `WaveformCustom` — verify waveform field is unchanged. Test case: set only `waveform` for a class — verify frequency is unchanged.
|
||||
|
||||
### Pitfall 3: Frequency Change Does Not Regenerate Harmonics for Preset Waveforms
|
||||
|
||||
**What goes wrong:** User sets `frequency = 300` for HTTPS (which has `WaveformCustom` by default, so this is fine). But if a user sets `frequency = 300` for a class that was previously configured with `WaveformSine` (via an earlier config entry), the harmonics may be stale from the old frequency.
|
||||
|
||||
**Why it happens:** `synth.WaveformPresetHarmonics` generates harmonics based on `baseHz`. If you update `BaseHz` without regenerating harmonics, the preset harmonics are anchored to the old frequency.
|
||||
|
||||
**How to avoid:** In the merge function: when updating `Frequency`, check if `WaveformType != WaveformCustom`. If true, regenerate `Harmonics` from the new frequency. The merge example above handles this correctly.
|
||||
|
||||
**Warning signs:** For the 14 built-in classes, all have `WaveformCustom` (hand-tuned harmonics), so this pitfall only bites if the user sets both `waveform` and `frequency` in two separate steps — or if a future phase pre-configures preset waveforms on built-ins.
|
||||
|
||||
### Pitfall 4: --config File-Not-Found vs Auto-Discovery Silence
|
||||
|
||||
**What goes wrong:** When `--config /path/to/missing.toml` is specified, the code returns the same "no config found, using defaults" behavior as auto-discovery silence.
|
||||
|
||||
**Why it happens:** `os.Stat` errors are treated uniformly regardless of how the path was obtained.
|
||||
|
||||
**How to avoid:** In the `Load` function, branch on whether `configPath` was explicitly provided: if it was, a `fs.ErrNotExist` is a user error (return error); if it came from auto-discovery, `fs.ErrNotExist` is normal (return `nil` error, use defaults).
|
||||
|
||||
**Warning signs:** CFG-03 acceptance criterion explicitly tests this: explicit path must error, absent auto-discovery must be silent.
|
||||
|
||||
### Pitfall 5: go.mod Tidy Drops TOML Dependency
|
||||
|
||||
**What goes wrong:** `go mod tidy` is run after adding BurntSushi/toml to go.mod but before any `.go` file in the module actually imports it. Tidy removes it.
|
||||
|
||||
**Why it happens:** `go mod tidy` removes unused dependencies.
|
||||
|
||||
**How to avoid:** Add the import in `config/config.go` before running `go mod tidy`.
|
||||
|
||||
## Code Examples
|
||||
|
||||
### Complete config.go Skeleton
|
||||
|
||||
```go
|
||||
// Source: BurntSushi/toml docs + project pattern
|
||||
// config/config.go
|
||||
package config
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"io/fs"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
||||
"github.com/BurntSushi/toml"
|
||||
|
||||
"github.com/netsynth/netsynth/classify"
|
||||
"github.com/netsynth/netsynth/synth"
|
||||
)
|
||||
|
||||
type SoundOverride struct {
|
||||
Frequency *float64 `toml:"frequency"`
|
||||
Waveform *string `toml:"waveform"`
|
||||
}
|
||||
|
||||
type rawConfig struct {
|
||||
Sounds map[string]SoundOverride `toml:"sounds"`
|
||||
}
|
||||
|
||||
// Load is the single public entry point.
|
||||
// configPath: value of --config flag; empty = auto-discover.
|
||||
func Load(configPath string) (map[classify.TrafficClass]synth.FreqConfig, error) {
|
||||
path, explicit, err := resolvePath(configPath)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if path == "" {
|
||||
// No config found during auto-discovery — use defaults silently (CFG-02)
|
||||
return copyDefaults(), nil
|
||||
}
|
||||
|
||||
raw, err := parseFile(path)
|
||||
if err != nil {
|
||||
if explicit && errors.Is(err, fs.ErrNotExist) {
|
||||
return nil, fmt.Errorf("config file not found: %s", path)
|
||||
}
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if err := validate(raw); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return merge(copyDefaults(), raw.Sounds), nil
|
||||
}
|
||||
```
|
||||
|
||||
### Example TOML Config File
|
||||
|
||||
```toml
|
||||
# netsynth.toml — override ICMP and SSH sounds
|
||||
[sounds.ICMP]
|
||||
frequency = 80.0
|
||||
waveform = "square"
|
||||
|
||||
[sounds.SSH]
|
||||
frequency = 400.0
|
||||
# waveform not set — SSH keeps its default waveform
|
||||
```
|
||||
|
||||
### Test Pattern (table-driven)
|
||||
|
||||
```go
|
||||
// config/config_test.go
|
||||
|
||||
func TestLoadPartialOverride(t *testing.T) {
|
||||
// Write a temp TOML file with only frequency for ICMP
|
||||
tomlContent := `
|
||||
[sounds.ICMP]
|
||||
frequency = 100.0
|
||||
`
|
||||
f, _ := os.CreateTemp(t.TempDir(), "*.toml")
|
||||
f.WriteString(tomlContent)
|
||||
f.Close()
|
||||
|
||||
cfgs, err := Load(f.Name())
|
||||
if err != nil {
|
||||
t.Fatalf("Load: %v", err)
|
||||
}
|
||||
|
||||
// ICMP frequency overridden
|
||||
if cfgs[classify.ClassICMP].BaseHz != 100.0 {
|
||||
t.Errorf("ICMP BaseHz: got %v, want 100.0", cfgs[classify.ClassICMP].BaseHz)
|
||||
}
|
||||
// ICMP waveform unchanged (WaveformCustom = 0)
|
||||
if cfgs[classify.ClassICMP].WaveformType != synth.WaveformCustom {
|
||||
t.Errorf("ICMP WaveformType: got %v, want WaveformCustom", cfgs[classify.ClassICMP].WaveformType)
|
||||
}
|
||||
// DNS frequency unchanged
|
||||
if cfgs[classify.ClassDNS].BaseHz != synth.ClassFreqConfigs[classify.ClassDNS].BaseHz {
|
||||
t.Errorf("DNS BaseHz unexpectedly changed")
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoadUnknownKey(t *testing.T) {
|
||||
tomlContent := `
|
||||
[sounds.ICMP]
|
||||
frequncy = 440
|
||||
`
|
||||
f, _ := os.CreateTemp(t.TempDir(), "*.toml")
|
||||
f.WriteString(tomlContent)
|
||||
f.Close()
|
||||
|
||||
_, err := Load(f.Name())
|
||||
if err == nil {
|
||||
t.Fatal("expected error for unknown key 'frequncy', got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "frequncy") {
|
||||
t.Errorf("error should name the bad key, got: %v", err)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## State of the Art
|
||||
|
||||
| Old Approach | Current Approach | When Changed | Impact |
|
||||
|--------------|------------------|--------------|--------|
|
||||
| `google/gopacket` | `gopacket/gopacket` v1.5.0 | 2022-2024 | N/A for this phase |
|
||||
| BurntSushi/toml v0.x | v1.6.0 (TOML 1.1 enabled by default) | December 2025 | TOML 1.1 compliance; API unchanged, same `Decode`/`DecodeFile` functions |
|
||||
| `go-audio/generator` | ARCHIVED (Feb 2026, read-only) | February 2026 | Do not use; project already avoids it |
|
||||
|
||||
**Current versions confirmed 2026-03-26:**
|
||||
- `BurntSushi/toml` v1.6.0 (December 18, 2025) — TOML 1.1 default, stable API
|
||||
- `pelletier/go-toml/v2` v2.3.0 (March 24, 2026) — alternative if structured error needed
|
||||
|
||||
## Open Questions
|
||||
|
||||
1. **Typo suggestion for unknown keys (D-07 nice-to-have)**
|
||||
- What we know: BurntSushi returns `[]toml.Key` (structured), Levenshtein distance is ~15 lines of Go or `github.com/agnivade/levenshtein` (tiny, zero-dependency)
|
||||
- What's unclear: Is the complexity worth it for 2 valid field names per class block (`frequency`, `waveform`)?
|
||||
- Recommendation: Skip the external library. Implement inline: for each undecoded key, if it has edit distance ≤ 2 from any valid key name, append " (did you mean: X?)" to the error. The valid key set for field names is small and static: `["frequency", "waveform"]`. This is ~10 lines of Go.
|
||||
|
||||
2. **copyDefaults() — shallow vs deep copy of Harmonics slices**
|
||||
- What we know: `synth.FreqConfig.Harmonics` is a `[]HarmonicDef`. Go's `map[K]V` assignment copies struct values (including slice headers) but the underlying array is shared.
|
||||
- What's unclear: Does this matter if merge only replaces the whole slice (via `WaveformPresetHarmonics`) rather than appending to it?
|
||||
- Recommendation: Since the merge code assigns a freshly-generated `[]HarmonicDef` from `WaveformPresetHarmonics` (never mutates the original), shallow copy is safe. No deep copy needed. Document this in a comment for future maintainers.
|
||||
|
||||
## Environment Availability
|
||||
|
||||
Step 2.6: This phase introduces one new external dependency:
|
||||
|
||||
| Dependency | Required By | Available | Version | Fallback |
|
||||
|------------|------------|-----------|---------|----------|
|
||||
| `github.com/BurntSushi/toml` | config.Load() TOML parsing | ✓ (fetched via go get) | v1.6.0 | pelletier/go-toml v2.3.0 |
|
||||
| `os.UserConfigDir()` | Auto-discovery of `~/.config/netsynth/config.toml` | ✓ (Go stdlib) | Go 1.13+ | N/A — stdlib |
|
||||
| Go 1.24.1 toolchain | Module minimum | ✓ | 1.24.1 | N/A |
|
||||
| C compiler (CGo) | go-lame MP3 encoding (pre-existing) | Assumed ✓ (Phase 2+ already requires this) | — | N/A |
|
||||
|
||||
No missing dependencies with no fallback. BurntSushi/toml confirmed fetchable from pkg.go.dev.
|
||||
|
||||
## Validation Architecture
|
||||
|
||||
### Test Framework
|
||||
|
||||
| Property | Value |
|
||||
|----------|-------|
|
||||
| Framework | Go standard `testing` package |
|
||||
| Config file | None — `go test ./...` |
|
||||
| Quick run command | `go test ./config/...` |
|
||||
| Full suite command | `go test ./...` |
|
||||
|
||||
### Phase Requirements → Test Map
|
||||
|
||||
| Req ID | Behavior | Test Type | Automated Command | File Exists? |
|
||||
|--------|----------|-----------|-------------------|-------------|
|
||||
| CFG-01 | TOML overrides applied to correct class | unit | `go test ./config/... -run TestLoadOverride` | Wave 0 |
|
||||
| CFG-02 | No config file → silent, uses defaults | unit | `go test ./config/... -run TestLoadNoConfig` | Wave 0 |
|
||||
| CFG-03 | `--config` explicit path → error if missing | unit | `go test ./config/... -run TestLoadExplicitMissing` | Wave 0 |
|
||||
| CFG-04 | Partial override: unset fields unchanged | unit | `go test ./config/... -run TestLoadPartialOverride` | Wave 0 |
|
||||
| CFG-05 | Unknown key → error naming the key | unit | `go test ./config/... -run TestLoadUnknownKey` | Wave 0 |
|
||||
| CFG-03 | `--config` flag wired in Cobra | integration | `go test ./cmd/netsynth/... -run TestConfigFlag` | Wave 0 |
|
||||
|
||||
### Sampling Rate
|
||||
|
||||
- **Per task commit:** `go test ./config/... -count=1`
|
||||
- **Per wave merge:** `go test ./... -count=1`
|
||||
- **Phase gate:** Full suite green before `/gsd:verify-work`
|
||||
|
||||
### Wave 0 Gaps
|
||||
|
||||
- [ ] `config/config.go` — package does not exist yet; create in Wave 1
|
||||
- [ ] `config/config_test.go` — covers CFG-01 through CFG-05
|
||||
- [ ] `cmd/netsynth/main_test.go` — add `TestConfigFlag` covering CFG-03 CLI integration
|
||||
|
||||
*(Existing test infrastructure covers all other packages; only `config/` is new.)*
|
||||
|
||||
## Sources
|
||||
|
||||
### Primary (HIGH confidence)
|
||||
|
||||
- `pkg.go.dev/github.com/BurntSushi/toml` — v1.6.0 API: `DecodeFile`, `MetaData.Undecoded()`, `[]Key` type; verified 2026-03-26
|
||||
- Go stdlib `os.UserConfigDir()` — returns `$XDG_CONFIG_HOME` or `$HOME/.config` on Linux; Go 1.13+ feature
|
||||
- `pkg.go.dev/github.com/pelletier/go-toml/v2` — v2.3.0 `DisallowUnknownFields()` / `StrictMissingError` API; verified 2026-03-26
|
||||
|
||||
### Secondary (MEDIUM confidence)
|
||||
|
||||
- WebSearch: BurntSushi/toml Undecoded() approach verified against official GitHub source (`toml/decode.go`)
|
||||
- WebSearch: pelletier/go-toml v2 DisallowUnknownFields verified against official docs
|
||||
- WebSearch: `os.UserConfigDir` XDG compliance — confirmed returns `$XDG_CONFIG_HOME` or `$HOME/.config` on Linux per golang/go issue #29960
|
||||
|
||||
### Tertiary (LOW confidence)
|
||||
|
||||
- WebSearch: edit distance typo suggestion libraries (agnivade/levenshtein, go-edlib) — not deeply evaluated; recommendation is inline 10-line implementation to avoid dependency
|
||||
|
||||
## Metadata
|
||||
|
||||
**Confidence breakdown:**
|
||||
|
||||
- Standard stack: HIGH — versions confirmed via `go get` live fetch (v1.6.0 BurntSushi, v2.3.0 pelletier)
|
||||
- Architecture: HIGH — patterns derived from library documentation + existing codebase patterns
|
||||
- Pitfalls: HIGH — Undecoded() + map key limitation is a documented behavior; partial-override via pointer fields is an established Go idiom
|
||||
- TOML typo suggestion: LOW — nice-to-have from D-07; no deep investigation needed given small valid-key set
|
||||
|
||||
**Research date:** 2026-03-26
|
||||
**Valid until:** 2026-06-26 (BurntSushi/toml is stable; go-toml v2 moves faster but is not the chosen library)
|
||||
+80
@@ -0,0 +1,80 @@
|
||||
---
|
||||
phase: 06
|
||||
slug: config-package-and-sound-overrides
|
||||
status: draft
|
||||
nyquist_compliant: false
|
||||
wave_0_complete: false
|
||||
created: 2026-03-26
|
||||
---
|
||||
|
||||
# Phase 06 — Validation Strategy
|
||||
|
||||
> Per-phase validation contract for feedback sampling during execution.
|
||||
|
||||
---
|
||||
|
||||
## Test Infrastructure
|
||||
|
||||
| Property | Value |
|
||||
|----------|-------|
|
||||
| **Framework** | go test (stdlib) |
|
||||
| **Config file** | none — tests use in-memory TOML strings |
|
||||
| **Quick run command** | `go test ./config/... -count=1` |
|
||||
| **Full suite command** | `go test ./... -count=1` |
|
||||
| **Estimated runtime** | ~2 seconds |
|
||||
|
||||
---
|
||||
|
||||
## Sampling Rate
|
||||
|
||||
- **After every task commit:** Run `go test ./config/... -count=1`
|
||||
- **After every plan wave:** Run `go test ./... -count=1`
|
||||
- **Before `/gsd:verify-work`:** Full suite must be green
|
||||
- **Max feedback latency:** 2 seconds
|
||||
|
||||
---
|
||||
|
||||
## Per-Task Verification Map
|
||||
|
||||
| Task ID | Plan | Wave | Requirement | Test Type | Automated Command | File Exists | Status |
|
||||
|---------|------|------|-------------|-----------|-------------------|-------------|--------|
|
||||
| 06-01-01 | 01 | 1 | CFG-01, CFG-04 | unit | `go test ./config/... -run TestParse` | ❌ W0 | ⬜ pending |
|
||||
| 06-01-02 | 01 | 1 | CFG-02, CFG-03 | unit | `go test ./config/... -run TestDiscover` | ❌ W0 | ⬜ pending |
|
||||
| 06-01-03 | 01 | 1 | CFG-05 | unit | `go test ./config/... -run TestUnknown` | ❌ W0 | ⬜ pending |
|
||||
| 06-02-01 | 02 | 2 | CFG-01, CFG-04 | integration | `go test ./... -run TestRunSynthesis` | ❌ W0 | ⬜ pending |
|
||||
| 06-02-02 | 02 | 2 | CFG-03 | integration | `go test ./cmd/... -run TestConfig` | ❌ W0 | ⬜ pending |
|
||||
|
||||
*Status: ⬜ pending · ✅ green · ❌ red · ⚠️ flaky*
|
||||
|
||||
---
|
||||
|
||||
## Wave 0 Requirements
|
||||
|
||||
- [ ] `config/config_test.go` — stubs for parse, discover, validate, merge tests
|
||||
- [ ] Existing `go test` infrastructure covers all phase requirements
|
||||
|
||||
*Existing test infrastructure (go test) covers all phase requirements. New test files created alongside implementation.*
|
||||
|
||||
---
|
||||
|
||||
## Manual-Only Verifications
|
||||
|
||||
| Behavior | Requirement | Why Manual | Test Instructions |
|
||||
|----------|-------------|------------|-------------------|
|
||||
| Auto-discover from `~/.config/netsynth/config.toml` | CFG-02 | Requires real home directory | Create config in `~/.config/netsynth/`, run netsynth, verify it loads |
|
||||
| Ctrl+C after config load | CFG-01 | End-to-end with capture | Load config, start capture, Ctrl+C, verify MP3 uses overridden frequency |
|
||||
|
||||
*Most behaviors have automated verification via unit tests with in-memory TOML.*
|
||||
|
||||
---
|
||||
|
||||
## Validation Sign-Off
|
||||
|
||||
- [ ] All tasks have `<automated>` verify or Wave 0 dependencies
|
||||
- [ ] Sampling continuity: no 3 consecutive tasks without automated verify
|
||||
- [ ] Wave 0 covers all MISSING references
|
||||
- [ ] No watch-mode flags
|
||||
- [ ] Feedback latency < 2s
|
||||
- [ ] `nyquist_compliant: true` set in frontmatter
|
||||
|
||||
**Approval:** pending
|
||||
+110
@@ -0,0 +1,110 @@
|
||||
---
|
||||
phase: 06-config-package-and-sound-overrides
|
||||
verified: 2026-03-26T20:15:00Z
|
||||
status: passed
|
||||
score: 10/10 must-haves verified
|
||||
re_verification: false
|
||||
---
|
||||
|
||||
# Phase 6: Config Package and Sound Overrides Verification Report
|
||||
|
||||
**Phase Goal:** Users can create a TOML config file to override frequency and waveform per traffic class, with auto-discovery, partial override semantics, and clear validation errors
|
||||
**Verified:** 2026-03-26T20:15:00Z
|
||||
**Status:** passed
|
||||
**Re-verification:** No — initial verification
|
||||
|
||||
## Goal Achievement
|
||||
|
||||
### Observable Truths
|
||||
|
||||
| # | Truth | Status | Evidence |
|
||||
|----|-------------------------------------------------------------------------------------|------------|--------------------------------------------------------------------------------------------|
|
||||
| 1 | Load with explicit path to valid TOML returns merged config map with overrides applied | ✓ VERIFIED | TestLoadPartialOverrideFrequency, TestLoadBothOverrides — PASS |
|
||||
| 2 | Load with no config file found returns default ClassFreqConfigs unchanged | ✓ VERIFIED | TestLoadNoConfig (t.Chdir to empty tmpdir) — PASS |
|
||||
| 3 | Load with unknown TOML key returns error naming the bad key | ✓ VERIFIED | TestLoadUnknownKey ("frequncy") — PASS; error contains the typo'd key name |
|
||||
| 4 | Load with partial override (only frequency set) leaves waveform unchanged | ✓ VERIFIED | TestLoadPartialOverrideFrequency — WaveformType remains WaveformCustom — PASS |
|
||||
| 5 | Load with partial override (only waveform set) leaves frequency unchanged | ✓ VERIFIED | TestLoadPartialOverrideWaveform — BaseHz remains 65.0 — PASS |
|
||||
| 6 | Load with unknown class name logs warning and does not error | ✓ VERIFIED | TestLoadUnknownClass (BOGUS class) — err == nil, 14 entries, warning to stderr — PASS |
|
||||
| 7 | User passes --config /path/to/file.toml and tool uses that file for sound overrides | ✓ VERIFIED | config.Load(configPath) called in run() at line 87; flows to RunSynthesis and NewBank |
|
||||
| 8 | User passes --config /nonexistent.toml and tool exits with clear error before capture | ✓ VERIFIED | Tested live: `go run ./cmd/netsynth --config /nonexistent/file.toml` exits 1 with "config file not found: /nonexistent/file.toml" |
|
||||
| 9 | User runs without --config and auto-discovery kicks in (or defaults used silently) | ✓ VERIFIED | discoverPath() checks ./netsynth.toml then XDG dir; silent default on no-find |
|
||||
| 10 | RunSynthesis uses the merged config map instead of hardcoded ClassFreqConfigs | ✓ VERIFIED | encode/mp3.go line 58: `synth.NewBank(1.0, freqCfgs)` — no reference to ClassFreqConfigs |
|
||||
|
||||
**Score:** 10/10 truths verified
|
||||
|
||||
### Required Artifacts
|
||||
|
||||
| Artifact | Expected | Status | Details |
|
||||
|-------------------------|---------------------------------------------------|------------|------------------------------------------------------------------------|
|
||||
| `config/config.go` | Load function, parse, validate, merge, discover | ✓ VERIFIED | 184 lines; exports Load, SoundOverride, rawConfig; all functions present |
|
||||
| `config/config_test.go` | Table-driven tests for CFG-01 through CFG-05 | ✓ VERIFIED | 181 lines; 9 test functions (TestLoad*); all 9 pass |
|
||||
| `cmd/netsynth/main.go` | --config flag, config.Load call, freqCfgs to RunSynthesis | ✓ VERIFIED | configPath var, flag registration, config.Load at line 87, two RunSynthesis call sites updated |
|
||||
| `encode/mp3.go` | RunSynthesis with freqCfgs parameter | ✓ VERIFIED | Signature: `func RunSynthesis(..., freqCfgs map[classify.TrafficClass]synth.FreqConfig) error` |
|
||||
| `encode/mp3_test.go` | Updated tests for new RunSynthesis signature | ✓ VERIFIED | Three call sites pass `synth.ClassFreqConfigs` as third arg |
|
||||
|
||||
### Key Link Verification
|
||||
|
||||
| From | To | Via | Status | Details |
|
||||
|---------------------------|---------------------------|--------------------------------------------------|------------|-----------------------------------------------------------|
|
||||
| `config/config.go` | `synth/config.go` | synth.FreqConfig, ClassFreqConfigs, WaveformPresetHarmonics | ✓ WIRED | grep confirmed all three at lines 46, 147-148, 172, 178 |
|
||||
| `config/config.go` | `classify/types.go` | classify.TrafficClass (AllClasses implied) | ✓ WIRED | Line 161: `classify.TrafficClass(className)` confirmed |
|
||||
| `config/config.go` | `github.com/BurntSushi/toml` | toml.DecodeFile, md.Undecoded() | ✓ WIRED | Lines 104 and 115 confirmed; dependency in go.mod |
|
||||
| `cmd/netsynth/main.go` | `config/config.go` | config.Load(configPath) | ✓ WIRED | Line 87: `freqCfgs, err := config.Load(configPath)` |
|
||||
| `cmd/netsynth/main.go` | `encode/mp3.go` | encode.RunSynthesis(snapshots, outputPath, freqCfgs) | ✓ WIRED | Lines 157 and 225 — both runLiveMode and runPcapMode |
|
||||
| `encode/mp3.go` | `synth/bank.go` | synth.NewBank(1.0, freqCfgs) using passed-in config | ✓ WIRED | Line 58: `synth.NewBank(1.0, freqCfgs)` — no hardcoding |
|
||||
|
||||
### Data-Flow Trace (Level 4)
|
||||
|
||||
| Artifact | Data Variable | Source | Produces Real Data | Status |
|
||||
|-----------------------|---------------|-------------------------------|--------------------|-------------|
|
||||
| `config/config.go` | result map | synth.ClassFreqConfigs + TOML overrides | Yes — copies from ClassFreqConfigs (14 entries), overlays TOML | ✓ FLOWING |
|
||||
| `encode/mp3.go` | freqCfgs | Injected from config.Load | Yes — passed in from caller, not hardcoded | ✓ FLOWING |
|
||||
| `cmd/netsynth/main.go`| freqCfgs | config.Load(configPath) return | Yes — real config.Load result, error-guarded | ✓ FLOWING |
|
||||
|
||||
### Behavioral Spot-Checks
|
||||
|
||||
| Behavior | Command | Result | Status |
|
||||
|----------------------------------------------------|---------------------------------------------------------------|-----------------------------------------------------|---------|
|
||||
| `--config` flag appears in CLI help | `go run ./cmd/netsynth --help` | `--config string Path to TOML config file (default: auto-discover)` | ✓ PASS |
|
||||
| Explicit --config missing file errors before capture | `go run ./cmd/netsynth --config /nonexistent/file.toml --read /dev/null` | exit 1, "config file not found: /nonexistent/file.toml" | ✓ PASS |
|
||||
| All 9 config package tests pass | `go test ./config/... -count=1 -v` | All 9 TestLoad* PASS | ✓ PASS |
|
||||
| Full test suite green | `go test ./... -count=1` | 7 packages all ok | ✓ PASS |
|
||||
| Binary builds and vets clean | `go build ./... && go vet ./...` | BUILD OK, VET OK | ✓ PASS |
|
||||
|
||||
### Requirements Coverage
|
||||
|
||||
| Requirement | Source Plan | Description | Status | Evidence |
|
||||
|-------------|-------------|------------------------------------------------------------------------|-------------|------------------------------------------------------------------|
|
||||
| CFG-01 | 06-01 | User can create a TOML config file that overrides default sound mappings | ✓ SATISFIED | config.Load + merge; TestLoadPartialOverrideFrequency PASS |
|
||||
| CFG-02 | 06-01 | Tool auto-discovers config from ./netsynth.toml or ~/.config/netsynth/config.toml (silent if absent) | ✓ SATISFIED | discoverPath(); TestLoadNoConfig PASS (t.Chdir to empty dir) |
|
||||
| CFG-03 | 06-02 | User can specify explicit config path via --config flag (error if missing) | ✓ SATISFIED | --config flag registered; config.Load returns "not found" error |
|
||||
| CFG-04 | 06-01 | User can override individual values without replicating entire default config | ✓ SATISFIED | Pointer fields (*float64, *string); TestLoadPartialOverrideWaveform PASS |
|
||||
| CFG-05 | 06-01 | Unknown keys in config file produce a clear error with the typo'd key name | ✓ SATISFIED | md.Undecoded() + keyPath extraction; TestLoadUnknownKey PASS |
|
||||
|
||||
All 5 requirement IDs from both PLAN frontmatter entries (CFG-01, CFG-02, CFG-04, CFG-05 from 06-01; CFG-03 from 06-02) are satisfied with evidence.
|
||||
|
||||
**Orphaned requirements check:** REQUIREMENTS.md traceability table maps CFG-01 through CFG-05 to Phase 6. All 5 are claimed and verified. No orphans.
|
||||
|
||||
### Anti-Patterns Found
|
||||
|
||||
| File | Line | Pattern | Severity | Impact |
|
||||
|--------------------|------|-------------------|----------|---------|
|
||||
| `go.mod` | 14 | BurntSushi/toml marked `// indirect` despite being a direct import in config/config.go | Info | None functional — `go mod tidy` corrects it; does not affect build or tests |
|
||||
|
||||
No placeholders, stub functions, hardcoded empty returns, or TODO markers found in any phase 6 modified files.
|
||||
|
||||
### Human Verification Required
|
||||
|
||||
No items require human verification. All functional behaviors were confirmed programmatically:
|
||||
- Config loading, merging, and validation verified via unit tests.
|
||||
- CLI flag confirmed in help output.
|
||||
- Error-before-capture behavior confirmed via live CLI invocation.
|
||||
|
||||
### Gaps Summary
|
||||
|
||||
No gaps. All 10 observable truths verified, all 5 artifacts substantive and wired, all 6 key links confirmed, all 5 requirements satisfied. The single info-level finding (BurntSushi/toml marked indirect in go.mod) is a trivial go module hygiene item — `go mod tidy` resolves it and it has no impact on correctness or functionality.
|
||||
|
||||
---
|
||||
|
||||
_Verified: 2026-03-26T20:15:00Z_
|
||||
_Verifier: Claude (gsd-verifier)_
|
||||
@@ -0,0 +1,302 @@
|
||||
---
|
||||
phase: 07-custom-rules-and-print-config
|
||||
plan: 01
|
||||
type: tdd
|
||||
wave: 1
|
||||
depends_on: []
|
||||
files_modified:
|
||||
- config/config.go
|
||||
- config/config_test.go
|
||||
autonomous: true
|
||||
requirements:
|
||||
- RULE-01
|
||||
- RULE-02
|
||||
- RULE-03
|
||||
|
||||
must_haves:
|
||||
truths:
|
||||
- "TOML [[rules]] blocks parse into classify.Rule slices"
|
||||
- "Missing protocol or class in a rule produces a clear error at startup"
|
||||
- "User rules are returned separately from FreqCfgs for caller to prepend"
|
||||
- "New class names without explicit sound config get auto-assigned frequencies in 1200-2400 Hz range"
|
||||
- "Built-in class names in user rules do not get overwritten by auto-freq"
|
||||
artifacts:
|
||||
- path: "config/config.go"
|
||||
provides: "RawRule, LoadResult, validateRules, convertRules, autoAssignFreq, addAutoFreqEntries"
|
||||
contains: "type LoadResult struct"
|
||||
- path: "config/config_test.go"
|
||||
provides: "Tests for rule parsing, validation, auto-freq, LoadResult"
|
||||
contains: "TestLoadCustomRules"
|
||||
key_links:
|
||||
- from: "config/config.go"
|
||||
to: "classify/rules.go"
|
||||
via: "convertRules produces []classify.Rule"
|
||||
pattern: "classify\\.Rule"
|
||||
- from: "config/config.go"
|
||||
to: "synth/config.go"
|
||||
via: "autoAssignFreq creates FreqConfig entries with WaveformPresetHarmonics"
|
||||
pattern: "synth\\.WaveformPresetHarmonics"
|
||||
---
|
||||
|
||||
<objective>
|
||||
Extend the config package to parse `[[rules]]` TOML blocks into classification rules, validate them, auto-assign frequencies for new class names, and return a `LoadResult` struct from `Load()`.
|
||||
|
||||
Purpose: This is the data layer for user-defined classification rules (RULE-01, RULE-02, RULE-03). The LoadResult struct becomes the contract consumed by Plan 02 for CLI wiring and print-config.
|
||||
|
||||
Output: Updated `config/config.go` with RawRule, LoadResult, validation, auto-freq; comprehensive tests in `config/config_test.go`.
|
||||
</objective>
|
||||
|
||||
<execution_context>
|
||||
@$HOME/.claude/get-shit-done/workflows/execute-plan.md
|
||||
@$HOME/.claude/get-shit-done/templates/summary.md
|
||||
</execution_context>
|
||||
|
||||
<context>
|
||||
@.planning/PROJECT.md
|
||||
@.planning/ROADMAP.md
|
||||
@.planning/STATE.md
|
||||
@.planning/phases/07-custom-rules-and-print-config/07-CONTEXT.md
|
||||
@.planning/phases/07-custom-rules-and-print-config/07-RESEARCH.md
|
||||
|
||||
@config/config.go
|
||||
@config/config_test.go
|
||||
@classify/rules.go
|
||||
@classify/types.go
|
||||
@synth/config.go
|
||||
|
||||
<interfaces>
|
||||
<!-- Key types and contracts the executor needs. -->
|
||||
|
||||
From classify/rules.go:
|
||||
```go
|
||||
type Rule struct {
|
||||
Protocol string
|
||||
DstPort uint16
|
||||
Class TrafficClass
|
||||
}
|
||||
var DefaultRules = []Rule{ ... } // 12 rules, first-match-wins
|
||||
```
|
||||
|
||||
From classify/types.go:
|
||||
```go
|
||||
type TrafficClass string
|
||||
func AllClasses() []TrafficClass // returns 14 built-in classes
|
||||
```
|
||||
|
||||
From synth/config.go:
|
||||
```go
|
||||
type WaveformType int
|
||||
const WaveformSine WaveformType = 1
|
||||
type FreqConfig struct {
|
||||
BaseHz float64
|
||||
Harmonics []HarmonicDef
|
||||
Pan float64
|
||||
WaveformType WaveformType
|
||||
}
|
||||
var ClassFreqConfigs = map[classify.TrafficClass]FreqConfig{ ... } // 14 entries, max 1047 Hz
|
||||
func WaveformPresetHarmonics(wt WaveformType, baseHz float64, sampleRate int) []HarmonicDef
|
||||
const SampleRate = 44100
|
||||
```
|
||||
|
||||
From config/config.go (current):
|
||||
```go
|
||||
type SoundOverride struct {
|
||||
Frequency *float64 `toml:"frequency"`
|
||||
Waveform *string `toml:"waveform"`
|
||||
}
|
||||
type rawConfig struct {
|
||||
Sounds map[string]SoundOverride `toml:"sounds"`
|
||||
}
|
||||
func Load(configPath string) (map[classify.TrafficClass]synth.FreqConfig, error)
|
||||
```
|
||||
|
||||
From config/config_test.go (patterns):
|
||||
```go
|
||||
func writeTOML(t *testing.T, content string) string // creates temp TOML file
|
||||
// Tests call config.Load(path) and check returned map
|
||||
```
|
||||
</interfaces>
|
||||
</context>
|
||||
|
||||
<tasks>
|
||||
|
||||
<task type="auto" tdd="true">
|
||||
<name>Task 1: RawRule, LoadResult, validation, conversion, and auto-freq with TDD</name>
|
||||
<files>config/config.go, config/config_test.go</files>
|
||||
<read_first>config/config.go, config/config_test.go, classify/rules.go, classify/types.go, synth/config.go</read_first>
|
||||
<behavior>
|
||||
- TestLoadCustomRules: TOML with `[[rules]]` block (port=8080, protocol="tcp", class="MyApp") + `[sounds.MyApp]` (frequency=300.0) parses successfully; LoadResult.UserRules has len 1 with Protocol="tcp", DstPort=8080, Class="MyApp"; LoadResult.FreqCfgs["MyApp"].BaseHz == 300.0
|
||||
- TestLoadCustomRuleNoPort: TOML with `[[rules]]` (protocol="udp", class="AllUDP", no port field) parses; UserRules[0].DstPort == 0
|
||||
- TestLoadCustomRuleMissingProtocol: TOML `[[rules]]` with class="X" but no protocol field -> error containing "protocol is required"
|
||||
- TestLoadCustomRuleMissingClass: TOML `[[rules]]` with protocol="tcp" but no class field -> error containing "class is required"
|
||||
- TestLoadCustomRuleInvalidProtocol: TOML `[[rules]]` with protocol="ftp" -> error containing "invalid protocol"
|
||||
- TestLoadCustomRuleUnknownField: TOML `[[rules]]` with typo_field="bad" -> error containing "typo_field" (from Undecoded())
|
||||
- TestUserRulesPrepend: Load returns UserRules separately from FreqCfgs; caller can do `append(result.UserRules, classify.DefaultRules...)` to get user rules first
|
||||
- TestAutoFreqAssignment: TOML with `[[rules]]` (class="GameServer", protocol="tcp") and NO `[sounds.GameServer]` -> FreqCfgs contains "GameServer" entry with BaseHz in range [1200, 2350] and WaveformType == WaveformSine
|
||||
- TestAutoFreqDeterministic: Two Load() calls with same class name produce same BaseHz
|
||||
- TestAutoFreqSkipsBuiltins: TOML with `[[rules]]` (class="HTTPS", protocol="tcp", port=443) -> FreqCfgs["HTTPS"].BaseHz == 175.0 (the default), NOT an auto-assigned value
|
||||
- TestLoadResultConfigPath: Load(explicit_path) -> LoadResult.ConfigPath == explicit_path; Load("") with no file -> LoadResult.ConfigPath == ""
|
||||
- TestLoadNoConfigReturnsLoadResult: Load("") in empty dir returns LoadResult with len(FreqCfgs)==14, len(UserRules)==0, ConfigPath==""
|
||||
- TestExistingTestsStillPass: All 8 existing tests in config_test.go continue to pass after Load() signature change (they need updating to use LoadResult)
|
||||
</behavior>
|
||||
<action>
|
||||
RED phase -- Write all test functions listed in behavior above in config/config_test.go. Tests call config.Load() and assert on LoadResult fields. Update the 8 existing tests to use the new LoadResult return type (e.g., `result, err := config.Load(path); cfgs := result.FreqCfgs`). Run tests -- they must all fail (Load still returns bare map).
|
||||
|
||||
GREEN phase -- Modify config/config.go:
|
||||
|
||||
1. Add RawRule struct (per D-01):
|
||||
```go
|
||||
type RawRule struct {
|
||||
Port *uint16 `toml:"port"`
|
||||
Protocol string `toml:"protocol"`
|
||||
Class string `toml:"class"`
|
||||
}
|
||||
```
|
||||
|
||||
2. Add Rules field to rawConfig:
|
||||
```go
|
||||
type rawConfig struct {
|
||||
Sounds map[string]SoundOverride `toml:"sounds"`
|
||||
Rules []RawRule `toml:"rules"`
|
||||
}
|
||||
```
|
||||
|
||||
3. Add LoadResult struct (per D-13, Claude's Discretion: struct over tuple):
|
||||
```go
|
||||
type LoadResult struct {
|
||||
FreqCfgs map[classify.TrafficClass]synth.FreqConfig
|
||||
UserRules []classify.Rule
|
||||
ConfigPath string
|
||||
}
|
||||
```
|
||||
|
||||
4. Add validateRules function called from validate():
|
||||
```go
|
||||
func validateRules(rules []RawRule) error {
|
||||
validProtocols := map[string]bool{"tcp": true, "udp": true, "icmp": true}
|
||||
for i, r := range rules {
|
||||
if r.Protocol == "" {
|
||||
return fmt.Errorf("config: rules[%d]: protocol is required", i)
|
||||
}
|
||||
if !validProtocols[r.Protocol] {
|
||||
return fmt.Errorf("config: rules[%d]: invalid protocol %q -- valid: tcp, udp, icmp", i, r.Protocol)
|
||||
}
|
||||
if r.Class == "" {
|
||||
return fmt.Errorf("config: rules[%d]: class is required", i)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
```
|
||||
|
||||
5. Add convertRules function:
|
||||
```go
|
||||
func convertRules(raw []RawRule) []classify.Rule {
|
||||
result := make([]classify.Rule, len(raw))
|
||||
for i, r := range raw {
|
||||
var port uint16
|
||||
if r.Port != nil {
|
||||
port = *r.Port
|
||||
}
|
||||
result[i] = classify.Rule{
|
||||
Protocol: r.Protocol,
|
||||
DstPort: port,
|
||||
Class: classify.TrafficClass(r.Class),
|
||||
}
|
||||
}
|
||||
return result
|
||||
}
|
||||
```
|
||||
|
||||
6. Add autoAssignFreq function (per D-07/D-08, using FNV-32a):
|
||||
```go
|
||||
import "hash/fnv"
|
||||
|
||||
func autoAssignFreq(className string) float64 {
|
||||
h := fnv.New32a()
|
||||
h.Write([]byte(className))
|
||||
const (
|
||||
baseHz = 1200.0
|
||||
stepHz = 50.0
|
||||
numSteps = uint32(24)
|
||||
)
|
||||
return baseHz + float64(h.Sum32()%numSteps)*stepHz
|
||||
}
|
||||
```
|
||||
|
||||
7. Add addAutoFreqEntries function (called AFTER merge, per Pitfall 4):
|
||||
```go
|
||||
func addAutoFreqEntries(cfgs map[classify.TrafficClass]synth.FreqConfig, userRules []classify.Rule) {
|
||||
for _, rule := range userRules {
|
||||
if _, exists := cfgs[rule.Class]; !exists {
|
||||
baseHz := autoAssignFreq(string(rule.Class))
|
||||
cfgs[rule.Class] = synth.FreqConfig{
|
||||
BaseHz: baseHz,
|
||||
WaveformType: synth.WaveformSine,
|
||||
Harmonics: synth.WaveformPresetHarmonics(synth.WaveformSine, baseHz, synth.SampleRate),
|
||||
Pan: 0.0,
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
8. Change Load() signature to return LoadResult:
|
||||
```go
|
||||
func Load(configPath string) (LoadResult, error) {
|
||||
```
|
||||
- When no config found: return `LoadResult{FreqCfgs: copyDefaults(), ConfigPath: ""}`, nil
|
||||
- After parseFile + validate + merge: call convertRules, call addAutoFreqEntries, return LoadResult with FreqCfgs, UserRules, and the resolved config path
|
||||
- Update validate() to also call validateRules(raw.Rules)
|
||||
- The `merge()` function for unknown class names should NO LONGER print a warning for classes that appear in raw.Rules -- those are legitimate custom classes. Keep the warning only for [sounds.X] where X is neither a built-in class nor a class defined in [[rules]].
|
||||
|
||||
9. Update the merge() function: Change the unknown-class warning logic. Instead of always warning on unknown class names in sounds, accept the `userRules []RawRule` as a parameter (or check after conversion). Simplest: after converting rules, pass the set of user-defined class names to merge so it can skip the warning for those. Alternatively, run merge first (with warnings), then let addAutoFreqEntries handle user-defined classes. The warning is acceptable for now -- it only fires for [sounds.X] where X has no matching [[rules]] entry AND is not a built-in class. Keep existing warning behavior, it is harmless.
|
||||
|
||||
REFACTOR phase -- Clean up if needed. Ensure all tests pass.
|
||||
|
||||
Run `go test ./config/...` -- all tests must pass.
|
||||
Run `go test ./...` -- full suite must pass (the Load() call site in main.go will break; that is expected and fixed in Plan 02).
|
||||
</action>
|
||||
<verify>
|
||||
<automated>go test ./config/... -v -count=1</automated>
|
||||
</verify>
|
||||
<acceptance_criteria>
|
||||
- config/config.go contains `type RawRule struct` with `Port *uint16`, `Protocol string`, `Class string` fields
|
||||
- config/config.go contains `type LoadResult struct` with `FreqCfgs`, `UserRules`, `ConfigPath` fields
|
||||
- config/config.go contains `func Load(configPath string) (LoadResult, error)`
|
||||
- config/config.go contains `func validateRules(rules []RawRule) error`
|
||||
- config/config.go contains `func convertRules(raw []RawRule) []classify.Rule`
|
||||
- config/config.go contains `func autoAssignFreq(className string) float64` with `fnv.New32a()`
|
||||
- config/config.go contains `func addAutoFreqEntries(`
|
||||
- config/config.go imports `"hash/fnv"`
|
||||
- config/config_test.go contains `TestLoadCustomRules`
|
||||
- config/config_test.go contains `TestAutoFreqAssignment`
|
||||
- config/config_test.go contains `TestAutoFreqSkipsBuiltins`
|
||||
- config/config_test.go contains `TestLoadCustomRuleMissingProtocol`
|
||||
- `go test ./config/... -count=1` exits 0
|
||||
</acceptance_criteria>
|
||||
<done>
|
||||
Load() returns LoadResult with FreqCfgs + UserRules + ConfigPath. TOML [[rules]] blocks parse, validate (protocol required, class required, valid protocols only), and convert to classify.Rule slices. Auto-frequency assignment creates FreqConfig entries for new class names in 1200-2350 Hz range using FNV-32a. Built-in class names from user rules are NOT overwritten. All existing config tests updated and passing. Full config test suite green.
|
||||
</done>
|
||||
</task>
|
||||
|
||||
</tasks>
|
||||
|
||||
<verification>
|
||||
- `go test ./config/... -v -count=1` passes all tests including new rule-related tests
|
||||
- `go vet ./config/...` reports no issues
|
||||
- LoadResult struct is exported and usable from cmd/netsynth package
|
||||
</verification>
|
||||
|
||||
<success_criteria>
|
||||
- config.Load() returns LoadResult struct (not bare map)
|
||||
- [[rules]] TOML blocks parse into UserRules field
|
||||
- Validation catches missing protocol, missing class, invalid protocol
|
||||
- Auto-freq assigns 1200-2350 Hz for new class names, skips built-ins
|
||||
- All 8 existing config tests updated and passing
|
||||
- All new tests passing
|
||||
</success_criteria>
|
||||
|
||||
<output>
|
||||
After completion, create `.planning/phases/07-custom-rules-and-print-config/07-01-SUMMARY.md`
|
||||
</output>
|
||||
@@ -0,0 +1,94 @@
|
||||
---
|
||||
phase: 07-custom-rules-and-print-config
|
||||
plan: "01"
|
||||
subsystem: config
|
||||
tags: [config, rules, tdd, classification, auto-freq]
|
||||
dependency_graph:
|
||||
requires: []
|
||||
provides: [LoadResult, RawRule, validateRules, convertRules, autoAssignFreq, addAutoFreqEntries]
|
||||
affects: [cmd/netsynth/main.go]
|
||||
tech_stack:
|
||||
added: ["hash/fnv"]
|
||||
patterns: [LoadResult-struct, FNV-32a-deterministic-hash, TDD-red-green]
|
||||
key_files:
|
||||
created: []
|
||||
modified:
|
||||
- config/config.go
|
||||
- config/config_test.go
|
||||
- cmd/netsynth/main.go
|
||||
decisions:
|
||||
- "addAutoFreqEntries runs before merge so [sounds.X] overrides apply to user-defined classes"
|
||||
- "merge() warning for unknown class names still fires for [sounds.X] where X is neither built-in nor in [[rules]] -- acceptable harmless warning"
|
||||
- "main.go call site updated to use LoadResult.FreqCfgs -- minimal fix to keep compile; full wiring deferred to Plan 02"
|
||||
metrics:
|
||||
duration: 3min
|
||||
completed: "2026-03-26T20:45:08Z"
|
||||
tasks_completed: 1
|
||||
files_modified: 3
|
||||
---
|
||||
|
||||
# Phase 7 Plan 01: Config Rule Parsing and LoadResult Summary
|
||||
|
||||
Extend config package to parse `[[rules]]` TOML blocks, validate them, auto-assign frequencies for new class names using FNV-32a, and return a `LoadResult` struct from `Load()`.
|
||||
|
||||
## What Was Built
|
||||
|
||||
`config.Load()` now returns `LoadResult{FreqCfgs, UserRules, ConfigPath}` instead of a bare map. The new struct is the data contract for Plan 02's CLI wiring and `--print-config` output.
|
||||
|
||||
**New types and functions in config/config.go:**
|
||||
- `RawRule` struct: `Port *uint16`, `Protocol string`, `Class string` — pointer Port to distinguish missing vs zero
|
||||
- `LoadResult` struct: `FreqCfgs`, `UserRules []classify.Rule`, `ConfigPath string`
|
||||
- `validateRules()`: checks protocol required, class required, valid protocols (tcp/udp/icmp)
|
||||
- `convertRules()`: converts `[]RawRule` to `[]classify.Rule`
|
||||
- `autoAssignFreq()`: FNV-32a hash → deterministic Hz in [1200, 2350] range (24 steps of 50Hz)
|
||||
- `addAutoFreqEntries()`: creates `FreqConfig` entries for new class names, skips built-ins
|
||||
- Import: `hash/fnv`
|
||||
|
||||
**Key operation order:** `addAutoFreqEntries` runs before `merge` so that `[sounds.MyApp]` sound overrides apply to user-defined classes that were added by auto-freq.
|
||||
|
||||
## Tasks Completed
|
||||
|
||||
| Task | Name | Commit | Files |
|
||||
|------|------|--------|-------|
|
||||
| 1 | RawRule, LoadResult, validation, conversion, auto-freq with TDD | 4b365cd | config/config.go, config/config_test.go, cmd/netsynth/main.go |
|
||||
|
||||
## Deviations from Plan
|
||||
|
||||
### Auto-fixed Issues
|
||||
|
||||
**1. [Rule 1 - Bug] Operation order: addAutoFreqEntries must run before merge**
|
||||
- **Found during:** Task 1 GREEN phase
|
||||
- **Issue:** Plan's action section said "merge first, then addAutoFreqEntries" but this caused [sounds.MyApp] overrides to be ignored for user-defined classes (merge only applies to classes already in the map)
|
||||
- **Fix:** Reversed the order — addAutoFreqEntries first (creates the entry), then merge (applies sound overrides)
|
||||
- **Files modified:** config/config.go
|
||||
- **Commit:** 4b365cd
|
||||
|
||||
**2. [Rule 3 - Blocking] main.go call site updated to use LoadResult**
|
||||
- **Found during:** Task 1 GREEN phase
|
||||
- **Issue:** Plan notes this break is expected but tests wouldn't compile without it
|
||||
- **Fix:** Minimal one-line update: `loadResult, err := config.Load(...)` + `freqCfgs := loadResult.FreqCfgs`
|
||||
- **Files modified:** cmd/netsynth/main.go
|
||||
- **Commit:** 4b365cd
|
||||
|
||||
## Test Coverage
|
||||
|
||||
21 tests total (8 existing + 13 new):
|
||||
- `TestLoadCustomRules` - TOML [[rules]] block with port/protocol/class
|
||||
- `TestLoadCustomRuleNoPort` - optional port field, DstPort=0 when absent
|
||||
- `TestLoadCustomRuleMissingProtocol` - validation error "protocol is required"
|
||||
- `TestLoadCustomRuleMissingClass` - validation error "class is required"
|
||||
- `TestLoadCustomRuleInvalidProtocol` - validation error "invalid protocol"
|
||||
- `TestLoadCustomRuleUnknownField` - undecoded TOML field error
|
||||
- `TestUserRulesPrepend` - UserRules field usable for prepend pattern
|
||||
- `TestAutoFreqAssignment` - BaseHz in [1200, 2350], WaveformSine
|
||||
- `TestAutoFreqDeterministic` - same class name produces same Hz
|
||||
- `TestAutoFreqSkipsBuiltins` - HTTPS stays at 175.0 default
|
||||
- `TestLoadResultConfigPath` - ConfigPath populated correctly
|
||||
- `TestLoadNoConfigReturnsLoadResult` - returns LoadResult with empty UserRules
|
||||
- All 8 existing tests updated to use `result.FreqCfgs`
|
||||
|
||||
## Known Stubs
|
||||
|
||||
None. All new functions are fully implemented and tested.
|
||||
|
||||
## Self-Check: PASSED
|
||||
@@ -0,0 +1,444 @@
|
||||
---
|
||||
phase: 07-custom-rules-and-print-config
|
||||
plan: 02
|
||||
type: execute
|
||||
wave: 2
|
||||
depends_on:
|
||||
- "07-01"
|
||||
files_modified:
|
||||
- cmd/netsynth/main.go
|
||||
- cmd/netsynth/main_test.go
|
||||
- config/config.go
|
||||
- config/config_test.go
|
||||
autonomous: true
|
||||
requirements:
|
||||
- RULE-02
|
||||
- CFG-06
|
||||
|
||||
must_haves:
|
||||
truths:
|
||||
- "User runs netsynth --print-config and sees full effective config as commented TOML on stdout without capture starting"
|
||||
- "User rules prepend before built-in rules so first-match-wins gives user priority"
|
||||
- "Print-config output shows source path when config file loaded"
|
||||
- "Print-config output annotates defaults vs overrides vs auto-assigned"
|
||||
- "Print-config works without -i flag"
|
||||
- "Print-config includes [[rules]] section when user rules are present"
|
||||
artifacts:
|
||||
- path: "cmd/netsynth/main.go"
|
||||
provides: "--print-config flag, runPrintConfig(), user rule prepend"
|
||||
contains: "print-config"
|
||||
- path: "config/config.go"
|
||||
provides: "PrintConfig function"
|
||||
contains: "func PrintConfig("
|
||||
- path: "cmd/netsynth/main_test.go"
|
||||
provides: "Tests for --print-config flag"
|
||||
contains: "TestPrintConfigFlagRegistered"
|
||||
- path: "config/config_test.go"
|
||||
provides: "Tests for PrintConfig output"
|
||||
contains: "TestPrintConfigContainsAllClasses"
|
||||
key_links:
|
||||
- from: "cmd/netsynth/main.go"
|
||||
to: "config/config.go"
|
||||
via: "runPrintConfig calls config.Load then config.PrintConfig"
|
||||
pattern: "config\\.PrintConfig"
|
||||
- from: "cmd/netsynth/main.go"
|
||||
to: "classify/rules.go"
|
||||
via: "append(result.UserRules, classify.DefaultRules...)"
|
||||
pattern: "append.*UserRules.*DefaultRules"
|
||||
---
|
||||
|
||||
<objective>
|
||||
Wire the LoadResult into main.go (user rules prepend, --print-config flag), implement the PrintConfig output function, and add comprehensive tests for both.
|
||||
|
||||
Purpose: Completes RULE-02 (user rules fire before built-ins at the CLI level) and CFG-06 (--print-config UX). This is the final plan for Phase 7 and the v1.1 milestone.
|
||||
|
||||
Output: Updated main.go with --print-config and user rule prepending; PrintConfig function in config package; tests in both test files.
|
||||
</objective>
|
||||
|
||||
<execution_context>
|
||||
@$HOME/.claude/get-shit-done/workflows/execute-plan.md
|
||||
@$HOME/.claude/get-shit-done/templates/summary.md
|
||||
</execution_context>
|
||||
|
||||
<context>
|
||||
@.planning/PROJECT.md
|
||||
@.planning/ROADMAP.md
|
||||
@.planning/STATE.md
|
||||
@.planning/phases/07-custom-rules-and-print-config/07-CONTEXT.md
|
||||
@.planning/phases/07-custom-rules-and-print-config/07-RESEARCH.md
|
||||
@.planning/phases/07-custom-rules-and-print-config/07-01-SUMMARY.md
|
||||
|
||||
@cmd/netsynth/main.go
|
||||
@cmd/netsynth/main_test.go
|
||||
@config/config.go
|
||||
@config/config_test.go
|
||||
@classify/rules.go
|
||||
@classify/types.go
|
||||
@synth/config.go
|
||||
|
||||
<interfaces>
|
||||
<!-- Post-Plan-01 interfaces the executor needs -->
|
||||
|
||||
From config/config.go (after Plan 01):
|
||||
```go
|
||||
type LoadResult struct {
|
||||
FreqCfgs map[classify.TrafficClass]synth.FreqConfig
|
||||
UserRules []classify.Rule
|
||||
ConfigPath string
|
||||
}
|
||||
|
||||
func Load(configPath string) (LoadResult, error)
|
||||
```
|
||||
|
||||
From classify/rules.go:
|
||||
```go
|
||||
var DefaultRules = []Rule{ ... } // 12 rules
|
||||
func NewClassifier(rules []Rule) *Classifier
|
||||
```
|
||||
|
||||
From synth/config.go:
|
||||
```go
|
||||
var ClassFreqConfigs = map[classify.TrafficClass]FreqConfig{ ... } // 14 entries
|
||||
type FreqConfig struct {
|
||||
BaseHz float64
|
||||
Harmonics []HarmonicDef
|
||||
Pan float64
|
||||
WaveformType WaveformType
|
||||
}
|
||||
```
|
||||
|
||||
From classify/types.go:
|
||||
```go
|
||||
func AllClasses() []TrafficClass // 14 built-in classes in display order
|
||||
```
|
||||
|
||||
From cmd/netsynth/main.go (current run() flow):
|
||||
```go
|
||||
// listIfaces check is first early-exit
|
||||
// then mutual exclusion check for --read and -i
|
||||
// then interface-required check
|
||||
// then BPF filter validation
|
||||
// then config.Load(configPath)
|
||||
// then output path resolution
|
||||
// then runLiveMode or runPcapMode
|
||||
```
|
||||
|
||||
From cmd/netsynth/main_test.go (patterns):
|
||||
```go
|
||||
func newTestCmd() *cobra.Command // creates fresh command with all flags
|
||||
// Tests use rootCmd.SetArgs, rootCmd.Execute(), check err
|
||||
// PersistentPreRunE wires test vars to package-level vars
|
||||
```
|
||||
</interfaces>
|
||||
</context>
|
||||
|
||||
<tasks>
|
||||
|
||||
<task type="auto">
|
||||
<name>Task 1: Wire LoadResult into main.go and add --print-config flag</name>
|
||||
<files>cmd/netsynth/main.go, cmd/netsynth/main_test.go</files>
|
||||
<read_first>cmd/netsynth/main.go, cmd/netsynth/main_test.go, config/config.go, classify/rules.go</read_first>
|
||||
<action>
|
||||
**main.go changes:**
|
||||
|
||||
1. Add package-level var for print-config flag:
|
||||
```go
|
||||
var printConfig bool // add alongside existing configPath var
|
||||
```
|
||||
|
||||
2. Register --print-config flag in main() alongside existing flags:
|
||||
```go
|
||||
rootCmd.Flags().BoolVar(&printConfig, "print-config", false, "Print effective config as commented TOML and exit")
|
||||
```
|
||||
|
||||
3. In run(), add --print-config check as the SECOND early-exit (after listIfaces, BEFORE the mutual exclusion check). Per Pitfall 2 from research, this must come before the interface-required validation so `netsynth --print-config` works without `-i`:
|
||||
```go
|
||||
// --print-config mode (CFG-06, D-09/D-10)
|
||||
if printConfig {
|
||||
return runPrintConfig()
|
||||
}
|
||||
```
|
||||
|
||||
4. Add runPrintConfig function:
|
||||
```go
|
||||
func runPrintConfig() error {
|
||||
result, err := config.Load(configPath)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
output := config.PrintConfig(result)
|
||||
fmt.Print(output)
|
||||
return nil
|
||||
}
|
||||
```
|
||||
|
||||
5. Update ALL Load() call sites to use LoadResult (there is one in run()):
|
||||
```go
|
||||
// Load config (CFG-01 through CFG-05, D-11: fail fast before capture)
|
||||
result, err := config.Load(configPath)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
```
|
||||
|
||||
6. After config load, prepend user rules before creating classifier (per D-04, RULE-02). Update BOTH runLiveMode and runPcapMode. Change their signatures to accept LoadResult instead of bare map:
|
||||
```go
|
||||
func runLiveMode(cmd *cobra.Command, result config.LoadResult) error {
|
||||
// ...
|
||||
// D-04: user rules prepend before built-ins; first-match-wins
|
||||
allRules := append(result.UserRules, classify.DefaultRules...)
|
||||
classifier := classify.NewClassifier(allRules)
|
||||
// ...use result.FreqCfgs where freqCfgs was used before...
|
||||
}
|
||||
```
|
||||
Do the same for runPcapMode. Update the call sites in run():
|
||||
```go
|
||||
if readPath != "" {
|
||||
return runPcapMode(cmd, result)
|
||||
}
|
||||
return runLiveMode(cmd, result)
|
||||
```
|
||||
|
||||
7. In both runLiveMode and runPcapMode, replace `freqCfgs` parameter usage with `result.FreqCfgs` in the encode.RunSynthesis call:
|
||||
```go
|
||||
if err := encode.RunSynthesis(collectedSnapshots, outputPath, result.FreqCfgs); err != nil {
|
||||
```
|
||||
|
||||
**main_test.go changes:**
|
||||
|
||||
8. Update newTestCmd() to include --print-config flag and --config flag:
|
||||
```go
|
||||
var testPrintConfig bool
|
||||
var testConfigPath string
|
||||
// ...in flag registration:
|
||||
rootCmd.Flags().BoolVar(&testPrintConfig, "print-config", false, "Print effective config")
|
||||
rootCmd.Flags().StringVar(&testConfigPath, "config", "", "Path to TOML config file")
|
||||
// ...in PersistentPreRunE:
|
||||
printConfig = testPrintConfig
|
||||
configPath = testConfigPath
|
||||
```
|
||||
|
||||
9. Add TestPrintConfigFlagRegistered:
|
||||
```go
|
||||
func TestPrintConfigFlagRegistered(t *testing.T) {
|
||||
rootCmd := newTestCmd()
|
||||
f := rootCmd.Flags().Lookup("print-config")
|
||||
if f == nil {
|
||||
t.Fatal("expected --print-config flag to be registered")
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
10. Add TestPrintConfigNoInterface -- verifies --print-config works without -i:
|
||||
```go
|
||||
func TestPrintConfigNoInterface(t *testing.T) {
|
||||
// Reset globals
|
||||
ifaceName = ""
|
||||
listIfaces = false
|
||||
printConfig = false
|
||||
configPath = ""
|
||||
// ... reset all globals
|
||||
t.Chdir(t.TempDir()) // no netsynth.toml in temp dir
|
||||
|
||||
rootCmd := newTestCmd()
|
||||
rootCmd.SetArgs([]string{"--print-config"})
|
||||
|
||||
var outBuf, errBuf bytes.Buffer
|
||||
rootCmd.SetOut(&outBuf)
|
||||
rootCmd.SetErr(&errBuf)
|
||||
|
||||
err := rootCmd.Execute()
|
||||
if err != nil {
|
||||
t.Fatalf("--print-config should not require -i, got error: %v", err)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
11. Add TestPrintConfigWithConfigFile -- verifies print-config loads and displays a user config:
|
||||
```go
|
||||
func TestPrintConfigWithConfigFile(t *testing.T) {
|
||||
// Create temp TOML with an override
|
||||
dir := t.TempDir()
|
||||
tomlPath := filepath.Join(dir, "test.toml")
|
||||
os.WriteFile(tomlPath, []byte("[sounds.ICMP]\nfrequency = 100.0\n"), 0644)
|
||||
|
||||
// Reset globals
|
||||
// ...
|
||||
rootCmd := newTestCmd()
|
||||
rootCmd.SetArgs([]string{"--print-config", "--config", tomlPath})
|
||||
|
||||
var outBuf, errBuf bytes.Buffer
|
||||
rootCmd.SetOut(&outBuf)
|
||||
rootCmd.SetErr(&errBuf)
|
||||
|
||||
// Capture stdout by redirecting os.Stdout temporarily, OR
|
||||
// check that no error occurred (PrintConfig writes to os.Stdout via fmt.Print)
|
||||
err := rootCmd.Execute()
|
||||
if err != nil {
|
||||
t.Fatalf("--print-config with --config should succeed, got: %v", err)
|
||||
}
|
||||
}
|
||||
```
|
||||
</action>
|
||||
<verify>
|
||||
<automated>go test ./cmd/netsynth/... -v -count=1 && go test ./config/... -count=1</automated>
|
||||
</verify>
|
||||
<acceptance_criteria>
|
||||
- cmd/netsynth/main.go contains `var printConfig bool`
|
||||
- cmd/netsynth/main.go contains `"print-config"` flag registration
|
||||
- cmd/netsynth/main.go contains `if printConfig {` BEFORE the interface-required check
|
||||
- cmd/netsynth/main.go contains `func runPrintConfig() error`
|
||||
- cmd/netsynth/main.go contains `append(result.UserRules, classify.DefaultRules...)`
|
||||
- cmd/netsynth/main.go contains `func runLiveMode(cmd *cobra.Command, result config.LoadResult)`
|
||||
- cmd/netsynth/main.go contains `func runPcapMode(cmd *cobra.Command, result config.LoadResult)`
|
||||
- cmd/netsynth/main_test.go contains `TestPrintConfigFlagRegistered`
|
||||
- cmd/netsynth/main_test.go contains `TestPrintConfigNoInterface`
|
||||
- cmd/netsynth/main_test.go contains `"print-config"` in newTestCmd()
|
||||
- cmd/netsynth/main_test.go contains `"config"` flag in newTestCmd()
|
||||
- `go test ./cmd/netsynth/... -count=1` exits 0
|
||||
- `go test ./config/... -count=1` exits 0
|
||||
</acceptance_criteria>
|
||||
<done>
|
||||
--print-config flag registered, checked before interface validation (no -i required). runPrintConfig calls config.Load then config.PrintConfig, prints to stdout, exits. User rules prepended in both runLiveMode and runPcapMode via append(result.UserRules, classify.DefaultRules...). All existing and new tests pass.
|
||||
</done>
|
||||
</task>
|
||||
|
||||
<task type="auto">
|
||||
<name>Task 2: Implement PrintConfig output function with comment annotations</name>
|
||||
<files>config/config.go, config/config_test.go</files>
|
||||
<read_first>config/config.go, config/config_test.go, synth/config.go, classify/types.go, classify/rules.go</read_first>
|
||||
<action>
|
||||
Add the PrintConfig function to config/config.go and tests to config/config_test.go.
|
||||
|
||||
**config/config.go additions:**
|
||||
|
||||
1. Add an `AutoClasses` field to LoadResult to track which classes were auto-assigned (per Open Question 1 from research):
|
||||
```go
|
||||
type LoadResult struct {
|
||||
FreqCfgs map[classify.TrafficClass]synth.FreqConfig
|
||||
UserRules []classify.Rule
|
||||
ConfigPath string
|
||||
AutoClasses map[classify.TrafficClass]bool // classes with auto-assigned frequencies
|
||||
}
|
||||
```
|
||||
Update addAutoFreqEntries to populate this map. Also update Load() to initialize the map.
|
||||
|
||||
2. Add the PrintConfig function. Use manual string building with fmt.Fprintf to a strings.Builder (per D-09, D-10, D-11). The function signature:
|
||||
```go
|
||||
func PrintConfig(result LoadResult) string
|
||||
```
|
||||
|
||||
3. Output format (per Pattern 5 from research):
|
||||
```
|
||||
# NetSynth effective configuration
|
||||
# Config source: <path or "none (using defaults)">
|
||||
# Generated: <date>
|
||||
|
||||
```
|
||||
|
||||
Then, if result.UserRules is non-empty, emit the [[rules]] section:
|
||||
```
|
||||
# Classification rules (user-defined, prepended before built-in rules)
|
||||
[[rules]]
|
||||
port = 8080
|
||||
protocol = "tcp"
|
||||
class = "MyApp"
|
||||
|
||||
```
|
||||
For each user rule, emit a `[[rules]]` block. If DstPort == 0, omit the `port` line (per D-02 semantics).
|
||||
|
||||
Then emit the [sounds] section. Iterate in a deterministic order: first AllClasses() (14 built-in classes in display order), then any user-defined classes sorted alphabetically. For each class:
|
||||
```
|
||||
# <ClassName> -- <BaseHz> Hz (<annotation>)
|
||||
[sounds.<ClassName>]
|
||||
frequency = <BaseHz>
|
||||
waveform = "<waveform_string>"
|
||||
|
||||
```
|
||||
Where annotation is:
|
||||
- `default` -- class is in synth.ClassFreqConfigs AND FreqCfgs entry matches the default BaseHz and WaveformType
|
||||
- `override` -- class is in synth.ClassFreqConfigs BUT FreqCfgs entry differs from default (user changed it)
|
||||
- `auto-assigned` -- class is in result.AutoClasses
|
||||
|
||||
4. Add waveformString helper to convert WaveformType back to string:
|
||||
```go
|
||||
func waveformString(wt synth.WaveformType) string {
|
||||
switch wt {
|
||||
case synth.WaveformSine:
|
||||
return "sine"
|
||||
case synth.WaveformSquare:
|
||||
return "square"
|
||||
case synth.WaveformSawtooth:
|
||||
return "sawtooth"
|
||||
case synth.WaveformTriangle:
|
||||
return "triangle"
|
||||
default:
|
||||
return "custom"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
5. For deterministic ordering of user-defined classes (not in AllClasses()), collect them, sort by string value, and append after built-in classes.
|
||||
|
||||
**config/config_test.go additions:**
|
||||
|
||||
6. TestPrintConfigContainsAllClasses: Create a LoadResult with defaults (no overrides, no user rules). Call PrintConfig. Assert output contains all 14 class names from classify.AllClasses(): "ICMP", "DNS", "HTTPS", "HTTP", "SSH", "SMTP", "NTP", "DHCP", "other-TCP", "other-UDP", "unknown-1", "unknown-2", "unknown-3", "unknown-4".
|
||||
|
||||
7. TestPrintConfigSourcePath: Create LoadResult with ConfigPath="/home/user/netsynth.toml". Assert output contains `# Config source: /home/user/netsynth.toml`.
|
||||
|
||||
8. TestPrintConfigNoSourcePath: Create LoadResult with ConfigPath="". Assert output contains `# Config source: none`.
|
||||
|
||||
9. TestPrintConfigContainsRules: Create LoadResult with UserRules containing one rule (Protocol="tcp", DstPort=8080, Class="MyApp"). Assert output contains `[[rules]]`, `port = 8080`, `protocol = "tcp"`, `class = "MyApp"`.
|
||||
|
||||
10. TestPrintConfigRuleNoPort: Create LoadResult with UserRules containing rule with DstPort=0. Assert output does NOT contain `port =` for that rule.
|
||||
|
||||
11. TestPrintConfigDefaultAnnotation: Create LoadResult with defaults. Assert output contains `(default)` annotation for ICMP entry.
|
||||
|
||||
12. TestPrintConfigOverrideAnnotation: Create LoadResult where ICMP has BaseHz=100.0 (differs from default 65.0). Assert output contains `(override)` for ICMP.
|
||||
|
||||
13. TestPrintConfigAutoAssignedAnnotation: Create LoadResult with AutoClasses map containing "GameServer"=true. Assert output contains `(auto-assigned)` for GameServer entry.
|
||||
</action>
|
||||
<verify>
|
||||
<automated>go test ./config/... -v -count=1 -run "PrintConfig" && go test ./... -count=1</automated>
|
||||
</verify>
|
||||
<acceptance_criteria>
|
||||
- config/config.go contains `func PrintConfig(result LoadResult) string`
|
||||
- config/config.go contains `func waveformString(wt synth.WaveformType) string`
|
||||
- config/config.go LoadResult struct contains `AutoClasses map[classify.TrafficClass]bool`
|
||||
- config/config.go PrintConfig output contains `# NetSynth effective configuration`
|
||||
- config/config.go PrintConfig output contains `# Config source:`
|
||||
- config/config_test.go contains `TestPrintConfigContainsAllClasses`
|
||||
- config/config_test.go contains `TestPrintConfigSourcePath`
|
||||
- config/config_test.go contains `TestPrintConfigContainsRules`
|
||||
- config/config_test.go contains `TestPrintConfigDefaultAnnotation`
|
||||
- config/config_test.go contains `TestPrintConfigOverrideAnnotation`
|
||||
- config/config_test.go contains `TestPrintConfigAutoAssignedAnnotation`
|
||||
- `go test ./... -count=1` exits 0 (full suite green)
|
||||
</acceptance_criteria>
|
||||
<done>
|
||||
PrintConfig produces commented TOML output with: header (source path, date), [[rules]] section for user rules (port omitted when 0), [sounds.*] section for all classes in deterministic order. Each sound entry annotated as (default), (override), or (auto-assigned). Full test suite green including all existing tests.
|
||||
</done>
|
||||
</task>
|
||||
|
||||
</tasks>
|
||||
|
||||
<verification>
|
||||
- `go test ./... -count=1` -- full suite green
|
||||
- `go vet ./...` -- no issues
|
||||
- `netsynth --print-config` outputs commented TOML to stdout (manual check)
|
||||
- `netsynth --print-config --config <file>` shows overrides annotated as such
|
||||
</verification>
|
||||
|
||||
<success_criteria>
|
||||
- --print-config flag works without -i, outputs to stdout, exits without capture
|
||||
- User rules prepended before DefaultRules in both live and pcap modes
|
||||
- PrintConfig output contains all 14 built-in classes plus any user-defined classes
|
||||
- Comment annotations correctly distinguish default / override / auto-assigned
|
||||
- Source path shown in header when config loaded
|
||||
- [[rules]] section present in output when user rules exist
|
||||
- Full go test suite passes
|
||||
</success_criteria>
|
||||
|
||||
<output>
|
||||
After completion, create `.planning/phases/07-custom-rules-and-print-config/07-02-SUMMARY.md`
|
||||
</output>
|
||||
@@ -0,0 +1,95 @@
|
||||
---
|
||||
phase: 07-custom-rules-and-print-config
|
||||
plan: "02"
|
||||
subsystem: config, cmd/netsynth
|
||||
tags: [config, cli, print-config, rules, wiring, CFG-06, RULE-02]
|
||||
dependency_graph:
|
||||
requires: [LoadResult, UserRules, AutoClasses, PrintConfig]
|
||||
provides: [--print-config flag, runPrintConfig, user-rule-prepend, PrintConfig-output]
|
||||
affects: [cmd/netsynth/main.go, config/config.go]
|
||||
tech_stack:
|
||||
added: ["sort", "time", "strings.Builder"]
|
||||
patterns: [LoadResult-propagation, user-rule-prepend, annotated-TOML-output]
|
||||
key_files:
|
||||
created: []
|
||||
modified:
|
||||
- cmd/netsynth/main.go
|
||||
- cmd/netsynth/main_test.go
|
||||
- config/config.go
|
||||
- config/config_test.go
|
||||
decisions:
|
||||
- "--print-config check placed after --list-interfaces but before interface-required validation so it works without -i"
|
||||
- "AutoClasses map added to LoadResult to track which classes were auto-assigned by FNV-32a"
|
||||
- "PrintConfig returns a string (not writes to io.Writer) for testability; caller prints to stdout"
|
||||
- "waveformString returns custom for WaveformCustom (zero value used by hand-tuned built-in classes)"
|
||||
- "classAnnotation: built-in classes compared on both BaseHz and WaveformType for override detection"
|
||||
metrics:
|
||||
duration: 8min
|
||||
completed: "2026-03-26T20:55:00Z"
|
||||
tasks_completed: 2
|
||||
files_modified: 4
|
||||
---
|
||||
|
||||
# Phase 7 Plan 02: CLI Wiring and PrintConfig Output Summary
|
||||
|
||||
Wire the LoadResult into main.go (user rules prepend, --print-config flag), implement the PrintConfig output function in the config package, and add comprehensive tests for both. Completes RULE-02 and CFG-06 — the final plan for Phase 7 and the v1.1 milestone.
|
||||
|
||||
## What Was Built
|
||||
|
||||
**cmd/netsynth/main.go:**
|
||||
- Added `printConfig bool` var and `--print-config` flag registration
|
||||
- `runPrintConfig()`: calls `config.Load(configPath)` then `config.PrintConfig(result)`, prints to stdout, exits clean
|
||||
- --print-config check fires before interface-required validation (no -i needed)
|
||||
- `runLiveMode` and `runPcapMode` now accept `config.LoadResult` instead of bare `map[TrafficClass]FreqConfig`
|
||||
- User rules prepend in both modes: `append(result.UserRules, classify.DefaultRules...)` (RULE-02)
|
||||
- Removed unused `synth` import
|
||||
|
||||
**config/config.go:**
|
||||
- `LoadResult` gains `AutoClasses map[classify.TrafficClass]bool` field
|
||||
- `addAutoFreqEntries` updated to accept and populate `autoClasses` map
|
||||
- `Load()` initializes `AutoClasses` map and returns it in `LoadResult`
|
||||
- `PrintConfig(result LoadResult) string`: generates commented TOML output with:
|
||||
- Header: `# NetSynth effective configuration`, `# Config source: <path or "none (using defaults)">`, `# Generated: <UTC timestamp>`
|
||||
- `[[rules]]` section for each user rule (port omitted when DstPort==0)
|
||||
- `[sounds.*]` section for all classes in deterministic order (14 built-ins in AllClasses() order, then user-defined sorted alphabetically)
|
||||
- Per-class annotation: `(default)`, `(override)`, or `(auto-assigned)`
|
||||
- `waveformString()`: converts WaveformType to TOML string
|
||||
- `classAnnotation()`: determines annotation based on AutoClasses membership and comparison with defaults
|
||||
|
||||
## Tasks Completed
|
||||
|
||||
| Task | Name | Commit | Files |
|
||||
|------|------|--------|-------|
|
||||
| 1 | Wire LoadResult into main.go and add --print-config flag | d43914f | cmd/netsynth/main.go, cmd/netsynth/main_test.go |
|
||||
| 2 | Implement PrintConfig output function with comment annotations | b52e36b | config/config.go, config/config_test.go |
|
||||
|
||||
## Deviations from Plan
|
||||
|
||||
None - plan executed exactly as written.
|
||||
|
||||
## Test Coverage
|
||||
|
||||
New tests added (8 PrintConfig tests in config_test.go, 3 print-config tests in main_test.go):
|
||||
|
||||
**config/config_test.go:**
|
||||
- `TestPrintConfigContainsAllClasses` - all 14 class names in output
|
||||
- `TestPrintConfigSourcePath` - `# Config source: <path>` in header
|
||||
- `TestPrintConfigNoSourcePath` - `# Config source: none` when no config
|
||||
- `TestPrintConfigContainsRules` - `[[rules]]` section with port/protocol/class
|
||||
- `TestPrintConfigRuleNoPort` - port line omitted when DstPort==0
|
||||
- `TestPrintConfigDefaultAnnotation` - `(default)` for unmodified built-in class
|
||||
- `TestPrintConfigOverrideAnnotation` - `(override)` for modified built-in class
|
||||
- `TestPrintConfigAutoAssignedAnnotation` - `(auto-assigned)` for FNV-hash assigned class
|
||||
|
||||
**cmd/netsynth/main_test.go:**
|
||||
- `TestPrintConfigFlagRegistered` - flag exists on command
|
||||
- `TestPrintConfigNoInterface` - --print-config works without -i
|
||||
- `TestPrintConfigWithConfigFile` - --print-config with --config succeeds
|
||||
|
||||
Full suite: `go test ./... -count=1` all 7 packages pass.
|
||||
|
||||
## Known Stubs
|
||||
|
||||
None. All functionality is fully implemented and wired.
|
||||
|
||||
## Self-Check: PASSED
|
||||
@@ -0,0 +1,123 @@
|
||||
# Phase 7: Custom Rules and Print-Config - Context
|
||||
|
||||
**Gathered:** 2026-03-26
|
||||
**Status:** Ready for planning
|
||||
|
||||
<domain>
|
||||
## Phase Boundary
|
||||
|
||||
Add user-defined traffic classification rules in TOML (`[[rules]]` array-of-tables) that prepend before built-in rules, with automatic synthesis layer creation for new class names. Add `--print-config` flag that outputs the full effective config as commented TOML to stdout without starting a capture.
|
||||
|
||||
Requirements covered: RULE-01, RULE-02, RULE-03, CFG-06.
|
||||
|
||||
</domain>
|
||||
|
||||
<decisions>
|
||||
## Implementation Decisions
|
||||
|
||||
### Custom Rule TOML Schema
|
||||
- **D-01:** Custom rules use TOML array-of-tables `[[rules]]` with three fields: `port` (uint16, optional — omit to match any port), `protocol` (string, required — "tcp", "udp", or "icmp"), and `class` (string, required — the TrafficClass name). Sound configuration for the class goes in a separate `[sounds.<class>]` block.
|
||||
- **D-02:** Port is optional. When omitted (or 0), the rule matches all traffic for the given protocol, mirroring the existing `Rule.DstPort = 0` semantics in `classify.DefaultRules`.
|
||||
- **D-03:** Protocol is required. No implicit "match both TCP and UDP" behavior. User must write separate rules for each protocol.
|
||||
|
||||
### Rule Ordering and Priority
|
||||
- **D-04:** User-defined rules are prepended before built-in `DefaultRules` (RULE-02). First-match-wins semantics are preserved. A user rule for port 443/tcp fires before the built-in HTTPS rule.
|
||||
- **D-05:** Rules within the TOML `[[rules]]` array maintain their file order. First rule in the file is first to match.
|
||||
|
||||
### Class Name Collision Policy
|
||||
- **D-06:** User-defined class names that match built-in names (e.g., `class = "HTTPS"`) are treated as overrides, not errors. The user's rule fires first (prepended), so traffic matching it gets classified under the same built-in class name via the user rule. Sound config in `[sounds.HTTPS]` still applies. This resolves the design question flagged in STATE.md.
|
||||
|
||||
### Sound Assignment for Custom Classes
|
||||
- **D-07:** New class names that have no `[sounds.<class>]` entry automatically get sensible defaults: a frequency from an unused range and sine waveform. This satisfies RULE-03 (no silent gaps for user-defined classes).
|
||||
- **D-08:** (Claude's Discretion) The auto-assignment algorithm — how to pick frequencies for new classes that don't collide with built-in frequencies. Could use a hash of the class name, a sequential pool, or a deterministic spread across an unused frequency band.
|
||||
|
||||
### Print-Config
|
||||
- **D-09:** `--print-config` outputs the full effective config (defaults merged with user overrides and custom rules) as commented TOML. Comments indicate which values are defaults vs overrides. This satisfies CFG-06.
|
||||
- **D-10:** Output goes to stdout (pipeable). User can do `netsynth --print-config > template.toml` to create a config template. The command exits without starting a capture.
|
||||
- **D-11:** If a config file is loaded (via auto-discovery or `--config`), show its source path in a header comment.
|
||||
|
||||
### Config Package Extension
|
||||
- **D-12:** The existing `config.Load()` function must be extended to parse `[[rules]]` blocks in addition to `[sounds.*]`. The `rawConfig` struct gains a `Rules []RawRule` field.
|
||||
- **D-13:** `config.Load()` returns both the merged `FreqConfig` map and the user rules (as `[]classify.Rule`). The caller prepends user rules before `classify.DefaultRules`.
|
||||
|
||||
### Claude's Discretion
|
||||
- How to extend `rawConfig` struct and `Load()` return type (tuple, struct, or new function)
|
||||
- Auto-frequency assignment algorithm for custom classes without explicit sound config
|
||||
- Whether `--print-config` is a Cobra subcommand or a flag on the root command
|
||||
- How to format the commented TOML output (manual string building vs TOML encoder + post-processing)
|
||||
|
||||
</decisions>
|
||||
|
||||
<canonical_refs>
|
||||
## Canonical References
|
||||
|
||||
**Downstream agents MUST read these before planning or implementing.**
|
||||
|
||||
### Classification System
|
||||
- `classify/rules.go` — `Rule` struct (Protocol, DstPort, Class), `DefaultRules` ordered slice, first-match-wins
|
||||
- `classify/types.go` — `TrafficClass` string type, `AllClasses()`, `ClassifiedPacket`, `WindowSnapshot`
|
||||
- `classify/classifier.go` — `NewClassifier(rules []Rule)` — accepts injected rule slice
|
||||
|
||||
### Config System (Phase 6 output)
|
||||
- `config/config.go` — `Load()`, `rawConfig`, `SoundOverride`, `merge()`, `validate()`, `parseWaveform()`
|
||||
- `config/config_test.go` — Existing test patterns for TOML loading
|
||||
|
||||
### Synthesis Pipeline
|
||||
- `synth/config.go` — `FreqConfig`, `ClassFreqConfigs`, `WaveformType`, `WaveformPresetHarmonics()`
|
||||
- `synth/bank.go` — `NewBank(tau, cfgs map[TrafficClass]FreqConfig)` — injection point for merged config
|
||||
- `encode/mp3.go` — `RunSynthesis(snapshots, outputPath, freqCfgs)` — pipeline entry
|
||||
|
||||
### CLI
|
||||
- `cmd/netsynth/main.go` — Cobra command, `--config` flag, `run()` dispatches to live/pcap modes
|
||||
|
||||
### Prior Context
|
||||
- `.planning/phases/06-config-package-and-sound-overrides/06-CONTEXT.md` — Phase 6 decisions (TOML schema, merge semantics, validation)
|
||||
|
||||
No external specs — requirements fully captured in decisions above.
|
||||
|
||||
</canonical_refs>
|
||||
|
||||
<code_context>
|
||||
## Existing Code Insights
|
||||
|
||||
### Reusable Assets
|
||||
- `classify.Rule` struct — Already has Protocol, DstPort, Class fields matching the TOML schema
|
||||
- `classify.NewClassifier(rules []Rule)` — Accepts any rule slice, so prepending user rules is straightforward
|
||||
- `config.Load()` — Existing TOML loading with BurntSushi/toml, validation, and merge pipeline
|
||||
- `config.rawConfig` — Top-level decode struct, needs `Rules` field added
|
||||
- `config.parseWaveform()` — Reusable for validating waveform strings in sound overrides
|
||||
- `synth.NewBank(tau, cfgs)` — Already accepts arbitrary config maps (Phase 5 injection seam)
|
||||
|
||||
### Established Patterns
|
||||
- First-match-wins rule ordering in `classify.DefaultRules`
|
||||
- TOML strict decoding with `Undecoded()` for unknown key detection
|
||||
- Pointer fields (`*float64`, `*string`) for partial override semantics
|
||||
- Config loaded once at startup before capture (fail-fast)
|
||||
|
||||
### Integration Points
|
||||
- `config.Load()` return value must expand to include user rules
|
||||
- `cmd/netsynth/main.go:run()` — Prepend user rules before passing to `classify.NewClassifier()`
|
||||
- `config.merge()` — Must handle new class names by creating `FreqConfig` entries with auto-assigned frequencies
|
||||
- `--print-config` — New flag or subcommand in Cobra root command
|
||||
|
||||
</code_context>
|
||||
|
||||
<specifics>
|
||||
## Specific Ideas
|
||||
|
||||
- Print-config should show commented TOML with `# default` / `# override` annotations and source path header
|
||||
- Output to stdout so users can pipe to a file as a template
|
||||
|
||||
</specifics>
|
||||
|
||||
<deferred>
|
||||
## Deferred Ideas
|
||||
|
||||
None — discussion stayed within phase scope.
|
||||
|
||||
</deferred>
|
||||
|
||||
---
|
||||
|
||||
*Phase: 07-custom-rules-and-print-config*
|
||||
*Context gathered: 2026-03-26*
|
||||
+73
@@ -0,0 +1,73 @@
|
||||
# Phase 7: Custom Rules and Print-Config - Discussion Log
|
||||
|
||||
> **Audit trail only.** Do not use as input to planning, research, or execution agents.
|
||||
> Decisions are captured in CONTEXT.md — this log preserves the alternatives considered.
|
||||
|
||||
**Date:** 2026-03-26
|
||||
**Phase:** 07-custom-rules-and-print-config
|
||||
**Areas discussed:** Custom rule TOML schema, Class name collision policy, Print-config output format, Sound assignment for custom classes
|
||||
|
||||
---
|
||||
|
||||
## Custom Rule TOML Schema
|
||||
|
||||
| Option | Description | Selected |
|
||||
|--------|-------------|----------|
|
||||
| Minimal: port + protocol + class | Matches existing Rule struct. Sound config in separate [sounds.X]. | ✓ |
|
||||
| Inline sound: port + protocol + class + frequency/waveform | All-in-one rule block, mixes classification and sound concerns. | |
|
||||
| Rich matching: port ranges, src/dst, regex | More expressive but significantly more complex. | |
|
||||
|
||||
**User's choice:** Minimal — port + protocol + class
|
||||
**Notes:** Protocol is required. Port is optional (omit to match any port for the protocol).
|
||||
|
||||
---
|
||||
|
||||
## Class Name Collision Policy
|
||||
|
||||
| Option | Description | Selected |
|
||||
|--------|-------------|----------|
|
||||
| Treat as override | User's rule fires first (prepended), same class name. Simplest model. | ✓ |
|
||||
| Reject with error | Startup error if user rule uses built-in class name. | |
|
||||
| Namespace: prefix user classes | User classes get "user-" prefix. Adds naming complexity. | |
|
||||
|
||||
**User's choice:** Treat as override
|
||||
**Notes:** Resolves the design question flagged in STATE.md since Phase 5 research.
|
||||
|
||||
---
|
||||
|
||||
## Print-Config Output Format
|
||||
|
||||
| Option | Description | Selected |
|
||||
|--------|-------------|----------|
|
||||
| Commented TOML | Valid TOML with comments showing default vs override. Pipeable to file. | ✓ |
|
||||
| Plain TOML | Clean but doesn't show what's default vs overridden. | |
|
||||
| Human-readable table | Formatted table, not valid TOML. | |
|
||||
|
||||
**User's choice:** Commented TOML to stdout
|
||||
**Notes:** Output to stdout so `netsynth --print-config > template.toml` works. Shows source path in header comment.
|
||||
|
||||
---
|
||||
|
||||
## Sound Assignment for Custom Classes
|
||||
|
||||
| Option | Description | Selected |
|
||||
|--------|-------------|----------|
|
||||
| Auto-assign sensible defaults | Pick unused frequency + sine waveform. No silence. | ✓ |
|
||||
| Require explicit [sounds.X] | Error if no matching sound config. More friction. | |
|
||||
| Single fallback tone | All custom classes share one tone. Defeats distinct sounds purpose. | |
|
||||
|
||||
**User's choice:** Auto-assign sensible defaults
|
||||
**Notes:** Satisfies RULE-03 (no silent gaps). Algorithm left to Claude's discretion.
|
||||
|
||||
---
|
||||
|
||||
## Claude's Discretion
|
||||
|
||||
- Auto-frequency assignment algorithm
|
||||
- --print-config as flag vs subcommand
|
||||
- Commented TOML formatting approach
|
||||
- config.Load() return type extension
|
||||
|
||||
## Deferred Ideas
|
||||
|
||||
None — discussion stayed within phase scope.
|
||||
@@ -0,0 +1,515 @@
|
||||
# Phase 7: Custom Rules and Print-Config - Research
|
||||
|
||||
**Researched:** 2026-03-26
|
||||
**Domain:** Go config parsing (BurntSushi/toml), rule system extension, TOML serialization
|
||||
**Confidence:** HIGH
|
||||
|
||||
## Summary
|
||||
|
||||
Phase 7 adds two related features: user-defined TOML classification rules that prepend before built-in `DefaultRules`, and a `--print-config` flag that serializes the full effective config to stdout as commented TOML without starting a capture. Both features are pure Go additions with no new dependencies — the entire implementation works within the existing stack.
|
||||
|
||||
The rule parsing extension is straightforward: add a `Rules []RawRule` field to `rawConfig`, validate required fields (`protocol`, `class`), and prepend the parsed `[]classify.Rule` slice before `classify.DefaultRules` in `main.go`. BurntSushi/toml's `Undecoded()` mechanism already catches typos in `[[rules]]` blocks (verified experimentally — unknown fields in array-of-table entries appear in `Undecoded()` as `rules.field_name`). Auto-frequency assignment for new class names uses FNV-32a hash of the class name mapped to a 1200–2400 Hz range (above all 14 built-in frequencies which top out at 1047 Hz), producing deterministic and collision-resistant results.
|
||||
|
||||
The `--print-config` implementation has two design paths: Cobra flag on the root command (simpler, consistent with the existing flag-on-root pattern) or a Cobra subcommand. The flag path is recommended as it mirrors how `--list-interfaces` works. The output format uses manual string building (not the TOML encoder) to support `# default` / `# override` annotations that the encoder cannot produce.
|
||||
|
||||
**Primary recommendation:** Extend `config.Load()` to return a `LoadResult` struct (freqCfgs + user rules), prepend user rules in `main.go`, use FNV-32a for auto-frequency assignment, and implement `--print-config` as a flag that triggers early-exit in the `run()` function.
|
||||
|
||||
<user_constraints>
|
||||
## User Constraints (from CONTEXT.md)
|
||||
|
||||
### Locked Decisions
|
||||
|
||||
- **D-01:** Custom rules use TOML array-of-tables `[[rules]]` with three fields: `port` (uint16, optional — omit to match any port), `protocol` (string, required — "tcp", "udp", or "icmp"), and `class` (string, required — the TrafficClass name). Sound configuration for the class goes in a separate `[sounds.<class>]` block.
|
||||
- **D-02:** Port is optional. When omitted (or 0), the rule matches all traffic for the given protocol, mirroring the existing `Rule.DstPort = 0` semantics in `classify.DefaultRules`.
|
||||
- **D-03:** Protocol is required. No implicit "match both TCP and UDP" behavior. User must write separate rules for each protocol.
|
||||
- **D-04:** User-defined rules are prepended before built-in `DefaultRules` (RULE-02). First-match-wins semantics are preserved. A user rule for port 443/tcp fires before the built-in HTTPS rule.
|
||||
- **D-05:** Rules within the TOML `[[rules]]` array maintain their file order. First rule in the file is first to match.
|
||||
- **D-06:** User-defined class names that match built-in names (e.g., `class = "HTTPS"`) are treated as overrides, not errors. The user's rule fires first (prepended), so traffic matching it gets classified under the same built-in class name via the user rule. Sound config in `[sounds.HTTPS]` still applies.
|
||||
- **D-07:** New class names that have no `[sounds.<class>]` entry automatically get sensible defaults: a frequency from an unused range and sine waveform. This satisfies RULE-03 (no silent gaps for user-defined classes).
|
||||
- **D-08:** (Claude's Discretion) The auto-assignment algorithm — how to pick frequencies for new classes that don't collide with built-in frequencies. Could use a hash of the class name, a sequential pool, or a deterministic spread across an unused frequency band.
|
||||
- **D-09:** `--print-config` outputs the full effective config (defaults merged with user overrides and custom rules) as commented TOML. Comments indicate which values are defaults vs overrides. This satisfies CFG-06.
|
||||
- **D-10:** Output goes to stdout (pipeable). User can do `netsynth --print-config > template.toml` to create a config template. The command exits without starting a capture.
|
||||
- **D-11:** If a config file is loaded (via auto-discovery or `--config`), show its source path in a header comment.
|
||||
- **D-12:** The existing `config.Load()` function must be extended to parse `[[rules]]` blocks in addition to `[sounds.*]`. The `rawConfig` struct gains a `Rules []RawRule` field.
|
||||
- **D-13:** `config.Load()` returns both the merged `FreqConfig` map and the user rules (as `[]classify.Rule`). The caller prepends user rules before `classify.DefaultRules`.
|
||||
|
||||
### Claude's Discretion
|
||||
|
||||
- How to extend `rawConfig` struct and `Load()` return type (tuple, struct, or new function)
|
||||
- Auto-frequency assignment algorithm for custom classes without explicit sound config
|
||||
- Whether `--print-config` is a Cobra subcommand or a flag on the root command
|
||||
- How to format the commented TOML output (manual string building vs TOML encoder + post-processing)
|
||||
|
||||
### Deferred Ideas (OUT OF SCOPE)
|
||||
|
||||
None — discussion stayed within phase scope.
|
||||
</user_constraints>
|
||||
|
||||
<phase_requirements>
|
||||
## Phase Requirements
|
||||
|
||||
| ID | Description | Research Support |
|
||||
|----|-------------|------------------|
|
||||
| RULE-01 | User can define custom classification rules in TOML (match by port and/or protocol, assign class name and sound) | D-01 through D-05; `[[rules]]` TOML parsing with BurntSushi/toml confirmed working |
|
||||
| RULE-02 | User-defined rules take priority over built-in rules (prepend before defaults) | D-04; `classify.NewClassifier(rules []Rule)` already accepts any rule slice; prepend in `main.go` |
|
||||
| RULE-03 | User-defined class names automatically get a synthesis layer (no silent gaps) | D-07/D-08; FNV-32a auto-frequency in 1200–2400 Hz range; `synth.NewBank` already accepts arbitrary class maps |
|
||||
| CFG-06 | User can run `netsynth --print-config` to see the effective config as commented TOML | D-09 through D-11; flag on root command triggering early-exit; manual string building for comment annotations |
|
||||
</phase_requirements>
|
||||
|
||||
## Standard Stack
|
||||
|
||||
No new dependencies required. All features use existing libraries.
|
||||
|
||||
### Core (existing, no changes needed)
|
||||
| Library | Version | Purpose | Notes |
|
||||
|---------|---------|---------|-------|
|
||||
| `github.com/BurntSushi/toml` | v1.6.0 | TOML decode + `Undecoded()` typo detection | Handles `[[rules]]` array-of-tables natively; `Undecoded()` catches typos in rule blocks |
|
||||
| `github.com/spf13/cobra` | v1.10.2 | `--print-config` flag addition | PersistentPreRunE / early-exit pattern already used; add flag to root command |
|
||||
| `hash/fnv` | stdlib | FNV-32a hash for auto-frequency assignment | No import needed — already in Go stdlib |
|
||||
| `fmt` | stdlib | Manual TOML comment string building for print-config | Simplest approach for annotated output |
|
||||
|
||||
**Installation:** No new packages. `go build` with existing `go.mod` is sufficient.
|
||||
|
||||
## Architecture Patterns
|
||||
|
||||
### Recommended Project Structure (additions only)
|
||||
|
||||
```
|
||||
config/
|
||||
├── config.go — extend rawConfig + Load() return type
|
||||
└── config_test.go — add tests for [[rules]] parsing, validate, auto-freq
|
||||
|
||||
cmd/netsynth/
|
||||
└── main.go — --print-config flag, prepend user rules, printConfig()
|
||||
```
|
||||
|
||||
### Pattern 1: rawConfig + Load() Return Type Extension
|
||||
|
||||
**What:** Add `Rules []RawRule` to `rawConfig`. Change `Load()` to return a `LoadResult` struct instead of a bare map.
|
||||
|
||||
**When to use:** Prefer a struct return over a tuple `(map, []Rule, error)` — Go tuples with 3+ values become unwieldy at the call site.
|
||||
|
||||
**Recommended struct:**
|
||||
```go
|
||||
// Source: internal design — no external library required
|
||||
type LoadResult struct {
|
||||
FreqCfgs map[classify.TrafficClass]synth.FreqConfig
|
||||
UserRules []classify.Rule
|
||||
ConfigPath string // "" if no config loaded (for --print-config header comment)
|
||||
}
|
||||
|
||||
type RawRule struct {
|
||||
Port *uint16 `toml:"port"`
|
||||
Protocol string `toml:"protocol"`
|
||||
Class string `toml:"class"`
|
||||
}
|
||||
|
||||
type rawConfig struct {
|
||||
Sounds map[string]SoundOverride `toml:"sounds"`
|
||||
Rules []RawRule `toml:"rules"`
|
||||
}
|
||||
```
|
||||
|
||||
**Call site in main.go:**
|
||||
```go
|
||||
result, err := config.Load(configPath)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
allRules := append(result.UserRules, classify.DefaultRules...)
|
||||
classifier := classify.NewClassifier(allRules)
|
||||
```
|
||||
|
||||
### Pattern 2: RawRule Validation
|
||||
|
||||
**What:** Validate each `RawRule` before converting to `classify.Rule`. Required fields: `protocol` (non-empty, must be "tcp"/"udp"/"icmp"). `class` must be non-empty. `port` is optional.
|
||||
|
||||
**Port omission semantics:** In TOML, a missing `port` key means the struct field stays at its zero value. Using `*uint16` (pointer) lets us distinguish "omitted" from "port = 0". In practice, both map to `DstPort: 0` (match-any-port), so a `uint16` field (non-pointer) also works here — the distinction is only meaningful for validation messages. Use `*uint16` to match D-02 intent and for consistency with `SoundOverride` pointer fields.
|
||||
|
||||
**Validation function:**
|
||||
```go
|
||||
func validateRules(rules []RawRule) error {
|
||||
validProtocols := map[string]bool{"tcp": true, "udp": true, "icmp": true}
|
||||
for i, r := range rules {
|
||||
if r.Protocol == "" {
|
||||
return fmt.Errorf("config: rules[%d]: protocol is required", i)
|
||||
}
|
||||
if !validProtocols[r.Protocol] {
|
||||
return fmt.Errorf("config: rules[%d]: invalid protocol %q — valid: tcp, udp, icmp", i, r.Protocol)
|
||||
}
|
||||
if r.Class == "" {
|
||||
return fmt.Errorf("config: rules[%d]: class is required", i)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
```
|
||||
|
||||
**Conversion to classify.Rule:**
|
||||
```go
|
||||
func convertRules(raw []RawRule) []classify.Rule {
|
||||
result := make([]classify.Rule, len(raw))
|
||||
for i, r := range raw {
|
||||
var port uint16
|
||||
if r.Port != nil {
|
||||
port = *r.Port
|
||||
}
|
||||
result[i] = classify.Rule{
|
||||
Protocol: r.Protocol,
|
||||
DstPort: port,
|
||||
Class: classify.TrafficClass(r.Class),
|
||||
}
|
||||
}
|
||||
return result
|
||||
}
|
||||
```
|
||||
|
||||
### Pattern 3: Auto-Frequency Assignment via FNV-32a
|
||||
|
||||
**What:** For custom class names with no `[sounds.<class>]` block, assign a frequency deterministically from the class name using FNV-32a hash. Map to 1200–2400 Hz in 50 Hz steps.
|
||||
|
||||
**Why FNV-32a:** Fast, deterministic, already in stdlib, zero collisions observed across realistic class names. The 1200–2400 Hz range is entirely above the highest built-in frequency (1047 Hz for ClassUnknown4), so no overlap is possible.
|
||||
|
||||
**Verified with test:** The 24-step spread (1200, 1250, ..., 2350 Hz) gives clean frequency assignments: "MyApp"→1500 Hz, "GameServer"→1800 Hz, "MediaStream"→2150 Hz, "VoIP"→1750 Hz, "Database"→2000 Hz.
|
||||
|
||||
```go
|
||||
// Source: stdlib hash/fnv — no import required beyond "hash/fnv"
|
||||
import "hash/fnv"
|
||||
|
||||
func autoAssignFreq(className string) float64 {
|
||||
h := fnv.New32a()
|
||||
h.Write([]byte(className))
|
||||
const (
|
||||
baseHz = 1200.0
|
||||
stepHz = 50.0
|
||||
numSteps = 24 // range: 1200–2350 Hz
|
||||
)
|
||||
step := h.Sum32() % numSteps
|
||||
return baseHz + float64(step)*stepHz
|
||||
}
|
||||
```
|
||||
|
||||
**Integration point in `merge()`:** After processing all `Sounds` overrides, iterate user rules. For each rule whose `Class` is not in the defaults map and has no `[sounds.<class>]` entry, call `autoAssignFreq` and create a `FreqConfig` with `WaveformSine`.
|
||||
|
||||
```go
|
||||
// In config.merge() or a new mergeCustomClasses() helper:
|
||||
func addAutoFreqEntries(
|
||||
cfgs map[classify.TrafficClass]synth.FreqConfig,
|
||||
userRules []classify.Rule,
|
||||
) {
|
||||
for _, rule := range userRules {
|
||||
class := rule.Class
|
||||
if _, exists := cfgs[class]; !exists {
|
||||
baseHz := autoAssignFreq(string(class))
|
||||
cfgs[class] = synth.FreqConfig{
|
||||
BaseHz: baseHz,
|
||||
WaveformType: synth.WaveformSine,
|
||||
Harmonics: synth.WaveformPresetHarmonics(synth.WaveformSine, baseHz, synth.SampleRate),
|
||||
Pan: 0.0,
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Pattern 4: --print-config as Flag on Root Command
|
||||
|
||||
**What:** Add `--print-config` bool flag. In `run()`, check the flag early and call a `printConfig()` function that writes to stdout, then return nil without starting a capture.
|
||||
|
||||
**Why flag over subcommand:** Consistent with `--list-interfaces` (existing pattern). Both are "inspect mode" flags that short-circuit the main capture path. Subcommand would require the user to write `netsynth print-config` rather than `netsynth --print-config`, deviating from the established CLI style.
|
||||
|
||||
```go
|
||||
// In main():
|
||||
var printConfigFlag bool
|
||||
rootCmd.Flags().BoolVar(&printConfigFlag, "print-config", false, "Print effective config as commented TOML and exit")
|
||||
|
||||
// In run():
|
||||
if printConfigFlag {
|
||||
return runPrintConfig(configPath)
|
||||
}
|
||||
```
|
||||
|
||||
**runPrintConfig() structure:**
|
||||
```go
|
||||
func runPrintConfig(configPath string) error {
|
||||
result, err := config.Load(configPath)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
output, err := config.PrintConfig(result)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
fmt.Print(output)
|
||||
return nil
|
||||
}
|
||||
```
|
||||
|
||||
### Pattern 5: PrintConfig Output Format
|
||||
|
||||
**What:** Manual string building using `fmt.Fprintf` to a `strings.Builder`. The BurntSushi/toml encoder cannot add comments, so manual building is the correct approach.
|
||||
|
||||
**Output structure:**
|
||||
```toml
|
||||
# NetSynth effective configuration
|
||||
# Config source: /home/user/.config/netsynth/config.toml
|
||||
# Generated: 2026-03-26
|
||||
|
||||
# Custom classification rules (prepended before built-in rules)
|
||||
# [[rules]]
|
||||
# port = 8080
|
||||
# protocol = "tcp"
|
||||
# class = "MyApp"
|
||||
|
||||
[sounds]
|
||||
|
||||
# ICMP — 65.0 Hz (default)
|
||||
[sounds.ICMP]
|
||||
frequency = 65.0
|
||||
waveform = "custom"
|
||||
|
||||
# HTTPS — 300.0 Hz (override)
|
||||
[sounds.HTTPS]
|
||||
frequency = 300.0
|
||||
waveform = "sine"
|
||||
```
|
||||
|
||||
**Comment semantics:**
|
||||
- `# (default)` — value came from `synth.ClassFreqConfigs`
|
||||
- `# (override)` — value was set in the user's config file
|
||||
- `# (auto-assigned)` — frequency was auto-generated for a user-defined class
|
||||
|
||||
**Key implementation note:** Custom class entries added by `addAutoFreqEntries()` need their origin tracked. The `LoadResult` or a separate annotation map needs to carry which classes are auto-assigned vs user-overridden vs defaults. Simplest approach: `PrintConfig()` receives the `LoadResult` and compares against `synth.ClassFreqConfigs` to determine annotation.
|
||||
|
||||
### Pattern 6: Undecoded() and [[rules]] Interaction
|
||||
|
||||
**Verified behavior (experimental):** BurntSushi/toml's `Undecoded()` correctly catches unknown fields in `[[rules]]` blocks. A typo like `typo_field = "bad"` in a `[[rules]]` entry appears in `Undecoded()` as `rules.typo_field`. The existing `parseFile()` logic handles this automatically — no changes to the undecoded key check are needed.
|
||||
|
||||
**Important:** Class-name typos in `[sounds.<class>]` are STILL not caught (pre-existing limitation documented in the existing code comment). This is unchanged behavior for Phase 7.
|
||||
|
||||
### Anti-Patterns to Avoid
|
||||
|
||||
- **Returning a tuple `(map, []Rule, error)` from Load():** Three-value tuples at call sites are verbose and error-prone. Use a `LoadResult` struct.
|
||||
- **Using the TOML encoder for print-config output:** The encoder cannot add `# (default)` comments. Manual `fmt.Fprintf` to `strings.Builder` is the correct approach.
|
||||
- **Modifying `classify.DefaultRules` in place:** Always prepend user rules as a new slice. `DefaultRules` is a package-level var that must not be mutated. Use `append(userRules, classify.DefaultRules...)` to create a fresh slice.
|
||||
- **Silent auto-frequency collision:** If two user-defined classes hash to the same frequency step, they will produce the same tone. This is acceptable for v1.1 (the probability is low with 24 steps) but document it in comments.
|
||||
- **Placing `--print-config` check after config validation:** The check should occur early in `run()` — right after config load, before any interface or output validation. The user should be able to run `netsynth --print-config` without specifying `-i`.
|
||||
|
||||
## Don't Hand-Roll
|
||||
|
||||
| Problem | Don't Build | Use Instead | Why |
|
||||
|---------|-------------|-------------|-----|
|
||||
| TOML parsing with typo detection | Custom parser | BurntSushi/toml `Undecoded()` | Already used; handles `[[rules]]` natively |
|
||||
| Frequency hash | Custom hash function | stdlib `hash/fnv` FNV-32a | Zero-dependency, deterministic, already stdlib |
|
||||
| CLI flag parsing | Manual arg parsing | Cobra flag registration | Consistent with all existing flags |
|
||||
|
||||
**Key insight:** Every mechanism needed for Phase 7 already exists in the codebase. The risk is over-engineering: the entire implementation is struct extension + prepend + string building.
|
||||
|
||||
## Common Pitfalls
|
||||
|
||||
### Pitfall 1: Mutating classify.DefaultRules
|
||||
**What goes wrong:** `append(classify.DefaultRules, userRules...)` prepends to the wrong end and may mutate the backing array of `DefaultRules` if the slice has capacity.
|
||||
**Why it happens:** Go slice append behavior with shared backing arrays.
|
||||
**How to avoid:** Always build the combined slice as `append(userRules, classify.DefaultRules...)` — user rules first, then defaults. This also gives the correct prepend order (D-04).
|
||||
**Warning signs:** Built-in rules fire before user rules for the same port/protocol.
|
||||
|
||||
### Pitfall 2: --print-config Requires -i (incorrect)
|
||||
**What goes wrong:** The `run()` function checks for `-i` / `--read` before checking `--print-config`, causing `netsynth --print-config` to fail with "interface required".
|
||||
**Why it happens:** The interface-required validation runs before the print-config check.
|
||||
**How to avoid:** Check `printConfigFlag` at the very top of `run()`, before the interface validation block. This matches how `listIfaces` is handled.
|
||||
**Warning signs:** `netsynth --print-config` returns "interface required" error instead of config output.
|
||||
|
||||
### Pitfall 3: Undecoded() Reports sounds.<class>.frequency as Unknown
|
||||
**What goes wrong:** After adding `Rules []RawRule` to `rawConfig`, the `Undecoded()` check may report `sounds.MyApp.frequency` as unknown if the `SoundOverride` struct is not correctly decoded.
|
||||
**Why it happens:** This was a concern during research but was verified NOT to occur — `[sounds.MyApp]` with a `SoundOverride` struct value decodes correctly alongside `[[rules]]`. No issue exists.
|
||||
**How to avoid:** N/A — verified working. Document in code that both sections coexist correctly.
|
||||
|
||||
### Pitfall 4: Auto-Frequency Called for Built-in Class Names
|
||||
**What goes wrong:** If a user writes `class = "HTTPS"` in `[[rules]]`, `addAutoFreqEntries()` must not overwrite the existing HTTPS entry with an auto-generated frequency.
|
||||
**Why it happens:** The auto-assign loop checks `if _, exists := cfgs[class]; !exists` — built-in classes ARE in the defaults map, so this guard works correctly. But only if `addAutoFreqEntries()` runs AFTER `merge()` has already applied `[sounds.*]` overrides.
|
||||
**How to avoid:** Call `addAutoFreqEntries()` as the last step in the merge pipeline, after `merge(defaults, raw.Sounds)`. The class-exists check then correctly skips both built-in and user-overridden classes.
|
||||
|
||||
### Pitfall 5: print-config Missing User Rules Section
|
||||
**What goes wrong:** `printConfig()` shows `[sounds.*]` entries but omits `[[rules]]` entries, making the output not round-trippable.
|
||||
**Why it happens:** Developer focuses on the sounds section (the existing config domain) and forgets rules.
|
||||
**How to avoid:** The `LoadResult` must include both `UserRules []classify.Rule` and `ConfigPath string`. The `PrintConfig()` function must emit the `[[rules]]` section before the `[sounds.*]` section, using the user rule slice.
|
||||
|
||||
### Pitfall 6: validate() Must Run Before convertRules()
|
||||
**What goes wrong:** An empty `protocol` or `class` field in `[[rules]]` gets silently converted to a `classify.Rule` with empty strings, producing confusing runtime behavior.
|
||||
**Why it happens:** `convertRules()` has no validation; it just copies fields.
|
||||
**How to avoid:** Call `validateRules(raw.Rules)` inside `validate()` (the existing validation entry point), before conversion. Fail fast at startup.
|
||||
|
||||
## Code Examples
|
||||
|
||||
### TOML File with Custom Rules (user-facing format)
|
||||
```toml
|
||||
# Classify custom app traffic on port 8080
|
||||
[[rules]]
|
||||
port = 8080
|
||||
protocol = "tcp"
|
||||
class = "MyApp"
|
||||
|
||||
# Match all UDP traffic to a custom class (port omitted = match any)
|
||||
[[rules]]
|
||||
protocol = "udp"
|
||||
class = "AllUDP"
|
||||
|
||||
# Give MyApp a custom sound
|
||||
[sounds.MyApp]
|
||||
frequency = 300.0
|
||||
waveform = "sine"
|
||||
|
||||
# Override built-in HTTPS sound
|
||||
[sounds.HTTPS]
|
||||
frequency = 400.0
|
||||
```
|
||||
|
||||
### rawConfig Extension
|
||||
```go
|
||||
// config/config.go
|
||||
type RawRule struct {
|
||||
Port *uint16 `toml:"port"`
|
||||
Protocol string `toml:"protocol"`
|
||||
Class string `toml:"class"`
|
||||
}
|
||||
|
||||
type rawConfig struct {
|
||||
Sounds map[string]SoundOverride `toml:"sounds"`
|
||||
Rules []RawRule `toml:"rules"`
|
||||
}
|
||||
```
|
||||
|
||||
### LoadResult Struct (replaces bare map return)
|
||||
```go
|
||||
type LoadResult struct {
|
||||
FreqCfgs map[classify.TrafficClass]synth.FreqConfig
|
||||
UserRules []classify.Rule
|
||||
ConfigPath string // populated path or "" if auto-discovery found nothing
|
||||
}
|
||||
|
||||
func Load(configPath string) (LoadResult, error) { ... }
|
||||
```
|
||||
|
||||
### Prepend User Rules in main.go
|
||||
```go
|
||||
result, err := config.Load(configPath)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
// D-04: user rules prepend before built-ins; first-match-wins
|
||||
allRules := append(result.UserRules, classify.DefaultRules...)
|
||||
classifier := classify.NewClassifier(allRules)
|
||||
```
|
||||
|
||||
### FNV-32a Auto-Frequency
|
||||
```go
|
||||
import "hash/fnv"
|
||||
|
||||
func autoAssignFreq(className string) float64 {
|
||||
h := fnv.New32a()
|
||||
h.Write([]byte(className))
|
||||
const (
|
||||
baseHz = 1200.0
|
||||
stepHz = 50.0
|
||||
numSteps = uint32(24)
|
||||
)
|
||||
return baseHz + float64(h.Sum32()%numSteps)*stepHz
|
||||
}
|
||||
```
|
||||
|
||||
## State of the Art
|
||||
|
||||
No changes to the underlying technology stack. All patterns are internal to the codebase.
|
||||
|
||||
| Old Behavior | New Behavior | When Changed | Impact |
|
||||
|---|---|---|---|
|
||||
| `config.Load()` returns `map[classify.TrafficClass]synth.FreqConfig` | Returns `LoadResult` struct with FreqCfgs + UserRules + ConfigPath | Phase 7 | All callers of `Load()` need update (currently 1 call site: `main.go:run()`) |
|
||||
| Unknown class names in `[sounds.*]` silently ignored (warning) | Still ignored with warning, but user-defined class names from `[[rules]]` get auto-freq entries instead | Phase 7 | New behavior for Phase 7 class names; old warning behavior preserved for truly unknown names |
|
||||
| `merge()` only processes sound overrides | `merge()` + `addAutoFreqEntries()` also handles new class synthesis entries | Phase 7 | Synthesis bank grows dynamically with user-defined classes |
|
||||
|
||||
## Environment Availability
|
||||
|
||||
Step 2.6: SKIPPED (no external dependencies identified — Phase 7 is a pure Go code extension using existing stack).
|
||||
|
||||
## Validation Architecture
|
||||
|
||||
### Test Framework
|
||||
| Property | Value |
|
||||
|----------|-------|
|
||||
| Framework | Go standard `testing` package |
|
||||
| Config file | None (no pytest.ini / jest.config equivalent) |
|
||||
| Quick run command | `go test ./config/... ./cmd/netsynth/...` |
|
||||
| Full suite command | `go test ./...` |
|
||||
|
||||
### Phase Requirements → Test Map
|
||||
|
||||
| Req ID | Behavior | Test Type | Automated Command | File Exists? |
|
||||
|--------|----------|-----------|-------------------|-------------|
|
||||
| RULE-01 | `[[rules]]` block in TOML parses correctly into `RawRule` slice | unit | `go test ./config/... -run TestLoadCustomRules` | ❌ Wave 0 |
|
||||
| RULE-01 | Port field omitted → DstPort 0 (match-any) | unit | `go test ./config/... -run TestLoadCustomRuleNoPort` | ❌ Wave 0 |
|
||||
| RULE-01 | Missing `protocol` field → error | unit | `go test ./config/... -run TestLoadCustomRuleMissingProtocol` | ❌ Wave 0 |
|
||||
| RULE-01 | Missing `class` field → error | unit | `go test ./config/... -run TestLoadCustomRuleMissingClass` | ❌ Wave 0 |
|
||||
| RULE-01 | Typo in `[[rules]]` field → error naming bad key | unit | `go test ./config/... -run TestLoadCustomRuleUnknownField` | ❌ Wave 0 |
|
||||
| RULE-02 | User rule for port 443/tcp fires before built-in HTTPS rule | unit | `go test ./config/... -run TestUserRulesPrepend` | ❌ Wave 0 |
|
||||
| RULE-03 | Class name with no `[sounds.*]` entry gets auto-freq entry in FreqCfgs | unit | `go test ./config/... -run TestAutoFreqAssignment` | ❌ Wave 0 |
|
||||
| RULE-03 | Auto-freq is deterministic (same class name → same frequency) | unit | `go test ./config/... -run TestAutoFreqDeterministic` | ❌ Wave 0 |
|
||||
| RULE-03 | Built-in class names NOT overwritten by auto-freq | unit | `go test ./config/... -run TestAutoFreqSkipsBuiltins` | ❌ Wave 0 |
|
||||
| CFG-06 | `--print-config` flag registered on root command | unit | `go test ./cmd/netsynth/... -run TestPrintConfigFlagRegistered` | ❌ Wave 0 |
|
||||
| CFG-06 | `--print-config` exits without requiring `-i` flag | unit | `go test ./cmd/netsynth/... -run TestPrintConfigNoInterface` | ❌ Wave 0 |
|
||||
| CFG-06 | Print-config output contains all 14 default class names | unit | `go test ./config/... -run TestPrintConfigContainsAllClasses` | ❌ Wave 0 |
|
||||
| CFG-06 | Print-config output contains `[[rules]]` section when user rules are present | unit | `go test ./config/... -run TestPrintConfigContainsRules` | ❌ Wave 0 |
|
||||
| CFG-06 | Print-config includes source path in header comment when config loaded | unit | `go test ./config/... -run TestPrintConfigSourcePath` | ❌ Wave 0 |
|
||||
|
||||
### Sampling Rate
|
||||
- **Per task commit:** `go test ./config/... ./cmd/netsynth/...`
|
||||
- **Per wave merge:** `go test ./...`
|
||||
- **Phase gate:** `go test ./...` green before `/gsd:verify-work`
|
||||
|
||||
### Wave 0 Gaps
|
||||
All test functions listed above are new — no existing test file covers Phase 7 behavior. Tests should be added to:
|
||||
- `config/config_test.go` — all `config` package tests (follow existing `writeTOML` helper pattern)
|
||||
- `cmd/netsynth/main_test.go` — all `cmd/netsynth` flag tests (follow existing `newTestCmd()` pattern)
|
||||
|
||||
No new test files needed — extend the existing test files.
|
||||
|
||||
## Open Questions
|
||||
|
||||
1. **PrintConfig annotation tracking for auto-assigned classes**
|
||||
- What we know: `addAutoFreqEntries()` adds entries to `FreqCfgs` for new class names
|
||||
- What's unclear: `PrintConfig()` needs to know which entries are auto-assigned (vs default vs user-override) to annotate them correctly
|
||||
- Recommendation: Add an `AutoClasses map[classify.TrafficClass]bool` field to `LoadResult`, populated by `addAutoFreqEntries()`. `PrintConfig()` consults this map.
|
||||
|
||||
2. **Cobra --print-config placement: before or after config load**
|
||||
- What we know: `--print-config` needs config loaded to show effective values
|
||||
- What's unclear: What if the user runs `netsynth --print-config` with no config file?
|
||||
- Recommendation: Always call `config.Load(configPath)` before printing. If no config file is found (auto-discovery returns nothing), the output shows all defaults — which is the most useful behavior.
|
||||
|
||||
## Sources
|
||||
|
||||
### Primary (HIGH confidence)
|
||||
- Source code: `config/config.go` — read directly; rawConfig struct, Load(), merge(), validate(), parseFile() all verified
|
||||
- Source code: `classify/rules.go` — DefaultRules slice, Rule struct verified
|
||||
- Source code: `classify/classifier.go` — NewClassifier(rules []Rule) injection point verified
|
||||
- Source code: `synth/bank.go` — NewBank(tau, cfgs) accepts arbitrary class maps confirmed
|
||||
- Source code: `synth/config.go` — ClassFreqConfigs frequency range 65–1047 Hz confirmed; WaveformPresetHarmonics verified
|
||||
- Source code: `cmd/netsynth/main.go` — current Load() call site; listIfaces early-exit pattern verified
|
||||
- Experimental: BurntSushi/toml `Undecoded()` behavior with `[[rules]]` — verified by running test code against go.mod-pinned v1.6.0
|
||||
- Experimental: FNV-32a frequency distribution — verified by running Go code; 24 distinct frequencies in 1200–2400 Hz range
|
||||
|
||||
### Secondary (MEDIUM confidence)
|
||||
- Source code: `config/config_test.go` — test patterns for writeTOML, Load() behavior; test style confirmed
|
||||
- Source code: `cmd/netsynth/main_test.go` — newTestCmd() pattern, flag registration test style confirmed
|
||||
|
||||
### Tertiary (LOW confidence)
|
||||
- None.
|
||||
|
||||
## Metadata
|
||||
|
||||
**Confidence breakdown:**
|
||||
- Standard stack: HIGH — no new dependencies; all libraries verified against go.mod
|
||||
- Architecture: HIGH — all integration points verified by reading actual source code
|
||||
- Pitfalls: HIGH — Pitfalls 1, 2, 4, 5 verified by code inspection; Pitfall 3 experimentally verified as non-issue
|
||||
- Test patterns: HIGH — existing test file structure read directly
|
||||
|
||||
**Research date:** 2026-03-26
|
||||
**Valid until:** Stable — 90 days (pure Go, no external dependencies, stable TOML library)
|
||||
@@ -0,0 +1,86 @@
|
||||
---
|
||||
phase: 7
|
||||
slug: custom-rules-and-print-config
|
||||
status: draft
|
||||
nyquist_compliant: false
|
||||
wave_0_complete: false
|
||||
created: 2026-03-26
|
||||
---
|
||||
|
||||
# Phase 7 — Validation Strategy
|
||||
|
||||
> Per-phase validation contract for feedback sampling during execution.
|
||||
|
||||
---
|
||||
|
||||
## Test Infrastructure
|
||||
|
||||
| Property | Value |
|
||||
|----------|-------|
|
||||
| **Framework** | Go standard `testing` package |
|
||||
| **Config file** | None |
|
||||
| **Quick run command** | `go test ./config/... ./cmd/netsynth/...` |
|
||||
| **Full suite command** | `go test ./...` |
|
||||
| **Estimated runtime** | ~5 seconds |
|
||||
|
||||
---
|
||||
|
||||
## Sampling Rate
|
||||
|
||||
- **After every task commit:** Run `go test ./config/... ./cmd/netsynth/...`
|
||||
- **After every plan wave:** Run `go test ./...`
|
||||
- **Before `/gsd:verify-work`:** Full suite must be green
|
||||
- **Max feedback latency:** 5 seconds
|
||||
|
||||
---
|
||||
|
||||
## Per-Task Verification Map
|
||||
|
||||
| Task ID | Plan | Wave | Requirement | Test Type | Automated Command | File Exists | Status |
|
||||
|---------|------|------|-------------|-----------|-------------------|-------------|--------|
|
||||
| 07-01-01 | 01 | 1 | RULE-01 | unit | `go test ./config/... -run TestLoadCustomRules` | ❌ W0 | ⬜ pending |
|
||||
| 07-01-02 | 01 | 1 | RULE-01 | unit | `go test ./config/... -run TestLoadCustomRuleNoPort` | ❌ W0 | ⬜ pending |
|
||||
| 07-01-03 | 01 | 1 | RULE-01 | unit | `go test ./config/... -run TestLoadCustomRuleMissingProtocol` | ❌ W0 | ⬜ pending |
|
||||
| 07-01-04 | 01 | 1 | RULE-01 | unit | `go test ./config/... -run TestLoadCustomRuleMissingClass` | ❌ W0 | ⬜ pending |
|
||||
| 07-01-05 | 01 | 1 | RULE-01 | unit | `go test ./config/... -run TestLoadCustomRuleUnknownField` | ❌ W0 | ⬜ pending |
|
||||
| 07-01-06 | 01 | 1 | RULE-02 | unit | `go test ./config/... -run TestUserRulesPrepend` | ❌ W0 | ⬜ pending |
|
||||
| 07-01-07 | 01 | 1 | RULE-03 | unit | `go test ./config/... -run TestAutoFreqAssignment` | ❌ W0 | ⬜ pending |
|
||||
| 07-01-08 | 01 | 1 | RULE-03 | unit | `go test ./config/... -run TestAutoFreqDeterministic` | ❌ W0 | ⬜ pending |
|
||||
| 07-01-09 | 01 | 1 | RULE-03 | unit | `go test ./config/... -run TestAutoFreqSkipsBuiltins` | ❌ W0 | ⬜ pending |
|
||||
| 07-02-01 | 02 | 2 | CFG-06 | unit | `go test ./cmd/netsynth/... -run TestPrintConfigFlagRegistered` | ❌ W0 | ⬜ pending |
|
||||
| 07-02-02 | 02 | 2 | CFG-06 | unit | `go test ./cmd/netsynth/... -run TestPrintConfigNoInterface` | ❌ W0 | ⬜ pending |
|
||||
| 07-02-03 | 02 | 2 | CFG-06 | unit | `go test ./config/... -run TestPrintConfigContainsAllClasses` | ❌ W0 | ⬜ pending |
|
||||
| 07-02-04 | 02 | 2 | CFG-06 | unit | `go test ./config/... -run TestPrintConfigContainsRules` | ❌ W0 | ⬜ pending |
|
||||
| 07-02-05 | 02 | 2 | CFG-06 | unit | `go test ./config/... -run TestPrintConfigSourcePath` | ❌ W0 | ⬜ pending |
|
||||
|
||||
*Status: ⬜ pending · ✅ green · ❌ red · ⚠️ flaky*
|
||||
|
||||
---
|
||||
|
||||
## Wave 0 Requirements
|
||||
|
||||
- [ ] `config/config_test.go` — add test stubs for RULE-01, RULE-02, RULE-03 (extend existing file using `writeTOML` helper pattern)
|
||||
- [ ] `cmd/netsynth/main_test.go` — add test stubs for CFG-06 (extend existing file using `newTestCmd()` pattern)
|
||||
|
||||
*Existing infrastructure covers framework install — `go test` already works.*
|
||||
|
||||
---
|
||||
|
||||
## Manual-Only Verifications
|
||||
|
||||
| Behavior | Requirement | Why Manual | Test Instructions |
|
||||
|----------|-------------|------------|-------------------|
|
||||
| Custom rule produces distinct tone in MP3 output | RULE-01 | Audio output requires human ear verification | Run `netsynth -i lo --config test.toml -o out.mp3`, listen for distinct tone on custom rule port |
|
||||
|
||||
---
|
||||
|
||||
## Validation Sign-Off
|
||||
|
||||
- [ ] All tasks have `<automated>` verify or Wave 0 dependencies
|
||||
- [ ] Sampling continuity: no 3 consecutive tasks without automated verify
|
||||
- [ ] Wave 0 covers all MISSING references
|
||||
- [ ] No watch-mode flags
|
||||
- [ ] Feedback latency < 5s
|
||||
- [ ] `nyquist_compliant: true` set in frontmatter
|
||||
|
||||
**Approval:** pending
|
||||
@@ -0,0 +1,115 @@
|
||||
---
|
||||
phase: 07-custom-rules-and-print-config
|
||||
verified: 2026-03-26T21:10:00Z
|
||||
status: passed
|
||||
score: 10/10 must-haves verified
|
||||
---
|
||||
|
||||
# Phase 7: Custom Rules and Print-Config Verification Report
|
||||
|
||||
**Phase Goal:** Users can define their own traffic classification rules in TOML, assign custom sounds to them, and inspect the full effective config before capture begins
|
||||
**Verified:** 2026-03-26T21:10:00Z
|
||||
**Status:** passed
|
||||
**Re-verification:** No — initial verification
|
||||
|
||||
## Goal Achievement
|
||||
|
||||
### Observable Truths
|
||||
|
||||
| # | Truth | Status | Evidence |
|
||||
|---|-------|--------|---------|
|
||||
| 1 | TOML `[[rules]]` blocks parse into `classify.Rule` slices | VERIFIED | `convertRules()` in config.go:192-206; `TestLoadCustomRules` passes; `TestLoadCustomRuleNoPort` passes |
|
||||
| 2 | Missing protocol or class in a rule produces a clear error at startup | VERIFIED | `validateRules()` in config.go:175-189; `TestLoadCustomRuleMissingProtocol`, `TestLoadCustomRuleMissingClass`, `TestLoadCustomRuleInvalidProtocol` all pass |
|
||||
| 3 | User rules are returned separately from FreqCfgs for caller to prepend | VERIFIED | `LoadResult.UserRules []classify.Rule` field in config.go:48-52; `TestUserRulesPrepend` passes |
|
||||
| 4 | New class names without explicit sound config get auto-assigned frequencies in 1200-2400 Hz range | VERIFIED | `autoAssignFreq()` in config.go:210-219 uses FNV-32a; range [1200, 2350]; `TestAutoFreqAssignment` and `TestAutoFreqDeterministic` pass |
|
||||
| 5 | Built-in class names in user rules do not get overwritten by auto-freq | VERIFIED | `addAutoFreqEntries()` checks `if _, exists := cfgs[rule.Class]; !exists` before assigning; `TestAutoFreqSkipsBuiltins` verifies HTTPS stays at 175.0 Hz |
|
||||
| 6 | User runs `netsynth --print-config` and sees full effective config as commented TOML on stdout without capture starting | VERIFIED | `runPrintConfig()` in main.go:114-122; `if printConfig` check at main.go:73 fires before interface-required validation; `TestPrintConfigNoInterface` passes |
|
||||
| 7 | User rules prepend before built-in rules so first-match-wins gives user priority | VERIFIED | `append(result.UserRules, classify.DefaultRules...)` in both `runLiveMode` (main.go:139) and `runPcapMode` (main.go:205); `TestUserRulesPrepend` confirms prepend order |
|
||||
| 8 | Print-config output shows source path when config file loaded | VERIFIED | `PrintConfig()` emits `# Config source: <path>` when `result.ConfigPath != ""`; `TestPrintConfigSourcePath` passes |
|
||||
| 9 | Print-config output annotates defaults vs overrides vs auto-assigned | VERIFIED | `classAnnotation()` in config.go:340-353 returns "default", "override", or "auto-assigned"; `TestPrintConfigDefaultAnnotation`, `TestPrintConfigOverrideAnnotation`, `TestPrintConfigAutoAssignedAnnotation` all pass |
|
||||
| 10 | Print-config output includes `[[rules]]` section when user rules are present | VERIFIED | `PrintConfig()` emits `[[rules]]` section when `len(result.UserRules) > 0` (config.go:284-295); `TestPrintConfigContainsRules` passes |
|
||||
|
||||
**Score:** 10/10 truths verified
|
||||
|
||||
### Required Artifacts
|
||||
|
||||
| Artifact | Expected | Status | Details |
|
||||
|----------|----------|--------|---------|
|
||||
| `config/config.go` | RawRule, LoadResult, validateRules, convertRules, autoAssignFreq, addAutoFreqEntries, PrintConfig | VERIFIED | All 7 constructs present; file is 396 lines, fully substantive |
|
||||
| `config/config_test.go` | Tests for rule parsing, validation, auto-freq, LoadResult, PrintConfig | VERIFIED | 29 tests total (8 pre-existing + 13 Plan-01 + 8 Plan-02); all pass |
|
||||
| `cmd/netsynth/main.go` | --print-config flag, runPrintConfig(), user rule prepend | VERIFIED | Flag registered at main.go:49; runPrintConfig at main.go:114; prepend in both runLiveMode and runPcapMode |
|
||||
| `cmd/netsynth/main_test.go` | Tests for --print-config flag | VERIFIED | TestPrintConfigFlagRegistered, TestPrintConfigNoInterface, TestPrintConfigWithConfigFile all present and pass |
|
||||
|
||||
### Key Link Verification
|
||||
|
||||
| From | To | Via | Status | Details |
|
||||
|------|----|-----|--------|---------|
|
||||
| config/config.go | classify/rules.go | convertRules produces []classify.Rule | WIRED | `classify.Rule` used at lines 49, 78, 192-206, 225 — manual grep confirmed |
|
||||
| config/config.go | synth/config.go | autoAssignFreq creates FreqConfig entries with WaveformPresetHarmonics | WIRED | `synth.WaveformPresetHarmonics` called at lines 232, 384, 390 — manual grep confirmed |
|
||||
| cmd/netsynth/main.go | config/config.go | runPrintConfig calls config.Load then config.PrintConfig | WIRED | `config.PrintConfig(result)` at main.go:119 — manual grep confirmed |
|
||||
| cmd/netsynth/main.go | classify/rules.go | append(result.UserRules, classify.DefaultRules...) | WIRED | gsd-tools verified; pattern present at main.go:139 and main.go:205 |
|
||||
|
||||
Note: gsd-tools key-link checker reported false negatives for the three pattern matches involving escaped dots (`\.`). All four links are confirmed present via manual grep.
|
||||
|
||||
### Data-Flow Trace (Level 4)
|
||||
|
||||
| Artifact | Data Variable | Source | Produces Real Data | Status |
|
||||
|----------|---------------|--------|--------------------|--------|
|
||||
| config/config.go PrintConfig | result.UserRules, result.FreqCfgs, result.AutoClasses | config.Load() parsing TOML + FNV-32a hash | Yes — real TOML parsing, classify.Rule slices, synth.FreqConfig map | FLOWING |
|
||||
| cmd/netsynth/main.go runLiveMode | allRules via result.UserRules | config.Load() -> convertRules() -> user TOML | Yes — user rules prepended to classify.DefaultRules | FLOWING |
|
||||
| cmd/netsynth/main.go runPcapMode | allRules via result.UserRules | config.Load() -> convertRules() -> user TOML | Yes — same prepend pattern as runLiveMode | FLOWING |
|
||||
|
||||
### Behavioral Spot-Checks
|
||||
|
||||
| Behavior | Command | Result | Status |
|
||||
|----------|---------|--------|--------|
|
||||
| config package: all 29 tests pass | `go test ./config/... -count=1` | ok (0.017s) | PASS |
|
||||
| cmd/netsynth package: all 13 tests pass | `go test ./cmd/netsynth/... -count=1` | ok (0.013s) | PASS |
|
||||
| Full test suite: all 7 packages | `go test ./... -count=1` | ok all 7 packages | PASS |
|
||||
| Static analysis | `go vet ./...` | no issues | PASS |
|
||||
| PrintConfig includes all 14 class names | TestPrintConfigContainsAllClasses | PASS | PASS |
|
||||
| --print-config works without -i | TestPrintConfigNoInterface | PASS | PASS |
|
||||
|
||||
### Requirements Coverage
|
||||
|
||||
| Requirement | Source Plan | Description | Status | Evidence |
|
||||
|-------------|-------------|-------------|--------|---------|
|
||||
| RULE-01 | 07-01 | User can define custom classification rules in TOML (match by port and/or protocol, assign class name) | SATISFIED | `RawRule` struct + `rawConfig.Rules []RawRule` + TOML `[[rules]]` parsing; TestLoadCustomRules and TestLoadCustomRuleNoPort verify parsing |
|
||||
| RULE-02 | 07-01, 07-02 | User-defined rules take priority over built-in rules (prepend before defaults) | SATISFIED | `append(result.UserRules, classify.DefaultRules...)` in both runLiveMode and runPcapMode; TestUserRulesPrepend verifies order |
|
||||
| RULE-03 | 07-01 | User-defined class names automatically get a synthesis layer (no silent gaps) | SATISFIED | `addAutoFreqEntries()` creates FreqConfig for unknown class names using FNV-32a in [1200, 2350] Hz; TestAutoFreqAssignment verifies entry exists with WaveformSine |
|
||||
| CFG-06 | 07-02 | User can run `netsynth --print-config` to see the effective config as commented TOML | SATISFIED | `--print-config` flag registered; `runPrintConfig()` calls config.Load + config.PrintConfig + fmt.Print; fires before interface-required check; TestPrintConfigNoInterface confirms no -i needed |
|
||||
|
||||
**Orphaned requirements:** None. All four requirement IDs (RULE-01, RULE-02, RULE-03, CFG-06) are claimed by plan frontmatter and verified above. REQUIREMENTS.md traceability table confirms all four map to Phase 7.
|
||||
|
||||
### Anti-Patterns Found
|
||||
|
||||
| File | Line | Pattern | Severity | Impact |
|
||||
|------|------|---------|----------|--------|
|
||||
| (none) | — | — | — | — |
|
||||
|
||||
No TODOs, FIXMEs, placeholder comments, empty return stubs, or hardcoded empty data found in modified files. The merge() function at config.go:368 does contain `return defaults` but returns the populated map after in-place mutation — this is correct behavior, not a stub.
|
||||
|
||||
### Human Verification Required
|
||||
|
||||
The following behaviors cannot be verified programmatically and require manual testing before production use:
|
||||
|
||||
#### 1. End-to-End TOML Round-Trip
|
||||
|
||||
**Test:** Create a `netsynth.toml` with multiple `[[rules]]` blocks (different ports, protocols, class names), run `netsynth --print-config`, copy the output to a new file, and load it again with `--print-config --config <copied-file>`.
|
||||
**Expected:** Output from both invocations should show the same class frequencies and annotations.
|
||||
**Why human:** Requires file creation, CLI invocation, and comparison of two output streams — not suitable for automated spot-check in a non-interactive environment.
|
||||
|
||||
#### 2. Custom Rule Sound Differentiation
|
||||
|
||||
**Test:** Create a TOML defining a custom rule for port 8080/tcp as "WebApp", run a capture or play a pcap with HTTP traffic on port 8080, and listen to the resulting MP3.
|
||||
**Expected:** Port 8080 traffic should produce a distinct tone from port 80 (HTTP) traffic.
|
||||
**Why human:** Requires audio playback and subjective listening — cannot be verified programmatically.
|
||||
|
||||
### Gaps Summary
|
||||
|
||||
No gaps. All 10 observable truths are verified, all 4 artifacts pass all three levels (exists, substantive, wired), all 4 key links are confirmed present in the code, all 4 requirements are satisfied, and the full test suite (7 packages, 29+ config tests, 13 main tests) passes cleanly.
|
||||
|
||||
---
|
||||
|
||||
_Verified: 2026-03-26T21:10:00Z_
|
||||
_Verifier: Claude (gsd-verifier)_
|
||||
Reference in New Issue
Block a user