feat(connect): make transportReconnect implicitly true

trezor · Nov 7, 2024 · d523359 · d523359
1 parent 0dfebc8
commit d523359
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 16 deletions.
diff --git a/packages/connect/e2e/common.setup.ts b/packages/connect/e2e/common.setup.ts
@@ -127,6 +127,7 @@ export const initTrezorConnect = async (
         debug: false,
         popup: false,
         pendingTransportEvent: true,
+        transportReconnect: false,
         connectSrc: process.env.TREZOR_CONNECT_SRC, // custom source for karma tests
         ...options,
     });

diff --git a/packages/connect/src/core/__tests__/Core.test.ts b/packages/connect/src/core/__tests__/Core.test.ts
@@ -7,7 +7,11 @@ import { initCoreState } from '../index';
 const { createTestTransport } = global.JestMocks;
 
 const getSettings = (partial: Partial<ConnectSettings> = {}) =>
-    parseConnectSettings({ transports: [createTestTransport()], ...partial });
+    parseConnectSettings({
+        transports: [createTestTransport()],
+        transportReconnect: false,
+        ...partial,
+    });
 
 describe('Core', () => {
     beforeAll(async () => {});

diff --git a/packages/connect/src/core/index.ts b/packages/connect/src/core/index.ts
@@ -1258,7 +1258,7 @@ export class Core extends EventEmitter {
         this.deviceList.init({ pendingTransportEvent, transportReconnect });
 
         // in auto core mode, we have to wait to check if transport is available
-        if (!transportReconnect || coreMode === 'auto') {
+        if (transportReconnect === false || coreMode === 'auto') {
             await this.deviceList.pendingConnection();
         }
 

diff --git a/packages/connect/src/device/DeviceList.ts b/packages/connect/src/device/DeviceList.ts
@@ -253,9 +253,10 @@ export class DeviceList extends TypedEmitter<DeviceListEvents> implements IDevic
             .catch(error => {
                 this.cleanup();
                 this.emit(TRANSPORT.ERROR, error);
-                this.initPromise = initParams.transportReconnect
-                    ? this.createReconnectPromise(initParams)
-                    : undefined;
+                this.initPromise =
+                    initParams.transportReconnect !== false
+                        ? this.createReconnectPromise(initParams)
+                        : undefined;
             });
     }
 
@@ -291,7 +292,7 @@ export class DeviceList extends TypedEmitter<DeviceListEvents> implements IDevic
         transport.on(TRANSPORT.ERROR, error => {
             this.cleanup();
             this.emit(TRANSPORT.ERROR, error);
-            if (initParams.transportReconnect) {
+            if (initParams.transportReconnect !== false) {
                 this.initPromise = this.createReconnectPromise(initParams);
             }
         });

diff --git a/packages/connect/src/device/__tests__/DeviceList.test.ts b/packages/connect/src/device/__tests__/DeviceList.test.ts
@@ -27,7 +27,9 @@ describe('DeviceList', () => {
     beforeAll(async () => {
         // todo: I don't get it. If we pass empty messages: {} (see getDeviceListParams), tests behave differently.
         await DataManager.load({
-            ...parseConnectSettings({}),
+            ...parseConnectSettings({
+                transportReconnect: false,
+            }),
         });
 
         // Todo: This is a hack, it should not be here at all. Transport shall return valid device (with valid features)
@@ -42,7 +44,9 @@ describe('DeviceList', () => {
 
     beforeEach(() => {
         list = new DeviceList({
-            ...parseConnectSettings({}),
+            ...parseConnectSettings({
+                transportReconnect: false,
+            }),
             messages: DataManager.getProtobufMessages(),
         });
         eventsSpy = jest.fn();
@@ -99,7 +103,7 @@ describe('DeviceList', () => {
         );
 
         list.setTransports([transport]);
-        list.init({ pendingTransportEvent: true });
+        list.init({ pendingTransportEvent: true, transportReconnect: false });
         // transport-error is not emitted yet because list.init is not awaited
         expect(eventsSpy).toHaveBeenCalledTimes(0);
         await list.pendingConnection();
@@ -117,7 +121,7 @@ describe('DeviceList', () => {
         );
 
         list.setTransports([transport]);
-        list.init({ pendingTransportEvent: true });
+        list.init({ pendingTransportEvent: true, transportReconnect: false });
         // transport-error is not emitted yet because list.init is not awaited
         expect(eventsSpy).toHaveBeenCalledTimes(0);
         await list.pendingConnection();
@@ -131,7 +135,7 @@ describe('DeviceList', () => {
         });
 
         list.setTransports([transport]);
-        list.init({ pendingTransportEvent: true });
+        list.init({ pendingTransportEvent: true, transportReconnect: false });
         await list.pendingConnection();
 
         const events = eventsSpy.mock.calls.map(call => call[0]);
@@ -144,7 +148,7 @@ describe('DeviceList', () => {
         });
 
         list.setTransports([transport]);
-        list.init({ pendingTransportEvent: true });
+        list.init({ pendingTransportEvent: true, transportReconnect: false });
         const transportFirstEvent = list.pendingConnection();
 
         // NOTE: this behavior is wrong, if device creation fails DeviceList shouldn't wait 10 secs.
@@ -174,7 +178,7 @@ describe('DeviceList', () => {
         });
 
         list.setTransports([transport]);
-        list.init({ pendingTransportEvent: true });
+        list.init({ pendingTransportEvent: true, transportReconnect: false });
         await list.pendingConnection();
 
         const events = eventsSpy.mock.calls.map(call => call[0]);
@@ -189,7 +193,7 @@ describe('DeviceList', () => {
         });
 
         list.setTransports([transport]);
-        list.init({ pendingTransportEvent: true });
+        list.init({ pendingTransportEvent: true, transportReconnect: false });
         await list.pendingConnection();
 
         const events = eventsSpy.mock.calls.map(([event, { path }]) => [event, path]);
@@ -221,7 +225,7 @@ describe('DeviceList', () => {
         // NOTE: this behavior is wrong
         jest.useFakeTimers();
         list.setTransports([transport]);
-        list.init({ pendingTransportEvent: true });
+        list.init({ pendingTransportEvent: true, transportReconnect: false });
         const transportFirstEvent = list.pendingConnection();
         await jest.advanceTimersByTimeAsync(6 * 1000); // TODO: this is wrong
         await transportFirstEvent;
@@ -267,7 +271,7 @@ describe('DeviceList', () => {
         });
 
         list.setTransports([transport]);
-        list.init({ pendingTransportEvent: true });
+        list.init({ pendingTransportEvent: true, transportReconnect: false });
         await list.pendingConnection();
 
         // emit TRANSPORT.CHANGE 3 times