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

Reduce copy of Strings in WebServer RequestHandler #10345

Merged
merged 2 commits into from
Sep 18, 2024
Merged

Reduce copy of Strings in WebServer RequestHandler #10345

merged 2 commits into from
Sep 18, 2024

Conversation

TD-er
Copy link
Contributor

@TD-er TD-er commented Sep 13, 2024

Description of Change

Nearly each function of WebServer RequestHandler does copy the String arguments instead of using const String&.

N.B. This might break some classes which inherit from RequestHandler

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 13, 2024 •
edited
Loading

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Reduce copy of Strings in WebServer RequestHandler":
    • 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).
⚠️

The source branch "RequestHandler_reduce_string_copy" incorrect format:

  • contains uppercase letters. This can cause troubles on case-insensitive file systems (macOS).
    Please rename your branch.

👋 Hello TD-er, 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 6815a0d

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 13, 2024 •
edited
Loading

Memory usage test (comparing PR against master branch)

The table below shows the summary of memory usage change (decrease - increase) in bytes and percentage for each target.

MemoryFLASH [bytes]FLASH [%]RAM [bytes]RAM [%]
TargetDECINCDECINCDECINCDECINC
ESP32S3💚 -12440💚 -0.120.00000.000.00
ESP32S2💚 -12360💚 -0.130.00000.000.00
ESP32C3💚 -17000💚 -0.160.00000.000.00
ESP32C6💚 -17000💚 -0.170.00000.000.00
ESP32💚 -12360💚 -0.120.00000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32S3ESP32S2ESP32C3ESP32C6ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
WebServer/examples/WebServer💚 -12440💚 -12360💚 -17000💚 -17000💚 -12360

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 13, 2024 •
edited
Loading

Test Results

 56 files   -  83   56 suites   - 83   4m 58s ⏱️ - 1h 36m 58s
 21 tests  -   9   21 ✅  -   9  0 💤 ±0  0 ❌ ±0 
135 runs   - 168  135 ✅  - 168  0 💤 ±0  0 ❌ ±0 

Results for commit 6815a0d. ± Comparison against base commit 9e60bbe.

This pull request removes 9 tests. 
performance.coremark.test_coremark ‑ test_coremark
performance.fibonacci.test_fibonacci ‑ test_fibonacci
performance.psramspeed.test_psramspeed ‑ test_psramspeed
performance.ramspeed.test_ramspeed ‑ test_ramspeed
performance.superpi.test_superpi ‑ test_superpi
test_touch_errors
test_touch_interrtupt
test_touch_read
validation.periman.test_periman ‑ test_periman

♻️ This comment has been updated with latest results.

@TD-er TD-er marked this pull request as ready for review September 13, 2024 20:01
me-no-dev
me-no-dev reviewed Sep 16, 2024
View reviewed changes
libraries/WebServer/src/detail/RequestHandlersImpl.h

if (!_isFile) {
// Base URI doesn't point to a file.
// If a directory is requested, look for index file.
if (requestUri.endsWith("/")) {
requestUri += "index.htm";
return handle(server, requestMethod, String(requestUri + "index.htm"));
Copy link
Member

Choose a reason for hiding this comment

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

why?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So we can keep the requestUri const

me-no-dev
me-no-dev reviewed Sep 16, 2024
View reviewed changes
libraries/WebServer/src/detail/RequestHandlersImpl.h
if (!canHandle(server, requestMethod, requestUri)) {
return false;
}

log_v("StaticRequestHandler::handle: request=%s _uri=%s\r\n", requestUri.c_str(), _uri.c_str());

String path(_path);
String eTagCode;
Copy link
Member

Choose a reason for hiding this comment

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

moving it changes nothing

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Less allocated on the stack when it returns early (e.g. due to the added single recursive call you asked about in the previous comment.

@VojtechBartoska VojtechBartoska added the Area: WiFi Issue related to WiFi label Sep 16, 2024
@P-R-O-C-H-Y P-R-O-C-H-Y added the Status: Pending Merge Pull Request is ready to be merged label Sep 18, 2024
@me-no-dev me-no-dev merged commit 100b3c6 into espressif:master Sep 18, 2024
40 checks passed
@TD-er TD-er deleted the RequestHandler_reduce_string_copy branch September 18, 2024 08:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@P-R-O-C-H-Y P-R-O-C-H-Y P-R-O-C-H-Y approved these changes

@me-no-dev me-no-dev me-no-dev approved these changes

Assignees
No one assigned
Labels
Area: WiFi Issue related to WiFi Status: Pending Merge Pull Request is ready to be merged
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@TD-er @me-no-dev @P-R-O-C-H-Y @VojtechBartoska