Files
kandev/apps/web/components/settings/system/message-queue-settings.tsx
T
2026-09-22 21:24:43 +01:00

584 lines
18 KiB
TypeScript

"use client";
import { useCallback, useEffect, useRef, useState } from "react";
import { Alert, AlertDescription, AlertTitle } from "@kandev/ui/alert";
import { Badge } from "@kandev/ui/badge";
import { Button } from "@kandev/ui/button";
import { CardContent, CardHeader, CardTitle } from "@kandev/ui/card";
import { Input } from "@kandev/ui/input";
import { SettingsRow } from "../settings-group";
import { SettingsInfo } from "../settings-info";
import { Spinner } from "@kandev/ui/spinner";
import { Switch } from "@kandev/ui/switch";
import { IconAlertCircle, IconLock } from "@tabler/icons-react";
import type { TFunction } from "i18next";
import { useTranslation } from "react-i18next";
import { useAppStore } from "@/components/state-provider";
import { SettingsCard } from "@/components/settings/settings-card";
import {
settingsActionClassName,
settingsControlClassName,
} from "@/components/settings/settings-control";
import { useSettingsSaveContributor } from "@/components/settings/settings-save-provider";
import {
fetchMessageQueueSettings,
updateMessageQueueSettings,
} from "@/lib/api/domains/settings-api";
import type { MessageQueueSettingsResponse, MessageQueueSettingsSource } from "@/lib/types/system";
const ENVIRONMENT_VARIABLE = "KANDEV_QUEUE_MAX_PER_SESSION";
/** Parses the max-per-session draft text into a non-negative safe integer,
* or `null` when the text isn't a valid whole number. */
function parseMaximum(value: string): number | null {
const trimmed = value.trim();
if (!/^\d+$/.test(trimmed)) return null;
const parsed = Number(trimmed);
return Number.isSafeInteger(parsed) ? parsed : null;
}
/** Maps an effective-settings source enum to its i18n label key. */
function sourceLabelKey(source: MessageQueueSettingsSource): string {
switch (source) {
case "setting":
return "system:messageQueueSourceSetting";
case "configuration":
return "system:messageQueueSourceConfiguration";
case "environment":
return "system:messageQueueSourceEnvironment";
default:
return "system:messageQueueSourceDefault";
}
}
function queueCapacityLockMessage(
t: TFunction,
source: MessageQueueSettingsSource | undefined,
): string {
if (source === "configuration") return t("system:messageQueueConfigurationLocked");
return t("system:messageQueueEnvironmentLocked", { variable: ENVIRONMENT_VARIABLE });
}
type QueueSettingsValidationOptions = {
parsed: number | null;
isAdmin: boolean;
isLocked: boolean;
isMaxDirty: boolean;
lockSource: MessageQueueSettingsSource | undefined;
};
function queueSettingsInvalidReason(
t: TFunction,
{ parsed, isAdmin, isLocked, isMaxDirty, lockSource }: QueueSettingsValidationOptions,
): string | undefined {
if (parsed === null) return t("system:messageQueueValidation");
if (!isAdmin) return t("system:messageQueueAdminOnly");
if (isLocked && isMaxDirty) return queueCapacityLockMessage(t, lockSource);
return undefined;
}
/** Loads the persisted snapshot and owns the editable queue-setting drafts.
* Split out of
* `useMessageQueueSettingsDraft` so neither function needs to grow past the
* project's per-function line limit as the page gains fields. */
function useMessageQueueSettingsLoad() {
const [snapshot, setSnapshot] = useState<MessageQueueSettingsResponse | null>(null);
const [draft, setDraft] = useState("");
const [mergeDraft, setMergeDraft] = useState(true);
const [autoMergeDraft, setAutoMergeDraft] = useState(true);
const [loading, setLoading] = useState(true);
const [loadFailed, setLoadFailed] = useState(false);
const loadVersion = useRef(0);
const reload = useCallback(async () => {
const version = ++loadVersion.current;
setLoading(true);
setLoadFailed(false);
try {
const response = await fetchMessageQueueSettings();
if (version !== loadVersion.current) return;
setSnapshot(response);
setDraft(String(response.settings.max_per_session));
setMergeDraft(response.settings.merge_enabled);
setAutoMergeDraft(response.settings.auto_merge_enabled);
} catch {
if (version === loadVersion.current) setLoadFailed(true);
} finally {
if (version === loadVersion.current) setLoading(false);
}
}, []);
useEffect(() => {
void reload();
return () => {
loadVersion.current += 1;
};
}, [reload]);
return {
snapshot,
setSnapshot,
draft,
setDraft,
mergeDraft,
setMergeDraft,
autoMergeDraft,
setAutoMergeDraft,
loading,
loadFailed,
reload,
};
}
type QueueSettingsContributorOptions = {
load: ReturnType<typeof useMessageQueueSettingsLoad>;
parsed: number | null;
isMaxDirty: boolean;
isMergeDirty: boolean;
isAutoMergeDirty: boolean;
isAdmin: boolean;
isLocked: boolean;
invalidReason: string | undefined;
onSaveFailed: (failed: boolean) => void;
};
/** Registers all queue drafts as one atomic settings-page contributor. */
function useQueueSettingsContributor({
load,
parsed,
isMaxDirty,
isMergeDirty,
isAutoMergeDirty,
isAdmin,
isLocked,
invalidReason,
onSaveFailed,
}: QueueSettingsContributorOptions) {
const {
snapshot,
setSnapshot,
draft,
setDraft,
mergeDraft,
setMergeDraft,
autoMergeDraft,
setAutoMergeDraft,
} = load;
const baseline = snapshot?.settings.max_per_session;
const mergeBaseline = snapshot?.settings.merge_enabled;
const autoMergeBaseline = snapshot?.settings.auto_merge_enabled;
const isDirty = isMaxDirty || isMergeDirty || isAutoMergeDirty;
useSettingsSaveContributor({
id: "system-message-queue",
revision: `${draft}:${mergeDraft}:${autoMergeDraft}`,
isDirty,
canSave: parsed !== null && isAdmin && (!isMaxDirty || !isLocked),
invalidReason,
save: async () => {
if (parsed === null || !isAdmin || (isMaxDirty && isLocked)) {
throw new Error(invalidReason);
}
const submitted = draft;
const submittedMerge = mergeDraft;
const submittedAutoMerge = autoMergeDraft;
onSaveFailed(false);
try {
const response = await updateMessageQueueSettings({
...(isMaxDirty ? { max_per_session: parsed } : {}),
...(isMergeDirty ? { merge_enabled: mergeDraft } : {}),
...(isAutoMergeDirty ? { auto_merge_enabled: autoMergeDraft } : {}),
});
setSnapshot(response);
setDraft((current) =>
current === submitted ? String(response.settings.max_per_session) : current,
);
setMergeDraft((current) =>
current === submittedMerge ? response.settings.merge_enabled : current,
);
setAutoMergeDraft((current) =>
current === submittedAutoMerge ? response.settings.auto_merge_enabled : current,
);
} catch (error) {
onSaveFailed(true);
throw error;
}
},
discard: () => {
if (baseline !== undefined) setDraft(String(baseline));
if (mergeBaseline !== undefined) setMergeDraft(mergeBaseline);
if (autoMergeBaseline !== undefined) setAutoMergeDraft(autoMergeBaseline);
onSaveFailed(false);
},
});
}
/** Derives dirty, validation, and permission state for all queue drafts. */
export function useMessageQueueSettingsDraft() {
const { t } = useTranslation();
const role = useAppStore((state) => state.auth.user?.role);
const [saveFailed, setSaveFailed] = useState(false);
const load = useMessageQueueSettingsLoad();
const { snapshot, draft, mergeDraft, autoMergeDraft } = load;
const parsed = parseMaximum(draft);
const baseline = snapshot?.settings.max_per_session;
const mergeBaseline = snapshot?.settings.merge_enabled;
const autoMergeBaseline = snapshot?.settings.auto_merge_enabled;
const isMaxDirty = baseline !== undefined && draft !== String(baseline);
const isMergeDirty = mergeBaseline !== undefined && mergeDraft !== mergeBaseline;
const isAutoMergeDirty = autoMergeBaseline !== undefined && autoMergeDraft !== autoMergeBaseline;
const isAdmin = role === undefined || role === "admin";
const isLocked = snapshot?.effective.locked === true;
const lockSource = snapshot?.effective.source;
const invalidReason = queueSettingsInvalidReason(t, {
parsed,
isAdmin,
isLocked,
isMaxDirty,
lockSource,
});
useQueueSettingsContributor({
load,
parsed,
isMaxDirty,
isMergeDirty,
isAutoMergeDirty,
isAdmin,
isLocked,
invalidReason,
onSaveFailed: setSaveFailed,
});
return {
snapshot,
draft,
setDraft: load.setDraft,
mergeDraft,
setMergeDraft: load.setMergeDraft,
autoMergeDraft,
setAutoMergeDraft: load.setAutoMergeDraft,
loading: load.loading,
loadFailed: load.loadFailed,
saveFailed,
invalidReason,
isDirty: isMaxDirty || isMergeDirty || isAutoMergeDirty,
isAdmin,
isLocked,
lockSource,
reload: load.reload,
};
}
type QueueLimitFieldsProps = {
draft: string;
onDraftChange: (value: string) => void;
disabled: boolean;
configured: number;
effectiveValue: string;
source: MessageQueueSettingsSource;
};
/** Renders the per-session limit input plus the configured/effective summary
* badge; a pure presentational block extracted so `MessageQueueSettings`
* stays under the per-function line limit. */
function QueueLimitFields({
draft,
onDraftChange,
disabled,
configured,
effectiveValue,
source,
}: QueueLimitFieldsProps) {
const { t } = useTranslation();
return (
<>
<SettingsRow
label={t("system:messageQueueMaximumLabel")}
description={t("settings:queueMaximumShort")}
controlId="message-queue-max-per-session"
info={
<SettingsInfo label={t("system:messageQueueMaximumLabel")}>
<p>{t("system:messageQueueLimitDescription")}</p>
<p>{t("system:messageQueueUnlimitedHelp")}</p>
<p>{t("system:messageQueueEffectiveHelp")}</p>
</SettingsInfo>
}
control={
<Input
id="message-queue-max-per-session"
data-testid="message-queue-max-per-session"
type="number"
inputMode="numeric"
min={0}
step={1}
value={draft}
disabled={disabled}
onChange={(event) => onDraftChange(event.target.value)}
className={settingsControlClassName("w-full md:w-40")}
/>
}
/>
<div className="text-xs text-muted-foreground">
<div className="flex flex-wrap items-center gap-2">
{String(configured) !== effectiveValue && (
<>
<span>{t("system:messageQueueConfigured")}</span>
<span>{configured}</span>
</>
)}
<span className="text-muted-foreground">{t("system:messageQueueEffective")}</span>
<strong data-testid="message-queue-effective-value">{effectiveValue}</strong>
<Badge variant="secondary" data-testid="message-queue-source">
{t(sourceLabelKey(source))}
</Badge>
</div>
</div>
</>
);
}
type MergeToggleFieldsProps = {
enabled: boolean;
onChange: (next: boolean) => void;
disabled: boolean;
};
/** Renders the merge-enabled switch plus its limitations notice; extracted
* for the same per-function line-limit reason as `QueueLimitFields`. */
function MergeToggleFields({ enabled, onChange, disabled }: MergeToggleFieldsProps) {
const { t } = useTranslation();
const label = t("system:messageQueueMergeToggleLabel");
return (
<SettingsRow
label={label}
description={t("settings:queueMergeShort")}
controlId="message-queue-merge-enabled"
touchTarget="switch"
controlWrapperTestId="message-queue-merge-touch-target"
info={
<SettingsInfo label={label}>
<p>{t("system:messageQueueMergeDescription")}</p>
<p>{t("system:messageQueueMergeNotice")}</p>
</SettingsInfo>
}
control={
<Switch
id="message-queue-merge-enabled"
data-testid="message-queue-merge-enabled"
checked={enabled}
disabled={disabled}
onCheckedChange={onChange}
aria-label={label}
className="cursor-pointer disabled:cursor-not-allowed"
/>
}
/>
);
}
function AutoMergeToggleFields({ enabled, onChange, disabled }: MergeToggleFieldsProps) {
const { t } = useTranslation();
const label = t("system:messageQueueAutoMergeToggleLabel");
return (
<SettingsRow
label={label}
description={t("settings:queueAutoMergeShort")}
controlId="message-queue-auto-merge-enabled"
touchTarget="switch"
controlWrapperTestId="message-queue-auto-merge-touch-target"
info={
<SettingsInfo label={label}>
<p>{t("system:messageQueueAutoMergeDescription")}</p>
<p>{t("system:messageQueueAutoMergeNotice")}</p>
</SettingsInfo>
}
control={
<Switch
id="message-queue-auto-merge-enabled"
data-testid="message-queue-auto-merge-enabled"
checked={enabled}
disabled={disabled}
onCheckedChange={onChange}
aria-label={label}
className="cursor-pointer disabled:cursor-not-allowed"
/>
}
/>
);
}
function MessageQueueLoadingState({ withinGroup }: { withinGroup: boolean }) {
const { t } = useTranslation();
const loadingContent = (
<div className="flex items-center gap-2 py-6 text-sm text-muted-foreground">
<Spinner className="size-4" />
{t("system:messageQueueLoading")}
</div>
);
if (withinGroup) return <div data-testid="message-queue-settings">{loadingContent}</div>;
return (
<SettingsCard>
<CardContent>{loadingContent}</CardContent>
</SettingsCard>
);
}
function MessageQueueSettingsReady({
state,
withinGroup,
}: MessageQueueSettingsContentProps & {
state: NonNullable<MessageQueueSettingsContentProps["state"]>;
}) {
const { t } = useTranslation();
const { settings, effective } = state.snapshot!;
const isConfigurationLocked = state.lockSource === "configuration";
const effectiveValue =
effective.max_per_session === 0
? t("system:messageQueueUnlimited")
: String(effective.max_per_session);
const content = (
<>
{withinGroup ? (
<div className="space-y-1 pb-3">
<h4 className="text-sm font-semibold">{t("system:messageQueueTitle")}</h4>
</div>
) : (
<CardHeader>
<CardTitle className="text-base">{t("system:messageQueueLimitTitle")}</CardTitle>
</CardHeader>
)}
<CardContent className={withinGroup ? "min-w-0 space-y-5 px-0" : "min-w-0 space-y-5"}>
{!withinGroup && (
<p className="text-sm text-muted-foreground">
{t("system:messageQueueLimitDescription")}
</p>
)}
<QueueLimitFields
draft={state.draft}
onDraftChange={state.setDraft}
disabled={!state.isAdmin || state.isLocked}
configured={settings.max_per_session}
effectiveValue={effectiveValue}
source={effective.source}
/>
{state.isDirty && state.invalidReason && (
<p role="alert" className="text-sm text-destructive">
{state.invalidReason}
</p>
)}
{state.isLocked && (
<Alert>
<IconLock className="size-4" />
<AlertTitle>
{t(
isConfigurationLocked
? "system:messageQueueConfigurationLockTitle"
: "system:messageQueueEnvironmentLockTitle",
)}
</AlertTitle>
<AlertDescription>{queueCapacityLockMessage(t, state.lockSource)}</AlertDescription>
</Alert>
)}
{!state.isAdmin && (
<p className="text-sm text-muted-foreground">{t("system:messageQueueAdminOnly")}</p>
)}
{state.saveFailed && (
<Alert variant="destructive">
<IconAlertCircle className="size-4" />
<AlertDescription>{t("system:messageQueueSaveFailed")}</AlertDescription>
</Alert>
)}
<MergeToggleFields
enabled={state.mergeDraft}
onChange={state.setMergeDraft}
disabled={!state.isAdmin}
/>
<AutoMergeToggleFields
enabled={state.autoMergeDraft}
onChange={state.setAutoMergeDraft}
disabled={!state.isAdmin}
/>
</CardContent>
</>
);
if (withinGroup) {
return (
<div className="min-w-0 py-3" data-testid="message-queue-settings">
{content}
</div>
);
}
return (
<SettingsCard
isDirty={state.isDirty}
className="min-w-0 w-full"
data-testid="message-queue-settings"
>
{content}
</SettingsCard>
);
}
/** Settings → Task Behavior → Message Queue controls, sharing one save contributor. */
type MessageQueueSettingsContentProps = {
state: ReturnType<typeof useMessageQueueSettingsDraft>;
withinGroup?: boolean;
};
export function MessageQueueSettings() {
const state = useMessageQueueSettingsDraft();
return <MessageQueueSettingsContent state={state} />;
}
export function MessageQueueSettingsContent({
state,
withinGroup = false,
}: MessageQueueSettingsContentProps) {
if (state.loading && !state.snapshot) {
return <MessageQueueLoadingState withinGroup={withinGroup} />;
}
if (state.loadFailed && !state.snapshot) {
return <MessageQueueLoadError onRetry={() => void state.reload()} withinGroup={withinGroup} />;
}
if (!state.snapshot) return null;
return <MessageQueueSettingsReady state={state} withinGroup={withinGroup} />;
}
function MessageQueueLoadError({
onRetry,
withinGroup = false,
}: {
onRetry: () => void;
withinGroup?: boolean;
}) {
const { t } = useTranslation();
const content = (
<div className="space-y-3 py-6">
<Alert variant="destructive">
<IconAlertCircle className="size-4" />
<AlertDescription>{t("system:messageQueueLoadFailed")}</AlertDescription>
</Alert>
<Button
variant="outline"
className={settingsActionClassName("cursor-pointer")}
onClick={onRetry}
>
{t("system:messageQueueRetry")}
</Button>
</div>
);
if (withinGroup) return <div data-testid="message-queue-settings">{content}</div>;
return (
<SettingsCard>
<CardContent>{content}</CardContent>
</SettingsCard>
);
}