signalk-to-noforeignland 0.1.26 → 0.1.27

package/.github/workflows/github.yml

@@ -0,0 +1,30 @@
+name: Publish Package
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  id-token: write  # Required for OIDC authentication
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+      
+      - name: Install dependencies
+        run: npm ci
+      
+      - name: Run tests if available
+        run: npm test --if-present
+      
+      - name: Publish to NPM
+        run: npm publish

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+0.1.27
+* Final version after successful testing SV MOIN and SV KIAPA NUI
+
+0.1.27-beta.1
+* NEW: NPMJS requires new method for publishing. The old tokens will expire Nov 19th, 2025, so moving to OIDC authentication.
+* NEW: Check the GPS status in navigation.position, else retry and throw PluginError on Dashboard
+* CHANGE: Keep track data on disk rewritten and migrate old files to new structure, so nfl-track-sent.jsonl becomes a continuous archive of all sent track data over time, when enabled. New Logic:
+* * New points accumulate in nfl-track-pending.jsonl
+* * Send succeeds → API confirms receipt
+* * If keepFiles=true: The content of pending file is appended to nfl-track-sent.jsonl (line 588)
+* * Pending file is deleted
+* * Next GPS points → create a new pending file
+* * Next successful send → appends again to the same nfl-track-sent.jsonl
+
 0.1.26
 * Same as 0.1.26-beta.1 
 

package/doc/beta_install.md

@@ -0,0 +1,62 @@
+How-to install the latest beta on your device?
+
+This guide assumes you have a default install with default folders.
+This is written for a Cerbo GX or a RPI, jump to the section you need want to go to.
+It is recommended to enable the Debug Log for this plugin in Server -> Plugin Config before updating.
+
+**For Raspberry PI:** 
+
+1. Backup old data
+
+```
+cd ~
+mkdir nfl-backup
+cp -a .signalk/node_modules/signalk-to-noforeignland/* nfl-backup/
+```
+
+2.  Get new files from repo (main for latest)
+
+```
+cd ~/.signalk/node_modules/signalk-to-noforeignland/
+rm *
+#NOTE: Trackdir will not be deleted, this is what we want.
+wget  https://github.com/noforeignland/nfl-signalk/archive/refs/heads/main.zip
+unzip main.zip
+cp -r nfl-signalk-main/* .
+rm main.zip
+rm -rf nfl-signalk-main/
+```
+
+3.  Restart Server & Check logs
+
+```
+sudo systemctl restart signalk.service && sudo journalctl -u signalk.service -f
+```
+
+
+**For Cerbo GX with Image Large:**
+1. Backup old data
+
+```
+cd ~
+mkdir nfl-backup
+cp -a /data/conf/signalk/node_modules/signalk-to-noforeignland/*  nfl-backup
+```
+
+2. Get new files from repo (main for latest)
+
+```
+cd /data/conf/signalk/node_modules/signalk-to-noforeignland/
+rm *
+# NOTE: Trackdir will not be deleted, this is what we want.
+wget  https://github.com/noforeignland/nfl-signalk/archive/refs/heads/main.zip
+unzip main.zip
+cp -r nfl-signalk-main/* .
+rm main.zip
+rm -rf nfl-signalk-main/
+```
+
+3. Restart Server & Check logs
+```
+Restart Server vom Webgui and check logs in Webgui
+```

package/index.js

@@ -11,7 +11,8 @@ const isReachable = require('is-reachable');
 const apiUrl = 'https://www.noforeignland.com/home/api/v1/boat/tracking/track';
 const pluginApiKey = '0ede6cb6-5213-45f5-8ab4-b4836b236f97';
 const defaultTracksDir = 'track';
