feat(desktop): use datadogId from identities in Sentry

Sentry renderer init takes store and sets user id via datadogIdSelector.
Anonymizer and tests updated.

Author: gre-ledger

apps/ledger-live-desktop/src/sentry/anonymizer.test.ts

@@ -0,0 +1,95 @@
+/* eslint-disable @typescript-eslint/no-require-imports -- need require() after resetModules to get fresh module with env */
+describe("sentry anonymizer", () => {
+  const origEnv = process.env;
+
+  beforeEach(() => {
+    jest.resetModules();
+    process.env = { ...origEnv };
+  });
+
+  afterAll(() => {
+    process.env = origEnv;
+  });
+
+  describe("filepath", () => {
+    it("should return path unchanged when env paths are not set", () => {
+      process.env.LEDGER_CONFIG_DIRECTORY = "";
+      process.env.HOME_DIRECTORY = "";
+      const anonymizer = require("~/sentry/anonymizer").default;
+      expect(anonymizer.filepath("/some/path")).toBe("");
+    });
+
+    it("should return path unchanged for app:// URLs", () => {
+      process.env.LEDGER_CONFIG_DIRECTORY = "/tmp/config";
+      process.env.HOME_DIRECTORY = "/tmp/home";
+      const anonymizer = require("~/sentry/anonymizer").default;
+      expect(anonymizer.filepath("app://foo/bar")).toBe("app://foo/bar");
+    });
+
+    it("should replace USER_DATA path when LEDGER_CONFIG_DIRECTORY is set", () => {
+      process.env.LEDGER_CONFIG_DIRECTORY = "/tmp/user-data";
+      process.env.HOME_DIRECTORY = "/tmp/home";
+      const anonymizer = require("~/sentry/anonymizer").default;
+      expect(anonymizer.filepath("/tmp/user-data/foo/log.txt")).toBe("$USER_DATA/foo/log.txt");
+    });
+
+    it("should replace HOME path when HOME_DIRECTORY is set", () => {
+      process.env.LEDGER_CONFIG_DIRECTORY = "/tmp/config";
+      process.env.HOME_DIRECTORY = "/Users/test";
+      const anonymizer = require("~/sentry/anonymizer").default;
+      expect(anonymizer.filepath("/Users/test/file")).toBe("$HOME/file");
+    });
+
+    it("should replace both paths when both are set", () => {
+      process.env.LEDGER_CONFIG_DIRECTORY = "/tmp/config";
+      process.env.HOME_DIRECTORY = "/tmp/home";
+      const anonymizer = require("~/sentry/anonymizer").default;
+      expect(anonymizer.filepath("/tmp/home/.config/app")).toBe("$HOME/.config/app");
+      expect(anonymizer.filepath("/tmp/config/log")).toBe("$USER_DATA/log");
+    });
+  });
+
+  describe("filepathRecursiveReplacer", () => {
+    beforeEach(() => {
+      process.env.LEDGER_CONFIG_DIRECTORY = "/tmp/config";
+      process.env.HOME_DIRECTORY = "/tmp/home";
+    });
+
+    it("should replace path in plain object", () => {
+      const anonymizer = require("~/sentry/anonymizer").default;
+      const obj = { path: "/tmp/config/foo" };
+      anonymizer.filepathRecursiveReplacer(obj);
+      expect(obj.path).toBe("$USER_DATA/foo");
+    });
+
+    it("should replace path in array", () => {
+      const anonymizer = require("~/sentry/anonymizer").default;
+      const arr = ["/tmp/home/x"];
+      anonymizer.filepathRecursiveReplacer(arr);
+      expect(arr[0]).toBe("$HOME/x");
+    });
+
+    it("should replace path in Error message", () => {
+      const anonymizer = require("~/sentry/anonymizer").default;
+      const err = new Error("Failed at /tmp/config/file.ts");
+      anonymizer.filepathRecursiveReplacer(err);
+      expect(err.message).toBe("Failed at $USER_DATA/file.ts");
+    });
+
+    it("should handle nested objects", () => {
+      const anonymizer = require("~/sentry/anonymizer").default;
+      const obj = { inner: { path: "/tmp/home/bar" } };
+      anonymizer.filepathRecursiveReplacer(obj);
+      expect(obj).toMatchObject({ inner: { path: "$HOME/bar" } });
+    });
+
+    it("should not recurse into already-seen references (circular)", () => {
+      const anonymizer = require("~/sentry/anonymizer").default;
+      const obj: Record<string, unknown> = { a: "/tmp/config/x" };
+      obj.self = obj;
+      anonymizer.filepathRecursiveReplacer(obj);
+      expect(obj.a).toBe("$USER_DATA/x");
+      expect(obj.self).toBe(obj);
+    });
+  });
+});

apps/ledger-live-desktop/src/sentry/anonymizer.ts

@@ -9,11 +9,12 @@ let configDir = (() => {
 
   // we load in async the user data. there is a short period where this will be "" but then it becomes the real path
   // eslint-disable-next-line @typescript-eslint/no-var-requires
-  require("electron")
-    .ipcRenderer.invoke("getPathUserData")
-    .then((path: string) => {
+  const invoke = require("electron")?.ipcRenderer?.invoke;
+  if (typeof invoke === "function") {
+    invoke("getPathUserData").then((path: string) => {
       configDir = path;
     });
+  }
   return "";
 })();
 
@@ -27,11 +28,12 @@ let homeDir = (() => {
   }
 
   // eslint-disable-next-line @typescript-eslint/no-var-requires
-  require("electron")
-    .ipcRenderer.invoke("getPathHome")
-    .then((path: string) => {
+  const invoke = require("electron")?.ipcRenderer?.invoke;
+  if (typeof invoke === "function") {
+    invoke("getPathHome").then((path: string) => {
       homeDir = path;
     });
+  }
   return "";
 })();
 
@@ -49,7 +51,7 @@ function filepathReplace(path: string): string {
     const p: string = basePaths[name];
     return path
       .replaceAll(p, name) // normal replace of the path
-      .replaceAll(encodeURI(p.replace(/\\/g, "/")), name); // replace of the URI version of the path (that are in file:///)
+      .replaceAll(encodeURI(p.replaceAll("\\", "/")), name); // replace of the URI version of the path (that are in file:///)
   }, path);
   return replaced;
 }

apps/ledger-live-desktop/src/sentry/renderer.ts

@@ -1,18 +1,22 @@
 import * as Sentry from "@sentry/electron/renderer";
-import user from "./../helpers/user";
+import { datadogIdSelector } from "@ledgerhq/client-ids/store";
 import { init, setShouldSendCallback } from "./install";
 import { Primitive } from "@sentry/types";
+import type { Store } from "redux";
+import type { State } from "~/renderer/reducers";
+
 // @ts-expect-error The right type would be SentryMainModule from "@sentry/electron/main"…
 // …but we should avoid importing the whole module and blow the bundle size
 const available = init(Sentry, {
   integrations: [Sentry.browserTracingIntegration()],
 });
-export default async (shouldSendCallback: () => boolean) => {
+
+export default async (shouldSendCallback: () => boolean, store: Store<State>) => {
   if (!available) return;
   setShouldSendCallback(shouldSendCallback);
-  const u = await user();
+  const datadogId = datadogIdSelector(store.getState());
   Sentry.setUser({
-    id: u.id,
+    id: datadogId.exportDatadogIdForSentry(),
     ip_address: undefined,
   });
 };