feat: add Umami Analytics integration and widget (#5362)

Co-authored-by: Josh G <febrile42@users.noreply.github.com>
Co-authored-by: Meier Lukas <meierschlumpf@gmail.com>
Co-authored-by: Thomas <thomas@ajnart.fr>

packages/api/src/router/widgets/index.ts

@@ -30,4 +30,5 @@ export const widgetRouter = createTRPCRouter({
   timetable: lazy(() => import("./timetable").then((mod) => mod.timetableRouter)),
   tracearr: lazy(() => import("./tracearr").then((mod) => mod.tracearrRouter)),
   speedtestTracker: lazy(() => import("./speedtest-tracker").then((mod) => mod.speedtestTrackerRouter)),
+  umami: lazy(() => import("./umami").then((mod) => mod.umamiRouter)),
 });

packages/api/src/router/widgets/umami.ts

@@ -0,0 +1,205 @@
+import { observable } from "@trpc/server/observable";
+import { z } from "zod/v4";
+
+import { createLogger } from "@homarr/core/infrastructure/logs";
+import { ErrorWithMetadata } from "@homarr/core/infrastructure/logs/error";
+import { createIntegrationAsync } from "@homarr/integrations";
+import {
+  umamiActiveVisitorsRequestHandler,
+  umamiEventNamesRequestHandler,
+  umamiMultiEventRequestHandler,
+  umamiRequestHandler,
+  umamiTopPagesRequestHandler,
+  umamiTopReferrersRequestHandler,
+} from "@homarr/request-handler/umami";
+
+import { createManyIntegrationMiddleware, createOneIntegrationMiddleware } from "../../middlewares/integration";
+import { createTRPCRouter, publicProcedure } from "../../trpc";
+
+const logger = createLogger({ module: "umami-router" });
+
+export const umamiRouter = createTRPCRouter({
+  getWebsites: publicProcedure.concat(createOneIntegrationMiddleware("query", "umami")).query(async ({ ctx }) => {
+    try {
+      const instance = await createIntegrationAsync(ctx.integration);
+      return await instance.getWebsitesAsync();
+    } catch (error) {
+      logger.warn(new Error("Failed to load websites", { cause: error }));
+      return [];
+    }
+  }),
+
+  getVisitorStats: publicProcedure
+    .input(
+      z.object({
+        websiteId: z.string(),
+        timeFrame: z.string(),
+        eventName: z.string().optional(),
+      }),
+    )
+    .concat(createManyIntegrationMiddleware("query", "umami"))
+    .query(async ({ ctx, input }) => {
+      const results = await Promise.all(
+        ctx.integrations.map(async (integration) => {
+          const innerHandler = umamiRequestHandler.handler(integration, {
+            websiteId: input.websiteId,
+            timeFrame: input.timeFrame,
+            eventName: input.eventName,
+          });
+          const { data, timestamp } = await innerHandler.getCachedOrUpdatedDataAsync({ forceUpdate: false });
+
+          return {
+            integrationId: integration.id,
+            integrationName: integration.name,
+            integrationUrl: integration.url,
+            visitorStats: data,
+            updatedAt: timestamp,
+          };
+        }),
+      );
+
+      return results;
+    }),
+
+  getEventNames: publicProcedure
+    .input(z.object({ websiteId: z.string() }))
+    .concat(createOneIntegrationMiddleware("query", "umami"))
+    .query(async ({ ctx, input }) => {
+      try {
+        const innerHandler = umamiEventNamesRequestHandler.handler(ctx.integration, { websiteId: input.websiteId });
+        const { data } = await innerHandler.getCachedOrUpdatedDataAsync({ forceUpdate: false });
+        return data;
+      } catch (error) {
+        logger.warn(
+          new ErrorWithMetadata("Failed to load event names", { websiteId: input.websiteId }, { cause: error }),
+        );
+        return [];
+      }
+    }),
+
+  getTopPages: publicProcedure
+    .input(
+      z.object({
+        websiteId: z.string(),
+        timeFrame: z.string(),
+        limit: z.number().int().min(1).max(500),
+      }),
+    )
+    .concat(createOneIntegrationMiddleware("query", "umami"))
+    .query(async ({ ctx, input }) => {
+      try {
+        const innerHandler = umamiTopPagesRequestHandler.handler(ctx.integration, {
+          websiteId: input.websiteId,
+          timeFrame: input.timeFrame,
+          limit: input.limit,
+        });
+        const { data } = await innerHandler.getCachedOrUpdatedDataAsync({ forceUpdate: false });
+        return data;
+      } catch (error) {
+        logger.warn(
+          new ErrorWithMetadata(
+            "Failed to load top pages",
+            { websiteId: input.websiteId, timeFrame: input.timeFrame, limit: input.limit },
+            { cause: error },
+          ),
+        );
+        return [];
+      }
+    }),
+
+  getTopReferrers: publicProcedure
+    .input(
+      z.object({
+        websiteId: z.string(),
+        timeFrame: z.string(),
+        limit: z.number().int().min(1).max(500),
+      }),
+    )
+    .concat(createOneIntegrationMiddleware("query", "umami"))
+    .query(async ({ ctx, input }) => {
+      try {
+        const innerHandler = umamiTopReferrersRequestHandler.handler(ctx.integration, {
+          websiteId: input.websiteId,
+          timeFrame: input.timeFrame,
+          limit: input.limit,
+        });
+        const { data } = await innerHandler.getCachedOrUpdatedDataAsync({ forceUpdate: false });
+        return data;
+      } catch (error) {
+        logger.warn(
+          new ErrorWithMetadata(
+            "Failed to load top referrers",
+            { websiteId: input.websiteId, timeFrame: input.timeFrame, limit: input.limit },
+            { cause: error },
+          ),
+        );
+        return [];
+      }
+    }),
+
+  getMultiEventTimeSeries: publicProcedure
+    .input(
+      z.object({
+        websiteId: z.string(),
+        timeFrame: z.string(),
+        eventNames: z.array(z.string()),
+      }),
+    )
+    .concat(createOneIntegrationMiddleware("query", "umami"))
+    .query(async ({ ctx, input }) => {
+      try {
+        const sortedNames = [...input.eventNames].sort();
+        const innerHandler = umamiMultiEventRequestHandler.handler(ctx.integration, {
+          websiteId: input.websiteId,
+          timeFrame: input.timeFrame,
+          eventNames: sortedNames,
+        });
+        const { data } = await innerHandler.getCachedOrUpdatedDataAsync({ forceUpdate: false });
+        return data;
+      } catch (error) {
+        logger.warn(
+          new ErrorWithMetadata(
+            "Failed to load multi-event time series",
+            { websiteId: input.websiteId, timeFrame: input.timeFrame, eventNames: JSON.stringify(input.eventNames) },
+            { cause: error },
+          ),
+        );
+        return [];
+      }
+    }),
+
+  getActiveVisitors: publicProcedure
+    .input(z.object({ websiteId: z.string() }))
+    .concat(createOneIntegrationMiddleware("query", "umami"))
+    .query(async ({ ctx, input }) => {
+      try {
+        const innerHandler = umamiActiveVisitorsRequestHandler.handler(ctx.integration, {
+          websiteId: input.websiteId,
+        });
+        const { data } = await innerHandler.getCachedOrUpdatedDataAsync({ forceUpdate: false });
+        return data;
+      } catch (error) {
+        logger.warn(
+          new ErrorWithMetadata("Failed to load active visitors", { websiteId: input.websiteId }, { cause: error }),
+        );
+        return 0;
+      }
+    }),
+
+  subscribeActiveVisitors: publicProcedure
+    .input(z.object({ websiteId: z.string() }))
+    .concat(createOneIntegrationMiddleware("query", "umami"))
+    .subscription(({ ctx, input }) => {
+      return observable<number>((emit) => {
+        const innerHandler = umamiActiveVisitorsRequestHandler.handler(ctx.integration, {
+          websiteId: input.websiteId,
+        });
+        const unsubscribe = innerHandler.subscribe((count) => {
+          emit.next(count);
+        });
+        return () => {
+          unsubscribe();
+        };
+      });
+    }),
+});