Skip to content
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.

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

Improve error handling for WebUSB issues #1164

Merged
merged 14 commits into from
May 3, 2024
Merged

Conversation

microbit-robert
Copy link
Collaborator

@microbit-robert microbit-robert commented Apr 8, 2024

Show dialogs with updated and more user friendly text and graphics instead of a toast notification.
Continue to use existing translations until new text has been translated.

See https://microbit-global.monday.com/boards/1125389526/views/244984/pulses/1434828425 (private)

Copy link

github-actions bot commented Apr 8, 2024

Preview build will be at
https://review-python-editor-v3.microbit.org/webusb-errors/

@microbit-matt-hillsdon
Copy link
Collaborator

microbit-matt-hillsdon commented Apr 19, 2024

Fallback error requesting reconnect

image

  • should this be a V2 micro:bit in the video?

Failed to claim interface

image

Should we change the language to not use process and maybe avoid the repetition? For example:

Another app or browser tab is connected to this micro:bit

Close any other tabs that may be using WebUSB (e.g. MakeCode, Python Editor, machine learning tool), or unplug and replug the micro:bit before trying again.

Is app the best option? "application"? I think "program" isn't quite right especially in the context of a micro:bit editor and process is too techy.

Should this have the full replug advice + video? Leaning towards no as the best correction is likely to close the other tab.

Connection timeout

image

I think this should have the replug advice + video.

lang/ui.en.json Outdated
@@ -1116,29 +1116,21 @@
"description": "Part of WebUSB error message"
},
"webusb-error-clear-connect-description-2": {
"defaultMessage": "Close any other tabs that may be using WebUSB (e.g. MakeCode, Python Editor), or unplug and replug the micro:bit before trying again.",
"defaultMessage": "Close any other tabs that may be using WebUSB (e.g. MakeCode, Python Editor, machine learning tool), or unplug and replug the micro:bit before trying again.",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure that we want to add the ML tool here but one to confirm on Monday.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is still unresolved, but I've simplified this back to being just MakeCode and the Python Editor for now.

lang/ui.en.json Outdated Show resolved Hide resolved
@jaustin
Copy link

jaustin commented Apr 29, 2024

Fallback error requesting reconnect

image

  • should this be a V2 micro:bit in the video?

Sure, I will update the video when I get a moment. Is it okay to swap the assets out at that point? How disruptive will it be if dimensions change slightly, etc?

I will also make sure '1' fades and '2' appears at the same time, as that was bothering me. Any other video feedback?

Failed to claim interface

image

Should we change the language to not use process and maybe avoid the repetition? For example:

Another app or browser tab is connected to this micro:bit

Close any other tabs that may be using WebUSB (e.g. MakeCode, Python Editor, machine learning tool), or unplug and replug the micro:bit before trying again.

That language sounds better. To be even more helpful for the user, could we include favicon hints for each?

image

image

image

Is app the best option? "application"? I think "program" isn't quite right especially in the context of a micro:bit editor and process is too techy.

I think conventionally it would be a 'page' right? Another "Another page or browser tab is connected to this micro:bit" (I think even web apps are still web pages?)

Should this have the full replug advice + video? Leaning towards no as the best correction is likely to close the other tab.

I agree no. I think it's common you need to find that other tab. Though I don't know when it's MakeCode or not. I think it's when you have multiple windows and MakeCode is the frontmost tab in one of them?

Connection timeout

image

I think this should have the replug advice + video.

Agree

@microbit-robert
Copy link
Collaborator Author

Updated screenshots:

I have updated the text for this one so matches what the video shows. It's now quite tall and will likely scroll vertically on screen heights of 768px.
image

Improved title, simplified the description to lose reference to the machine learning tool.
image

Timeout error is now identifical to the reconnect error with a different title. Again, it's tall.
image

@microbit-robert
Copy link
Collaborator Author

microbit-robert commented May 1, 2024

Alternative layouts. Update: Pushed changes to implement the horizontal layout.

Horizontal:
image

Vertical with a lot of horizontal padding around the video:
image

@microbit-matt-hillsdon microbit-matt-hillsdon changed the title [DRAFT - DO NOT MERGE] Improve error handling for WebUSB issues Improve error handling for WebUSB issues May 3, 2024
@microbit-matt-hillsdon microbit-matt-hillsdon marked this pull request as ready for review May 3, 2024 10:06
microbit-matt-hillsdon and others added 3 commits May 3, 2024 11:10
Given that we've said pages/tabs in the title (below in this file, above in the UI!) it's tempting to reduce the translation churn by reinstating this.
@microbit-matt-hillsdon microbit-matt-hillsdon merged commit 9bfff59 into main May 3, 2024
1 check passed
@microbit-matt-hillsdon microbit-matt-hillsdon deleted the webusb-errors branch May 3, 2024 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants