feat(suite): introduce new prerequisite - device-used-elsehwere. sepa…

…rate from device-unacquired
trezor · Dec 2, 2024 · 41d270a · 41d270a
1 parent a0de260
commit 41d270a
Show file tree

Hide file tree

Showing 8 changed files with 99 additions and 42 deletions.
diff --git a/packages/suite/src/components/suite/ConnectDevicePrompt.tsx b/packages/suite/src/components/suite/ConnectDevicePrompt.tsx
@@ -74,8 +74,10 @@ const getMessageId = ({
             return isDesktop() ? 'TR_NO_TRANSPORT_DESKTOP' : 'TR_NO_TRANSPORT';
         case 'device-bootloader':
             return 'TR_DEVICE_CONNECTED_BOOTLOADER';
-        case 'device-unacquired':
+        case 'device-used-elsewhere':
             return 'TR_DEVICE_CONNECTED_UNACQUIRED';
+        case 'device-unacquired':
+            return 'TR_NEEDS_ATTENTION_UNABLE_TO_CONNECT';
         default: {
             if (connected) {
                 return !showWarning ? 'TR_DEVICE_CONNECTED' : 'TR_DEVICE_CONNECTED_WRONG_STATE';

diff --git a/packages/suite/src/components/suite/PrerequisitesGuide/DeviceAcquire.tsx b/packages/suite/src/components/suite/PrerequisitesGuide/DeviceAcquire.tsx
@@ -2,14 +2,16 @@ import { MouseEventHandler } from 'react';
 
 import { acquireDevice } from '@suite-common/wallet-core';
 import { Button } from '@trezor/components';
-import { isDesktop } from '@trezor/env-utils';
 
 import { Translation, TroubleshootingTips } from 'src/components/suite';
 import { useDevice, useDispatch } from 'src/hooks/suite';
-import { TROUBLESHOOTING_TIP_RECONNECT } from 'src/components/suite/troubleshooting/tips';
+import {
+    TROUBLESHOOTING_TIP_RECONNECT,
+    TROUBLESHOOTING_TIP_CLOSE_ALL_TABS,
+} from 'src/components/suite/troubleshooting/tips';
 
 export const DeviceAcquire = () => {
-    const { isLocked, device } = useDevice();
+    const { isLocked } = useDevice();
     const dispatch = useDispatch();
 
     const isDeviceLocked = isLocked();
@@ -21,45 +23,15 @@ export const DeviceAcquire = () => {
 
     const ctaButton = (
         <Button data-testid="@device-acquire" isLoading={isDeviceLocked} onClick={handleClick}>
-            <Translation id="TR_ACQUIRE_DEVICE" />
+            <Translation id="TR_TRY_AGAIN" />
         </Button>
     );
 
-    const tips = [
-        {
-            key: 'device-used-elsewhere',
-            heading: <Translation id="TR_DEVICE_CONNECTED_UNACQUIRED" />,
-            description: device?.transportSessionOwner ? (
-                <Translation
-                    id="TR_DEVICE_CONNECTED_UNACQUIRED_DESCRIPTION"
-                    values={{
-                        transportSessionOwner: device.transportSessionOwner,
-                    }}
-                />
-            ) : (
-                // legacy bridge does not share transportSessionOwner information
-                <Translation id="TR_DEVICE_CONNECTED_UNACQUIRED_DESCRIPTION_UNKNOWN_APP" />
-            ),
-        },
-        {
-            key: 'device-acquire',
-            heading: <Translation id="TR_TROUBLESHOOTING_CLOSE_TABS" />,
-            description: (
-                <Translation
-                    id={
-                        isDesktop()
-                            ? 'TR_TROUBLESHOOTING_CLOSE_TABS_DESCRIPTION_DESKTOP'
-                            : 'TR_TROUBLESHOOTING_CLOSE_TABS_DESCRIPTION'
-                    }
-                />
-            ),
-        },
-        TROUBLESHOOTING_TIP_RECONNECT,
-    ];
+    const tips = [TROUBLESHOOTING_TIP_CLOSE_ALL_TABS, TROUBLESHOOTING_TIP_RECONNECT];
 
     return (
         <TroubleshootingTips
-            label={<Translation id="TR_ACQUIRE_DEVICE_TITLE" />}
+            label={<Translation id="TR_NEEDS_ATTENTION_UNABLE_TO_CONNECT" />}
             cta={ctaButton}
             items={tips}
         />

diff --git a/packages/suite/src/components/suite/PrerequisitesGuide/DeviceUnreadable.tsx b/packages/suite/src/components/suite/PrerequisitesGuide/DeviceUnreadable.tsx
@@ -13,6 +13,7 @@ import {
     TROUBLESHOOTING_TIP_UNREADABLE_HID,
     TROUBLESHOOTING_TIP_SUITE_DESKTOP_TOGGLE_BRIDGE,
     TROUBLESHOOTING_TIP_RECONNECT,
+    TROUBLESHOOTING_TIP_CLOSE_ALL_TABS,
 } from 'src/components/suite/troubleshooting/tips';
 import { useSelector, useDispatch } from 'src/hooks/suite';
 import type { TrezorDevice } from 'src/types/suite';
@@ -143,6 +144,11 @@ export const DeviceUnreadable = ({ device }: DeviceUnreadableProps) => {
         // you might have a very old device which is no longer supported current bridge
         // if on desktop - try toggling between the 2 bridges we have available
         items.push(TROUBLESHOOTING_TIP_SUITE_DESKTOP_TOGGLE_BRIDGE);
+    } else {
+        // it might also be unreadable because device was acquired on transport layer by another app and never released.
+        // this should be rather exceptional case that happens only when sessions synchronization is broken or other app
+        // is not cooperating with us
+        items.push(TROUBLESHOOTING_TIP_CLOSE_ALL_TABS);
     }
 
     return (

diff --git a/packages/suite/src/components/suite/PrerequisitesGuide/DeviceUsedElsewhere.tsx b/packages/suite/src/components/suite/PrerequisitesGuide/DeviceUsedElsewhere.tsx
@@ -0,0 +1,58 @@
+import { MouseEventHandler } from 'react';
+
+import { acquireDevice } from '@suite-common/wallet-core';
+import { Button } from '@trezor/components';
+
+import { Translation, TroubleshootingTips } from 'src/components/suite';
+import { useDevice, useDispatch } from 'src/hooks/suite';
+import {
+    TROUBLESHOOTING_TIP_RECONNECT,
+    TROUBLESHOOTING_TIP_CLOSE_ALL_TABS,
+} from 'src/components/suite/troubleshooting/tips';
+
+export const DeviceUsedElsewhere = () => {
+    const { isLocked, device } = useDevice();
+    const dispatch = useDispatch();
+
+    const isDeviceLocked = isLocked();
+
+    const handleClick: MouseEventHandler = e => {
+        e.stopPropagation();
+        dispatch(acquireDevice());
+    };
+
+    const ctaButton = (
+        <Button
+            data-testid="@device-used-elsewhere"
+            isLoading={isDeviceLocked}
+            onClick={handleClick}
+        >
+            <Translation id="TR_ACQUIRE_DEVICE" />
+        </Button>
+    );
+
+    const tips = [
+        {
+            key: 'device-used-elsewhere',
+            heading: <Translation id="TR_DEVICE_CONNECTED_UNACQUIRED" />,
+            description: (
+                <Translation
+                    id="TR_DEVICE_CONNECTED_UNACQUIRED_DESCRIPTION"
+                    values={{
+                        transportSessionOwner: device?.transportSessionOwner || 'unknown',
+                    }}
+                />
+            ),
+        },
+        TROUBLESHOOTING_TIP_CLOSE_ALL_TABS,
+        TROUBLESHOOTING_TIP_RECONNECT,
+    ];
+
+    return (
+        <TroubleshootingTips
+            label={<Translation id="TR_ACQUIRE_DEVICE_TITLE" />}
+            cta={ctaButton}
+            items={tips}
+        />
+    );
+};
diff --git a/packages/suite/src/components/suite/PrerequisitesGuide/PrerequisitesGuide.tsx b/packages/suite/src/components/suite/PrerequisitesGuide/PrerequisitesGuide.tsx
@@ -26,6 +26,7 @@ import { DeviceNoFirmware } from './DeviceNoFirmware';
 import { DeviceUpdateRequired } from './DeviceUpdateRequired';
 import { DeviceDisconnectRequired } from './DeviceDisconnectRequired';
 import { MultiShareBackupInProgress } from './MultiShareBackupInProgress';
+import { DeviceUsedElsewhere } from './DeviceUsedElsewhere';
 
 const Wrapper = styled.div`
     display: flex;
@@ -68,6 +69,8 @@ export const PrerequisitesGuide = ({ allowSwitchDevice }: PrerequisitesGuideProp
                     return <DeviceConnect isWebUsbTransport={isWebUsbTransport} />;
                 case 'device-unacquired':
                     return <DeviceAcquire />;
+                case 'device-used-elsewhere':
+                    return <DeviceUsedElsewhere />;
                 case 'device-unreadable':
                     return <DeviceUnreadable device={device} />;
                 case 'device-unknown':

diff --git a/packages/suite/src/components/suite/troubleshooting/tips/index.tsx b/packages/suite/src/components/suite/troubleshooting/tips/index.tsx
@@ -99,3 +99,17 @@ export const TROUBLESHOOTING_TIP_RECONNECT = {
         />
     ),
 };
+
+export const TROUBLESHOOTING_TIP_CLOSE_ALL_TABS = {
+    key: 'device-acquire',
+    heading: <Translation id="TR_TROUBLESHOOTING_CLOSE_TABS" />,
+    description: (
+        <Translation
+            id={
+                isDesktop()
+                    ? 'TR_TROUBLESHOOTING_CLOSE_TABS_DESCRIPTION_DESKTOP'
+                    : 'TR_TROUBLESHOOTING_CLOSE_TABS_DESCRIPTION'
+            }
+        />
+    ),
+};
diff --git a/packages/suite/src/support/messages.ts b/packages/suite/src/support/messages.ts
@@ -2087,6 +2087,10 @@ const messages = defineMessagesWithTypeCheck({
         defaultMessage: 'Trezor is not readable.',
         id: 'TR_NEEDS_ATTENTION_UNREADABLE',
     },
+    TR_NEEDS_ATTENTION_UNABLE_TO_CONNECT: {
+        defaultMessage: 'Failed to communicate with Trezor',
+        id: 'TR_NEEDS_ATTENTION_UNABLE_TO_CONNECT',
+    },
     TR_UDEV_DOWNLOAD_TITLE: {
         defaultMessage: 'Download udev rules',
         id: 'TR_UDEV_DOWNLOAD_TITLE',
@@ -6790,11 +6794,6 @@ const messages = defineMessagesWithTypeCheck({
         defaultMessage:
             'The app {transportSessionOwner} may currently be using this device. You can take control of the device if needed.',
     },
-    TR_DEVICE_CONNECTED_UNACQUIRED_DESCRIPTION_UNKNOWN_APP: {
-        id: 'TR_DEVICE_CONNECTED_UNACQUIRED_DESCRIPTION_UNKNOWN_APP',
-        defaultMessage:
-            'Another app may currently be using this device. You can take control of the device if needed.',
-    },
     TR_WIPE_OR_UPDATE: {
         id: 'TR_WIPE_OR_UPDATE',
         defaultMessage: 'Reset device or update firmware',

diff --git a/packages/suite/src/utils/suite/prerequisites.ts b/packages/suite/src/utils/suite/prerequisites.ts
@@ -28,6 +28,9 @@ export const getPrerequisiteName = ({ router, device, transport }: GetPrerequisi
         return 'device-disconnect-required';
     }
 
+    if (device.type === 'unacquired' && device?.transportSessionOwner)
+        return 'device-used-elsewhere';
+
     // device features cannot be read, device is probably used in another window
     if (device.type === 'unacquired') return 'device-unacquired';