Skip to content

A personal assistant that lives on your desktop, remembers what matters, and can use your Mac for you.

TypeScript
3.2 KB
Raw Blame
import { execFileSync } from "node:child_process";
import { accessSync, constants, statSync } from "node:fs";
import { homedir } from "node:os";
import { isAbsolute, join, resolve } from "node:path";

/**
 * The installed app's runtime folder (`GENTLE_DOT_RUNTIME`), or undefined in a
 * source checkout. It holds `node/`, `bin/` (`engram`, `pi`),
 * `daemon/` (this bundle and its `node_modules/`) and `ui/`.
 */
export function runtimeDir(env: NodeJS.ProcessEnv = process.env): string | undefined {
	return env.GENTLE_DOT_RUNTIME ? resolve(env.GENTLE_DOT_RUNTIME) : undefined;
}

/** The runtime's flat install of the daemon's external dependencies. */
export function runtimeModules(runtime: string): string {
	return join(runtime, "daemon", "node_modules");
}

/** Where a user's own Engram usually lives, after the login PATH on Unix. */
export function engramKnownDirs(home: string, platform: NodeJS.Platform = process.platform): string[] {
	if (platform === "win32") {
		return [
			join(home, "go", "bin"),
			join(home, "AppData", "Local", "engram", "bin"),
			join(home, ".local", "bin"),
		];
	}
	return [join(home, "go", "bin"), "/opt/homebrew/bin", "/usr/local/bin", join(home, ".local", "bin")];
}

const SYSTEM_PATH = "/usr/bin:/bin:/usr/sbin:/sbin";

function isExecutableFile(path: string, platform: NodeJS.Platform = process.platform): boolean {
	try {
		accessSync(path, platform === "win32" ? constants.R_OK : constants.X_OK);
		return statSync(path).isFile();
	} catch {
		return false;
	}
}

/**
 * The `engram` the user's login shell finds. The app starts with a fixed PATH,
 * so the shell builds the user's own from their profile, starting from the system one.
 */
function loginShellEngram(env: NodeJS.ProcessEnv, home: string): string | undefined {
	try {
		const output = execFileSync(env.SHELL || "/bin/sh", ["-l", "-c", "command -v engram"], {
			env: { ...env, HOME: home, PATH: SYSTEM_PATH },
			encoding: "utf8",
			stdio: ["ignore", "pipe", "ignore"],
			timeout: 5000,
		});
		const found = output.trim().split("\n").at(-1)?.trim() ?? "";
		return isAbsolute(found) && isExecutableFile(found) ? found : undefined;
	} catch {
		return undefined;
	}
}

/**
 * The Engram binary of an installed app: `ENGRAM_BIN`, then an `engram` on the
 * user's login PATH (Unix only) or in the usual folders, so the user's own version
 * keeps serving `~/.engram`, and only then the one the runtime carries.
 * Windows uses `engram.exe`, skips login shells and accepts readable executable files.
 */
export function resolveEngramBin(
	env: NodeJS.ProcessEnv,
	runtime: string,
	options: { home?: string; knownDirs?: string[]; platform?: NodeJS.Platform } = {},
): string {
	if (env.ENGRAM_BIN) return env.ENGRAM_BIN;
	const platform = options.platform ?? process.platform;
	const home = options.home ?? (env.HOME || (platform === "win32" && env.USERPROFILE) || homedir());
	const name = platform === "win32" ? "engram.exe" : "engram";
	const fromLogin = platform === "win32" ? undefined : loginShellEngram(env, home);
	if (fromLogin) return fromLogin;
	for (const dir of options.knownDirs ?? engramKnownDirs(home, platform)) {
		const bin = join(dir, name);
		if (isExecutableFile(bin, platform)) return bin;
	}
	return join(runtime, "bin", name);
}