Skip to content

show more error popups for usb connection #2362

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dlech merged 4 commits into from
Jan 25, 2026
Merged

show more error popups for usb connection #2362

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
84533c0
usb: implement AlreadyInUse alert
dlech Jan 25, 2026
f0728d2
usb: show error message if opening device fails
dlech Jan 25, 2026
11a8436
usb/sagas: show unexpected error alerts
dlech Jan 25, 2026
a114613
alerts/UnexpectedErrorAlert: expand the message
dlech Jan 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/alerts/UnexpectedErrorAlert.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: MIT
// Copyright (c) 2022-2023 The Pybricks Authors
// Copyright (c) 2022-2026 The Pybricks Authors

import './UnexpectedErrorAlert.scss';
import {
Expand Down Expand Up @@ -29,7 +29,11 @@ const UnexpectedErrorAlert: React.FunctionComponent<UnexpectedErrorAlertProps> =

return (
<>
<p>{i18n.translate('message')}</p>
<p>
{i18n.translate('message', {
copyErrorMessage: i18n.translate('copyErrorMessage'),
})}
</p>
<p>{error.message}</p>
{error.stack && (
<>
Expand Down
2 changes: 1 addition & 1 deletion src/alerts/translations/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"message": "An unexpected error occurred. Please consider reporting this so we can make a better error message.",
"message": "An unexpected error occurred. Please consider reporting this so we can make a better error message. Click the {copyErrorMessage} button below to copy the technical details and paste it in the bug report. Also include the operating system you are using, the web browser you are using and the actions you performed that led to this error.",
"technicalInfo": "Expand for detailed technical information",
"copyErrorMessage": "Copy Error Message",
"reportBug": "Report Bug"
Expand Down
19 changes: 19 additions & 0 deletions src/usb/alerts/AccessDenied.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// SPDX-License-Identifier: MIT
// Copyright (c) 2025-2026 The Pybricks Authors

import { Toast } from '@blueprintjs/core';
import { act } from '@testing-library/react';
import React from 'react';
import { testRender } from '../../../test';
import { accessDenied } from './AccessDenied';

it('should dismiss when close is clicked', async () => {
const callback = jest.fn();
const toast = accessDenied(callback, undefined as never);

const [user, message] = testRender(<Toast {...toast} />);

await act(() => user.click(message.getByRole('button', { name: /close/i })));

expect(callback).toHaveBeenCalledWith('dismiss');
});
26 changes: 26 additions & 0 deletions src/usb/alerts/AccessDenied.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// SPDX-License-Identifier: MIT
// Copyright (c) 2025-2026 The Pybricks Authors

import { Intent } from '@blueprintjs/core';
import { Error } from '@blueprintjs/icons';
import React from 'react';
import type { CreateToast } from '../../toasterTypes';
import { isLinux } from '../../utils/os';
import { useI18n } from './i18n';

const AccessDenied: React.FunctionComponent = () => {
const i18n = useI18n();
return (
<>
<p>{i18n.translate('accessDenied.message')}</p>
{isLinux() && <p>{i18n.translate('accessDenied.linuxSuggestion')}</p>}
</>
);
};

export const accessDenied: CreateToast = (onAction) => ({
message: <AccessDenied />,
icon: <Error />,
intent: Intent.DANGER,
onDismiss: () => onAction('dismiss'),
});
19 changes: 19 additions & 0 deletions src/usb/alerts/AlreadyInUse.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// SPDX-License-Identifier: MIT
// Copyright (c) 2025-2026 The Pybricks Authors

import { Toast } from '@blueprintjs/core';
import { act } from '@testing-library/react';
import React from 'react';
import { testRender } from '../../../test';
import { alreadyInUse } from './AlreadyInUse';

it('should dismiss when close is clicked', async () => {
const callback = jest.fn();
const toast = alreadyInUse(callback, undefined as never);

const [user, message] = testRender(<Toast {...toast} />);

await act(() => user.click(message.getByRole('button', { name: /close/i })));

expect(callback).toHaveBeenCalledWith('dismiss');
});
24 changes: 24 additions & 0 deletions src/usb/alerts/AlreadyInUse.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// SPDX-License-Identifier: MIT
// Copyright (c) 2025-2026 The Pybricks Authors

import { Intent } from '@blueprintjs/core';
import { Error } from '@blueprintjs/icons';
import React from 'react';
import type { CreateToast } from '../../toasterTypes';
import { useI18n } from './i18n';

const AlreadyInUse: React.FunctionComponent = () => {
const i18n = useI18n();
return (
<>
<p>{i18n.translate('alreadyInUse.message')}</p>
</>
);
};

export const alreadyInUse: CreateToast = (onAction) => ({
message: <AlreadyInUse />,
icon: <Error />,
intent: Intent.DANGER,
onDismiss: () => onAction('dismiss'),
});
6 changes: 5 additions & 1 deletion src/usb/alerts/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
// SPDX-License-Identifier: MIT
// Copyright (c) 2025 The Pybricks Authors
// Copyright (c) 2025-2026 The Pybricks Authors

import { accessDenied } from './AccessDenied';
import { alreadyInUse } from './AlreadyInUse';
import { newPybricksProfile } from './NewPybricksProfile';
import { noWebUsb } from './NoWebUsb';
import { oldFirmware } from './OldFirmware';

// gathers all of the alert creation functions for passing up to the top level
export default {
accessDenied,
alreadyInUse,
newPybricksProfile,
noWebUsb,
oldFirmware,
Expand Down
7 changes: 7 additions & 0 deletions src/usb/alerts/translations/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@
"suggestion": "Use a supported browser such as Google Chrome or Microsoft Edge.",
"action": "More Info"
},
"accessDenied": {
"message": "Access to the USB device was denied.",
"linuxSuggestion": "On Linux, ensure that you have the correct udev rules installed."
},
"alreadyInUse": {
"message": "This hub is already in use by another application."
},
"oldFirmware": {
"message": "A new firmware version is available for this hub. Please install the latest version to use all new features.",
"flashFirmware": {
Expand Down
62 changes: 54 additions & 8 deletions src/usb/sagas.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,9 @@ function* handleUsbConnectPybricks(hotPlugDevice?: USBDevice): Generator {
return;
}

// TODO: show unexpected error message to user here
yield* put(
alertsShowAlert('alerts', 'unexpectedError', { error: reqDeviceErr }),
);
console.error('Failed to request USB device:', reqDeviceErr);
yield* put(usbDidFailToConnectPybricks());
yield* cleanup();
Expand All @@ -154,7 +156,25 @@ function* handleUsbConnectPybricks(hotPlugDevice?: USBDevice): Generator {
continue;
}

// TODO: show error message to user here
// Only show error to the user if they initiated the connection.
if (hotPlugDevice === undefined) {
if (openErr.name === 'SecurityError') {
// Known causes:
// - Linux without proper udev rules to allow access to USB devices
// - Trying to access a device on a host machine when the USB
// device is shared with a VM guest OS.
// Other suspected causes:
// - Issues with permissions in containerized apps (e.g. Snaps on Ubuntu)
yield* put(alertsShowAlert('usb', 'accessDenied'));
} else {
yield* put(
alertsShowAlert('alerts', 'unexpectedError', {
error: openErr,
}),
);
}
}

console.error('Failed to open USB device:', openErr);
yield* put(usbDidFailToConnectPybricks());
yield* cleanup();
Expand All @@ -168,7 +188,7 @@ function* handleUsbConnectPybricks(hotPlugDevice?: USBDevice): Generator {

const [, selectErr] = yield* call(() => maybe(usbDevice.selectConfiguration(1)));
if (selectErr) {
// TODO: show error message to user here
yield* put(alertsShowAlert('alerts', 'unexpectedError', { error: selectErr }));
console.error('Failed to select USB device configuration:', selectErr);
yield* put(usbDidFailToConnectPybricks());
yield* cleanup();
Expand Down Expand Up @@ -205,7 +225,17 @@ function* handleUsbConnectPybricks(hotPlugDevice?: USBDevice): Generator {
maybe(usbDevice.claimInterface(iface.interfaceNumber)),
);
if (claimErr) {
// TODO: show error message to user here
// Only show error to the user if they initiated the connection.
if (hotPlugDevice === undefined) {
if (claimErr.name === 'NetworkError') {
yield* put(alertsShowAlert('usb', 'alreadyInUse'));
} else {
yield* put(
alertsShowAlert('alerts', 'unexpectedError', { error: claimErr }),
);
}
}

console.error('Failed to claim USB interface:', claimErr);
yield* put(usbDidFailToConnectPybricks());
yield* cleanup();
Expand All @@ -229,7 +259,11 @@ function* handleUsbConnectPybricks(hotPlugDevice?: USBDevice): Generator {
),
);
if (fwVerError || fwVerResult?.status !== 'ok') {
// TODO: show error message to user here
yield* put(
alertsShowAlert('alerts', 'unexpectedError', {
error: fwVerError || ensureError(fwVerResult?.status),
}),
);
console.error('Failed to get firmware version:', fwVerError);
yield* put(usbDidFailToConnectPybricks());
yield* cleanup();
Expand Down Expand Up @@ -285,7 +319,11 @@ function* handleUsbConnectPybricks(hotPlugDevice?: USBDevice): Generator {
),
);
if (nameError || nameResult?.status !== 'ok') {
// TODO: show error message to user here
yield* put(
alertsShowAlert('alerts', 'unexpectedError', {
error: nameError || ensureError(nameResult?.status),
}),
);
console.error('Failed to get device name:', nameError);
yield* put(usbDidFailToConnectPybricks());
yield* cleanup();
Expand All @@ -312,7 +350,11 @@ function* handleUsbConnectPybricks(hotPlugDevice?: USBDevice): Generator {
),
);
if (swVerError || swVerResult?.status !== 'ok') {
// TODO: show error message to user here
yield* put(
alertsShowAlert('alerts', 'unexpectedError', {
error: swVerError || ensureError(swVerResult?.status),
}),
);
console.error('Failed to get software version:', swVerError);
yield* put(usbDidFailToConnectPybricks());
yield* cleanup();
Expand Down Expand Up @@ -354,7 +396,11 @@ function* handleUsbConnectPybricks(hotPlugDevice?: USBDevice): Generator {
),
);
if (hubCapErr || hubCapResult?.status !== 'ok') {
// TODO: show error message to user here
yield* put(
alertsShowAlert('alerts', 'unexpectedError', {
error: hubCapErr || ensureError(hubCapResult?.status),
}),
);
console.error('Failed to get hub capabilities:', hubCapErr);
yield* put(usbDidFailToConnectPybricks());
yield* cleanup();
Expand Down