signalk-charts-provider-simple 2.1.0 → 2.2.0

package/README.md

@@ -125,7 +125,7 @@ systemctl --user enable --now podman.socket
 
 The plugin uses one combined image that `signalk-container` pulls automatically on first conversion:
 
-- `ghcr.io/dirkwa/signalk-charts-provider-simple/charts-toolbox:1.0.0` — GDAL + tippecanoe + tile-join + helpers in a single image (multi-arch: amd64 + arm64). The plugin pins to a specific `:VERSION` tag rather than `:latest` so a published image tag is permanent for any host that pulled it; bumping the toolbox image is a co-ordinated edit of `docker/charts-toolbox/VERSION` and the matching constant in `src/utils/container-images.ts`.
+- `ghcr.io/dirkwa/signalk-charts-provider-simple/charts-toolbox:1.1.0` — GDAL + tippecanoe + tile-join + helpers in a single image (multi-arch: amd64 + arm64). The plugin pins to a specific `:VERSION` tag rather than `:latest` so a published image tag is permanent for any host that pulled it; bumping the toolbox image is a co-ordinated edit of `docker/charts-toolbox/VERSION` and the matching constant in `src/utils/container-images.ts`.
 
 **Why `signalk-container`?** It transparently handles the three deployment topologies that 1.x got wrong:
 
@@ -144,7 +144,7 @@ The same `charts-toolbox` image the plugin uses internally is also available for
 Pull it directly from GHCR:
 
 ```bash
-docker pull ghcr.io/dirkwa/signalk-charts-provider-simple/charts-toolbox:1.0.0
+docker pull ghcr.io/dirkwa/signalk-charts-provider-simple/charts-toolbox:1.1.0
 ```
 
 See [docs/charts-toolbox-image.md](docs/charts-toolbox-image.md) for a quickstart, the `--user` / `--userns=keep-id` flag forms per runtime, and reproducibility notes.

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAQ,MAAM,qBAAqB,CAAC;AAiExD,OAAO,KAAK,EACV,iBAAiB,EAQlB,MAAM,YAAY,CAAC;AAcpB,QAAA,MAAM,iBAAiB,GAAI,KAAK,iBAAiB,KAAG,MAwyFnD,CAAC;AAiHF,eAAe,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAQ,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAuExD,OAAO,KAAK,EAGV,iBAAiB,EAMlB,MAAM,YAAY,CAAC;AAepB,QAAA,MAAM,iBAAiB,GAAI,KAAK,iBAAiB,KAAG,MA+0FnD,CAAC;AAiHF,eAAe,iBAAiB,CAAC"}

package/dist/index.js

@@ -1,29 +1,28 @@
-import path from 'path';
+import { SKVersion } from '@signalk/server-api';
+import { Type } from '@sinclair/typebox';
+import Busboy from 'busboy';
 import fs from 'fs';
 import https from 'https';
-import { SKVersion } from '@signalk/server-api';
+import { DatabaseSync } from 'node:sqlite';
+import path from 'path';
 import { findCharts, findRepairableCharts } from './charts-loader.js';
-import { scanChartsRecursively, scanAllFolders } from './utils/file-scanner.js';
+import { checkForUpdates, classifyUrl, fetchCatalog, fetchCatalogRegistry, getCachedCatalog, getCatalogRegistry, getCatalogsWithInstalledCharts, getConvertingCharts, getConvertingCount, getInstalledCatalogCharts, getRegistryStatus, initCatalogManager, pruneStaleInstalls, removeInstall, removeInstallByFilename, renameInstallFilename, rollbackInstall, setConvertingState, setInstallFilename, trackInstall } from './utils/catalog-manager.js';
+import { cleanCatalogTitle } from './utils/catalog-title.js';
 import { initChartState, isChartEnabled, setChartEnabled } from './utils/chart-state.js';
