Implemented the remaining trim artifact cleanup
All checks were successful
ci/woodpecker/tag/release Pipeline was successful
All checks were successful
ci/woodpecker/tag/release Pipeline was successful
This commit is contained in:
@@ -1,591 +0,0 @@
|
||||
# Pre-1.0 Code Quality And Deduplication Audit
|
||||
|
||||
## Executive Summary
|
||||
|
||||
seriatim's current codebase is in good shape for a limited pre-1.0 cleanup pass. The main command paths are explicit, tests cover the public CLI and important transformation behavior, and the implemented architecture mostly matches the policy in `docs/policy/architecture.md`: merge uses a registry-driven pipeline, while trim and normalize operate at the artifact level.
|
||||
|
||||
The top three refactoring targets before 1.0 are:
|
||||
|
||||
1. Centralize public output schema names, schema validation selection, and artifact schema switching.
|
||||
2. Reduce duplicated trim projection logic across full, intermediate, and minimal artifacts.
|
||||
3. Move trim command orchestration out of `internal/cli` so CLI code remains a thin adapter like merge and normalize.
|
||||
|
||||
No major architectural risk appears to block 1.0. The best next step is a series of small, behavior-preserving refactors protected by the existing CLI, trim, normalize, artifact, schema, and pipeline tests.
|
||||
|
||||
## Repository Map Reviewed
|
||||
|
||||
Reviewed documentation and policy:
|
||||
|
||||
- `README.md`
|
||||
- `docs/cli.md`
|
||||
- `docs/config.md`
|
||||
- `docs/operations.md`
|
||||
- `docs/troubleshooting.md`
|
||||
- `docs/policy/architecture.md`
|
||||
- `docs/policy/development.md`
|
||||
- `docs/internal/pipeline.md`
|
||||
- `docs/internal/artifacts.md`
|
||||
- `docs/internal/modules.md`
|
||||
- `docs/integrations/output-schemas.md`
|
||||
- `docs/integrations/whisperx-json.md`
|
||||
- `docs/roadmap/cleanup.md`
|
||||
|
||||
Reviewed implementation areas:
|
||||
|
||||
- `cmd/seriatim`: root process error handling.
|
||||
- `internal/cli`: Cobra command setup and command-level tests for `merge`, `trim`, and `normalize`.
|
||||
- `internal/config`: validated config construction, defaults, environment variables, path validation, and config tests.
|
||||
- `internal/pipeline`: registry resolution, stage ordering, preprocessing state validation, and pipeline execution.
|
||||
- `internal/builtin`: built-in input, preprocess, merge, postprocess, and output modules.
|
||||
- `internal/artifact`: conversion from merged model to public output artifacts.
|
||||
- `internal/trim`: selector parsing, artifact parsing/conversion, trimming, and trim tests.
|
||||
- `internal/normalize`: artifact-level parsing, repair, building, reporting, and normalize tests.
|
||||
- `internal/report`: report model and JSON writer.
|
||||
- `internal/overlap`, `internal/coalesce`, `internal/danglers`, `internal/backchannel`, `internal/filler`, `internal/autocorrect`, `internal/speaker`: implemented modules and module-specific tests.
|
||||
- `schema`: public Go schema types, embedded JSON Schemas, semantic validation, and schema tests.
|
||||
- `examples` and `samples`: checked layout and role, not every sample payload line-by-line.
|
||||
|
||||
The reviewed execution paths were:
|
||||
|
||||
- `seriatim merge`: Cobra options, `config.NewMergeConfig`, `pipeline.Run`, built-in registry, output writer, optional report.
|
||||
- `seriatim trim`: Cobra options, `config.NewTrimConfig`, artifact parsing, trim application, schema conversion, output writing, optional report.
|
||||
- `seriatim normalize`: Cobra options, `config.NewNormalizeConfig`, `normalize.Run`, artifact parsing/building, output writing, optional report.
|
||||
|
||||
No `internal/app`, `internal/stage`, `internal/modules`, `internal/validators`, `internal/adapters`, `internal/storage`, `internal/manifest`, `pkg`, or top-level `tests` directories exist in the current layout. Equivalent responsibilities are implemented in the packages listed above.
|
||||
|
||||
## High-Confidence Deduplication Opportunities
|
||||
|
||||
### Centralize Output Schema Names And Schema Selection
|
||||
|
||||
Affected files/packages:
|
||||
|
||||
- `internal/config`
|
||||
- `internal/trim`
|
||||
- `internal/artifact`
|
||||
- `internal/normalize`
|
||||
- `schema`
|
||||
|
||||
Duplicated or near-duplicated behavior:
|
||||
|
||||
- `internal/config` defines `seriatim-minimal`, `seriatim-intermediate`, and `seriatim-full` as output schema constants and validates CLI/config values.
|
||||
- `internal/trim/artifact.go` defines another set of constants with the same string values.
|
||||
- `internal/artifact`, `internal/normalize`, and `internal/trim` each switch over the same schema names to select conversion or validation behavior.
|
||||
|
||||
Why it matters:
|
||||
|
||||
- Output schema names are part of the public interface. If a schema name, default, or validation error changes in one package but not another, `merge`, `trim`, and `normalize` can drift.
|
||||
- The current duplication is small but central enough that future schema changes would require edits in several packages.
|
||||
|
||||
Recommended refactor:
|
||||
|
||||
- Keep one canonical set of public schema names, preferably outside command-specific config construction.
|
||||
- Expose narrow helpers for schema validation and display text where needed.
|
||||
- Preserve the current semantic difference that `merge` and `normalize` resolve `SERIATIM_OUTPUT_SCHEMA` and default to intermediate, while `trim` preserves the input artifact schema unless `--output-schema` is supplied.
|
||||
- Do not build a broad schema registry unless a new implemented schema makes the switch statements materially harder to maintain.
|
||||
|
||||
Suggested tests:
|
||||
|
||||
- `internal/config` tests for schema defaults, env precedence, invalid values, and trim override behavior.
|
||||
- `internal/cli` tests for merge, trim, and normalize schema flags.
|
||||
- `internal/artifact`, `internal/trim`, `internal/normalize`, and `schema` tests for selected shape validation.
|
||||
|
||||
Risk level: Low to medium. Public behavior must stay byte-compatible where tests assert shapes and diagnostics.
|
||||
|
||||
### Reduce Duplicated Trim Projection Logic Across Artifact Shapes
|
||||
|
||||
Affected files/packages:
|
||||
|
||||
- `internal/trim/apply.go`
|
||||
- `internal/trim/apply_test.go`
|
||||
- `internal/cli/trim_test.go`
|
||||
|
||||
Duplicated or near-duplicated behavior:
|
||||
|
||||
- `Apply`, `ApplyIntermediate`, and `ApplyMinimal` each validate mode, reject empty selectors, collect input IDs, validate sequential IDs, verify selected IDs exist, apply keep/remove policy, renumber retained segments from 1, build old-to-new mappings, collect removed IDs, and enforce `AllowEmpty`.
|
||||
- Only the segment shape and full-schema overlap group recomputation differ.
|
||||
|
||||
Why it matters:
|
||||
|
||||
- Trim is user-facing artifact surgery. Drift in ID validation, empty-output handling, or keep/remove behavior across schemas would produce confusing public differences.
|
||||
- The duplicated loops make future fixes to selector behavior or ID policy likely to require changes in three places.
|
||||
|
||||
Recommended refactor:
|
||||
|
||||
- Extract a small projection helper that operates on ordered segment IDs and returns retained indexes, old-to-new ID mapping, removed IDs, and empty-output validation.
|
||||
- Keep schema-specific reconstruction local to each artifact shape.
|
||||
- Keep full-schema overlap recomputation separate; it is a real semantic difference and should remain obvious.
|
||||
|
||||
Suggested tests:
|
||||
|
||||
- Existing `internal/trim/apply_test.go` coverage for keep/remove, renumbering, sequential ID validation, empty output, schema preservation, and overlap recomputation.
|
||||
- Existing `internal/cli/trim_test.go` coverage for end-to-end artifact behavior and report audit fields.
|
||||
- Add one table test that asserts the same selector policy across all three schemas.
|
||||
|
||||
Risk level: Medium. The refactor touches public trim behavior, but the duplicated policy is well covered.
|
||||
|
||||
### Move Trim Orchestration Out Of The CLI Adapter
|
||||
|
||||
Affected files/packages:
|
||||
|
||||
- `internal/cli/trim.go`
|
||||
- `internal/trim`
|
||||
- `internal/config`
|
||||
- `internal/report`
|
||||
|
||||
Duplicated or near-duplicated behavior:
|
||||
|
||||
- `merge` parses flags, builds config, and delegates to `pipeline.Run`.
|
||||
- `normalize` parses flags, builds config, and delegates to `normalize.Run`.
|
||||
- `trim` parses flags and config, but also reads files, parses artifacts, applies domain logic, converts schemas, validates output, writes output JSON, builds audit payloads, and writes reports directly in `internal/cli`.
|
||||
|
||||
Why it matters:
|
||||
|
||||
- This is the clearest boundary drift from the architecture policy. CLI should stay an adapter for flag parsing and command dispatch.
|
||||
- Keeping trim orchestration in CLI makes it harder to test trim as an application service without Cobra and makes report/output behavior easier to diverge from normalize.
|
||||
|
||||
Recommended refactor:
|
||||
|
||||
- Add a `trim.Run(ctx, cfg)` or similarly narrow artifact-level service in `internal/trim`.
|
||||
- Move artifact reading, selector parsing, apply/convert/validate/write/report orchestration into that service.
|
||||
- Leave Cobra flag definitions and `config.NewTrimConfig` calls in `internal/cli`.
|
||||
- Keep trim audit fields stable unless tests and docs are intentionally updated.
|
||||
|
||||
Suggested tests:
|
||||
|
||||
- Keep existing `internal/cli/trim_test.go` end-to-end tests.
|
||||
- Add direct `internal/trim` service tests for report generation and output schema conversion once the orchestration moves.
|
||||
|
||||
Risk level: Medium. It is mostly a move, but report event wording and error wrapping must remain stable.
|
||||
|
||||
### Centralize Pretty JSON File Writing
|
||||
|
||||
Affected files/packages:
|
||||
|
||||
- `internal/builtin/output.go`
|
||||
- `internal/cli/trim.go`
|
||||
- `internal/normalize/normalize.go`
|
||||
- `internal/report/report.go`
|
||||
|
||||
Duplicated or near-duplicated behavior:
|
||||
|
||||
- Several packages create a file with `os.Create`, use `json.NewEncoder`, set a two-space indent, encode a value, and defer close.
|
||||
- Error wrapping differs by call site: normalize wraps encode errors, trim and merge output mostly return raw errors, and report writing returns raw encode errors.
|
||||
|
||||
Why it matters:
|
||||
|
||||
- JSON artifacts and reports are core outputs. Formatting and write error semantics should not drift accidentally.
|
||||
- Centralizing this low-level operation would simplify future changes such as consistent close error handling or atomic write policy, if such behavior is ever implemented.
|
||||
|
||||
Recommended refactor:
|
||||
|
||||
- Introduce a small internal helper for deterministic JSON file writing.
|
||||
- Keep report construction in `internal/report`; only share the file-writing mechanics.
|
||||
- Do not introduce atomic writes or temporary files as part of this cleanup unless that behavior is intentionally designed and documented.
|
||||
|
||||
Suggested tests:
|
||||
|
||||
- Existing CLI tests that read output JSON for all commands.
|
||||
- Existing report tests through merge, trim, and normalize CLI paths.
|
||||
- A small helper-level test can verify indentation and trailing newline if those become explicit guarantees.
|
||||
|
||||
Risk level: Low.
|
||||
|
||||
## Medium-Confidence Opportunities
|
||||
|
||||
### Simplify Artifact Schema Switching In `internal/trim`
|
||||
|
||||
Affected files/packages:
|
||||
|
||||
- `internal/trim/artifact.go`
|
||||
- `internal/trim/artifact_test.go`
|
||||
|
||||
Duplicated or near-duplicated behavior:
|
||||
|
||||
- `Artifact.Value`, `SegmentCount`, `Application`, `Version`, `ValidateArtifact`, `ApplyArtifact`, and `ConvertArtifact` all switch on the same schema discriminator and nil-check the same payload pointers.
|
||||
|
||||
Why it matters:
|
||||
|
||||
- The wrapper works, but the repeated switch boilerplate makes it easier to miss one accessor when adding a field or changing error behavior.
|
||||
|
||||
Recommended refactor:
|
||||
|
||||
- After centralizing schema names, consider small methods or private helpers that reduce repeated nil-check/access patterns.
|
||||
- Avoid a generic visitor framework unless it directly removes the existing boilerplate without hiding schema-specific conversion rules.
|
||||
|
||||
Suggested tests:
|
||||
|
||||
- `internal/trim/artifact_test.go`
|
||||
- `internal/cli/trim_test.go` schema conversion cases.
|
||||
|
||||
Risk level: Low to medium.
|
||||
|
||||
### Share Common Config Path Validation Helpers For Single-Input Commands
|
||||
|
||||
Affected files/packages:
|
||||
|
||||
- `internal/config/config.go`
|
||||
- `internal/config/config_test.go`
|
||||
|
||||
Duplicated or near-duplicated behavior:
|
||||
|
||||
- `NewTrimConfig` and `NewNormalizeConfig` both trim, clean, require, and stat a single `--input-file`.
|
||||
- They also share `--output-file` and optional `--report-file` normalization behavior.
|
||||
|
||||
Why it matters:
|
||||
|
||||
- Config validation is a public command contract. Even small drift in missing file errors, directory errors, or output path parent checks would be user-visible.
|
||||
|
||||
Recommended refactor:
|
||||
|
||||
- Add private helpers for required single input files and optional output/report paths.
|
||||
- Keep merge's multi-input normalization separate because it deduplicates and sorts repeated `--input-file` values.
|
||||
- Preserve the intentional output schema difference between trim and normalize.
|
||||
|
||||
Suggested tests:
|
||||
|
||||
- Existing `internal/config` tests for trim and normalize input/output/report errors.
|
||||
- Existing CLI tests for report path failures.
|
||||
|
||||
Risk level: Low.
|
||||
|
||||
### Add Narrow CLI Flag Helper Functions
|
||||
|
||||
Affected files/packages:
|
||||
|
||||
- `internal/cli/merge.go`
|
||||
- `internal/cli/trim.go`
|
||||
- `internal/cli/normalize.go`
|
||||
|
||||
Duplicated or near-duplicated behavior:
|
||||
|
||||
- `--input-file`, `--output-file`, `--report-file`, `--output-schema`, and `--output-modules` are defined in multiple commands with related help text and defaults.
|
||||
|
||||
Why it matters:
|
||||
|
||||
- Flag names and help text are part of the user interface. Minor drift between commands can make docs and tests harder to keep accurate.
|
||||
|
||||
Recommended refactor:
|
||||
|
||||
- Add small flag registration helpers only for shared flags whose semantics are genuinely the same.
|
||||
- Do not introduce a command factory; current command files are short and readable.
|
||||
- Keep trim's `--output-schema` help/default distinct because omitted trim schema preserves the input artifact schema.
|
||||
|
||||
Suggested tests:
|
||||
|
||||
- Existing command recognition and behavior tests.
|
||||
- Add help-output assertions only if the helper refactor changes how help text is generated.
|
||||
|
||||
Risk level: Low.
|
||||
|
||||
### Centralize Segment Provenance Reference Formatting Where Semantics Match
|
||||
|
||||
Affected files/packages:
|
||||
|
||||
- `internal/overlap`
|
||||
- `internal/coalesce`
|
||||
- `internal/danglers`
|
||||
- `internal/model`
|
||||
|
||||
Duplicated or near-duplicated behavior:
|
||||
|
||||
- Several modules construct or interpret provenance references such as `source#index`, `word-run:group:speaker:run`, `coalesce:n`, and `resolve-danglers:n`.
|
||||
- `internal/overlap` and `internal/coalesce` both prefer `Source` plus `SourceSegmentIndex` and fall back to `SourceRef`.
|
||||
|
||||
Why it matters:
|
||||
|
||||
- Provenance references appear in public full output and reports/tests rely on deterministic values. A formatting mismatch could affect downstream consumers.
|
||||
|
||||
Recommended refactor:
|
||||
|
||||
- Introduce a very small helper for the common `source#index` or "best available segment reference" behavior.
|
||||
- Leave module-specific generated prefixes local unless another module needs to parse or construct them with the same semantics.
|
||||
|
||||
Suggested tests:
|
||||
|
||||
- `internal/overlap` resolve/detect tests.
|
||||
- `internal/coalesce` tests.
|
||||
- Merge CLI tests that assert `source_ref`, `derived_from`, and overlap group segment references.
|
||||
|
||||
Risk level: Medium. Public full-output provenance must remain stable.
|
||||
|
||||
### Share Category Tagging Mechanics Between Backchannel And Filler Carefully
|
||||
|
||||
Affected files/packages:
|
||||
|
||||
- `internal/backchannel`
|
||||
- `internal/filler`
|
||||
- `internal/builtin`
|
||||
|
||||
Duplicated or near-duplicated behavior:
|
||||
|
||||
- Backchannel and filler modules both normalize text by removing punctuation, collapse fields, reject empty text, enforce a maximum word count of three, enforce a max duration, match regex patterns, avoid duplicate categories, and append a category.
|
||||
|
||||
Why it matters:
|
||||
|
||||
- The policies are similar enough that a bug fix to normalization or duplicate category handling may need to be applied twice.
|
||||
|
||||
Recommended refactor:
|
||||
|
||||
- Consider a tiny private shared helper for tag application mechanics if another tagger is added or if a bug is found in the common logic.
|
||||
- Keep the category names, regex lists, and duration defaults in their current packages.
|
||||
- Do not create a broad classifier framework before 1.0.
|
||||
|
||||
Suggested tests:
|
||||
|
||||
- `internal/backchannel/backchannel_test.go`
|
||||
- `internal/filler/filler_test.go`
|
||||
- Merge CLI tests that assert category tagging and report events.
|
||||
|
||||
Risk level: Low to medium.
|
||||
|
||||
### Reduce Repetition In Schema Semantic Validation
|
||||
|
||||
Affected files/packages:
|
||||
|
||||
- `schema/output.go`
|
||||
- `schema/output_test.go`
|
||||
|
||||
Duplicated or near-duplicated behavior:
|
||||
|
||||
- Full, intermediate, and minimal semantic validators each enforce sequential segment IDs and non-decreasing timing.
|
||||
- Full validation also checks overlap group timing, which is intentionally schema-specific.
|
||||
|
||||
Why it matters:
|
||||
|
||||
- Sequential IDs and timing are cross-schema public invariants. Drift in error wording or strictness would be confusing.
|
||||
|
||||
Recommended refactor:
|
||||
|
||||
- Consider a small helper that validates ordered ID/timing pairs for all segment shapes.
|
||||
- Keep full overlap group validation separate.
|
||||
|
||||
Suggested tests:
|
||||
|
||||
- Existing schema validation tests for missing/non-sequential IDs and invalid timing.
|
||||
- Add cross-schema semantic validation cases if helper extraction touches all three shapes.
|
||||
|
||||
Risk level: Low.
|
||||
|
||||
## Boundary And Responsibility Concerns
|
||||
|
||||
The main boundary concern is `internal/cli/trim.go`. It currently holds command parsing, artifact I/O, selector parsing, domain execution, schema conversion, output validation, output writing, report assembly, and audit sorting. That orchestration belongs in `internal/trim` under the current architecture because trim is an artifact-level application command, not CLI-specific behavior.
|
||||
|
||||
`internal/normalize` already provides a better pattern: the CLI builds `config.NormalizeConfig` and delegates to `normalize.Run`. `merge` follows the same boundary direction by delegating to `pipeline.Run`.
|
||||
|
||||
Other boundary observations:
|
||||
|
||||
- YAML loading for speaker maps and autocorrect rules lives in narrow packages and is called from built-in modules. This is acceptable for current behavior, although future refactors could split file loading from pure transformation if tests start needing adapter-free module execution.
|
||||
- `schema` owns public schema structs, embedded JSON Schema validation, and semantic validation. That is an appropriate boundary. Avoid moving command defaults or CLI wording into `schema`.
|
||||
- `internal/report` owns report data structures and report JSON writing. It should not grow command-specific audit policy, but it can reasonably share low-level deterministic JSON writing.
|
||||
|
||||
## Path, Key, And Naming Construction Review
|
||||
|
||||
seriatim currently uses local filesystem paths only. There are no remote keys, cache paths, manifests, lock files, daemon paths, object-store keys, or resume state paths in the inspected implementation.
|
||||
|
||||
Path validation is reasonably centralized in `internal/config`:
|
||||
|
||||
- `normalizeInputFiles` handles merge's repeated input files, duplicate detection, sorting, and file existence.
|
||||
- `normalizeOutputPath` validates output/report parent directories.
|
||||
- `requireFile` validates input files and YAML config files.
|
||||
|
||||
Cleanup opportunities:
|
||||
|
||||
- Add private config helpers for required single input paths and optional report paths to reduce repeated trim/normalize validation.
|
||||
- Centralize deterministic JSON output file writing as described above.
|
||||
- Consider a small provenance reference helper for `source#index` formatting and fallback behavior where `internal/overlap` and `internal/coalesce` already share semantics.
|
||||
|
||||
No remote key or generated workspace path cleanup is applicable.
|
||||
|
||||
## Resolution And Catalog Review
|
||||
|
||||
Module resolution is cleanly centralized for merge:
|
||||
|
||||
- `internal/builtin.NewRegistry` registers built-in input, preprocessing, postprocessing, merger, and output modules.
|
||||
- `internal/pipeline.Registry` resolves names and returns user-facing unknown module errors.
|
||||
- `pipeline.Run` validates preprocessing state transitions before execution.
|
||||
|
||||
Output module resolution differs by command:
|
||||
|
||||
- Merge resolves output modules through the pipeline registry.
|
||||
- Normalize accepts only `json` through config validation.
|
||||
- Trim does not expose output modules and always writes JSON.
|
||||
|
||||
Those differences appear intentional for current behavior. Do not force trim and normalize into the merge registry unless artifact-level commands gain actual pluggable output modules.
|
||||
|
||||
Schema resolution is less centralized:
|
||||
|
||||
- Config validates public schema names for CLI/config inputs.
|
||||
- Artifact, normalize, and trim packages switch over the same schema values for output construction, parsing, conversion, and validation.
|
||||
|
||||
Recommended centralization is limited to schema names and narrow validation/selection helpers. Avoid a plugin or catalog abstraction that would imply unimplemented dynamic schemas.
|
||||
|
||||
## Config And Command-Loading Review
|
||||
|
||||
Config loading is explicit and mostly consistent:
|
||||
|
||||
- CLI commands parse flags into option structs.
|
||||
- `internal/config` validates and normalizes runtime configs.
|
||||
- Merge and normalize resolve `SERIATIM_OUTPUT_SCHEMA`; trim accepts an explicit schema override and otherwise preserves the input artifact schema.
|
||||
- Merge sorts and deduplicates repeated input files; trim and normalize each require exactly one input file.
|
||||
|
||||
Likely intentional differences:
|
||||
|
||||
- Trim has `--keep`, `--remove`, and `--allow-empty`; merge and normalize do not.
|
||||
- Merge exposes module lists and stage config; trim and normalize do not run the merge pipeline.
|
||||
- Normalize validates output modules as only `json`; trim has no output module flag.
|
||||
- `--output-schema` has a default in merge and normalize help, but trim's empty default is meaningful.
|
||||
|
||||
Likely cleanup opportunities:
|
||||
|
||||
- Share path/report validation helpers for single-input commands.
|
||||
- Share flag registration for truly common flags after confirming help text stays stable.
|
||||
- Add small config test builders to reduce repeated boilerplate in `internal/config/config_test.go`.
|
||||
|
||||
No duplicated secret handling was found; no secrets are currently implemented.
|
||||
|
||||
## State, Manifest, Or Progress Handling Review
|
||||
|
||||
No durable state, manifests, checkpoints, progress files, resume logic, force mode, dry-run mode, remote storage, or daemon state are implemented.
|
||||
|
||||
Reports are deterministic JSON event artifacts:
|
||||
|
||||
- Merge reports are finalized in `internal/pipeline`.
|
||||
- Normalize reports are built in `internal/normalize`.
|
||||
- Trim reports are currently built in `internal/cli`.
|
||||
|
||||
The only state/progress cleanup recommended before 1.0 is to align trim report construction with an `internal/trim` application service and to avoid adding manifest/resume abstractions unless a concrete implemented workflow requires them.
|
||||
|
||||
## Refactors To Avoid Before 1.0
|
||||
|
||||
Avoid these tempting refactors before 1.0:
|
||||
|
||||
- A generic workflow engine for merge, trim, and normalize. Their command semantics are different enough that a shared engine would obscure behavior.
|
||||
- A broad plugin architecture. Current modules are built-in and registry-driven; dynamic plugins are not implemented.
|
||||
- A sweeping CLI redesign or command factory. The current explicit Cobra setup is easy to audit.
|
||||
- A generalized schema catalog that implies runtime-extensible schemas. Only the implemented minimal, intermediate, and full output schemas should be represented.
|
||||
- A manifest, checkpoint, resume, or dry-run framework. No such state model exists today.
|
||||
- Premature generics-heavy helpers for schema conversions. Keep helpers small and tied to duplicated policy, not shape similarity alone.
|
||||
- Merging backchannel and filler into one classifier package unless the common mechanics are extracted narrowly and domain-specific rules remain obvious.
|
||||
- Replacing all file I/O with an adapter layer. The current app is filesystem-only; introduce adapter seams only where they reduce tested duplication or clarify command boundaries.
|
||||
|
||||
## Recommended Implementation Sequence
|
||||
|
||||
1. Centralize schema names and output schema validation helpers.
|
||||
- Goal: one canonical public schema name source and stable validation behavior.
|
||||
- Files: `internal/config`, `internal/trim`, `internal/artifact`, `internal/normalize`, `schema` as needed.
|
||||
- Tests: `go test ./internal/config ./internal/artifact ./internal/trim ./internal/normalize ./schema ./internal/cli`.
|
||||
- Prompt size: one small implementation prompt.
|
||||
|
||||
2. Extract trim projection policy.
|
||||
- Goal: one implementation of keep/remove selection, sequential ID validation, renumbering, old-to-new mapping, removed IDs, and allow-empty policy.
|
||||
- Files: `internal/trim/apply.go`, `internal/trim/apply_test.go`.
|
||||
- Tests: `go test ./internal/trim ./internal/cli`.
|
||||
- Prompt size: one prompt.
|
||||
|
||||
3. Move trim orchestration into `internal/trim`.
|
||||
- Goal: make trim CLI match the merge/normalize adapter boundary.
|
||||
- Files: `internal/cli/trim.go`, new or updated `internal/trim` service file, trim tests.
|
||||
- Tests: `go test ./internal/trim ./internal/cli`.
|
||||
- Prompt size: one prompt.
|
||||
|
||||
4. Centralize deterministic JSON output writing.
|
||||
- Goal: remove repeated `os.Create` plus indented JSON encoder boilerplate.
|
||||
- Files: a small internal helper plus `internal/builtin/output.go`, `internal/normalize/normalize.go`, `internal/trim` or `internal/cli/trim.go`, `internal/report/report.go`.
|
||||
- Tests: `go test ./internal/builtin ./internal/normalize ./internal/trim ./internal/report ./internal/cli`.
|
||||
- Prompt size: one prompt.
|
||||
|
||||
5. Clean up config and CLI repetition.
|
||||
- Goal: private helpers for single input path validation, optional report paths, and common flags where semantics match.
|
||||
- Files: `internal/config/config.go`, `internal/config/config_test.go`, `internal/cli/*.go`.
|
||||
- Tests: `go test ./internal/config ./internal/cli`.
|
||||
- Prompt size: one prompt; split CLI helper work if help text assertions are added.
|
||||
|
||||
6. Review provenance and category helper extraction.
|
||||
- Goal: centralize only shared mechanics that are easy to get wrong.
|
||||
- Files: `internal/overlap`, `internal/coalesce`, maybe `internal/model`; `internal/backchannel`, `internal/filler`.
|
||||
- Tests: `go test ./internal/overlap ./internal/coalesce ./internal/backchannel ./internal/filler ./internal/cli`.
|
||||
- Prompt size: one or two prompts depending on whether provenance and category work are both pursued.
|
||||
|
||||
7. Test helper cleanup.
|
||||
- Goal: reduce repeated config builders and CLI test fixtures without hiding test intent.
|
||||
- Files: `internal/config/*_test.go`, `internal/cli/*_test.go`, selected module tests.
|
||||
- Tests: affected package tests plus `go test ./...`.
|
||||
- Prompt size: one prompt if scoped to config/CLI; otherwise split by package.
|
||||
|
||||
8. Dead-code and legacy terminology sweep.
|
||||
- Goal: remove stale helpers or wording left after cleanup.
|
||||
- Files: code and docs touched by the above stages.
|
||||
- Tests: `go test ./...`; grep for stale schema or architecture terms.
|
||||
- Prompt size: one prompt.
|
||||
|
||||
## Test Strategy
|
||||
|
||||
Before refactoring:
|
||||
|
||||
- Use existing tests as a behavior lock:
|
||||
- `go test ./internal/config`
|
||||
- `go test ./internal/trim`
|
||||
- `go test ./internal/normalize`
|
||||
- `go test ./internal/artifact`
|
||||
- `go test ./schema`
|
||||
- `go test ./internal/cli`
|
||||
|
||||
During schema cleanup:
|
||||
|
||||
- Preserve tests covering schema defaults, env precedence, invalid schema values, trim schema preservation, trim schema conversion, normalize selected schema, and merge output schemas.
|
||||
- Add a small cross-command test only if centralization changes the public error text source.
|
||||
|
||||
During trim projection cleanup:
|
||||
|
||||
- Add or preserve tests that assert the same selector behavior for full, intermediate, and minimal inputs.
|
||||
- Keep full-schema overlap group recomputation tests separate.
|
||||
|
||||
During trim orchestration move:
|
||||
|
||||
- Keep CLI end-to-end tests for trim output and reports.
|
||||
- Add direct `internal/trim` service tests if report construction moves out of CLI.
|
||||
|
||||
During JSON writer cleanup:
|
||||
|
||||
- Preserve CLI tests that read generated JSON.
|
||||
- If the helper claims deterministic formatting, add a focused helper test for indentation and newline behavior.
|
||||
|
||||
During provenance/category cleanup:
|
||||
|
||||
- Preserve module tests and merge CLI tests that assert `source_ref`, `derived_from`, overlap group segment refs, backchannel categories, filler categories, and report events.
|
||||
|
||||
Final validation for any cleanup sequence:
|
||||
|
||||
- `go test ./...`
|
||||
- `go run ./cmd/seriatim --help`
|
||||
- `go run ./cmd/seriatim merge --help`
|
||||
- `go run ./cmd/seriatim trim --help`
|
||||
- `go run ./cmd/seriatim normalize --help`
|
||||
|
||||
For this audit-only pass, the full test suite was intentionally not run because no code or example behavior changed.
|
||||
|
||||
## Appendix: Findings Not Worth Acting On
|
||||
|
||||
### Keep Merge Pipeline Registry Explicit
|
||||
|
||||
The registry resolution methods for input readers, preprocessors, postprocessors, output writers, and the merger look similar, but they produce stage-specific error messages and keep stage boundaries clear. A generic resolver would save little and could make errors less direct.
|
||||
|
||||
### Keep Merge, Trim, And Normalize As Separate Command Concepts
|
||||
|
||||
The commands share flags and file output behavior, but their domain semantics differ. Merge is a staged pipeline over raw inputs; trim and normalize operate on artifacts. A shared command runner would likely obscure those distinctions.
|
||||
|
||||
### Do Not Centralize All File Reads
|
||||
|
||||
`internal/builtin/input`, `internal/normalize/parse`, `internal/speaker`, `internal/autocorrect`, and trim orchestration read different file contracts and wrap errors differently. Centralizing all reads would not improve clarity today.
|
||||
|
||||
### Keep Schema-Specific Artifact Conversion Visible
|
||||
|
||||
Full, intermediate, and minimal outputs are intentionally different public contracts. Helpers can remove repeated accessors and schema names, but conversion code should remain easy to audit.
|
||||
|
||||
### Leave `samples/` Alone In Code Cleanup
|
||||
|
||||
`samples/` is a documentation/data hygiene question, not a code-quality refactor. The cleanup sequence should focus on maintained `examples/` and avoid destructive sample moves without a separate privacy and documentation pass.
|
||||
|
||||
### Avoid Test Fixture Over-Abstraction
|
||||
|
||||
There is repeated test setup in CLI and config tests, but much of it makes public behavior explicit at the call site. Add small builders where they reduce noise, but do not hide important command arguments behind opaque fixtures.
|
||||
@@ -1,784 +0,0 @@
|
||||
# Pre-1.0 Cleanup Implementation Plan
|
||||
|
||||
## Purpose
|
||||
|
||||
This roadmap defines the staged cleanup work recommended by
|
||||
`docs/roadmap/audit.md`. It is written for coding agents that will implement the
|
||||
cleanup in order.
|
||||
|
||||
This is a roadmap document. It may describe planned refactors because it lives
|
||||
under `docs/roadmap/`. Implementation agents must not document planned cleanup
|
||||
as current behavior outside `docs/roadmap/`.
|
||||
|
||||
## Governing Policies
|
||||
|
||||
Follow these policy documents before implementing any stage:
|
||||
|
||||
- `docs/policy/architecture.md`
|
||||
- `docs/policy/development.md`
|
||||
- `docs/policy/documentation.md`
|
||||
|
||||
The cleanup must preserve these project rules:
|
||||
|
||||
- Keep CLI code thin: parse flags, build validated config, delegate.
|
||||
- Keep config normalization and validation in `internal/config`.
|
||||
- Keep public output contracts and validation in `schema`.
|
||||
- Keep merge pipeline orchestration in `internal/pipeline`.
|
||||
- Keep trim and normalize artifact-level; do not run merge modules from those
|
||||
commands.
|
||||
- Keep behavior deterministic and sequential.
|
||||
- Prefer narrow helpers over broad frameworks.
|
||||
- Do not add concurrency, dynamic plugins, durable state, manifests, remote
|
||||
storage, or resume behavior.
|
||||
|
||||
## Global Implementation Rules
|
||||
|
||||
Each stage should be implemented as a small, behavior-preserving change.
|
||||
|
||||
For every stage:
|
||||
|
||||
- Start with `git status --short`.
|
||||
- Read the files listed in that stage before editing.
|
||||
- Do not modify unrelated files.
|
||||
- Preserve public CLI flags, defaults, output schemas, JSON shapes, report event
|
||||
ordering, report event text, and error messages unless the stage explicitly
|
||||
says otherwise.
|
||||
- Prefer private helpers unless a cross-package helper is genuinely needed.
|
||||
- Do not introduce generic engines, plugin systems, broad adapter layers, or
|
||||
generics-heavy abstractions.
|
||||
- Run the stage-specific tests listed in the stage.
|
||||
- Run `go test ./...` before considering the full cleanup sequence complete.
|
||||
|
||||
Documentation updates during cleanup should be minimal. If a refactor changes
|
||||
implemented package boundaries that are described in `docs/internal/` or
|
||||
`docs/policy/architecture.md`, update those docs in the same implementation
|
||||
stage. Do not update user-facing docs if behavior did not change.
|
||||
|
||||
## Stage 1: Centralize Output Schema Names
|
||||
|
||||
### Goal
|
||||
|
||||
Make `schema` the canonical source for public output schema names and keep
|
||||
command-specific default/precedence policy in `internal/config`.
|
||||
|
||||
### Decision
|
||||
|
||||
Use the `schema` package as the canonical home for output schema name constants
|
||||
because public output contracts already live there.
|
||||
|
||||
Add these exported string constants to `schema`:
|
||||
|
||||
- `OutputSchemaMinimal = "seriatim-minimal"`
|
||||
- `OutputSchemaIntermediate = "seriatim-intermediate"`
|
||||
- `OutputSchemaFull = "seriatim-full"`
|
||||
|
||||
Add narrow schema-name helpers in `schema`, not CLI-specific helpers:
|
||||
|
||||
- `ValidOutputSchemaName(value string) bool`
|
||||
- `OutputSchemaNames() []string`
|
||||
|
||||
Do not put CLI flag names or default selection policy in `schema`.
|
||||
|
||||
Keep the `internal/config` constants as aliases for compatibility inside the
|
||||
repository:
|
||||
|
||||
- `config.OutputSchemaMinimal = schema.OutputSchemaMinimal`
|
||||
- `config.OutputSchemaIntermediate = schema.OutputSchemaIntermediate`
|
||||
- `config.OutputSchemaFull = schema.OutputSchemaFull`
|
||||
|
||||
Remove the duplicate string constants from `internal/trim/artifact.go`; use the
|
||||
canonical schema constants instead. A type alias or package-local aliases are
|
||||
acceptable only if they point directly to the `schema` constants and do not
|
||||
repeat string literals.
|
||||
|
||||
### Files To Inspect
|
||||
|
||||
- `schema/output.go`
|
||||
- `schema/output_test.go`
|
||||
- `internal/config/config.go`
|
||||
- `internal/config/config_test.go`
|
||||
- `internal/trim/artifact.go`
|
||||
- `internal/trim/artifact_test.go`
|
||||
- `internal/artifact/transcript.go`
|
||||
- `internal/normalize/build.go`
|
||||
- `internal/cli/*_test.go`
|
||||
|
||||
### Implementation Steps
|
||||
|
||||
1. Add canonical output schema constants and helpers to `schema/output.go`.
|
||||
2. Update `internal/config` schema constants to alias `schema` constants.
|
||||
3. Update config validation to use `schema.ValidOutputSchemaName` while keeping
|
||||
the existing `--output-schema must be one of ...` error text.
|
||||
4. Update `internal/trim` to stop repeating schema string constants.
|
||||
5. Update affected tests only where they refer to moved constants.
|
||||
6. Search for raw schema string literals outside tests and docs. Keep raw values
|
||||
in docs and test fixtures where they are intentionally testing serialized
|
||||
public JSON.
|
||||
|
||||
### Acceptance Criteria
|
||||
|
||||
- There is one canonical set of output schema string constants in `schema`.
|
||||
- `merge` and `normalize` still default to `seriatim-intermediate` and still
|
||||
honor `SERIATIM_OUTPUT_SCHEMA`.
|
||||
- `trim` still preserves the input artifact schema when `--output-schema` is
|
||||
omitted.
|
||||
- Invalid schema error text remains stable unless tests are intentionally
|
||||
updated.
|
||||
- No new schema registry or plugin-style abstraction exists.
|
||||
|
||||
### Validation Commands
|
||||
|
||||
```sh
|
||||
go test ./schema ./internal/config ./internal/artifact ./internal/trim ./internal/normalize ./internal/cli
|
||||
```
|
||||
|
||||
### Prompt Size
|
||||
|
||||
Small enough for one implementation prompt.
|
||||
|
||||
## Stage 2: Extract Trim Projection Policy
|
||||
|
||||
### Goal
|
||||
|
||||
Use one implementation for trim selector policy, ID validation, retained-index
|
||||
selection, ID renumbering metadata, removed IDs, and empty-output handling.
|
||||
|
||||
### Decision
|
||||
|
||||
Add a private projection helper in `internal/trim/apply.go`. Do not introduce a
|
||||
generic artifact framework.
|
||||
|
||||
Recommended shape:
|
||||
|
||||
```go
|
||||
type projection struct {
|
||||
retainedIndexes []int
|
||||
oldToNewID map[int]int
|
||||
removedIDs []int
|
||||
}
|
||||
|
||||
func projectSegmentIDs(ids []int, opts Options) (projection, error)
|
||||
```
|
||||
|
||||
The helper should:
|
||||
|
||||
- validate `Mode`;
|
||||
- reject an empty selector;
|
||||
- validate input IDs are positive, unique, and sequential from `1..n`;
|
||||
- validate selected IDs exist;
|
||||
- apply keep/remove semantics;
|
||||
- return retained input indexes in original order;
|
||||
- return deterministic old-to-new ID mappings;
|
||||
- return removed input IDs in original order;
|
||||
- enforce `AllowEmpty`.
|
||||
|
||||
Keep schema-specific segment reconstruction in `Apply`, `ApplyIntermediate`,
|
||||
and `ApplyMinimal`. Keep full-schema overlap group recomputation only in the
|
||||
full-schema path.
|
||||
|
||||
### Files To Inspect
|
||||
|
||||
- `internal/trim/apply.go`
|
||||
- `internal/trim/apply_test.go`
|
||||
- `internal/cli/trim_test.go`
|
||||
- `schema/output.go`
|
||||
|
||||
### Implementation Steps
|
||||
|
||||
1. Add the private projection helper and small supporting types.
|
||||
2. Refactor `Apply` to call the helper, reconstruct full segments from retained
|
||||
indexes, renumber IDs, clear old overlap group IDs, and recompute overlap
|
||||
groups.
|
||||
3. Refactor `ApplyIntermediate` to call the helper and reconstruct intermediate
|
||||
segments.
|
||||
4. Refactor `ApplyMinimal` to call the helper and reconstruct minimal segments.
|
||||
5. Preserve existing error messages from `validateMode`, empty selectors,
|
||||
invalid input IDs, missing selected IDs, and empty output.
|
||||
6. Add a focused table test proving the same selector policy is applied to all
|
||||
three schema shapes.
|
||||
|
||||
### Acceptance Criteria
|
||||
|
||||
- Keep/remove behavior is unchanged for all supported artifact schemas.
|
||||
- Segment IDs are still reassigned sequentially from `1`.
|
||||
- Full-schema trim still recomputes overlap groups.
|
||||
- Intermediate and minimal trim still do not create overlap groups.
|
||||
- The common selector and ID policy exists in one helper.
|
||||
|
||||
### Validation Commands
|
||||
|
||||
```sh
|
||||
go test ./internal/trim ./internal/cli
|
||||
```
|
||||
|
||||
### Prompt Size
|
||||
|
||||
Small enough for one implementation prompt.
|
||||
|
||||
## Stage 3: Move Trim Orchestration Into `internal/trim`
|
||||
|
||||
### Goal
|
||||
|
||||
Make `trim` match the repository's adapter boundary: CLI parses flags and
|
||||
delegates; artifact-level orchestration lives in `internal/trim`.
|
||||
|
||||
### Decision
|
||||
|
||||
Add `Run(ctx context.Context, cfg config.TrimConfig) error` to `internal/trim`.
|
||||
|
||||
Move from `internal/cli/trim.go` into `internal/trim`:
|
||||
|
||||
- selector parsing from validated config;
|
||||
- input file read;
|
||||
- artifact parse;
|
||||
- `ApplyArtifact`;
|
||||
- output schema selection and conversion;
|
||||
- output validation;
|
||||
- transcript output JSON write;
|
||||
- trim audit payload construction;
|
||||
- report event construction;
|
||||
- old-to-new ID mapping ordering.
|
||||
|
||||
Keep in `internal/cli/trim.go`:
|
||||
|
||||
- Cobra command definition;
|
||||
- flag registration;
|
||||
- `cmd.Flags().Changed("output-schema")` handling;
|
||||
- `config.NewTrimConfig`;
|
||||
- delegation to `trim.Run`.
|
||||
|
||||
Temporarily keep any moved JSON writer local to `internal/trim` if Stage 4 has
|
||||
not yet been implemented. Stage 4 will centralize file writing.
|
||||
|
||||
### Files To Inspect
|
||||
|
||||
- `internal/cli/trim.go`
|
||||
- `internal/cli/trim_test.go`
|
||||
- `internal/trim/*.go`
|
||||
- `internal/trim/*_test.go`
|
||||
- `internal/config/config.go`
|
||||
- `internal/report/report.go`
|
||||
- `internal/normalize/normalize.go`
|
||||
|
||||
### Implementation Steps
|
||||
|
||||
1. Create `internal/trim/run.go` or another appropriately named file.
|
||||
2. Move trim audit structs to `internal/trim`. Keep JSON field names unchanged.
|
||||
3. Add `Run(ctx, cfg)` and check `ctx.Err()` before doing work.
|
||||
4. Move helper functions needed only by trim orchestration, including ordered
|
||||
ID mapping.
|
||||
5. Update `internal/cli/trim.go` to delegate to `trim.Run`.
|
||||
6. Add direct `internal/trim` tests for service-level behavior if existing CLI
|
||||
tests do not cover moved report/output behavior clearly.
|
||||
7. Keep all existing trim CLI tests passing.
|
||||
|
||||
### Acceptance Criteria
|
||||
|
||||
- `internal/cli/trim.go` contains flag wiring, config construction, and a call
|
||||
to `trim.Run`; it no longer performs artifact I/O or report construction.
|
||||
- Trim output files and report files are unchanged for existing tests.
|
||||
- Trim error wrapping is not weakened for user-facing file, parse, validation,
|
||||
or report-write failures.
|
||||
- No merge pipeline modules are invoked by trim.
|
||||
|
||||
### Validation Commands
|
||||
|
||||
```sh
|
||||
go test ./internal/trim ./internal/cli
|
||||
```
|
||||
|
||||
### Prompt Size
|
||||
|
||||
Small enough for one implementation prompt.
|
||||
|
||||
## Stage 4: Centralize Deterministic JSON File Writing
|
||||
|
||||
### Goal
|
||||
|
||||
Remove repeated `os.Create` plus indented `json.Encoder` boilerplate while
|
||||
preserving current JSON formatting.
|
||||
|
||||
### Decision
|
||||
|
||||
Create a small package named `internal/jsonfile`.
|
||||
|
||||
Recommended API:
|
||||
|
||||
```go
|
||||
package jsonfile
|
||||
|
||||
func Write(path string, value any) error
|
||||
```
|
||||
|
||||
The helper should:
|
||||
|
||||
- create or truncate the target path with `os.Create`;
|
||||
- encode JSON with `encoder.SetIndent("", " ")`;
|
||||
- preserve the current trailing newline produced by `Encoder.Encode`;
|
||||
- return underlying create/encode/close errors with enough context for callers
|
||||
to wrap where they already wrap.
|
||||
|
||||
Do not implement atomic writes, temporary files, directory creation, lock files,
|
||||
or fsync behavior in this stage.
|
||||
|
||||
### Files To Inspect
|
||||
|
||||
- `internal/builtin/output.go`
|
||||
- `internal/report/report.go`
|
||||
- `internal/normalize/normalize.go`
|
||||
- `internal/trim/run.go` or `internal/cli/trim.go`, depending on Stage 3 state
|
||||
- Existing CLI tests that read output JSON
|
||||
|
||||
### Implementation Steps
|
||||
|
||||
1. Add `internal/jsonfile/jsonfile.go`.
|
||||
2. Add a focused `internal/jsonfile/jsonfile_test.go` covering two-space
|
||||
indentation and valid JSON.
|
||||
3. Update merge JSON output writer to use `jsonfile.Write`.
|
||||
4. Update normalize output writing to use `jsonfile.Write`, preserving
|
||||
user-facing error context.
|
||||
5. Update trim output writing to use `jsonfile.Write`.
|
||||
6. Update `report.WriteJSON` to use `jsonfile.Write`.
|
||||
7. Remove duplicated local `writeOutputJSON` helpers.
|
||||
|
||||
### Acceptance Criteria
|
||||
|
||||
- Merge, trim, normalize, and report JSON are still pretty-printed with two
|
||||
spaces and a trailing newline.
|
||||
- There is one implementation of deterministic JSON file writing.
|
||||
- Report construction remains in `internal/report` or command packages; only
|
||||
file-writing mechanics are shared.
|
||||
- No new persistence semantics are introduced.
|
||||
|
||||
### Validation Commands
|
||||
|
||||
```sh
|
||||
go test ./internal/jsonfile ./internal/builtin ./internal/report ./internal/normalize ./internal/trim ./internal/cli
|
||||
```
|
||||
|
||||
### Prompt Size
|
||||
|
||||
Small enough for one implementation prompt.
|
||||
|
||||
## Stage 5: Clean Up Config Path Validation
|
||||
|
||||
### Goal
|
||||
|
||||
Reduce repeated path validation in single-input command config without changing
|
||||
config precedence or errors.
|
||||
|
||||
### Decision
|
||||
|
||||
Add private helpers in `internal/config/config.go` only. Do not create a config
|
||||
builder framework.
|
||||
|
||||
Recommended helpers:
|
||||
|
||||
```go
|
||||
func normalizeSingleInputFile(path string, flag string) (string, error)
|
||||
func normalizeOptionalOutputPath(path string, flag string) (string, error)
|
||||
```
|
||||
|
||||
`normalizeSingleInputFile` should preserve the current `--input-file is
|
||||
required` and `requireFile` behavior.
|
||||
|
||||
`normalizeOptionalOutputPath` should return `""` for empty or whitespace-only
|
||||
values and otherwise call the existing required output path validation.
|
||||
|
||||
Keep `normalizeInputFiles` separate for merge because merge accepts repeated
|
||||
input files, rejects duplicates, and sorts paths.
|
||||
|
||||
### Files To Inspect
|
||||
|
||||
- `internal/config/config.go`
|
||||
- `internal/config/config_test.go`
|
||||
- `internal/cli/trim_test.go`
|
||||
- `internal/cli/normalize_test.go`
|
||||
|
||||
### Implementation Steps
|
||||
|
||||
1. Add private path helpers.
|
||||
2. Refactor `NewTrimConfig` to use them.
|
||||
3. Refactor `NewNormalizeConfig` to use them.
|
||||
4. Keep `NewMergeConfig` behavior unchanged except where it can reuse existing
|
||||
`normalizeOutputPath`.
|
||||
5. Preserve all current error message substrings tested by config and CLI
|
||||
tests.
|
||||
|
||||
### Acceptance Criteria
|
||||
|
||||
- Trim and normalize single-input path normalization is implemented once.
|
||||
- Optional report path handling is implemented once.
|
||||
- Merge multi-input normalization remains explicit and unchanged.
|
||||
- No config struct fields, env vars, flags, defaults, or precedence rules
|
||||
change.
|
||||
|
||||
### Validation Commands
|
||||
|
||||
```sh
|
||||
go test ./internal/config ./internal/cli
|
||||
```
|
||||
|
||||
### Prompt Size
|
||||
|
||||
Small enough for one implementation prompt.
|
||||
|
||||
## Stage 6: Add Narrow CLI Flag Helpers
|
||||
|
||||
### Goal
|
||||
|
||||
Reduce typo-prone repeated Cobra flag wiring while keeping command files
|
||||
explicit and readable.
|
||||
|
||||
### Decision
|
||||
|
||||
Add helper functions in `internal/cli/flags.go`. Helpers should take a
|
||||
`*cobra.Command` and a target pointer. This avoids adding a direct import of
|
||||
`pflag` unless it becomes clearly cleaner.
|
||||
|
||||
Recommended helpers:
|
||||
|
||||
- `addOutputFileFlag(cmd *cobra.Command, target *string)`
|
||||
- `addReportFileFlag(cmd *cobra.Command, target *string)`
|
||||
- `addOutputModulesFlag(cmd *cobra.Command, target *string)`
|
||||
- `addMergeOutputSchemaFlag(cmd *cobra.Command, target *string)`
|
||||
- `addNormalizeOutputSchemaFlag(cmd *cobra.Command, target *string)`
|
||||
- `addTrimOutputSchemaFlag(cmd *cobra.Command, target *string)`
|
||||
|
||||
Do not create one generic output schema helper because trim has different
|
||||
omitted-flag semantics and help text.
|
||||
|
||||
For `--input-file`, prefer keeping command-local definitions unless a helper
|
||||
improves clarity:
|
||||
|
||||
- merge uses `StringArrayVar`;
|
||||
- trim and normalize use `StringVar`;
|
||||
- usage text differs.
|
||||
|
||||
### Files To Inspect
|
||||
|
||||
- `internal/cli/merge.go`
|
||||
- `internal/cli/trim.go`
|
||||
- `internal/cli/normalize.go`
|
||||
- `internal/cli/*_test.go`
|
||||
- `docs/cli.md`, only to verify flag text if behavior or help text changes
|
||||
|
||||
### Implementation Steps
|
||||
|
||||
1. Add `internal/cli/flags.go`.
|
||||
2. Move only identical or intentionally paired flag definitions into helpers.
|
||||
3. Keep command-specific flags and semantic differences local.
|
||||
4. Run command help manually and compare the important flag names/defaults.
|
||||
5. Update tests only if they assert help text that intentionally changed.
|
||||
|
||||
### Acceptance Criteria
|
||||
|
||||
- Public flag names and defaults are unchanged.
|
||||
- Help text remains at least as accurate as before.
|
||||
- Command files remain easy to read.
|
||||
- No command factory or shared command runner is introduced.
|
||||
|
||||
### Validation Commands
|
||||
|
||||
```sh
|
||||
go test ./internal/cli
|
||||
go run ./cmd/seriatim --help
|
||||
go run ./cmd/seriatim merge --help
|
||||
go run ./cmd/seriatim trim --help
|
||||
go run ./cmd/seriatim normalize --help
|
||||
```
|
||||
|
||||
### Prompt Size
|
||||
|
||||
Small enough for one implementation prompt.
|
||||
|
||||
## Stage 7: Centralize Common Segment Reference Formatting
|
||||
|
||||
### Goal
|
||||
|
||||
Use one helper for the shared "best available segment reference" policy used by
|
||||
overlap and coalesce logic.
|
||||
|
||||
### Decision
|
||||
|
||||
Add a small helper in `internal/model`, because the helper operates on
|
||||
`model.Segment` and expresses domain reference semantics.
|
||||
|
||||
Recommended API:
|
||||
|
||||
```go
|
||||
func SegmentReference(segment Segment) string
|
||||
```
|
||||
|
||||
The helper should:
|
||||
|
||||
- return `fmt.Sprintf("%s#%d", segment.Source, *segment.SourceSegmentIndex)`
|
||||
when `Source` is non-empty and `SourceSegmentIndex` is non-nil;
|
||||
- otherwise return `segment.SourceRef` when non-empty;
|
||||
- otherwise return `""`.
|
||||
|
||||
Use this helper only where the existing code already has this exact fallback
|
||||
policy. Keep generated references such as `word-run:%d:%d:%d`, `coalesce:%d`,
|
||||
and `resolve-danglers:%d` local to the modules that create them.
|
||||
|
||||
### Files To Inspect
|
||||
|
||||
- `internal/model/model.go`
|
||||
- `internal/overlap/detect.go`
|
||||
- `internal/coalesce/coalesce.go`
|
||||
- `internal/overlap/*_test.go`
|
||||
- `internal/coalesce/*_test.go`
|
||||
- `internal/cli/merge_test.go`
|
||||
|
||||
### Implementation Steps
|
||||
|
||||
1. Add `SegmentReference` and tests in `internal/model`.
|
||||
2. Replace duplicated fallback logic in overlap detection.
|
||||
3. Replace duplicated fallback logic in coalesce.
|
||||
4. Do not change generated reference prefixes.
|
||||
5. Do not change sorting behavior or derived-from ordering.
|
||||
|
||||
### Acceptance Criteria
|
||||
|
||||
- Existing provenance strings in full output remain unchanged.
|
||||
- `source#index` formatting exists in one shared helper for matching semantics.
|
||||
- Module-specific generated references stay module-local.
|
||||
|
||||
### Validation Commands
|
||||
|
||||
```sh
|
||||
go test ./internal/model ./internal/overlap ./internal/coalesce ./internal/cli
|
||||
```
|
||||
|
||||
### Prompt Size
|
||||
|
||||
Small enough for one implementation prompt.
|
||||
|
||||
## Stage 8: Reduce Repetition In Schema Semantic Validation
|
||||
|
||||
### Goal
|
||||
|
||||
Use one private helper for cross-schema segment ID and timing invariants.
|
||||
|
||||
### Decision
|
||||
|
||||
Keep this helper private to `schema`. Do not use generics unless the resulting
|
||||
code is clearly simpler than a small projection type.
|
||||
|
||||
Recommended shape:
|
||||
|
||||
```go
|
||||
type segmentSemantics struct {
|
||||
id int
|
||||
start float64
|
||||
end float64
|
||||
}
|
||||
|
||||
func validateSegmentSemantics(segments []segmentSemantics) error
|
||||
```
|
||||
|
||||
Preserve current error text:
|
||||
|
||||
- `segment %d has id %d; want %d`
|
||||
- `segment %d has end %.3f before start %.3f`
|
||||
|
||||
Keep full-schema overlap group timing validation separate.
|
||||
|
||||
### Files To Inspect
|
||||
|
||||
- `schema/output.go`
|
||||
- `schema/output_test.go`
|
||||
- callers in `internal/artifact`, `internal/trim`, and `internal/normalize`
|
||||
|
||||
### Implementation Steps
|
||||
|
||||
1. Add the private segment semantic helper.
|
||||
2. Adapt full, intermediate, and minimal validation functions to project their
|
||||
segment shapes into the helper.
|
||||
3. Keep full overlap group semantic validation in the full validation path.
|
||||
4. Add or preserve tests that cover invalid IDs and invalid timing for each
|
||||
public schema shape.
|
||||
|
||||
### Acceptance Criteria
|
||||
|
||||
- Sequential ID and timing rules are implemented once.
|
||||
- Public schema validation behavior and error wording remain stable.
|
||||
- Full overlap group validation remains full-schema only.
|
||||
|
||||
### Validation Commands
|
||||
|
||||
```sh
|
||||
go test ./schema ./internal/artifact ./internal/trim ./internal/normalize ./internal/cli
|
||||
```
|
||||
|
||||
### Prompt Size
|
||||
|
||||
Small enough for one implementation prompt.
|
||||
|
||||
## Stage 9: Test Helper Cleanup
|
||||
|
||||
### Goal
|
||||
|
||||
Reduce repeated test setup after behavior-preserving refactors are complete.
|
||||
|
||||
### Decision
|
||||
|
||||
Keep test helpers package-local. Do not add exported test utility packages.
|
||||
|
||||
Prioritize helpers that reduce noise without hiding public command behavior:
|
||||
|
||||
- config option builders in `internal/config/config_test.go`;
|
||||
- command execution helpers in `internal/cli` if duplication remains after
|
||||
trim orchestration and flag helper cleanup;
|
||||
- fixture builders for trim schema shapes if they stay repetitive.
|
||||
|
||||
Do not abstract command arguments so far that tests no longer show the public
|
||||
CLI contract being exercised.
|
||||
|
||||
### Files To Inspect
|
||||
|
||||
- `internal/config/config_test.go`
|
||||
- `internal/cli/merge_test.go`
|
||||
- `internal/cli/trim_test.go`
|
||||
- `internal/cli/normalize_test.go`
|
||||
- `internal/trim/*_test.go`
|
||||
|
||||
### Implementation Steps
|
||||
|
||||
1. Identify repeated setup that survived prior stages.
|
||||
2. Add package-local helper builders for config options with valid defaults.
|
||||
3. Consolidate duplicate read/write JSON helpers only inside the test package
|
||||
where they are used.
|
||||
4. Keep high-signal command arguments inline in CLI tests.
|
||||
5. Avoid golden-file rewrites or fixture churn unrelated to cleanup.
|
||||
|
||||
### Acceptance Criteria
|
||||
|
||||
- Tests are shorter where setup was noisy.
|
||||
- Public behavior being tested remains obvious.
|
||||
- No production code changes are made in this stage unless a test-only cleanup
|
||||
reveals dead production code from earlier stages.
|
||||
|
||||
### Validation Commands
|
||||
|
||||
```sh
|
||||
go test ./internal/config ./internal/cli ./internal/trim
|
||||
```
|
||||
|
||||
### Prompt Size
|
||||
|
||||
One implementation prompt if limited to config/CLI/trim tests. Split by package
|
||||
if the diff becomes large.
|
||||
|
||||
## Stage 10: Final Dead-Code And Documentation Sweep
|
||||
|
||||
### Goal
|
||||
|
||||
Remove stale helpers and update internal documentation only where implemented
|
||||
cleanup changed current boundaries.
|
||||
|
||||
### Decision
|
||||
|
||||
This is a cleanup verification stage, not a feature stage.
|
||||
|
||||
Do not delete `samples/`, move examples, redesign docs, or alter user-facing
|
||||
references unless directly required by implemented cleanup.
|
||||
|
||||
### Files To Inspect
|
||||
|
||||
- All files touched by Stages 1-9
|
||||
- `docs/policy/architecture.md`
|
||||
- `docs/policy/development.md`
|
||||
- `docs/internal/artifacts.md`
|
||||
- `docs/internal/pipeline.md`
|
||||
- `docs/internal/modules.md`
|
||||
- `docs/cli.md`
|
||||
- `docs/config.md`
|
||||
|
||||
### Implementation Steps
|
||||
|
||||
1. Search for obsolete helpers, duplicate schema constants, duplicate JSON
|
||||
writers, old trim CLI orchestration helpers, and unused imports.
|
||||
2. Run `go test ./...`.
|
||||
3. Run command help checks.
|
||||
4. Update internal docs only if package responsibility changed in a way current
|
||||
docs now describe inaccurately.
|
||||
5. Do not add planned cleanup notes outside `docs/roadmap/`.
|
||||
|
||||
### Acceptance Criteria
|
||||
|
||||
- No duplicate output schema string constants remain outside canonical aliases
|
||||
and intentional docs/test fixtures.
|
||||
- No duplicate production `writeOutputJSON` helper remains.
|
||||
- `internal/cli/trim.go` is a thin adapter.
|
||||
- Docs outside `docs/roadmap/` describe only implemented behavior.
|
||||
- Full repository tests pass.
|
||||
|
||||
### Validation Commands
|
||||
|
||||
```sh
|
||||
go test ./...
|
||||
go run ./cmd/seriatim --help
|
||||
go run ./cmd/seriatim merge --help
|
||||
go run ./cmd/seriatim trim --help
|
||||
go run ./cmd/seriatim normalize --help
|
||||
rg -n "SchemaMinimal|SchemaIntermediate|SchemaFull|writeOutputJSON|seriatim-minimal|seriatim-intermediate|seriatim-full" internal schema
|
||||
```
|
||||
|
||||
The `rg` command is a review aid. Raw schema strings may still be appropriate in
|
||||
canonical constants, docs, JSON Schema files, and tests that assert serialized
|
||||
public contracts.
|
||||
|
||||
### Prompt Size
|
||||
|
||||
Small enough for one implementation prompt after prior stages are complete.
|
||||
|
||||
## Deferred Or Explicitly Avoided Work
|
||||
|
||||
Do not implement these as part of the pre-1.0 cleanup sequence unless a later
|
||||
audit identifies a concrete bug or larger duplication pattern:
|
||||
|
||||
- A generic workflow engine for merge, trim, and normalize.
|
||||
- Dynamic plugins or runtime-extensible schemas.
|
||||
- A manifest, checkpoint, resume, dry-run, force, or progress framework.
|
||||
- Atomic output writes or fsync semantics.
|
||||
- A broad filesystem adapter layer.
|
||||
- A combined backchannel/filler classifier framework.
|
||||
- A generic registry resolver that erases stage-specific error messages.
|
||||
- A broad public API for internals.
|
||||
- Destructive changes to `samples/`.
|
||||
|
||||
Backchannel and filler share mechanics, but the cleanup decision is to defer
|
||||
shared category-tagging extraction before 1.0. The current duplication is small,
|
||||
domain-specific, and well isolated.
|
||||
|
||||
## Full Cleanup Validation
|
||||
|
||||
After all implemented stages:
|
||||
|
||||
```sh
|
||||
go test ./...
|
||||
go run ./cmd/seriatim --help
|
||||
go run ./cmd/seriatim merge --help
|
||||
go run ./cmd/seriatim trim --help
|
||||
go run ./cmd/seriatim normalize --help
|
||||
```
|
||||
|
||||
Manual review checklist:
|
||||
|
||||
- Public CLI behavior is unchanged.
|
||||
- Public output schemas and JSON shapes are unchanged.
|
||||
- Report event ordering and text remain stable unless tests were deliberately
|
||||
updated.
|
||||
- Trim, normalize, and merge boundaries match `docs/policy/architecture.md`.
|
||||
- No planned or aspirational behavior was added to non-roadmap docs.
|
||||
- Cleanup reduced duplicated policy without introducing broad abstractions.
|
||||
|
||||
## Open Questions
|
||||
|
||||
No blocking questions are required to implement this plan.
|
||||
|
||||
If a future implementation stage discovers that preserving current behavior
|
||||
conflicts with one of the structural decisions above, stop that stage and ask
|
||||
for direction before changing public CLI behavior, public JSON contracts, or
|
||||
report semantics.
|
||||
@@ -73,20 +73,23 @@ func ParseArtifactJSON(data []byte) (Artifact, error) {
|
||||
func ValidateArtifact(artifact Artifact) error {
|
||||
switch artifact.Schema {
|
||||
case SchemaFull:
|
||||
if artifact.Full == nil {
|
||||
return fmt.Errorf("full artifact payload is missing")
|
||||
payload, err := artifact.fullPayload()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return schema.ValidateTranscript(*artifact.Full)
|
||||
return schema.ValidateTranscript(*payload)
|
||||
case SchemaIntermediate:
|
||||
if artifact.Intermediate == nil {
|
||||
return fmt.Errorf("intermediate artifact payload is missing")
|
||||
payload, err := artifact.intermediatePayload()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return schema.ValidateIntermediateTranscript(*artifact.Intermediate)
|
||||
return schema.ValidateIntermediateTranscript(*payload)
|
||||
case SchemaMinimal:
|
||||
if artifact.Minimal == nil {
|
||||
return fmt.Errorf("minimal artifact payload is missing")
|
||||
payload, err := artifact.minimalPayload()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return schema.ValidateMinimalTranscript(*artifact.Minimal)
|
||||
return schema.ValidateMinimalTranscript(*payload)
|
||||
default:
|
||||
return fmt.Errorf("unsupported artifact schema %q", artifact.Schema)
|
||||
}
|
||||
@@ -188,10 +191,11 @@ func (artifact Artifact) Version() string {
|
||||
func ApplyArtifact(input Artifact, opts Options) (ApplyArtifactResult, error) {
|
||||
switch input.Schema {
|
||||
case SchemaFull:
|
||||
if input.Full == nil {
|
||||
return ApplyArtifactResult{}, fmt.Errorf("full artifact payload is missing")
|
||||
payload, err := input.fullPayload()
|
||||
if err != nil {
|
||||
return ApplyArtifactResult{}, err
|
||||
}
|
||||
result, err := Apply(*input.Full, opts)
|
||||
result, err := Apply(*payload, opts)
|
||||
if err != nil {
|
||||
return ApplyArtifactResult{}, err
|
||||
}
|
||||
@@ -206,10 +210,11 @@ func ApplyArtifact(input Artifact, opts Options) (ApplyArtifactResult, error) {
|
||||
OverlapGroupsRecomputed: true,
|
||||
}, nil
|
||||
case SchemaIntermediate:
|
||||
if input.Intermediate == nil {
|
||||
return ApplyArtifactResult{}, fmt.Errorf("intermediate artifact payload is missing")
|
||||
payload, err := input.intermediatePayload()
|
||||
if err != nil {
|
||||
return ApplyArtifactResult{}, err
|
||||
}
|
||||
result, err := ApplyIntermediate(*input.Intermediate, opts)
|
||||
result, err := ApplyIntermediate(*payload, opts)
|
||||
if err != nil {
|
||||
return ApplyArtifactResult{}, err
|
||||
}
|
||||
@@ -224,10 +229,11 @@ func ApplyArtifact(input Artifact, opts Options) (ApplyArtifactResult, error) {
|
||||
OverlapGroupsRecomputed: false,
|
||||
}, nil
|
||||
case SchemaMinimal:
|
||||
if input.Minimal == nil {
|
||||
return ApplyArtifactResult{}, fmt.Errorf("minimal artifact payload is missing")
|
||||
payload, err := input.minimalPayload()
|
||||
if err != nil {
|
||||
return ApplyArtifactResult{}, err
|
||||
}
|
||||
result, err := ApplyMinimal(*input.Minimal, opts)
|
||||
result, err := ApplyMinimal(*payload, opts)
|
||||
if err != nil {
|
||||
return ApplyArtifactResult{}, err
|
||||
}
|
||||
@@ -254,18 +260,19 @@ func ConvertArtifact(input Artifact, outputSchema string) (Artifact, error) {
|
||||
|
||||
switch input.Schema {
|
||||
case SchemaFull:
|
||||
if input.Full == nil {
|
||||
return Artifact{}, fmt.Errorf("full artifact payload is missing")
|
||||
payload, err := input.fullPayload()
|
||||
if err != nil {
|
||||
return Artifact{}, err
|
||||
}
|
||||
switch outputSchema {
|
||||
case SchemaIntermediate:
|
||||
out := intermediateFromFull(*input.Full)
|
||||
out := intermediateFromFull(*payload)
|
||||
return Artifact{
|
||||
Schema: SchemaIntermediate,
|
||||
Intermediate: &out,
|
||||
}, nil
|
||||
case SchemaMinimal:
|
||||
out := minimalFromFull(*input.Full)
|
||||
out := minimalFromFull(*payload)
|
||||
return Artifact{
|
||||
Schema: SchemaMinimal,
|
||||
Minimal: &out,
|
||||
@@ -274,12 +281,13 @@ func ConvertArtifact(input Artifact, outputSchema string) (Artifact, error) {
|
||||
return Artifact{}, fmt.Errorf("unsupported output schema %q", outputSchema)
|
||||
}
|
||||
case SchemaIntermediate:
|
||||
if input.Intermediate == nil {
|
||||
return Artifact{}, fmt.Errorf("intermediate artifact payload is missing")
|
||||
payload, err := input.intermediatePayload()
|
||||
if err != nil {
|
||||
return Artifact{}, err
|
||||
}
|
||||
switch outputSchema {
|
||||
case SchemaMinimal:
|
||||
out := minimalFromIntermediate(*input.Intermediate)
|
||||
out := minimalFromIntermediate(*payload)
|
||||
return Artifact{
|
||||
Schema: SchemaMinimal,
|
||||
Minimal: &out,
|
||||
@@ -290,12 +298,13 @@ func ConvertArtifact(input Artifact, outputSchema string) (Artifact, error) {
|
||||
return Artifact{}, fmt.Errorf("unsupported output schema %q", outputSchema)
|
||||
}
|
||||
case SchemaMinimal:
|
||||
if input.Minimal == nil {
|
||||
return Artifact{}, fmt.Errorf("minimal artifact payload is missing")
|
||||
payload, err := input.minimalPayload()
|
||||
if err != nil {
|
||||
return Artifact{}, err
|
||||
}
|
||||
switch outputSchema {
|
||||
case SchemaIntermediate:
|
||||
out := intermediateFromMinimal(*input.Minimal)
|
||||
out := intermediateFromMinimal(*payload)
|
||||
return Artifact{
|
||||
Schema: SchemaIntermediate,
|
||||
Intermediate: &out,
|
||||
@@ -310,6 +319,27 @@ func ConvertArtifact(input Artifact, outputSchema string) (Artifact, error) {
|
||||
}
|
||||
}
|
||||
|
||||
func (artifact Artifact) fullPayload() (*schema.Transcript, error) {
|
||||
if artifact.Full == nil {
|
||||
return nil, fmt.Errorf("full artifact payload is missing")
|
||||
}
|
||||
return artifact.Full, nil
|
||||
}
|
||||
|
||||
func (artifact Artifact) intermediatePayload() (*schema.IntermediateTranscript, error) {
|
||||
if artifact.Intermediate == nil {
|
||||
return nil, fmt.Errorf("intermediate artifact payload is missing")
|
||||
}
|
||||
return artifact.Intermediate, nil
|
||||
}
|
||||
|
||||
func (artifact Artifact) minimalPayload() (*schema.MinimalTranscript, error) {
|
||||
if artifact.Minimal == nil {
|
||||
return nil, fmt.Errorf("minimal artifact payload is missing")
|
||||
}
|
||||
return artifact.Minimal, nil
|
||||
}
|
||||
|
||||
func intermediateFromFull(input schema.Transcript) schema.IntermediateTranscript {
|
||||
segments := make([]schema.IntermediateSegment, len(input.Segments))
|
||||
for index, segment := range input.Segments {
|
||||
|
||||
@@ -128,6 +128,61 @@ func TestConvertArtifactMinimalToFullFails(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestValidateArtifactRejectsMissingPayloads(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
artifact Artifact
|
||||
want string
|
||||
}{
|
||||
{
|
||||
name: "full",
|
||||
artifact: Artifact{Schema: SchemaFull},
|
||||
want: "full artifact payload is missing",
|
||||
},
|
||||
{
|
||||
name: "intermediate",
|
||||
artifact: Artifact{Schema: SchemaIntermediate},
|
||||
want: "intermediate artifact payload is missing",
|
||||
},
|
||||
{
|
||||
name: "minimal",
|
||||
artifact: Artifact{Schema: SchemaMinimal},
|
||||
want: "minimal artifact payload is missing",
|
||||
},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
err := ValidateArtifact(test.artifact)
|
||||
assertErrorContains(t, err, test.want)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestApplyArtifactRejectsMissingPayload(t *testing.T) {
|
||||
_, err := ApplyArtifact(Artifact{Schema: SchemaFull}, Options{})
|
||||
assertErrorContains(t, err, "full artifact payload is missing")
|
||||
}
|
||||
|
||||
func TestConvertArtifactRejectsMissingPayloadWhenConversionRequested(t *testing.T) {
|
||||
_, err := ConvertArtifact(Artifact{Schema: SchemaFull}, SchemaMinimal)
|
||||
assertErrorContains(t, err, "full artifact payload is missing")
|
||||
}
|
||||
|
||||
func TestConvertArtifactSameSchemaDoesNotRequirePayload(t *testing.T) {
|
||||
artifact := Artifact{Schema: SchemaFull}
|
||||
converted, err := ConvertArtifact(artifact, SchemaFull)
|
||||
if err != nil {
|
||||
t.Fatalf("convert failed: %v", err)
|
||||
}
|
||||
if converted.Schema != SchemaFull {
|
||||
t.Fatalf("schema = %q, want %q", converted.Schema, SchemaFull)
|
||||
}
|
||||
if converted.Full != nil {
|
||||
t.Fatalf("full payload = %#v, want nil", converted.Full)
|
||||
}
|
||||
}
|
||||
|
||||
func mustMarshalJSON(t *testing.T, value any) []byte {
|
||||
t.Helper()
|
||||
data, err := json.Marshal(value)
|
||||
|
||||
Reference in New Issue
Block a user