peekinside 1.2.1 → 1.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "peekinside",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "Debug Node.js from the inside: errors with the requests, queries, logs and jobs behind them. A free local dashboard, and encrypted monitoring for production",
   "main": "index.js",
   "types": "./index.d.ts",

package/src/cli.js

@@ -70,6 +70,9 @@ export class Cli {
    * @throws {Error} When the hub did not start in time
    */
   async start(openBrowser) {
+    // A hub left running by an older PeekInside is replaced by this version's (its data stays).
+    const replaced = await this.hub.replaceIfOlder();
+    if (replaced) console.log(`Restarted PeekInside Local: it was version ${replaced}, now ${VERSION}.`);
     let running = await this.hub.status();
     if (!running) {
       this.hub.spawn();

package/src/hub/client.js

@@ -9,7 +9,7 @@ import fs from 'fs';
 import http from 'http';
 import path from 'path';
 import { fileURLToPath } from 'url';
-import { HUB_APP_ID, VERSION, settings } from '../config.js';
+import { HUB_API_VERSION, HUB_APP_ID, VERSION, settings } from '../config.js';
 
 const HUB_ENTRY = fileURLToPath(new URL('./entry.js', import.meta.url));
 
@@ -153,6 +153,50 @@ export class HubClient {
     }
   }
 
+  /**
+   * Replaces a running hub from an older PeekInside with this version's. Hubs outlive the apps
+   * that start them, so after an upgrade the old one would keep serving, its dashboard page
+   * included. Only a hub with the same API and data folder is replaced, so its data stays, and
+   * only the process hub.json names, so nothing else listening on the port is ever stopped.
+   *
+   * @returns {Promise<string|null>} The version that was replaced, or null when none was
+   */
+  async replaceIfOlder() {
+    const running = await this.status().catch(() => null);
+    const dataDir = settings.dataDir();
+    if (!HubClient.shouldReplace(running, { version: VERSION, dataDir, infoPid: readInfoPid(dataDir) })) return null;
+    try {
+      process.kill(running.pid, 'SIGTERM');
+    } catch (error) {
+      return null;
+    }
+    for (let attempt = 0; attempt < 50; attempt++) {
+      await new Promise((resolve) => setTimeout(resolve, 100));
+      if (!(await this.status().catch(() => null))) {
+        this.spawn();
+        await this.waitUntilReady(8000).catch(() => null);
+        return running.version;
+      }
+    }
+    return null;
+  }
+
+  /**
+   * Whether a running hub is an older version than this one that may be replaced: same API, same
+   * data folder, and the process its hub.json names.
+   *
+   * @param {Object|null} running - Its GET /api/status
+   * @param {{ version: string, dataDir: string, infoPid: number|null }} self - This version, its
+   *   data folder, and the pid in that folder's hub.json
+   * @returns {boolean}
+   */
+  static shouldReplace(running, { version, dataDir, infoPid }) {
+    if (!running || running.apiVersion !== HUB_API_VERSION) return false;
+    if (!Number.isInteger(running.pid) || running.pid !== infoPid || running.pid === process.pid) return false;
+    if (typeof running.dataDir !== 'string' || path.resolve(running.dataDir) !== path.resolve(dataDir)) return false;
+    return compareVersions(running.version, version) < 0;
+  }
+
   /**
    * Waits until the hub answers.
    *
@@ -182,3 +226,34 @@ export class HubClient {
     if (this.agent) this.agent.destroy();
   }
 }
+
+// The pid in the data folder's hub.json (written by the hub that runs), or null.
+function readInfoPid(dataDir) {
+  try {
+    const info = JSON.parse(fs.readFileSync(path.join(dataDir, 'hub.json'), 'utf8'));
+    return Number.isInteger(info.pid) ? info.pid : null;
+  } catch (error) {
+    return null;
+  }
+}
+
+/**
+ * Compares two versions by major, minor and patch ("1.10.0" is after "1.9.3"). Anything after the
+ * patch number (a prerelease) is ignored, and versions that can't be read compare as equal, so
+ * nothing is replaced on a guess.
+ *
+ * @param {string} a
+ * @param {string} b
+ * @returns {number} Negative when a is older, positive when newer, 0 otherwise
+ */
+export function compareVersions(a, b) {
+  const parse = (value) => /^(\d+)\.(\d+)\.(\d+)/.exec(String(value || ''));
+  const left = parse(a);
+  const right = parse(b);
+  if (!left || !right) return 0;
+  for (let index = 1; index <= 3; index++) {
+    const difference = Number(left[index]) - Number(right[index]);
+    if (difference) return difference;
+  }
+  return 0;
+}

package/src/transport/local.js

@@ -79,6 +79,7 @@ export class LocalTransport extends BatchTransport {
     this.blocked = new BlockedRequests();
     this.blockedWarnings = new Set();
     this.outdatedHubNoted = false;
+    this.hubVersionChecked = false;
   }
 
   /**
@@ -198,6 +199,12 @@ export class LocalTransport extends BatchTransport {
   // Sends the batch with the blocked-request counts gathered since the last batch. Records are
   // dropped only when the hub refuses them; when it isn't reachable, both are kept for later.
   async _deliver(batch) {
+    // Once per process: a hub left running by an older PeekInside is replaced by this version's.
+    if (!this.hubVersionChecked) {
+      this.hubVersionChecked = true;
+      const replaced = await this.hub.replaceIfOlder().catch(() => null);
+      if (replaced) console.log(`${LOG_PREFIX} Restarted the local dashboard: it was PeekInside ${replaced}, and this app uses ${VERSION}.`);
+    }
     const blocked = this.blocked.take();
     const samples = this.takeSamples();
     const { requests, exceptions, jobs, logs } = BatchTransport.split(batch);