feat(ws_transport): add header callback hook (IDFGH-15479) #16119

bryghtlabs-richard · 2025-06-12T18:26:51Z

Description

Add a callback for each line of header responses in the Websocket HTTP->WS transport upgrade. This is necessary to support AWS ALB and F5 cookie-based load-balancer sticky-sessions.

Testing

Existing "Sec-WebSocket-Accept" header-parsing was tested by connecting to a websocket. Failure was tested by intentionally setting server_key = NULL and confirming we still reject the connection.
New headers were tested by logging each header-line with ESP_LOGI() at the next layer up, in the esp_websocket_client.

Checklist

Before submitting a Pull Request, please ensure the following:

🚨 This PR does not introduce breaking changes.
All CI checks (GH Actions) pass.
Documentation is updated as needed.
Tests are updated or added as necessary.
Code is well-commented, especially in complex areas.
Git history is clean — commits are squashed to the minimum necessary.

Send a new event for each HTTP header-line received. Depends on espressif/esp-idf#16119 Closes espressif#715

components/tcp_transport/transport_ws.c

Buffer separately to simplify future improvements.

Move to a line-by-line header parser. Support a callback hook for each header-line. Migrate "Location" and "Sec-WebSocket-Accept" parsing. Part of espressif/esp-protocols#715

github-actions · 2025-06-26T16:07:12Z

	Messages
📖	🎉 Good Job! All checks are passing!

👋 Hello bryghtlabs-richard, we appreciate your contribution to this project!

📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.

Click to see more instructions ...

This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...

We do welcome contributions in the form of bug reports, feature requests and pull requests via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved, we synchronize it into our internal git repository.
4. In the internal git repository we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by 🚫 dangerJS against 0245c5c

glmfe · 2025-08-27T14:35:38Z

sha=0245c5c863fd1bf08ed9fbd913f8cccb297948cc

euripedesrocha · 2025-08-28T09:09:29Z

sha=0245c5c863fd1bf08ed9fbd913f8cccb297948cc

glmfe · 2025-09-01T19:08:49Z

Hi @bryghtlabs-richard,

I've got some comments from colleagues internally that I'll post them here as well

glmfe · 2025-09-01T19:09:11Z

components/tcp_transport/include/esp_transport_ws.h

+ *      - ESP_OK on success
+ *      - One of the error codes
+ */
+esp_err_t esp_transport_ws_set_header_userp(esp_transport_handle_t t, void * userp);


Why do we need to set this pointer in a separated function? Could it be a context in the set header hook?

Indeed it could. I'm fine with either way.

glmfe · 2025-09-01T19:10:07Z

components/tcp_transport/transport_ws.c

