feat!: release v2 (#6545)
Co-authored-by: Artur <145776561+arturict@users.noreply.github.com> Co-authored-by: arturict <arturict@users.noreply.github.com> Co-authored-by: Thomas <thomas@ajnart.fr> Co-authored-by: Afonso Jorge Ramos <afonsojorgeramos@gmail.com> Co-authored-by: Danura30082 <danura30082+github@gmail.com> Co-authored-by: Kushie <122986913+kushiemoon-dev@users.noreply.github.com> Co-authored-by: ajnart <thomas@ajnart.fr> Co-authored-by: ajnart <thomas@ajnart.dev> Co-authored-by: chenjun <chenjun@foxmail.com> Co-authored-by: Wikibear <wikibear@users.noreply.github.com> Co-authored-by: Bergasha <bergasha@gmail.com> Co-authored-by: leafyelin <43306196+leafyelin@users.noreply.github.com> Co-authored-by: Lucas Araujo <lucas.lra@gmail.com> Co-authored-by: GreenMonito <86085570+GreenMonito@users.noreply.github.com> Co-authored-by: Nerdy-Technician <roffo@nerdy-technician.social> Co-authored-by: Jun <34545896+jcstrong@users.noreply.github.com> Co-authored-by: Edmond Abraham <54119952+gitedmond@users.noreply.github.com> Co-authored-by: thrawnx <tight.bulb9384@fastmail.com> Co-authored-by: Chris <58918656+nordada@users.noreply.github.com> Co-authored-by: yi111 <153097222+Yi-111-a@users.noreply.github.com> Co-authored-by: Yanis <naamaneyanis@gmail.com> Co-authored-by: Wikibear <me@sej.de> Co-authored-by: alessiottavo <93441886+alessiottavo@users.noreply.github.com>
This commit is contained in:
3286 files changed
+284386
-139176
No files matched your search
@@ -3,21 +3,11 @@ import { PostHog } from "posthog-node";
|
||||
export const POSTHOG_API_KEY = "phc_vYBmGWNbRshvfeC7EHfeSmUm2pD2Neg5nGqzJuGvS8Hs";
|
||||
export const POSTHOG_HOST = "https://hog.homarr.dev";
|
||||
|
||||
let instance: PostHog | undefined;
|
||||
|
||||
export const getPostHogClient = (): PostHog => {
|
||||
instance ??= new PostHog(POSTHOG_API_KEY, {
|
||||
export const createPostHogClient = (): PostHog =>
|
||||
new PostHog(POSTHOG_API_KEY, {
|
||||
host: POSTHOG_HOST,
|
||||
flushAt: 10,
|
||||
flushInterval: 30_000,
|
||||
flushInterval: 0,
|
||||
preloadFeatureFlags: false,
|
||||
disableSurveys: true,
|
||||
});
|
||||
return instance;
|
||||
};
|
||||
|
||||
export const trackEvent = (instanceId: string, event: string, properties?: Record<string, unknown>) => {
|
||||
getPostHogClient().capture({
|
||||
distinctId: instanceId,
|
||||
event,
|
||||
properties,
|
||||
});
|
||||
};
|
||||
@@ -1,2 +1 @@
|
||||
export { trackEvent } from "./client";
|
||||
export { sendServerAnalyticsAsync } from "./send-server-analytics";
|
||||
@@ -1,9 +1,12 @@
|
||||
import { createHash } from "node:crypto";
|
||||
|
||||
import { isProviderEnabled } from "@homarr/auth/server";
|
||||
import { createId, Stopwatch } from "@homarr/common";
|
||||
import { env } from "@homarr/common/env";
|
||||
import { createLogger } from "@homarr/core/infrastructure/logs";
|
||||
import { count, db } from "@homarr/db";
|
||||
import { isMysql, isPostgresql } from "@homarr/db/collection";
|
||||
import { getServerSettingByKeyAsync, updateServerSettingByKeyAsync } from "@homarr/db/queries";
|
||||
import { count, countDistinct, db, eq } from "@homarr/db";
|
||||
import { isPostgresql } from "@homarr/db/collection";
|
||||
import { getServerSettingByKeyAsync, updateAnalyticsServerSettingAsync } from "@homarr/db/queries";
|
||||
import {
|
||||
accounts,
|
||||
apiKeys,
|
||||
@@ -14,6 +17,7 @@ import {
|
||||
groups,
|
||||
iconRepositories,
|
||||
icons,
|
||||
integrationItems,
|
||||
integrations,
|
||||
invites,
|
||||
itemLayouts,
|
||||
@@ -30,11 +34,12 @@ import {
|
||||
import { env as dockerEnv } from "@homarr/docker/env";
|
||||
|
||||
import packageJson from "../../../package.json";
|
||||
import { getPostHogClient } from "./client";
|
||||
import { createPostHogClient } from "./client";
|
||||
import { getItemCountBucket, getSnapshotPeriod, isSnapshotDue, omitZeroCounts } from "./snapshot-properties";
|
||||
|
||||
const logger = createLogger({ module: "analytics" });
|
||||
|
||||
type AnalyticsResult = "sent" | "disabled" | "failed";
|
||||
type AnalyticsResult = "sent" | "skipped" | "disabled" | "failed";
|
||||
|
||||
const getOrCreateInstanceId = async (
|
||||
analyticsSettings: Awaited<ReturnType<typeof getServerSettingByKeyAsync<"analytics">>>,
|
||||
@@ -42,16 +47,24 @@ const getOrCreateInstanceId = async (
|
||||
if (analyticsSettings.instanceId) return analyticsSettings.instanceId;
|
||||
|
||||
const instanceId = createId();
|
||||
await updateServerSettingByKeyAsync(db, "analytics", { ...analyticsSettings, instanceId });
|
||||
|
||||
const verified = await getServerSettingByKeyAsync(db, "analytics");
|
||||
return verified.instanceId ?? instanceId;
|
||||
const updated = await updateAnalyticsServerSettingAsync(db, (current) => {
|
||||
if (current.instanceId) return current;
|
||||
return { ...current, instanceId };
|
||||
});
|
||||
return updated.instanceId ?? instanceId;
|
||||
};
|
||||
|
||||
const sumGroupedCounts = (rows: { count: number }[]): number => rows.reduce((sum, row) => sum + row.count, 0);
|
||||
|
||||
export const sendServerAnalyticsAsync = async (): Promise<AnalyticsResult> => {
|
||||
const getSnapshotUuid = (instanceId: string, now: Date) => {
|
||||
const period = getSnapshotPeriod(now);
|
||||
const hash = createHash("sha256").update(`${instanceId}:${period}:server-analytics`).digest("hex").slice(0, 32);
|
||||
return `${hash.slice(0, 8)}-${hash.slice(8, 12)}-5${hash.slice(13, 16)}-a${hash.slice(17, 20)}-${hash.slice(20)}`;
|
||||
};
|
||||
|
||||
const sendSnapshotAsync = async (): Promise<AnalyticsResult> => {
|
||||
const stopWatch = new Stopwatch();
|
||||
if (env.NO_EXTERNAL_CONNECTION) return "disabled";
|
||||
const analyticsSettings = await getServerSettingByKeyAsync(db, "analytics");
|
||||
|
||||
if (!analyticsSettings.enableGeneral) {
|
||||
@@ -59,14 +72,18 @@ export const sendServerAnalyticsAsync = async (): Promise<AnalyticsResult> => {
|
||||
return "disabled";
|
||||
}
|
||||
|
||||
const client = getPostHogClient();
|
||||
const now = new Date();
|
||||
if (!isSnapshotDue(analyticsSettings.lastSuccessfulSnapshotAt, now)) return "skipped";
|
||||
|
||||
try {
|
||||
const instanceId = await getOrCreateInstanceId(analyticsSettings);
|
||||
|
||||
const [
|
||||
cultureSettings,
|
||||
boardSettings,
|
||||
countBoards,
|
||||
countPublicBoards,
|
||||
countBoardsWithStatusEnabled,
|
||||
countGroups,
|
||||
countApps,
|
||||
countSections,
|
||||
@@ -87,9 +104,17 @@ export const sendServerAnalyticsAsync = async (): Promise<AnalyticsResult> => {
|
||||
countAccounts,
|
||||
integrationKinds,
|
||||
widgetKinds,
|
||||
boardsWithWidgetKinds,
|
||||
boardItemCounts,
|
||||
boardsWithIntegrationKinds,
|
||||
layoutRoleCounts,
|
||||
sectionKindCounts,
|
||||
] = await Promise.all([
|
||||
getServerSettingByKeyAsync(db, "culture"),
|
||||
getServerSettingByKeyAsync(db, "board"),
|
||||
db.$count(boards),
|
||||
db.$count(boards, eq(boards.isPublic, true)),
|
||||
db.$count(boards, eq(boards.disableStatus, false)),
|
||||
db.$count(groups),
|
||||
db.$count(apps),
|
||||
db.$count(sections),
|
||||
@@ -116,13 +141,35 @@ export const sendServerAnalyticsAsync = async (): Promise<AnalyticsResult> => {
|
||||
.select({ kind: items.kind, count: count(items.id) })
|
||||
.from(items)
|
||||
.groupBy(items.kind),
|
||||
db
|
||||
.select({ kind: items.kind, count: countDistinct(items.boardId) })
|
||||
.from(items)
|
||||
.groupBy(items.kind),
|
||||
db
|
||||
.select({ boardId: items.boardId, count: count(items.id) })
|
||||
.from(items)
|
||||
.groupBy(items.boardId),
|
||||
db
|
||||
.select({ kind: integrations.kind, count: countDistinct(items.boardId) })
|
||||
.from(integrationItems)
|
||||
.innerJoin(integrations, eq(integrationItems.integrationId, integrations.id))
|
||||
.innerJoin(items, eq(integrationItems.itemId, items.id))
|
||||
.groupBy(integrations.kind),
|
||||
db
|
||||
.select({ kind: layouts.role, count: count(layouts.id) })
|
||||
.from(layouts)
|
||||
.groupBy(layouts.role),
|
||||
db
|
||||
.select({ kind: sections.kind, count: count(sections.id) })
|
||||
.from(sections)
|
||||
.groupBy(sections.kind),
|
||||
]);
|
||||
|
||||
const enabledAuthProviders = (["credentials", "oidc", "ldap"] as const).filter(isProviderEnabled);
|
||||
|
||||
const properties: Record<string, unknown> = {
|
||||
homarrVersion: packageJson.version,
|
||||
databaseType: isMysql() ? "mysql" : isPostgresql() ? "postgresql" : "sqlite",
|
||||
databaseType: isPostgresql() ? "postgresql" : "sqlite",
|
||||
dockerEnabled: Boolean(dockerEnv.ENABLE_DOCKER),
|
||||
kubernetesEnabled: Boolean(dockerEnv.ENABLE_KUBERNETES),
|
||||
authProviders: enabledAuthProviders,
|
||||
@@ -133,6 +180,7 @@ export const sendServerAnalyticsAsync = async (): Promise<AnalyticsResult> => {
|
||||
defaultLocale: cultureSettings.defaultLocale,
|
||||
|
||||
countBoards,
|
||||
countPublicBoards,
|
||||
countGroups,
|
||||
countApps,
|
||||
countSections,
|
||||
@@ -157,20 +205,55 @@ export const sendServerAnalyticsAsync = async (): Promise<AnalyticsResult> => {
|
||||
countWidgets: sumGroupedCounts(widgetKinds),
|
||||
};
|
||||
|
||||
for (const row of integrationKinds) {
|
||||
properties[`integration_${row.kind}`] = row.count;
|
||||
}
|
||||
for (const row of widgetKinds) {
|
||||
properties[`widget_${row.kind}`] = row.count;
|
||||
if (!boardSettings.forceDisableStatus && countBoardsWithStatusEnabled > 0) {
|
||||
properties.countBoardsWithStatusEnabled = countBoardsWithStatusEnabled;
|
||||
}
|
||||
|
||||
for (const row of integrationKinds) {
|
||||
if (row.count > 0) properties[`integration_${row.kind}`] = row.count;
|
||||
}
|
||||
for (const row of widgetKinds) {
|
||||
if (row.count > 0) properties[`widget_${row.kind}`] = row.count;
|
||||
}
|
||||
for (const row of boardsWithWidgetKinds) {
|
||||
if (row.count > 0) properties[`boardsWithWidget_${row.kind}`] = row.count;
|
||||
}
|
||||
for (const row of boardsWithIntegrationKinds) {
|
||||
if (row.count > 0) properties[`boardsWithIntegration_${row.kind}`] = row.count;
|
||||
}
|
||||
for (const row of layoutRoleCounts) {
|
||||
if (row.count > 0) properties[`layout_${row.kind}`] = row.count;
|
||||
}
|
||||
for (const row of sectionKindCounts) {
|
||||
if (row.count > 0) properties[`section_${row.kind}`] = row.count;
|
||||
}
|
||||
const boardSizeCounts = new Map<string, number>();
|
||||
const emptyBoardCount = countBoards - boardItemCounts.length;
|
||||
if (emptyBoardCount > 0) boardSizeCounts.set("empty", emptyBoardCount);
|
||||
for (const row of boardItemCounts) {
|
||||
const bucket = getItemCountBucket(row.count);
|
||||
boardSizeCounts.set(bucket, (boardSizeCounts.get(bucket) ?? 0) + 1);
|
||||
}
|
||||
for (const [bucket, boardCount] of boardSizeCounts) {
|
||||
properties[`boardsWithItemCount_${bucket}`] = boardCount;
|
||||
}
|
||||
const currentSettings = await getServerSettingByKeyAsync(db, "analytics");
|
||||
if (!currentSettings.enableGeneral || env.NO_EXTERNAL_CONNECTION) return "disabled";
|
||||
|
||||
const client = createPostHogClient();
|
||||
client.capture({
|
||||
uuid: getSnapshotUuid(instanceId, now),
|
||||
distinctId: instanceId,
|
||||
event: "server-analytics",
|
||||
properties,
|
||||
properties: { ...omitZeroCounts(properties), $process_person_profile: false },
|
||||
disableGeoip: true,
|
||||
});
|
||||
|
||||
await client.flush();
|
||||
await updateAnalyticsServerSettingAsync(db, (current) => ({
|
||||
...current,
|
||||
lastSuccessfulSnapshotAt: now.toISOString(),
|
||||
}));
|
||||
logger.info(`Sent analytics to PostHog in ${stopWatch.getElapsedInHumanWords()}`);
|
||||
return "sent";
|
||||
} catch (error) {
|
||||
@@ -178,3 +261,13 @@ export const sendServerAnalyticsAsync = async (): Promise<AnalyticsResult> => {
|
||||
return "failed";
|
||||
}
|
||||
};
|
||||
|
||||
let pendingSnapshot: Promise<AnalyticsResult> | null = null;
|
||||
|
||||
export const sendServerAnalyticsAsync = (): Promise<AnalyticsResult> => {
|
||||
if (pendingSnapshot) return pendingSnapshot;
|
||||
pendingSnapshot = sendSnapshotAsync().finally(() => {
|
||||
pendingSnapshot = null;
|
||||
});
|
||||
return pendingSnapshot;
|
||||
};
|
||||
@@ -0,0 +1,32 @@
|
||||
import { describe, expect, test } from "vitest";
|
||||
|
||||
import { getItemCountBucket, isSnapshotDue, omitZeroCounts } from "./snapshot-properties";
|
||||
|
||||
describe("snapshot properties", () => {
|
||||
test("waits seven full days after a successful report", () => {
|
||||
const now = new Date("2026-09-25T00:00:00.000Z");
|
||||
|
||||
expect(isSnapshotDue(null, now)).toBe(true);
|
||||
expect(isSnapshotDue("2026-09-18T00:00:00.001Z", now)).toBe(false);
|
||||
expect(isSnapshotDue("2026-09-18T00:00:00.000Z", now)).toBe(true);
|
||||
expect(isSnapshotDue("2026-09-26T00:00:00.000Z", now)).toBe(false);
|
||||
});
|
||||
|
||||
test("buckets board sizes and omits zero-valued counts", () => {
|
||||
expect([0, 1, 2, 3, 4, 7, 8, 15, 16].map(getItemCountBucket)).toEqual([
|
||||
"empty",
|
||||
"one",
|
||||
"two-to-three",
|
||||
"two-to-three",
|
||||
"four-to-seven",
|
||||
"four-to-seven",
|
||||
"eight-to-fifteen",
|
||||
"eight-to-fifteen",
|
||||
"sixteen-plus",
|
||||
]);
|
||||
expect(omitZeroCounts({ countBoards: 0, countWidgets: 2, boardsWithItemCount_empty: 1 })).toEqual({
|
||||
countWidgets: 2,
|
||||
boardsWithItemCount_empty: 1,
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,25 @@
|
||||
const snapshotIntervalMs = 7 * 24 * 60 * 60 * 1_000;
|
||||
|
||||
export const isSnapshotDue = (lastSuccessfulSnapshotAt: string | null, now: Date) => {
|
||||
if (!lastSuccessfulSnapshotAt) return true;
|
||||
const lastSent = Date.parse(lastSuccessfulSnapshotAt);
|
||||
if (!Number.isFinite(lastSent)) return true;
|
||||
return now.getTime() - lastSent >= snapshotIntervalMs;
|
||||
};
|
||||
|
||||
export const getSnapshotPeriod = (now: Date) => Math.floor(now.getTime() / snapshotIntervalMs);
|
||||
|
||||
export const getItemCountBucket = (itemCount: number) => {
|
||||
if (itemCount === 0) return "empty";
|
||||
if (itemCount === 1) return "one";
|
||||
if (itemCount <= 3) return "two-to-three";
|
||||
if (itemCount <= 7) return "four-to-seven";
|
||||
if (itemCount <= 15) return "eight-to-fifteen";
|
||||
return "sixteen-plus";
|
||||
};
|
||||
|
||||
export const omitZeroCounts = (properties: Record<string, unknown>) => {
|
||||
return Object.fromEntries(
|
||||
Object.entries(properties).filter(([key, value]) => !key.startsWith("count") || value !== 0),
|
||||
);
|
||||
};
|
||||
Reference in new issue
Block a user