signalk-charts-provider-simple 2.4.0 → 2.4.2

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAQ,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAqHxD,OAAO,KAAK,EACV,aAAa,EAEb,iBAAiB,EAIjB,QAAQ,EAET,MAAM,YAAY,CAAC;AAepB,QAAA,MAAM,iBAAiB,GAAI,KAAK,iBAAiB,KAAG,MAs6GnD,CAAC;AA4GF,eAAO,MAAM,oBAAoB,GAC/B,KAAK,QAAQ,EACb,UAAU,aAAa,EACvB,GAAG,MAAM,EACT,GAAG,MAAM,EACT,GAAG,MAAM,KACR,IAiDF,CAAC;AAEF,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;AAsHxD,OAAO,KAAK,EACV,aAAa,EAEb,iBAAiB,EAIjB,QAAQ,EAET,MAAM,YAAY,CAAC;AAwBpB,QAAA,MAAM,iBAAiB,GAAI,KAAK,iBAAiB,KAAG,MA49GnD,CAAC;AA4GF,eAAO,MAAM,oBAAoB,GAC/B,KAAK,QAAQ,EACb,UAAU,aAAa,EACvB,GAAG,MAAM,EACT,GAAG,MAAM,EACT,GAAG,MAAM,KACR,IAiDF,CAAC;AAEF,eAAe,iBAAiB,CAAC"}

package/dist/index.js

@@ -21,7 +21,7 @@ import { writeChartPathMarker } from './utils/path-marker.js';
 import { getBlankTileReplacement, getOverzoomedTile } from './utils/tile-overzoom.js';
 import { arePairWithinBase, classifyChartDirAccess, hasHostChartsMountEnv, isHostMountPath, isWithinBase, resolveDefaultChartsPath, validateChartName } from './utils/path-safety.js';
 import { parsePluginConfig } from './utils/plugin-config-schema.js';
-import { cleanupQuarantineDir, makeQuarantineDir, promoteQuarantine, sweepStaleQuarantineDirs } from './utils/quarantine.js';
+import { cleanupQuarantineDir, makeQuarantineDir, makeUniqueQuarantineDir, promoteQuarantine, sweepStaleQuarantineDirs } from './utils/quarantine.js';
 import { parseBody, parseShape } from './utils/rest-validation.js';
 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, processS57Directory, processS57Zip, processShpBasemap, setConversionFailed as setS57Failed } from './utils/s57-converter.js';
@@ -32,6 +32,14 @@ import { downloadAndExtractEncs } from './utils/custom-catalog-download.js';
 // is what the marker file records so users can confirm the running build.
 import packageJson from '../package.json' with { type: 'json' };
 const pluginVersion = packageJson.version;
+// The startup-global 'job-completed' handler is re-registered on every
+// start() because its closure captures the current chartPath. Track the
+// previous instance (module scope, like downloadManager itself) so
+// re-registration removes exactly that handler — a blanket
+// removeAllListeners('job-completed') would also strip the per-job
+// promotion/cleanup listeners of downloads still running from a prior
+// plugin lifecycle, stranding their files in the quarantine.
+let globalJobCompletedListener = null;
 // Single source of truth lives in container-jobs.ts as PLUGIN_OWNER_ID
 // (used as the `ownerPluginId` label on every runJob call). The plugin
 // id Signal K uses must match exactly so `cleanupOrphanedJobs` reaps
@@ -403,8 +411,10 @@ const pluginConstructor = (app) => {
             }
         }
         startCatalogUpdateChecker();
