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.

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

Jump to bottom

Extend websocket error logs to include transport failure reason (IDFGH-13978) #14806

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Extend websocket error logs to include transport failure reason (IDFGH-13978) #14806

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
093ea00
fix(ws_transport): correct split header bytes
bryghtlabs-richard Oct 10, 2024
175a42c
feat(ws_transport): include error reason in failure log
bryghtlabs-richard Oct 30, 2024
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
50 changes: 39 additions & 11 deletions components/tcp_transport/transport_ws.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,34 @@ static int esp_transport_read_internal(transport_ws_t *ws, char *buffer, int len
return to_read;
}

static int esp_transport_read_exact_size(transport_ws_t *ws, char *buffer, int requested_len, int timeout_ms)
{
int total_read = 0;
int len = requested_len;

while (len > 0) {
int bytes_read = esp_transport_read_internal(ws, buffer, len, timeout_ms);

if (bytes_read < 0) {
return bytes_read; // Return error from the underlying read
}

if (bytes_read == 0) {
// If we read 0 bytes, we return an error, since reading exact number of bytes resulted in a timeout operation
ESP_LOGW(TAG, "Requested to read %d, actually read %d bytes", requested_len, total_read);
return -1;
}

// Update buffer and remaining length
buffer += bytes_read;
len -= bytes_read;
total_read += bytes_read;

ESP_LOGV(TAG, "Read fragment of %d bytes", bytes_read);
}
return total_read;
}

static char *trimwhitespace(char *str)
{
char *end;
Expand Down Expand Up @@ -357,7 +385,7 @@ static int _ws_write(esp_transport_handle_t t, int opcode, int mask_flag, const

int poll_write;
if ((poll_write = esp_transport_poll_write(ws->parent, timeout_ms)) <= 0) {
ESP_LOGE(TAG, "Error transport_poll_write");
ESP_LOGE(TAG, "Error transport_poll_write(%i)", poll_write);
return poll_write;
}
ws_header[header_len++] = opcode;
Expand Down Expand Up @@ -456,7 +484,7 @@ static int ws_read_payload(esp_transport_handle_t t, char *buffer, int len, int

// Receive and process payload
if (bytes_to_read != 0 && (rlen = esp_transport_read_internal(ws, buffer, bytes_to_read, timeout_ms)) <= 0) {
ESP_LOGE(TAG, "Error read data");
ESP_LOGE(TAG, "Error read data(%i)", rlen);
return rlen;
}
ws->frame_state.bytes_remaining -= rlen;
Expand Down Expand Up @@ -486,8 +514,8 @@ static int ws_read_header(esp_transport_handle_t t, char *buffer, int len, int t
// Receive and process header first (based on header size)
int header = 2;
int mask_len = 4;
if ((rlen = esp_transport_read_internal(ws, data_ptr, header, timeout_ms)) <= 0) {
ESP_LOGE(TAG, "Error read data");
if ((rlen = esp_transport_read_exact_size(ws, data_ptr, header, timeout_ms)) <= 0) {
ESP_LOGE(TAG, "Error read data(%i)", rlen);
return rlen;
}
ws->frame_state.header_received = true;
Expand All @@ -500,16 +528,16 @@ static int ws_read_header(esp_transport_handle_t t, char *buffer, int len, int t
ESP_LOGD(TAG, "Opcode: %d, mask: %d, len: %d", ws->frame_state.opcode, mask, payload_len);
if (payload_len == 126) {
// headerLen += 2;
if ((rlen = esp_transport_read_internal(ws, data_ptr, header, timeout_ms)) <= 0) {
ESP_LOGE(TAG, "Error read data");
if ((rlen = esp_transport_read_exact_size(ws, data_ptr, header, timeout_ms)) <= 0) {
ESP_LOGE(TAG, "Error read data(%i)", rlen);
return rlen;
}
payload_len = (uint8_t)data_ptr[0] << 8 | (uint8_t)data_ptr[1];
} else if (payload_len == 127) {
// headerLen += 8;
header = 8;
if ((rlen = esp_transport_read_internal(ws, data_ptr, header, timeout_ms)) <= 0) {
ESP_LOGE(TAG, "Error read data");
if ((rlen = esp_transport_read_exact_size(ws, data_ptr, header, timeout_ms)) <= 0) {
ESP_LOGE(TAG, "Error read data(%i)", rlen);
return rlen;
}

Expand All @@ -523,8 +551,8 @@ static int ws_read_header(esp_transport_handle_t t, char *buffer, int len, int t

if (mask) {
// Read and store mask
if (payload_len != 0 && (rlen = esp_transport_read_internal(ws, buffer, mask_len, timeout_ms)) <= 0) {
ESP_LOGE(TAG, "Error read data");
if (payload_len != 0 && (rlen = esp_transport_read_exact_size(ws, buffer, mask_len, timeout_ms)) <= 0) {
ESP_LOGE(TAG, "Error read data(%i)", rlen);
return rlen;
}
memcpy(ws->frame_state.mask_key, buffer, mask_len);
Expand Down Expand Up @@ -619,7 +647,7 @@ static int ws_read(esp_transport_handle_t t, char *buffer, int len, int timeout_

if (ws->frame_state.payload_len) {
if ( (rlen = ws_read_payload(t, buffer, len, timeout_ms)) <= 0) {
ESP_LOGE(TAG, "Error reading payload data");
ESP_LOGE(TAG, "Error reading payload data(%i)", rlen);
ws->frame_state.bytes_remaining = 0;
return rlen;
}
Expand Down
Loading