signalk-charts-provider-simple 2.3.3 → 2.3.4

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;AA2GxD,OAAO,KAAK,EACV,aAAa,EAEb,iBAAiB,EAIjB,QAAQ,EAET,MAAM,YAAY,CAAC;AAepB,QAAA,MAAM,iBAAiB,GAAI,KAAK,iBAAiB,KAAG,MAi2GnD,CAAC;AAyFF,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;AAmHxD,OAAO,KAAK,EACV,aAAa,EAEb,iBAAiB,EAIjB,QAAQ,EAET,MAAM,YAAY,CAAC;AAepB,QAAA,MAAM,iBAAiB,GAAI,KAAK,iBAAiB,KAAG,MA+5GnD,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

@@ -18,7 +18,7 @@ import { repairMbtilesMetadata, setMbtilesDisplayName } from './utils/mbtiles-me
 import { open as openMbtilesReader } from './utils/mbtiles-reader.js';
 import { writeChartPathMarker } from './utils/path-marker.js';
 import { getBlankTileReplacement, getOverzoomedTile } from './utils/tile-overzoom.js';
-import { arePairWithinBase, isWithinBase, validateChartName } from './utils/path-safety.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 { parseBody, parseShape } from './utils/rest-validation.js';
@@ -51,12 +51,21 @@ const pluginConstructor = (app) => {
     let pluginDataDir = '';
     let defaultChartsPath = '';
     let serverMajorVersion = 1;
+    // The effective default chart directory. When Signal K runs in a container
+    // (signalk-universal-installer), the installer can mount a host folder the
+    // user shares with other chart apps (OpenCPN/qtVlm/...) and inject its
+    // in-container path via SIGNALK_CHARTS_HOST_PATH. When that env is present we
+    // default to it instead of the in-data-volume `charts-simple` dir, so a
+    // container user gets the shared host folder out of the box with no config —
+    // and so the chartPath field is never the free-text foot-gun that pointed at
+    // an unmounted host path. A user can still override via the chartPath setting.
     function getDefaultChartsPath() {
         if (!defaultChartsPath) {
             pluginDataDir = app.getDataDirPath();
-            const configBasePath = path.dirname(path.dirname(pluginDataDir));
-            defaultChartsPath = path.join(configBasePath, 'charts-simple');
             serverMajorVersion = app.config?.version ? parseInt(app.config.version.split('.')[0], 10) : 1;
+            const configBasePath = path.dirname(path.dirname(pluginDataDir));
+            const inDataVolumeDefault = path.join(configBasePath, 'charts-simple');
+            defaultChartsPath = resolveDefaultChartsPath(process.env.SIGNALK_CHARTS_HOST_PATH, inDataVolumeDefault);
         }
         return defaultChartsPath;
     }
@@ -70,7 +79,11 @@ const pluginConstructor = (app) => {
                 chartPath: {
                     type: 'string',
                     title: 'Chart path',
-                    description: `Main directory for chart files. Defaults to "${getDefaultChartsPath()}". Subfolders will be scanned recursively.`,
+                    description: (hasHostChartsMountEnv(process.env.SIGNALK_CHARTS_HOST_PATH)
+                        ? `Main directory for chart files. Defaults to the shared host charts folder mounted by the installer. ` +
+                            `Leave this blank to use it; only change it if you know the path is reachable inside the container. `
+                        : `Main directory for chart files. Defaults to "${getDefaultChartsPath()}". `) +
+                        `Subfolders will be scanned recursively.`,
                     default: getDefaultChartsPath()
                 },
                 cpuBudget: {
@@ -179,10 +192,53 @@ const pluginConstructor = (app) => {
         props = { ...config };
         setCpuBudget(props.cpuBudget);
         getDefaultChartsPath(); // ensure lazy init
-        ensureDirectoryExists(defaultChartsPath);
         const chartPath = props.chartPath || defaultChartsPath;
-        if (!ensureDirectoryExists(chartPath)) {
-            app.setPluginError(`Chart directory is not writable: ${chartPath}`);
+        // Is the effective path the host folder the installer bind-mounted (via
+        // SIGNALK_CHARTS_HOST_PATH)? If so we must NOT create it on demand: that
+        // folder is supposed to already exist (the installer made it and mounted
+        // it), so a missing dir means a missing mount — and `mkdir`-ing it would
+        // silently shadow the absent mount with an ephemeral in-container dir whose
+        // charts vanish on container recreate. isHostMountPath normalizes both
+        // sides so a trailing slash / `.`/`..` can't divert the mount into the
+        // mkdir branch.
+        const isHostMount = isHostMountPath(chartPath, process.env.SIGNALK_CHARTS_HOST_PATH);
+        let exists;
+        let createdOrWritable;
+        if (isHostMount) {
+            // Probe, never create.
+            exists = fs.existsSync(chartPath);
+            createdOrWritable = exists && isDirWritable(chartPath);
+        }
+        else {
+            // In-data-volume default or a user-typed path: create-on-demand, then
+            // verify it is an actually-writable directory. ensureDirectoryExists
+            // returns true for any path that already exists, so without the
+            // isDirWritable probe an existing read-only dir (or a regular file at
+            // that path) would slip through as usable and only fail on first write.
+            createdOrWritable = ensureDirectoryExists(chartPath) && isDirWritable(chartPath);
+            exists = fs.existsSync(chartPath);
+        }
+        const access = classifyChartDirAccess(isHostMount, exists, createdOrWritable);
+        if (!access.ok) {
+            if (access.reason === 'mount-missing') {
+                // NB: clearing the Chart path setting does NOT help here — with
+                // SIGNALK_CHARTS_HOST_PATH still set, the default resolves right back to
+                // this same (missing) mount. The real fixes are restoring the mount or
+                // removing the installer env / pointing at a reachable in-container dir.
+                app.setPluginError(`Shared charts folder is not mounted into the container at ${chartPath}. ` +
+                    `Charts live in a host folder the installer shares with the container; that ` +
+                    `mount appears to be missing. Re-run the installer to restore it, remove the ` +
+                    `installer-provided SIGNALK_CHARTS_HOST_PATH setting, or set Chart path to a ` +
+                    `directory that is reachable inside the container.`);
+            }
+            else if (access.reason === 'exists-unwritable') {
+                app.setPluginError(`Chart directory exists but is not writable by Signal K: ${chartPath}. ` +
+                    `In a container this is usually a folder-ownership mismatch — make sure the ` +
+                    `host folder is owned by the user that runs Signal K.`);
+            }
+            else {
+                app.setPluginError(`Chart directory is not writable: ${chartPath}`);
+            }
             app.setPluginStatus('Started (no chart directory)');
             return;
         }
@@ -2895,6 +2951,25 @@ const ensureDirectoryExists = (dirPath) => {
         return false;
     }
 };
+// Probe whether an EXISTING directory is usable as a chart root, without
+// creating it. Used for the injected host charts mount: we must NOT mkdir a
+// missing mount (that silently shadows it with an ephemeral in-container dir),
+// so we check existence + usability separately instead of create-on-demand.
+// Requires an actual directory (W_OK alone would accept a writable regular
+// file) with both write AND execute/search permission (X_OK — needed to
+// traverse into it to read/write chart files).
+const isDirWritable = (dirPath) => {
+    try {
+        if (!fs.statSync(dirPath).isDirectory()) {
+            return false;
+        }
+        fs.accessSync(dirPath, fs.constants.W_OK | fs.constants.X_OK);
+        return true;
+    }
+    catch {
+        return false;
+    }
+};
 const cleanupEmptyParents = (deletedPath, stopAt) => {
     try {
         let parent = path.dirname(deletedPath);