Skip to content

🪢 Open source agent evals & observability: Trace, evaluate, and improve LLM applications with one open platform.

fix(web-callouts): require header values again when the endpoint URL changes (#19565)

Steffen Reutherce6dde98837d
diff --git a/web/src/__tests__/server/web-callouts-trpc.servertest.ts b/web/src/__tests__/server/web-callouts-trpc.servertest.ts
index 84a429162d..3e37f73533 100644
--- a/web/src/__tests__/server/web-callouts-trpc.servertest.ts
+++ b/web/src/__tests__/server/web-callouts-trpc.servertest.ts
@@ -883,6 +883,52 @@ describe("webCallouts router", () => {
expect(stored?.requestHeaderKeys).toEqual(["Authorization", "X-New"]);
});
+ it("requires request header values again when the URL changes", async () => {
+ const { caller, prismaStub, projectId } = await prepare();
+ const endpoint = await createEndpoint(caller, projectId, {
+ requestHeaders: {
+ Authorization: "Bearer secret-token",
+ },
+ });
+ const update = {
+ projectId,
+ id: endpoint.id,
+ name: "Default",
+ url: "https://other.example.com/collect",
+ enabled: true,
+ toastMessage: "Sent to app",
+ };
+
+ await expect(
+ caller.webCallouts.upsert({
+ ...update,
+ requestHeaders: { Authorization: "" },
+ }),
+ ).rejects.toMatchObject({
+ code: "BAD_REQUEST",
+ message:
+ 'Header "Authorization" value must be re-entered when changing the endpoint URL.',
+ });
+ expect(decrypt).not.toHaveBeenCalled();
+
+ const stored = prismaStub.endpoints.find(
+ (candidate) => candidate.id === endpoint.id,
+ );
+ expect(stored?.url).toBe("https://example.com/callout");
+ expect(stored?.requestHeaders).toBe(
+ 'encrypted:{"Authorization":"Bearer secret-token"}',
+ );
+
+ await caller.webCallouts.upsert({
+ ...update,
+ requestHeaders: { Authorization: "Bearer new-token" },
+ });
+ expect(stored?.url).toBe("https://other.example.com/collect");
+ expect(stored?.requestHeaders).toBe(
+ 'encrypted:{"Authorization":"Bearer new-token"}',
+ );
+ });
+
it("rejects blank values for new or renamed request headers", async () => {
const { caller, prismaStub, projectId } = await prepare();
const endpoint = await createEndpoint(caller, projectId, {
diff --git a/web/src/features/web-callouts/components/WebCalloutSettingsPage.tsx b/web/src/features/web-callouts/components/WebCalloutSettingsPage.tsx
index aef8b2a80d..2ebf1d76c1 100644
--- a/web/src/features/web-callouts/components/WebCalloutSettingsPage.tsx
+++ b/web/src/features/web-callouts/components/WebCalloutSettingsPage.tsx
@@ -33,6 +33,7 @@ import {
TooltipContent,
TooltipTrigger,
} from "@/src/components/ui/tooltip";
+import { areDestinationUrlsEquivalent } from "@/src/features/automations/destinationUrl";
import { useHasProjectAccess } from "@/src/features/rbac";
import {
WEB_CALLOUT_BLOCKED_HEADER_NAMES,
@@ -210,6 +211,11 @@ function WebCalloutEndpointDialog(props: {
name: "headers",
});
+ const currentUrl = form.watch("url");
+ const isUrlChanged =
+ props.endpoint !== null &&
+ !areDestinationUrlsEquivalent(currentUrl, props.endpoint.url);
+
const onSubmit = (values: WebCalloutFormValues) => {
upsertMutation.mutate({
projectId: props.projectId,
@@ -329,14 +335,20 @@ function WebCalloutEndpointDialog(props: {
Optional headers added to the backend POST. Content-Type is set
automatically. Leave values empty for existing header names to
keep encrypted values.
+ {isUrlChanged
+ ? " Re-enter all header values when changing the endpoint URL."
+ : ""}
</FormDescription>
<div className="space-y-2">
{fields.map((field, index) => {
const currentHeaderName = form.watch(`headers.${index}.name`);
- const preservesExistingValue = hasExistingHeaderName(
- props.endpoint,
- currentHeaderName,
- );
+ const valuePlaceholder = getHeaderValuePlaceholder({
+ isExistingHeader: hasExistingHeaderName(
+ props.endpoint,
+ currentHeaderName,
+ ),
+ isUrlChanged,
+ });
return (
<div
@@ -362,11 +374,7 @@ function WebCalloutEndpointDialog(props: {
<FormItem>
<FormControl>
<Input
- placeholder={
- preservesExistingValue
- ? "***"
- : "Header value"
- }
+ placeholder={valuePlaceholder}
type="password"
{...field}
/>
@@ -446,6 +454,20 @@ const formValuesToRequestHeaders = (
.map((header) => [header.name.trim(), header.value.trim()]),
);
+const getHeaderValuePlaceholder = ({
+ isExistingHeader,
+ isUrlChanged,
+}: {
+ isExistingHeader: boolean;
+ isUrlChanged: boolean;
+}) => {
+ if (!isExistingHeader) {
+ return "Header value";
+ }
+
+ return isUrlChanged ? "Re-enter header value" : "***";
+};
+
const hasExistingHeaderName = (
endpoint: WebCalloutEndpoint | null,
name: string,
diff --git a/web/src/features/web-callouts/server/headers.ts b/web/src/features/web-callouts/server/headers.ts
index a32dde68f6..fb4f8d77bd 100644
--- a/web/src/features/web-callouts/server/headers.ts
+++ b/web/src/features/web-callouts/server/headers.ts
@@ -23,9 +23,11 @@ export type StoredWebCalloutHeaders = {
export const processHeadersForStorage = ({
inputHeaders,
existingHeaders,
+ isUrlChanged,
}: {
inputHeaders: WebCalloutHeaders;
existingHeaders: WebCalloutHeaders;
+ isUrlChanged: boolean;
}): StoredWebCalloutHeaders => {
const requestHeaders: WebCalloutHeaders = {};
const normalizedHeaderNames = new Set<string>();
@@ -54,6 +56,13 @@ export const processHeadersForStorage = ({
continue;
}
+ if (isUrlChanged) {
+ throw new TRPCError({
+ code: "BAD_REQUEST",
+ message: `Header "${name}" value must be re-entered when changing the endpoint URL.`,
+ });
+ }
+
const existingValue = findExistingHeaderValue(name, existingHeaders);
if (existingValue !== undefined) {
requestHeaders[name] = existingValue;
diff --git a/web/src/features/web-callouts/server/service.ts b/web/src/features/web-callouts/server/service.ts
index cbbb6fc12b..0160ff4ac4 100644
--- a/web/src/features/web-callouts/server/service.ts
+++ b/web/src/features/web-callouts/server/service.ts
@@ -1,6 +1,7 @@
/* eslint-disable @typescript-eslint/no-use-before-define */
import { TRPCError } from "@trpc/server";
+import { areDestinationUrlsEquivalent } from "@/src/features/automations/destinationUrl";
import {
type WebCalloutEndpointInput,
type WebCalloutInvokeInput,
@@ -111,14 +112,19 @@ export const upsertWebCalloutEndpoint = async ({
});
}
+ // Stored header values are only sent to the URL they were entered for.
+ const isUrlChanged =
+ !!existingEndpoint &&
+ !areDestinationUrlsEquivalent(existingEndpoint.url, input.url);
const shouldMergeExistingHeaders =
- Object.keys(input.requestHeaders).length > 0;
+ !isUrlChanged && Object.keys(input.requestHeaders).length > 0;
const headers = processHeadersForStorage({
inputHeaders: input.requestHeaders,
existingHeaders:
existingEndpoint && shouldMergeExistingHeaders
? decryptWebCalloutHeaders(existingEndpoint.requestHeaders)
: {},
+ isUrlChanged,
});
const data = {