✨ (dmk) [DSDK-489]: Add WebSocket data source (#608)

Author: jiyuzhuang

.changeset/purple-ears-drop.md

@@ -0,0 +1,5 @@
+---
+"@ledgerhq/device-management-kit": minor
+---
+
+Add WebSocket data source

packages/device-management-kit/package.json

@@ -37,10 +37,12 @@
     "axios": "^1.7.9",
     "inversify": "^6.2.1",
     "inversify-logger-middleware": "^3.1.0",
+    "isomorphic-ws": "^5.0.0",
     "purify-ts": "^2.1.0",
     "reflect-metadata": "^0.2.2",
     "semver": "^7.6.3",
     "uuid": "^11.0.3",
+    "ws": "^8.18.0",
     "xstate": "^5.19.1"
   },
   "peerDependencies": {
@@ -54,6 +56,7 @@
     "@ledgerhq/tsconfig-dsdk": "workspace:*",
     "@types/semver": "^7.5.8",
     "@types/uuid": "^10.0.0",
+    "@types/ws": "^8.5.13",
     "rxjs": "^7.8.1",
     "ts-node": "^10.9.2"
   }

packages/device-management-kit/src/api/DeviceManagementKit.test.ts

@@ -27,6 +27,7 @@ describe("DeviceManagementKit", () => {
         config: {
           managerApiUrl: "http://fake.url",
           mockUrl: "http://fake-mock.url",
+          webSocketUrl: "http://fake-websocket.url",
         },
       });
     });
@@ -85,6 +86,7 @@ describe("DeviceManagementKit", () => {
         config: {
           managerApiUrl: "http://fake.url",
           mockUrl: "http://fake-mock.url",
+          webSocketUrl: "http://fake-websocket.url",
         },
       });
     });

packages/device-management-kit/src/api/DeviceManagementKitBuilder.ts

@@ -1,6 +1,7 @@
 import {
   DEFAULT_MANAGER_API_BASE_URL,
   DEFAULT_MOCK_SERVER_BASE_URL,
+  DEFAULT_WEB_SOCKET_BASE_URL,
 } from "@internal/manager-api/model/Const";
 
 import { type LoggerSubscriberService } from "./logger-subscriber/service/LoggerSubscriberService";
