Skip to content

Retire v1 .bww format migration shim (introduced in #282) #283

Open

Description

@thomas-stegemann

Background

#282 unifies the .bww workspace export format on a v2 canonical schema. To stay non-breaking through v2.x, both reader paths (UI / CLI) ship migration shims that detect and read the legacy v1 shapes (UI-shape + CLI-shape) and rewrite them as v2 in-memory before the rest of the import pipeline runs.

The migration shims live at:

  • prologue.js importWorkspaceJson — detects legacy v1-UI envelope (format/version/workspace/data) and legacy v1-CLI envelope (workspaceFormatVersion + per-kind arrays); routes both into the v2 reader.
  • WorkspaceCommand.cs RunImportAsync — same detection on the .NET side.

Goal for v3.0.0

Cut the shims. Importers reject anything that isn't v2 with a clear error pointing at the v2.x version that could read + re-export it. v3 ships only the canonical v2 (renamed v3 if we bump again) schema.

Acceptance

  • Remove _isLegacyV1UiShape / _isLegacyV1CliShape detection branches from prologue.js
  • Remove the equivalent detection branches from WorkspaceCommand.cs RunImportAsync
  • Importer rejects v1 shapes with: 'Unsupported format. Re-export via Bowire v2.x or later (which migrates v1 → v2 on the fly).'
  • Schema doc (docs/format/bowire-workspace.md) drops the v1 migration table; describes v2 only
  • release-notes/v3.0.0.md flags this as a breaking change in the 'Breaking changes' section
  • Round-trip test that previously verified v1-UI → v2 + v1-CLI → v2 migrations gets removed (or moved to a 'pre-v3 fixtures' archive directory for reference)

Migration path for users

Anyone still on a v1 .bww file needs to open it once in v2.x (any patch release) and re-export — the v2.x writer always emits v2. Once re-exported, the file is forever-readable.

That window is the v2.x lifetime. v2.1 + v2.2 + v2.3 + v2.4 + v2.5 all carry the migration shim. By the time v3 arrives the v2 format will be the only one in real-world use.

Composes with #282 — that ticket adds the shim; this one removes it.

Activity

  1. added 2 commits that reference this issue on Jun 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

No labels
No labels

Type

Projects

  • Status
    Backlog

Relationships

None yet

Development

No branches or pull requests

Issue actions