feat: add comprehensive demo mode with mock integrations (#5870)

packages/request-handler/src/docker.ts

@@ -7,17 +7,174 @@ import { createLogger } from "@homarr/core/infrastructure/logs";
 import { ErrorWithMetadata } from "@homarr/core/infrastructure/logs/error";
 import { db, like, or } from "@homarr/db";
 import { icons } from "@homarr/db/schema";
-import type { ContainerState } from "@homarr/docker";
+import type { ContainerState, Port } from "@homarr/docker";
 import { dockerLabels, DockerSingleton } from "@homarr/docker";
 
 import { createCachedWidgetRequestHandler } from "./lib/cached-widget-request-handler";
 
 const logger = createLogger({ module: "dockerRequestHandler" });
 
+const isDemoMode = ["1", "yes", "t", "true"].includes((process.env.DEMO_MODE ?? "").toLowerCase());
+
+const port = (privatePort: number, publicPort: number, type: string): Port => ({
+  IP: "0.0.0.0",
+  PrivatePort: privatePort,
+  PublicPort: publicPort,
+  Type: type,
+});
+
+const mockContainers: {
+  id: string;
+  name: string;
+  host: string;
+  state: ContainerState;
+  image: string;
+  iconUrl: string;
+  cpuUsage: number;
+  memoryUsage: number;
+  ports: Port[];
+}[] = [
+  {
+    id: "a1b2c3d4e5f6",
+    name: "sonarr",
+    host: "local",
+    state: "running",
+    image: "lscr.io/linuxserver/sonarr:latest",
+    iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/sonarr.svg",
+    cpuUsage: 2.3,
+    memoryUsage: 256 * 1024 * 1024,
+    ports: [port(8989, 8989, "tcp")],
+  },
+  {
+    id: "b2c3d4e5f6a7",
+    name: "radarr",
+    host: "local",
+    state: "running",
+    image: "lscr.io/linuxserver/radarr:latest",
+    iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/radarr.svg",
+    cpuUsage: 1.8,
+    memoryUsage: 220 * 1024 * 1024,
+    ports: [port(7878, 7878, "tcp")],
+  },
+  {
+    id: "c3d4e5f6a7b8",
+    name: "plex",
+    host: "local",
+    state: "running",
+    image: "lscr.io/linuxserver/plex:latest",
+    iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/plex.svg",
+    cpuUsage: 12.5,
+    memoryUsage: 1024 * 1024 * 1024,
+    ports: [port(32400, 32400, "tcp")],
+  },
+  {
+    id: "d4e5f6a7b8c9",
+    name: "qbittorrent",
+    host: "local",
+    state: "running",
+    image: "lscr.io/linuxserver/qbittorrent:latest",
+    iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/qbittorrent.svg",
+    cpuUsage: 5.1,
+    memoryUsage: 380 * 1024 * 1024,
+    ports: [port(8080, 8080, "tcp")],
+  },
+  {
+    id: "e5f6a7b8c9d0",
+    name: "prowlarr",
+    host: "local",
+    state: "running",
+    image: "lscr.io/linuxserver/prowlarr:latest",
+    iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/prowlarr.svg",
+    cpuUsage: 0.8,
+    memoryUsage: 120 * 1024 * 1024,
+    ports: [port(9696, 9696, "tcp")],
+  },
+  {
+    id: "f6a7b8c9d0e1",
+    name: "overseerr",
+    host: "local",
+    state: "running",
+    image: "lscr.io/linuxserver/overseerr:latest",
+    iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/overseerr.svg",
+    cpuUsage: 1.2,
+    memoryUsage: 180 * 1024 * 1024,
+    ports: [port(5055, 5055, "tcp")],
+  },
+  {
+    id: "a7b8c9d0e1f2",
+    name: "homarr",
+    host: "local",
+    state: "running",
+    image: "ghcr.io/homarr-labs/homarr:latest",
+    iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/homarr.svg",
+    cpuUsage: 3.4,
+    memoryUsage: 290 * 1024 * 1024,
+    ports: [port(7575, 7575, "tcp")],
+  },
+  {
+    id: "b8c9d0e1f2a3",
+    name: "pihole",
+    host: "local",
+    state: "running",
+    image: "pihole/pihole:latest",
+    iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/pi-hole.svg",
+    cpuUsage: 0.5,
+    memoryUsage: 95 * 1024 * 1024,
+    ports: [port(80, 80, "tcp"), port(53, 53, "udp")],
+  },
+  {
+    id: "c9d0e1f2a3b4",
+    name: "nginx-proxy",
+    host: "local",
+    state: "running",
+    image: "jc21/nginx-proxy-manager:latest",
+    iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/nginx-proxy-manager.svg",
+    cpuUsage: 0.3,
+    memoryUsage: 65 * 1024 * 1024,
+    ports: [port(443, 443, "tcp"), port(81, 81, "tcp")],
+  },
+  {
+    id: "d0e1f2a3b4c5",
+    name: "watchtower",
+    host: "local",
+    state: "running",
+    image: "containrrr/watchtower:latest",
+    iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/watchtower.svg",
+    cpuUsage: 0.1,
+    memoryUsage: 30 * 1024 * 1024,
+    ports: [],
+  },
+  {
+    id: "e1f2a3b4c5d6",
+    name: "tdarr",
+    host: "local",
+    state: "exited",
+    image: "ghcr.io/haveagitgat/tdarr:latest",
+    iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/tdarr.svg",
+    cpuUsage: 0,
+    memoryUsage: 0,
+    ports: [],
+  },
+  {
+    id: "f2a3b4c5d6e7",
+    name: "bazarr",
+    host: "local",
+    state: "running",
+    image: "lscr.io/linuxserver/bazarr:latest",
+    iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/bazarr.svg",
+    cpuUsage: 0.6,
+    memoryUsage: 110 * 1024 * 1024,
+    ports: [port(6767, 6767, "tcp")],
+  },
+];
+
 export const dockerContainersRequestHandler = createCachedWidgetRequestHandler({
   queryKey: "dockerContainersResult",
   widgetKind: "dockerContainers",
   async requestAsync() {
+    if (isDemoMode) {
+      return mockContainers;
+    }
     return await getContainersWithStatsAsync();
   },
   cacheDuration: dayjs.duration(20, "seconds"),