+        err = esp_transport_ws_set_header_hook(t, config->header_hook);
+        ESP_TRANSPORT_ERR_OK_CHECK(TAG, err, return err;)
+    }
+    if (config->header_userp) {


What if user set this, but the hook isn't configured, should we warn? Is the idea that the context for the callback could change in between calls?

I'm not sure I would worry about it, but if it's preferred we could. I don't expect anyone would change the header_userp context in-between headers, given that their ordering isn't guaranteed.

glmfe · 2025-09-26T11:35:32Z

Accepted as 11f8534

Thanks for your contribution!

Send a new event for each HTTP header-line received. Depends on espressif/esp-idf#16119 Closes espressif#715

Send a new event for each HTTP header-line received. Depends on espressif/esp-idf#16119 Closes #715

bryghtlabs-richard added a commit to bryghtlabs-richard/esp-protocols that referenced this pull request Jun 12, 2025

feat(websocket): add WEBSOCKET_EVENT_HEADER_RECEIVED

6be5991

Send a new event for each HTTP header-line received. Depends on espressif/esp-idf#16119 Closes espressif#715

bryghtlabs-richard mentioned this pull request Jun 12, 2025

feat(websocket): add WEBSOCKET_EVENT_HEADER_RECEIVED (IDFGH-16539) espressif/esp-protocols#827

Merged

6 tasks

bryghtlabs-richard added a commit to bryghtlabs-richard/esp-protocols that referenced this pull request Jun 12, 2025

feat(websocket): add WEBSOCKET_EVENT_HEADER_RECEIVED

f96e373

Send a new event for each HTTP header-line received. Depends on espressif/esp-idf#16119 Closes espressif#715

bryghtlabs-richard added a commit to bryghtlabs-richard/esp-protocols that referenced this pull request Jun 12, 2025

feat(websocket): add WEBSOCKET_EVENT_HEADER_RECEIVED

90cef3a

Send a new event for each HTTP header-line received. Depends on espressif/esp-idf#16119 Closes espressif#715

bryghtlabs-richard force-pushed the feat/ws_transport_header_callbacks branch from f5ff595 to f8c65f8 Compare June 12, 2025 18:46

github-actions bot changed the title ~~feat(ws_transport): add header callback hook~~ feat(ws_transport): add header callback hook (IDFGH-15479) Jun 12, 2025

espressif-bot added the Status: Opened Issue is new label Jun 12, 2025

espressif-bot assigned euripedesrocha and glmfe and unassigned euripedesrocha Jun 13, 2025

glmfe reviewed Jun 26, 2025

View reviewed changes

components/tcp_transport/transport_ws.c Show resolved Hide resolved

components/tcp_transport/transport_ws.c Outdated Show resolved Hide resolved

bryghtlabs-richard added 2 commits June 26, 2025 10:41

feat(transport_ws): buffer redir_host separately

7629d08

Buffer separately to simplify future improvements.

feat(transport_ws): add header callback hook

0245c5c

Move to a line-by-line header parser. Support a callback hook for each header-line. Migrate "Location" and "Sec-WebSocket-Accept" parsing. Part of espressif/esp-protocols#715

bryghtlabs-richard force-pushed the feat/ws_transport_header_callbacks branch from f8c65f8 to 0245c5c Compare June 26, 2025 16:06

This was referenced Jun 26, 2025

Fix/ws transport reject multisec (IDFGH-15569) #16199

Closed

feat(websocket): Add ws get HTTP response headers espressif/esp-protocols#794

Open

euripedesrocha added PR-Sync-Merge Pull request sync as merge commit and removed PR-Sync-Merge Pull request sync as merge commit labels Aug 28, 2025

euripedesrocha added the PR-Sync-Merge Pull request sync as merge commit label Aug 28, 2025

espressif-bot added Status: Reviewing Issue is being reviewed and removed Status: Opened Issue is new labels Aug 29, 2025

glmfe reviewed Sep 1, 2025

View reviewed changes

espressif-bot added Status: Done Issue is done internally Resolution: NA Issue resolution is unavailable Resolution: Done Issue is done internally and removed Status: Reviewing Issue is being reviewed labels Sep 12, 2025

espressif-bot removed the Resolution: NA Issue resolution is unavailable label Sep 12, 2025

glmfe closed this Sep 26, 2025

glmfe mentioned this pull request Sep 26, 2025

[WebSocket Transport]: parse response line-at-a-time (IDFGH-15935) #16871

Open

bryghtlabs-richard added a commit to bryghtlabs-richard/esp-protocols that referenced this pull request Sep 29, 2025

feat(websocket): add WEBSOCKET_EVENT_HEADER_RECEIVED

3a9529b

Send a new event for each HTTP header-line received. Depends on espressif/esp-idf#16119 Closes espressif#715

bryghtlabs-richard added a commit to bryghtlabs-richard/esp-protocols that referenced this pull request Oct 3, 2025

feat(websocket): add WEBSOCKET_EVENT_HEADER_RECEIVED

57d48bb

Send a new event for each HTTP header-line received. Depends on espressif/esp-idf#16119 Closes espressif#715

bryghtlabs-richard added a commit to bryghtlabs-richard/esp-protocols that referenced this pull request Oct 22, 2025

feat(websocket): add WEBSOCKET_EVENT_HEADER_RECEIVED

b13064d

Send a new event for each HTTP header-line received. Depends on espressif/esp-idf#16119 Closes espressif#715

glmfe pushed a commit to espressif/esp-protocols that referenced this pull request Oct 22, 2025

feat(websocket): add WEBSOCKET_EVENT_HEADER_RECEIVED (#827)

18f0d02

Send a new event for each HTTP header-line received. Depends on espressif/esp-idf#16119 Closes #715

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(ws_transport): add header callback hook (IDFGH-15479) #16119

feat(ws_transport): add header callback hook (IDFGH-15479) #16119

Uh oh!

bryghtlabs-richard commented Jun 12, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jun 26, 2025 •

edited

Loading

Uh oh!

glmfe commented Aug 27, 2025

Uh oh!

euripedesrocha commented Aug 28, 2025

Uh oh!

glmfe commented Sep 1, 2025

Uh oh!

glmfe Sep 1, 2025

Uh oh!

bryghtlabs-richard Sep 1, 2025

Uh oh!

glmfe Sep 1, 2025

Uh oh!

bryghtlabs-richard Sep 1, 2025

Uh oh!

glmfe commented Sep 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

feat(ws_transport): add header callback hook (IDFGH-15479) #16119

feat(ws_transport): add header callback hook (IDFGH-15479) #16119

Uh oh!

Conversation

bryghtlabs-richard commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related

Testing

Checklist

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

glmfe commented Aug 27, 2025

Uh oh!

euripedesrocha commented Aug 28, 2025

Uh oh!

glmfe commented Sep 1, 2025

Uh oh!

glmfe Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

bryghtlabs-richard Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

glmfe Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

bryghtlabs-richard Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

glmfe commented Sep 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

bryghtlabs-richard commented Jun 12, 2025 •

edited

Loading

github-actions bot commented Jun 26, 2025 •

edited

Loading