Skip to content

πŸ™Œ OpenHands: AI-Driven Development

4.1 KB
Raw Blame
import type { CustomSecretInput } from "#/api/agent-server-adapter";
import { SecretsService } from "#/api/secrets-service";
import {
  REQUEST_SECRET_TOOL_NAME,
  SECRET_REQUEST_RESULT_PREFIX,
} from "#/constants/secret-request";
import { updateConversationSecrets } from "#/hooks/mutation/conversation-mutation-utils";
import {
  type SecretRequest,
  useSecretRequestStore,
} from "#/stores/secret-request-store";
import type { RequestSecretAction } from "#/types/agent-server/core";
import { claimClientToolCall } from "#/utils/claim-client-tool-call";
import { displayErrorToast } from "#/utils/custom-toast-handlers";
import { postClientToolResult } from "./client-tool-result";

const LEDGER_STORAGE_KEY_PREFIX = "openhands-secret-requests:";

type SecretRequestResult =
  | { status: "saved"; name: string }
  | { status: "not_saved"; name: string; guidance: string }
  | { status: "error"; name: string; error: string; guidance: string };

async function findSavedSecret(
  name: string,
): Promise<CustomSecretInput | null> {
  try {
    const secrets = await SecretsService.getSecretsOrThrow();
    return secrets.find((secret) => secret.name === name) ?? null;
  } catch {
    // Unknown β€” let the user answer; the form reports a duplicate name.
    return null;
  }
}

/**
 * Execute a `request_secret` tool call. A secret the user already saved (for
 * example in Settings after this conversation started) is attached straight
 * away, as every saved secret is at conversation start; otherwise the request
 * is queued for its chat card, which reports through {@link completeSecretRequest}.
 */
export async function handleRequestSecretAction(
  action: RequestSecretAction,
  conversationId: string,
  toolCallId: string,
): Promise<void> {
  // A replayed call would ask again and report the outcome twice.
  if (
    !claimClientToolCall(
      `${LEDGER_STORAGE_KEY_PREFIX}${conversationId}`,
      toolCallId,
    )
  ) {
    return;
  }

  const request: SecretRequest = {
    conversationId,
    toolCallId,
    name: action.name,
    reason: action.reason ?? null,
  };
  const savedSecret = await findSavedSecret(request.name);
  useSecretRequestStore.getState().enqueue(request);
  if (savedSecret) {
    await completeSecretRequest(request, savedSecret);
  }
}

async function resolveResult(
  request: SecretRequest,
  savedSecret: CustomSecretInput | null,
): Promise<SecretRequestResult> {
  if (!savedSecret) {
    return {
      status: "not_saved",
      name: request.name,
      guidance:
        "The user dismissed the form without saving the secret. Ask them how they want to proceed; never ask them to paste it into the chat.",
    };
  }

  try {
    await updateConversationSecrets(request.conversationId, [savedSecret]);
    return { status: "saved", name: savedSecret.name };
  } catch (error) {
    return {
      status: "error",
      name: savedSecret.name,
      error: error instanceof Error ? error.message : String(error),
      guidance:
        "The secret was saved to the user's settings but could not be attached to this conversation. It will be available in new conversations; tell the user.",
    };
  }
}

/**
 * Hand the outcome of a secret request back to the agent. It never carries the
 * value. Each request is reported once, whichever of the card and the
 * already-saved shortcut finishes first.
 *
 * Never rejects: the user has already answered, so a failure to report is
 * logged rather than surfaced.
 */
export async function completeSecretRequest(
  request: SecretRequest,
  savedSecret: CustomSecretInput | null,
): Promise<void> {
  const store = useSecretRequestStore.getState();
  if (!store.requests.some((r) => r.toolCallId === request.toolCallId)) return;
  store.dismiss(request.toolCallId);

  const result = await resolveResult(request, savedSecret);
  // Tell the user even when the agent cannot be told (an active `/goal` loop).
  if (result.status === "error") displayErrorToast(result.error);

  await postClientToolResult(
    request.conversationId,
    SECRET_REQUEST_RESULT_PREFIX,
    result,
  ).catch((error) => {
    console.warn(
      `[${REQUEST_SECRET_TOOL_NAME}] Failed to report the request result:`,
      error,
    );
  });
}