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.

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

fix(webserver): Proposal for simplifying webserver file uploads via form POST. #9167

Merged
merged 2 commits into from
Feb 1, 2024

Conversation

everslick
Copy link
Contributor

@everslick everslick commented Jan 23, 2024

The form parser has been shown to have issues with files ending with "--\r\n". This commit replaces the form parser with the parser from ESP8266, which is simpler and easier to reason about.

The form parser has shown to have issues with files ending with "--\r\n". This commit replaces the form parser with the parser from ESP8266, which passes the test case.
Copy link
Contributor

github-actions bot commented Jan 23, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Proposal for fixing file webserver uploads via form upload.":
    • body's lines must not be longer than 100 characters
    • summary should not end with a period (full stop)
    • summary looks empty
    • type/action looks empty
  • the commit message "Replace _uploadReadByte() in WebServer/Parsing.cpp with ESP8266 implementation.":
    • summary should not end with a period (full stop)
    • summary looks empty
    • type/action looks empty

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

👋 Hello everslick, we appreciate your contribution to 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.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- 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.

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 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.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against 16f7d34

@everslick
Copy link
Contributor Author

The _uploadReadByte() method should be also be replaced with this implementation from ESP8266:

int WebServer::_uploadReadByte(WiFiClient& client){
  int res = client.read();

  if (res < 0) {
    while(!client.available() && client.connected())
      delay(2);

    res = client.read();
  }

  return res;
}

@lucasssvaz
Copy link
Collaborator

The _uploadReadByte() method should be also be replaced with this implementation from ESP8266:

int WebServer::_uploadReadByte(WiFiClient& client){
  int res = client.read();

  if (res < 0) {
    while(!client.available() && client.connected())
      delay(2);

    res = client.read();
  }

  return res;
}

Could you also add this to this PR ?

@lucasssvaz lucasssvaz added Type: Bug 🐛 All bugs Area: Libraries Issue is related to Library support. Status: Needs investigation We need to do some research before taking next steps on this issue and removed Type: Bug 🐛 All bugs labels Jan 26, 2024
@everslick
Copy link
Contributor Author

Done.

@lucasssvaz
Copy link
Collaborator

Thanks, I'll test everything and get back to you

@everslick everslick changed the title Proposal for fixing file webserver uploads via form upload. fix(webserver) Proposal for fixing webserver file uploads via form POST. Jan 27, 2024
@everslick everslick changed the title fix(webserver) Proposal for fixing webserver file uploads via form POST. fix(webserver): Proposal for fixing webserver file uploads via form POST. Jan 27, 2024
@VojtechBartoska VojtechBartoska added Status: Review needed Issue or PR is awaiting review and removed Status: Needs investigation We need to do some research before taking next steps on this issue labels Jan 30, 2024
@VojtechBartoska VojtechBartoska added this to the 3.0.0-RC1 milestone Jan 30, 2024
@everslick everslick changed the title fix(webserver): Proposal for fixing webserver file uploads via form POST. fix(webserver): Proposal for simplifying webserver file uploads via form POST. Jan 31, 2024
Copy link
Member

@P-R-O-C-H-Y P-R-O-C-H-Y left a comment

Choose a reason for hiding this comment

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

Looks good. Tested with WebServer example "FSBrowser".

@me-no-dev me-no-dev merged commit 7c5196d into espressif:master Feb 1, 2024
51 checks passed
@everslick everslick deleted the patch-1 branch February 1, 2024 20:44
Jason2866 added a commit to Jason2866/arduino-esp32 that referenced this pull request Feb 5, 2024
me-no-dev pushed a commit that referenced this pull request Feb 5, 2024
earlephilhower added a commit to earlephilhower/arduino-pico that referenced this pull request May 30, 2024
earlephilhower added a commit to earlephilhower/arduino-pico that referenced this pull request May 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Libraries Issue is related to Library support. Status: Review needed Issue or PR is awaiting review
Projects
Development

Successfully merging this pull request may close these issues.

5 participants