Skip to content

Add support for partial websocket frame payload reads (IDFGH-14913) #15622

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.

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

Conversation

mrsobakin
Copy link

Description

Added support for partial websocket frame payload reads. This was implemented as a separate function httpd_ws_recv_frame_part to keep the backwards compatibility with subtle httpd_ws_recv_frame behavior, that being that it returns an undocumented error when max_len < pkt->len.

httpd_ws_frame_t now also contains new left_len field, which is used to keep track of the yet to be received data and calculating the mask offset. In the future, it shall also be used for implementing partial frame sends.

Related

Testing

This feature was tested by me on my project and on some additional edge cases, including trying to over-receive (reading more data than there is in a frame payload) and to under-receive (leaving data unprocessed and unread and completing the request). No unexpected errors were identified.

The change itself is not very complex, however in my opinion it is imperative that someone with more knowledge about the ESP HTTP stack verifies that there is no deeper issues with this implementation (and the idea itself, for that matter), which I may have missed.


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.

Copy link

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello mrsobakin, 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 6518fb9

@github-actions github-actions bot changed the title Add support for partial websocket frame payload reads Add support for partial websocket frame payload reads (IDFGH-14913) Mar 21, 2025
@espressif-bot espressif-bot added the Status: Opened Issue is new label Mar 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Opened Issue is new
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants