* Improve postinstall message to detect existing Chrome installations Previously, the npm postinstall script always recommended running `agent-browser install` to download Chrome for Testing, even when users already had a working Chrome installation on their system. This change adds Chrome detection logic to the postinstall script that mirrors the runtime behavior: - Checks for system Chrome installations on macOS, Linux, and Windows - Shows a success message when Chrome is found, indicating it will be used automatically - Only shows the `agent-browser install` warning when no Chrome is detected - Provides platform-specific guidance (Linux `--with-deps` flag, `--executable-path` alternative) The detection logic matches the existing Rust `find_chrome()` implementation to ensure consistency between postinstall messaging and runtime behavior. Fixes #814 * Mention --cdp, --provider, --engine as alternatives in postinstall message --------- Co-authored-by: ctate <366502+ctate@users.noreply.github.com>
286 lines
9.0 KiB
JavaScript
286 lines
9.0 KiB
JavaScript
#!/usr/bin/env node
|
|
|
|
/**
|
|
* Postinstall script for agent-browser
|
|
*
|
|
* Downloads the platform-specific native binary if not present.
|
|
* On global installs, patches npm's bin entry to use the native binary directly:
|
|
* - Windows: Overwrites .cmd/.ps1 shims
|
|
* - Mac/Linux: Replaces symlink to point to native binary
|
|
*/
|
|
|
|
import { existsSync, mkdirSync, chmodSync, createWriteStream, unlinkSync, writeFileSync, symlinkSync, lstatSync } from 'fs';
|
|
import { dirname, join } from 'path';
|
|
import { fileURLToPath } from 'url';
|
|
import { platform, arch } from 'os';
|
|
import { get } from 'https';
|
|
import { execSync } from 'child_process';
|
|
|
|
const __dirname = dirname(fileURLToPath(import.meta.url));
|
|
const projectRoot = join(__dirname, '..');
|
|
const binDir = join(projectRoot, 'bin');
|
|
|
|
// Detect if the system uses musl libc (e.g. Alpine Linux)
|
|
function isMusl() {
|
|
if (platform() !== 'linux') return false;
|
|
try {
|
|
const result = execSync('ldd --version 2>&1 || true', { encoding: 'utf8' });
|
|
return result.toLowerCase().includes('musl');
|
|
} catch {
|
|
return existsSync('/lib/ld-musl-x86_64.so.1') || existsSync('/lib/ld-musl-aarch64.so.1');
|
|
}
|
|
}
|
|
|
|
// Platform detection
|
|
const osKey = platform() === 'linux' && isMusl() ? 'linux-musl' : platform();
|
|
const platformKey = `${osKey}-${arch()}`;
|
|
const ext = platform() === 'win32' ? '.exe' : '';
|
|
const binaryName = `agent-browser-${platformKey}${ext}`;
|
|
const binaryPath = join(binDir, binaryName);
|
|
|
|
// Package info
|
|
const packageJson = JSON.parse(
|
|
(await import('fs')).readFileSync(join(projectRoot, 'package.json'), 'utf8')
|
|
);
|
|
const version = packageJson.version;
|
|
|
|
// GitHub release URL
|
|
const GITHUB_REPO = 'vercel-labs/agent-browser';
|
|
const DOWNLOAD_URL = `https://github.com/${GITHUB_REPO}/releases/download/v${version}/${binaryName}`;
|
|
|
|
async function downloadFile(url, dest) {
|
|
return new Promise((resolve, reject) => {
|
|
const file = createWriteStream(dest);
|
|
|
|
const request = (url) => {
|
|
get(url, (response) => {
|
|
// Handle redirects
|
|
if (response.statusCode === 301 || response.statusCode === 302) {
|
|
request(response.headers.location);
|
|
return;
|
|
}
|
|
|
|
if (response.statusCode !== 200) {
|
|
reject(new Error(`Failed to download: HTTP ${response.statusCode}`));
|
|
return;
|
|
}
|
|
|
|
response.pipe(file);
|
|
file.on('finish', () => {
|
|
file.close();
|
|
resolve();
|
|
});
|
|
}).on('error', (err) => {
|
|
unlinkSync(dest);
|
|
reject(err);
|
|
});
|
|
};
|
|
|
|
request(url);
|
|
});
|
|
}
|
|
|
|
async function main() {
|
|
// Check if binary already exists
|
|
if (existsSync(binaryPath)) {
|
|
// Ensure binary is executable (npm doesn't preserve execute bit)
|
|
if (platform() !== 'win32') {
|
|
chmodSync(binaryPath, 0o755);
|
|
}
|
|
console.log(`✓ Native binary ready: ${binaryName}`);
|
|
|
|
// On global installs, fix npm's bin entry to use native binary directly
|
|
await fixGlobalInstallBin();
|
|
|
|
showInstallReminder();
|
|
return;
|
|
}
|
|
|
|
// Ensure bin directory exists
|
|
if (!existsSync(binDir)) {
|
|
mkdirSync(binDir, { recursive: true });
|
|
}
|
|
|
|
console.log(`Downloading native binary for ${platformKey}...`);
|
|
console.log(`URL: ${DOWNLOAD_URL}`);
|
|
|
|
try {
|
|
await downloadFile(DOWNLOAD_URL, binaryPath);
|
|
|
|
// Make executable on Unix
|
|
if (platform() !== 'win32') {
|
|
chmodSync(binaryPath, 0o755);
|
|
}
|
|
|
|
console.log(`✓ Downloaded native binary: ${binaryName}`);
|
|
} catch (err) {
|
|
console.log(`Could not download native binary: ${err.message}`);
|
|
console.log('');
|
|
console.log('To build the native binary locally:');
|
|
console.log(' 1. Install Rust: https://rustup.rs');
|
|
console.log(' 2. Run: npm run build:native');
|
|
}
|
|
|
|
// On global installs, fix npm's bin entry to use native binary directly
|
|
// This avoids the /bin/sh error on Windows and provides zero-overhead execution
|
|
await fixGlobalInstallBin();
|
|
|
|
showInstallReminder();
|
|
}
|
|
|
|
function findSystemChrome() {
|
|
const os = platform();
|
|
if (os === 'darwin') {
|
|
const candidates = [
|
|
'/Applications/Google Chrome.app/Contents/MacOS/Google Chrome',
|
|
'/Applications/Google Chrome Canary.app/Contents/MacOS/Google Chrome Canary',
|
|
'/Applications/Chromium.app/Contents/MacOS/Chromium',
|
|
];
|
|
return candidates.find(p => existsSync(p)) || null;
|
|
}
|
|
if (os === 'linux') {
|
|
const names = ['google-chrome', 'google-chrome-stable', 'chromium-browser', 'chromium'];
|
|
for (const name of names) {
|
|
try {
|
|
const result = execSync(`which ${name} 2>/dev/null`, { encoding: 'utf8' }).trim();
|
|
if (result) return result;
|
|
} catch {}
|
|
}
|
|
return null;
|
|
}
|
|
if (os === 'win32') {
|
|
const candidates = [
|
|
`${process.env.LOCALAPPDATA}\\Google\\Chrome\\Application\\chrome.exe`,
|
|
'C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe',
|
|
'C:\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe',
|
|
];
|
|
return candidates.find(p => p && existsSync(p)) || null;
|
|
}
|
|
return null;
|
|
}
|
|
|
|
function showInstallReminder() {
|
|
const systemChrome = findSystemChrome();
|
|
if (systemChrome) {
|
|
console.log('');
|
|
console.log(` ✓ System Chrome found: ${systemChrome}`);
|
|
console.log(' agent-browser will use it automatically.');
|
|
console.log('');
|
|
return;
|
|
}
|
|
|
|
console.log('');
|
|
console.log(' ⚠ No Chrome installation detected.');
|
|
console.log(' If you plan to use a local browser, run:');
|
|
console.log('');
|
|
console.log(' agent-browser install');
|
|
if (platform() === 'linux') {
|
|
console.log('');
|
|
console.log(' On Linux, include system dependencies with:');
|
|
console.log('');
|
|
console.log(' agent-browser install --with-deps');
|
|
}
|
|
console.log('');
|
|
console.log(' You can skip this if you use --cdp, --provider, --engine, or --executable-path.');
|
|
console.log('');
|
|
}
|
|
|
|
/**
|
|
* Fix npm's bin entry on global installs to use the native binary directly.
|
|
* This provides zero-overhead CLI execution for global installs.
|
|
*/
|
|
async function fixGlobalInstallBin() {
|
|
if (platform() === 'win32') {
|
|
await fixWindowsShims();
|
|
} else {
|
|
await fixUnixSymlink();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Fix npm symlink on Mac/Linux global installs.
|
|
* Replace the symlink to the JS wrapper with a symlink to the native binary.
|
|
*/
|
|
async function fixUnixSymlink() {
|
|
// Get npm's global bin directory (npm prefix -g + /bin)
|
|
let npmBinDir;
|
|
try {
|
|
const prefix = execSync('npm prefix -g', { encoding: 'utf8' }).trim();
|
|
npmBinDir = join(prefix, 'bin');
|
|
} catch {
|
|
return; // npm not available
|
|
}
|
|
|
|
const symlinkPath = join(npmBinDir, 'agent-browser');
|
|
|
|
// Check if symlink exists (indicates global install)
|
|
try {
|
|
const stat = lstatSync(symlinkPath);
|
|
if (!stat.isSymbolicLink()) {
|
|
return; // Not a symlink, don't touch it
|
|
}
|
|
} catch {
|
|
return; // Symlink doesn't exist, not a global install
|
|
}
|
|
|
|
// Replace symlink to point directly to native binary
|
|
try {
|
|
unlinkSync(symlinkPath);
|
|
symlinkSync(binaryPath, symlinkPath);
|
|
console.log('✓ Optimized: symlink points to native binary (zero overhead)');
|
|
} catch (err) {
|
|
// Permission error or other issue - not critical, JS wrapper still works
|
|
console.log(`⚠ Could not optimize symlink: ${err.message}`);
|
|
console.log(' CLI will work via Node.js wrapper (slightly slower startup)');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Fix npm-generated shims on Windows global installs.
|
|
* npm generates shims that try to run /bin/sh, which doesn't exist on Windows.
|
|
* We overwrite them to invoke the native .exe directly.
|
|
*/
|
|
async function fixWindowsShims() {
|
|
let npmBinDir;
|
|
try {
|
|
npmBinDir = execSync('npm prefix -g', { encoding: 'utf8' }).trim();
|
|
} catch {
|
|
return;
|
|
}
|
|
|
|
const cmdShim = join(npmBinDir, 'agent-browser.cmd');
|
|
const ps1Shim = join(npmBinDir, 'agent-browser.ps1');
|
|
|
|
// Shims may not exist yet during postinstall (npm creates them after
|
|
// lifecycle scripts). If missing, fall back: the JS wrapper at
|
|
// bin/agent-browser.js handles Windows correctly via child_process.spawn.
|
|
if (!existsSync(cmdShim)) {
|
|
return;
|
|
}
|
|
|
|
// Detect architecture so ARM64 Windows is handled correctly
|
|
const cpuArch = arch() === 'arm64' ? 'arm64' : 'x64';
|
|
const relativeBinaryPath = `node_modules\\agent-browser\\bin\\agent-browser-win32-${cpuArch}.exe`;
|
|
const absoluteBinaryPath = join(npmBinDir, relativeBinaryPath);
|
|
|
|
// Only rewrite shims if the native binary actually exists
|
|
if (!existsSync(absoluteBinaryPath)) {
|
|
return;
|
|
}
|
|
|
|
try {
|
|
const cmdContent = `@ECHO off\r\n"%~dp0${relativeBinaryPath}" %*\r\n`;
|
|
writeFileSync(cmdShim, cmdContent);
|
|
|
|
const ps1Content = `#!/usr/bin/env pwsh\r\n$basedir = Split-Path $MyInvocation.MyCommand.Definition -Parent\r\n& "$basedir\\${relativeBinaryPath}" $args\r\nexit $LASTEXITCODE\r\n`;
|
|
writeFileSync(ps1Shim, ps1Content);
|
|
|
|
console.log('✓ Optimized: shims point to native binary (zero overhead)');
|
|
} catch (err) {
|
|
console.log(`⚠ Could not optimize shims: ${err.message}`);
|
|
console.log(' CLI will work via Node.js wrapper (slightly slower startup)');
|
|
}
|
|
}
|
|
|
|
main().catch(console.error);
|