@ledgerhq/live-common 34.52.0 → 34.52.1

package/src/hw/getOnboardingStatePolling.ts

@@ -28,6 +28,7 @@ export type GetOnboardingStatePollingResult = Observable<OnboardingStatePollingR
 
 export type GetOnboardingStatePollingArgs = {
   deviceId: string;
+  deviceName: string | null;
   pollingPeriodMs: number;
   transportAbortTimeoutMs?: number;
   safeGuardTimeoutMs?: number;
@@ -51,15 +52,17 @@ export type GetOnboardingStatePollingArgs = {
  */
 export const getOnboardingStatePolling = ({
   deviceId,
+  deviceName,
   pollingPeriodMs,
   transportAbortTimeoutMs = pollingPeriodMs - 100,
   safeGuardTimeoutMs = pollingPeriodMs * 10, // Nb Empirical value
   allowedErrorChecks = [],
 }: GetOnboardingStatePollingArgs): GetOnboardingStatePollingResult => {
   const getOnboardingStateOnce = (): Observable<OnboardingStatePollingResult> => {
-    return withDevice(deviceId, { openTimeoutMs: transportAbortTimeoutMs })(t =>
-      from(getVersion(t, { abortTimeoutMs: transportAbortTimeoutMs })),
-    ).pipe(
+    return withDevice(deviceId, {
+      openTimeoutMs: transportAbortTimeoutMs,
+      matchDeviceByName: deviceName ?? undefined,
+    })(t => from(getVersion(t, { abortTimeoutMs: transportAbortTimeoutMs }))).pipe(
       timeout(safeGuardTimeoutMs), // Throws a TimeoutError
       first(),
       catchError((error: unknown) => {

package/src/hw/hooks/useGenuineCheck.test.ts

@@ -37,6 +37,7 @@ describe("useGenuineCheck", () => {
         useGenuineCheck({
           getGenuineCheckFromDeviceId: mockedGetGenuineCheckFromDeviceId,
           deviceId: "A_DEVICE_ID",
+          deviceName: null,
         }),
       );
 
@@ -60,6 +61,7 @@ describe("useGenuineCheck", () => {
         useGenuineCheck({
           getGenuineCheckFromDeviceId: mockedGetGenuineCheckFromDeviceId,
           deviceId: "A_DEVICE_ID",
+          deviceName: null,
         }),
       );
 
@@ -80,6 +82,7 @@ describe("useGenuineCheck", () => {
         useGenuineCheck({
           getGenuineCheckFromDeviceId: mockedGetGenuineCheckFromDeviceId,
           deviceId: "A_DEVICE_ID",
+          deviceName: null,
         }),
       );
 
@@ -102,6 +105,7 @@ describe("useGenuineCheck", () => {
         useGenuineCheck({
           getGenuineCheckFromDeviceId: mockedGetGenuineCheckFromDeviceId,
           deviceId: "A_DEVICE_ID",
+          deviceName: null,
         }),
       );
 
@@ -127,6 +131,7 @@ describe("useGenuineCheck", () => {
           useGenuineCheck({
             getGenuineCheckFromDeviceId: mockedGetGenuineCheckFromDeviceId,
             deviceId: "A_DEVICE_ID",
+            deviceName: null,
           }),
         );
 
@@ -151,6 +156,7 @@ describe("useGenuineCheck", () => {
           useGenuineCheck({
             getGenuineCheckFromDeviceId: mockedGetGenuineCheckFromDeviceId,
             deviceId: "A_DEVICE_ID",
+            deviceName: null,
           }),
         );
 
@@ -185,6 +191,7 @@ describe("useGenuineCheck", () => {
           getGenuineCheckFromDeviceId: mockedGetGenuineCheckFromDeviceId,
           isHookEnabled: true,
           deviceId: "A_DEVICE_ID",
+          deviceName: null,
         }),
       );
 
@@ -220,6 +227,7 @@ describe("useGenuineCheck", () => {
         useGenuineCheck({
           getGenuineCheckFromDeviceId: mockedGetGenuineCheckFromDeviceId,
           deviceId: "A_DEVICE_ID",
+          deviceName: null,
         }),
       );
 
@@ -250,6 +258,7 @@ describe("useGenuineCheck", () => {
         useGenuineCheck({
           getGenuineCheckFromDeviceId: mockedGetGenuineCheckFromDeviceId,
           deviceId: "A_DEVICE_ID",
+          deviceName: null,
           permissionTimeoutMs,
         }),
       );
@@ -288,6 +297,7 @@ describe("useGenuineCheck", () => {
         useGenuineCheck({
           getGenuineCheckFromDeviceId: mockedGetGenuineCheckFromDeviceId,
           deviceId: "A_DEVICE_ID",
+          deviceName: null,
         }),
       );
 
@@ -300,4 +310,31 @@ describe("useGenuineCheck", () => {
       expect(result.current.error).toBeNull();
     });
   });
+
+  describe("When deviceName is provided", () => {
+    it("should pass deviceName to getGenuineCheckFromDeviceId", async () => {
+      const mockGetGenuineCheck = jest.fn().mockReturnValue(
+        of({
+          socketEvent: { type: "device-permission-granted" },
+          lockedDevice: false,
+        }),
+      );
+
+      renderHook(() =>
+        useGenuineCheck({
+          getGenuineCheckFromDeviceId: mockGetGenuineCheck,
+          deviceId: "A_DEVICE_ID",
+          deviceName: "My Device",
+        }),
+      );
+
+      await act(async () => {
+        jest.advanceTimersByTime(1);
+      });
+
+      expect(mockGetGenuineCheck).toHaveBeenCalledWith(
+        expect.objectContaining({ deviceName: "My Device" }),
+      );
+    });
+  });
 });

package/src/hw/hooks/useGenuineCheck.ts

@@ -22,6 +22,7 @@ export type DevicePermissionState =
 export type UseGenuineCheckArgs = {
   isHookEnabled?: boolean;
   deviceId: DeviceId;
+  deviceName: string | null;
   lockedDeviceTimeoutMs?: number;
   permissionTimeoutMs?: number;
 };
@@ -70,6 +71,7 @@ export const useGenuineCheck = ({
   getGenuineCheckFromDeviceId = defaultGetGenuineCheckFromDeviceId,
   isHookEnabled = true,
   deviceId,
+  deviceName,
   lockedDeviceTimeoutMs = 1000,
   permissionTimeoutMs = 60 * 1000,
 }: UseGenuineCheckArgs & UseGenuineCheckDependencies): UseGenuineCheckResult => {
@@ -92,6 +94,7 @@ export const useGenuineCheck = ({
 
     const sub = getGenuineCheckFromDeviceId({
       deviceId,
+      deviceName,
       lockedDeviceTimeoutMs,
     }).subscribe({
       next: ({ socketEvent, lockedDevice }: GetGenuineCheckFromDeviceIdResult) => {
@@ -146,6 +149,7 @@ export const useGenuineCheck = ({
   }, [
     isHookEnabled,
     deviceId,
+    deviceName,
     lockedDeviceTimeoutMs,
     getGenuineCheckFromDeviceId,
     permissionTimeoutMs,

package/src/hw/index.test.ts

@@ -9,7 +9,7 @@ describe("open", () => {
     it("should reject with a CantOpenDevice error", async () => {
       registerTransportModule({
         id: "test_0",
-        open: (_id: string, _timeoutMs?: number) => {
+        open: (_id: string, _timeoutMs?: number, _context?, _matchDeviceByName?: string) => {
           // Handles no device
           return null;
         },
@@ -27,7 +27,7 @@ describe("open", () => {
     it("should return the associated opened Transport instance", async () => {
       registerTransportModule({
         id: "test_1",
-        open: (id: string, _timeoutMs?: number) => {
+        open: (id: string, _timeoutMs?: number, _context?, _matchDeviceByName?: string) => {
           // Filters on this current test
           if (id !== "device_1") return null;
 
@@ -47,7 +47,7 @@ describe("open", () => {
     it("should reject with an error on timeout", async () => {
       registerTransportModule({
         id: "test_2",
-        open: (id: string, timeoutMs?: number) => {
+        open: (id: string, timeoutMs?: number, _context?, _matchDeviceByName?: string) => {
           // Filters on this current test
           if (id !== "device_2") return null;
 
@@ -63,7 +63,7 @@ describe("open", () => {
 
       const timeoutMs = 1000;
 
-      const openPromise = open("device_2", timeoutMs);
+      const openPromise = open("device_2", { openTimeoutMs: timeoutMs });
       jest.advanceTimersByTime(timeoutMs);
       await expect(openPromise).rejects.toBeInstanceOf(CantOpenDevice);
     });
@@ -71,7 +71,7 @@ describe("open", () => {
     test("And the Transport/module implementation timeouts before open, it should still reject with an error", async () => {
       registerTransportModule({
         id: "test_3",
-        open: (id: string, timeoutMs?: number) => {
+        open: (id: string, timeoutMs?: number, _context?, _matchDeviceByName?: string) => {
           // Filters on this current test
           if (id !== "device_3") return null;
 
@@ -88,10 +88,31 @@ describe("open", () => {
 
       const timeoutMs = 1000;
 
-      const openPromise = open("device_3", timeoutMs);
+      const openPromise = open("device_3", { openTimeoutMs: timeoutMs });
       // Advances time after the implementation timeout but before the `open` timeout
       jest.advanceTimersByTime(timeoutMs - 100);
       await expect(openPromise).rejects.toBeInstanceOf(TransportError);
     });
   });
+
+  describe("When matchDeviceByName is provided", () => {
+    it("should pass matchDeviceByName to the transport module open function", async () => {
+      const mockOpen = jest.fn(
+        (_id: string, _timeoutMs?: number, _context?, _matchDeviceByName?: string) => {
+          return Promise.resolve(aTransportBuilder());
+        },
+      );
+
+      registerTransportModule({
+        id: "test_4",
+        open: mockOpen,
+        disconnect: (_id: string) => {
+          return Promise.resolve();
+        },
+      });
+
+      await open("device_4", { matchDeviceByName: "My Device" });
+      expect(mockOpen).toHaveBeenCalledWith("device_4", undefined, undefined, "My Device");
+    });
+  });
 });

package/src/hw/index.ts

@@ -17,6 +17,7 @@ export type DeviceEvent = {
 };
 
 export type Discovery = Observable<DeviceEvent>;
+
 // NB open/close/disconnect semantic will have to be refined...
 export type TransportModule = {
   // unique transport name that identify the transport module
@@ -35,6 +36,7 @@ export type TransportModule = {
     id: string,
     timeoutMs?: number,
     context?: TraceContext,
+    matchDeviceByName?: string,
   ) => Promise<Transport> | null | undefined;
   // here, close means we want to STOP doing something with the transport
   close?: (transport: Transport, id: string) => Promise<void> | null | undefined;
@@ -88,6 +90,11 @@ export const discoverDevices = (
   );
 };
 
+export type OpenOptions = {
+  openTimeoutMs?: number;
+  matchDeviceByName?: string;
+};
+
 /**
  * Tries to call `open` on the 1st matching registered transport implementation
  *
@@ -109,7 +116,7 @@ export const discoverDevices = (
  */
 export const open = (
   deviceId: string,
-  timeoutMs?: number,
+  options?: OpenOptions,
   context?: TraceContext,
 ): Promise<Transport> => {
   // The first registered Transport (TransportModule) accepting the given device will be returned.
@@ -117,16 +124,16 @@ export const open = (
   // A TransportModule can check the prefix of the device id to guess if it should use USB or not on LLM for ex.
   for (let i = 0; i < modules.length; i++) {
     const m = modules[i];
-    const p = m.open(deviceId, timeoutMs, context);
+    const p = m.open(deviceId, options?.openTimeoutMs, context, options?.matchDeviceByName);
     if (p) {
       trace({
         type: LOG_TYPE,
         message: `Found a matching Transport: ${m.id}`,
         context,
-        data: { timeoutMs },
+        data: { options },
       });
 
-      if (!timeoutMs) {
+      if (!options?.openTimeoutMs) {
         return p;
       }
 
@@ -144,18 +151,18 @@ export const open = (
 
           return transport;
         }),
-        new Promise((_resolve, reject) => {
+        new Promise<never>((_resolve, reject) => {
           timer = setTimeout(() => {
             trace({
               type: LOG_TYPE,
-              message: `Could not open registered transport ${m.id} on ${deviceId}, timed out after ${timeoutMs}ms`,
+              message: `Could not open registered transport ${m.id} on ${deviceId}, timed out after ${options?.openTimeoutMs}ms`,
               context,
             });
 
             return reject(new CantOpenDevice(`Timeout while opening device on transport ${m.id}`));
-          }, timeoutMs);
+          }, options?.openTimeoutMs);
         }),
-      ]) as Promise<Transport>;
+      ]);
     }
   }
   return Promise.reject(new CantOpenDevice(`Cannot find registered transport to open ${deviceId}`));

package/src/hw/installLanguage.ts

@@ -36,16 +36,21 @@ export type InstallLanguageEvent =
 export type InstallLanguageRequest = { language: Language };
 export type Input = {
   deviceId: string;
+  deviceName: string | null;
   request: InstallLanguageRequest;
 };
 
 export default function installLanguage({
   deviceId,
+  deviceName,
   request,
 }: Input): Observable<InstallLanguageEvent> {
   const { language } = request;
 
-  const sub = withDevice(deviceId)(
+  const sub = withDevice(
+    deviceId,
+    deviceName ? { matchDeviceByName: deviceName } : undefined,
+  )(
     transport =>
       new Observable(subscriber => {
         const timeoutSub = of<InstallLanguageEvent>({

package/src/onboarding/hooks/useOnboardingStatePolling.ts

@@ -65,6 +65,7 @@ export const useOnboardingStatePolling = ({
     if (device && !stopPolling) {
       onboardingStatePollingSubscription = getOnboardingStatePolling({
         deviceId: device.deviceId,
+        deviceName: device.deviceName ?? null,
         pollingPeriodMs,
         allowedErrorChecks,
       }).subscribe({