@mxtommy/kip 4.5.0 → 4.5.1

package/plugin/index.js

@@ -34,10 +34,12 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 const server_api_1 = require("@signalk/server-api");
+const module_1 = require("module");
 const openapi = __importStar(require("./openApi.json"));
 const history_series_service_1 = require("./history-series.service");
 const duckdb_parquet_storage_service_1 = require("./duckdb-parquet-storage.service");
 const start = (server) => {
+    const packageRequire = (0, module_1.createRequire)(__filename);
     const mutableOpenApi = JSON.parse(JSON.stringify(openapi.default ?? openapi));
     const API_PATHS = {
         DISPLAYS: `/displays`,
@@ -84,6 +86,23 @@ const start = (server) => {
     let historySeriesServiceEnabled = true;
     let registerAsHistoryApiProvider = true;
     let historyApiProviderRegistered = false;
+    function resolveDependencyIdentity(dependencyName) {
+        try {
+            const pkg = packageRequire(`${dependencyName}/package.json`);
+            const name = typeof pkg.name === 'string' && pkg.name.trim() ? pkg.name.trim() : dependencyName;
+            const version = typeof pkg.version === 'string' && pkg.version.trim() ? pkg.version.trim() : 'unknown';
+            return `${name}@${version}`;
+        }
+        catch {
+            return `${dependencyName}@unavailable`;
+        }
+    }
+    function logRuntimeDependencyVersions() {
+        const nodeIdentity = `node@${process.version}`;
+        const duckDbNodeIdentity = resolveDependencyIdentity('@duckdb/node-api');
+        const parquetIdentity = resolveDependencyIdentity('@dsnp/parquetjs');
+        server.debug(`[KIP][RUNTIME] ${nodeIdentity} duckdb=${duckDbNodeIdentity} parquet=${parquetIdentity}`);
+    }
     function resolveHistoryModeConfig(settings) {
         const root = (settings && typeof settings === 'object' ? settings : {});
         const historySeriesServiceEnabledSetting = typeof root.historySeriesServiceEnabled === 'boolean'
@@ -102,12 +121,12 @@ const start = (server) => {
         const tail = suffix ? `.${suffix}` : '';
         const want = `displays.${displayId}${tail}`;
         const full = server.getSelfPath(want);
-        server.debug(`getDisplaySelfPath: displayId: ${displayId}, suffix: ${suffix}, want=${want}, fullPath=${JSON.stringify(full)}`);
+        server.debug(`[KIP][SELF_PATH] displayId=${displayId} suffix=${String(suffix ?? '')} requested=${want} resolved=${JSON.stringify(full)}`);
         return typeof full === 'object' && full !== null ? full : undefined;
     }
     function getAvailableDisplays() {
         const fullPath = server.getSelfPath('displays');
-        server.debug(`getAvailableDisplays: fullPath=${JSON.stringify(fullPath)}`);
+        server.debug(`[KIP][DISPLAYS] resolved=${JSON.stringify(fullPath)}`);
         return typeof fullPath === 'object' && fullPath !== null ? fullPath : undefined;
     }
     function sendOk(res, body) {
@@ -212,7 +231,7 @@ const start = (server) => {
     }
     function applyDisplayWrite(displayId, suffix, value) {
         const path = suffix ? `displays.${displayId}.${suffix}` : `displays.${displayId}`;
-        server.debug(`[WRITE TRACE] applyDisplayWrite path=${path} value=${JSON.stringify(value)}`);
+        server.debug(`[KIP][WRITE] applyDisplayWrite path=${path} value=${JSON.stringify(value)}`);
         try {
             server.handleMessage(plugin.id, {
                 updates: [
@@ -226,7 +245,7 @@ const start = (server) => {
                     }
                 ]
             }, server_api_1.SKVersion.v1);
-            server.debug(`[WRITE TRACE] handleMessage success path=${path}`);
+            server.debug(`[KIP][WRITE] handleMessage success path=${path}`);
             return completed(200);
         }
         catch (error) {
@@ -236,7 +255,7 @@ const start = (server) => {
         }
     }
     function handleSetDisplay(value) {
-        server.debug(`[COMMAND TRACE] handleSetDisplay payload=${JSON.stringify(value)}`);
+        server.debug(`[KIP][COMMAND] handleSetDisplay payload=${JSON.stringify(value)}`);
         const command = value;
         if (!command || typeof command !== 'object') {
             return completed(400, 'Command payload is required');
@@ -251,7 +270,7 @@ const start = (server) => {
         return applyDisplayWrite(command.displayId, null, displayValue);
     }
     function handleScreenWrite(value, suffix) {
-        server.debug(`[COMMAND TRACE] handleScreenWrite suffix=${suffix} payload=${JSON.stringify(value)}`);
+        server.debug(`[KIP][COMMAND] handleScreenWrite suffix=${suffix} payload=${JSON.stringify(value)}`);
         const command = value;
         if (!command || typeof command !== 'object') {
             return completed(400, 'Command payload is required');
@@ -266,7 +285,7 @@ const start = (server) => {
         return applyDisplayWrite(command.displayId, suffix, screenIdxValue);
     }
     function sendActionAsRest(res, result) {
-        server.debug(`[REST TRACE] sendActionAsRest statusCode=${result.statusCode} message=${result.message ?? ''}`);
+        server.debug(`[KIP][REST] sendActionAsRest statusCode=${result.statusCode} message=${result.message ?? ''}`);
         if (result.statusCode === 200) {
             return res.status(200).json({ state: 'SUCCESS', statusCode: 200 });
         }
@@ -425,7 +444,7 @@ const start = (server) => {
     function registerHistoryProvider() {
         historyApiProviderRegistered = false;
         if (!isHistoryApiProviderEnabled()) {
-            server.debug('[HISTORY PROVIDER] Registration disabled by plugin configuration');
+            server.debug('[KIP][HISTORY_PROVIDER] registration skipped reason=config-disabled');
             return;
         }
         const host = server;
@@ -459,10 +478,10 @@ const start = (server) => {
             if (typeof registry.unregisterHistoryApiProvider === 'function') {
                 historyApiRegistry = { unregisterHistoryApiProvider: registry.unregisterHistoryApiProvider.bind(registry) };
             }
-            server.debug('[HISTORY PROVIDER] Registered KIP as History API provider');
+            server.debug('[KIP][HISTORY_PROVIDER] registration success provider=kip');
             return;
         }
-        server.debug('[HISTORY PROVIDER] Registration requested but no compatible registration API was found on server host');
+        server.debug('[KIP][HISTORY_PROVIDER] registration skipped reason=api-unavailable');
     }
     function rebuildSeriesCaptureSubscriptions() {
         stopSeriesCapture();
@@ -544,7 +563,7 @@ const start = (server) => {
             void storageService.flush()
                 .then(result => {
                 if (result.inserted > 0 || result.exported > 0) {
-                    server.debug(`[SERIES STORAGE] flushed inserted=${result.inserted} exported=${result.exported}`);
+                    server.debug(`[KIP][STORAGE] flush inserted=${result.inserted} exported=${result.exported}`);
                 }
             })
                 .catch(error => {
@@ -558,7 +577,8 @@ const start = (server) => {
         name: 'KIP',
         description: 'KIP server plugin',
         start: (settings) => {
-            server.debug(`Starting plugin with settings: ${JSON.stringify(settings)}`);
+            server.debug('[KIP][LIFECYCLE] start');
+            logRuntimeDependencyVersions();
             const modeConfig = resolveHistoryModeConfig(settings);
             historySeriesServiceEnabled = modeConfig.historySeriesServiceEnabled;
             registerAsHistoryApiProvider = modeConfig.registerAsHistoryApiProvider;
@@ -567,14 +587,14 @@ const start = (server) => {
                 debug: (msg) => server.debug(msg),
                 error: (msg) => server.error(msg)
             });
-            const storageConfig = storageService.configure(settings);
-            server.debug(`[SERIES STORAGE] engine=${storageConfig.engine} db=${storageConfig.databaseFile} parquetDir=${storageConfig.parquetDirectory} flushMs=${storageConfig.flushIntervalMs}`);
+            const storageConfig = storageService.configure();
+            server.debug(`[KIP][STORAGE] config engine=${storageConfig.engine} db=${storageConfig.databaseFile} parquetDir=${storageConfig.parquetDirectory} flushMs=${storageConfig.flushIntervalMs}`);
             historySeries.setSampleSink(sample => {
                 storageService.enqueueSample(sample);
             });
             duckDbInitializationPromise = storageService.initialize();
             void duckDbInitializationPromise.then((ready) => {
-                server.debug(`[SERIES STORAGE] duckdbReady=${ready}`);
+                server.debug(`[KIP][STORAGE] duckdbReady=${ready}`);
                 if (ready && storageService.isDuckDbParquetEnabled()) {
                     if (isHistorySeriesServiceEnabled()) {
                         void storageService.getSeriesDefinitions()
@@ -624,12 +644,12 @@ const start = (server) => {
                         void storageService.pruneExpiredSamples(Date.now(), lifecycleToken)
                             .then(removedPersistedRows => {
                             if (removedPersistedRows > 0) {
-                                server.debug(`[SERIES RETENTION] duckdbPrune removedRows=${removedPersistedRows}`);
+                                server.debug(`[KIP][RETENTION] pruneExpired removedRows=${removedPersistedRows}`);
                             }
                             return storageService.pruneOrphanedSamples(lifecycleToken)
                                 .then(removedOrphanRows => {
                                 if (removedOrphanRows > 0) {
-                                    server.debug(`[SERIES RETENTION] duckdbOrphanPrune removedRows=${removedOrphanRows}`);
+                                    server.debug(`[KIP][RETENTION] pruneOrphaned removedRows=${removedOrphanRows}`);
                                 }
                             });
                         })
@@ -645,21 +665,21 @@ const start = (server) => {
             retentionSweepTimer.unref?.();
             rebuildSeriesCaptureSubscriptions();
             if (server.registerPutHandler) {
-                server.debug(`[COMMAND TRACE] Registering PUT handlers under context=${PUT_CONTEXT}`);
+                server.debug(`[KIP][COMMAND] registerPutHandlers context=${PUT_CONTEXT}`);
                 server.registerPutHandler(PUT_CONTEXT, COMMAND_PATHS.SET_DISPLAY, (context, path, value) => {
-                    server.debug(`[COMMAND TRACE] PUT handler hit path=${String(path)} context=${String(context)} command=${COMMAND_PATHS.SET_DISPLAY}`);
+                    server.debug(`[KIP][COMMAND] putHandlerHit command=${COMMAND_PATHS.SET_DISPLAY} path=${String(path)} context=${String(context)}`);
                     void context;
                     void path;
                     return handleSetDisplay(value);
                 }, plugin.id);
                 server.registerPutHandler(PUT_CONTEXT, COMMAND_PATHS.SET_SCREEN_INDEX, (context, path, value) => {
-                    server.debug(`[COMMAND TRACE] PUT handler hit path=${String(path)} context=${String(context)} command=${COMMAND_PATHS.SET_SCREEN_INDEX}`);
+                    server.debug(`[KIP][COMMAND] putHandlerHit command=${COMMAND_PATHS.SET_SCREEN_INDEX} path=${String(path)} context=${String(context)}`);
                     void context;
                     void path;
                     return handleScreenWrite(value, 'screenIndex');
                 }, plugin.id);
                 server.registerPutHandler(PUT_CONTEXT, COMMAND_PATHS.REQUEST_ACTIVE_SCREEN, (context, path, value) => {
-                    server.debug(`[COMMAND TRACE] PUT handler hit path=${String(path)} context=${String(context)} command=${COMMAND_PATHS.REQUEST_ACTIVE_SCREEN}`);
+                    server.debug(`[KIP][COMMAND] putHandlerHit command=${COMMAND_PATHS.REQUEST_ACTIVE_SCREEN} path=${String(path)} context=${String(context)}`);
                     void context;
                     void path;
                     return handleScreenWrite(value, 'activeScreen');
@@ -670,7 +690,7 @@ const start = (server) => {
             server.setPluginStatus(`Starting...`);
         },
         stop: () => {
-            server.debug(`Stopping plugin`);
+            server.debug('[KIP][LIFECYCLE] stop');
             stopSeriesCapture();
             if (retentionSweepTimer) {
                 clearInterval(retentionSweepTimer);
@@ -688,7 +708,7 @@ const start = (server) => {
             if (historyApiRegistry) {
                 try {
                     historyApiRegistry.unregisterHistoryApiProvider();
-                    server.debug('[HISTORY PROVIDER] Unregistered KIP History API provider');
+                    server.debug('[KIP][HISTORY_PROVIDER] unregister success provider=kip');
                 }
                 catch (error) {
                     server.error(`[HISTORY PROVIDER] unregister failed: ${String(error.message || error)}`);
@@ -701,7 +721,7 @@ const start = (server) => {
         },
         schema: () => CONFIG_SCHEMA,
         registerWithRouter(router) {
-            server.debug(`Registering plugin routes: ${API_PATHS.DISPLAYS}, ${API_PATHS.INSTANCE}, ${API_PATHS.SCREEN_INDEX}, ${API_PATHS.ACTIVATE_SCREEN}`);
+            server.debug(`[KIP][ROUTES] register displays=${API_PATHS.DISPLAYS} instance=${API_PATHS.INSTANCE} screenIndex=${API_PATHS.SCREEN_INDEX} activeScreen=${API_PATHS.ACTIVATE_SCREEN}`);
             // Validate/normalize :displayId where present
             router.param('displayId', (req, res, next, displayId) => {
                 logAuthTrace(req, 'router.param:displayId:entry');
@@ -736,7 +756,7 @@ const start = (server) => {
                         return sendFail(res, 400, 'Invalid displayId format');
                     }
                     req.displayId = id;
-                    server.debug(`[AUTH TRACE] router.param:displayId:normalized displayId=${id}`);
+                    server.debug(`[KIP][AUTH] displayIdNormalized value=${id}`);
                     next();
                 }
                 catch {
@@ -746,7 +766,7 @@ const start = (server) => {
             });
             router.put(`${API_PATHS.INSTANCE}`, async (req, res) => {
                 logAuthTrace(req, 'route:PUT:INSTANCE:entry');
-                server.debug(`** PUT ${API_PATHS.INSTANCE}. Params: ${JSON.stringify(req.params)} Body: ${JSON.stringify(req.body)}`);
+                server.debug(`[KIP][ROUTE] method=PUT path=${API_PATHS.INSTANCE} params=${JSON.stringify(req.params)} body=${JSON.stringify(req.body)}`);
                 try {
                     const displayId = req.displayId;
                     if (!displayId) {
@@ -764,7 +784,7 @@ const start = (server) => {
             });
             router.put(`${API_PATHS.SCREEN_INDEX}`, async (req, res) => {
                 logAuthTrace(req, 'route:PUT:SCREEN_INDEX:entry');
-                server.debug(`** PUT ${API_PATHS.SCREEN_INDEX}. Params: ${JSON.stringify(req.params)} Body: ${JSON.stringify(req.body)}`);
+                server.debug(`[KIP][ROUTE] method=PUT path=${API_PATHS.SCREEN_INDEX} params=${JSON.stringify(req.params)} body=${JSON.stringify(req.body)}`);
                 try {
                     const displayId = req.displayId;
                     if (!displayId) {
@@ -785,7 +805,7 @@ const start = (server) => {
             });
             router.put(`${API_PATHS.ACTIVATE_SCREEN}`, async (req, res) => {
                 logAuthTrace(req, 'route:PUT:ACTIVATE_SCREEN:entry');
-                server.debug(`** PUT ${API_PATHS.ACTIVATE_SCREEN}. Params: ${JSON.stringify(req.params)} Body: ${JSON.stringify(req.body)}`);
+                server.debug(`[KIP][ROUTE] method=PUT path=${API_PATHS.ACTIVATE_SCREEN} params=${JSON.stringify(req.params)} body=${JSON.stringify(req.body)}`);
                 try {
                     const displayId = req.displayId;
                     if (!displayId) {
@@ -805,7 +825,7 @@ const start = (server) => {
                 }
             });
             router.get(API_PATHS.DISPLAYS, (req, res) => {
-                server.debug(`*** GET DISPLAY ${API_PATHS.DISPLAYS}. Params: ${JSON.stringify(req.params)}`);
+                server.debug(`[KIP][ROUTE] method=GET path=${API_PATHS.DISPLAYS} params=${JSON.stringify(req.params)}`);
                 try {
                     const displays = getAvailableDisplays();
                     const items = displays && typeof displays === 'object'
@@ -817,8 +837,8 @@ const start = (server) => {
                             displayName: v?.value?.displayName ?? null
                         }))
                         : [];
-                    server.debug(`getAvailableDisplays returned: ${JSON.stringify(displays)}`);
-                    server.debug(`Found ${items.length} displays: ${JSON.stringify(items)}`);
+                    server.debug(`[KIP][DISPLAYS] raw=${JSON.stringify(displays)}`);
+                    server.debug(`[KIP][DISPLAYS] count=${items.length} items=${JSON.stringify(items)}`);
                     return res.status(200).json(items);
                 }
                 catch (error) {
@@ -827,7 +847,7 @@ const start = (server) => {
                 }
             });
             router.get(`${API_PATHS.INSTANCE}`, (req, res) => {
-                server.debug(`*** GET INSTANCE ${API_PATHS.INSTANCE}. Params: ${JSON.stringify(req.params)}`);
+                server.debug(`[KIP][ROUTE] method=GET path=${API_PATHS.INSTANCE} params=${JSON.stringify(req.params)}`);
                 try {
                     const displayId = req.displayId;
                     if (!displayId) {
@@ -847,7 +867,7 @@ const start = (server) => {
                 }
             });
             router.get(`${API_PATHS.SCREEN_INDEX}`, (req, res) => {
-                server.debug(`*** GET SCREEN_INDEX ${API_PATHS.SCREEN_INDEX}. Params: ${JSON.stringify(req.params)}`);
+                server.debug(`[KIP][ROUTE] method=GET path=${API_PATHS.SCREEN_INDEX} params=${JSON.stringify(req.params)}`);
                 try {
                     const displayId = req.displayId;
                     if (!displayId) {
@@ -867,7 +887,7 @@ const start = (server) => {
                 }
             });
             router.get(`${API_PATHS.ACTIVATE_SCREEN}`, (req, res) => {
-                server.debug(`*** GET ACTIVATE_SCREEN ${API_PATHS.ACTIVATE_SCREEN}. Params: ${JSON.stringify(req.params)}`);
+                server.debug(`[KIP][ROUTE] method=GET path=${API_PATHS.ACTIVATE_SCREEN} params=${JSON.stringify(req.params)}`);
                 try {
                     const displayId = req.displayId;
                     if (!displayId) {
@@ -887,7 +907,7 @@ const start = (server) => {
                 }
             });
             router.get(API_PATHS.SERIES, async (req, res) => {
-                server.debug(`*** GET SERIES ${API_PATHS.SERIES}. Params: ${JSON.stringify(req.params)}`);
+                server.debug(`[KIP][ROUTE] method=GET path=${API_PATHS.SERIES} params=${JSON.stringify(req.params)}`);
                 try {
                     if (!ensureHistorySeriesServiceEnabledForRequest(res)) {
                         return;
@@ -904,7 +924,7 @@ const start = (server) => {
                 }
             });
             router.put(API_PATHS.SERIES_INSTANCE, async (req, res) => {
-                server.debug(`** PUT ${API_PATHS.SERIES_INSTANCE}. Params: ${JSON.stringify(req.params)} Body: ${JSON.stringify(req.body)}`);
+                server.debug(`[KIP][ROUTE] method=PUT path=${API_PATHS.SERIES_INSTANCE} params=${JSON.stringify(req.params)} body=${JSON.stringify(req.body)}`);
                 try {
                     if (!ensureHistorySeriesServiceEnabledForRequest(res)) {
                         return;
@@ -945,7 +965,7 @@ const start = (server) => {
                 }
             });
             router.delete(API_PATHS.SERIES_INSTANCE, async (req, res) => {
-                server.debug(`** DELETE ${API_PATHS.SERIES_INSTANCE}. Params: ${JSON.stringify(req.params)}`);
+                server.debug(`[KIP][ROUTE] method=DELETE path=${API_PATHS.SERIES_INSTANCE} params=${JSON.stringify(req.params)}`);
                 try {
                     if (!ensureHistorySeriesServiceEnabledForRequest(res)) {
                         return;
@@ -973,7 +993,7 @@ const start = (server) => {
                 }
             });
             router.post(API_PATHS.SERIES_RECONCILE, async (req, res) => {
-                server.debug(`** POST ${API_PATHS.SERIES_RECONCILE}. Body: ${JSON.stringify(req.body)}`);
+                server.debug(`[KIP][ROUTE] method=POST path=${API_PATHS.SERIES_RECONCILE} body=${JSON.stringify(req.body)}`);
                 try {
                     if (!ensureHistorySeriesServiceEnabledForRequest(res)) {
                         return;
@@ -997,7 +1017,7 @@ const start = (server) => {
                     await storageService.replaceSeriesDefinitions(nextSeries);
                     const seriesOutsideScope = historySeries.listSeries();
                     historySeries.reconcileSeries([...seriesOutsideScope, ...nextSeries]);
-                    server.debug(`[SERIES RECONCILE] created=${result.created} updated=${result.updated} deleted=${result.deleted} total=${result.total}`);
+                    server.debug(`[KIP][SERIES_RECONCILE] created=${result.created} updated=${result.updated} deleted=${result.deleted} total=${result.total}`);
                     rebuildSeriesCaptureSubscriptions();
                     return sendOk(res, result);
                 }
@@ -1011,7 +1031,7 @@ const start = (server) => {
             if (router.stack) {
                 router.stack.forEach((layer) => {
                     if (layer.route && layer.route.path) {
-                        server.debug(`Registered route: ${layer.route.stack[0].method.toUpperCase()} ${layer.route.path}`);
+                        server.debug(`[KIP][ROUTES] registered method=${layer.route.stack[0].method.toUpperCase()} path=${layer.route.path}`);
                     }
                 });
             }