trails-cool/trails
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
trails/openspec/changes/planner-route-encoding/tasks.md
Ullrich Schäfer d933cca451
docs(openspec): propose planner-route-encoding change 
Follow-up to the planner WS reconnect-loop incident. Proposes compactly
encoding the computed route in the Yjs session doc (single-source geometry
+ delta/varint polyline + run-length-encoded road metadata, dual-format
backward-compatible reads) to cut a ~305 KB / 77 km route to ~40–60 KB —
WITHOUT changing the routing-host "compute once, share via Yjs" model or
GPX export output.

Artifacts: proposal, design, specs (new planner-route-encoding
capability), tasks. Validates --strict. Ready for /opsx:apply.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-14 09:31:58 +02:00

2.4 KiB
Raw Blame History

1. Codec primitives

  • 1.1 Add a framework-free codec in @trails-cool/map-core (e.g. route-codec.ts): encodePolyline(coords: [lon,lat][]) -> string / decodePolyline(str) -> [lon,lat][] using fixed-precision (1e5) delta + zig-zag varint + base64, with a version tag
  • 1.2 Add encodeRuns(values: string[]) -> string / decodeRuns(str, length?) -> string[] run-length codec for the road-metadata channels
  • 1.3 Unit tests: polyline round-trip within ~1 m over random + real fixtures; empty/single-point; RLE round-trip incl. all-same, all-distinct, and a realistic run pattern

2. Write path (new encoding)

  • 2.1 In route-data.ts writeComputedRoute: store geometry once as encodePolyline(coordinates) (drop the separate geojson write); write each ROAD_METADATA_KEYS channel via encodeRuns; keep segmentBoundaries + profile
  • 2.2 Add a readGeojson(routeData) helper that assembles the GeoJSON LineString from decoded coordinates (so callers that needed geojson no longer read a stored copy)

3. Read path (dual-format, backward compatible)

  • 3.1 In route-data.ts read helpers (readComputedRoute, readRoadMetadata, coordinate accessors): detect format per key (encoding version tag/sentinel → new decoder; else JSON.parse legacy) and return the same decoded shapes as today
  • 3.2 Point every reader (SessionView map render, elevation profile, GPX export, save-to-journal, road-type/surface coloring) at the helpers; confirm none reads a raw routeData.get("geojson"|"coordinates"|<metadata>) directly
  • 3.3 Tests: a legacy-format routeData decodes correctly through the helpers; a new-format one decodes correctly; both yield identical reader-facing data

4. Verification

  • 4.1 GPX-export golden test: export the same route via legacy and new encoding → byte-identical output
  • 4.2 Size assertion on a realistic route fixture (e.g. the ~77 km / multi-waypoint case): new-encoded Y.encodeStateAsUpdate size is ≥~4× smaller than legacy and a small fraction of MAX_DOC_BYTES
  • 4.3 Confirm routing-host election / BRouter usage unchanged (no client recompute); pnpm --filter @trails-cool/planner --filter @trails-cool/map-core typecheck && lint && test, full pnpm test
  • 4.4 Manual/e2e sanity: open a fresh session, add several waypoints, confirm route renders + colors + exports; reload a session persisted in the legacy format and confirm it still works