Skip to content

πŸ™Œ OpenHands: AI-Driven Development

fix how lookupsecrets are sent (#244)

Robert Brennan4c71e0fdea58
diff --git a/__tests__/api/agent-server-adapter.test.ts b/__tests__/api/agent-server-adapter.test.ts
index bca9e655b0..e61cf5b878 100644
--- a/__tests__/api/agent-server-adapter.test.ts
+++ b/__tests__/api/agent-server-adapter.test.ts
@@ -8,13 +8,23 @@ import {
} from "#/api/agent-server-adapter";
import { DEFAULT_SETTINGS } from "#/services/settings";
-const { mockGetAgentServerWorkingDir, mockIsAgentServerToolAvailable } =
- vi.hoisted(() => ({
- mockGetAgentServerWorkingDir: vi.fn(
- () => "/workspace/project/agent-canvas",
- ),
- mockIsAgentServerToolAvailable: vi.fn(() => true),
- }));
+const {
+ mockGetAgentServerWorkingDir,
+ mockIsAgentServerToolAvailable,
+ mockGetEffectiveLocalBackend,
+} = vi.hoisted(() => ({
+ mockGetAgentServerWorkingDir: vi.fn(
+ () => "/workspace/project/agent-canvas",
+ ),
+ mockIsAgentServerToolAvailable: vi.fn(() => true),
+ mockGetEffectiveLocalBackend: vi.fn(() => ({
+ id: "default-local",
+ name: "Local backend",
+ host: "http://127.0.0.1:8000",
+ apiKey: "session-key",
+ kind: "local" as const,
+ })),
+}));
vi.mock("#/api/agent-server-config", () => ({
getAgentServerBaseUrl: vi.fn(() => "http://127.0.0.1:8000"),
@@ -28,11 +38,21 @@ vi.mock("#/api/agent-server-compatibility", () => ({
isAgentServerToolAvailable: mockIsAgentServerToolAvailable,
}));
+vi.mock("#/api/backend-registry/active-store", () => ({
+ getEffectiveLocalBackend: mockGetEffectiveLocalBackend,
+}));
+
beforeEach(() => {
mockIsAgentServerToolAvailable.mockReturnValue(true);
+ mockGetEffectiveLocalBackend.mockReturnValue({
+ id: "default-local",
+ name: "Local backend",
+ host: "http://127.0.0.1:8000",
+ apiKey: "session-key",
+ kind: "local",
+ });
});
-
describe("buildStartConversationRequest", () => {
it("uses nested settings as the source of truth and keeps SDK tool names", () => {
const payload = buildStartConversationRequest({
@@ -229,6 +249,48 @@ describe("buildStartConversationRequest", () => {
content: [{ type: "text", text: "Follow the repo conventions." }],
});
});
+
+ it("serializes custom secrets as host-relative LookupSecret entries", () => {
+ const payload = buildStartConversationRequest({
+ settings: {
+ ...DEFAULT_SETTINGS,
+ agent_settings: {
+ ...DEFAULT_SETTINGS.agent_settings,
+ llm: { model: "nested-model" },
+ },
+ },
+ customSecrets: [
+ { name: "API_KEY", description: "Primary API key" },
+ { name: "folder/name", description: "Nested secret" },
+ ],
+ }) as {
+ secrets: Record<
+ string,
+ {
+ kind: string;
+ url: string;
+ description?: string;
+ headers?: Record<string, string>;
+ }
+ >;
+ };
+
+ expect(payload.secrets).toEqual({
+ API_KEY: {
+ kind: "LookupSecret",
+ url: "/api/settings/secrets/API_KEY",
+ description: "Primary API key",
+ headers: { "X-Session-API-Key": "session-key" },
+ },
+ "folder/name": {
+ kind: "LookupSecret",
+ url: "/api/settings/secrets/folder%2Fname",
+ description: "Nested secret",
+ headers: { "X-Session-API-Key": "session-key" },
+ },
+ });
+ });
+
});
describe("getDefaultConversationTitle", () => {
diff --git a/src/api/agent-server-adapter.ts b/src/api/agent-server-adapter.ts
index 5ab367b66a..5429a40de1 100644
--- a/src/api/agent-server-adapter.ts
+++ b/src/api/agent-server-adapter.ts
@@ -7,6 +7,7 @@ import {
shouldLoadPublicSkills,
} from "./agent-server-config";
import { getEffectiveLocalBackend } from "./backend-registry/active-store";
+import { buildAuthHeaders } from "./backend-registry/auth";
import {
GetHooksResponse,
GetSkillsResponse,
@@ -453,27 +454,24 @@ export function buildStartConversationRequest(
payload.agent_definitions = conversationSettings.agent_definitions;
}
- // Add custom secrets as LookupSecret entries
- // The agent-server will fetch values at runtime from /api/settings/secrets/{name}
+ // Add custom secrets as LookupSecret entries.
+ // The agent-server fetches the value at runtime from
+ // `/api/settings/secrets/{name}` on its own host, so the URL stays
+ // host-relative; auth headers come from the active local backend.
if (options.customSecrets && options.customSecrets.length > 0) {
const backend = getEffectiveLocalBackend();
- const baseUrl = backend.host;
- const sessionApiKey = backend.apiKey || null;
+ const headers = buildAuthHeaders(backend);
const secrets: Record<string, LookupSecret> = {};
for (const secret of options.customSecrets) {
const lookupSecret: LookupSecret = {
kind: "LookupSecret",
- url: `${baseUrl}/api/settings/secrets/${encodeURIComponent(secret.name)}`,
+ url: `/api/settings/secrets/${encodeURIComponent(secret.name)}`,
description: secret.description,
};
- // Include session API key header if configured (local agent-server only β€”
- // cloud LookupSecrets aren't fetched by the local runtime).
- if (sessionApiKey) {
- lookupSecret.headers = {
- "X-Session-API-Key": sessionApiKey,
- };
+ if (Object.keys(headers).length > 0) {
+ lookupSecret.headers = headers;
}
secrets[secret.name] = lookupSecret;