π OpenHands: AI-Driven Development
import React from "react";
import { useTranslation } from "react-i18next";
import { useQueryClient } from "@tanstack/react-query";
import { AxiosError } from "axios";
import { I18nKey } from "#/i18n/declaration";
import { useCreateSecret } from "#/hooks/mutation/use-create-secret";
import { ACP_MODEL_DISCOVERY_QUERY_KEYS } from "#/hooks/query/query-keys";
import { type ACPProviderSecretField } from "#/constants/acp-providers";
import {
displayErrorToast,
displaySuccessToast,
displayWarningToast,
} from "#/utils/custom-toast-handlers";
import { retrieveAxiosErrorMessage } from "#/utils/retrieve-axios-error-message";
/**
* Shared save flow for the ACP credential forms (the onboarding step and the
* Settings β Agent section): persists each filled field as a global secret,
* refreshes the secret queries, and toasts the outcome β a warning instead of
* "Saved" when a file-content credential landed on a backend that can't
* materialise it to disk (cloud, pending agent-canvas#1016), so we don't claim
* success for an orphaned credential.
*
* ``saveFilled`` resolves ``true`` when every filled field saved (or nothing
* needed saving) and ``false`` on failure, so callers can gate navigation /
* form resets on it. Empty fields are never written β a blank input is a
* deliberate skip, not a request to clear an existing secret.
*
* ``consumesFileCredentials`` β whether the backend materialises ``multiline``
* credentials to disk β comes from the caller (``useAcpCredentialForm``
* computes it), so the save warning and the form's required-gate can't
* disagree on the capability.
*/
export function useSaveAcpSecrets(
fields: ACPProviderSecretField[],
consumesFileCredentials: boolean,
) {
const { t } = useTranslation("openhands");
const queryClient = useQueryClient();
const { mutateAsync: createSecret } = useCreateSecret();
const [isSaving, setIsSaving] = React.useState(false);
// ``silent`` suppresses the success/warning toast (not errors) so a caller
// that persists credentials alongside something else β the Settings β Agent
// single Save, which also writes the agent spec β can emit one combined
// "Saved" instead of two. The standalone onboarding caller leaves it off.
const saveFilled = async (
values: Record<string, string>,
{ silent = false }: { silent?: boolean } = {},
) => {
const toSave = fields
.map((field) => ({ field, value: values[field.name]?.trim() }))
.filter(
(entry): entry is { field: ACPProviderSecretField; value: string } =>
Boolean(entry.value),
);
if (toSave.length === 0) return true;
setIsSaving(true);
try {
// Sequential so a mid-list failure leaves the earlier secrets saved and
// surfaces a single, specific error rather than a race of toasts.
for (const { field, value } of toSave) {
await createSecret({ name: field.name, value });
}
await queryClient.invalidateQueries({ queryKey: ["secrets-search"] });
await queryClient.invalidateQueries({ queryKey: ["secrets"] });
await queryClient.invalidateQueries({
queryKey: ACP_MODEL_DISCOVERY_QUERY_KEYS.all,
});
const savedOrphanedFileCredential =
!consumesFileCredentials && toSave.some(({ field }) => field.multiline);
if (savedOrphanedFileCredential) {
displayWarningToast(t(I18nKey.ONBOARDING$ACP_SECRETS_ORPHANED_WARNING));
} else if (!silent) {
displaySuccessToast(t(I18nKey.SETTINGS$SAVED));
}
return true;
} catch (error) {
const message = retrieveAxiosErrorMessage(error as AxiosError);
displayErrorToast(message || t(I18nKey.ERROR$GENERIC));
return false;
} finally {
setIsSaving(false);
}
};
return { saveFilled, isSaving };
}