feat: import to docker form board, docker button on boards (#1714)

2023-12-30 20:11:38 +01:00
parent e13a4afdde
commit 082077ec9d
16 changed files with 234 additions and 138 deletions
--- a/src/components/Dashboard/Modals/SelectElement/Components/Overview/AvailableElementsOverview.tsx
+++ b/src/components/Dashboard/Modals/SelectElement/Components/Overview/AvailableElementsOverview.tsx
@@ -3,6 +3,7 @@ import { closeModal } from '@mantine/modals';
 import { showNotification } from '@mantine/notifications';
 import { IconBox, IconBoxAlignTop, IconStack } from '@tabler/icons-react';
 import { motion } from 'framer-motion';
+import { useSession } from 'next-auth/react';
 import { useTranslation } from 'next-i18next';
 import { ReactNode } from 'react';
 import { v4 as uuidv4 } from 'uuid';
@@ -18,17 +19,17 @@ import { useStyles } from '../Shared/styles';
 interface AvailableElementTypesProps {
  modalId: string;
  onOpenIntegrations: () => void;
-  onOpenStaticElements: () => void;
 }

 export const AvailableElementTypes = ({
  modalId,
  onOpenIntegrations: onOpenWidgets,
-  onOpenStaticElements,
 }: AvailableElementTypesProps) => {
  const { t } = useTranslation('layout/element-selector/selector');
  const { config, name: configName } = useConfigContext();
  const { updateConfig } = useConfigStore();
+  const { data } = useSession();
+
  const getLowestWrapper = () => config?.wrappers.sort((a, b) => a.position - b.position)[0];

  const onClickCreateCategory = async () => {
--- a/src/components/Dashboard/Modals/SelectElement/Components/StaticElementsTab/AvailableStaticElementsTab.tsx
+++ b/src/components/Dashboard/Modals/SelectElement/Components/StaticElementsTab/AvailableStaticElementsTab.tsx
@@ -1,34 +0,0 @@
-import { Container, Grid, Text } from '@mantine/core';
-import { IconCursorText } from '@tabler/icons-react';
-import { useTranslation } from 'next-i18next';
-
-import { GenericAvailableElementType } from '../Shared/GenericElementType';
-import { SelectorBackArrow } from '../Shared/SelectorBackArrow';
-
-interface AvailableStaticTypesProps {
-  onClickBack: () => void;
-}
-
-export const AvailableStaticTypes = ({ onClickBack }: AvailableStaticTypesProps) => {
-  const { t } = useTranslation('layout/element-selector/selector');
-  return (
-    <>
-      <SelectorBackArrow onClickBack={onClickBack} />
-
-      <Text mb="md" color="dimmed">
-        Static elements provide you additional control over your dashboard. They are static, because
-        they don&apos;t integrate with any apps and their content never changes.
-      </Text>
-
-      <Grid grow>
-        {/*
-        <GenericAvailableElementType
-          name="Static Text"
-          description="Display a fixed string on your dashboard"
-          image={IconCursorText}
-          handleAddition={async () => {}}
-        /> */}
-      </Grid>
-    </>
-  );
-};
--- a/src/components/Dashboard/Modals/SelectElement/Components/WidgetsTab/AvailableWidgetsTab.tsx
+++ b/src/components/Dashboard/Modals/SelectElement/Components/WidgetsTab/AvailableWidgetsTab.tsx
@@ -1,4 +1,4 @@
-import { Grid, Text } from '@mantine/core';
+import { Grid, Stack, Text } from '@mantine/core';
 import { useTranslation } from 'next-i18next';

 import widgets from '../../../../../../widgets';
@@ -14,7 +14,7 @@ export const AvailableIntegrationElements = ({
 }: AvailableIntegrationElementsProps) => {
  const { t } = useTranslation('layout/element-selector/selector');
  return (
-    <>
+    <Stack m="sm">
      <SelectorBackArrow onClickBack={onClickBack} />

      <Text mb="md" color="dimmed">
@@ -26,6 +26,6 @@ export const AvailableIntegrationElements = ({
          <WidgetElementType key={k} id={k} image={v.icon} widget={v} />
        ))}
      </Grid>
-    </>
+    </Stack>
  );
 };
--- a/src/components/Dashboard/Modals/SelectElement/SelectElementModal.tsx
+++ b/src/components/Dashboard/Modals/SelectElement/SelectElementModal.tsx
@@ -2,11 +2,10 @@ import { ContextModalProps } from '@mantine/modals';
 import { useState } from 'react';

 import { AvailableElementTypes } from './Components/Overview/AvailableElementsOverview';
-import { AvailableStaticTypes } from './Components/StaticElementsTab/AvailableStaticElementsTab';
 import { AvailableIntegrationElements } from './Components/WidgetsTab/AvailableWidgetsTab';

 export const SelectElementModal = ({ context, id }: ContextModalProps) => {
-  const [activeTab, setActiveTab] = useState<undefined | 'integrations' | 'static_elements'>();
+  const [activeTab, setActiveTab] = useState<undefined | 'integrations' | 'dockerImport'>();

  switch (activeTab) {
    case undefined:
@@ -14,13 +13,10 @@ export const SelectElementModal = ({ context, id }: ContextModalProps) => {
        <AvailableElementTypes
          modalId={id}
          onOpenIntegrations={() => setActiveTab('integrations')}
-          onOpenStaticElements={() => setActiveTab('static_elements')}
        />
      );
    case 'integrations':
      return <AvailableIntegrationElements onClickBack={() => setActiveTab(undefined)} />;
-    case 'static_elements':
-      return <AvailableStaticTypes onClickBack={() => setActiveTab(undefined)} />;
    default:
      /* default to the main selection tab */
      setActiveTab(undefined);
--- a/src/components/Manage/Tools/Docker/ContainerActionBar.tsx
+++ b/src/components/Manage/Tools/Docker/ContainerActionBar.tsx
@@ -16,7 +16,7 @@ import { RouterInputs, api } from '~/utils/api';
 import { openDockerSelectBoardModal } from './docker-select-board.modal';

 export interface ContainerActionBarProps {
-  selected: Dockerode.ContainerInfo[];
+  selected: (Dockerode.ContainerInfo & { icon?: string })[];
  reload: () => void;
  isLoading: boolean;
 }
@@ -94,7 +94,7 @@ export default function ContainerActionBar({
        color="indigo"
        variant="light"
        radius="md"
-        disabled={selected.length !== 1}
+        disabled={selected.length < 1}
        onClick={() => openDockerSelectBoardModal({ containers: selected })}
      >
        {t('actionBar.addToHomarr.title')}
@@ -127,13 +127,7 @@ const useDockerActionMutation = () => {
      { action, id: container.Id },
      {
        onSuccess: () => {
-          notifications.update({
-            id: container.Id,
-            title: containerName,
-            message: `${t(`actions.${action}.end`)} ${containerName}`,
-            icon: <IconCheck />,
-            autoClose: 2000,
-          });
+          notifications.cleanQueue();
        },
        onError: (err) => {
          notifications.update({
--- a/src/components/Manage/Tools/Docker/ContainerTable.tsx
+++ b/src/components/Manage/Tools/Docker/ContainerTable.tsx
@@ -2,6 +2,7 @@ import {
  Badge,
  Checkbox,
  Group,
+  Image,
  ScrollArea,
  Table,
  Text,
@@ -96,6 +97,7 @@ export default function ContainerTable({
              <Row
                key={container.Id}
                container={container}
+                icon={(container as any).icon ?? undefined}
                selected={selected}
                toggleRow={toggleRow}
                width={width}
@@ -113,10 +115,12 @@ type RowProps = {
  selected: boolean;
  toggleRow: (container: ContainerInfo) => void;
  width: number;
+  icon?: string;
 };
-const Row = ({ container, selected, toggleRow, width }: RowProps) => {
+const Row = ({ icon, container, selected, toggleRow, width }: RowProps) => {
  const { t } = useTranslation('modules/docker');
  const { classes, cx } = useStyles();
+  const containerName = container.Names[0].replace('/', '');

  return (
    <tr className={cx({ [classes.rowSelected]: selected })}>
@@ -124,13 +128,16 @@ const Row = ({ container, selected, toggleRow, width }: RowProps) => {
        <Checkbox checked={selected} onChange={() => toggleRow(container)} transitionDuration={0} />
      </td>
      <td>
-        <Text size="lg" weight={600}>
-          {container.Names[0].replace('/', '')}
-        </Text>
+        <Group noWrap>
+          <Image withPlaceholder src={icon} width={30} height={30} />
+          <Text size="lg" weight={600}>
+            {containerName}
+          </Text>
+        </Group>
      </td>
      {width > MIN_WIDTH_MOBILE && (
        <td>
-          <Text size="lg">{container.Image}</Text>
+          <Text size="lg">{container.Image.slice(0, 25)}</Text>
        </td>
      )}
      {width > MIN_WIDTH_MOBILE && (
--- a/src/components/Manage/Tools/Docker/docker-select-board.modal.tsx
+++ b/src/components/Manage/Tools/Docker/docker-select-board.modal.tsx
@@ -1,4 +1,4 @@
-import { Button, Group, Select, Stack, Text, TextInput, Title } from '@mantine/core';
+import { Button, Group, Select, Stack, Text, Title } from '@mantine/core';
 import { useForm } from '@mantine/form';
 import { ContextModalProps, modals } from '@mantine/modals';
 import { showNotification } from '@mantine/notifications';
@@ -6,6 +6,9 @@ import { IconCheck, IconX } from '@tabler/icons-react';
 import { ContainerInfo } from 'dockerode';
 import { Trans, useTranslation } from 'next-i18next';
 import { z } from 'zod';
+import { useConfigContext } from '~/config/provider';
+import { useConfigStore } from '~/config/store';
+import { generateDefaultApp } from '~/tools/shared/app';
 import { api } from '~/utils/api';
 import { useI18nZodResolver } from '~/utils/i18n-zod-resolver';

@@ -14,7 +17,7 @@ const dockerSelectBoardSchema = z.object({
 });

 type InnerProps = {
-  containers: ContainerInfo[];
+  containers: (ContainerInfo & { icon?: string })[];
 };
 type FormType = z.infer<typeof dockerSelectBoardSchema>;

@@ -22,13 +25,18 @@ export const DockerSelectBoardModal = ({ id, innerProps }: ContextModalProps<Inn
  const { t } = useTranslation('tools/docker');
  const { mutateAsync, isLoading } = api.boards.addAppsForContainers.useMutation();
  const { i18nZodResolver } = useI18nZodResolver();
+  const { name: configName } = useConfigContext();
+
+  const updateConfig = useConfigStore((store) => store.updateConfig);
  const handleSubmit = async (values: FormType) => {
+    const newApps = innerProps.containers.map((container) => ({
+      name: (container.Names.at(0) ?? 'App').replace('/', ''),
+      port: container.Ports.at(0)?.PublicPort,
+      icon: container.icon,
+    }));
    await mutateAsync(
      {
-        apps: innerProps.containers.map((container) => ({
-          name: (container.Names.at(0) ?? 'App').replace('/', ''),
-          port: container.Ports.at(0)?.PublicPort,
-        })),
+        apps: newApps,
        boardName: values.board,
      },
      {
@@ -39,7 +47,21 @@ export const DockerSelectBoardModal = ({ id, innerProps }: ContextModalProps<Inn
            icon: <IconCheck />,
            color: 'green',
          });
-
+          updateConfig(configName!, (config) => {
+            const lowestWrapper = config?.wrappers.sort((a, b) => a.position - b.position)[0];
+            const defaultApp = generateDefaultApp(lowestWrapper.id);
+            return {
+              ...config,
+              apps: [
+                ...config.apps,
+                ...newApps.map((app) => ({
+                  ...defaultApp,
+                  ...app,
+                  wrapperId: lowestWrapper.id,
+                })),
+              ],
+            };
+          });
          modals.close(id);
        },
        onError: () => {
@@ -117,5 +139,5 @@ export const openDockerSelectBoardModal = (innerProps: InnerProps) => {
    ),
    innerProps,
  });
-  umami.track('Add to homarr modal')
+  umami.track('Add to homarr modal');
 };
--- a/src/components/layout/Templates/BoardLayout.tsx
+++ b/src/components/layout/Templates/BoardLayout.tsx
@@ -1,16 +1,26 @@
-import { Button, Global, Text, Title, Tooltip, clsx } from '@mantine/core';
-import { useHotkeys, useWindowEvent } from '@mantine/hooks';
+import { Button, Global, Modal, Stack, Text, Title, Tooltip, clsx } from '@mantine/core';
+import { useDisclosure, useHotkeys, useWindowEvent } from '@mantine/hooks';
 import { openContextModal } from '@mantine/modals';
 import { hideNotification, showNotification } from '@mantine/notifications';
-import { IconApps, IconEditCircle, IconEditCircleOff, IconSettings } from '@tabler/icons-react';
+import {
+  IconApps,
+  IconBrandDocker,
+  IconEditCircle,
+  IconEditCircleOff,
+  IconSettings,
+} from '@tabler/icons-react';
 import Consola from 'consola';
+import { ContainerInfo } from 'dockerode';
 import { useSession } from 'next-auth/react';
 import { Trans, useTranslation } from 'next-i18next';
 import Link from 'next/link';
 import { useRouter } from 'next/router';
 import { env } from 'process';
+import { useState } from 'react';
 import { useEditModeStore } from '~/components/Dashboard/Views/useEditModeStore';
 import { useNamedWrapperColumnCount } from '~/components/Dashboard/Wrappers/gridstack/store';
+import ContainerActionBar from '~/components/Manage/Tools/Docker/ContainerActionBar';
+import ContainerTable from '~/components/Manage/Tools/Docker/ContainerTable';
 import { BoardHeadOverride } from '~/components/layout/Meta/BoardHeadOverride';
 import { HeaderActionButton } from '~/components/layout/header/ActionButton';
 import { useConfigContext } from '~/config/provider';
@@ -20,14 +30,15 @@ import { MainLayout } from './MainLayout';

 type BoardLayoutProps = {
  children: React.ReactNode;
+  isDockerEnabled?: boolean;
 };

-export const BoardLayout = ({ children }: BoardLayoutProps) => {
+export const BoardLayout = ({ children, isDockerEnabled = false }: BoardLayoutProps) => {
  const { config } = useConfigContext();
  const { data: session } = useSession();

  return (
-    <MainLayout autoFocusSearch={session?.user.autoFocusSearch} headerActions={<HeaderActions />}>
+    <MainLayout autoFocusSearch={session?.user.autoFocusSearch} headerActions={<HeaderActions isDockerEnabled={isDockerEnabled} />}>
      <BoardHeadOverride />
      <BackgroundImage />
      {children}
@@ -36,7 +47,7 @@ export const BoardLayout = ({ children }: BoardLayoutProps) => {
  );
 };

-export const HeaderActions = () => {
+export const HeaderActions = ({isDockerEnabled = false} : { isDockerEnabled: boolean}) => {
  const { data: sessionData } = useSession();

  if (!sessionData?.user?.isAdmin) return null;
@@ -44,11 +55,55 @@ export const HeaderActions = () => {
  return (
    <>
      <ToggleEditModeButton />
+      {isDockerEnabled && <DockerButton />}
      <CustomizeBoardButton />
    </>
  );
 };

+const DockerButton = () => {
+  const [selection, setSelection] = useState<(ContainerInfo & { icon?: string })[]>([]);
+  const [opened, { open, close, toggle }] = useDisclosure(false);
+  useHotkeys([['mod+B', toggle]]);
+
+  const { data, refetch, isRefetching } = api.docker.containers.useQuery(undefined, {
+    cacheTime: 60 * 1000 * 5,
+    staleTime: 60 * 1000 * 1,
+  });
+  const { t } = useTranslation('tools/docker');
+  const reload = () => {
+    refetch();
+    setSelection([]);
+  };
+
+  return (
+    <>
+      <Tooltip label={t('title')}>
+        <HeaderActionButton onClick={open}>
+          <IconBrandDocker size={20} stroke={1.5} />
+        </HeaderActionButton>
+      </Tooltip>
+      <Modal
+        title={t('title')}
+        withCloseButton={true}
+        closeOnClickOutside={true}
+        size="full"
+        opened={opened}
+        onClose={close}
+      >
+        <Stack>
+          <ContainerActionBar selected={selection} reload={reload} isLoading={isRefetching} />
+          <ContainerTable
+            containers={data ?? []}
+            selection={selection}
+            setSelection={setSelection}
+          />
+        </Stack>
+      </Modal>
+    </>
+  );
+};
+
 const CustomizeBoardButton = () => {
  const { name } = useConfigContext();
  const { t } = useTranslation('boards/common');