signalk-race-control 0.12.7 → 0.12.8

package/README.md

@@ -229,7 +229,9 @@ and a live projected finishing order — during and after the race.
   finishing instantly), or the current corrected-time gap if both are still racing or
   both have finished. With no boat marked self, the column instead compares everyone
   against the current **leader** (tagged accordingly), so it's never just blank.
-- **Export to Excel** — a genuine `.xlsx` snapshot of the current standings (same
+- **Export to Excel** — a genuine `.xlsx` snapshot of the current standings, with one
+  worksheet per class (each ranked on its own; boats with no class go on a "No class"
+  sheet, and a race with no classes gets a single "Results" sheet) (same
   ranking, same rows as the on-screen table: rank, boat, sail number, MMSI, TCF, start
   time, finish time, elapsed, corrected, status), with the time columns rendered in
   your browser's own timezone rather than the server's (and with the date included,

package/index.js

@@ -2400,28 +2400,12 @@ module.exports = function (app) {
       const workbook = new ExcelJS.Workbook();
       workbook.creator = 'Race Control';
       workbook.created = new Date();
-      const sheet = workbook.addWorksheet('Results');
-
-      const titleRow = sheet.addRow([race.name]);
-      sheet.mergeCells(titleRow.number, 1, titleRow.number, headers.length);
-      titleRow.getCell(1).font = { bold: true, size: 14 };
 
       const statusLine = race.stopTime
         ? `Called off ${formatLocalDateTime(race.stopTime, tz)}`
         : race.startTime
           ? `Started ${formatLocalDateTime(race.startTime, tz)}`
           : 'Not started';
-      const infoRow = sheet.addRow([statusLine]);
-      sheet.mergeCells(infoRow.number, 1, infoRow.number, headers.length);
-      infoRow.getCell(1).font = { italic: true, color: { argb: 'FF64748B' } };
-
-      sheet.addRow([]);
-
-      const headerRow = sheet.addRow(headers);
-      headerRow.font = { bold: true };
-      headerRow.eachCell((cell) => {
-        cell.fill = { type: 'pattern', pattern: 'solid', fgColor: { argb: 'FFE2E8F0' } };
-      });
 
       // Real Excel date/time values in Start/Finish (shifted the same way
       // formatLocalDateTime above does, to display as the exporting
@@ -2435,43 +2419,92 @@ module.exports = function (app) {
       // that would just sit there, wrong, once the file is reopened later.
       const dateNumFmt = race.multiDay ? 'yyyy-mm-dd hh:mm:ss' : 'hh:mm:ss';
       const durationNumFmt = '[h]:mm:ss';
-      ranked.forEach((r, i) => {
-        const status = r.boat.dns
-          ? 'DNS'
-          : r.boat.dnf
-            ? 'DNF'
-            : r.boat.finishTime
-              ? 'Finished'
-              : race.startTime
-                ? 'Racing'
-                : 'Not started';
-        const rankLabel = r.boat.dns ? 'DNS' : r.boat.dnf ? 'DNF' : r.rankMs != null ? i + 1 : '';
-        const start = effectiveStartTime(race, r.boat);
-        const startDate = start != null ? new Date(start - tz * 60000) : null;
-        const finishDate = r.boat.finishTime != null ? new Date(r.boat.finishTime - tz * 60000) : null;
-        const rowNum = headerRow.number + 1 + i;
-        const row = sheet.addRow([
-          rankLabel,
-          r.boat.name,
-          r.boat.sailNumber || '',
-          r.boat.mmsi || '',
-          r.boat.tcf,
-          startDate,
-          finishDate,
-          { formula: `IF(OR(F${rowNum}="",G${rowNum}=""),"",G${rowNum}-F${rowNum})` },
-          { formula: `IF(H${rowNum}="","",H${rowNum}*E${rowNum})` },
-          status
-        ]);
-        row.getCell(6).numFmt = dateNumFmt;
-        row.getCell(7).numFmt = dateNumFmt;
-        row.getCell(8).numFmt = durationNumFmt;
-        row.getCell(9).numFmt = durationNumFmt;
-      });
 
-      const widths = [7, 24, 12, 12, 8, race.multiDay ? 17 : 12, race.multiDay ? 17 : 12, 12, 12, 12];
-      widths.forEach((w, i) => {
-        sheet.getColumn(i + 1).width = w;
-      });
+      // One worksheet per class, each ranked on its own (the global order
+      // from rankedBoatList is preserved within a class, so DNF/DNS/unranked
+      // boats still trail). A race with no classes keeps the single
+      // "Results" sheet.
+      const usedSheetNames = new Set();
+      const uniqueSheetName = (raw) => {
+        // Excel sheet names: max 31 chars, none of : \ / ? * [ ], unique.
+        const base = (String(raw).replace(/[:\\/?*\[\]]/g, ' ').replace(/\s+/g, ' ').trim() || 'Class').slice(0, 31);
+        let name = base;
+        for (let n = 2; usedSheetNames.has(name.toLowerCase()); n++) {
+          const suffix = ` (${n})`;
+          name = base.slice(0, 31 - suffix.length) + suffix;
+        }
+        usedSheetNames.add(name.toLowerCase());
+        return name;
+      };
+
+      const addResultsSheet = (sheetName, title, entries) => {
+        const sheet = workbook.addWorksheet(uniqueSheetName(sheetName));
+
+        const titleRow = sheet.addRow([title]);
+        sheet.mergeCells(titleRow.number, 1, titleRow.number, headers.length);
+        titleRow.getCell(1).font = { bold: true, size: 14 };
+
+        const infoRow = sheet.addRow([statusLine]);
+        sheet.mergeCells(infoRow.number, 1, infoRow.number, headers.length);
+        infoRow.getCell(1).font = { italic: true, color: { argb: 'FF64748B' } };
+
+        sheet.addRow([]);
+
+        const headerRow = sheet.addRow(headers);
+        headerRow.font = { bold: true };
+        headerRow.eachCell((cell) => {
+          cell.fill = { type: 'pattern', pattern: 'solid', fgColor: { argb: 'FFE2E8F0' } };
+        });
+
+        entries.forEach((r, i) => {
+          const status = r.boat.dns
+            ? 'DNS'
+            : r.boat.dnf
+              ? 'DNF'
+              : r.boat.finishTime
+                ? 'Finished'
+                : race.startTime
+                  ? 'Racing'
+                  : 'Not started';
+          const rankLabel = r.boat.dns ? 'DNS' : r.boat.dnf ? 'DNF' : r.rankMs != null ? i + 1 : '';
+          const start = effectiveStartTime(race, r.boat);
+          const startDate = start != null ? new Date(start - tz * 60000) : null;
+          const finishDate = r.boat.finishTime != null ? new Date(r.boat.finishTime - tz * 60000) : null;
+          const rowNum = headerRow.number + 1 + i;
+          const row = sheet.addRow([
+            rankLabel,
+            r.boat.name,
+            r.boat.sailNumber || '',
+            r.boat.mmsi || '',
+            r.boat.tcf,
+            startDate,
+            finishDate,
+            { formula: `IF(OR(F${rowNum}="",G${rowNum}=""),"",G${rowNum}-F${rowNum})` },
+            { formula: `IF(H${rowNum}="","",H${rowNum}*E${rowNum})` },
+            status
+          ]);
+          row.getCell(6).numFmt = dateNumFmt;
+          row.getCell(7).numFmt = dateNumFmt;
+          row.getCell(8).numFmt = durationNumFmt;
+          row.getCell(9).numFmt = durationNumFmt;
+        });
+
+        const widths = [7, 24, 12, 12, 8, race.multiDay ? 17 : 12, race.multiDay ? 17 : 12, 12, 12, 12];
+        widths.forEach((w, i) => {
+          sheet.getColumn(i + 1).width = w;
+        });
+      };
+
+      const classes = race.classes || [];
+      if (!classes.length) {
+        addResultsSheet('Results', race.name, ranked);
+      } else {
+        classes.forEach((cls) => {
+          addResultsSheet(cls.name, `${race.name} — ${cls.name}`, ranked.filter((r) => r.boat.classId === cls.id));
+        });
+        const unclassed = ranked.filter((r) => !r.boat.classId);
+        if (unclassed.length) addResultsSheet('No class', `${race.name} — No class`, unclassed);
+      }
 
       const safeName = (race.name || 'race').replace(/[^a-z0-9\-_]+/gi, '_').slice(0, 60) || 'race';
       res.setHeader('Content-Type', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "signalk-race-control",
-  "version": "0.12.7",
+  "version": "0.12.8",
   "description": "SignalK plugin and webapp for tracking elapsed and handicap-corrected (Time-on-Time) race time, with a per-boat editable TCF and boat names pulled from AIS when available.",
   "main": "index.js",
   "author": "Joachim Bakke <github@heiamoss.com>",

package/test/plugin.test.js

@@ -326,3 +326,83 @@ describe('/overpass proxy — falls back across mirrors', () => {
     assert.deepEqual(res.body.elements, []);
   });
 });
+
+describe('GET /races/:id/export.xlsx — split by class', () => {
+  const ExcelJS = require('exceljs');
+  const { Writable } = require('node:stream');
+  let plugin;
+  let router;
+
+  before(() => {
+    const dataDir = fs.mkdtempSync(path.join(os.tmpdir(), 'race-control-test-'));
+    plugin = pluginFactory(makeApp(dataDir));
+    plugin.start({});
+    router = makeRouter();
+    plugin.registerWithRouter(router);
+  });
+
+  after(() => {
+    plugin.stop();
+  });
+
+  // The export streams a workbook into `res`; collect it and re-read it.
+  async function exportWorkbook(raceId) {
+    const route = router._routes.find((r) => r.method === 'GET' && r.pattern.test(`/races/${raceId}/export.xlsx`));
+    const chunks = [];
+    const res = new Writable({
+      write(chunk, _enc, cb) {
+        chunks.push(Buffer.from(chunk));
+        cb();
+      }
+    });
+    res.setHeader = () => {};
+    res.status = () => res;
+    res.json = () => {};
+    const done = new Promise((resolve) => res.on('finish', resolve));
+    await route.handler({ params: { id: raceId }, query: { tzOffsetMinutes: '0' }, body: {} }, res);
+    await done;
+    const wb = new ExcelJS.Workbook();
+    await wb.xlsx.load(Buffer.concat(chunks));
+    return wb;
+  }
+
+  const boatNames = (sheet) => {
+    const names = [];
+    sheet.eachRow((row, n) => {
+      if (n > 4) names.push(row.getCell(2).value);
+    });
+    return names;
+  };
+
+  test('a race with no classes exports a single Results sheet', async () => {
+    const created = await call(router, 'POST', '/races', { body: { name: 'Plain' } });
+    const id = created.body.race.id;
+    await call(router, 'POST', `/races/${id}/boats`, { body: { name: 'Alpha' } });
+    const wb = await exportWorkbook(id);
+    assert.deepEqual(wb.worksheets.map((w) => w.name), ['Results']);
+    assert.deepEqual(boatNames(wb.getWorksheet('Results')), ['Alpha']);
+  });
+
+  test('a race with classes exports one sheet per class, ranked within it', async () => {
+    const created = await call(router, 'POST', '/races', { body: { name: 'Split' } });
+    const id = created.body.race.id;
+    const classA = (await call(router, 'POST', `/races/${id}/classes`, { body: { name: 'Cruisers' } })).body.classes[0];
+    const classes = (await call(router, 'POST', `/races/${id}/classes`, { body: { name: 'Racers: 1/2' } })).body.classes;
+    const classB = classes[1];
+    const add = async (name, classId) => {
+      const b = (await call(router, 'POST', `/races/${id}/boats`, { body: { name } })).body;
+      if (classId) await call(router, 'PUT', `/races/${id}/boats/${b.id}/class`, { body: { classId } });
+    };
+    await add('A1', classA.id);
+    await add('A2', classA.id);
+    await add('B1', classB.id);
+    await add('Loner', null);
+
+    const wb = await exportWorkbook(id);
+    assert.deepEqual(wb.worksheets.map((w) => w.name), ['Cruisers', 'Racers 1 2', 'No class']);
+    assert.deepEqual(boatNames(wb.getWorksheet('Cruisers')).sort(), ['A1', 'A2']);
+    assert.deepEqual(boatNames(wb.getWorksheet('Racers 1 2')), ['B1']);
+    assert.deepEqual(boatNames(wb.getWorksheet('No class')), ['Loner']);
+    assert.match(wb.getWorksheet('Cruisers').getCell(1, 1).value, /Split — Cruisers/);
+  });
+});