wowok 2.1.12 → 2.1.15

package/scripts/install-better-sqlite3.js

@@ -0,0 +1,377 @@
+#!/usr/bin/env node
+
+/**
+ * better-sqlite3 prebuilt binary installation script
+ *
+ * Hybrid approach (Option B priority, Option A fallback):
+ * 1. First check for local prebuilt binaries (Option B) - priority, no network required
+ * 2. If no matching local version, try downloading from GitHub (Option A)
+ * 3. If download fails, prompt user for manual installation
+ *
+ * This script runs in the following scenarios:
+ * - During development when running npm install
+ * - When users install the wowok package
+ * - When other packages depend on wowok
+ */
+
+import { execSync } from "child_process";
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const GREEN = "\x1b[32m";
+const YELLOW = "\x1b[33m";
+const RED = "\x1b[31m";
+const BLUE = "\x1b[34m";
+const NC = "\x1b[0m";
+
+function log(message) {
+	console.log(message);
+}
+
+function logInfo(message) {
+	console.log(`${BLUE}${message}${NC}`);
+}
+
+function logSuccess(message) {
+	console.log(`${GREEN}${message}${NC}`);
+}
+
+function logWarning(message) {
+	console.log(`${YELLOW}${message}${NC}`);
+}
+
+function logError(message) {
+	console.log(`${RED}${message}${NC}`);
+}
+
+// Detect if currently being installed as a dependency
+function getInstallContext() {
+	const cwd = process.cwd();
+	const isDependency =
+		cwd.includes("node_modules") ||
+		!fs.existsSync(path.join(cwd, "package.json"));
+	return {
+		cwd,
+		isDependency,
+		isDirectInstall: !isDependency,
+	};
+}
+
+function getPlatformInfo() {
+	const platform = process.platform;
+	const arch = process.arch;
+	const nodeAbi = process.versions.modules;
+
+	const platformMap = {
+		linux: "linux",
+		darwin: "darwin",
+		win32: "win32",
+		freebsd: "freebsd",
+	};
+
+	return {
+		platform: platformMap[platform] || platform,
+		arch,
+		nodeAbi,
+		platformKey: `${platform}-${arch}`,
+		fullKey: `node-v${nodeAbi}-${platformMap[platform] || platform}-${arch}`,
+	};
+}
+
+function findLocalPrebuilt(platformInfo, packageRoot) {
+	const prebuildsDir = path.join(packageRoot, "prebuilds");
+
+	if (fs.existsSync(prebuildsDir)) {
+		const files = fs.readdirSync(prebuildsDir);
+
+		const exactPattern = new RegExp(
+			`better-sqlite3-v[\\d.]+-${platformInfo.fullKey}\\.node$`,
+		);
+		for (const file of files) {
+			if (exactPattern.test(file)) {
+				return {
+					path: path.join(prebuildsDir, file),
+					exactMatch: true,
+					source: "package",
+				};
+			}
+		}
+
+		const platformArchPattern = new RegExp(
+			`better-sqlite3-v[\\d.]+-node-v[\\d]+-${platformInfo.platform}-${platformInfo.arch}\\.node$`,
+		);
+		for (const file of files) {
+			if (platformArchPattern.test(file)) {
+				logWarning(
+					`Found similar version: ${file} (Node ABI may not match)`,
+				);
+				return {
+					path: path.join(prebuildsDir, file),
+					exactMatch: false,
+					source: "package",
+				};
+			}
+		}
+	}
+
+	return null;
+}
+
+function copyPrebuiltToBetterSqlite3(
+	sourcePath,
+	betterSqlite3Path,
+	platformInfo,
+) {
+	const targetDir = path.join(betterSqlite3Path, "build", "Release");
+	const targetPath = path.join(targetDir, "better_sqlite3.node");
+
+	fs.mkdirSync(targetDir, { recursive: true });
+	fs.copyFileSync(sourcePath, targetPath);
+
+	const bindingDir = path.join(
+		betterSqlite3Path,
+		"lib",
+		"binding",
+		platformInfo.fullKey,
+	);
+	fs.mkdirSync(bindingDir, { recursive: true });
+	fs.copyFileSync(sourcePath, path.join(bindingDir, "better_sqlite3.node"));
+
+	return targetPath;
+}
+
+function downloadPrebuilt(platformInfo, betterSqlite3Path) {
+	const packageJsonPath = path.join(betterSqlite3Path, "package.json");
+	const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf8"));
+	const version = packageJson.version;
+
+	const downloadUrl = `https://github.com/WiseLibs/better-sqlite3/releases/download/v${version}/better-sqlite3-v${version}-${platformInfo.fullKey}.tar.gz`;
+
+	const tempDir = path.join(betterSqlite3Path, ".download-temp");
+	fs.mkdirSync(tempDir, { recursive: true });
+	const tempFile = path.join(tempDir, "prebuilt.tar.gz");
+
+	try {
+		if (process.platform === "win32") {
+			execSync(
+				`powershell -Command "Invoke-WebRequest -Uri '${downloadUrl}' -OutFile '${tempFile}'"`,
+				{
+					stdio: "pipe",
+				},
+			);
+		} else {
+			execSync(`curl -L -o "${tempFile}" "${downloadUrl}"`, {
+				stdio: "pipe",
+			});
+		}
+
+		const extractDir = path.join(tempDir, "extracted");
+		fs.mkdirSync(extractDir, { recursive: true });
+		execSync(`tar -xzf "${tempFile}" -C "${extractDir}"`, {
+			stdio: "pipe",
+		});
+
+		const files = fs.readdirSync(extractDir);
+		const nodeFile = files.find((f) => f.endsWith(".node"));
+
+		if (!nodeFile) {
+			throw new Error(".node file not found");
+		}
+
+		const sourcePath = path.join(extractDir, nodeFile);
+		const targetPath = copyPrebuiltToBetterSqlite3(
+			sourcePath,
+			betterSqlite3Path,
+			platformInfo,
+		);
+
+		fs.rmSync(tempDir, { recursive: true, force: true });
+
+		return targetPath;
+	} catch (error) {
+		if (fs.existsSync(tempDir)) {
+			fs.rmSync(tempDir, { recursive: true, force: true });
+		}
+		throw error;
+	}
+}
+
+function tryPrebuildInstall(betterSqlite3Path) {
+	try {
+		execSync("npx prebuild-install --verbose", {
+			cwd: betterSqlite3Path,
+			stdio: "pipe",
+		});
+		return fs.existsSync(
+			path.join(
+				betterSqlite3Path,
+				"build",
+				"Release",
+				"better_sqlite3.node",
+			),
+		);
+	} catch (error) {
+		return false;
+	}
+}
+
+function main() {
+	const context = getInstallContext();
+	const platformInfo = getPlatformInfo();
+
+	const packageRoot = __dirname.includes("node_modules")
+		? path.resolve(__dirname, "..")
+		: process.cwd();
+
+	const isSilent = context.isDependency;
+
+	if (!isSilent) {
+		log(`${BLUE}=== better-sqlite3 Prebuilt Binary Installation ===${NC}`);
+		logInfo(`Platform: ${platformInfo.platform}-${platformInfo.arch}`);
+		logInfo(`Node.js ABI: node-v${platformInfo.nodeAbi}`);
+	}
+
+	const possiblePaths = [
+		path.join(packageRoot, "node_modules", "better-sqlite3"),
+		path.join(process.cwd(), "node_modules", "better-sqlite3"),
+		path.join(packageRoot, "..", "better-sqlite3"),
+	];
+
+	let betterSqlite3Path = null;
+	for (const p of possiblePaths) {
+		if (fs.existsSync(p)) {
+			betterSqlite3Path = p;
+			break;
+		}
+	}
+
+	if (!betterSqlite3Path) {
+		if (!isSilent) {
+			logWarning(
+				"better-sqlite3 not installed, skipping prebuilt binary installation",
+			);
+			logInfo(
+				"Tip: To use SQLite features, run: npm install better-sqlite3",
+			);
+		}
+		return;
+	}
+
+	const prebuiltPath = path.join(
+		betterSqlite3Path,
+		"build",
+		"Release",
+		"better_sqlite3.node",
+	);
+	if (fs.existsSync(prebuiltPath)) {
+		if (!isSilent) {
+			logSuccess("better-sqlite3 prebuilt binary already exists");
+		}
+		return;
+	}
+
+	if (!isSilent) {
+		logInfo("");
+		logInfo("Step 1: Looking for local prebuilt binaries...");
+	}
+
+	const localPrebuilt = findLocalPrebuilt(platformInfo, packageRoot);
+
+	if (localPrebuilt) {
+		try {
+			copyPrebuiltToBetterSqlite3(
+				localPrebuilt.path,
+				betterSqlite3Path,
+				platformInfo,
+			);
+			if (!isSilent) {
+				if (localPrebuilt.exactMatch) {
+					logSuccess(
+						"Installed successfully using local prebuilt binary!",
+					);
+				} else {
+					logWarning(
+						"Installed using similar version, but Node ABI may not match",
+					);
+					logInfo(
+						"  If issues occur, consider downloading matching version from GitHub",
+					);
+				}
+			}
+			return;
+		} catch (error) {
+			if (!isSilent) {
+				logError(`Failed to use local version: ${error.message}`);
+			}
+		}
+	} else if (!isSilent) {
+		logInfo("No local prebuilt binaries found");
+	}
+
+	if (!isSilent) {
+		logInfo("");
+		logInfo("Step 2: Trying to download prebuilt binary from GitHub...");
+	}
+
+	if (tryPrebuildInstall(betterSqlite3Path)) {
+		if (!isSilent) {
+			logSuccess("Downloaded successfully via prebuild-install!");
+		}
+		return;
+	}
+
+	try {
+		downloadPrebuilt(platformInfo, betterSqlite3Path);
+		if (!isSilent) {
+			logSuccess("Downloaded and installed successfully from GitHub!");
+		}
+		return;
+	} catch (error) {
+		if (!isSilent) {
+			logError(`Download failed: ${error.message}`);
+		}
+	}
+
+	if (!isSilent) {
+		logInfo("");
+		logWarning("========================================");
+		logWarning("better-sqlite3 prebuilt binary installation failed");
+		logWarning("========================================");
+		logInfo("");
+		logInfo("You can try the following solutions:");
+		logInfo("");
+		logInfo("1. Manually download prebuilt binary:");
+		logInfo(
+			`   Visit: https://github.com/WiseLibs/better-sqlite3/releases`,
+		);
+		logInfo(
+			`   Download: better-sqlite3-v{version}-${platformInfo.fullKey}.tar.gz`,
+		);
+		logInfo(`   Extract to: ${betterSqlite3Path}/build/Release/`);
+		logInfo("");
+		logInfo("2. Build from source (requires Python and C++ toolchain):");
+		logInfo("   npm install better-sqlite3 --build-from-source");
+		logInfo("");
+		logInfo("3. Use a compatible Node.js version:");
+		logInfo(
+			"   Check: https://github.com/WiseLibs/better-sqlite3/releases",
+		);
+		logInfo("   Find matching prebuilt binaries");
+		logInfo("");
+		logWarning("Note: better-sqlite3 will attempt to compile on first use");
+		logWarning("      Runtime errors may occur if build tools are missing");
+	} else {
+		logWarning(
+			`[wowok] better-sqlite3 prebuilt binary installation failed (${platformInfo.fullKey})`,
+		);
+		logWarning(
+			"[wowok] For SQLite features, manually install prebuilt binary or build toolchain",
+		);
+	}
+}
+
+main();