-        downloadManager.removeAllListeners('job-completed');
-        downloadManager.on('job-completed', (job) => {
+        if (globalJobCompletedListener) {
+            downloadManager.removeListener('job-completed', globalJobCompletedListener);
+        }
+        globalJobCompletedListener = (job) => {
             app.debug(`Download job completed: ${job.id}, extracted files: ${job.extractedFiles.join(', ')}`);
             for (const fileName of job.extractedFiles) {
                 const relativePath = path.relative(chartPath, path.join(job.targetDir, fileName));
@@ -421,7 +431,8 @@ const pluginConstructor = (app) => {
                     }
                 }
             });
-        });
+        };
+        downloadManager.on('job-completed', globalJobCompletedListener);
         // Filesystem housekeeping (removing invalid .mbtiles and orphaned
         // journal/WAL files) runs independently of the display path so it can
         // never delay chart listing. It rescans the chart directory itself
@@ -616,6 +627,13 @@ const pluginConstructor = (app) => {
                         .json({ success: false, error: `Invalid chart name: ${chartNameCheck.reason}` });
                     return;
                 }
+                // Setup-failure cleanup state: if anything throws after the
+                // quarantine dir exists but before the job owns it, the catch
+                // below removes the orphan. Once createJob has returned, the
+                // job's completion/failure listeners own the dir — the catch
+                // must NOT touch it then.
+                let stagedDir = null;
+                let createdJobId = null;
                 try {
                     console.log(`Creating download job for: ${downloadUrl}`);
                     console.log(`Target folder: ${targetFolder}`);
@@ -628,11 +646,16 @@ const pluginConstructor = (app) => {
                     if (!fs.existsSync(targetDir)) {
                         fs.mkdirSync(targetDir, { recursive: true });
                     }
-                    // Stage the download in the quarantine dir; promote on
+                    // Stage the download in a per-job quarantine dir; promote on
                     // job-completed so a crash mid-fetch never leaves a partial
-                    // .mbtiles in the live chart library.
-                    const quarantineDir = makeQuarantineDir(app.getDataDirPath(), chartName);
+                    // .mbtiles in the live chart library. Per-job (unique) because
+                    // download jobs run concurrently: two downloads with the same
+                    // chart name must not share a dir, or the first to finish wipes
+                    // the workspace out from under the other mid-extraction.
+                    const quarantineDir = makeUniqueQuarantineDir(app.getDataDirPath(), chartName);
+                    stagedDir = quarantineDir;
                     const jobId = downloadManager.createJob(downloadUrl, quarantineDir, chartName);
+                    createdJobId = jobId;
                     const promoteListener = (job) => {
                         if (job.id !== jobId) {
                             return;
@@ -688,6 +711,9 @@ const pluginConstructor = (app) => {
                     });
                 }
                 catch (error) {
+                    if (stagedDir !== null && createdJobId === null) {
+                        cleanupQuarantineDir(stagedDir);
+                    }
                     console.error('Error creating download job:', error);
                     res.status(500).json({
                         success: false,
@@ -1326,7 +1352,7 @@ const pluginConstructor = (app) => {
                 // streamed here first, then atomically promoted on `finish`.
                 // A crashed/aborted request leaves the partial files in the
                 // quarantine for the startup sweep to wipe, never in basePath.
-                const quarantineDir = makeQuarantineDir(app.getDataDirPath(), `upload-${Date.now()}-${Math.random().toString(36).slice(2, 8)}`);
+                const quarantineDir = makeUniqueQuarantineDir(app.getDataDirPath(), 'upload');
                 const uploadedFiles = [];
                 const writePromises = [];
                 const fields = {};
@@ -1371,6 +1397,11 @@ const pluginConstructor = (app) => {
                             reject(err);
                         });
                     });
+                    // Observe the rejection now: Promise.all only attaches in the
+                    // 'finish' handler, which never fires on an aborted request —
+                    // a staging failure there would otherwise surface as a
+                    // process-level unhandled rejection.
+                    writePromise.catch(() => undefined);
                     writePromises.push(writePromise);
                 });
                 bb.on('finish', () => {
@@ -1433,6 +1464,23 @@ const pluginConstructor = (app) => {
                         }
                     })();
                 });
