Skip to content

πŸ™Œ OpenHands: AI-Driven Development

4.5 KB
Raw Blame
import React from "react";
import { useSearchSecrets } from "#/hooks/query/use-get-secrets";
import { useSaveAcpSecrets } from "#/hooks/use-save-acp-secrets";
import {
  getAcpCredentialConflicts,
  getAcpProviderSecrets,
  type ACPProviderSecretField,
} from "#/constants/acp-providers";

export interface AcpCredentialForm {
  /** Credential fields for ``providerKey`` (see {@link getAcpProviderSecrets}). */
  fields: ACPProviderSecretField[];
  /** Current (unsaved) input values, keyed by field name. */
  values: Record<string, string>;
  setValue: (name: string, value: string) => void;
  /** Whether a secret with this name is already saved on the backend. */
  secretExists: (name: string) => boolean;
  /** Typed now (non-blank) or previously saved. */
  hasValueFor: (name: string) => boolean;
  /** ``[credential, conflicting]`` pairs currently both set (typed or saved). */
  conflicts: Array<[string, string]>;
  /** Whether a credential (a ``secret`` field β€” API key, OAuth token, or
   * file-content blob) is already saved on the backend for this provider. This
   * is the backend-truthful auth signal that works on Docker/cloud, where the
   * host-login probe can't run (agent-canvas#1244). A non-credential field (a
   * base URL or GCP scalar) being set does not count. */
  credentialsConfigured: boolean;
  /** Whether the active backend can materialise file-content (``multiline``)
   * credentials to disk. False on cloud (agent-canvas#1016), where such a
   * credential would be orphaned. */
  consumesFileCredentials: boolean;
  /** At least one field has a non-blank typed value. */
  isDirty: boolean;
  /** Persist the filled fields; resolves ``true`` when everything saved.
   * ``silent`` suppresses the success toast so a caller saving credentials
   * alongside other state can emit a single combined confirmation. */
  save: (options?: { silent?: boolean }) => Promise<boolean>;
  reset: () => void;
  isSaving: boolean;
}

/**
 * Shared state + derived values for the ACP credential forms (the onboarding
 * step and the Settings β†’ Agent section): the provider's field list, the typed
 * values, existing-secret lookups, the credential-conflict pairs, and the save
 * flow ({@link useSaveAcpSecrets}). Values reset when ``providerKey`` changes β€”
 * typed-but-unsaved input belongs to the previous provider's fields.
 */
export function useAcpCredentialForm(
  providerKey: string | null | undefined,
): AcpCredentialForm {
  const { data: existingSecrets } = useSearchSecrets();
  const fields = React.useMemo(
    () => getAcpProviderSecrets(providerKey),
    [providerKey],
  );
  const [values, setValues] = React.useState<Record<string, string>>({});

  // Both local and cloud agent-servers materialise file-content credentials
  // (Codex auth.json, Gemini Vertex SA) via the SDK's acp_file_secrets: locally
  // from the user's machine, on cloud from the per-user encrypted secret store
  // routed through agent_context.secrets at conversation start (the cloud
  // backend pins an SDK that materialises reserved file secrets). So a pasted
  // file blob is consumable on every supported backend.
  const consumesFileCredentials = true;
  const { saveFilled, isSaving } = useSaveAcpSecrets(
    fields,
    consumesFileCredentials,
  );

  React.useEffect(() => {
    setValues({});
  }, [providerKey]);

  const secretExists = React.useCallback(
    (name: string) =>
      (existingSecrets ?? []).some((secret) => secret.name === name),
    [existingSecrets],
  );

  const hasValueFor = React.useCallback(
    (name: string) => Boolean(values[name]?.trim()) || secretExists(name),
    [values, secretExists],
  );

  const setValue = React.useCallback(
    (name: string, value: string) =>
      setValues((prev) => ({ ...prev, [name]: value })),
    [],
  );

  const reset = React.useCallback(() => setValues({}), []);

  return {
    fields,
    values,
    setValue,
    secretExists,
    hasValueFor,
    conflicts: getAcpCredentialConflicts(providerKey, hasValueFor),
    // `=== true` is the intended strict check: only a credential-bearing field
    // (API key, OAuth token, file blob) counts β€” never a base URL or GCP scalar,
    // which omit `secret` entirely. A field must never set `secret: false` to
    // opt out; omit the flag instead.
    credentialsConfigured: fields.some(
      (field) => field.secret === true && secretExists(field.name),
    ),
    consumesFileCredentials,
    isDirty: fields.some((field) => Boolean(values[field.name]?.trim())),
    save: (options) => saveFilled(values, options),
    reset,
    isSaving,
  };
}