Merge branch 'dev' into fix/remove-board-loading-overlay

markAsReady is still called by gridstack sections but now acts as a
no-op since the loading overlay that consumed isReady was removed.

apps/nextjs/src/app/[locale]/boards/(content)/_client.tsx

@@ -1,70 +1,27 @@
 "use client";
 
-import { useCallback, useRef } from "react";
-import { Box, LoadingOverlay, Stack } from "@mantine/core";
+import { Box, Stack } from "@mantine/core";
 
-import type { RouterOutputs } from "@homarr/api";
-import { clientApi } from "@homarr/api/client";
 import { useCurrentLayout, useRequiredBoard } from "@homarr/boards/context";
 
 import { BoardCategorySection } from "~/components/board/sections/category-section";
 import { BoardEmptySection } from "~/components/board/sections/empty-section";
 import { BoardBackgroundVideo } from "~/components/layout/background";
-import { fullHeightWithoutHeaderAndFooter } from "~/constants";
-import { useIsBoardReady } from "./_ready-context";
-
-let boardName: string | null = null;
-
-export const updateBoardName = (name: string | null) => {
-  boardName = name;
-};
-
-type UpdateCallback = (prev: RouterOutputs["board"]["getHomeBoard"]) => RouterOutputs["board"]["getHomeBoard"];
-
-export const useUpdateBoard = () => {
-  const utils = clientApi.useUtils();
-
-  const updateBoard = useCallback(
-    (updaterWithoutUndefined: UpdateCallback) => {
-      if (!boardName) {
-        throw new Error("Board name is not set");
-      }
-      utils.board.getBoardByName.setData({ name: boardName }, (previous) =>
-        previous ? updaterWithoutUndefined(previous) : previous,
-      );
-    },
-    [utils],
-  );
-
-  return {
-    updateBoard,
-  };
-};
 
 export const ClientBoard = () => {
   const board = useRequiredBoard();
   const currentLayoutId = useCurrentLayout();
-  const isReady = useIsBoardReady();
 
   const fullWidthSortedSections = board.sections
     .filter((section) => section.kind === "empty" || section.kind === "category")
     .sort((sectionA, sectionB) => sectionA.yOffset - sectionB.yOffset);
 
-  const ref = useRef<HTMLDivElement>(null);
-
   return (
     <Box h="100%" pos="relative">
       <BoardBackgroundVideo />
-      <LoadingOverlay
-        visible={!isReady}
-        transitionProps={{ duration: 500 }}
-        loaderProps={{ size: "lg" }}
-        h={fullHeightWithoutHeaderAndFooter}
-      />
-      <Stack ref={ref} h="100%" style={{ visibility: isReady ? "visible" : "hidden" }}>
+      <Stack h="100%">
         {fullWidthSortedSections.map((section) =>
           section.kind === "empty" ? (
-            // Unique keys per layout to always reinitialize the gridstack
             <BoardEmptySection key={`${currentLayoutId}-${section.id}`} section={section} />
           ) : (
             <BoardCategorySection key={`${currentLayoutId}-${section.id}`} section={section} />

apps/nextjs/src/app/[locale]/boards/(content)/_ready-context.tsx

@@ -1,42 +1,19 @@
 "use client";
 
 import type { PropsWithChildren } from "react";
-import { createContext, useCallback, useContext, useEffect, useState } from "react";
-import { usePathname } from "next/navigation";
-
-import { clientApi } from "@homarr/api/client";
-import { useRequiredBoard } from "@homarr/boards/context";
+import { createContext, useCallback, useContext } from "react";
 
 const BoardReadyContext = createContext<{
-  isReady: boolean;
   markAsReady: (id: string) => void;
 } | null>(null);
 
 export const BoardReadyProvider = ({ children }: PropsWithChildren) => {
-  const pathname = usePathname();
-  const utils = clientApi.useUtils();
-  const board = useRequiredBoard();
-  const [readySections, setReadySections] = useState<string[]>([]);
-
-  // Reset sections required for ready state
-  useEffect(() => {
-    return () => {
-      setReadySections([]);
-    };
-  }, [pathname, utils]);
-
-  useEffect(() => {
-    setReadySections((previous) => previous.filter((id) => board.sections.some((section) => section.id === id)));
-  }, [board.sections.length, setReadySections]);
-
-  const markAsReady = useCallback((id: string) => {
-    setReadySections((previous) => (previous.includes(id) ? previous : [...previous, id]));
-  }, []);
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  const markAsReady = useCallback((_id: string) => {}, []);
 
   return (
     <BoardReadyContext.Provider
       value={{
-        isReady: board.sections.length === readySections.length,
         markAsReady,
       }}
     >
@@ -54,13 +31,3 @@ export const useMarkSectionAsReady = () => {
 
   return context.markAsReady;
 };
-
-export const useIsBoardReady = () => {
-  const context = useContext(BoardReadyContext);
-
-  if (!context) {
-    throw new Error("BoardReadyProvider is required");
-  }
-
-  return context.isReady;
-};

apps/tasks/src/main.spec.ts

@@ -1,108 +0,0 @@
-import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
-
-import { handshakeAsync } from "@homarr/redis";
-
-import { waitForRedisAsync } from "./main";
-
-const { mockLogger } = vi.hoisted(() => ({
-  mockLogger: {
-    info: vi.fn(),
-    warn: vi.fn(),
-    error: vi.fn(),
-    debug: vi.fn(),
-  },
-}));
-
-vi.mock("./overrides", () => ({}));
-
-vi.mock("@homarr/core/infrastructure/logs", () => ({
-  createLogger: () => mockLogger,
-}));
-
-vi.mock("@homarr/redis", () => ({
-  handshakeAsync: vi.fn(),
-}));
-
-vi.mock("@homarr/cron-jobs", () => ({
-  jobGroup: {
-    initializeAsync: vi.fn().mockResolvedValue(undefined),
-    startAllAsync: vi.fn().mockResolvedValue(undefined),
-  },
-}));
-
-vi.mock("./on-start", () => ({
-  onStartAsync: vi.fn().mockResolvedValue(undefined),
-}));
-
-describe("waitForRedisAsync", () => {
-  beforeEach(() => {
-    vi.clearAllMocks();
-    vi.useFakeTimers();
-  });
-
-  afterEach(() => {
-    vi.useRealTimers();
-  });
-
-  test("succeeds on first attempt", async () => {
-    vi.mocked(handshakeAsync).mockResolvedValueOnce(undefined);
-
-    await waitForRedisAsync();
-
-    expect(handshakeAsync).toHaveBeenCalledOnce();
-    expect(mockLogger.info).toHaveBeenCalledWith("Redis connection established");
-  });
-
-  test("retries on failure then succeeds", async () => {
-    vi.mocked(handshakeAsync)
-      .mockRejectedValueOnce(new Error("ECONNREFUSED"))
-      .mockRejectedValueOnce(new Error("ECONNREFUSED"))
-      .mockResolvedValueOnce(undefined);
-
-    const promise = waitForRedisAsync();
-
-    await vi.advanceTimersByTimeAsync(500);
-    await vi.advanceTimersByTimeAsync(500);
-    await promise;
-
-    expect(handshakeAsync).toHaveBeenCalledTimes(3);
-    expect(mockLogger.warn).toHaveBeenCalledTimes(2);
-    expect(mockLogger.info).toHaveBeenCalledWith("Redis connection established");
-  });
-
-  test("logs error and proceeds after max retries exhausted", async () => {
-    vi.mocked(handshakeAsync).mockRejectedValue(new Error("ECONNREFUSED"));
-
-    const promise = waitForRedisAsync();
-
-    for (let index = 0; index < 10; index++) {
-      await vi.advanceTimersByTimeAsync(500);
-    }
-    await promise;
-
-    expect(handshakeAsync).toHaveBeenCalledTimes(10);
-    expect(mockLogger.error).toHaveBeenCalledWith("Redis did not become ready after retries, proceeding anyway");
-    expect(mockLogger.info).not.toHaveBeenCalled();
-  });
-
-  test("warns with attempt count on each retry", async () => {
-    vi.mocked(handshakeAsync).mockRejectedValueOnce(new Error("fail")).mockResolvedValueOnce(undefined);
-
-    const promise = waitForRedisAsync();
-
-    await vi.advanceTimersByTimeAsync(500);
-    await promise;
-
-    expect(mockLogger.warn).toHaveBeenCalledWith("Redis not ready, retrying (1/10)...");
-  });
-
-  test("does not retry after success", async () => {
-    vi.mocked(handshakeAsync).mockResolvedValueOnce(undefined);
-
-    await waitForRedisAsync();
-
-    expect(handshakeAsync).toHaveBeenCalledOnce();
-    expect(mockLogger.warn).not.toHaveBeenCalled();
-    expect(mockLogger.error).not.toHaveBeenCalled();
-  });
-});

apps/tasks/src/main.ts

@@ -1,33 +1,11 @@
 // This import has to be the first import in the file so that the agent is overridden before any other modules are imported.
 import "./overrides";
 
-import { createLogger } from "@homarr/core/infrastructure/logs";
 import { jobGroup } from "@homarr/cron-jobs";
-import { handshakeAsync } from "@homarr/redis";
 
 import { onStartAsync } from "./on-start";
 
-const logger = createLogger({ module: "tasks" });
-
-const MAX_RETRIES = 10;
-const RETRY_DELAY_MS = 500;
-
-export const waitForRedisAsync = async () => {
-  for (let attempt = 1; attempt <= MAX_RETRIES; attempt++) {
-    try {
-      await handshakeAsync();
-      logger.info("Redis connection established");
-      return;
-    } catch {
-      logger.warn(`Redis not ready, retrying (${attempt}/${MAX_RETRIES})...`);
-      await new Promise((resolve) => setTimeout(resolve, RETRY_DELAY_MS));
-    }
-  }
-  logger.error("Redis did not become ready after retries, proceeding anyway");
-};
-
 void (async () => {
-  await waitForRedisAsync();
   await onStartAsync();
   await jobGroup.initializeAsync();
   await jobGroup.startAllAsync();

packages/core/src/infrastructure/redis/client.ts

@@ -5,7 +5,6 @@ import { redisEnv } from "./env";
 
 const defaultRedisOptions = {
   connectionName: "homarr",
-  lazyConnect: true,
 } satisfies RedisOptions;
 
 export type { Redis as RedisClient } from "ioredis";

packages/redis/src/lib/channel-subscription-tracker.spec.ts

@@ -1,102 +0,0 @@
-import { beforeEach, describe, expect, test, vi } from "vitest";
-
-import { ChannelSubscriptionTracker } from "./channel-subscription-tracker";
-import { createRedisConnection } from "./connection";
-
-const mockRedisClient = {
-  subscribe: vi.fn().mockResolvedValue("OK"),
-  unsubscribe: vi.fn().mockResolvedValue("OK"),
-  on: vi.fn(),
-};
-
-vi.mock("@homarr/core/infrastructure/logs", () => ({
-  createLogger: () => ({ debug: vi.fn(), warn: vi.fn() }),
-}));
-
-vi.mock("./connection", () => ({
-  createRedisConnection: vi.fn(() => mockRedisClient),
-}));
-
-describe("ChannelSubscriptionTracker", () => {
-  beforeEach(() => {
-    vi.clearAllMocks();
-    // Reset static state between tests
-    // @ts-expect-error accessing private static for test reset
-    ChannelSubscriptionTracker.subscriptions = new Map();
-    // @ts-expect-error accessing private static for test reset
-    ChannelSubscriptionTracker._redis = undefined;
-    // @ts-expect-error accessing private static for test reset
-    ChannelSubscriptionTracker.listenerActive = false;
-  });
-
-  test("redis client is lazily created on first subscribe", () => {
-    vi.mocked(createRedisConnection).mockClear();
-
-    ChannelSubscriptionTracker.subscribe("channel-1", vi.fn());
-
-    expect(createRedisConnection).toHaveBeenCalledOnce();
-  });
-
-  test("redis client is reused across multiple subscribes", () => {
-    vi.mocked(createRedisConnection).mockClear();
-
-    ChannelSubscriptionTracker.subscribe("channel-1", vi.fn());
-    ChannelSubscriptionTracker.subscribe("channel-2", vi.fn());
-
-    expect(createRedisConnection).toHaveBeenCalledOnce();
-  });
-
-  test("subscribes to redis channel on first callback for a channel", () => {
-    ChannelSubscriptionTracker.subscribe("test-channel", vi.fn());
-
-    expect(mockRedisClient.subscribe).toHaveBeenCalledWith("test-channel");
-  });
-
-  test("does not re-subscribe when adding second callback to same channel", () => {
-    ChannelSubscriptionTracker.subscribe("test-channel", vi.fn());
-    mockRedisClient.subscribe.mockClear();
-
-    ChannelSubscriptionTracker.subscribe("test-channel", vi.fn());
-
-    expect(mockRedisClient.subscribe).not.toHaveBeenCalled();
-  });
-
-  test("unsubscribe function removes the callback", () => {
-    const unsubscribe = ChannelSubscriptionTracker.subscribe("test-channel", vi.fn());
-
-    unsubscribe();
-
-    expect(mockRedisClient.unsubscribe).toHaveBeenCalledWith("test-channel");
-  });
-
-  test("does not unsubscribe from redis if other callbacks remain", () => {
-    ChannelSubscriptionTracker.subscribe("test-channel", vi.fn());
-    const unsubscribe = ChannelSubscriptionTracker.subscribe("test-channel", vi.fn());
-
-    unsubscribe();
-
-    expect(mockRedisClient.unsubscribe).not.toHaveBeenCalled();
-  });
-
-  test("activates message listener only once", () => {
-    ChannelSubscriptionTracker.subscribe("ch-1", vi.fn());
-    ChannelSubscriptionTracker.subscribe("ch-2", vi.fn());
-
-    expect(mockRedisClient.on).toHaveBeenCalledTimes(1);
-    expect(mockRedisClient.on).toHaveBeenCalledWith("message", expect.any(Function));
-  });
-
-  test("message listener dispatches to correct channel callbacks", () => {
-    const callback1 = vi.fn();
-    const callback2 = vi.fn();
-    ChannelSubscriptionTracker.subscribe("channel-a", callback1);
-    ChannelSubscriptionTracker.subscribe("channel-b", callback2);
-
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    const messageHandler = mockRedisClient.on.mock.calls[0]![1] as (channel: string, message: string) => void;
-    messageHandler("channel-a", "test-message");
-
-    expect(callback1).toHaveBeenCalledWith("test-message");
-    expect(callback2).not.toHaveBeenCalled();
-  });
-});

packages/redis/src/lib/channel-subscription-tracker.ts

@@ -2,7 +2,6 @@ import { randomUUID } from "crypto";
 
 import type { MaybePromise } from "@homarr/common/types";
 import { createLogger } from "@homarr/core/infrastructure/logs";
-import type { RedisClient } from "@homarr/core/infrastructure/redis";
 
 import { createRedisConnection } from "./connection";
 
@@ -19,10 +18,7 @@ type SubscriptionCallback = (message: string) => MaybePromise<void>;
  */
 export class ChannelSubscriptionTracker {
   private static subscriptions = new Map<string, Map<string, SubscriptionCallback>>();
-  private static _redis: RedisClient | undefined;
-  private static get redis() {
-    return (this._redis ??= createRedisConnection());
-  }
+  private static redis = createRedisConnection();
   private static listenerActive = false;
 
   /**

packages/redis/src/lib/channel.spec.ts

@@ -1,147 +0,0 @@
-import { beforeEach, describe, expect, test, vi } from "vitest";
-
-import {
-  createCacheChannel,
-  createGetSetChannel,
-  createListChannel,
-  createSubPubChannel,
-  handshakeAsync,
-} from "./channel";
-import { createRedisConnection } from "./connection";
-
-const mockRedisClient = {
-  get: vi.fn().mockResolvedValue(null),
-  set: vi.fn().mockResolvedValue("OK"),
-  del: vi.fn().mockResolvedValue(1),
-  publish: vi.fn().mockResolvedValue(1),
-  lrange: vi.fn().mockResolvedValue([]),
-  lrem: vi.fn().mockResolvedValue(0),
-  lpush: vi.fn().mockResolvedValue(1),
-  ltrim: vi.fn().mockResolvedValue("OK"),
-  llen: vi.fn().mockResolvedValue(0),
-  hello: vi.fn().mockResolvedValue({}),
-  subscribe: vi.fn().mockResolvedValue("OK"),
-  on: vi.fn(),
-};
-
-vi.mock("@homarr/core/infrastructure/logs", () => ({
-  createLogger: () => ({ debug: vi.fn(), warn: vi.fn(), error: vi.fn(), info: vi.fn() }),
-}));
-
-vi.mock("./connection", () => ({
-  createRedisConnection: vi.fn(() => mockRedisClient),
-}));
-
-vi.mock("./channel-subscription-tracker", () => ({
-  ChannelSubscriptionTracker: {
-    subscribe: vi.fn(() => vi.fn()),
-  },
-}));
-
-describe("channel lazy initialization", () => {
-  beforeEach(() => {
-    vi.mocked(createRedisConnection).mockClear();
-  });
-
-  test("getSetClient is lazily created on first channel operation", async () => {
-    vi.mocked(createRedisConnection).mockClear();
-
-    const channel = createGetSetChannel<string>("test-lazy");
-    expect(createRedisConnection).not.toHaveBeenCalled();
-
-    await channel.getAsync();
-
-    expect(createRedisConnection).toHaveBeenCalled();
-  });
-
-  test("publisher is lazily created on first publish", async () => {
-    const channel = createSubPubChannel<string>("test-pub", { persist: false });
-
-    const callsBefore = vi.mocked(createRedisConnection).mock.calls.length;
-    await channel.publishAsync("hello");
-
-    expect(vi.mocked(createRedisConnection).mock.calls.length).toBeGreaterThan(callsBefore);
-  });
-
-  test("handshakeAsync creates a client and calls hello", async () => {
-    await handshakeAsync();
-
-    expect(mockRedisClient.hello).toHaveBeenCalledOnce();
-  });
-});
-
-describe("createSubPubChannel", () => {
-  beforeEach(() => {
-    vi.clearAllMocks();
-  });
-
-  test("publishAsync persists data and publishes", async () => {
-    const channel = createSubPubChannel<{ value: number }>("test-channel");
-
-    await channel.publishAsync({ value: 42 });
-
-    expect(mockRedisClient.set).toHaveBeenCalledOnce();
-    expect(mockRedisClient.publish).toHaveBeenCalledOnce();
-  });
-
-  test("publishAsync with persist:false skips set", async () => {
-    const channel = createSubPubChannel<string>("no-persist", { persist: false });
-
-    await channel.publishAsync("data");
-
-    expect(mockRedisClient.set).not.toHaveBeenCalled();
-    expect(mockRedisClient.publish).toHaveBeenCalledOnce();
-  });
-
-  test("getLastDataAsync returns null when no data", async () => {
-    const channel = createSubPubChannel<string>("empty");
-
-    const result = await channel.getLastDataAsync();
-
-    expect(result).toBeNull();
-  });
-});
-
-describe("createListChannel", () => {
-  beforeEach(() => {
-    vi.clearAllMocks();
-  });
-
-  test("addAsync pushes to list", async () => {
-    const channel = createListChannel<string>("test-list");
-
-    await channel.addAsync("item1");
-
-    expect(mockRedisClient.lpush).toHaveBeenCalledOnce();
-  });
-
-  test("clearAsync deletes the list", async () => {
-    const channel = createListChannel<string>("test-list");
-
-    await channel.clearAsync();
-
-    expect(mockRedisClient.del).toHaveBeenCalledOnce();
-  });
-});
-
-describe("createCacheChannel", () => {
-  beforeEach(() => {
-    vi.clearAllMocks();
-  });
-
-  test("invalidateAsync deletes the cache key", async () => {
-    const channel = createCacheChannel<string>("test-cache");
-
-    await channel.invalidateAsync();
-
-    expect(mockRedisClient.del).toHaveBeenCalledWith("cache:test-cache");
-  });
-
-  test("getAsync returns null when no cached data", async () => {
-    const channel = createCacheChannel<string>("test-cache");
-
-    const result = await channel.getAsync();
-
-    expect(result).toBeNull();
-  });
-});

packages/redis/src/lib/channel.ts

@@ -2,7 +2,6 @@ import superjson from "superjson";
 
 import { createId, hashObjectBase64 } from "@homarr/common";
 import { createLogger } from "@homarr/core/infrastructure/logs";
-import type { RedisClient } from "@homarr/core/infrastructure/redis";
 import type { WidgetKind } from "@homarr/definitions";
 
 import { ChannelSubscriptionTracker } from "./channel-subscription-tracker";
@@ -10,11 +9,8 @@ import { createRedisConnection } from "./connection";
 
 const logger = createLogger({ module: "redisChannel" });
 
-let _publisher: RedisClient | undefined;
-const getPublisher = () => (_publisher ??= createRedisConnection());
-
-let _lastDataClient: RedisClient | undefined;
-const getLastDataClient = () => (_lastDataClient ??= createRedisConnection());
+const publisher = createRedisConnection();
+const lastDataClient = createRedisConnection();
 
 /**
  * Creates a new pub/sub channel.
@@ -31,33 +27,34 @@ export const createSubPubChannel = <TData>(name: string, { persist }: { persist:
      */
     subscribe: (callback: (data: TData) => void) => {
       if (persist) {
-        void getLastDataClient()
-          .get(lastChannelName)
-          .then((data) => {
-            if (data) {
-              callback(superjson.parse(data));
-            }
-          });
+        void lastDataClient.get(lastChannelName).then((data) => {
+          if (data) {
+            callback(superjson.parse(data));
+          }
+        });
       }
       return ChannelSubscriptionTracker.subscribe(channelName, (message) => {
         callback(superjson.parse(message));
       });
     },
+    /**
+     * Publish data to the channel with last data saved.
+     * @param data data to be published
+     */
     publishAsync: async (data: TData) => {
       if (persist) {
-        await getLastDataClient().set(lastChannelName, superjson.stringify(data));
+        await lastDataClient.set(lastChannelName, superjson.stringify(data));
       }
-      await getPublisher().publish(channelName, superjson.stringify(data));
+      await publisher.publish(channelName, superjson.stringify(data));
     },
     getLastDataAsync: async () => {
-      const data = await getLastDataClient().get(lastChannelName);
+      const data = await lastDataClient.get(lastChannelName);
       return data ? superjson.parse<TData>(data) : null;
     },
   };
 };
 
-let _getSetClient: RedisClient | undefined;
-const getSetClient = () => (_getSetClient ??= createRedisConnection());
+const getSetClient = createRedisConnection();
 
 /**
  * Creates a new redis channel for a list
@@ -72,7 +69,7 @@ export const createListChannel = <TItem>(name: string) => {
      * @returns an array of all items
      */
     getAllAsync: async () => {
-      const items = await getSetClient().lrange(listChannelName, 0, -1);
+      const items = await getSetClient.lrange(listChannelName, 0, -1);
       return items.map((item) => superjson.parse<TItem>(item));
     },
     /**
@@ -80,20 +77,20 @@ export const createListChannel = <TItem>(name: string) => {
      * @param item item to remove
      */
     removeAsync: async (item: TItem) => {
-      await getSetClient().lrem(listChannelName, 0, superjson.stringify(item));
+      await getSetClient.lrem(listChannelName, 0, superjson.stringify(item));
     },
     /**
      * Clear all items from the channels list
      */
     clearAsync: async () => {
-      await getSetClient().del(listChannelName);
+      await getSetClient.del(listChannelName);
     },
     /**
      * Add an item to the channels list
      * @param item item to add
      */
     addAsync: async (item: TItem) => {
-      await getSetClient().lpush(listChannelName, superjson.stringify(item));
+      await getSetClient.lpush(listChannelName, superjson.stringify(item));
     },
   };
 };
@@ -109,7 +106,7 @@ export const createGetSetChannel = <TData>(name: string) => {
      * @returns data or null if not found
      */
     getAsync: async () => {
-      const data = await getSetClient().get(name);
+      const data = await getSetClient.get(name);
       return data ? superjson.parse<TData>(data) : null;
     },
     /**
@@ -117,13 +114,13 @@ export const createGetSetChannel = <TData>(name: string) => {
      * @param data data to be stored in the channel
      */
     setAsync: async (data: TData) => {
-      await getSetClient().set(name, superjson.stringify(data));
+      await getSetClient.set(name, superjson.stringify(data));
     },
     /**
      * Remove data from the channel
      */
     removeAsync: async () => {
-      await getSetClient().del(name);
+      await getSetClient.del(name);
     },
   };
 };
@@ -143,7 +140,7 @@ export const createCacheChannel = <TData>(name: string, cacheDurationMs: number
      * @returns data or null if not found or expired
      */
     getAsync: async () => {
-      const data = await getSetClient().get(cacheChannelName);
+      const data = await getSetClient.get(cacheChannelName);
       if (!data) return null;
 
       const parsedData = superjson.parse<{ data: TData; timestamp: Date }>(data);
@@ -159,13 +156,13 @@ export const createCacheChannel = <TData>(name: string, cacheDurationMs: number
      * @returns data or new data if not present or expired
      */
     consumeAsync: async (callback: () => Promise<TData>) => {
-      const data = await getSetClient().get(cacheChannelName);
+      const data = await getSetClient.get(cacheChannelName);
 
       const getNewDataAsync = async () => {
         logger.debug(`Cache miss for channel '${cacheChannelName}'`);
         const newData = await callback();
         const result = { data: newData, timestamp: new Date() };
-        await getSetClient().set(cacheChannelName, superjson.stringify(result));
+        await getSetClient.set(cacheChannelName, superjson.stringify(result));
         logger.debug(`Cache updated for channel '${cacheChannelName}'`);
         return result;
       };
@@ -190,14 +187,14 @@ export const createCacheChannel = <TData>(name: string, cacheDurationMs: number
      * Invalidate the cache channels data.
      */
     invalidateAsync: async () => {
-      await getSetClient().del(cacheChannelName);
+      await getSetClient.del(cacheChannelName);
     },
     /**
      * Set the data in the cache channel.
      * @param data data to be stored in the cache channel
      */
     setAsync: async (data: TData) => {
-      await getSetClient().set(cacheChannelName, superjson.stringify({ data, timestamp: new Date() }));
+      await getSetClient.set(cacheChannelName, superjson.stringify({ data, timestamp: new Date() }));
     },
   };
 };
@@ -239,12 +236,12 @@ export const createChannelEventHistory = <TData>(channelName: string, maxElement
       });
     },
     pushAsync: async (data: TData, options = { publish: false }) => {
-      if (options.publish) await getPublisher().publish(channelName, superjson.stringify(data));
-      await getSetClient().lpush(channelName, superjson.stringify({ data, timestamp: new Date() }));
-      await getSetClient().ltrim(channelName, 0, maxElements);
+      if (options.publish) await publisher.publish(channelName, superjson.stringify(data));
+      await getSetClient.lpush(channelName, superjson.stringify({ data, timestamp: new Date() }));
+      await getSetClient.ltrim(channelName, 0, maxElements);
     },
     clearAsync: async () => {
-      await getSetClient().del(channelName);
+      await getSetClient.del(channelName);
     },
     /**
      * Returns a slice of the available data in the channel.
@@ -253,17 +250,17 @@ export const createChannelEventHistory = <TData>(channelName: string, maxElement
      * @param endIndex End index of the slice, negative values are counted from the end, defaults at end of range.
      */
     getSliceAsync: async (startIndex = 0, endIndex = -1) => {
-      const range = await getSetClient().lrange(channelName, startIndex, endIndex);
+      const range = await getSetClient.lrange(channelName, startIndex, endIndex);
       return range.map((item) => superjson.parse<{ data: TData; timestamp: Date }>(item));
     },
     getSliceUntilTimeAsync: async (time: Date) => {
-      const itemsInCollection = await getSetClient().lrange(channelName, 0, -1);
+      const itemsInCollection = await getSetClient.lrange(channelName, 0, -1);
       return itemsInCollection
         .map((item) => superjson.parse<{ data: TData; timestamp: Date }>(item))
         .filter((item) => item.timestamp < time);
     },
     getLengthAsync: async () => {
-      return await getSetClient().llen(channelName);
+      return await getSetClient.llen(channelName);
     },
     name: channelName,
   };
@@ -274,11 +271,11 @@ export const createChannelEventHistory = <TData>(channelName: string, maxElement
  */
 export const createChannelEventHistoryOld = <TData>(channelName: string, maxElements = 15) => {
   const popElementsOverMaxAsync = async () => {
-    const length = await getSetClient().llen(channelName);
+    const length = await getSetClient.llen(channelName);
     if (length <= maxElements) {
       return;
     }
-    await getSetClient().ltrim(channelName, 0, maxElements - 1);
+    await getSetClient.ltrim(channelName, 0, maxElements - 1);
   };
 
   return {
@@ -288,33 +285,33 @@ export const createChannelEventHistoryOld = <TData>(channelName: string, maxElem
       });
     },
     publishAndPushAsync: async (data: TData) => {
-      await getPublisher().publish(channelName, superjson.stringify(data));
-      await getSetClient().lpush(channelName, superjson.stringify({ data, timestamp: new Date() }));
+      await publisher.publish(channelName, superjson.stringify(data));
+      await getSetClient.lpush(channelName, superjson.stringify({ data, timestamp: new Date() }));
       await popElementsOverMaxAsync();
     },
     pushAsync: async (data: TData) => {
-      await getSetClient().lpush(channelName, superjson.stringify({ data, timestamp: new Date() }));
+      await getSetClient.lpush(channelName, superjson.stringify({ data, timestamp: new Date() }));
       await popElementsOverMaxAsync();
     },
     clearAsync: async () => {
-      await getSetClient().del(channelName);
+      await getSetClient.del(channelName);
     },
     getLastAsync: async () => {
-      const length = await getSetClient().llen(channelName);
-      const data = await getSetClient().lrange(channelName, length - 1, length);
+      const length = await getSetClient.llen(channelName);
+      const data = await getSetClient.lrange(channelName, length - 1, length);
       if (data.length !== 1) return null;
 
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       return superjson.parse<{ data: TData; timestamp: Date }>(data[0]!);
     },
     getSliceAsync: async (startIndex: number, endIndex: number) => {
-      const range = await getSetClient().lrange(channelName, startIndex, endIndex);
+      const range = await getSetClient.lrange(channelName, startIndex, endIndex);
       return range.map((item) => superjson.parse<{ data: TData; timestamp: Date }>(item));
     },
     getSliceUntilTimeAsync: async (time: Date) => {
-      const length = await getSetClient().llen(channelName);
+      const length = await getSetClient.llen(channelName);
       const items: TData[] = [];
-      const itemsInCollection = await getSetClient().lrange(channelName, 0, length - 1);
+      const itemsInCollection = await getSetClient.lrange(channelName, 0, length - 1);
 
       for (let i = 0; i < length - 1; i++) {
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
@@ -327,7 +324,7 @@ export const createChannelEventHistoryOld = <TData>(channelName: string, maxElem
       return items;
     },
     getLengthAsync: async () => {
-      return await getSetClient().llen(channelName);
+      return await getSetClient.llen(channelName);
     },
     name: channelName,
   };
@@ -341,14 +338,14 @@ export const createChannelWithLatestAndEvents = <TData>(channelName: string) =>
       });
     },
     publishAndUpdateLastStateAsync: async (data: TData) => {
-      await getPublisher().publish(channelName, superjson.stringify(data));
-      await getSetClient().set(channelName, superjson.stringify({ data, timestamp: new Date() }));
+      await publisher.publish(channelName, superjson.stringify(data));
+      await getSetClient.set(channelName, superjson.stringify({ data, timestamp: new Date() }));
     },
     setAsync: async (data: TData) => {
-      await getSetClient().set(channelName, superjson.stringify({ data, timestamp: new Date() }));
+      await getSetClient.set(channelName, superjson.stringify({ data, timestamp: new Date() }));
     },
     getAsync: async () => {
-      const data = await getSetClient().get(channelName);
+      const data = await getSetClient.get(channelName);
       if (!data) return null;
 
       return superjson.parse<{ data: TData; timestamp: Date }>(data);
@@ -357,8 +354,7 @@ export const createChannelWithLatestAndEvents = <TData>(channelName: string) =>
   };
 };
 
-let _queueClient: RedisClient | undefined;
-const getQueueClient = () => (_queueClient ??= createRedisConnection());
+const queueClient = createRedisConnection();
 
 type WithId<TItem> = TItem & { _id: string };
 
@@ -370,11 +366,11 @@ type WithId<TItem> = TItem & { _id: string };
 export const createQueueChannel = <TItem>(name: string) => {
   const queueChannelName = `queue:${name}`;
   const getDataAsync = async () => {
-    const data = await getQueueClient().get(queueChannelName);
+    const data = await queueClient.get(queueChannelName);
     return data ? superjson.parse<WithId<TItem>[]>(data) : [];
   };
   const setDataAsync = async (data: WithId<TItem>[]) => {
-    await getQueueClient().set(queueChannelName, superjson.stringify(data));
+    await queueClient.set(queueChannelName, superjson.stringify(data));
   };
 
   return {
@@ -421,5 +417,5 @@ export const createQueueChannel = <TItem>(name: string) => {
 };
 
 export const handshakeAsync = async () => {
-  await getSetClient().hello();
+  await getSetClient.hello();
 };

packages/redis/src/lib/connection.spec.ts

@@ -1,45 +0,0 @@
-import { describe, expect, test, vi } from "vitest";
-
-import { createRedisClient } from "@homarr/core/infrastructure/redis";
-
-import { createRedisConnection } from "./connection";
-
-const mockRedisInstance = { ping: vi.fn() };
-
-vi.mock("@homarr/core/infrastructure/redis", () => ({
-  createRedisClient: vi.fn(() => mockRedisInstance),
-}));
-
-describe("createRedisConnection", () => {
-  test("returns a redis client regardless of CI env", () => {
-    const original = process.env.CI;
-    process.env.CI = "true";
-
-    const client = createRedisConnection();
-
-    expect(client).toBe(mockRedisInstance);
-    expect(client).not.toBeNull();
-
-    process.env.CI = original;
-  });
-
-  test("returns a redis client when DISABLE_REDIS_LOGS is set", () => {
-    const original = process.env.DISABLE_REDIS_LOGS;
-    process.env.DISABLE_REDIS_LOGS = "true";
-
-    const client = createRedisConnection();
-
-    expect(client).toBe(mockRedisInstance);
-    expect(client).not.toBeNull();
-
-    process.env.DISABLE_REDIS_LOGS = original;
-  });
-
-  test("always delegates to createRedisClient", () => {
-    vi.mocked(createRedisClient).mockClear();
-
-    createRedisConnection();
-
-    expect(createRedisClient).toHaveBeenCalledOnce();
-  });
-});

packages/redis/src/lib/connection.ts

@@ -1,3 +1,15 @@
+import type { RedisClient } from "@homarr/core/infrastructure/redis";
 import { createRedisClient } from "@homarr/core/infrastructure/redis";
 
-export const createRedisConnection = () => createRedisClient();
+/**
+ * Creates a new Redis connection
+ * @returns redis client
+ */
+export const createRedisConnection = () => {
+  if (Boolean(process.env.CI) || Boolean(process.env.DISABLE_REDIS_LOGS)) {
+    // Return null if we are in CI as we don't want to connect to Redis
+    return null as unknown as RedisClient;
+  }
+
+  return createRedisClient();
+};