Skip to content

feat(websocket): Add websocket HTTP redirect #771

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(websocket): Add websocket HTTP redirect #771

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
51 changes: 38 additions & 13 deletions components/esp_websocket_client/esp_websocket_client.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,12 @@
#define WS_OVER_TCP_SCHEME "ws"
#define WS_OVER_TLS_SCHEME "wss"
#define WS_HTTP_BASIC_AUTH "Basic "
#define WS_HTTP_REDIRECT(code) ((code >= 300) && (code < 400))

#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 5, 0)
// Features supported in 5.5.0
#define WS_TRANSPORT_REDIRECT_HEADER_SUPPORT 1
#endif

const static int STOPPED_BIT = BIT0;
const static int CLOSE_FRAME_SENT_BIT = BIT1; // Indicates that a close frame was sent by the client
Expand Down Expand Up @@ -586,6 +592,23 @@
return ESP_OK;
}

static void esp_websocket_client_prepare_transport(esp_websocket_client_handle_t client)
{
//get transport by scheme
if (client->transport == NULL && client->config->ext_transport == NULL) {
client->transport = esp_transport_list_get_transport(client->transport_list, client->config->scheme);
}

if (client->transport == NULL) {
ESP_LOGE(TAG, "There are no transports valid, stop websocket client");
client->run = false;
}
//default port
if (client->config->port == 0) {
client->config->port = esp_transport_get_default_port(client->transport);
}
}

static int esp_websocket_client_send_with_exact_opcode(esp_websocket_client_handle_t client, ws_transport_opcodes_t opcode, const uint8_t *data, int len, TickType_t timeout)
{
int ret = -1;
Expand Down Expand Up @@ -985,19 +1008,7 @@
esp_websocket_client_handle_t client = (esp_websocket_client_handle_t) pv;
client->run = true;

//get transport by scheme
if (client->transport == NULL && client->config->ext_transport == NULL) {
client->transport = esp_transport_list_get_transport(client->transport_list, client->config->scheme);
}

if (client->transport == NULL) {
ESP_LOGE(TAG, "There are no transports valid, stop websocket client");
client->run = false;
}
//default port
if (client->config->port == 0) {
client->config->port = esp_transport_get_default_port(client->transport);
}
esp_websocket_client_prepare_transport(client);

client->state = WEBSOCKET_STATE_INIT;
xEventGroupClearBits(client->status_bits, STOPPED_BIT | CLOSE_FRAME_SENT_BIT);
Expand Down Expand Up @@ -1035,6 +1046,20 @@
esp_websocket_client_abort_connection(client, WEBSOCKET_ERROR_TYPE_TCP_TRANSPORT);
break;
}
#if WS_TRANSPORT_REDIRECT_HEADER_SUPPORT
else if (WS_HTTP_REDIRECT(result)) {
// Redirecting to a new URI
client->config->port = 0;
client->config->uri = esp_transport_ws_get_redir_uri(client->transport);
Copy link
Collaborator

Choose a reason for hiding this comment

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

How long this will be valid? Shall we strdup here?

esp_websocket_client_set_uri(client, client->config->uri);
esp_websocket_client_prepare_transport(client);

// Rerun the connection with the redir uri.
client->state = WEBSOCKET_STATE_INIT;
ESP_LOGI(TAG, "Redirecting to %s", client->config->uri);
break;
}
#endif
ESP_LOGD(TAG, "Transport connected to %s://%s:%d", client->config->scheme, client->config->host, client->config->port);

client->state = WEBSOCKET_STATE_CONNECTED;
Expand Down