wyrm-mcp 5.2.1 → 5.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wyrm-mcp",
-  "version": "5.2.1",
+  "version": "5.2.2",
   "description": "🐉 Wyrm - Persistent AI Memory System with encryption, full-text search, and infinite storage",
   "type": "module",
   "main": "dist/index.js",

package/scripts/preinstall.cjs

@@ -1,21 +1,28 @@
 #!/usr/bin/env node
 /**
- * Termux / PRoot compatibility shim.
+ * Pre-install environment shim.
  *
- * On Termux (Bionic libc) and proot-distro'd Linux distros running on top of
- * it, the system compiler is a recent clang/gcc that rejects Node's bundled
- * `-flto=4` flag from its `common.gypi`. When `prebuild-install` times out
- * (which it often does on phone bandwidth or when GitHub releases are slow)
- * and node-gyp falls back to building `better-sqlite3` from source, the
- * compile dies with:
+ * Two things:
  *
- *   cc: error: unsupported argument '4' to option '-flto='
+ * 1. **Termux / PRoot compatibility patch.** On Termux (Bionic libc) and
+ *    proot-distro'd Linux distros running on top of it, the system compiler
+ *    is a recent clang/gcc that rejects Node's bundled `-flto=4` flag from
+ *    its `common.gypi`. When `prebuild-install` times out and node-gyp falls
+ *    back to building `better-sqlite3` from source, the compile dies with:
  *
- * This script detects an Android/Termux/PRoot environment and rewrites the
- * relevant `common.gypi` so the build succeeds without manual intervention.
- * On every other platform it does nothing and exits 0.
+ *      cc: error: unsupported argument '4' to option '-flto='
+ *
+ *    We detect Android-like environments and rewrite the relevant
+ *    `common.gypi` so the build succeeds without manual intervention.
+ *
+ * 2. **Build-tool hint.** On platforms where `better-sqlite3` ships no
+ *    prebuilt binary (anything not in linux/macOS/Windows × x64/arm64), the
+ *    install WILL invoke `node-gyp`. If `gcc`/`g++`/`make`/`python3` aren't
+ *    on PATH, that fails with cryptic errors. We detect the gap up front and
+ *    print the exact install command for the host's package manager.
  *
  * Idempotent. Safe to run multiple times. Failures never block the install.
+ * See TROUBLESHOOTING.md in this repo for the full failure-mode catalogue.
  */
 
 'use strict';
@@ -23,6 +30,7 @@
 const fs = require('fs');
 const path = require('path');
 const os = require('os');
+const cp = require('child_process');
 
 const log = (msg) => process.stdout.write(`[wyrm-mcp preinstall] ${msg}\n`);
 
@@ -93,36 +101,131 @@ function patchGypi(file) {
   }
 }
 
