Files
kandev/apps/web/components/automations/trigger-configs/webhook-config.tsx
T
João Salavisa 2a7a8dcd48 feat(i18n): localize Automations (#2247)
Co-authored-by: Kandev Agent <agent@kandev.dev>
2026-08-04 10:46:40 +02:00

300 lines
9.7 KiB
TypeScript

"use client";
import { useState, useMemo, useCallback, useEffect } from "react";
import { Trans, useTranslation } from "react-i18next";
import { t as translate } from "@/lib/i18n";
import { toast } from "@/lib/toast/sonner";
import { Button } from "@kandev/ui/button";
import { Input } from "@kandev/ui/input";
import { Label } from "@kandev/ui/label";
import { Textarea } from "@kandev/ui/textarea";
import { IconCopy, IconCheck, IconEye, IconEyeOff } from "@tabler/icons-react";
import { revealWebhookSecret } from "@/lib/api/domains/automation-api";
import { copyToClipboard } from "@/lib/utils/copy-to-clipboard";
type WebhookConfigProps = {
automationId: string | null;
workspaceId: string;
};
// Wire syntax the user copies verbatim: the header the backend checks, and the
// placeholder paths the prompt renderer resolves. These are interpolated into
// the help text rather than written into the catalog, so the pseudo-locale
// cannot accent them into a header or path that no longer resolves.
const WEBHOOK_SECRET_HEADER = "X-Webhook-Secret";
const WEBHOOK_PATH_PLACEHOLDER = "{{webhook.<path>}}";
const WEBHOOK_PATH_EXAMPLE = "{{webhook.pull_request.number}}";
const codeClass = "bg-muted px-1 rounded";
// extractPaths walks a parsed JSON object two levels deep and returns the
// dot-paths to leaf scalars (string/number/bool). For nested objects it
// returns the children's full paths so the badges suggest
// `{{webhook.pull_request.number}}` rather than `{{webhook.pull_request}}`
// (which resolves to the entire blob). Arrays surface as their root path
// only — indexing across every element would explode the badge count.
const MAX_DEPTH = 2;
function isScalar(v: unknown): boolean {
return typeof v === "string" || typeof v === "number" || typeof v === "boolean";
}
function walkPaths(value: unknown, prefix: string, depth: number, out: string[]) {
if (isScalar(value) || value === null) {
out.push(prefix);
return;
}
if (Array.isArray(value)) {
// Stop at the array root — listing every index isn't useful for badges.
out.push(prefix);
return;
}
if (typeof value !== "object") return;
if (depth >= MAX_DEPTH) {
out.push(prefix);
return;
}
for (const [k, v] of Object.entries(value as Record<string, unknown>)) {
walkPaths(v, prefix ? `${prefix}.${k}` : k, depth + 1, out);
}
}
function extractKeys(json: string): string[] {
try {
const parsed = JSON.parse(json);
if (typeof parsed !== "object" || parsed === null || Array.isArray(parsed)) {
return [];
}
const out: string[] = [];
walkPaths(parsed, "", 0, out);
return out;
} catch {
return [];
}
}
export function WebhookConfig({ automationId, workspaceId }: WebhookConfigProps) {
const { t } = useTranslation();
const [copied, setCopied] = useState<"url" | "secret" | null>(null);
const [samplePayload, setSamplePayload] = useState("");
const copyValue = useCallback(async (value: string, kind: "url" | "secret") => {
if (await copyToClipboard(value)) {
setCopied(kind);
setTimeout(() => setCopied(null), 2000);
}
}, []);
const detectedKeys = useMemo(() => extractKeys(samplePayload), [samplePayload]);
if (!automationId) {
return (
<div className="space-y-3">
<p className="text-xs text-muted-foreground">{t("automations:webhookUrlAfterSave")}</p>
<SamplePayloadSection
samplePayload={samplePayload}
onChange={setSamplePayload}
detectedKeys={detectedKeys}
/>
</div>
);
}
const webhookUrl =
typeof window !== "undefined"
? `${window.location.origin}/api/v1/automations/webhook/${automationId}`
: `/api/v1/automations/webhook/${automationId}`;
return (
<div className="space-y-3">
<UrlField
url={webhookUrl}
copied={copied === "url"}
onCopy={() => copyValue(webhookUrl, "url")}
/>
<SecretField
automationId={automationId}
workspaceId={workspaceId}
copied={copied === "secret"}
onCopy={(value) => copyValue(value, "secret")}
/>
<p className="text-xs text-muted-foreground">
<Trans
i18nKey="automations:webhookUsageHelp"
values={{
header: WEBHOOK_SECRET_HEADER,
placeholder: WEBHOOK_PATH_PLACEHOLDER,
example: WEBHOOK_PATH_EXAMPLE,
}}
>
<code className={codeClass} />
<code className={codeClass} />
<code className={codeClass} />
</Trans>
</p>
<SamplePayloadSection
samplePayload={samplePayload}
onChange={setSamplePayload}
detectedKeys={detectedKeys}
/>
</div>
);
}
function UrlField({ url, copied, onCopy }: { url: string; copied: boolean; onCopy: () => void }) {
const { t } = useTranslation();
return (
<div className="space-y-1.5">
<Label className="text-xs">{t("automations:webhookUrlLabel")}</Label>
<div className="flex gap-2">
<Input value={url} readOnly className="font-mono text-xs" />
<Button variant="outline" size="sm" className="cursor-pointer shrink-0" onClick={onCopy}>
{copied ? <IconCheck className="h-3.5 w-3.5" /> : <IconCopy className="h-3.5 w-3.5" />}
</Button>
</div>
</div>
);
}
type SecretState = { status: "loading" } | { status: "ready"; value: string } | { status: "error" };
// A plain function returning copy is invisible to `i18next/no-literal-string`,
// so the loading label is resolved by the caller and passed in.
function inputValueFor(
status: SecretState["status"],
secret: string | null,
hidden: boolean,
masked: string,
loadingLabel: string,
): string {
if (status === "loading") return loadingLabel;
if (!secret || hidden) return masked;
return secret;
}
function SecretField({
automationId,
workspaceId,
copied,
onCopy,
}: {
automationId: string;
workspaceId: string;
copied: boolean;
onCopy: (value: string) => void;
}) {
const { t } = useTranslation();
// The secret is revealable any time — fetch it once on mount so users
// landing on a saved automation can see/copy it without an extra click.
// Combining status + value in one state avoids a setState(true) inside
// the effect body (which the React linter flags as a cascading render).
const [state, setState] = useState<SecretState>({ status: "loading" });
const [hidden, setHidden] = useState(true);
useEffect(() => {
let cancelled = false;
revealWebhookSecret(automationId, workspaceId)
.then((result) => {
if (cancelled) return;
setState({ status: "ready", value: result.webhook_secret });
})
.catch((err) => {
if (cancelled) return;
// The interpolated value is an API/network diagnostic and stays English.
const msg = err instanceof Error ? err.message : String(err);
toast.error(translate("automations:failedToLoadWebhookSecret", { error: msg }));
setState({ status: "error" });
});
return () => {
cancelled = true;
};
}, [automationId, workspaceId]);
const secret = state.status === "ready" ? state.value : null;
const masked = "•".repeat(32);
const inputValue = inputValueFor(
state.status,
secret,
hidden,
masked,
t("automations:webhookSecretLoading"),
);
return (
<div className="space-y-1.5">
<Label className="text-xs">{t("automations:webhookSecretLabel")}</Label>
<div className="flex gap-2">
<Input
value={inputValue}
readOnly
className="font-mono text-xs"
data-testid="automation-webhook-secret-input"
/>
<Button
variant="outline"
size="sm"
className="cursor-pointer shrink-0"
onClick={() => secret && onCopy(secret)}
disabled={!secret}
>
{copied ? <IconCheck className="h-3.5 w-3.5" /> : <IconCopy className="h-3.5 w-3.5" />}
</Button>
<Button
variant="outline"
size="sm"
className="cursor-pointer shrink-0"
onClick={() => setHidden((v) => !v)}
disabled={!secret}
data-testid="automation-webhook-secret-toggle"
>
{hidden ? <IconEye className="h-3.5 w-3.5" /> : <IconEyeOff className="h-3.5 w-3.5" />}
</Button>
</div>
</div>
);
}
function SamplePayloadSection({
samplePayload,
onChange,
detectedKeys,
}: {
samplePayload: string;
onChange: (value: string) => void;
detectedKeys: string[];
}) {
const { t } = useTranslation();
return (
<div className="space-y-2">
<div className="space-y-1.5">
<Label className="text-xs">{t("automations:samplePayloadLabel")}</Label>
{/* An example JSON body — a value, not prose. */}
<Textarea
value={samplePayload}
onChange={(e) => onChange(e.target.value)}
placeholder='{"repo": "org/app", "env": "prod"}'
className="font-mono text-xs min-h-[60px] resize-y"
rows={2}
/>
<p className="text-xs text-muted-foreground">{t("automations:samplePayloadHelp")}</p>
</div>
<div className="space-y-1">
<Label className="text-xs">{t("automations:availablePlaceholders")}</Label>
<div className="flex flex-wrap gap-1.5">
<PlaceholderBadge value="webhook.body" />
{detectedKeys.map((key) => (
<PlaceholderBadge key={key} value={`webhook.${key}`} />
))}
{detectedKeys.length === 0 && !samplePayload && (
<PlaceholderBadge value="webhook.<path>" />
)}
</div>
</div>
</div>
);
}
function PlaceholderBadge({ value }: { value: string }) {
return (
<code className="bg-muted px-1.5 py-0.5 rounded text-xs font-mono text-muted-foreground">
{`{{${value}}}`}
</code>
);
}