-const routeSaveName = 'nfl-track.jsonl';
+const routeSaveName = 'nfl-track-pending.jsonl';  // Changed: separate pending file
+const routeSentName = 'nfl-track-sent.jsonl';      // New: archive for sent data
 
 class SignalkToNoforeignland {
   constructor(app) {
@@ -148,6 +149,10 @@ getSchema() {
 
   async start(options = {}, restartPlugin) {
   
+  // Position data health check
+  this.positionCheckInterval = null;
+  this.lastPositionReceived = null;
+  
   // Backward compatibility: migrate old flat structure to new nested structure
   let needsSave = false;
   if (options.boatApiKey && !options.mandatory) {
@@ -227,6 +232,9 @@ getSchema() {
     return;
   }
 
+  // NEW: Migrate old track file to new naming scheme on startup
+  await this.migrateOldTrackFile();
+
   this.app.debug('track logger started, now logging to', this.options.trackDir);
   this.app.setPluginStatus(`Started${needsSave ? ' (config migrated)' : ''}`);
   this.upSince = new Date().getTime();
@@ -247,10 +255,38 @@ getSchema() {
   // start cron job
   this.cron = new CronJob(this.options.apiCron, this.interval.bind(this));
   this.cron.start();
+  
+  // Start position health check (every 5 minutes)
+  this.startPositionHealthCheck();
 }
 
+  // NEW: Migrate old track file naming to new scheme
+  async migrateOldTrackFile() {
+    const oldTrackFile = path.join(this.options.trackDir, 'nfl-track.jsonl');
+    const newPendingFile = path.join(this.options.trackDir, routeSaveName);
+    
+    try {
+      // Check if old file exists and new pending file doesn't
+      if (await fs.pathExists(oldTrackFile) && !(await fs.pathExists(newPendingFile))) {
+        this.app.debug('Migrating old track file to new naming scheme...');
+        await fs.move(oldTrackFile, newPendingFile);
+        this.app.debug('Successfully migrated old track file to:', routeSaveName);
+      }
+    } catch (err) {
+      this.app.debug('Error during track file migration:', err.message);
+      // Non-fatal error, continue startup
+    }
+  }
+
   stop() {
     this.app.debug('plugin stopped');
+    
+    // Stop position health check
+    if (this.positionCheckInterval) {
+      clearInterval(this.positionCheckInterval);
+      this.positionCheckInterval = null;
+    }
+    
     if (this.cron) {
       this.cron.stop();
       this.cron = undefined;
@@ -360,6 +396,7 @@ getSchema() {
 
       // Punkt speichern
       this.lastPosition = { pos: value.value, timestamp, currentTime: new Date().getTime() };
+      this.lastPositionReceived = new Date().getTime(); // Track for health check
       await this.savePoint(this.lastPosition);
 
       // shouldDoLog zurücksetzen wenn minSpeed aktiv ist
@@ -378,6 +415,7 @@ getSchema() {
     t: point.timestamp
   };
   this.app.debug(`save data point:`, obj);
+  // CHANGED: Save to pending file
   await fs.appendFile(path.join(this.options.trackDir, routeSaveName), JSON.stringify(obj) + EOL);
   
   const lastSaveTime = new Date().toISOString();
@@ -443,6 +481,57 @@ getSchema() {
     return res;
   }
 
+  // NEW: Position health check
+  startPositionHealthCheck() {
+    // Check every 5 minutes if we're receiving position data
+    this.positionCheckInterval = setInterval(() => {
+      const now = new Date().getTime();
+      const timeSinceLastPosition = this.lastPositionReceived 
+        ? (now - this.lastPositionReceived) / 1000 
+        : null;
+      
+      // Build appropriate error message based on filterSource setting
+      const filterMsg = this.options.filterSource 
+        ? ` from source '${this.options.filterSource}'` 
+        : '';
+      
+      if (!this.lastPositionReceived) {
+        // Never received any position data
+        const errorMsg = this.options.filterSource
+          ? `No GPS position data received from filtered source '${this.options.filterSource}'. Check Expert Settings > Position source device, or leave empty to use any GPS source.`
+          : 'No GPS position data received. Check that your GPS is connected and SignalK is receiving navigation.position data.';
+        this.app.setPluginError(errorMsg);
+        this.app.debug('Position health check: No position data ever received' + filterMsg);
+      } else if (timeSinceLastPosition > 300) {
+        // No position data for more than 5 minutes
+        const errorMsg = this.options.filterSource
+          ? `No GPS position data${filterMsg} for ${Math.floor(timeSinceLastPosition / 60)} minutes. Check that source '${this.options.filterSource}' is active, or change/clear Position source device in Expert Settings.`
+          : `No GPS position data for ${Math.floor(timeSinceLastPosition / 60)} minutes. Check your GPS connection.`;
+        this.app.setPluginError(errorMsg);
+        this.app.debug(`Position health check: No position for ${timeSinceLastPosition.toFixed(0)} seconds` + filterMsg);
+      } else {
+        // Position data is flowing normally
+        this.app.debug(`Position health check: OK (last position ${timeSinceLastPosition.toFixed(0)} seconds ago${filterMsg})`);
+        // Clear any previous error if position is now flowing
+        const lastSaveTime = this.lastPosition ? new Date(this.lastPosition.currentTime).toISOString() : 'Never';
+        const lastTransferTime = this.lastSuccessfulTransfer ? this.lastSuccessfulTransfer.toISOString() : 'None since start';
+        const sourceInfo = this.options.filterSource ? ` (source: ${this.options.filterSource})` : '';
+        this.app.setPluginStatus(`Active${sourceInfo} - Last save: ${lastSaveTime} | Last transfer: ${lastTransferTime}`);
+      }
+    }, 5 * 60 * 1000); // Check every 5 minutes
+    
+    // Also do an initial check after 2 minutes
+    setTimeout(() => {
+      if (!this.lastPositionReceived) {
+        const errorMsg = this.options.filterSource
+          ? `No GPS position data received after 2 minutes from filtered source '${this.options.filterSource}'. Check Expert Settings > Position source device. You may need to leave it empty to use any available GPS source.`
+          : 'No GPS position data received after 2 minutes. Check that your GPS is connected and SignalK is receiving navigation.position data.';
+        this.app.setPluginError(errorMsg);
+        this.app.debug('Initial position check: No position data received' + (this.options.filterSource ? ` from source '${this.options.filterSource}'` : ''));
+      }
+    }, 2 * 60 * 1000);
+  }
+
   // periodic interval called by cron
   async interval() {
     if ((this.checkBoatMoving()) && await this.checkTrack() && await this.testInternet()) {
@@ -503,6 +592,7 @@ getSchema() {
 }
 
   async checkTrack() {
+    // CHANGED: Check pending file instead
     const trackFile = path.join(this.options.trackDir, routeSaveName);
     this.app.debug('checking the track', trackFile, 'if should send');
     const exists = await fs.pathExists(trackFile);
@@ -522,7 +612,9 @@ getSchema() {
 
   async sendApiData() {
     this.app.debug('sending the data');
-    const trackData = await this.createTrack(path.join(this.options.trackDir, routeSaveName));
+    // CHANGED: Read from pending file
+    const pendingFile = path.join(this.options.trackDir, routeSaveName);
+    const trackData = await this.createTrack(pendingFile);
     if (!trackData) {
       this.app.debug('Recorded track did not contain any valid track points, aborting sending.');
       this.app.setPluginError(`Failed to send track - Recorded track did not contain any valid track points, aborting sending.`);
@@ -564,14 +656,9 @@ getSchema() {
             this.lastSuccessfulTransfer = new Date();
             this.app.debug('Track successfully sent to API');
             this.app.setPluginStatus(`Started - last Track sent successfully at ${new Date().toISOString()}`);
-            if (this.options.keepFiles) {
-              const filename = new Date().toJSON().slice(0, 19).replace(/:/g, '') + '-nfl-track.jsonl';
-              this.app.debug('moving and keeping track file: ', filename);
-              await fs.move(path.join(this.options.trackDir, routeSaveName), path.join(this.options.trackDir, filename));
-            } else {
-              this.app.debug('Deleting track file');
-              await fs.remove(path.join(this.options.trackDir, routeSaveName));
-            }
+            
+            // CHANGED: New file handling logic
+            await this.handleSuccessfulSend(pendingFile);
             return; // Erfolg - beende Funktion
           } else {
             this.app.debug('Could not send track to API, returned response json:', responseBody);
@@ -605,6 +692,39 @@ getSchema() {
       }
     }
   }
+
+  // NEW: Handle file operations after successful send
+  async handleSuccessfulSend(pendingFile) {
+    const sentFile = path.join(this.options.trackDir, routeSentName);
+    
+    try {
+      if (this.options.keepFiles) {
+        // Append pending data to sent archive
+        this.app.debug('Appending sent data to archive file:', routeSentName);
+        
+        // Read pending file content
+        const pendingContent = await fs.readFile(pendingFile, 'utf8');
+        
+        // Append to sent file (create if doesn't exist)
+        await fs.appendFile(sentFile, pendingContent);
+        
+        this.app.debug('Successfully archived sent track data');
+      } else {
+        this.app.debug('keepFiles disabled, will delete pending file');
+      }
+      
+      // Always delete the pending file after successful send
+      this.app.debug('Deleting pending track file');
+      await fs.remove(pendingFile);
+      this.app.debug('Successfully processed track files after send');
+      
+    } catch (err) {
+      this.app.debug('Error handling files after successful send:', err.message);
+      // Non-fatal: Data was sent successfully, file handling is secondary
+      // Next save will create a new pending file anyway
+    }
+  }
+
   async createTrack(inputPath) {
     const fileStream = fs.createReadStream(inputPath);
     const rl = readline.createInterface({ input: fileStream, crlfDelay: Infinity });
@@ -635,4 +755,4 @@ getSchema() {
 module.exports = function (app) {
   const instance = new SignalkToNoforeignland(app);
   return instance.getPluginObject();
-};
+};

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "signalk-to-noforeignland",
-  "version": "0.1.26",
-  "description": "SignalK track logger to noforeignland.com ",
+  "version": "0.1.27",
+  "description": "SignalK track logger to noforeignland.com",
   "main": "index.js",
   "keywords": [
     "signalk-node-server-plugin",
     "signalk-category-utility"
   ],
   "author": "Dirk Wahrheit",
+  "license": "MIT",
   "homepage": "https://github.com/noforeignland/nfl-signalk",
   "bugs": {
     "url": "https://github.com/noforeignland/nfl-signalk/issues"
@@ -16,8 +17,11 @@
     "type": "git",
     "url": "https://github.com/noforeignland/nfl-signalk.git"
   },
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"No tests specified\" && exit 0"
   },
   "dependencies": {
     "cron": "^2.1.0",
@@ -25,4 +29,4 @@
     "is-reachable": "^5.2.1",
     "node-fetch": "^2.6.7"
   }
-}
+}

package/track/nfl-track-sent.jsonl

@@ -0,0 +1,2 @@
+{"lat":-17.6813649,"lon":177.3838949,"t":"2025-11-09T17:38:20.841Z"}
+{"lat":-17.6813779,"lon":177.3838402,"t":"2025-11-09T17:58:22.829Z"}