djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #8667 from tannewt/ww_large_file

Browse Source 
Improve web workflow error handling
This commit is contained in:
Dan Halbert 2023-11-28 23:24:55 -05:00 committed by GitHub
commit c3f8e0f551
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 137 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/workflows.md
View File

@ -368,6 +368,31 @@ curl -v -L http://circuitpython.local/cp/devices.json
}
```
#### `/cp/diskinfo.json`
Returns information about the attached disk(s). A list of objects, one per disk.
* `root`: Filesystem path to the root of the disk.
* `free`: Count of free bytes on the disk.
* `block_size`: Size of a block in bytes.
* `writable`: True when CircuitPython and the web workflow can write to the disk. USB may claim a disk instead.
* `total`: Total bytes that make up the disk.
Example:
```sh
curl -v -L http://circuitpython.local/cp/diskinfo.json
```
```json
[{
"root": "/",
"free": 2964992,
"block_size": 512,
"writable": true,
"total": 2967552
}]
```
#### `/cp/serial/`
@ -380,7 +405,7 @@ This is an authenticated endpoint in both modes.
Returns information about the device.
* `web_api_version`: Always `1`. This versions the rest of the API and new versions may not be backwards compatible.
* `web_api_version`: Between `1` and `3`. This versions the rest of the API and new versions may not be backwards compatible. See below for more info.
* `version`: CircuitPython build version.
* `build_date`: CircuitPython build date.
* `board_name`: Human readable name of the board.
@ -436,3 +461,9 @@ CircuitPython is expected to be masked UTF-8, as the spec requires. Data from Ci
client is unmasked. It is also unbuffered so the client will get a variety of frame sizes.
Only one WebSocket at a time is supported.
### Versions
* `1` - Initial version.
* `2` - Added `/cp/diskinfo.json`.
* `3` - Changed `/cp/diskinfo.json` to return a list in preparation for multi-disk support.

2
supervisor/shared/web_workflow/static/directory.html
View File

@ -4,7 +4,7 @@
<title></title>
<meta charset="UTF-8">
<link rel="stylesheet" href="/style.css">
<link rel="stylesheet" href="http://circuitpython.org/assets/css/webworkflow-8.css">
<link rel="stylesheet" href="http://circuitpython.org/assets/css/webworkflow-9.css">
</head>
<body>
<h1><a href="/"><img src="/favicon.ico"/></a>&nbsp;<span id="path"></span></h1>

2
supervisor/shared/web_workflow/static/edit.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="UTF-8">
<title>Offline Code Edit</title>
<link rel="stylesheet" href="http://circuitpython.org/assets/css/webworkflow-8.css">
<link rel="stylesheet" href="http://circuitpython.org/assets/css/webworkflow-9.css">
<link rel="stylesheet" href="/style.css">
</head>
<body>

2
supervisor/shared/web_workflow/static/serial.html
View File

@ -5,7 +5,7 @@
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="/style.css">
<link rel="stylesheet" href="http://circuitpython.org/assets/css/webworkflow-8.css">
<link rel="stylesheet" href="http://circuitpython.org/assets/css/webworkflow-9.css">
</head>
<body style="flex-direction: column; display: flex; height: 100%; width: 100%; margin: 0; font-size: 1rem;">
<div style="flex: auto; display: flex; overflow: auto; flex-direction: column;">

2
supervisor/shared/web_workflow/static/welcome.html
View File

@ -5,7 +5,7 @@
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="/style.css">
<link rel="stylesheet" href="http://circuitpython.org/assets/css/webworkflow-8.css">
<link rel="stylesheet" href="http://circuitpython.org/assets/css/webworkflow-9.css">
</head>
<body>

124
supervisor/shared/web_workflow/web_workflow.c
View File

@ -374,9 +374,16 @@ bool supervisor_start_web_workflow(bool reload) {
return false;
}
void web_workflow_send_raw(socketpool_socket_obj_t *socket, const uint8_t *buf, int len) {
void web_workflow_send_raw(socketpool_socket_obj_t *socket, bool flush, const uint8_t *buf, int len) {
int total_sent = 0;
int sent = -MP_EAGAIN;
int nodelay_ok = -1;
// When flushing, disable Nagle's combining algorithm so that buf is sent immediately.
if (flush) {
int nodelay = 1;
nodelay_ok = common_hal_socketpool_socket_setsockopt(socket, SOCKETPOOL_IPPROTO_TCP, SOCKETPOOL_TCP_NODELAY, &nodelay, sizeof(nodelay));
}
while ((sent == -MP_EAGAIN || (sent > 0 && total_sent < len)) &&
common_hal_socketpool_socket_get_connected(socket)) {
sent = socketpool_socket_send(socket, buf + total_sent, len - total_sent);
@ -388,14 +395,28 @@ void web_workflow_send_raw(socketpool_socket_obj_t *socket, const uint8_t *buf,
}
}
}
// Re-enable Nagle's algorithm when done sending.
if (nodelay_ok == 0) {
int nodelay = 0;
nodelay_ok = common_hal_socketpool_socket_setsockopt(socket, SOCKETPOOL_IPPROTO_TCP, SOCKETPOOL_TCP_NODELAY, &nodelay, sizeof(nodelay));
}
}
STATIC void _print_raw(void *env, const char *str, size_t len) {
web_workflow_send_raw((socketpool_socket_obj_t *)env, (const uint8_t *)str, (size_t)len);
web_workflow_send_raw((socketpool_socket_obj_t *)env, false, (const uint8_t *)str, (size_t)len);
}
static void _send_str(socketpool_socket_obj_t *socket, const char *str) {
web_workflow_send_raw(socket, (const uint8_t *)str, strlen(str));
web_workflow_send_raw(socket, false, (const uint8_t *)str, strlen(str));
}
static void _send_str_maybe_flush(socketpool_socket_obj_t *socket, bool flush, const char *str) {
web_workflow_send_raw(socket, flush, (const uint8_t *)str, strlen(str));
}
static void _send_final_str(socketpool_socket_obj_t *socket, const char *str) {
web_workflow_send_raw(socket, true, (const uint8_t *)str, strlen(str));
}
// The last argument must be NULL! Otherwise, it won't stop.
@ -404,9 +425,13 @@ static __attribute__((sentinel)) void _send_strs(socketpool_socket_obj_t *socket
va_start(ap, socket);
const char *str = va_arg(ap, const char *);
while (str != NULL) {
const char *next_str = va_arg(ap, const char *);
assert(str != NULL);
_send_str(socket, str);
str = va_arg(ap, const char *);
while (next_str != NULL) {
str = next_str;
next_str = va_arg(ap, const char *);
_send_str_maybe_flush(socket, next_str == NULL, str);
}
va_end(ap);
}
@ -414,15 +439,15 @@ static __attribute__((sentinel)) void _send_strs(socketpool_socket_obj_t *socket
static void _send_chunk(socketpool_socket_obj_t *socket, const char *chunk) {
mp_print_t _socket_print = {socket, _print_raw};
mp_printf(&_socket_print, "%X\r\n", strlen(chunk));
web_workflow_send_raw(socket, (const uint8_t *)chunk, strlen(chunk));
web_workflow_send_raw(socket, (const uint8_t *)"\r\n", 2);
web_workflow_send_raw(socket, false, (const uint8_t *)chunk, strlen(chunk));
web_workflow_send_raw(socket, strlen(chunk) == 0, (const uint8_t *)"\r\n", 2);
}
STATIC void _print_chunk(void *env, const char *str, size_t len) {
mp_print_t _socket_print = {env, _print_raw};
mp_printf(&_socket_print, "%X\r\n", len);
web_workflow_send_raw((socketpool_socket_obj_t *)env, (const uint8_t *)str, len);
web_workflow_send_raw((socketpool_socket_obj_t *)env, (const uint8_t *)"\r\n", 2);
web_workflow_send_raw((socketpool_socket_obj_t *)env, false, (const uint8_t *)str, len);
web_workflow_send_raw((socketpool_socket_obj_t *)env, true, (const uint8_t *)"\r\n", 2);
}
// A bit of a misnomer because it sends all arguments as one chunk.
@ -524,7 +549,7 @@ static void _cors_header(socketpool_socket_obj_t *socket, _request *request) {
static void _reply_continue(socketpool_socket_obj_t *socket, _request *request) {
_send_str(socket, "HTTP/1.1 100 Continue\r\n");
_cors_header(socket, request);
_send_str(socket, "\r\n");
_send_final_str(socket, "\r\n");
}
static void _reply_created(socketpool_socket_obj_t *socket, _request *request) {
@ -532,7 +557,7 @@ static void _reply_created(socketpool_socket_obj_t *socket, _request *request) {
"HTTP/1.1 201 Created\r\n",
"Content-Length: 0\r\n", NULL);
_cors_header(socket, request);
_send_str(socket, "\r\n");
_send_final_str(socket, "\r\n");
}
static void _reply_no_content(socketpool_socket_obj_t *socket, _request *request) {
@ -540,7 +565,7 @@ static void _reply_no_content(socketpool_socket_obj_t *socket, _request *request
"HTTP/1.1 204 No Content\r\n",
"Content-Length: 0\r\n", NULL);
_cors_header(socket, request);
_send_str(socket, "\r\n");
_send_final_str(socket, "\r\n");
}
static void _reply_access_control(socketpool_socket_obj_t *socket, _request *request) {
@ -558,7 +583,7 @@ static void _reply_access_control(socketpool_socket_obj_t *socket, _request *req
}
_send_str(socket, "\r\n");
_cors_header(socket, request);
_send_str(socket, "\r\n");
_send_final_str(socket, "\r\n");
}
static void _reply_missing(socketpool_socket_obj_t *socket, _request *request) {
@ -566,7 +591,7 @@ static void _reply_missing(socketpool_socket_obj_t *socket, _request *request) {
"HTTP/1.1 404 Not Found\r\n",
"Content-Length: 0\r\n", NULL);
_cors_header(socket, request);
_send_str(socket, "\r\n");
_send_final_str(socket, "\r\n");
}
static void _reply_method_not_allowed(socketpool_socket_obj_t *socket, _request *request) {
@ -574,7 +599,7 @@ static void _reply_method_not_allowed(socketpool_socket_obj_t *socket, _request
"HTTP/1.1 405 Method Not Allowed\r\n",
"Content-Length: 0\r\n", NULL);
_cors_header(socket, request);
_send_str(socket, "\r\n");
_send_final_str(socket, "\r\n");
}
static void _reply_forbidden(socketpool_socket_obj_t *socket, _request *request) {
@ -582,7 +607,7 @@ static void _reply_forbidden(socketpool_socket_obj_t *socket, _request *request)
"HTTP/1.1 403 Forbidden\r\n",
"Content-Length: 0\r\n", NULL);
_cors_header(socket, request);
_send_str(socket, "\r\n");
_send_final_str(socket, "\r\n");
}
static void _reply_conflict(socketpool_socket_obj_t *socket, _request *request) {
@ -590,7 +615,7 @@ static void _reply_conflict(socketpool_socket_obj_t *socket, _request *request)
"HTTP/1.1 409 Conflict\r\n",
"Content-Length: 19\r\n", NULL);
_cors_header(socket, request);
_send_str(socket, "\r\nUSB storage active.");
_send_final_str(socket, "\r\nUSB storage active.");
}
@ -599,7 +624,7 @@ static void _reply_precondition_failed(socketpool_socket_obj_t *socket, _request
"HTTP/1.1 412 Precondition Failed\r\n",
"Content-Length: 0\r\n", NULL);
_cors_header(socket, request);
_send_str(socket, "\r\n");
_send_final_str(socket, "\r\n");
}
static void _reply_payload_too_large(socketpool_socket_obj_t *socket, _request *request) {
@ -607,7 +632,7 @@ static void _reply_payload_too_large(socketpool_socket_obj_t *socket, _request *
"HTTP/1.1 413 Payload Too Large\r\n",
"Content-Length: 0\r\n", NULL);
_cors_header(socket, request);
_send_str(socket, "\r\n");
_send_final_str(socket, "\r\n");
}
static void _reply_expectation_failed(socketpool_socket_obj_t *socket, _request *request) {
@ -615,7 +640,7 @@ static void _reply_expectation_failed(socketpool_socket_obj_t *socket, _request
"HTTP/1.1 417 Expectation Failed\r\n",
"Content-Length: 0\r\n", NULL);
_cors_header(socket, request);
_send_str(socket, "\r\n");
_send_final_str(socket, "\r\n");
}
static void _reply_unauthorized(socketpool_socket_obj_t *socket, _request *request) {
@ -624,7 +649,7 @@ static void _reply_unauthorized(socketpool_socket_obj_t *socket, _request *reque
"Content-Length: 0\r\n",
"WWW-Authenticate: Basic realm=\"CircuitPython\"\r\n", NULL);
_cors_header(socket, request);
_send_str(socket, "\r\n");
_send_final_str(socket, "\r\n");
}
static void _reply_server_error(socketpool_socket_obj_t *socket, _request *request) {
@ -632,7 +657,7 @@ static void _reply_server_error(socketpool_socket_obj_t *socket, _request *reque
"HTTP/1.1 500 Internal Server Error\r\n",
"Content-Length: 0\r\n", NULL);
_cors_header(socket, request);
_send_str(socket, "\r\n");
_send_final_str(socket, "\r\n");
}
#if CIRCUITPY_MDNS
@ -658,7 +683,7 @@ static void _reply_redirect(socketpool_socket_obj_t *socket, _request *request,
}
_send_strs(socket, path, "\r\n", NULL);
_cors_header(socket, request);
_send_str(socket, "\r\n");
_send_final_str(socket, "\r\n");
}
#endif
@ -734,11 +759,19 @@ static void _reply_with_file(socketpool_socket_obj_t *socket, _request *request,
_send_str(socket, "\r\n");
uint32_t total_read = 0;
int nodelay_ok = -1;
while (total_read < total_length) {
uint8_t data_buffer[64];
size_t quantity_read;
f_read(active_file, data_buffer, 64, &quantity_read);
total_read += quantity_read;
// When getting near the end of the file, disable Nagle's combining algorithm so that
// data is sent immediately.
if (total_length - total_read < 64) {
int nodelay = 1;
// Returns 0 when it works.
nodelay_ok = common_hal_socketpool_socket_setsockopt(socket, SOCKETPOOL_IPPROTO_TCP, SOCKETPOOL_TCP_NODELAY, &nodelay, sizeof(nodelay));
}
uint32_t send_offset = 0;
while (send_offset < quantity_read) {
int sent = socketpool_socket_send(socket, data_buffer + send_offset, quantity_read - send_offset);
@ -755,6 +788,12 @@ static void _reply_with_file(socketpool_socket_obj_t *socket, _request *request,
if (total_read < total_length) {
socketpool_socket_close(socket);
}
// Re-enable Nagle's algorithm when done sending.
if (nodelay_ok == 0) {
int nodelay = 0;
nodelay_ok = common_hal_socketpool_socket_setsockopt(socket, SOCKETPOOL_IPPROTO_TCP, SOCKETPOOL_TCP_NODELAY, &nodelay, sizeof(nodelay));
}
}
static void _reply_with_devices_json(socketpool_socket_obj_t *socket, _request *request) {
@ -812,7 +851,7 @@ static void _reply_with_version_json(socketpool_socket_obj_t *socket, _request *
_update_encoded_ip();
// Note: this leverages the fact that C concats consecutive string literals together.
mp_printf(&_socket_print,
"{\"web_api_version\": 2, "
"{\"web_api_version\": 3, "
"\"version\": \"" MICROPY_GIT_TAG "\", "
"\"build_date\": \"" MICROPY_BUILD_DATE "\", "
"\"board_name\": \"%s\", "
@ -852,10 +891,16 @@ static void _reply_with_diskinfo_json(socketpool_socket_obj_t *socket, _request
uint16_t total_size = fs->n_fatent - 2;
const char *writable = "false";
if (!_usb_active()) {
writable = "true";
}
mp_printf(&_socket_print,
"{\"free\": %d, "
"[{\"root\": \"/\", "
"\"free\": %d, "
"\"block_size\": %d, "
"\"total\": %d}", free_clusters * block_size, block_size, total_size * block_size);
"\"writable\": %s, "
"\"total\": %d}]", free_clusters * block_size, block_size, writable, total_size * block_size);
// Empty chunk signals the end of the response.
_send_chunk(socket, "");
@ -883,9 +928,12 @@ STATIC void _discard_incoming(socketpool_socket_obj_t *socket, size_t amount) {
size_t read_len = MIN(sizeof(bytes), amount - discarded);
int len = socketpool_socket_recv_into(socket, bytes, read_len);
if (len < 0) {
if (len == -MP_EAGAIN) {
continue;
}
break;
}
discarded += read_len;
discarded += len;
}
}
@ -905,9 +953,12 @@ static void _write_file_and_reply(socketpool_socket_obj_t *socket, _request *req
FRESULT result = f_open(fs, &active_file, path, FA_WRITE);
bool new_file = false;
size_t old_length = 0;
if (result == FR_NO_FILE) {
new_file = true;
result = f_open(fs, &active_file, path, FA_WRITE | FA_OPEN_ALWAYS);
} else {
old_length = f_size(&active_file);
}
if (result == FR_NO_PATH) {
@ -927,27 +978,35 @@ static void _write_file_and_reply(socketpool_socket_obj_t *socket, _request *req
_discard_incoming(socket, request->content_length);
_reply_server_error(socket, request);
return;
} else if (request->expect) {
_reply_continue(socket, request);
}
// Change the file size to start.
f_lseek(&active_file, request->content_length);
if (f_tell(&active_file) < request->content_length) {
if (!new_file) {
// Truncate the file back to the old length.
f_lseek(&active_file, old_length);
f_truncate(&active_file);
}
f_close(&active_file);
if (new_file) {
f_unlink(fs, path);
}
override_fattime(0);
#if CIRCUITPY_USB_MSC
usb_msc_unlock();
#endif
_discard_incoming(socket, request->content_length);
// Too large.
if (request->expect) {
_reply_expectation_failed(socket, request);
} else {
_discard_incoming(socket, request->content_length);
_reply_payload_too_large(socket, request);
}
return;
} else if (request->expect) {
_reply_continue(socket, request);
}
f_truncate(&active_file);
f_rewind(&active_file);
@ -1015,7 +1074,7 @@ static void _reply_static(socketpool_socket_obj_t *socket, _request *request, co
"Content-Length: ", encoded_len, "\r\n",
"Content-Type: ", content_type, "\r\n",
"\r\n", NULL);
web_workflow_send_raw(socket, response, response_len);
web_workflow_send_raw(socket, true, response, response_len);
}
#define _REPLY_STATIC(socket, request, filename) _reply_static(socket, request, filename, filename##_length, filename##_content_type)
@ -1462,6 +1521,7 @@ static void _process_request(socketpool_socket_obj_t *socket, _request *request)
int nodelay = 1;
common_hal_socketpool_socket_setsockopt(socket, SOCKETPOOL_IPPROTO_TCP, SOCKETPOOL_TCP_NODELAY, &nodelay, sizeof(nodelay));
socketpool_socket_send(socket, (const uint8_t *)error_response, strlen(error_response));
request->done = true;
}
if (!request->done) {
return;

2
supervisor/shared/web_workflow/web_workflow.h
View File

@ -43,4 +43,4 @@ void supervisor_stop_web_workflow(void);
mdns_server_obj_t *supervisor_web_workflow_mdns(mp_obj_t network_interface);
// To share with websocket.
void web_workflow_send_raw(socketpool_socket_obj_t *socket, const uint8_t *buf, int len);
void web_workflow_send_raw(socketpool_socket_obj_t *socket, bool flush, const uint8_t *buf, int len);

19
supervisor/shared/web_workflow/websocket.c
View File

@ -138,23 +138,18 @@ static void _read_next_frame_header(void) {
uint8_t opcode = 0x8; // CLOSE
if (cp_serial.opcode == 0x9) {
opcode = 0xA; // PONG
} else {
// Set the TCP socket to send immediately so that we send the payload back before
// closing the connection.
int nodelay = 1;
common_hal_socketpool_socket_setsockopt(&cp_serial.socket, SOCKETPOOL_IPPROTO_TCP, SOCKETPOOL_TCP_NODELAY, &nodelay, sizeof(nodelay));
}
uint8_t frame_header[2];
frame_header[0] = 1 << 7 | opcode;
frame_header[1] = cp_serial.payload_remaining;
web_workflow_send_raw(&cp_serial.socket, (const uint8_t *)frame_header, 2);
web_workflow_send_raw(&cp_serial.socket, cp_serial.opcode != 0x9, (const uint8_t *)frame_header, 2);
}
if (cp_serial.payload_remaining > 0 && _read_byte(&h)) {
// Send the payload back to the client.
cp_serial.frame_index++;
cp_serial.payload_remaining--;
web_workflow_send_raw(&cp_serial.socket, &h, 1);
web_workflow_send_raw(&cp_serial.socket, false, &h, 1);
}
if (cp_serial.payload_remaining == 0) {
@ -217,23 +212,23 @@ static void _websocket_send(_websocket *ws, const char *text, size_t len) {
payload_len = 127;
}
frame_header[1] = payload_len;
web_workflow_send_raw(&ws->socket, (const uint8_t *)frame_header, 2);
web_workflow_send_raw(&ws->socket, false, (const uint8_t *)frame_header, 2);
uint8_t extended_len[4];
if (payload_len == 126) {
extended_len[0] = (len >> 8) & 0xff;
extended_len[1] = len & 0xff;
web_workflow_send_raw(&ws->socket, extended_len, 2);
web_workflow_send_raw(&ws->socket, false, extended_len, 2);
} else if (payload_len == 127) {
uint32_t zero = 0;
// 64 bits where top four bytes are zero.
web_workflow_send_raw(&ws->socket, (const uint8_t *)&zero, 4);
web_workflow_send_raw(&ws->socket, false, (const uint8_t *)&zero, 4);
extended_len[0] = (len >> 24) & 0xff;
extended_len[1] = (len >> 16) & 0xff;
extended_len[2] = (len >> 8) & 0xff;
extended_len[3] = len & 0xff;
web_workflow_send_raw(&ws->socket, extended_len, 4);
web_workflow_send_raw(&ws->socket, false, extended_len, 4);
}
web_workflow_send_raw(&ws->socket, (const uint8_t *)text, len);
web_workflow_send_raw(&ws->socket, false, (const uint8_t *)text, len);
}
void websocket_write(const char *text, size_t len) {