c0f6f9ef2a
* Add `BrowserTool` * add some logging * go with npm install -g * remove dep changes since the switch to npm install -g * tweak * tweak * tweak * tweak * tweak timeout * tweak * remove logs * skill investigation doc * wip * wip * tweak * lock agent-browser version * tweak * logs * logs * more logs * more debug stuff * try this * try this * try this * fix PATH * try this * tweak * tweak * tweak * update wiki entries * update wiki once again * lint fix --------- Co-authored-by: Colin McDonnell <colinmcd94@gmail.com>
487 lines
16 KiB
TypeScript
487 lines
16 KiB
TypeScript
import { spawnSync } from "node:child_process";
|
|
import { chmodSync, createWriteStream, existsSync, mkdirSync } from "node:fs";
|
|
import { mkdtemp } from "node:fs/promises";
|
|
import { tmpdir } from "node:os";
|
|
import { join } from "node:path";
|
|
import { pipeline } from "node:stream/promises";
|
|
import { setTimeout as sleep } from "node:timers/promises";
|
|
import { log } from "./cli.ts";
|
|
|
|
export interface InstallFromNpmTarballParams {
|
|
packageName: string;
|
|
version: string;
|
|
executablePath: string;
|
|
installDependencies?: boolean;
|
|
}
|
|
|
|
export interface InstallFromCurlParams {
|
|
installUrl: string;
|
|
executableName: string;
|
|
}
|
|
|
|
export interface InstallFromDirectTarballParams {
|
|
url: string;
|
|
executablePath: string;
|
|
stripComponents?: number;
|
|
}
|
|
|
|
export interface InstallFromGithubParams {
|
|
owner: string;
|
|
repo: string;
|
|
tag?: string;
|
|
assetName?: string;
|
|
executablePath?: string;
|
|
githubInstallationToken?: string;
|
|
}
|
|
|
|
export interface InstallFromGithubTarballParams {
|
|
owner: string;
|
|
repo: string;
|
|
tag?: string;
|
|
assetNamePattern: string;
|
|
executablePath: string;
|
|
githubInstallationToken?: string;
|
|
}
|
|
|
|
interface NpmRegistryData {
|
|
"dist-tags": { latest: string };
|
|
versions: Record<string, unknown>;
|
|
}
|
|
|
|
/**
|
|
* Install a CLI tool from an npm package tarball
|
|
* Downloads the tarball, extracts it to a temp directory, and returns the path to the CLI executable
|
|
* The temp directory will be cleaned up by the OS automatically
|
|
*/
|
|
export async function installFromNpmTarball(params: InstallFromNpmTarballParams): Promise<string> {
|
|
const tempDir = process.env.PULLFROG_TEMP_DIR;
|
|
if (!tempDir) throw new Error("PULLFROG_TEMP_DIR is not set");
|
|
|
|
const extractedDir = join(tempDir, "package");
|
|
const cliPath = join(extractedDir, params.executablePath);
|
|
|
|
if (existsSync(cliPath)) {
|
|
log.debug(`» using cached binary at ${cliPath}`);
|
|
return cliPath;
|
|
}
|
|
|
|
// Resolve version if it's a range or "latest"
|
|
let resolvedVersion = params.version;
|
|
if (
|
|
params.version.startsWith("^") ||
|
|
params.version.startsWith("~") ||
|
|
params.version === "latest"
|
|
) {
|
|
const npmRegistry = process.env.NPM_REGISTRY || "https://registry.npmjs.org";
|
|
log.debug(`» resolving version for ${params.version}...`);
|
|
try {
|
|
const registryResponse = await fetch(`${npmRegistry}/${params.packageName}`);
|
|
if (!registryResponse.ok) {
|
|
throw new Error(`Failed to query registry: ${registryResponse.status}`);
|
|
}
|
|
const registryData = (await registryResponse.json()) as NpmRegistryData;
|
|
resolvedVersion = registryData["dist-tags"].latest;
|
|
log.debug(`» resolved to version ${resolvedVersion}`);
|
|
} catch (error) {
|
|
log.warning(
|
|
`Failed to resolve version from registry: ${error instanceof Error ? error.message : String(error)}`
|
|
);
|
|
throw error;
|
|
}
|
|
}
|
|
|
|
log.debug(`» installing ${params.packageName}@${resolvedVersion}...`);
|
|
|
|
const tarballPath = join(tempDir, "package.tgz");
|
|
|
|
// Download tarball from npm
|
|
const npmRegistry = process.env.NPM_REGISTRY || "https://registry.npmjs.org";
|
|
// Handle scoped packages (e.g., @scope/package -> @scope%2Fpackage/-/package-version.tgz)
|
|
let tarballUrl: string;
|
|
if (params.packageName.startsWith("@")) {
|
|
const [scope, name] = params.packageName.slice(1).split("/");
|
|
const scopedPackageName = `@${scope}%2F${name}`;
|
|
tarballUrl = `${npmRegistry}/${scopedPackageName}/-/${name}-${resolvedVersion}.tgz`;
|
|
} else {
|
|
tarballUrl = `${npmRegistry}/${params.packageName}/-/${params.packageName}-${resolvedVersion}.tgz`;
|
|
}
|
|
|
|
log.debug(`» downloading from ${tarballUrl}...`);
|
|
const response = await fetch(tarballUrl);
|
|
if (!response.ok) {
|
|
throw new Error(`Failed to download tarball: ${response.status} ${response.statusText}`);
|
|
}
|
|
|
|
// Write tarball to file
|
|
if (!response.body) throw new Error("Response body is null");
|
|
const fileStream = createWriteStream(tarballPath);
|
|
await pipeline(response.body, fileStream);
|
|
log.debug(`» downloaded tarball to ${tarballPath}`);
|
|
|
|
// Extract tarball
|
|
log.debug(`» extracting tarball...`);
|
|
const extractResult = spawnSync("tar", ["-xzf", tarballPath, "-C", tempDir], {
|
|
stdio: "pipe",
|
|
encoding: "utf-8",
|
|
});
|
|
if (extractResult.status !== 0) {
|
|
throw new Error(
|
|
`Failed to extract tarball: ${extractResult.stderr || extractResult.stdout || "Unknown error"}`
|
|
);
|
|
}
|
|
|
|
if (!existsSync(cliPath)) {
|
|
throw new Error(`Executable not found in extracted package at ${cliPath}`);
|
|
}
|
|
|
|
// Install dependencies if requested
|
|
if (params.installDependencies) {
|
|
log.debug(`» installing dependencies for ${params.packageName}...`);
|
|
const installResult = spawnSync("npm", ["install", "--production"], {
|
|
cwd: extractedDir,
|
|
stdio: "pipe",
|
|
encoding: "utf-8",
|
|
});
|
|
if (installResult.status !== 0) {
|
|
throw new Error(
|
|
`Failed to install dependencies: ${installResult.stderr || installResult.stdout || "Unknown error"}`
|
|
);
|
|
}
|
|
log.debug(`» dependencies installed`);
|
|
}
|
|
|
|
// Make the file executable
|
|
chmodSync(cliPath, 0o755);
|
|
|
|
log.debug(`» ${params.packageName} installed at ${cliPath}`);
|
|
|
|
return cliPath;
|
|
}
|
|
|
|
/**
|
|
* Fetch with retry logic if Retry-After header is present
|
|
*/
|
|
async function fetchWithRetry(
|
|
url: string,
|
|
headers: Record<string, string>,
|
|
errorMessage: string
|
|
): Promise<Response> {
|
|
const response = await fetch(url, { headers });
|
|
if (!response.ok) {
|
|
const retryAfter = response.headers.get("Retry-After") || response.headers.get("retry-after");
|
|
if (retryAfter) {
|
|
const waitSeconds = parseInt(retryAfter, 10);
|
|
if (!Number.isNaN(waitSeconds) && waitSeconds > 0) {
|
|
log.info(`» rate limited, waiting ${waitSeconds} seconds before retry...`);
|
|
await sleep(waitSeconds * 1000);
|
|
const retryResponse = await fetch(url, { headers });
|
|
if (!retryResponse.ok) {
|
|
throw new Error(
|
|
`${errorMessage}: ${retryResponse.status} ${retryResponse.statusText} (retry failed)`
|
|
);
|
|
}
|
|
return retryResponse;
|
|
}
|
|
}
|
|
throw new Error(`${errorMessage}: ${response.status} ${response.statusText}`);
|
|
}
|
|
return response;
|
|
}
|
|
|
|
/**
|
|
* Install a CLI tool from GitHub releases
|
|
* Downloads the latest release asset from GitHub and returns the path to the executable
|
|
* The temp directory will be cleaned up by the OS automatically
|
|
*/
|
|
export async function installFromGithub(params: InstallFromGithubParams): Promise<string> {
|
|
// use a deterministic subdir in PULLFROG_TEMP_DIR so repeated calls are cached
|
|
const pullfrogTemp = process.env.PULLFROG_TEMP_DIR;
|
|
const installDir = pullfrogTemp
|
|
? join(pullfrogTemp, `github-${params.owner}-${params.repo}`)
|
|
: await mkdtemp(join(tmpdir(), `${params.owner}-${params.repo}-github-`));
|
|
|
|
const expectedCliPath = join(installDir, params.executablePath ?? params.assetName ?? "asset");
|
|
|
|
if (existsSync(expectedCliPath)) {
|
|
log.debug(`» using cached binary at ${expectedCliPath}`);
|
|
return expectedCliPath;
|
|
}
|
|
|
|
log.info(`» installing ${params.owner}/${params.repo} from GitHub releases...`);
|
|
|
|
// fetch release from GitHub API (pinned tag or latest)
|
|
const releaseUrl = params.tag
|
|
? `https://api.github.com/repos/${params.owner}/${params.repo}/releases/tags/${params.tag}`
|
|
: `https://api.github.com/repos/${params.owner}/${params.repo}/releases/latest`;
|
|
log.debug(`» fetching release from ${releaseUrl}...`);
|
|
|
|
const headers: Record<string, string> = {};
|
|
if (params.githubInstallationToken) {
|
|
headers.Authorization = `Bearer ${params.githubInstallationToken}`;
|
|
}
|
|
|
|
const releaseResponse = await fetchWithRetry(releaseUrl, headers, "Failed to fetch release");
|
|
|
|
const releaseData = (await releaseResponse.json()) as {
|
|
tag_name: string;
|
|
assets: Array<{
|
|
name: string;
|
|
browser_download_url: string;
|
|
}>;
|
|
};
|
|
|
|
log.debug(`» found release ${releaseData.tag_name}`);
|
|
|
|
const asset = releaseData.assets.find((a) => a.name === params.assetName);
|
|
if (!asset) {
|
|
throw new Error(`Asset '${params.assetName}' not found in release ${releaseData.tag_name}`);
|
|
}
|
|
const assetUrl = asset.browser_download_url;
|
|
|
|
log.debug(`» downloading asset from ${assetUrl}...`);
|
|
|
|
mkdirSync(installDir, { recursive: true });
|
|
|
|
// determine file extension and download path
|
|
const urlPath = new URL(assetUrl).pathname;
|
|
const fileName = urlPath.split("/").pop() || "asset";
|
|
const downloadPath = join(installDir, fileName);
|
|
|
|
// download the asset
|
|
const assetResponse = await fetchWithRetry(assetUrl, headers, "Failed to download asset");
|
|
|
|
if (!assetResponse.body) throw new Error("Response body is null");
|
|
const fileStream = createWriteStream(downloadPath);
|
|
await pipeline(assetResponse.body, fileStream);
|
|
log.debug(`» downloaded asset to ${downloadPath}`);
|
|
|
|
// determine the executable path
|
|
const cliPath = params.executablePath ? join(installDir, params.executablePath) : downloadPath;
|
|
|
|
if (!existsSync(cliPath)) {
|
|
throw new Error(`Executable not found at ${cliPath}`);
|
|
}
|
|
|
|
chmodSync(cliPath, 0o755);
|
|
log.info(`» installed from GitHub release at ${cliPath}`);
|
|
|
|
return cliPath;
|
|
}
|
|
|
|
/**
|
|
* Install a CLI tool from a GitHub release tarball
|
|
* Downloads the tar.gz from GitHub releases, extracts it, and returns the path to the CLI executable
|
|
* The temp directory will be cleaned up by the OS automatically
|
|
*/
|
|
export async function installFromGithubTarball(
|
|
params: InstallFromGithubTarballParams
|
|
): Promise<string> {
|
|
const tempDir = process.env.PULLFROG_TEMP_DIR;
|
|
if (!tempDir) throw new Error("PULLFROG_TEMP_DIR is not set");
|
|
|
|
const cliPath = join(tempDir, params.executablePath);
|
|
|
|
if (existsSync(cliPath)) {
|
|
log.debug(`» using cached binary at ${cliPath}`);
|
|
return cliPath;
|
|
}
|
|
|
|
log.info(`» installing ${params.owner}/${params.repo} from GitHub releases...`);
|
|
|
|
// determine platform-specific asset name
|
|
const os = process.platform === "darwin" ? "darwin" : "linux";
|
|
const arch = process.arch === "arm64" ? "arm64" : "x64";
|
|
const assetName = params.assetNamePattern.replace("{os}", os).replace("{arch}", arch);
|
|
|
|
// fetch release from GitHub API (pinned tag or latest)
|
|
const releaseUrl = params.tag
|
|
? `https://api.github.com/repos/${params.owner}/${params.repo}/releases/tags/${params.tag}`
|
|
: `https://api.github.com/repos/${params.owner}/${params.repo}/releases/latest`;
|
|
log.info(`» fetching release from ${releaseUrl}...`);
|
|
|
|
const headers: Record<string, string> = {};
|
|
if (params.githubInstallationToken) {
|
|
headers.Authorization = `Bearer ${params.githubInstallationToken}`;
|
|
}
|
|
|
|
const releaseResponse = await fetchWithRetry(releaseUrl, headers, "Failed to fetch release");
|
|
|
|
const releaseData = (await releaseResponse.json()) as {
|
|
tag_name: string;
|
|
assets: Array<{
|
|
name: string;
|
|
browser_download_url: string;
|
|
}>;
|
|
};
|
|
|
|
log.debug(`» found release: ${releaseData.tag_name}`);
|
|
|
|
const asset = releaseData.assets.find((a) => a.name === assetName);
|
|
if (!asset) {
|
|
throw new Error(`Asset '${assetName}' not found in release ${releaseData.tag_name}`);
|
|
}
|
|
const assetUrl = asset.browser_download_url;
|
|
|
|
log.debug(`» downloading asset from ${assetUrl}...`);
|
|
|
|
const tarballPath = join(tempDir, assetName);
|
|
|
|
// download the asset
|
|
const assetResponse = await fetchWithRetry(assetUrl, headers, "Failed to download asset");
|
|
|
|
if (!assetResponse.body) throw new Error("Response body is null");
|
|
const fileStream = createWriteStream(tarballPath);
|
|
await pipeline(assetResponse.body, fileStream);
|
|
log.debug(`» downloaded tarball to ${tarballPath}`);
|
|
|
|
// extract tar.gz
|
|
log.debug(`» extracting tarball...`);
|
|
const extractResult = spawnSync("tar", ["-xzf", tarballPath, "-C", tempDir], {
|
|
stdio: "pipe",
|
|
encoding: "utf-8",
|
|
});
|
|
if (extractResult.status !== 0) {
|
|
throw new Error(
|
|
`Failed to extract tarball: ${extractResult.stderr || extractResult.stdout || "Unknown error"}`
|
|
);
|
|
}
|
|
|
|
if (!existsSync(cliPath)) {
|
|
throw new Error(`Executable not found in extracted tarball at ${cliPath}`);
|
|
}
|
|
|
|
// make the file executable
|
|
chmodSync(cliPath, 0o755);
|
|
|
|
log.info(`» ${params.owner}/${params.repo} installed at ${cliPath}`);
|
|
|
|
return cliPath;
|
|
}
|
|
|
|
/**
|
|
* Install a CLI tool from a direct tarball URL.
|
|
* Downloads the tarball, extracts it to a temp directory, and returns the path to the CLI executable.
|
|
*/
|
|
export async function installFromDirectTarball(
|
|
params: InstallFromDirectTarballParams
|
|
): Promise<string> {
|
|
const tempDir = process.env.PULLFROG_TEMP_DIR;
|
|
if (!tempDir) throw new Error("PULLFROG_TEMP_DIR is not set");
|
|
|
|
const extractDir = join(tempDir, "direct-package");
|
|
const cliPath = join(extractDir, params.executablePath);
|
|
|
|
if (existsSync(cliPath)) {
|
|
log.debug(`» using cached binary at ${cliPath}`);
|
|
return cliPath;
|
|
}
|
|
|
|
log.info(`» downloading tarball from ${params.url}...`);
|
|
|
|
const tarballPath = join(tempDir, "direct-package.tgz");
|
|
|
|
const response = await fetchWithRetry(params.url, {}, "failed to download tarball");
|
|
if (!response.body) throw new Error("response body is null");
|
|
|
|
const fileStream = createWriteStream(tarballPath);
|
|
await pipeline(response.body, fileStream);
|
|
log.debug(`» downloaded tarball to ${tarballPath}`);
|
|
|
|
mkdirSync(extractDir, { recursive: true });
|
|
|
|
const tarArgs = ["-xzf", tarballPath, "-C", extractDir];
|
|
if (params.stripComponents !== undefined && params.stripComponents > 0) {
|
|
tarArgs.push(`--strip-components=${Math.floor(params.stripComponents)}`);
|
|
}
|
|
|
|
log.debug(`» extracting tarball...`);
|
|
const extractResult = spawnSync("tar", tarArgs, {
|
|
stdio: "pipe",
|
|
encoding: "utf-8",
|
|
});
|
|
if (extractResult.status !== 0) {
|
|
throw new Error(
|
|
`failed to extract tarball: ${extractResult.stderr || extractResult.stdout || "unknown error"}`
|
|
);
|
|
}
|
|
|
|
if (!existsSync(cliPath)) {
|
|
throw new Error(`executable not found in extracted tarball at ${cliPath}`);
|
|
}
|
|
|
|
chmodSync(cliPath, 0o755);
|
|
log.info(`» installed at ${cliPath}`);
|
|
|
|
return cliPath;
|
|
}
|
|
|
|
/**
|
|
* Install a CLI tool from a curl-based install script
|
|
* Downloads the install script, runs it with HOME set to temp directory, and returns the path to the CLI executable
|
|
* The temp directory will be cleaned up by the OS automatically
|
|
*/
|
|
export async function installFromCurl(params: InstallFromCurlParams): Promise<string> {
|
|
const tempDir = process.env.PULLFROG_TEMP_DIR;
|
|
if (!tempDir) throw new Error("PULLFROG_TEMP_DIR is not set");
|
|
|
|
const cliPath = join(tempDir, ".local", "bin", params.executableName);
|
|
|
|
if (existsSync(cliPath)) {
|
|
log.debug(`» using cached binary at ${cliPath}`);
|
|
return cliPath;
|
|
}
|
|
|
|
log.info(`» installing ${params.executableName}...`);
|
|
|
|
const installScriptPath = join(tempDir, "install.sh");
|
|
|
|
// Download the install script
|
|
log.debug(`» downloading install script from ${params.installUrl}...`);
|
|
const installScriptResponse = await fetch(params.installUrl);
|
|
if (!installScriptResponse.ok) {
|
|
throw new Error(`Failed to download install script: ${installScriptResponse.status}`);
|
|
}
|
|
|
|
if (!installScriptResponse.body) throw new Error("Response body is null");
|
|
const fileStream = createWriteStream(installScriptPath);
|
|
await pipeline(installScriptResponse.body, fileStream);
|
|
log.debug(`» downloaded install script to ${installScriptPath}`);
|
|
|
|
// Make install script executable
|
|
chmodSync(installScriptPath, 0o755);
|
|
|
|
log.debug(`» installing to temp directory at ${tempDir}...`);
|
|
|
|
const installResult = spawnSync("bash", [installScriptPath], {
|
|
cwd: tempDir,
|
|
env: {
|
|
// Run the install script with HOME set to temp directory
|
|
// ensuring a fresh install for each run
|
|
HOME: tempDir,
|
|
// XDG_CONFIG_HOME must match HOME so CLI tools find config in the right place
|
|
XDG_CONFIG_HOME: join(tempDir, ".config"),
|
|
SHELL: process.env.SHELL,
|
|
USER: process.env.USER,
|
|
},
|
|
stdio: "pipe",
|
|
encoding: "utf-8",
|
|
});
|
|
|
|
if (installResult.status !== 0) {
|
|
const errorOutput = installResult.stderr || installResult.stdout || "No output";
|
|
throw new Error(
|
|
`Failed to install ${params.executableName}. Install script exited with code ${installResult.status}. Output: ${errorOutput}`
|
|
);
|
|
}
|
|
|
|
if (!existsSync(cliPath)) {
|
|
throw new Error(`Executable not found at ${cliPath}`);
|
|
}
|
|
|
|
// Ensure binary is executable
|
|
chmodSync(cliPath, 0o755);
|
|
log.info(`» ${params.executableName} installed at ${cliPath}`);
|
|
|
|
return cliPath;
|
|
}
|