@meri-imperiumi/signalk-passage-briefing 0.13.1 → 0.13.2

package/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## [Unreleased]
 
+## [0.13.2] - 2026-10-19
+
+### Fixed
+- Briefing refresh crashed with 502 `Cannot read properties of undefined (reading '1')` when the course provider reported the vessel navigating the briefed route while still heading to its first waypoint (`navigation.course.activeRoute.pointIndex` 0, forward — e.g. just after engaging a route): the progress trim read `raw[pointIndex - 1]` for a last passed waypoint that does not exist yet. Forward pointIndex 0 now trims to the vessel position with nothing trimmed off (`trimmedFromNm` 0), and without a known vessel position the full untrimmed plan serves.
+
 ## [0.13.1] - 2026-10-19
 
 ### Changed

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meri-imperiumi/signalk-passage-briefing",
-  "version": "0.13.1",
+  "version": "0.13.2",
   "description": "Offshore passage daily briefing webapp for Signal K",
   "main": "plugin/index.js",
   "scripts": {

package/plugin/index.js

@@ -564,12 +564,25 @@ module.exports = (app) => {
     ) {
       return null; // Not past the first point, or an index we cannot use
     }
+    const target = raw[pointIndex];
+    const vessel = vesselPosition();
+    // Heading to the first waypoint (forward pointIndex 0): no leg of
+    // the plan is behind the boat, so there is no last passed waypoint
+    // to anchor the trim distance on. The plan starts at the vessel
+    // when known (nothing trimmed off, 0 nm in), else serves in full.
+    if (!reverse && pointIndex === 0) {
+      if (!vessel) {
+        return null;
+      }
+      return {
+        coordinates: [[vessel.lon, vessel.lat], ...raw],
+        trimmedFromNm: 0,
+      };
+    }
     // Travel order decides what remains: forward navigates toward
     // higher indices, reverse toward lower ones (the course provider's
     // `reverse` flag). The start point is the vessel's actual position
     // when available, else the last passed waypoint.
-    const target = raw[pointIndex];
-    const vessel = vesselPosition();
     const start = vessel
       ? [vessel.lon, vessel.lat]
       : reverse
@@ -579,7 +592,8 @@ module.exports = (app) => {
       ? raw.slice(0, pointIndex + 1).reverse()
       : raw.slice(pointIndex);
     // Distance along the stored plan from its start to the trim point:
-    // the boat sits between the target and the last passed point
+    // the boat sits between the target and the last passed point (the
+    // forward pointIndex 0 case returned above, so this is defined)
     const reference = reverse ? target : raw[pointIndex - 1];
     const anchorSlice = reverse
       ? raw.slice(0, pointIndex + 1)

package/tests/plugin.test.js

@@ -2802,6 +2802,61 @@ test("route progress: briefing trims to the sailed legs (work doc #28)", async (
       revPayload.trimmedFromNm > 55 && revPayload.trimmedFromNm < 65,
       `reversed trimmedFromNm ${revPayload.trimmedFromNm}`,
     );
+
+    // Just engaged, heading to the first waypoint (pointIndex 0): no
+    // waypoint is behind the boat, so the plan starts at the vessel
+    // with nothing trimmed off. Regression: the trim used to read
+    // raw[-1] and crashed the refresh with "Cannot read properties of
+    // undefined (reading '1')" (502 on /api/briefing/refresh)
+    app.getSelfPath = (path) =>
+      path === "navigation.position"
+        ? { latitude: -0.05, longitude: 0 }
+        : path === "navigation.course.activeRoute"
+          ? {
+              href: "/resources/routes/r1",
+              pointIndex: 0,
+            }
+          : null;
+    const engagedRes = await call("/api/briefing/refresh", {
+      query: { route: "r1" },
+    });
+    assert.equal(
+      engagedRes.code,
+      null,
+      `engaged refresh: ${JSON.stringify(engagedRes.payload)}`,
+    );
+    const engaged = await call("/api/briefing", { query: { route: "r1" } });
+    const engagedPayload = engaged.payload.payload;
+    assert.ok(
+      Math.abs(engagedPayload.waypoints[0].lat + 0.05) < 0.01,
+      `engaged start ${engagedPayload.waypoints[0].lat}`,
+    );
+    assert.equal(engagedPayload.trimmedFromNm, 0);
+    // The full plan follows the boat: last waypoint is the route end
+    assert.ok(
+      Math.abs(engagedPayload.waypoints.at(-1).lat - 1.5) < 0.01,
+      `engaged end ${engagedPayload.waypoints.at(-1).lat}`,
+    );
+
+    // Same pointIndex 0 but no vessel position: no anchor for the
+    // start — the full plan serves untrimmed
+    app.getSelfPath = (path) =>
+      path === "navigation.position"
+        ? null
+        : path === "navigation.course.activeRoute"
+          ? {
+              href: "/resources/routes/r1",
+              pointIndex: 0,
+            }
+          : null;
+    await call("/api/briefing/refresh", { query: { route: "r1" } });
+    const untrimmed = await call("/api/briefing", { query: { route: "r1" } });
+    const untrimmedPayload = untrimmed.payload.payload;
+    assert.ok(
+      Math.abs(untrimmedPayload.waypoints[0].lat) < 0.01,
+      `untrimmed start ${untrimmedPayload.waypoints[0].lat}`,
+    );
+    assert.equal(untrimmedPayload.trimmedFromNm, undefined);
   } finally {
     globalThis.fetch = originalFetch;
   }