@noforeignland/signalk-to-noforeignland 1.1.0-beta.3 → 1.1.0

package/CHANGELOG.md

@@ -1,6 +1,12 @@
 1.1.0
+* CHANGE: Removed postinstall script - SignalK server will use --ignore-scripts (issue #2181). Runtime PluginCleanup handles all migration.
 * CHANGE: Refactored Project structure, see PROJECT_STRUCTURE.md
 * CHANGE: Use phrase GNSS instead of GPS - Thanks Piotr
+* BUGFIX: Removed unreliable DNS-based internet connectivity test (beta.11) - API retry logic is sufficient
+* BUGFIX: Reverted to beta.3 working configuration (beta.10) - undoing all failed schema experiments from beta.4-9
+* CHANGE: Improved cleanup error handling - only shows error after all retry attempts fail
+* CHANGE: Added installed plugins logging for better debugging
+* CHANGE: Platform-specific cleanup instructions (Cerbo GX vs standard)
 
 1.0.1
 * CHANGE: Cleanup previous installs and migrate plugin config, removes depricated old plugins.

package/README.md

@@ -1,9 +1,6 @@
 # Signal K To Noforeignland
 Effortlessly log your boat's movement to **noforeignland.com**
 
-## Important for 0.1.x users
-Upgrade to >1.1.0 by installing this plugin from the Appstore again. Your old config will be migrated and old plugins will be automatically removed.
-
 ## Features
 * Automatically log your position to noforeignland.com
 * Send detailed tracks to log your entire trip and not just your final position
@@ -14,8 +11,9 @@ Upgrade to >1.1.0 by installing this plugin from the Appstore again. Your old co
 * SK data paths about the plugin status for your own dashboard or Node Red coding
 
 ## Issues
-* Server -> Plugin Config -> Signal K to Noforeignland -> Enable debug log (top right)
-* Report issues on GitHub (https://github.com/noforeignland/nfl-signalk/issues)
+* Enable debug logging: Server -> Plugin Config -> Signal K to Noforeignland -> Enable debug log (top right)
+* Check logs: Server -> Server Log (in SignalK web UI)
+* Report issues on [GitHub](https://github.com/noforeignland/nfl-signalk/issues)
 
 ## Requirements
 * An internet connection is required in order to update noforeignland.com
@@ -44,8 +42,6 @@ noforeignland.source - string              - string            - data source of
 notifications.noforeignland.status_boolean - json object       - auto created
 ```
 
-https://github.com/noforeignland/nfl-signalk/issues
-
 # Virctron Cerbo GX Users
 
 ## Limited storage

package/doc/beta_install_cerbo.md

@@ -84,9 +84,6 @@ chown -R signalk:signalk /data/conf/signalk/*
 ```
 
 
-----------------------------------------
-
-
 # dev tree (unstable) install - NOT RECOMMENDED
 
 1. Backup as above 
@@ -111,6 +108,20 @@ chown -R signalk:signalk /data/conf/signalk/*
 ```
 
 3. Restart Server & Check logs
+```
+svc -t /service/signalk-server
+```
+
+# Manual Fixes
+
+## WARNING: found multiple copies of plugin with id signalk-to-noforeignland at /data/conf/signalk/node_modules/ and /data/conf/signalk/node_modules/
+
+```
+cd /data/conf/signalk && npm uninstall signalk-to-noforeignland signalk-to-nfl
+```
+
+and than
+
 ```
 svc -t /service/signalk-server
 ```

package/index.js

@@ -202,17 +202,8 @@ class SignalkToNoforeignland {
       if (!hasTrack) {
         return;
       }
-      
-      // Test internet connection
-      const hasInternet = await this.trackSender.testInternet();
-      if (!hasInternet) {
-        const errorMsg = 'No internet connection detected. Unable to send tracking data to NFL. DNS lookups failed - check your internet connection.';
-        this.app.debug(errorMsg);
-        this.setPluginError(errorMsg);
-        return;
-      }
-      
-      // Send track data
+
+      // Send track data (has built-in retry logic)
       const success = await this.trackSender.sendTrack();
       
       if (success) {

package/lib/PluginCleanup.js

@@ -13,37 +13,130 @@ class PluginCleanup {
     try {
       // Detect SignalK directory (standard or Victron Cerbo)
       const victronPath = '/data/conf/signalk';
-      const standardPath = process.env.SIGNALK_NODE_CONFIG_DIR || 
+      const standardPath = process.env.SIGNALK_NODE_CONFIG_DIR ||
                            path.join(process.env.HOME || process.env.USERPROFILE, '.signalk');
-      
+
       const configDir = fs.existsSync(victronPath) ? victronPath : standardPath;
       this.app.debug(`Using SignalK directory: ${configDir}`);
-      
+
       const configPath = path.join(configDir, 'plugin-config-data');
-      
+
       // 1. Config Migration - only from signalk-to-noforeignland
       await this.migrateConfig(configPath);
-      
-      // 2. Check and remove old plugins
-      await this.removeOldPlugins(configDir);
-      
+
+      // 2. Verify what plugins are actually present
+      this.logInstalledPlugins(configDir);
+
+      // 3. Check and remove old plugins
+      return await this.removeOldPlugins(configDir);
+
     } catch (err) {
       this.app.debug('Error during old plugin cleanup:', err.message);
+      return null;
+    }
+  }
+
+  /**
+   * Log which SignalK NFL plugins are currently installed (for debugging)
+   */
+  logInstalledPlugins(configDir) {
+    const nodeModulesDir = path.join(configDir, 'node_modules');
+    const pluginsToCheck = [
+      '@noforeignland/signalk-to-noforeignland',
+      'signalk-to-noforeignland',
+      'signalk-to-nfl'
+    ];
+
+    const found = [];
+    for (const pluginName of pluginsToCheck) {
+      const pluginPath = path.join(nodeModulesDir, pluginName);
+      if (fs.existsSync(pluginPath)) {
+        const packageJsonPath = path.join(pluginPath, 'package.json');
+        let version = 'unknown';
+        try {
+          if (fs.existsSync(packageJsonPath)) {
+            const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+            version = packageJson.version;
+          }
+        } catch (e) {
+          // Ignore version read errors
+        }
+        found.push(`${pluginName}@${version}`);
+      }
+    }
+
+    if (found.length > 0) {
+      this.app.debug(`Installed NFL plugins: ${found.join(', ')}`);
     }
   }
 
   /**
-   * Migrate config from old plugin to new scoped version
+   * Migrate config from old plugin ID to new plugin ID
+   *
+   * Handles config migration from:
+   * 1. Old unscoped plugin "signalk-to-noforeignland" (v0.1.x)
+   * 2. Beta versions with wrong plugin ID (v1.1.0-beta.1/2/3)
+   *
+   * Both used config filename: "signalk-to-noforeignland.json"
+   * New version uses: "@noforeignland-signalk-to-noforeignland.json"
+   *
+   * Since both sources use the same filename, we simply copy if it exists.
    */
   async migrateConfig(configPath) {
     const oldConfigFile = path.join(configPath, 'signalk-to-noforeignland.json');
     const newConfigFile = path.join(configPath, '@noforeignland-signalk-to-noforeignland.json');
-    
+
+    // Only migrate if old config exists and new config doesn't
     if (fs.existsSync(oldConfigFile) && !fs.existsSync(newConfigFile)) {
-      this.app.debug('Migrating configuration from old plugin "signalk-to-noforeignland"...');
-      fs.copyFileSync(oldConfigFile, newConfigFile);
-      fs.copyFileSync(oldConfigFile, `${oldConfigFile}.backup`);
-      this.app.debug('✓ Configuration migrated successfully');
+      this.app.debug('Migrating configuration from old plugin to new scoped plugin...');
+      this.app.debug(`  Source: ${oldConfigFile}`);
+      this.app.debug(`  Target: ${newConfigFile}`);
+
+      try {
+        // Copy to new location
+        fs.copyFileSync(oldConfigFile, newConfigFile);
+
+        // Create backup of old config
+        const backupFile = `${oldConfigFile}.backup-${Date.now()}`;
+        fs.copyFileSync(oldConfigFile, backupFile);
+
+        this.app.debug('✓ Configuration successfully migrated');
+        this.app.debug(`  Backup saved: ${backupFile}`);
+      } catch (err) {
+        this.app.debug(`⨯ Config migration failed: ${err.message}`);
+        this.app.debug('  You may need to reconfigure the plugin manually');
+      }
+    } else if (fs.existsSync(newConfigFile)) {
+      this.app.debug('Configuration already in new location');
+
+      // Check if config has incorrect "configuration" wrapper and fix it
+      try {
+        const configData = JSON.parse(fs.readFileSync(newConfigFile, 'utf8'));
+        if (configData.configuration && typeof configData.configuration === 'object') {
+          this.app.debug('Detected nested "configuration" wrapper, unwrapping...');
+
+          // Unwrap: move properties from configuration object to root
+          const unwrapped = {
+            ...configData.configuration,
+            enabled: configData.enabled,
+            enableLogging: configData.enableLogging,
+            enableDebug: configData.enableDebug
+          };
+
+          // Backup before fixing
+          const fixBackupFile = `${newConfigFile}.backup-unwrap-${Date.now()}`;
+          fs.copyFileSync(newConfigFile, fixBackupFile);
+
+          // Write fixed config
+          fs.writeFileSync(newConfigFile, JSON.stringify(unwrapped, null, 2));
+          this.app.debug('✓ Configuration unwrapped successfully');
+          this.app.debug(`  Backup: ${fixBackupFile}`);
+        }
+      } catch (err) {
+        this.app.debug(`⨯ Could not check/fix config structure: ${err.message}`);
+      }
+    } else {
+      this.app.debug('No old configuration found, first-time setup');
     }
   }
 
@@ -87,16 +180,11 @@ class PluginCleanup {
       this.app.debug('All old plugins removed successfully');
       return 'all_removed';
     }
-    
-    // Show warning for plugins that couldn't be removed immediately
+
+    // Don't show error immediately - log that we're retrying
     const stillPresentNames = stillPresent.map(p => `"${p.name}"`).join(' and ');
-    const stillPresentCmd = stillPresent.map(p => p.name).join(' ');
-    
-    this.app.setPluginError(
-      `Old plugin(s) ${stillPresentNames} still installed. ` +
-      `Will retry removal, or uninstall manually: cd ${configDir} && npm uninstall ${stillPresentCmd}`
-    );
-    
+    this.app.debug(`Old plugin(s) ${stillPresentNames} still present, will retry removal...`);
+
     // Delayed removal attempts (multiple tries with increasing delays)
     return new Promise((resolve) => {
       const delays = [5000, 15000, 30000]; // 5s, 15s, 30s
@@ -104,12 +192,22 @@ class PluginCleanup {
       
       const attemptRemoval = async () => {
         if (attemptIndex >= delays.length) {
-          // Final attempt failed
+          // Final attempt failed - NOW show error only if plugins still exist
           const remaining = stillPresent.filter(p => fs.existsSync(p.dir));
           if (remaining.length > 0) {
-            const remainingNames = remaining.map(p => p.name).join(' ');
-            this.app.debug(`Could not remove old plugins after multiple attempts: ${remainingNames}`);
-            this.app.debug(`Please manually run: cd ${configDir} && npm uninstall ${remainingNames}`);
+            const remainingNames = remaining.map(p => `"${p.name}"`).join(' and ');
+            const remainingCmd = remaining.map(p => p.name).join(' ');
+
+            this.app.debug(`Could not remove old plugins after ${delays.length} attempts: ${remainingNames}`);
+
+            // Show error with platform-specific commands
+            const isVictronCerbo = configDir === '/data/conf/signalk';
+            const cmdPrefix = isVictronCerbo ? 'On Victron Cerbo GX, ' : '';
+
+            this.app.setPluginError(
+              `${cmdPrefix}Old plugin(s) ${remainingNames} detected. ` +
+              `Manual removal required: cd ${configDir} && npm uninstall ${remainingCmd}`
+            );
             resolve('partial_removal');
           } else {
             this.app.debug('All old plugins eventually removed');

package/lib/TrackSender.js

@@ -36,44 +36,6 @@ class TrackSender {
     } 
   }
 
-  /**
-   * Test internet connectivity
-   */
-  async testInternet() {
-    const dns = require('dns').promises;
-    
-    this.app.debug('testing internet connection');
-    
-    const timeoutMs = this.options.internetTestTimeout || 2000;
-    this.app.debug(`Using internet test timeout: ${timeoutMs}ms`);
-    
-    const dnsServers = [
-      { name: 'Google DNS', ip: '8.8.8.8' },
-      { name: 'Cloudflare DNS', ip: '1.1.1.1' }
-    ];
-    
-    for (const server of dnsServers) {
-      try {
-        const startTime = Date.now();
-        const result = await Promise.race([
-          dns.reverse(server.ip),
-          new Promise((_, reject) => 
-            setTimeout(() => reject(new Error('DNS timeout')), timeoutMs)
-          )
-        ]);
-        const elapsed = Date.now() - startTime;
-        
-        this.app.debug(`internet connection = true, ${server.name} (${server.ip}) is reachable (took ${elapsed}ms)`);
-        return true;
-      } catch (err) {
-        this.app.debug(`${server.name} (${server.ip}) not reachable:`, err.message);
-      }
-    }
-    
-    this.app.debug(`internet connection = false, no public DNS servers reachable (timeout was ${timeoutMs}ms)`);
-    return false;
-  }
-
   /**
    * Check if track file exists and has content
    */

package/package.json

@@ -3,7 +3,7 @@
   "signalk": {
     "id": "@noforeignland/signalk-to-noforeignland"
   },
-  "version": "1.1.0-beta.3",
+  "version": "1.1.0",
   "description": "SignalK track logger to noforeignland.com",
   "main": "index.js",
   "keywords": [
@@ -24,8 +24,7 @@
     "node": ">=18.0.0"
   },
   "scripts": {
-    "test": "echo \"No tests specified\" && exit 0",
-    "postinstall": "node cleanup-old-plugin.js"
+    "test": "echo \"No tests specified\" && exit 0"
   },
   "dependencies": {
     "cron": "^2.1.0",

package/cleanup-old-plugin.js

@@ -1,80 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * Cleanup script for old plugin versions
- * This runs as a standalone script during npm postinstall
- * NOT a class - just a simple executable script
- */
-
-const fs = require('fs');
-const path = require('path');
-
-// Detect SignalK directory (standard ~/.signalk or Victron Cerbo /data/conf/signalk)
-function getSignalKDir() {
-  const victronPath = '/data/conf/signalk';
-  const homePath = path.join(process.env.HOME || '', '.signalk');
-  
-  // Check Victron path first
-  if (fs.existsSync(victronPath)) {
-    return victronPath;
-  }
-  
-  return homePath;
-}
-
-const signalkDir = getSignalKDir();
-console.log(`Using SignalK directory: ${signalkDir}`);
-
-// 1. Migration (only for signalk-to-noforeignland config)
-try {
-  const configPath = path.join(signalkDir, 'plugin-config-data');
-  const oldConfig = path.join(configPath, 'signalk-to-noforeignland.json');
-  const newConfig = path.join(configPath, '@noforeignland-signalk-to-noforeignland.json');
-  
-  if (fs.existsSync(oldConfig) && !fs.existsSync(newConfig)) {
-    fs.copyFileSync(oldConfig, newConfig);
-    fs.copyFileSync(oldConfig, `${oldConfig}.backup`);
-    console.log('✓ Configuration migrated');
-  }
-} catch (e) {
-  console.warn('Could not migrate config:', e.message);
-}
-
-// 2. Uninstall old plugins (with delay so npm can finish)
-setTimeout(() => {
-  try {
-    const oldPlugins = [
-      { dir: path.join(signalkDir, 'node_modules', 'signalk-to-noforeignland'), name: 'signalk-to-noforeignland' },
-      { dir: path.join(signalkDir, 'node_modules', 'signalk-to-nfl'), name: 'signalk-to-nfl' }
-    ];
-    
-    let removedAny = false;
-    const failedPlugins = [];
-    
-    for (const plugin of oldPlugins) {
-      if (fs.existsSync(plugin.dir)) {
-        try {
-          console.log(`Removing old plugin "${plugin.name}"...`);
-          // Direct deletion is safer than npm uninstall during installation
-          fs.rmSync(plugin.dir, { recursive: true, force: true });
-          console.log(`✓ Old plugin "${plugin.name}" removed`);
-          removedAny = true;
-        } catch (e) {
-          console.warn(`Could not remove "${plugin.name}":`, e.message);
-          failedPlugins.push(plugin.name);
-        }
-      }
-    }
-    
-    if (failedPlugins.length > 0) {
-      const uninstallCmd = failedPlugins.join(' ');
-      console.warn(`Please run manually: npm uninstall ${uninstallCmd}`);
-    }
-    
-    if (!removedAny && failedPlugins.length === 0) {
-      console.log('No old plugins found - already clean!');
-    }
-  } catch (e) {
-    console.warn('Error during cleanup:', e.message);
-  }
-}, 2000); // Wait 2 seconds for npm to finish