-import { downloadManager } from './utils/download-manager.js';
-import { initCatalogManager, getCatalogRegistry, fetchCatalog, getCachedCatalog, classifyUrl, trackInstall, setInstallFilename, renameInstallFilename, removeInstall, removeInstallByFilename, getInstalledCatalogCharts, pruneStaleInstalls, setConvertingState, getConvertingCharts, getConvertingCount, checkForUpdates, getCatalogsWithInstalledCharts } from './utils/catalog-manager.js';
-import { initS57Converter, processS57Zip, getAllConversionProgress as getAllS57Progress, getConversionProgress as getS57Progress, setConversionFailed as setS57Failed } from './utils/s57-converter.js';
-import { getContainerManager, waitForContainerManager } from './utils/container-manager.js';
+import { getCpuBudget, setCpuBudget } from './utils/concurrency.js';
 import { PLUGIN_OWNER_ID } from './utils/container-jobs.js';
-import { cleanupQuarantineDir, makeQuarantineDir, promoteQuarantine, sweepStaleQuarantineDirs } from './utils/quarantine.js';
-import { cleanCatalogTitle } from './utils/catalog-title.js';
-import { setMbtilesDisplayName, repairMbtilesMetadata } from './utils/mbtiles-metadata.js';
+import { getContainerManager, waitForContainerManager } from './utils/container-manager.js';
+import { downloadManager } from './utils/download-manager.js';
+import { scanAllFolders, scanChartsRecursively } from './utils/file-scanner.js';
+import { repairMbtilesMetadata, setMbtilesDisplayName } from './utils/mbtiles-metadata.js';
 import { open as openMbtilesReader } from './utils/mbtiles-reader.js';
-import { initRncConverter, processRncZip, processPilotTar, getAllConversionProgress as getAllRncProgress, getConversionProgress as getRncProgress, setConversionFailed as setRncFailed } from './utils/rnc-converter.js';
-import { processGshhg, processShpBasemap } from './utils/s57-converter.js';
-import { getCpuBudget, setCpuBudget } from './utils/concurrency.js';
 import { writeChartPathMarker } from './utils/path-marker.js';
+import { arePairWithinBase, isWithinBase, validateChartName } from './utils/path-safety.js';
 import { parsePluginConfig } from './utils/plugin-config-schema.js';
-import { Type } from '@sinclair/typebox';
+import { cleanupQuarantineDir, makeQuarantineDir, promoteQuarantine, sweepStaleQuarantineDirs } from './utils/quarantine.js';
 import { parseBody, parseShape } from './utils/rest-validation.js';
-import { isWithinBase, arePairWithinBase, validateChartName } from './utils/path-safety.js';
-import Busboy from 'busboy';
-import { DatabaseSync } from 'node:sqlite';
+import { getAllConversionProgress as getAllRncProgress, getConversionProgress as getRncProgress, initRncConverter, processPilotTar, processRncZip, setConversionFailed as setRncFailed } from './utils/rnc-converter.js';
+import { getAllConversionProgress as getAllS57Progress, getConversionProgress as getS57Progress, initS57Converter, processGshhg, processS57Zip, processShpBasemap, setConversionFailed as setS57Failed } from './utils/s57-converter.js';
 // JSON import with type attribute (NodeNext ESM). package.json's `version`
 // is what the marker file records so users can confirm the running build.
 import packageJson from '../package.json' with { type: 'json' };
@@ -320,7 +319,14 @@ const pluginConstructor = (app) => {
                             `rolling back chart ${chartNumber ?? '<unknown>'}`);
                         if (chartNumber) {
                             setConvertingState(chartNumber, false);
-                            removeInstall(chartNumber);
+                            // A restart/crash can land here mid-update. rollbackInstall
+                            // restores the prior on-disk version (UPDATE) or drops the
+                            // pending record (FRESH), reading the snapshot trackInstall
+                            // persisted in the record — so a still-pending update keeps
+                            // surfacing in checkForUpdates(). For a committed record (no
+                            // snapshot marker) it's a no-op, so a spurious reap of an
+                            // already-installed chart doesn't delete it.
+                            rollbackInstall(chartNumber);
                         }
                     }
                     if (cleanup.reaped.length > 0) {
@@ -1467,13 +1473,43 @@ const pluginConstructor = (app) => {
                 const registry = getCatalogRegistry();
                 const installed = getInstalledCatalogCharts();
                 const convertingCharts = getConvertingCharts();
-                res.json({ registry, installed, converting: convertingCharts });
+                res.json({
+                    registry,
+                    installed,
+                    converting: convertingCharts,
+                    registryStatus: getRegistryStatus()
+                });
             }
             catch (error) {
                 console.error('Error fetching catalog registry:', error);
                 res.status(500).json({ error: 'Failed to fetch catalog registry' });
             }
         });
