A modern and easy to use dashboard. 80+ integrations. 20K+ icons built in. Authentication out of the box. No YAML, drag and drop configuration.
feat(releases): hide Docker suggestions per item (#7239)
Thomas97a5fb433728
diff --git a/packages/api/src/router/docker/docker-router.ts b/packages/api/src/router/docker/docker-router.tsindex db3c0fc19..14eacfcca 100644--- a/packages/api/src/router/docker/docker-router.ts+++ b/packages/api/src/router/docker/docker-router.ts@@ -2,6 +2,8 @@ import { TRPCError } from "@trpc/server";import { observable } from "@trpc/server/observable";import { z } from "zod/v4";+import { createKeyedFingerprint } from "@homarr/common/server";+import { getReleaseSourceFromDockerImage } from "@homarr/definitions";import type { ContainerState, DockerContainerTarget, Port } from "@homarr/docker";import { DockerSingleton } from "@homarr/docker";import {@@ -84,7 +86,16 @@ export const dockerRouter = createTRPCRouter({const { data, timestamp } = result;return {- containers: data.containers satisfies DockerContainer[],+ containers: data.containers.map((container): DockerContainer => {+ const source = getReleaseSourceFromDockerImage(container.image);+ let releaseSourceToken: string | undefined;+ if (source) {+ releaseSourceToken = createKeyedFingerprint(+ JSON.stringify(["releases-docker-suggestion-v1", source.provider, source.identifier]),+ );+ }+ return { ...container, releaseSourceToken };+ }),endpoints: data.endpoints,timestamp,};@@ -292,6 +303,7 @@ const assertDockerEndpointCapability = (};interface DockerContainer {+ releaseSourceToken?: string;endpointId: string;endpointName: string;resourceId: string;diff --git a/packages/definitions/src/release-provider.ts b/packages/definitions/src/release-provider.tsindex 3fa53cc8f..69dd4f861 100644--- a/packages/definitions/src/release-provider.ts+++ b/packages/definitions/src/release-provider.ts@@ -76,3 +76,35 @@ export const normalizeReleaseProviderIdentifier = (provider: ReleaseProviderKind// ponytail: only strip container image versions/digests for providers that use themreturn registryPrefix ? removeContainerImageVersion(withoutRegistry) : withoutRegistry;};++const containerImageToProviderKind: Record<string, ReleaseProviderKind> = {+ "ghcr.io": "gitHubContainerRegistry",+ "docker.io": "dockerHub",+ "lscr.io": "linuxServerIO",+ "quay.io": "quay",+};++export const getReleaseSourceFromDockerImage = (image: string) => {+ const digestIndex = image.indexOf("@");+ let withoutDigest = image;+ if (digestIndex !== -1) withoutDigest = image.slice(0, digestIndex);++ const tagIndex = withoutDigest.indexOf(":", withoutDigest.lastIndexOf("/") + 1);+ let reference = withoutDigest;+ let version: string | undefined;+ if (tagIndex !== -1) {+ reference = withoutDigest.slice(0, tagIndex);+ version = withoutDigest.slice(tagIndex + 1);+ }++ const [maybeSource, maybeIdentifier] = reference.split(/\/(.*)/);+ const hasSource = maybeSource && maybeSource in containerImageToProviderKind;+ const source = hasSource ? maybeSource : "docker.io";+ let identifier = reference;+ if (hasSource && maybeIdentifier) identifier = maybeIdentifier;++ if (!identifier) return undefined;++ const provider = containerImageToProviderKind[source] ?? "dockerHub";+ return { provider, identifier: normalizeReleaseProviderIdentifier(provider, identifier), version };+};diff --git a/packages/translation/src/lang/en.json b/packages/translation/src/lang/en.jsonindex 4a8c85fc0..3de39c1bc 100644--- a/packages/translation/src/lang/en.json+++ b/packages/translation/src/lang/en.json@@ -1904,6 +1904,7 @@"tryAgain": "Try again","loading": "Loading","show": "Show",+ "showAll": "Show all","hide": "Hide","undo": "Undo","editNamed": "Edit {name}",@@ -1913,6 +1914,7 @@"copied": "Copied","refresh": "Refresh"},+ "hidden": "Hidden","pagination": {"pageOf": "Page {page} of {totalPages}"},diff --git a/packages/widgets/src/_inputs/widget-multiReleasesRepositories-input.tsx b/packages/widgets/src/_inputs/widget-multiReleasesRepositories-input.tsxindex a565af636..4664ed93a 100644--- a/packages/widgets/src/_inputs/widget-multiReleasesRepositories-input.tsx+++ b/packages/widgets/src/_inputs/widget-multiReleasesRepositories-input.tsx@@ -28,6 +28,8 @@ import {IconCopy,IconCopyCheckFilled,IconEdit,+ IconEye,+ IconEyeOff,IconKey,IconPackageImport,IconPlus,@@ -43,7 +45,7 @@ import {getReleaseProviderDefaultUrl,getReleaseProviderIconUrl,getReleaseProviderName,- normalizeReleaseProviderIdentifier,+ getReleaseSourceFromDockerImage,releaseProviderKinds,} from "@homarr/definitions";import { IconPicker } from "@homarr/forms-collection";@@ -76,6 +78,13 @@ export const WidgetMultiReleasesRepositoriesInput = ({const actionT = useI18n("common.action");const form = useFormContext();const repositories = form.values.options[property] as ReleasesRepository[];+ const storedHiddenSuggestions = form.values.options.hiddenDockerSuggestions;+ let hiddenSourceTokens: string[] = [];+ if (Array.isArray(storedHiddenSuggestions)) {+ hiddenSourceTokens = storedHiddenSuggestions.filter(+ (entry): entry is string => typeof entry === "string" && /^[a-f0-9]{64}$/.test(entry),+ );+ }const { openModal: openEditModal } = useModalAction(RepositoryEditModal);const { openModal: openImportModal } = useModalAction(RepositoryImportModal);const versionFilterPrecisionOptions = useMemo(@@ -173,10 +182,9 @@ export const WidgetMultiReleasesRepositoriesInput = ({onClick={() =>openImportModal({repositories,+ hiddenSourceTokens,versionFilterPrecisionOptions,- onConfirm: (selectedRepositories) => {- if (!selectedRepositories.length) return;-+ onConfirm: (selectedRepositories, nextHiddenSourceTokens) => {form.setValues((previous) => {const previousValues = previous.options?.[property] as ReleasesRepository[];return {@@ -184,6 +192,7 @@ export const WidgetMultiReleasesRepositoriesInput = ({options: {...previous.options,[property]: [...previousValues, ...selectedRepositories],+ hiddenDockerSuggestions: nextHiddenSourceTokens,},};});@@ -653,6 +662,7 @@ const RepositoryEditModal = createModal<RepositoryEditProps>(({ innerProps, actiinterface ReleasesRepositoryImport extends ReleasesRepository {alreadyImported: boolean;+ sourceToken: string;}interface ImportRepositorySelectProps {@@ -661,6 +671,8 @@ interface ImportRepositorySelectProps {versionFilterPrecisionOptions: string[];disabled: boolean;onImageSelectionChanged?: (isSelected: boolean) => void;+ onVisibilityChanged?: () => void;+ hidden?: boolean;}const ImportRepositorySelect = ({@@ -669,9 +681,18 @@ const ImportRepositorySelect = ({versionFilterPrecisionOptions,disabled = false,onImageSelectionChanged = undefined,+ onVisibilityChanged,+ hidden = false,}: ImportRepositorySelectProps) => {const tRepository = useI18n("widget.releases.option.repositories");+ const actionT = useI18n("common.action");const provider = repository.provider;+ let visibilityLabel = actionT("hide");+ let VisibilityIcon = IconEyeOff;+ if (hidden) {+ visibilityLabel = actionT("show");+ VisibilityIcon = IconEye;+ }return (<Group gap="xl" justify="space-between">@@ -734,22 +755,39 @@ const ImportRepositorySelect = ({</Text></Group></Tooltip>+ {onVisibilityChanged && (+ <Button+ size="compact-xs"+ variant="subtle"+ color="gray"+ leftSection={<VisibilityIcon size="1em" />}+ aria-label={`${visibilityLabel}: ${repository.identifier}`}+ onClick={onVisibilityChanged}+ >+ {visibilityLabel}+ </Button>+ )}</Group>);};interface RepositoryImportProps {repositories: ReleasesRepository[];+ hiddenSourceTokens: string[];versionFilterPrecisionOptions: string[];- onConfirm: (selectedRepositories: ReleasesRepositoryImport[]) => void;+ onConfirm: (selectedRepositories: ReleasesRepositoryImport[], hiddenSourceTokens: string[]) => void;isAdmin: boolean;}const RepositoryImportModal = createModal<RepositoryImportProps>(({ innerProps, actions }) => {const tRepository = useI18n("widget.releases.option.repositories");+ const tCommon = useI18n("common");const actionT = useI18n("common.action");const [loading, setLoading] = useState(false);- const [selectedImages, setSelectedImages] = useState([] as ReleasesRepositoryImport[]);+ const [selectedSourceTokens, setSelectedSourceTokens] = useState<string[]>([]);+ const [hiddenSourceTokens, setHiddenSourceTokens] = useState(innerProps.hiddenSourceTokens);+ const hiddenSources = useMemo(() => new Set(hiddenSourceTokens), [hiddenSourceTokens]);+ const selectedSources = useMemo(() => new Set(selectedSourceTokens), [selectedSourceTokens]);const docker = clientApi.docker.getContainers.useQuery(undefined, {refetchOnMount: false,@@ -761,52 +799,76 @@ const RepositoryImportModal = createModal<RepositoryImportProps>(({ innerProps,const imported = new Set(innerProps.repositories.map((item) => `${item.provider}:${item.identifier}`));const seen = new Set<string>();return docker.data.containers.reduce<ReleasesRepositoryImport[]>((acc, container) => {- const [maybeSource, maybeIdentifierAndVersion] = container.image.split(/\/(.*)/);- const hasSource = maybeSource && maybeSource in containerImageToProviderKind;- const source = hasSource ? maybeSource : "docker.io";- const [identifier, version] =- hasSource && maybeIdentifierAndVersion ? maybeIdentifierAndVersion.split(":") : container.image.split(":");-- if (!identifier) return acc;-- const provider = containerImageToProviderKind[source] ?? "dockerHub";- const normalizedIdentifier = normalizeReleaseProviderIdentifier(provider, identifier);-- const key = `${provider}:${normalizedIdentifier}`;+ const source = getReleaseSourceFromDockerImage(container.image);+ if (!source || !container.releaseSourceToken) return acc;+ const { provider, identifier, version } = source;+ const key = `${provider}:${identifier}`;if (seen.has(key)) return acc;seen.add(key);acc.push({id: createId(),provider,- identifier: normalizedIdentifier,+ identifier,iconUrl: container.iconUrl ?? undefined,- name: formatIdentifierName(normalizedIdentifier),+ name: formatIdentifierName(identifier),versionFilter: version ? parseImageVersionToVersionFilter(version) : undefined,alreadyImported: imported.has(key),+ sourceToken: container.releaseSourceToken,});return acc;}, []);}, [docker.data, innerProps.repositories]);+ const visibleRepositories = useMemo(+ () => importRepositories.filter((repository) => !hiddenSources.has(repository.sourceToken)),+ [importRepositories, hiddenSources],+ );+ const availableRepositories = useMemo(+ () => visibleRepositories.filter((repository) => !repository.alreadyImported),+ [visibleRepositories],+ );+ const selectedRepositories = useMemo(+ () => availableRepositories.filter((repository) => selectedSources.has(repository.sourceToken)),+ [availableRepositories, selectedSources],+ );+ const hiddenRepositories = useMemo(+ () => importRepositories.filter((repository) => hiddenSources.has(repository.sourceToken)),+ [importRepositories, hiddenSources],+ );+ const setSourceHidden = (key: string, hidden: boolean) => {+ if (hidden) {+ setHiddenSourceTokens((previous) => [...new Set([...previous, key])]);+ setSelectedSourceTokens((previous) => previous.filter((selected) => selected !== key));+ return;+ }+ setHiddenSourceTokens((previous) => previous.filter((source) => source !== key));+ };+ const hasHiddenChanges =+ hiddenSourceTokens.length !== innerProps.hiddenSourceTokens.length ||+ hiddenSourceTokens.some((key) => !innerProps.hiddenSourceTokens.includes(key));+const handleConfirm = useCallback(() => {setLoading(true);- innerProps.onConfirm(selectedImages);+ innerProps.onConfirm(selectedRepositories, hiddenSourceTokens);setLoading(false);actions.closeModal();- }, [innerProps, selectedImages, actions]);+ }, [innerProps, selectedRepositories, hiddenSourceTokens, actions]);const allImagesImported = useMemo(- () => importRepositories.every((repository) => repository.alreadyImported),- [importRepositories],+ () => visibleRepositories.every((repository) => repository.alreadyImported),+ [visibleRepositories],);const anyImagesImported = useMemo(- () => importRepositories.some((repository) => repository.alreadyImported),- [importRepositories],+ () => visibleRepositories.some((repository) => repository.alreadyImported),+ [visibleRepositories],);+ let initialSection = "";+ if (anyImagesImported) initialSection = "alreadyImported";+ if (!allImagesImported) initialSection = "foundImages";return (<Stack>@@ -815,103 +877,142 @@ const RepositoryImportModal = createModal<RepositoryImportProps>(({ innerProps,<Loader size="xl" /><Title order={3}>{tRepository("importRepositories.loading")}</Title></Stack>- ) : importRepositories.length === 0 ? (+ ) : visibleRepositories.length === 0 && hiddenSourceTokens.length === 0 ? (<Stack justify="center" align="center"><IconBrandDocker stroke={1} size={128} /><Title order={3}>{tRepository("importRepositories.noImagesFound")}</Title></Stack>) : (<Stack>- <Accordion defaultValue={!allImagesImported ? "foundImages" : anyImagesImported ? "alreadyImported" : ""}>- <Accordion.Item value="foundImages">- <Accordion.Control disabled={allImagesImported} icon={<IconZoomScan />}>- <Group>- {tRepository("importRepositories.listFoundImages")}- {allImagesImported && (- <Text c="dimmed" size="sm">- {tRepository("importRepositories.allImagesAlreadyImported")}- </Text>- )}- </Group>- </Accordion.Control>- <Accordion.Panel>- {!allImagesImported && (- <Stack justify="center" gap="xs">- <Group>- <Button- leftSection={<IconCopyCheckFilled size="1em" />}- onClick={() =>- setSelectedImages(importRepositories.filter((repository) => !repository.alreadyImported))- }- size="xs"- >- {tRepository("importRepositories.selectAll")}- </Button>- <Button- leftSection={<IconCopy size="1em" />}- onClick={() => setSelectedImages([])}- size="xs"- variant="default"- color="gray.5"- >- {tRepository("importRepositories.deselectAll")}- </Button>- </Group>-- <Divider />-- {importRepositories- .filter((repository) => !repository.alreadyImported)- .map((repository) => (- <ImportRepositorySelect- key={repository.id}- repository={repository}- checked={selectedImages.includes(repository)}- versionFilterPrecisionOptions={innerProps.versionFilterPrecisionOptions}- disabled={false}- onImageSelectionChanged={(isSelected) =>- isSelected- ? setSelectedImages([...selectedImages, repository])- : setSelectedImages(selectedImages.filter((img) => img !== repository))+ {visibleRepositories.length > 0 && (+ <Accordion defaultValue={initialSection}>+ <Accordion.Item value="foundImages">+ <Accordion.Control disabled={allImagesImported} icon={<IconZoomScan />}>+ <Group>+ {tRepository("importRepositories.listFoundImages")}+ {allImagesImported && (+ <Text c="dimmed" size="sm">+ {tRepository("importRepositories.allImagesAlreadyImported")}+ </Text>+ )}+ </Group>+ </Accordion.Control>+ <Accordion.Panel>+ {!allImagesImported && (+ <Stack justify="center" gap="xs">+ <Group>+ <Button+ leftSection={<IconCopyCheckFilled size="1em" />}+ onClick={() =>+ setSelectedSourceTokens(availableRepositories.map((repository) => repository.sourceToken))}- />- ))}- </Stack>- )}- </Accordion.Panel>- </Accordion.Item>- <Accordion.Item value="alreadyImported">- <Accordion.Control disabled={!anyImagesImported} icon={<IconPackageImport />}>- {tRepository("importRepositories.listAlreadyImportedImages")}- </Accordion.Control>- <Accordion.Panel>- {anyImagesImported && (- <Stack justify="center" gap="xs">- {importRepositories- .filter((repository) => repository.alreadyImported)- .map((repository) => (+ size="xs"+ >+ {tRepository("importRepositories.selectAll")}+ </Button>+ <Button+ leftSection={<IconCopy size="1em" />}+ onClick={() => setSelectedSourceTokens([])}+ size="xs"+ variant="default"+ color="gray.5"+ >+ {tRepository("importRepositories.deselectAll")}+ </Button>+ </Group>++ <Divider />++ {availableRepositories.map((repository) => (<ImportRepositorySelectkey={repository.id}repository={repository}+ checked={selectedSources.has(repository.sourceToken)}versionFilterPrecisionOptions={innerProps.versionFilterPrecisionOptions}- checked- disabled+ disabled={false}+ onImageSelectionChanged={(isSelected) => {+ const key = repository.sourceToken;+ if (isSelected) {+ setSelectedSourceTokens((previous) => [...previous, key]);+ return;+ }+ setSelectedSourceTokens((previous) => previous.filter((selected) => selected !== key));+ }}+ onVisibilityChanged={() => setSourceHidden(repository.sourceToken, true)}/>))}- </Stack>- )}- </Accordion.Panel>- </Accordion.Item>- </Accordion>+ </Stack>+ )}+ </Accordion.Panel>+ </Accordion.Item>+ <Accordion.Item value="alreadyImported">+ <Accordion.Control disabled={!anyImagesImported} icon={<IconPackageImport />}>+ {tRepository("importRepositories.listAlreadyImportedImages")}+ </Accordion.Control>+ <Accordion.Panel>+ {anyImagesImported && (+ <Stack justify="center" gap="xs">+ {visibleRepositories+ .filter((repository) => repository.alreadyImported)+ .map((repository) => (+ <ImportRepositorySelect+ key={repository.id}+ repository={repository}+ versionFilterPrecisionOptions={innerProps.versionFilterPrecisionOptions}+ checked+ disabled+ onVisibilityChanged={() => setSourceHidden(repository.sourceToken, true)}+ />+ ))}+ </Stack>+ )}+ </Accordion.Panel>+ </Accordion.Item>+ </Accordion>+ )}</Stack>)}+ {hiddenSourceTokens.length > 0 && (+ <Accordion defaultValue="hidden">+ <Accordion.Item value="hidden">+ <Accordion.Control icon={<IconEyeOff />}>+ {tCommon("hidden")} ({hiddenSourceTokens.length})+ </Accordion.Control>+ <Accordion.Panel>+ <Stack gap="xs">+ <Group justify="flex-end">+ <Button size="xs" variant="subtle" onClick={() => setHiddenSourceTokens([])}>+ {actionT("showAll")}+ </Button>+ </Group>+ {hiddenRepositories.map((repository) => (+ <ImportRepositorySelect+ key={repository.sourceToken}+ repository={repository}+ checked={false}+ disabled+ hidden+ versionFilterPrecisionOptions={innerProps.versionFilterPrecisionOptions}+ onVisibilityChanged={() => setSourceHidden(repository.sourceToken, false)}+ />+ ))}+ </Stack>+ </Accordion.Panel>+ </Accordion.Item>+ </Accordion>+ )}+<Group justify="flex-end"><Button variant="default" onClick={actions.closeModal} color="gray.5">{actionT("cancel")}</Button>- <Button onClick={handleConfirm} loading={loading} disabled={selectedImages.length === 0}>+ <Button+ onClick={handleConfirm}+ loading={loading}+ disabled={selectedRepositories.length === 0 && !hasHiddenChanges}+ >{actionT("confirm")}</Button></Group>@@ -924,13 +1025,6 @@ const RepositoryImportModal = createModal<RepositoryImportProps>(({ innerProps,size: "xl",});-const containerImageToProviderKind: Record<string, ReleaseProviderKind> = {- "ghcr.io": "gitHubContainerRegistry",- "docker.io": "dockerHub",- "lscr.io": "linuxServerIO",- "quay.io": "quay",-};-const parseImageVersionToVersionFilter = (imageVersion: string): ReleasesVersionFilter | undefined => {const version = /(?<=\D|^)\d+(?:\.\d+)*(?![\d.])/.exec(imageVersion)?.[0];diff --git a/packages/widgets/src/releases/index.ts b/packages/widgets/src/releases/index.tsindex 4ffe68ac3..788d9c39e 100644--- a/packages/widgets/src/releases/index.ts+++ b/packages/widgets/src/releases/index.ts@@ -49,6 +49,7 @@ export const { definition, componentLoader } = createWidgetDefinition("releases"defaultValue: 0,validate: z.number().min(0),}),+ hiddenDockerSuggestions: factory.internal({ defaultValue: [] as string[] }),repositories: factory.multiReleasesRepositories({defaultValue: [{