fix: expand linux service PATH handling
This commit is contained in:
@@ -11,6 +11,7 @@ Docs: https://docs.clawd.bot
|
|||||||
### Fixes
|
### Fixes
|
||||||
- TUI: forward unknown slash commands (for example, `/context`) to the Gateway.
|
- TUI: forward unknown slash commands (for example, `/context`) to the Gateway.
|
||||||
- TUI: include Gateway slash commands in autocomplete and `/help`.
|
- TUI: include Gateway slash commands in autocomplete and `/help`.
|
||||||
|
- Linux: include env-configured user bin roots in systemd PATH and align PATH audits. (#1512) Thanks @robbyczgw-cla.
|
||||||
- Media: preserve PNG alpha when possible; fall back to JPEG when still over size cap. (#1491) Thanks @robbyczgw-cla.
|
- Media: preserve PNG alpha when possible; fall back to JPEG when still over size cap. (#1491) Thanks @robbyczgw-cla.
|
||||||
- Agents: treat plugin-only tool allowlists as opt-ins; keep core tools enabled. (#1467)
|
- Agents: treat plugin-only tool allowlists as opt-ins; keep core tools enabled. (#1467)
|
||||||
- Exec approvals: persist allowlist entry ids to keep macOS allowlist rows stable. (#1521) Thanks @ngutman.
|
- Exec approvals: persist allowlist entry ids to keep macOS allowlist rows stable. (#1521) Thanks @ngutman.
|
||||||
|
|||||||
@@ -324,6 +324,7 @@ brew install <formula>
|
|||||||
```
|
```
|
||||||
|
|
||||||
If you run Clawdbot via systemd, ensure the service PATH includes `/home/linuxbrew/.linuxbrew/bin` (or your brew prefix) so `brew`-installed tools resolve in non‑login shells.
|
If you run Clawdbot via systemd, ensure the service PATH includes `/home/linuxbrew/.linuxbrew/bin` (or your brew prefix) so `brew`-installed tools resolve in non‑login shells.
|
||||||
|
Recent builds also prepend common user bin dirs on Linux systemd services (for example `~/.local/bin`, `~/.npm-global/bin`, `~/.local/share/pnpm`, `~/.bun/bin`) and honor `PNPM_HOME`, `NPM_CONFIG_PREFIX`, `BUN_INSTALL`, `VOLTA_HOME`, `ASDF_DATA_DIR`, `NVM_DIR`, and `FNM_DIR` when set.
|
||||||
|
|
||||||
### Can I switch between npm and git installs later?
|
### Can I switch between npm and git installs later?
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
import { describe, expect, it } from "vitest";
|
import { describe, expect, it } from "vitest";
|
||||||
import { auditGatewayServiceConfig, SERVICE_AUDIT_CODES } from "./service-audit.js";
|
import { auditGatewayServiceConfig, SERVICE_AUDIT_CODES } from "./service-audit.js";
|
||||||
|
import { buildMinimalServicePath } from "./service-env.js";
|
||||||
|
|
||||||
describe("auditGatewayServiceConfig", () => {
|
describe("auditGatewayServiceConfig", () => {
|
||||||
it("flags bun runtime", async () => {
|
it("flags bun runtime", async () => {
|
||||||
@@ -39,4 +40,24 @@ describe("auditGatewayServiceConfig", () => {
|
|||||||
audit.issues.some((issue) => issue.code === SERVICE_AUDIT_CODES.gatewayPathMissingDirs),
|
audit.issues.some((issue) => issue.code === SERVICE_AUDIT_CODES.gatewayPathMissingDirs),
|
||||||
).toBe(true);
|
).toBe(true);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("accepts Linux minimal PATH with user directories", async () => {
|
||||||
|
const env = { HOME: "/home/testuser", PNPM_HOME: "/opt/pnpm" };
|
||||||
|
const minimalPath = buildMinimalServicePath({ platform: "linux", env });
|
||||||
|
const audit = await auditGatewayServiceConfig({
|
||||||
|
env,
|
||||||
|
platform: "linux",
|
||||||
|
command: {
|
||||||
|
programArguments: ["/usr/bin/node", "gateway"],
|
||||||
|
environment: { PATH: minimalPath },
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(
|
||||||
|
audit.issues.some((issue) => issue.code === SERVICE_AUDIT_CODES.gatewayPathNonMinimal),
|
||||||
|
).toBe(false);
|
||||||
|
expect(
|
||||||
|
audit.issues.some((issue) => issue.code === SERVICE_AUDIT_CODES.gatewayPathMissingDirs),
|
||||||
|
).toBe(false);
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ import {
|
|||||||
isVersionManagedNodePath,
|
isVersionManagedNodePath,
|
||||||
resolveSystemNodePath,
|
resolveSystemNodePath,
|
||||||
} from "./runtime-paths.js";
|
} from "./runtime-paths.js";
|
||||||
import { getMinimalServicePathParts } from "./service-env.js";
|
import { getMinimalServicePathPartsFromEnv } from "./service-env.js";
|
||||||
import { resolveSystemdUserUnitPath } from "./systemd.js";
|
import { resolveSystemdUserUnitPath } from "./systemd.js";
|
||||||
|
|
||||||
export type GatewayServiceCommand = {
|
export type GatewayServiceCommand = {
|
||||||
@@ -206,6 +206,7 @@ function normalizePathEntry(entry: string, platform: NodeJS.Platform): string {
|
|||||||
function auditGatewayServicePath(
|
function auditGatewayServicePath(
|
||||||
command: GatewayServiceCommand,
|
command: GatewayServiceCommand,
|
||||||
issues: ServiceConfigIssue[],
|
issues: ServiceConfigIssue[],
|
||||||
|
env: Record<string, string | undefined>,
|
||||||
platform: NodeJS.Platform,
|
platform: NodeJS.Platform,
|
||||||
) {
|
) {
|
||||||
if (platform === "win32") return;
|
if (platform === "win32") return;
|
||||||
@@ -219,12 +220,13 @@ function auditGatewayServicePath(
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
const expected = getMinimalServicePathParts({ platform });
|
const expected = getMinimalServicePathPartsFromEnv({ platform, env });
|
||||||
const parts = servicePath
|
const parts = servicePath
|
||||||
.split(getPathModule(platform).delimiter)
|
.split(getPathModule(platform).delimiter)
|
||||||
.map((entry) => entry.trim())
|
.map((entry) => entry.trim())
|
||||||
.filter(Boolean);
|
.filter(Boolean);
|
||||||
const normalizedParts = parts.map((entry) => normalizePathEntry(entry, platform));
|
const normalizedParts = parts.map((entry) => normalizePathEntry(entry, platform));
|
||||||
|
const normalizedExpected = new Set(expected.map((entry) => normalizePathEntry(entry, platform)));
|
||||||
const missing = expected.filter((entry) => {
|
const missing = expected.filter((entry) => {
|
||||||
const normalized = normalizePathEntry(entry, platform);
|
const normalized = normalizePathEntry(entry, platform);
|
||||||
return !normalizedParts.includes(normalized);
|
return !normalizedParts.includes(normalized);
|
||||||
@@ -239,6 +241,9 @@ function auditGatewayServicePath(
|
|||||||
|
|
||||||
const nonMinimal = parts.filter((entry) => {
|
const nonMinimal = parts.filter((entry) => {
|
||||||
const normalized = normalizePathEntry(entry, platform);
|
const normalized = normalizePathEntry(entry, platform);
|
||||||
|
if (normalizedExpected.has(normalized)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
return (
|
return (
|
||||||
normalized.includes("/.nvm/") ||
|
normalized.includes("/.nvm/") ||
|
||||||
normalized.includes("/.fnm/") ||
|
normalized.includes("/.fnm/") ||
|
||||||
@@ -315,7 +320,7 @@ export async function auditGatewayServiceConfig(params: {
|
|||||||
const platform = params.platform ?? process.platform;
|
const platform = params.platform ?? process.platform;
|
||||||
|
|
||||||
auditGatewayCommand(params.command?.programArguments, issues);
|
auditGatewayCommand(params.command?.programArguments, issues);
|
||||||
auditGatewayServicePath(params.command, issues, platform);
|
auditGatewayServicePath(params.command, issues, params.env, platform);
|
||||||
await auditGatewayRuntime(params.env, params.command, issues, platform);
|
await auditGatewayRuntime(params.env, params.command, issues, platform);
|
||||||
|
|
||||||
if (platform === "linux") {
|
if (platform === "linux") {
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ import {
|
|||||||
buildNodeServiceEnvironment,
|
buildNodeServiceEnvironment,
|
||||||
buildServiceEnvironment,
|
buildServiceEnvironment,
|
||||||
getMinimalServicePathParts,
|
getMinimalServicePathParts,
|
||||||
|
getMinimalServicePathPartsFromEnv,
|
||||||
} from "./service-env.js";
|
} from "./service-env.js";
|
||||||
|
|
||||||
describe("getMinimalServicePathParts - Linux user directories", () => {
|
describe("getMinimalServicePathParts - Linux user directories", () => {
|
||||||
@@ -70,6 +71,30 @@ describe("getMinimalServicePathParts - Linux user directories", () => {
|
|||||||
expect(extraDirIndex).toBeLessThan(userDirIndex);
|
expect(extraDirIndex).toBeLessThan(userDirIndex);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("includes env-configured bin roots when HOME is set on Linux", () => {
|
||||||
|
const result = getMinimalServicePathPartsFromEnv({
|
||||||
|
platform: "linux",
|
||||||
|
env: {
|
||||||
|
HOME: "/home/testuser",
|
||||||
|
PNPM_HOME: "/opt/pnpm",
|
||||||
|
NPM_CONFIG_PREFIX: "/opt/npm",
|
||||||
|
BUN_INSTALL: "/opt/bun",
|
||||||
|
VOLTA_HOME: "/opt/volta",
|
||||||
|
ASDF_DATA_DIR: "/opt/asdf",
|
||||||
|
NVM_DIR: "/opt/nvm",
|
||||||
|
FNM_DIR: "/opt/fnm",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result).toContain("/opt/pnpm");
|
||||||
|
expect(result).toContain("/opt/npm/bin");
|
||||||
|
expect(result).toContain("/opt/bun/bin");
|
||||||
|
expect(result).toContain("/opt/volta/bin");
|
||||||
|
expect(result).toContain("/opt/asdf/shims");
|
||||||
|
expect(result).toContain("/opt/nvm/current/bin");
|
||||||
|
expect(result).toContain("/opt/fnm/current/bin");
|
||||||
|
});
|
||||||
|
|
||||||
it("does not include Linux user directories on macOS", () => {
|
it("does not include Linux user directories on macOS", () => {
|
||||||
const result = getMinimalServicePathParts({
|
const result = getMinimalServicePathParts({
|
||||||
platform: "darwin",
|
platform: "darwin",
|
||||||
|
|||||||
@@ -18,6 +18,7 @@ export type MinimalServicePathOptions = {
|
|||||||
platform?: NodeJS.Platform;
|
platform?: NodeJS.Platform;
|
||||||
extraDirs?: string[];
|
extraDirs?: string[];
|
||||||
home?: string;
|
home?: string;
|
||||||
|
env?: Record<string, string | undefined>;
|
||||||
};
|
};
|
||||||
|
|
||||||
type BuildServicePathOptions = MinimalServicePathOptions & {
|
type BuildServicePathOptions = MinimalServicePathOptions & {
|
||||||
@@ -38,11 +39,31 @@ function resolveSystemPathDirs(platform: NodeJS.Platform): string[] {
|
|||||||
* Resolve common user bin directories for Linux.
|
* Resolve common user bin directories for Linux.
|
||||||
* These are paths where npm global installs and node version managers typically place binaries.
|
* These are paths where npm global installs and node version managers typically place binaries.
|
||||||
*/
|
*/
|
||||||
export function resolveLinuxUserBinDirs(home: string | undefined): string[] {
|
export function resolveLinuxUserBinDirs(
|
||||||
|
home: string | undefined,
|
||||||
|
env?: Record<string, string | undefined>,
|
||||||
|
): string[] {
|
||||||
if (!home) return [];
|
if (!home) return [];
|
||||||
|
|
||||||
const dirs: string[] = [];
|
const dirs: string[] = [];
|
||||||
|
|
||||||
|
const add = (dir: string | undefined) => {
|
||||||
|
if (dir) dirs.push(dir);
|
||||||
|
};
|
||||||
|
const appendSubdir = (base: string | undefined, subdir: string) => {
|
||||||
|
if (!base) return undefined;
|
||||||
|
return base.endsWith(`/${subdir}`) ? base : path.posix.join(base, subdir);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Env-configured bin roots (override defaults when present).
|
||||||
|
add(env?.PNPM_HOME);
|
||||||
|
add(appendSubdir(env?.NPM_CONFIG_PREFIX, "bin"));
|
||||||
|
add(appendSubdir(env?.BUN_INSTALL, "bin"));
|
||||||
|
add(appendSubdir(env?.VOLTA_HOME, "bin"));
|
||||||
|
add(appendSubdir(env?.ASDF_DATA_DIR, "shims"));
|
||||||
|
add(appendSubdir(env?.NVM_DIR, "current/bin"));
|
||||||
|
add(appendSubdir(env?.FNM_DIR, "current/bin"));
|
||||||
|
|
||||||
// Common user bin directories
|
// Common user bin directories
|
||||||
dirs.push(`${home}/.local/bin`); // XDG standard, pip, etc.
|
dirs.push(`${home}/.local/bin`); // XDG standard, pip, etc.
|
||||||
dirs.push(`${home}/.npm-global/bin`); // npm custom prefix (recommended for non-root)
|
dirs.push(`${home}/.npm-global/bin`); // npm custom prefix (recommended for non-root)
|
||||||
@@ -68,7 +89,8 @@ export function getMinimalServicePathParts(options: MinimalServicePathOptions =
|
|||||||
const systemDirs = resolveSystemPathDirs(platform);
|
const systemDirs = resolveSystemPathDirs(platform);
|
||||||
|
|
||||||
// Add Linux user bin directories (npm global, nvm, fnm, volta, etc.)
|
// Add Linux user bin directories (npm global, nvm, fnm, volta, etc.)
|
||||||
const linuxUserDirs = platform === "linux" ? resolveLinuxUserBinDirs(options.home) : [];
|
const linuxUserDirs =
|
||||||
|
platform === "linux" ? resolveLinuxUserBinDirs(options.home, options.env) : [];
|
||||||
|
|
||||||
const add = (dir: string) => {
|
const add = (dir: string) => {
|
||||||
if (!dir) return;
|
if (!dir) return;
|
||||||
@@ -83,6 +105,15 @@ export function getMinimalServicePathParts(options: MinimalServicePathOptions =
|
|||||||
return parts;
|
return parts;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function getMinimalServicePathPartsFromEnv(options: BuildServicePathOptions = {}): string[] {
|
||||||
|
const env = options.env ?? process.env;
|
||||||
|
return getMinimalServicePathParts({
|
||||||
|
...options,
|
||||||
|
home: options.home ?? env.HOME,
|
||||||
|
env,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
export function buildMinimalServicePath(options: BuildServicePathOptions = {}): string {
|
export function buildMinimalServicePath(options: BuildServicePathOptions = {}): string {
|
||||||
const env = options.env ?? process.env;
|
const env = options.env ?? process.env;
|
||||||
const platform = options.platform ?? process.platform;
|
const platform = options.platform ?? process.platform;
|
||||||
@@ -90,10 +121,7 @@ export function buildMinimalServicePath(options: BuildServicePathOptions = {}):
|
|||||||
return env.PATH ?? "";
|
return env.PATH ?? "";
|
||||||
}
|
}
|
||||||
|
|
||||||
return getMinimalServicePathParts({
|
return getMinimalServicePathPartsFromEnv({ ...options, env }).join(path.delimiter);
|
||||||
...options,
|
|
||||||
home: options.home ?? env.HOME,
|
|
||||||
}).join(path.delimiter);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export function buildServiceEnvironment(params: {
|
export function buildServiceEnvironment(params: {
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { afterEach, beforeEach, vi } from "vitest";
|
import { afterAll, afterEach, beforeEach, vi } from "vitest";
|
||||||
|
|
||||||
import type {
|
import type {
|
||||||
ChannelId,
|
ChannelId,
|
||||||
@@ -9,6 +9,10 @@ import type { ClawdbotConfig } from "../src/config/config.js";
|
|||||||
import type { OutboundSendDeps } from "../src/infra/outbound/deliver.js";
|
import type { OutboundSendDeps } from "../src/infra/outbound/deliver.js";
|
||||||
import { setActivePluginRegistry } from "../src/plugins/runtime.js";
|
import { setActivePluginRegistry } from "../src/plugins/runtime.js";
|
||||||
import { createTestRegistry } from "../src/test-utils/channel-plugins.js";
|
import { createTestRegistry } from "../src/test-utils/channel-plugins.js";
|
||||||
|
import { withIsolatedTestHome } from "./test-env";
|
||||||
|
|
||||||
|
const testEnv = withIsolatedTestHome();
|
||||||
|
afterAll(() => testEnv.cleanup());
|
||||||
const pickSendFn = (id: ChannelId, deps?: OutboundSendDeps) => {
|
const pickSendFn = (id: ChannelId, deps?: OutboundSendDeps) => {
|
||||||
switch (id) {
|
switch (id) {
|
||||||
case "discord":
|
case "discord":
|
||||||
|
|||||||
@@ -130,3 +130,7 @@ export function installTestEnv(): { cleanup: () => void; tempHome: string } {
|
|||||||
|
|
||||||
return { cleanup, tempHome };
|
return { cleanup, tempHome };
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function withIsolatedTestHome(): { cleanup: () => void; tempHome: string } {
|
||||||
|
return installTestEnv();
|
||||||
|
}
|
||||||
|
|||||||
@@ -26,7 +26,6 @@ export default defineConfig({
|
|||||||
"test/format-error.test.ts",
|
"test/format-error.test.ts",
|
||||||
],
|
],
|
||||||
setupFiles: ["test/setup.ts"],
|
setupFiles: ["test/setup.ts"],
|
||||||
globalSetup: ["test/global-setup.ts"],
|
|
||||||
exclude: [
|
exclude: [
|
||||||
"dist/**",
|
"dist/**",
|
||||||
"apps/macos/**",
|
"apps/macos/**",
|
||||||
|
|||||||
@@ -11,7 +11,6 @@ export default defineConfig({
|
|||||||
maxWorkers: e2eWorkers,
|
maxWorkers: e2eWorkers,
|
||||||
include: ["test/**/*.e2e.test.ts", "src/**/*.e2e.test.ts"],
|
include: ["test/**/*.e2e.test.ts", "src/**/*.e2e.test.ts"],
|
||||||
setupFiles: ["test/setup.ts"],
|
setupFiles: ["test/setup.ts"],
|
||||||
globalSetup: ["test/global-setup.ts"],
|
|
||||||
exclude: [
|
exclude: [
|
||||||
"dist/**",
|
"dist/**",
|
||||||
"apps/macos/**",
|
"apps/macos/**",
|
||||||
|
|||||||
Reference in New Issue
Block a user