@@ -28,6 +29,7 @@ export class DeviceManagementKitBuilder {
   private config: DmkConfig = {
     managerApiUrl: DEFAULT_MANAGER_API_BASE_URL,
     mockUrl: DEFAULT_MOCK_SERVER_BASE_URL,
+    webSocketUrl: DEFAULT_WEB_SOCKET_BASE_URL,
   };
 
   build(): DeviceManagementKit {

packages/device-management-kit/src/api/DmkConfig.ts

@@ -1,4 +1,5 @@
 export type DmkConfig = {
   mockUrl: string;
   managerApiUrl: string;
+  webSocketUrl: string;
 };

packages/device-management-kit/src/api/command/use-case/SendCommandUseCase.test.ts

@@ -2,6 +2,7 @@ import { Left } from "purify-ts";
 
 import { type Command } from "@api/command/Command";
 import { CommandResultStatus } from "@api/command/model/CommandResult";
+import { type DmkConfig } from "@api/DmkConfig";
 import { type LoggerPublisherService } from "@api/logger-publisher/service/LoggerPublisherService";
 import { deviceSessionStubBuilder } from "@internal/device-session/model/DeviceSession.stub";
 import { DefaultDeviceSessionService } from "@internal/device-session/service/DefaultDeviceSessionService";
@@ -25,10 +26,7 @@ describe("SendCommandUseCase", () => {
   beforeEach(() => {
     logger = new DefaultLoggerPublisherService([], "send-command-use-case");
     sessionService = new DefaultDeviceSessionService(() => logger);
-    managerApiDataSource = new AxiosManagerApiDataSource({
-      managerApiUrl: "http://fake.url",
-      mockUrl: "http://fake-mock.url",
-    });
+    managerApiDataSource = new AxiosManagerApiDataSource({} as DmkConfig);
     managerApi = new DefaultManagerApiService(managerApiDataSource);
     command = {
       getApdu: jest.fn(),

packages/device-management-kit/src/api/device-session/use-case/ToggleDeviceSessionRefresher.test.ts

@@ -1,3 +1,4 @@
+import { type DmkConfig } from "@api/DmkConfig";
 import { type LoggerPublisherService } from "@api/logger-publisher/service/LoggerPublisherService";
 import { type DeviceSession } from "@internal/device-session/model/DeviceSession";
 import { deviceSessionStubBuilder } from "@internal/device-session/model/DeviceSession.stub";
@@ -24,10 +25,7 @@ describe("ToggleDeviceSessionRefresherUseCase", () => {
     );
     sessionService = new DefaultDeviceSessionService(() => logger);
     managerApi = new DefaultManagerApiService(
-      new AxiosManagerApiDataSource({
-        managerApiUrl: "http://fake.url",
-        mockUrl: "http://fake-mock.url",
-      }),
+      new AxiosManagerApiDataSource({} as DmkConfig),
     );
   });
 

packages/device-management-kit/src/di.ts

@@ -16,6 +16,7 @@ import { managerApiModuleFactory } from "@internal/manager-api/di/managerApiModu
 import {
   DEFAULT_MANAGER_API_BASE_URL,
   DEFAULT_MOCK_SERVER_BASE_URL,
+  DEFAULT_WEB_SOCKET_BASE_URL,
 } from "@internal/manager-api/model/Const";
 import { sendModuleFactory } from "@internal/send/di/sendModule";
 import { transportModuleFactory } from "@internal/transport//di/transportModule";
@@ -35,8 +36,9 @@ export const makeContainer = ({
   transports = [],
   loggers = [],
   config = {
-    managerApiUrl: DEFAULT_MANAGER_API_BASE_URL,
     mockUrl: DEFAULT_MOCK_SERVER_BASE_URL,
+    managerApiUrl: DEFAULT_MANAGER_API_BASE_URL,
+    webSocketUrl: DEFAULT_WEB_SOCKET_BASE_URL,
   },
 }: Partial<MakeContainerProps>) => {
   const container = new Container();

packages/device-management-kit/src/internal/device-session/service/DefaultDeviceSessionService.test.ts

@@ -1,6 +1,7 @@
 import { Either, Left } from "purify-ts";
 import { Observable } from "rxjs";
 
+import { type DmkConfig } from "@api/DmkConfig";
 import { type DeviceSession } from "@internal/device-session/model/DeviceSession";
 import { deviceSessionStubBuilder } from "@internal/device-session/model/DeviceSession.stub";
 import { DeviceSessionNotFound } from "@internal/device-session/model/Errors";
@@ -25,10 +26,7 @@ describe("DefaultDeviceSessionService", () => {
     jest.restoreAllMocks();
     loggerService = new DefaultLoggerPublisherService([], "deviceSession");
     sessionService = new DefaultDeviceSessionService(() => loggerService);
-    managerApiDataSource = new AxiosManagerApiDataSource({
-      managerApiUrl: "http://fake.url",
-      mockUrl: "http://fake-mock.url",
-    });
+    managerApiDataSource = new AxiosManagerApiDataSource({} as DmkConfig);
     managerApi = new DefaultManagerApiService(managerApiDataSource);
 
     deviceSession = deviceSessionStubBuilder(

packages/device-management-kit/src/internal/device-session/use-case/CloseSessionsUseCase.test.ts

@@ -1,3 +1,4 @@
+import { type DmkConfig } from "@api/DmkConfig";
 import { type LoggerPublisherService } from "@api/logger-publisher/service/LoggerPublisherService";
 import { deviceSessionStubBuilder } from "@internal/device-session/model/DeviceSession.stub";
 import { DefaultDeviceSessionService } from "@internal/device-session/service/DefaultDeviceSessionService";
@@ -20,10 +21,7 @@ describe("CloseSessionsUseCase", () => {
       [],
       "close-sessions-use-case-test",
     );
-    managerApiDataSource = new AxiosManagerApiDataSource({
-      managerApiUrl: "http://fake.url",
-      mockUrl: "http://fake-mock.url",
-    });
+    managerApiDataSource = new AxiosManagerApiDataSource({} as DmkConfig);
     managerApi = new DefaultManagerApiService(managerApiDataSource);
     sessionService = new DefaultDeviceSessionService(() => logger);
   });

packages/device-management-kit/src/internal/device-session/use-case/GetDeviceSessionStateUseCase.test.ts

@@ -1,3 +1,4 @@
+import { type DmkConfig } from "@api/DmkConfig";
 import { type LoggerPublisherService } from "@api/logger-publisher/service/LoggerPublisherService";
 import { deviceSessionStubBuilder } from "@internal/device-session/model/DeviceSession.stub";
 import { DeviceSessionNotFound } from "@internal/device-session/model/Errors";
@@ -26,10 +27,7 @@ describe("GetDeviceSessionStateUseCase", () => {
       [],
       "get-connected-device-use-case-test",
     );
-    managerApiDataSource = new AxiosManagerApiDataSource({
-      managerApiUrl: "http://fake.url",
-      mockUrl: "http://fake-mock.url",
-    });
+    managerApiDataSource = new AxiosManagerApiDataSource({} as DmkConfig);
     managerApi = new DefaultManagerApiService(managerApiDataSource);
     sessionService = new DefaultDeviceSessionService(() => logger);
   });

packages/device-management-kit/src/internal/discovery/di/discoveryModule.test.ts

@@ -39,6 +39,7 @@ describe("discoveryModuleFactory", () => {
         config: {
           managerApiUrl: "http://fake.url",
           mockUrl: "http://fake-mock.url",
+          webSocketUrl: "http://fake-websocket.url",
         },
       }),
     );

packages/device-management-kit/src/internal/discovery/use-case/ConnectUseCase.test.ts

@@ -6,7 +6,7 @@ import { TransportMock } from "@api/transport/model/__mocks__/TransportMock";
 import { type DiscoveredDevice } from "@api/transport/model/DiscoveredDevice";
 import { UnknownDeviceError } from "@api/transport/model/Errors";
 import { connectedDeviceStubBuilder } from "@api/transport/model/TransportConnectedDevice.stub";
-import { type Transport } from "@api/types";
+import type { DmkConfig, Transport } from "@api/types";
 import { DefaultDeviceSessionService } from "@internal/device-session/service/DefaultDeviceSessionService";
 import { type DeviceSessionService } from "@internal/device-session/service/DeviceSessionService";
 import { DefaultLoggerPublisherService } from "@internal/logger-publisher/service/DefaultLoggerPublisherService";
@@ -48,10 +48,7 @@ describe("ConnectUseCase", () => {
     logger = new DefaultLoggerPublisherService([], tag);
     transport = new TransportMock();
     sessionService = new DefaultDeviceSessionService(() => logger);
-    managerApiDataSource = new AxiosManagerApiDataSource({
-      managerApiUrl: "http://fake.url",
-      mockUrl: "http://fake-mock.url",
-    });
+    managerApiDataSource = new AxiosManagerApiDataSource({} as DmkConfig);
     managerApi = new DefaultManagerApiService(managerApiDataSource);
     // @ts-expect-error mock
     transportService = new DefaultTransportService();

packages/device-management-kit/src/internal/discovery/use-case/DisconnectUseCase.test.ts

@@ -3,7 +3,7 @@ import { Left, Maybe, Right } from "purify-ts";
 import { TransportMock } from "@api/transport/model/__mocks__/TransportMock";
 import { DisconnectError } from "@api/transport/model/Errors";
 import { connectedDeviceStubBuilder } from "@api/transport/model/TransportConnectedDevice.stub";
-import { type Transport } from "@api/types";
+import type { DmkConfig, Transport } from "@api/types";
 import { deviceSessionStubBuilder } from "@internal/device-session/model/DeviceSession.stub";
 import { DeviceSessionNotFound } from "@internal/device-session/model/Errors";
 import { DefaultDeviceSessionService } from "@internal/device-session/service/DefaultDeviceSessionService";
@@ -49,10 +49,7 @@ describe("DisconnectUseCase", () => {
   it("should disconnect from a device", async () => {
     // Given
     const connectedDevice = connectedDeviceStubBuilder();
-    managerApiDataSource = new AxiosManagerApiDataSource({
-      managerApiUrl: "http://fake.url",
-      mockUrl: "http://fake-mock.url",
-    });
+    managerApiDataSource = new AxiosManagerApiDataSource({} as DmkConfig);
     managerApi = new DefaultManagerApiService(managerApiDataSource);
     const deviceSession = deviceSessionStubBuilder(
       {

packages/device-management-kit/src/internal/discovery/use-case/GetConnectedDeviceUseCase.test.ts

@@ -1,3 +1,4 @@
+import { type DmkConfig } from "@api/DmkConfig";
 import { type LoggerPublisherService } from "@api/logger-publisher/service/LoggerPublisherService";
 import { ConnectedDevice } from "@api/transport/model/ConnectedDevice";
 import { deviceSessionStubBuilder } from "@internal/device-session/model/DeviceSession.stub";
@@ -26,10 +27,7 @@ describe("GetConnectedDevice", () => {
       [],
       "get-connected-device-use-case",
     );
-    managerApiDataSource = new AxiosManagerApiDataSource({
-      managerApiUrl: "http://fake.url",
-      mockUrl: "http://fake-mock.url",
-    });
+    managerApiDataSource = new AxiosManagerApiDataSource({} as DmkConfig);
     managerApi = new DefaultManagerApiService(managerApiDataSource);
     sessionService = new DefaultDeviceSessionService(() => logger);
   });

packages/device-management-kit/src/internal/discovery/use-case/ListConnectedDevicesUseCase.test.ts

@@ -8,7 +8,7 @@ import { AxiosManagerApiDataSource } from "@internal/manager-api/data/AxiosManag
 import { type ManagerApiDataSource } from "@internal/manager-api/data/ManagerApiDataSource";
 import { DefaultManagerApiService } from "@internal/manager-api/service/DefaultManagerApiService";
 import { type ManagerApiService } from "@internal/manager-api/service/ManagerApiService";
-import { ConnectedDevice } from "@root/src";
+import { ConnectedDevice, type DmkConfig } from "@root/src";
 
 let logger: LoggerPublisherService;
 let sessionService: DeviceSessionService;
@@ -21,10 +21,7 @@ describe("ListDeviceSessionsUseCase", () => {
       [],
       "list-device-sessions-use-case-test",
     );
-    managerApiDataSource = new AxiosManagerApiDataSource({
-      managerApiUrl: "http://fake.url",
-      mockUrl: "http://fake-mock.url",
-    });
+    managerApiDataSource = new AxiosManagerApiDataSource({} as DmkConfig);
     managerApi = new DefaultManagerApiService(managerApiDataSource);
     sessionService = new DefaultDeviceSessionService(() => logger);
   });

packages/device-management-kit/src/internal/discovery/use-case/ListenToConnectedDeviceUseCase.test.ts

@@ -1,3 +1,4 @@
+import { type DmkConfig } from "@api/DmkConfig";
 import { type LoggerPublisherService } from "@api/logger-publisher/service/LoggerPublisherService";
 import { ConnectedDevice } from "@api/transport/model/ConnectedDevice";
 import { connectedDeviceStubBuilder } from "@api/transport/model/TransportConnectedDevice.stub";
@@ -26,10 +27,7 @@ describe("ListenToConnectedDevice", () => {
       [],
       "listen-to-connected-device-use-case",
     );
-    managerApiDataSource = new AxiosManagerApiDataSource({
-      managerApiUrl: "http://fake.url",
-      mockUrl: "http://fake-mock.url",
-    });
+    managerApiDataSource = new AxiosManagerApiDataSource({} as DmkConfig);
     managerApi = new DefaultManagerApiService(managerApiDataSource);
     sessionService = new DefaultDeviceSessionService(() => logger);
   });