github-starred/better-auth
2
0
Fork 0
mirror of https://github.com/better-auth/better-auth.git synced 2026-08-01 10:50:40 -05:00
Code Issues 2.5k Packages Projects Releases 112 Wiki Activity

chore(telemetry): ensure telemetry consent notice displays correctly (#3944)

Browse Source 
* fix(telemetry): ensure telemetry consent notice displays correctly

* chore: check for process

Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>

* chore: fix lint error

---------

Co-authored-by: Bereket Engida <86073083+Bekacru@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
This commit is contained in:
Fraol Lemecha
2025-08-12 14:25:36 -07:00
committed by GitHub
co-authored by Bereket Engida cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
parent 031888178d
commit 30600b02b9
1 changed files with 42 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/better-auth/src/telemetry/index.ts
+42 -20
View File
@@ -23,24 +23,42 @@ You can also debug what would be sent by setting:
Learn more in the docs: https://www.better-auth.com/docs/reference/telemetry\n\n`;
async function configFilePath() {
const path = await import("path");
const os = await import("os");
const baseDir =
typeof process !== "undefined" && process.platform === "win32"
? process.env.APPDATA || path.join(os.homedir(), "AppData", "Roaming")
: path.join(os.homedir(), ".config");
const dir = path.join(baseDir, "better-auth");
const file = path.join(dir, "telemetry.json");
return { file, dir };
}
const shownNoticeInProcess = new Set<string>();
async function hasShownNoticeBefore(anonymousId: string) {
try {
const { file } = await configFilePath();
const fs = await import("fs/promises");
const path = await import("path");
const os = await import("os");
const baseDir =
process.platform === "win32"
? process.env.APPDATA || path.join(os.homedir(), "AppData", "Roaming")
: path.join(os.homedir(), ".config");
const dir = path.join(baseDir, "better-auth");
const file = path.join(dir, "telemetry.json");
const raw = await fs.readFile(file, "utf-8");
const json = JSON.parse(raw) as { seen?: string[] };
return Array.isArray(json.seen) && json.seen.includes(anonymousId);
} catch {
//if we can't read the file, we don't want to show the notice
} catch (err: unknown) {
if (
err &&
typeof err === "object" &&
"code" in err &&
(err as NodeJS.ErrnoException).code === "ENOENT"
) {
// if the file doesn't exist we know that the notice hasn't been shown before
return false;
}
// an unknown error happend
return true;
}
}
@@ -48,21 +66,17 @@ async function hasShownNoticeBefore(anonymousId: string) {
async function markNoticeShown(anonymousId: string) {
try {
const fs = await import("fs/promises");
const path = await import("path");
const os = await import("os");
const baseDir =
process.platform === "win32"
? process.env.APPDATA || path.join(os.homedir(), "AppData", "Roaming")
: path.join(os.homedir(), ".config");
const dir = path.join(baseDir, "better-auth");
const file = path.join(dir, "telemetry.json");
const { file, dir } = await configFilePath();
await fs.mkdir(dir, { recursive: true });
let json: { seen: string[] } = { seen: [] };
try {
const raw = await fs.readFile(file, "utf-8");
const parsed = JSON.parse(raw) as { seen?: string[] };
json.seen = Array.isArray(parsed.seen) ? parsed.seen : [];
} catch {}
if (!json.seen.includes(anonymousId)) {
json.seen.push(anonymousId);
}
@@ -72,15 +86,19 @@ async function markNoticeShown(anonymousId: string) {
async function maybeShowTelemetryNotice(anonymousId: string) {
if (shownNoticeInProcess.has(anonymousId)) return;
if (typeof process !== "undefined" && process.stdout && !process.stdout.isTTY)
return;
if (await hasShownNoticeBefore(anonymousId)) {
shownNoticeInProcess.add(anonymousId);
return;
}
try {
console.log(message);
} catch {}
shownNoticeInProcess.add(anonymousId);
await markNoticeShown(anonymousId);
}
@@ -90,10 +108,13 @@ export async function createTelemetry(
context?: TelemetryContext,
) {
const debugEnabled =
options.telemetry?.debug || getBooleanEnvVar("BETTER_AUTH_TELEMETRY_DEBUG");
options.telemetry?.debug ||
getBooleanEnvVar("BETTER_AUTH_TELEMETRY_DEBUG", false);
const disableNotice =
options.telemetry?.disableNotice ||
getBooleanEnvVar("BETTER_AUTH_TELEMETRY_DISABLE_NOTICE");
getBooleanEnvVar("BETTER_AUTH_TELEMETRY_DISABLE_NOTICE", false);
const TELEMETRY_ENDPOINT = ENV.BETTER_AUTH_TELEMETRY_ENDPOINT;
const track = async (event: TelemetryEvent) => {
try {
@@ -137,6 +158,7 @@ export async function createTelemetry(
packageManager: detectPackageManager(),
};
const enabled = await isEnabled();
if (enabled) {
if (!disableNotice) {
await maybeShowTelemetryNotice(anonymousId);