mirror of
https://github.com/blakeblackshear/frigate.git
synced 2026-03-31 12:24:55 +03:00
* add CameraProfileConfig model for named config overrides * add profiles field to CameraConfig * add active_profile field to FrigateConfig Runtime-only field excluded from YAML serialization, tracks which profile is currently active. * add ProfileManager for profile activation and persistence Handles snapshotting base configs, applying profile overrides via deep_merge + apply_section_update, publishing ZMQ updates, and persisting active profile to /config/.active_profile. * add profile API endpoints (GET /profiles, GET/PUT /profile) * add MQTT and dispatcher integration for profiles - Subscribe to frigate/profile/set MQTT topic - Publish profile/state and profiles/available on connect - Add _on_profile_command handler to dispatcher - Broadcast active profile state on WebSocket connect * wire ProfileManager into app startup and FastAPI - Create ProfileManager after dispatcher init - Restore persisted profile on startup - Pass dispatcher and profile_manager to FastAPI app * add tests for invalid profile values and keys Tests that Pydantic rejects: invalid field values (fps: "not_a_number"), unknown section keys (ffmpeg in profile), invalid nested values, and invalid profiles in full config parsing. * formatting * fix CameraLiveConfig JSON serialization error on profile activation refactor _publish_updates to only publish ZMQ updates for sections that actually changed, not all sections on affected cameras. * consolidate * add enabled field to camera profiles for enabling/disabling cameras * add zones support to camera profiles * add frontend profile types, color utility, and config save support * add profile state management and save preview support * add profileName prop to BaseSection for profile-aware config editing * add profile section dropdown and wire into camera settings pages * add per-profile camera enable/disable to Camera Management view * add profiles summary page with card-based layout and fix backend zone comparison bug * add active profile badge to settings toolbar * i18n * add red dot for any pending changes including profiles * profile support for mask and zone editor * fix hidden field validation errors caused by lodash wildcard and schema gaps lodash unset does not support wildcard (*) segments, so hidden fields like filters.*.mask were never stripped from form data, leaving null raw_coordinates that fail RJSF anyOf validation. Add unsetWithWildcard helper and also strip hidden fields from the JSON schema itself as defense-in-depth. * add face_recognition and lpr to profile-eligible sections * move profile dropdown from section panes to settings header * add profiles enable toggle and improve empty state * formatting * tweaks * tweak colors and switch * fix profile save diff, masksAndZones delete, and config sync * ui tweaks * ensure profile manager gets updated config * rename profile settings to ui settings * refactor profilesview and add dots/border colors when overridden * implement an update_config method for profile manager * fix mask deletion * more unique colors * add top-level profiles config section with friendly names * implement profile friendly names and improve profile UI - Add ProfileDefinitionConfig type and profiles field to FrigateConfig - Use ProfilesApiResponse type with friendly_name support throughout - Replace Record<string, unknown> with proper JsonObject/JsonValue types - Add profile creation form matching zone pattern (Zod + NameAndIdFields) - Add pencil icon for renaming profile friendly names in ProfilesView - Move Profiles menu item to first under Camera Configuration - Add activity indicators on save/rename/delete buttons - Display friendly names in CameraManagementView profile selector - Fix duplicate colored dots in management profile dropdown - Fix i18n namespace for overridden base config tooltips - Move profile override deletion from dropdown trash icon to footer button with confirmation dialog, matching Reset to Global pattern - Remove Add Profile from section header dropdown to prevent saving camera overrides before top-level profile definition exists - Clean up newProfiles state after API profile deletion - Refresh profiles SWR cache after saving profile definitions * remove profile badge in settings and add profiles to main menu * use icon only on mobile * change color order * docs * show activity indicator on trash icon while deleting a profile * tweak language * immediately create profiles on backend instead of deferring to Save All * hide restart-required fields when editing a profile section fields that require a restart cannot take effect via profile switching, so they are merged into hiddenFields when profileName is set * show active profile indicator in desktop status bar * fix profile config inheritance bug where Pydantic defaults override base values The /config API was dumping profile overrides with model_dump() which included all Pydantic defaults. When the frontend merged these over the camera's base config, explicitly-set base values were lost. Now profile overrides are re-dumped with exclude_unset=True so only user-specified fields are returned. Also fixes the Save All path generating spurious deletion markers for restart-required fields that are hidden during profile editing but not excluded from the raw data sanitization in prepareSectionSavePayload. * docs tweaks * docs tweak * formatting * formatting * fix typing * fix test pollution test_maintainer was injecting MagicMock() into sys.modules["frigate.config.camera.updater"] at module load time and never restoring it. When the profile tests later imported CameraConfigUpdateEnum and CameraConfigUpdateTopic from that module, they got mock objects instead of the real dataclass/enum, so equality comparisons always failed * remove * fix settings showing profile-merged values when editing base config When a profile is active, the in-memory config contains effective (profile-merged) values. The settings UI was displaying these merged values even when the "Base Config" view was selected. Backend: snapshot pre-profile base configs in ProfileManager and expose them via a `base_config` key in the /api/config camera response when a profile is active. The top-level sections continue to reflect the effective running config. Frontend: read from `base_config` when available in BaseSection, useConfigOverride, useAllCameraOverrides, and prepareSectionSavePayload. Include formData labels in Object/Audio switches widgets so that labels added only by a profile override remain visible when editing that profile. * use rasterized_mask as field makes it easier to exclude from the schema with exclude=True prevents leaking of the field when using model_dump for profiles * fix zones - Fix zone colors not matching across profiles by falling back to base zone color when profile zone data lacks a color field - Use base_config for base-layer values in masks/zones view so profile-merged values don't pollute the base config editing view - Handle zones separately in profile manager snapshot/restore since ZoneConfig requires special serialization (color as private attr, contour generation) - Inherit base zone color and generate contours for profile zone overrides in profile manager * formatting * don't require restart for camera enabled change for profiles * publish camera state when changing profiles * formatting * remove available profiles from mqtt * improve typing
242 lines
8.6 KiB
TypeScript
242 lines
8.6 KiB
TypeScript
import { useCallback, useMemo, useState } from "react";
|
|
import { useTranslation } from "react-i18next";
|
|
import type { SectionConfig } from "@/components/config-form/sections";
|
|
import { ConfigSectionTemplate } from "@/components/config-form/sections";
|
|
import type { PolygonType } from "@/types/canvas";
|
|
import { Badge } from "@/components/ui/badge";
|
|
import {
|
|
Tooltip,
|
|
TooltipContent,
|
|
TooltipTrigger,
|
|
} from "@/components/ui/tooltip";
|
|
import type { ConfigSectionData } from "@/types/configForm";
|
|
import type { ProfileState } from "@/types/profile";
|
|
import { getSectionConfig } from "@/utils/configUtil";
|
|
import { getProfileColor } from "@/utils/profileColors";
|
|
import { cn } from "@/lib/utils";
|
|
import { useDocDomain } from "@/hooks/use-doc-domain";
|
|
import { Link } from "react-router-dom";
|
|
import { LuExternalLink } from "react-icons/lu";
|
|
import Heading from "@/components/ui/heading";
|
|
|
|
export type SettingsPageProps = {
|
|
selectedCamera?: string;
|
|
setUnsavedChanges?: React.Dispatch<React.SetStateAction<boolean>>;
|
|
selectedZoneMask?: PolygonType[];
|
|
onSectionStatusChange?: (
|
|
sectionKey: string,
|
|
level: "global" | "camera",
|
|
status: SectionStatus,
|
|
) => void;
|
|
pendingDataBySection?: Record<string, ConfigSectionData>;
|
|
onPendingDataChange?: (
|
|
sectionKey: string,
|
|
cameraName: string | undefined,
|
|
data: ConfigSectionData | null,
|
|
) => void;
|
|
profileState?: ProfileState;
|
|
/** Callback to delete the current profile's overrides for the current section */
|
|
onDeleteProfileSection?: (profileName: string) => void;
|
|
profilesUIEnabled?: boolean;
|
|
setProfilesUIEnabled?: React.Dispatch<React.SetStateAction<boolean>>;
|
|
};
|
|
|
|
export type SectionStatus = {
|
|
hasChanges: boolean;
|
|
isOverridden: boolean;
|
|
/** Where the override comes from: "global" = camera overrides global, "profile" = profile overrides base */
|
|
overrideSource?: "global" | "profile";
|
|
hasValidationErrors: boolean;
|
|
};
|
|
|
|
export type SingleSectionPageOptions = {
|
|
sectionKey: string;
|
|
level: "global" | "camera";
|
|
sectionConfig?: SectionConfig;
|
|
requiresRestart?: boolean;
|
|
showOverrideIndicator?: boolean;
|
|
};
|
|
|
|
export type SingleSectionPageProps = SettingsPageProps &
|
|
SingleSectionPageOptions;
|
|
|
|
export function SingleSectionPage({
|
|
sectionKey,
|
|
level,
|
|
sectionConfig,
|
|
requiresRestart,
|
|
showOverrideIndicator = true,
|
|
selectedCamera,
|
|
setUnsavedChanges,
|
|
onSectionStatusChange,
|
|
pendingDataBySection,
|
|
onPendingDataChange,
|
|
profileState,
|
|
onDeleteProfileSection,
|
|
}: SingleSectionPageProps) {
|
|
const sectionNamespace =
|
|
level === "camera" ? "config/cameras" : "config/global";
|
|
const { t, i18n } = useTranslation([
|
|
sectionNamespace,
|
|
"views/settings",
|
|
"common",
|
|
]);
|
|
const { getLocaleDocUrl } = useDocDomain();
|
|
const [sectionStatus, setSectionStatus] = useState<SectionStatus>({
|
|
hasChanges: false,
|
|
isOverridden: false,
|
|
hasValidationErrors: false,
|
|
});
|
|
const resolvedSectionConfig = useMemo(
|
|
() => sectionConfig ?? getSectionConfig(sectionKey, level),
|
|
[level, sectionConfig, sectionKey],
|
|
);
|
|
const sectionDocsUrl = resolvedSectionConfig.sectionDocs
|
|
? getLocaleDocUrl(resolvedSectionConfig.sectionDocs)
|
|
: undefined;
|
|
|
|
const currentEditingProfile = selectedCamera
|
|
? (profileState?.editingProfile[selectedCamera] ?? null)
|
|
: null;
|
|
|
|
const profileColor = useMemo(
|
|
() =>
|
|
currentEditingProfile && profileState?.allProfileNames
|
|
? getProfileColor(currentEditingProfile, profileState.allProfileNames)
|
|
: undefined,
|
|
[currentEditingProfile, profileState?.allProfileNames],
|
|
);
|
|
|
|
const handleDeleteProfileSection = useCallback(() => {
|
|
if (currentEditingProfile && onDeleteProfileSection) {
|
|
onDeleteProfileSection(currentEditingProfile);
|
|
}
|
|
}, [currentEditingProfile, onDeleteProfileSection]);
|
|
|
|
const handleSectionStatusChange = useCallback(
|
|
(status: SectionStatus) => {
|
|
setSectionStatus(status);
|
|
onSectionStatusChange?.(sectionKey, level, status);
|
|
},
|
|
[level, onSectionStatusChange, sectionKey],
|
|
);
|
|
|
|
if (level === "camera" && !selectedCamera) {
|
|
return (
|
|
<div className="flex h-full items-center justify-center text-muted-foreground">
|
|
{t("configForm.camera.noCameras", { ns: "views/settings" })}
|
|
</div>
|
|
);
|
|
}
|
|
|
|
return (
|
|
<div className="flex size-full flex-col lg:pr-2">
|
|
<div className="mb-5 flex items-center justify-between gap-4">
|
|
<div className="flex flex-col">
|
|
<Heading as="h4">
|
|
{t(`${sectionKey}.label`, { ns: sectionNamespace })}
|
|
</Heading>
|
|
{i18n.exists(`${sectionKey}.description`, {
|
|
ns: sectionNamespace,
|
|
}) && (
|
|
<div className="my-1 text-sm text-muted-foreground">
|
|
{t(`${sectionKey}.description`, { ns: sectionNamespace })}
|
|
</div>
|
|
)}
|
|
{sectionDocsUrl && (
|
|
<div className="flex items-center text-sm text-primary-variant">
|
|
<Link
|
|
to={sectionDocsUrl}
|
|
target="_blank"
|
|
rel="noopener noreferrer"
|
|
className="inline"
|
|
>
|
|
{t("readTheDocumentation", { ns: "common" })}
|
|
<LuExternalLink className="ml-2 inline-flex size-3" />
|
|
</Link>
|
|
</div>
|
|
)}
|
|
</div>
|
|
<div className="flex flex-col items-end gap-2 md:flex-row md:items-center">
|
|
<div className="flex flex-wrap items-center justify-end gap-2">
|
|
{level === "camera" &&
|
|
showOverrideIndicator &&
|
|
sectionStatus.isOverridden && (
|
|
<Tooltip>
|
|
<TooltipTrigger asChild>
|
|
<Badge
|
|
variant="secondary"
|
|
className={cn(
|
|
"cursor-default border-2 text-center text-xs text-primary-variant",
|
|
sectionStatus.overrideSource === "profile" &&
|
|
profileColor
|
|
? profileColor.border
|
|
: "border-selected",
|
|
)}
|
|
>
|
|
{sectionStatus.overrideSource === "profile"
|
|
? t("button.overriddenBaseConfig", {
|
|
ns: "views/settings",
|
|
defaultValue: "Overridden (Base Config)",
|
|
})
|
|
: t("button.overriddenGlobal", {
|
|
ns: "views/settings",
|
|
defaultValue: "Overridden (Global)",
|
|
})}
|
|
</Badge>
|
|
</TooltipTrigger>
|
|
<TooltipContent>
|
|
{sectionStatus.overrideSource === "profile"
|
|
? t("button.overriddenBaseConfigTooltip", {
|
|
ns: "views/settings",
|
|
profile: currentEditingProfile
|
|
? (profileState?.profileFriendlyNames.get(
|
|
currentEditingProfile,
|
|
) ?? currentEditingProfile)
|
|
: "",
|
|
})
|
|
: t("button.overriddenGlobalTooltip", {
|
|
ns: "views/settings",
|
|
})}
|
|
</TooltipContent>
|
|
</Tooltip>
|
|
)}
|
|
{sectionStatus.hasChanges && (
|
|
<Badge
|
|
variant="secondary"
|
|
className="cursor-default bg-danger text-xs text-white hover:bg-danger"
|
|
>
|
|
{t("modified", { ns: "common", defaultValue: "Modified" })}
|
|
</Badge>
|
|
)}
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<ConfigSectionTemplate
|
|
sectionKey={sectionKey}
|
|
level={level}
|
|
cameraName={level === "camera" ? selectedCamera : undefined}
|
|
showOverrideIndicator={showOverrideIndicator}
|
|
onSave={() => setUnsavedChanges?.(false)}
|
|
showTitle={false}
|
|
sectionConfig={resolvedSectionConfig}
|
|
pendingDataBySection={pendingDataBySection}
|
|
onPendingDataChange={onPendingDataChange}
|
|
requiresRestart={requiresRestart}
|
|
onStatusChange={handleSectionStatusChange}
|
|
profileName={currentEditingProfile ?? undefined}
|
|
profileFriendlyName={
|
|
currentEditingProfile
|
|
? (profileState?.profileFriendlyNames.get(currentEditingProfile) ??
|
|
currentEditingProfile)
|
|
: undefined
|
|
}
|
|
profileBorderColor={profileColor?.border}
|
|
onDeleteProfileSection={
|
|
currentEditingProfile ? handleDeleteProfileSection : undefined
|
|
}
|
|
/>
|
|
</div>
|
|
);
|
|
}
|