← index #10508PR #814
Related · medium · value 1.127
QUERY · ISSUE

Timeout support for websocket/webrepl

openby jimmoopened 2023-01-16updated 2024-09-12
enhancement

Reported here: https://github.com/orgs/micropython/discussions/10444

Webrepl constructs a websocket with BLOCKING_WRITE set. There's no timeout, so prints can hang.

CANDIDATE · PULL REQUEST

webrepl: Changes for more webrepl features while making it smaller.

openby felixdoerreopened 2024-02-29updated 2024-10-12

This change:

  • Moves the password checking to python
  • Removes the special file transfer protocol (This changes allows to extend mpremote to support webrepl just like a serial port)
  • Moves the REPL data to websocket binary packages

The change should be compatible with the current micropython version, however a new webrepl client needs to be deployed under https://micropython.org/webrepl/

Currently, to help you testing, I've adjusted the default URL to https://felix.dogcraft.de/webrepl/, where I host the corresponding draft "new" webrepl client. I've pushed the modified js code here, if you want to take a look: https://github.com/felixdoerre/webreplv2. I'm not completely sure, if I should open a PR in https://github.com/micropython/webrepl, as this seems to be the authoritative source of the client, but the repo seems to be abandoned for some time now.

The new webrepl client currently features (See also #13540):

  • A file browser, allowing directory listings, downloads and uploads. This uses the same injected code as mpremote.
  • An implementation of the mount-feature from mpremote that works with the same injected code. It allows mounting files from the browser's local storage (which can host some python scripts that one wants to bring for debugging), or from a local folder, that is drag-and-dropped into the webrepl (read-only), this is useful for rapid development/testing.
  • An implementation of mip with a package browser to list and download packages directly from https://micropython.org/pi/

Currently the "mount" feature has to be activated "manually" (by calling hookme() from the developer tools, and then executing __mount() in the repl manually). Also the UI for the file browser might not be super intuitive yet (the + for upload and mounting a local folder might be too small and not clear enough). So I'm hoping for UI improvement suggestions.

If you want, I can split the mount and the mip implementation into separate PRs, but the file-browser and this PR are dependent on each other.

With this change the _webrepl module from micropython is not needed anymore and can be removed.

2 comments
Carglglz · 2024-02-29

@felixdoerre this could be a good opportunity
to add SSL support to WebREPL using SSLContext see https://github.com/micropython/micropython/pull/5611#issuecomment-1314686679 👍🏼

felixdoerre · 2024-03-14

I've pushed a few adjustments and an (optional) bonus commit to allow specifying an ssl context.

Keyboard

j / / n
next pair
k / / p
previous pair
1 / / h
show query pane
2 / / l
show candidate pane
c
copy suggested comment
r
toggle reasoning
g i
go to index
?
show this help
esc
close overlays

press ? or esc to close

copied