♻️ (core) [DSDK-290]: Session refinements (#75)

LedgerHQ · May 15, 2024 · b512289 · b512289
2 parents a807f59 + 56cb882
commit b512289
Show file tree

Hide file tree

Showing 41 changed files with 432 additions and 407 deletions.
diff --git a/.changeset/curly-knives-design.md b/.changeset/curly-knives-design.md
@@ -0,0 +1,5 @@
+---
+"@ledgerhq/device-sdk-core": patch
+---
+
+Naming DeviceSession
diff --git a/apps/sample/src/app/client-layout.tsx b/apps/sample/src/app/client-layout.tsx
@@ -16,7 +16,7 @@ import styled, { DefaultTheme } from "styled-components";
 import { Header } from "@/components/Header";
 import { Sidebar } from "@/components/Sidebar";
 import { SdkProvider } from "@/providers/DeviceSdkProvider";
-import { SessionProvider } from "@/providers/SessionsProvider";
+import { DeviceSessionsProvider } from "@/providers/DeviceSessionsProvider";
 import { GlobalStyle } from "@/styles/globalstyles";
 
 type ClientRootLayoutProps = {
@@ -45,13 +45,13 @@ const ClientRootLayout: React.FC<ClientRootLayoutProps> = ({ children }) => {
           <GlobalStyle />
           <body>
             <Root>
-              <SessionProvider>
+              <DeviceSessionsProvider>
                 <Sidebar />
                 <PageContainer>
                   <Header />
                   {children}
                 </PageContainer>
-              </SessionProvider>
+              </DeviceSessionsProvider>
             </Root>
           </body>
         </StyleProvider>

diff --git a/apps/sample/src/components/ApduView/index.tsx b/apps/sample/src/components/ApduView/index.tsx
@@ -5,7 +5,7 @@ import styled, { DefaultTheme } from "styled-components";
 
 import { useApduForm } from "@/hooks/useApduForm";
 import { useSdk } from "@/providers/DeviceSdkProvider";
-import { useSessionContext } from "@/providers/SessionsProvider";
+import { useDeviceSessionsContext } from "@/providers/DeviceSessionsProvider";
 
 const Root = styled(Flex).attrs({ mx: 15, mt: 10, mb: 5 })`
   flex-direction: column;
@@ -70,7 +70,7 @@ export const ApduView: React.FC = () => {
   const sdk = useSdk();
   const {
     state: { selectedId: selectedSessionId },
-  } = useSessionContext();
+  } = useDeviceSessionsContext();
   const onSubmit = useCallback(
     async (values: typeof apduFormValues) => {
       setLoading(true);

diff --git a/apps/sample/src/components/Device/index.tsx b/apps/sample/src/components/Device/index.tsx
@@ -2,12 +2,12 @@ import React from "react";
 import {
   ConnectionType,
   DeviceModelId,
-  SessionId,
+  DeviceSessionId,
 } from "@ledgerhq/device-sdk-core";
 import { Box, DropdownGeneric, Flex, Icons, Text } from "@ledgerhq/react-ui";
 import styled, { DefaultTheme } from "styled-components";
 
-import { useSessionState } from "@/hooks/useSessionState";
+import { useDeviceSessionState } from "@/hooks/useDeviceSessionState";
 
 import { StatusText } from "./StatusText";
 
@@ -38,7 +38,7 @@ const ActionRow = styled(Flex).attrs({ py: 4, px: 2 })`
 type DeviceProps = {
   name: string;
   type: ConnectionType;
-  sessionId: SessionId;
+  sessionId: DeviceSessionId;
   model: DeviceModelId;
   onDisconnect: () => Promise<void>;
 };
@@ -50,7 +50,7 @@ export const Device: React.FC<DeviceProps> = ({
   onDisconnect,
   sessionId,
 }) => {
-  const sessionState = useSessionState(sessionId);
+  const sessionState = useDeviceSessionState(sessionId);
   return (
     <Root>
       <IconContainer>

diff --git a/apps/sample/src/components/MainView/index.tsx b/apps/sample/src/components/MainView/index.tsx
@@ -4,7 +4,7 @@ import Image from "next/image";
 import styled, { DefaultTheme } from "styled-components";
 
 import { useSdk } from "@/providers/DeviceSdkProvider";
-import { useSessionContext } from "@/providers/SessionsProvider";
+import { useDeviceSessionsContext } from "@/providers/DeviceSessionsProvider";
 
 const Root = styled(Flex)`
   flex: 1;
@@ -23,7 +23,7 @@ const NanoLogo = styled(Image).attrs({ mb: 8 })`
 
 export const MainView: React.FC = () => {
   const sdk = useSdk();
-  const { dispatch } = useSessionContext();
+  const { dispatch } = useDeviceSessionsContext();
 
   // Example starting the discovery on a user action
   const onSelectDeviceClicked = useCallback(() => {

diff --git a/apps/sample/src/components/Sidebar/index.tsx b/apps/sample/src/components/Sidebar/index.tsx
@@ -7,7 +7,7 @@ import styled, { DefaultTheme } from "styled-components";
 import { Device } from "@/components/Device";
 import { Menu } from "@/components/Menu";
 import { useSdk } from "@/providers/DeviceSdkProvider";
-import { useSessionContext } from "@/providers/SessionsProvider";
+import { useDeviceSessionsContext } from "@/providers/DeviceSessionsProvider";
 
 const Root = styled(Flex).attrs({ py: 8, px: 6 })`
   flex-direction: column;
@@ -46,7 +46,7 @@ export const Sidebar: React.FC = () => {
   const {
     state: { deviceById },
     dispatch,
-  } = useSessionContext();
+  } = useDeviceSessionsContext();
 
   useEffect(() => {
     sdk

diff --git a/apps/sample/src/hooks/useSessionState.ts → ...sample/src/hooks/useDeviceSessionState.ts b/apps/sample/src/hooks/useSessionState.ts → ...sample/src/hooks/useDeviceSessionState.ts
@@ -1,21 +1,22 @@
 import { useEffect, useState } from "react";
-import { SessionDeviceState, SessionId } from "@ledgerhq/device-sdk-core";
+import { DeviceSessionId, DeviceSessionState } from "@ledgerhq/device-sdk-core";
 
 import { useSdk } from "@/providers/DeviceSdkProvider";
 
-export function useSessionState(sessionId: SessionId) {
+export function useDeviceSessionState(sessionId: DeviceSessionId) {
   const sdk = useSdk();
-  const [sessionState, setSessionState] = useState<SessionDeviceState>();
+  const [deviceSessionState, setDeviceSessionState] =
+    useState<DeviceSessionState>();
 
   useEffect(() => {
     if (sessionId) {
       const subscription = sdk
-        .getSessionDeviceState({
+        .getDeviceSessionState({
           sessionId,
         })
         .subscribe((state) => {
           // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
-          setSessionState(state);
+          setDeviceSessionState(state);
         });
 
       return () => {
@@ -24,5 +25,5 @@ export function useSessionState(sessionId: SessionId) {
     }
   }, [sessionId, sdk]);
 
-  return sessionState;
+  return deviceSessionState;
 }
diff --git a/apps/sample/src/providers/DeviceSessionsProvider/index.tsx b/apps/sample/src/providers/DeviceSessionsProvider/index.tsx
@@ -0,0 +1,38 @@
+import React, { Context, createContext, useContext, useReducer } from "react";
+
+import {
+  AddSessionAction,
+  DeviceSessionsInitialState,
+  deviceSessionsReducer,
+  DeviceSessionsState,
+  RemoveSessionAction,
+} from "@/reducers/deviceSessions";
+
+type DeviceSessionsContextType = {
+  state: DeviceSessionsState;
+  dispatch: (value: AddSessionAction | RemoveSessionAction) => void;
+};
+
+const DeviceSessionsContext: Context<DeviceSessionsContextType> =
+  createContext<DeviceSessionsContextType>({
+    state: DeviceSessionsInitialState,
+    dispatch: () => null,
+  });
+
+export const DeviceSessionsProvider: React.FC<React.PropsWithChildren> = ({
+  children,
+}) => {
+  const [state, dispatch] = useReducer(
+    deviceSessionsReducer,
+    DeviceSessionsInitialState,
+  );
+
+  return (
+    <DeviceSessionsContext.Provider value={{ state, dispatch }}>
+      {children}
+    </DeviceSessionsContext.Provider>
+  );
+};
+
+export const useDeviceSessionsContext = () =>
+  useContext<DeviceSessionsContextType>(DeviceSessionsContext);
diff --git a/apps/sample/src/providers/SessionsProvider/index.tsx b/apps/sample/src/providers/SessionsProvider/index.tsx
diff --git a/apps/sample/src/reducers/sessions.ts → apps/sample/src/reducers/deviceSessions.ts b/apps/sample/src/reducers/sessions.ts → apps/sample/src/reducers/deviceSessions.ts
@@ -1,28 +1,28 @@
 import { Reducer } from "react";
-import { ConnectedDevice, SessionId } from "@ledgerhq/device-sdk-core";
+import { ConnectedDevice, DeviceSessionId } from "@ledgerhq/device-sdk-core";
 
-export type SessionsState = {
-  selectedId: SessionId | null;
-  deviceById: Record<SessionId, ConnectedDevice>;
+export type DeviceSessionsState = {
+  selectedId: DeviceSessionId | null;
+  deviceById: Record<DeviceSessionId, ConnectedDevice>;
 };
 
 export type AddSessionAction = {
   type: "add_session";
-  payload: { sessionId: SessionId; connectedDevice: ConnectedDevice };
+  payload: { sessionId: DeviceSessionId; connectedDevice: ConnectedDevice };
 };
 
 export type RemoveSessionAction = {
   type: "remove_session";
-  payload: { sessionId: SessionId };
+  payload: { sessionId: DeviceSessionId };
 };
 
-export const SessionsInitialState: SessionsState = {
+export const DeviceSessionsInitialState: DeviceSessionsState = {
   selectedId: null,
   deviceById: {},
 };
 
-export const sessionsReducer: Reducer<
-  SessionsState,
+export const deviceSessionsReducer: Reducer<
+  DeviceSessionsState,
   AddSessionAction | RemoveSessionAction
 > = (state, action) => {
   switch (action.type) {

diff --git a/packages/core/src/api/DeviceSdk.test.ts b/packages/core/src/api/DeviceSdk.test.ts
@@ -87,7 +87,7 @@ describe("DeviceSdk", () => {
       [commandTypes.SendCommandUseCase],
       [usbDiTypes.GetConnectedDeviceUseCase],
       [discoveryTypes.DisconnectUseCase],
-      [deviceSessionTypes.GetSessionDeviceStateUseCase],
+      [deviceSessionTypes.GetDeviceSessionStateUseCase],
     ])("should have %p use case", (diSymbol) => {
       const uc = sdk.container.get<StubUseCase>(diSymbol);
       expect(uc).toBeInstanceOf(StubUseCase);

diff --git a/packages/core/src/api/DeviceSdk.ts b/packages/core/src/api/DeviceSdk.ts
@@ -6,14 +6,14 @@ import {
   SendCommandUseCase,
   SendCommandUseCaseArgs,
 } from "@api/command/use-case/SendCommandUseCase";
-import { SessionDeviceState } from "@api/session/SessionDeviceState";
-import { SessionId } from "@api/session/types";
+import { DeviceSessionState } from "@api/device-session/DeviceSessionState";
+import { DeviceSessionId } from "@api/device-session/types";
 import { ConnectedDevice } from "@api/usb/model/ConnectedDevice";
 import { configTypes } from "@internal/config/di/configTypes";
 import { GetSdkVersionUseCase } from "@internal/config/use-case/GetSdkVersionUseCase";
 import { deviceSessionTypes } from "@internal/device-session/di/deviceSessionTypes";
 import { ApduResponse } from "@internal/device-session/model/ApduResponse";
-import { GetSessionDeviceStateUseCase } from "@internal/device-session/use-case/GetSessionDeviceStateUseCase";
+import { GetDeviceSessionStateUseCase } from "@internal/device-session/use-case/GetDeviceSessionStateUseCase";
 import { discoveryTypes } from "@internal/discovery/di/discoveryTypes";
 import {
   ConnectUseCase,
@@ -66,7 +66,7 @@ export class DeviceSdk {
       .execute();
   }
 
-  connect(args: ConnectUseCaseArgs): Promise<SessionId> {
+  connect(args: ConnectUseCaseArgs): Promise<DeviceSessionId> {
     return this.container
       .get<ConnectUseCase>(discoveryTypes.ConnectUseCase)
       .execute(args);
@@ -96,12 +96,12 @@ export class DeviceSdk {
       .execute(args);
   }
 
-  getSessionDeviceState(args: {
-    sessionId: SessionId;
-  }): Observable<SessionDeviceState> {
+  getDeviceSessionState(args: {
+    sessionId: DeviceSessionId;
+  }): Observable<DeviceSessionState> {
     return this.container
-      .get<GetSessionDeviceStateUseCase>(
-        deviceSessionTypes.GetSessionDeviceStateUseCase,
+      .get<GetDeviceSessionStateUseCase>(
+        deviceSessionTypes.GetDeviceSessionStateUseCase,
       )
       .execute(args);
   }

diff --git a/packages/core/src/api/command/use-case/SendCommandUseCase.test.ts b/packages/core/src/api/command/use-case/SendCommandUseCase.test.ts
@@ -1,9 +1,9 @@
 import { Left } from "purify-ts";
 
 import { Command } from "@api/command/Command";
-import { sessionStubBuilder } from "@internal/device-session/model/Session.stub";
-import { DefaultSessionService } from "@internal/device-session/service/DefaultSessionService";
-import { SessionService } from "@internal/device-session/service/SessionService";
+import { deviceSessionStubBuilder } from "@internal/device-session/model/DeviceSession.stub";
+import { DefaultDeviceSessionService } from "@internal/device-session/service/DefaultDeviceSessionService";
+import { DeviceSessionService } from "@internal/device-session/service/DeviceSessionService";
 import { DefaultLoggerPublisherService } from "@internal/logger-publisher/service/DefaultLoggerPublisherService";
 import { LoggerPublisherService } from "@internal/logger-publisher/service/LoggerPublisherService";
 
@@ -13,14 +13,14 @@ import {
 } from "./SendCommandUseCase";
 
 let logger: LoggerPublisherService;
-let sessionService: SessionService;
+let sessionService: DeviceSessionService;
 const fakeSessionId = "fakeSessionId";
 let command: Command<{ status: string }>;
 
 describe("SendCommandUseCase", () => {
   beforeEach(() => {
     logger = new DefaultLoggerPublisherService([], "send-command-use-case");
-    sessionService = new DefaultSessionService(() => logger);
+    sessionService = new DefaultDeviceSessionService(() => logger);
     command = {
       getApdu: jest.fn(),
       parseResponse: jest.fn(),
@@ -32,12 +32,12 @@ describe("SendCommandUseCase", () => {
   });
 
   it("should send a command to a connected device", async () => {
-    const session = sessionStubBuilder();
-    sessionService.addSession(session);
+    const deviceSession = deviceSessionStubBuilder();
+    sessionService.addDeviceSession(deviceSession);
     const useCase = new SendCommandUseCase(sessionService, () => logger);
 
     jest
-      .spyOn(session, "getCommand")
+      .spyOn(deviceSession, "getCommand")
       .mockReturnValue(async () => Promise.resolve({ status: "success" }));
 
     const response = await useCase.execute<{ status: string }>({
@@ -52,7 +52,7 @@ describe("SendCommandUseCase", () => {
   it("should throw an error if the session is not found", async () => {
     const useCase = new SendCommandUseCase(sessionService, () => logger);
     jest
-      .spyOn(sessionService, "getSessionById")
+      .spyOn(sessionService, "getDeviceSessionById")
       .mockReturnValue(Left({ _tag: "DeviceSessionNotFound" }));
 
     const res = useCase.execute<{ status: string }>({