-function main() {
-  // Opt-out for users who don't want us touching node-gyp config.
-  if (process.env.WYRM_SKIP_TERMUX_FIX) {
-    return;
+// ---------------------------------------------------------------------------
+// Build-tool hint (for platforms with no prebuilt better-sqlite3 binary)
+// ---------------------------------------------------------------------------
+
+// Platforms where `better-sqlite3` ships a prebuilt binary. If we're on one of
+// these, prebuild-install handles everything and no compiler is needed.
+const PREBUILT_TARGETS = new Set([
+  'linux-x64',
+  'linux-arm64',
+  'darwin-x64',
+  'darwin-arm64',
+  'win32-x64',
+  'win32-arm64',
+]);
+
+function hasOnPath(cmd) {
+  try {
+    cp.execFileSync(process.platform === 'win32' ? 'where' : 'which', [cmd], {
+      stdio: 'ignore',
+    });
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+function detectPackageManager() {
+  if (process.platform === 'darwin') return { tool: 'brew', pkgs: 'python3' };
+  if (process.platform === 'win32') return null; // node-gyp handles MSVC differently
+  // Linux: sniff /etc/os-release.
+  let osRelease = '';
+  try {
+    osRelease = fs.readFileSync('/etc/os-release', 'utf8').toLowerCase();
+  } catch {
+    return null;
+  }
+  if (/\b(debian|ubuntu|raspbian|mint|kali|pop)\b/.test(osRelease)) {
+    return { tool: 'apt', pkgs: 'build-essential python3' };
   }
+  if (/\b(fedora|rhel|centos|rocky|alma)\b/.test(osRelease)) {
+    return { tool: 'dnf', pkgs: 'gcc gcc-c++ make python3' };
+  }
+  if (/\balpine\b/.test(osRelease)) {
+    return { tool: 'apk', pkgs: 'build-base python3' };
+  }
+  if (/\barch\b/.test(osRelease) || /\bmanjaro\b/.test(osRelease)) {
+    return { tool: 'pacman', pkgs: 'base-devel python' };
+  }
+  if (/\bopensuse\b/.test(osRelease) || /\bsuse\b/.test(osRelease)) {
+    return { tool: 'zypper', pkgs: 'gcc gcc-c++ make python3' };
+  }
+  return null;
+}
 
-  const env = detectAndroidLike();
-  if (!env) {
-    return; // Not Android/Termux/PRoot — nothing to do.
+function installCommand(pm) {
+  switch (pm.tool) {
+    case 'apt': return `sudo apt-get update && sudo apt-get install -y ${pm.pkgs}`;
+    case 'dnf': return `sudo dnf install -y ${pm.pkgs}`;
+    case 'apk': return `sudo apk add --no-cache ${pm.pkgs}`;
+    case 'pacman': return `sudo pacman -S --needed ${pm.pkgs}`;
+    case 'zypper': return `sudo zypper install -y ${pm.pkgs}`;
+    case 'brew': return `brew install ${pm.pkgs}`;
+    default: return `# install: ${pm.pkgs}`;
   }
+}
 
-  const gypis = findGypiCandidates();
-  if (gypis.length === 0) {
-    log(`detected ${env}, but no node-gyp common.gypi found yet — skipping.`);
-    log(`if the native build fails later, re-run install or open an issue.`);
-    return;
+function checkBuildTools() {
+  if (process.env.WYRM_SKIP_BUILD_TOOL_HINT) return;
+
+  const target = `${process.platform}-${process.arch}`;
+  // On prebuilt platforms, prebuild-install handles it. No need to warn.
+  // (Exception: Termux/PRoot, where prebuild-install often times out and we
+  //  fall back to source. The Android branch already ran above; if we get
+  //  here on Android-like, the user already saw our other messages.)
+  if (PREBUILT_TARGETS.has(target) && !detectAndroidLike()) return;
+
+  // Source build is likely. Check the essentials.
+  const needed = process.platform === 'win32'
+    ? ['python']
+    : ['cc', 'make', 'python3'];
+  const missing = needed.filter((c) => !hasOnPath(c));
+  if (missing.length === 0) return;
+
+  log(`heads-up: on ${target} this install will compile better-sqlite3 from source,`);
+  log(`but the following build tools are missing on PATH: ${missing.join(', ')}.`);
+
+  const pm = detectPackageManager();
+  if (pm) {
+    log(`install them with:`);
+    log(`  ${installCommand(pm)}`);
+  } else {
+    log(`install a C/C++ toolchain (gcc or clang), make, and python3 via your package manager.`);
   }
+  log(`see TROUBLESHOOTING.md for more. Suppress this hint with WYRM_SKIP_BUILD_TOOL_HINT=1.`);
+}
+
+// ---------------------------------------------------------------------------
 
-  let patchedAny = false;
-  for (const file of gypis) {
-    if (patchGypi(file)) {
-      log(`patched -flto=4 -> -flto in ${file}`);
-      patchedAny = true;
+function main() {
+  // 1. Termux/PRoot common.gypi patch (opt-out: WYRM_SKIP_TERMUX_FIX=1)
+  if (!process.env.WYRM_SKIP_TERMUX_FIX) {
+    const env = detectAndroidLike();
+    if (env) {
+      const gypis = findGypiCandidates();
+      if (gypis.length === 0) {
+        log(`detected ${env}, but no node-gyp common.gypi found yet — skipping.`);
+        log(`if the native build fails later, re-run install or open an issue.`);
+      } else {
+        let patchedAny = false;
+        for (const file of gypis) {
+          if (patchGypi(file)) {
+            log(`patched -flto=4 -> -flto in ${file}`);
+            patchedAny = true;
+          }
+        }
+        if (patchedAny) {
+          log(`Termux/PRoot compatibility fix applied. To revert, restore .wyrm-preinstall.bak.`);
+          log(`Disable on future installs with WYRM_SKIP_TERMUX_FIX=1.`);
+        }
+      }
     }
   }
 
-  if (patchedAny) {
-    log(`Termux/PRoot compatibility fix applied. To revert, restore .wyrm-preinstall.bak.`);
-    log(`Disable on future installs with WYRM_SKIP_TERMUX_FIX=1.`);
-  }
+  // 2. Build-tool hint (always runs unless suppressed)
+  checkBuildTools();
 }
 
 try {