+                // An aborted request or a Busboy parse error never reaches
+                // 'finish', which owns the normal cleanup — without these the
+                // staged files stay on disk and the dir stays registered as
+                // active (so the startup sweep skips it) until a full server
+                // restart. cleanupQuarantineDir is idempotent, so a late abort
+                // racing the finish path is harmless.
+                bb.on('error', (err) => {
+                    app.error('Upload stream error: ' + (err instanceof Error ? err.message : String(err)));
+                    cleanupQuarantineDir(quarantineDir);
+                    if (!res.headersSent) {
+                        res.status(400).send('Malformed upload');
+                    }
+                });
+                req.on('aborted', () => {
+                    app.debug('Upload request aborted by client');
+                    cleanupQuarantineDir(quarantineDir);
+                });
                 req.pipe(bb);
             }
             catch (error) {
@@ -1728,7 +1776,7 @@ const pluginConstructor = (app) => {
                     // the UI stuck waiting for status it would never get.
                     let quarantineDir;
                     try {
-                        quarantineDir = makeQuarantineDir(app.getDataDirPath(), chartNumber);
+                        quarantineDir = makeUniqueQuarantineDir(app.getDataDirPath(), chartNumber);
                     }
                     catch (err) {
                         res.status(500).json({
@@ -1820,6 +1868,11 @@ const pluginConstructor = (app) => {
                 });
                 return;
             }
+            // Setup-failure cleanup state for the direct-.mbtiles branch: see
+            // the download-chart-locker route. Once createJob has returned,
+            // the job's listeners own the dir and the catch must leave it be.
+            let stagedDir = null;
+            let createdJobId = null;
             try {
                 const chartPath = props.chartPath || defaultChartsPath;
                 const targetDir = !targetFolder || targetFolder === '/' ? chartPath : path.join(chartPath, targetFolder);
@@ -1876,13 +1929,16 @@ const pluginConstructor = (app) => {
                     handleGshhgDownload(res, app, chartNumber, catalogFile, zipfileDatetime, url, targetDir, chartPath);
                 }
                 else {
-                    // Direct .mbtiles download (or ZIP-of-.mbtiles): stage into the
-                    // quarantine dir so a crash mid-download/extract never leaves a
-                    // half-built file in the live chart library. Promotion runs on
-                    // job-completed; failure / no-files paths drop the quarantine.
-                    const quarantineDir = makeQuarantineDir(app.getDataDirPath(), chartNumber);
+                    // Direct .mbtiles download (or ZIP-of-.mbtiles): stage into a
+                    // per-job quarantine dir so a crash mid-download/extract never
+                    // leaves a half-built file in the live chart library, and so a
+                    // re-download of the same chartNumber can't share (and wipe)
+                    // a still-running job's dir. Promotion runs on job-completed;
+                    // failure / no-files paths drop the quarantine.
+                    const quarantineDir = makeUniqueQuarantineDir(app.getDataDirPath(), chartNumber);
+                    stagedDir = quarantineDir;
                     const jobId = downloadManager.createJob(url, quarantineDir, chartNumber);
-                    trackInstall(chartNumber, catalogFile, zipfileDatetime ?? '', url);
+                    createdJobId = jobId;
                     const cleanupListener = (job) => {
                         if (job.id !== jobId) {
                             return;
@@ -1951,6 +2007,11 @@ const pluginConstructor = (app) => {
                     };
                     downloadManager.on('job-failed', cleanupListener);
                     downloadManager.on('job-completed', cleanupListener);
+                    // Only after the listeners own the job/quarantine lifecycle:
+                    // if this throws, the catch below must NOT touch the dir (the
+                    // listeners will promote or clean it), and nothing before the
+                    // registration above can throw once createJob has returned.
+                    trackInstall(chartNumber, catalogFile, zipfileDatetime ?? '', url);
                     app.debug(`Catalog download started: ${chartNumber} from ${catalogFile}, job: ${jobId}`);
                     res.json({
                         success: true,
@@ -1960,6 +2021,9 @@ const pluginConstructor = (app) => {
                 }
             }
             catch (error) {
+                if (stagedDir !== null && createdJobId === null) {
+                    cleanupQuarantineDir(stagedDir);
+                }
                 console.error('Error creating catalog download job:', error);
                 res.status(500).json({
                     success: false,
@@ -2205,7 +2269,7 @@ const pluginConstructor = (app) => {
             // the same cleanup as a conversion failure.
             let quarantineDir = null;
             try {
-                quarantineDir = makeQuarantineDir(app.getDataDirPath(), chartNumber);
+                quarantineDir = makeUniqueQuarantineDir(app.getDataDirPath(), chartNumber);
                 const displayName = chartTitle ? cleanCatalogTitle(chartTitle) : undefined;
                 const result = await processS57Zip(zipPath, quarantineDir, chartNumber, (status, message) => {
                     app.debug(`S-57 [${chartNumber}] ${status}: ${message}`);
@@ -2288,7 +2352,7 @@ const pluginConstructor = (app) => {
             app.debug(`Starting RNC conversion for ${chartNumber}: ${zipPath}`);
             let quarantineDir = null;
             try {
-                quarantineDir = makeQuarantineDir(app.getDataDirPath(), chartNumber);
+                quarantineDir = makeUniqueQuarantineDir(app.getDataDirPath(), chartNumber);
                 const result = await processRncZip(zipPath, quarantineDir, chartNumber, (status, message) => {
                     app.debug(`RNC [${chartNumber}] ${status}: ${message}`);
                 });
@@ -2369,7 +2433,7 @@ const pluginConstructor = (app) => {
             setConvertingState(chartNumber, true);
             let quarantineDir = null;
             try {
-                quarantineDir = makeQuarantineDir(app.getDataDirPath(), chartNumber);
+                quarantineDir = makeUniqueQuarantineDir(app.getDataDirPath(), chartNumber);
                 const result = await processPilotTar(dlPath, quarantineDir, chartNumber, (status, message) => {
                     app.debug(`Pilot [${chartNumber}] ${status}: ${message}`);
                 });
@@ -2440,7 +2504,7 @@ const pluginConstructor = (app) => {
             setConvertingState(chartNumber, true);
             let quarantineDir = null;
             try {
-                quarantineDir = makeQuarantineDir(app.getDataDirPath(), chartNumber);
+                quarantineDir = makeUniqueQuarantineDir(app.getDataDirPath(), chartNumber);
                 const result = await processShpBasemap(dlPath, quarantineDir, chartNumber, (status, message) => {
                     app.debug(`ShpBasemap [${chartNumber}] ${status}: ${message}`);
                 });
@@ -2491,7 +2555,7 @@ const pluginConstructor = (app) => {
         void (async () => {
             let quarantineDir = null;
             try {
-                quarantineDir = makeQuarantineDir(app.getDataDirPath(), chartNumber);
+                quarantineDir = makeUniqueQuarantineDir(app.getDataDirPath(), chartNumber);
                 const result = await processGshhg(tmpDir, quarantineDir, resolution, chartNumber, (status, message) => {
                     app.debug(`GSHHG [${chartNumber}] ${status}: ${message}`);
                 });
@@ -2673,7 +2737,7 @@ const pluginConstructor = (app) => {
                 }
                 setConvertingState(id, true);
                 convertingFlagged = true;
-                quarantineDir = makeQuarantineDir(app.getDataDirPath(), id);
+                quarantineDir = makeUniqueQuarantineDir(app.getDataDirPath(), id);
                 const conv = await processS57Directory(encDir, quarantineDir, id, (status, message) => setCatalogProgress(id, status, message), {
                     displayName: catalog.name,
                     displayDescription: `Custom catalog: ${catalog.name}`,