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 3 commits into
base: master
Choose a base branch
from
Open

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

wants to merge 3 commits into from
+35 −7

Conversation

bryghtlabs-richard
Copy link
Contributor

@bryghtlabs-richard bryghtlabs-richard commented Oct 30, 2024 •
edited
Loading

Description

When transport_ws fails to read data from the underlying transport, add the result code so that we can look up the failure reason directly. This makes debugging failures at the next layer down simpler.

Related

Please wait for #14706 first, to avoid merge conflicts.

Testing

I unplugged my wireless router's uplink port, then observed the failure code in the console log.

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.

@bryghtlabs-richard
fix(ws_transport): correct split header bytes
093ea00 
When the underlying transport returns header,
length, or mask bytes early, again call the
underlying transport.

This solves the WS parser getting offset when
the server sends a burst of frames where the
last WS header is split across packet boundaries,
so fewer than the needed bytes may be available.
@bryghtlabs-richard
feat(ws_transport): include error reason in failure log
175a42c 
When the underlying transport returns a failure,
add the failure result to the log.
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 30, 2024 •
edited
Loading

Messages
📖 You might consider squashing your 3 commits (simplifying branch history).

👋 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.
- Addressing info messages (📖) is strongly recommended; they're less critical but valuable.
- 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 539213f

@espressif-bot espressif-bot added the Status: Opened Issue is new label Oct 30, 2024
@github-actions github-actions bot changed the title Extend websocket error logs to include transport failure reason Extend websocket error logs to include transport failure reason (IDFGH-13978) Oct 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@euripedesrocha euripedesrocha

Labels
Status: Opened Issue is new
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@bryghtlabs-richard @euripedesrocha @espressif-bot