+        // Force a re-fetch of the catalog index from GitHub (the Refresh button).
+        // Awaits the fetch so the response reflects the just-attempted result, but
+        // swallows the rejection — registryStatus carries the reason (rate-limited
+        // / offline / error) so the UI can message accurately.
+        router.post('/catalog-registry/refresh', (_req, res) => {
+            void (async () => {
+                try {
+                    await fetchCatalogRegistry().catch((err) => {
+                        app.debug(`Catalog registry refresh failed: ${err instanceof Error ? err.message : String(err)}`);
+                    });
+                    res.json({
+                        registry: getCatalogRegistry(),
+                        installed: getInstalledCatalogCharts(),
+                        converting: getConvertingCharts(),
+                        registryStatus: getRegistryStatus()
+                    });
+                }
+                catch (error) {
+                    // The refresh itself is awaited+swallowed above; this only fires if
+                    // building the response throws.
+                    console.error('Error building catalog refresh response:', error);
+                    res.status(500).json({ error: 'Failed to build catalog refresh response' });
+                }
+            })();
+        });
         router.get('/catalog-s57-status', (_req, res) => {
             // Runtime info is owned by signalk-container in 2.0+; we report
             // whatever its manager exposes.  Available = manager present AND
@@ -1791,14 +1827,14 @@ const pluginConstructor = (app) => {
                         void (async () => {
                             try {
                                 if (!job.extractedFiles || job.extractedFiles.length === 0) {
-                                    removeInstall(chartNumber);
+                                    rollbackInstall(chartNumber);
                                     app.debug(`Removed catalog tracking for ${chartNumber}: no .mbtiles extracted`);
                                     return;
                                 }
                                 if (job.status !== 'completed') {
                                     // Failed downloads leak nothing into the live target;
                                     // the quarantine wipe in `finally` handles cleanup.
-                                    removeInstall(chartNumber);
+                                    rollbackInstall(chartNumber);
                                     return;
                                 }
                                 try {
@@ -1806,7 +1842,7 @@ const pluginConstructor = (app) => {
                                 }
                                 catch (promoteErr) {
                                     app.error(`Promotion failed for ${chartNumber}: ${promoteErr instanceof Error ? promoteErr.message : String(promoteErr)}`);
-                                    removeInstall(chartNumber);
+                                    rollbackInstall(chartNumber);
                                     return;
                                 }
                                 // The global `job-completed` handler enables charts and
@@ -1890,7 +1926,7 @@ const pluginConstructor = (app) => {
             const zipPath = zipFileName ? path.join(tmpDownloadDir, zipFileName) : null;
             if (!zipPath || !fs.existsSync(zipPath)) {
                 app.debug(`S-57: no ZIP file found after download for ${chartNumber}`);
-                removeInstall(chartNumber);
+                rollbackInstall(chartNumber);
                 cleanupDir(tmpDownloadDir);
                 return;
             }
@@ -1937,7 +1973,7 @@ const pluginConstructor = (app) => {
             }
             catch (convError) {
                 app.error(`S-57 conversion failed for ${chartNumber}: ${convError instanceof Error ? convError.message : String(convError)}`);
-                removeInstall(chartNumber);
+                rollbackInstall(chartNumber);
                 setConvertingState(chartNumber, false);
                 if (quarantineDir !== null) {
                     cleanupQuarantineDir(quarantineDir);
@@ -1951,7 +1987,7 @@ const pluginConstructor = (app) => {
             }
             downloadManager.removeListener('job-completed', s57Listener);
             downloadManager.removeListener('job-failed', s57FailListener);
-            removeInstall(chartNumber);
+            rollbackInstall(chartNumber);
             setConvertingState(chartNumber, false);
             setS57Failed(chartNumber, job.error ?? 'Download failed');
             cleanupDir(tmpDownloadDir);
@@ -1978,7 +2014,7 @@ const pluginConstructor = (app) => {
             const zipPath = zipFileName ? path.join(tmpDownloadDir, zipFileName) : null;
             if (!zipPath || !fs.existsSync(zipPath)) {
                 app.debug(`RNC: no file found after download for ${chartNumber}`);
-                removeInstall(chartNumber);
+                rollbackInstall(chartNumber);
                 cleanupDir(tmpDownloadDir);
                 return;
             }
@@ -2020,7 +2056,7 @@ const pluginConstructor = (app) => {
             }
             catch (convError) {
                 app.error(`RNC conversion failed for ${chartNumber}: ${convError instanceof Error ? convError.message : String(convError)}`);
-                removeInstall(chartNumber);
+                rollbackInstall(chartNumber);
                 setConvertingState(chartNumber, false);
                 if (quarantineDir !== null) {
                     cleanupQuarantineDir(quarantineDir);
@@ -2034,7 +2070,7 @@ const pluginConstructor = (app) => {
             }
             downloadManager.removeListener('job-completed', rncListener);
             downloadManager.removeListener('job-failed', rncFailListener);
-            removeInstall(chartNumber);
+            rollbackInstall(chartNumber);
             setConvertingState(chartNumber, false);
             setRncFailed(chartNumber, job.error ?? 'Download failed');
             cleanupDir(tmpDownloadDir);
@@ -2060,7 +2096,7 @@ const pluginConstructor = (app) => {
             const dlFileName = job.extractedFiles?.[0] ?? job.targetFiles?.[0];
             const dlPath = dlFileName ? path.join(tmpDownloadDir, dlFileName) : null;
             if (!dlPath || !fs.existsSync(dlPath)) {
-                removeInstall(chartNumber);
+                rollbackInstall(chartNumber);
                 cleanupDir(tmpDownloadDir);
                 return;
             }
@@ -2091,7 +2127,7 @@ const pluginConstructor = (app) => {
             }
             catch (convError) {
                 app.error(`Pilot conversion failed: ${convError instanceof Error ? convError.message : String(convError)}`);
-                removeInstall(chartNumber);
+                rollbackInstall(chartNumber);
                 setConvertingState(chartNumber, false);
                 if (quarantineDir !== null) {
                     cleanupQuarantineDir(quarantineDir);
@@ -2105,7 +2141,7 @@ const pluginConstructor = (app) => {
             }
             downloadManager.removeListener('job-completed', pilotListener);
             downloadManager.removeListener('job-failed', pilotFailListener);
-            removeInstall(chartNumber);
+            rollbackInstall(chartNumber);
             setConvertingState(chartNumber, false);
             setRncFailed(chartNumber, job.error ?? 'Download failed');
             cleanupDir(tmpDownloadDir);
@@ -2131,7 +2167,7 @@ const pluginConstructor = (app) => {
             const dlFileName = job.extractedFiles?.[0] ?? job.targetFiles?.[0];
             const dlPath = dlFileName ? path.join(tmpDownloadDir, dlFileName) : null;
             if (!dlPath || !fs.existsSync(dlPath)) {
-                removeInstall(chartNumber);
+                rollbackInstall(chartNumber);
                 cleanupDir(tmpDownloadDir);
                 return;
             }
@@ -2158,7 +2194,7 @@ const pluginConstructor = (app) => {
             }
             catch (convError) {
                 app.error(`ShpBasemap conversion failed: ${convError instanceof Error ? convError.message : String(convError)}`);
-                removeInstall(chartNumber);
+                rollbackInstall(chartNumber);
                 setConvertingState(chartNumber, false);
                 if (quarantineDir !== null) {
                     cleanupQuarantineDir(quarantineDir);
@@ -2172,7 +2208,7 @@ const pluginConstructor = (app) => {
             }
             downloadManager.removeListener('job-completed', shpListener);
             downloadManager.removeListener('job-failed', shpFailListener);
-            removeInstall(chartNumber);
+            rollbackInstall(chartNumber);
             setConvertingState(chartNumber, false);
             cleanupDir(tmpDownloadDir);
         };
@@ -2206,7 +2242,7 @@ const pluginConstructor = (app) => {
             }
             catch (error) {
                 app.error(`GSHHG conversion failed: ${error instanceof Error ? error.message : String(error)}`);
-                removeInstall(chartNumber);
+                rollbackInstall(chartNumber);
                 setConvertingState(chartNumber, false);
                 if (quarantineDir !== null) {
                     cleanupQuarantineDir(quarantineDir);