feat(webserver): Middleware with default middleware for cors, authc, curl-like logging by mathieucarbou · Pull Request #10750 · espressif/arduino-esp32 (original) (raw)

Conversation

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters

[ Show hidden characters]({{ revealButtonHref }})

For history, please see: #10186

This PR improves WebServer with the following additions:

• Add Middleware support (aka Expressif) with some built-in middlewares like cors, authc and logging (curl-like)
• Add ability to collect all incoming request headers
• Added response code and info on server

👋 Hello mathieucarbou, 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.
- 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.

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 f977d60

Note:

I kept using chained pointers, I don't know why STL lists are not used across the code, if it is because Arduino Core has to support AVR-like boards where C++ STL is not available ?

Because if it is the case, then why not creating a sort of ArduinoList (like it was done with String) that could be used everywhere, instead of repeating the CRUD logic to manage a list everywhere ? Maybe these structures exist already ?

Test Results

62 files 62 suites 5m 41s ⏱️
21 tests 21 ✅ 0 💤 0 ❌
154 runs 154 ✅ 0 💤 0 ❌

Results for commit f977d60.

♻️ This comment has been updated with latest results.

It's been on my backlog to create something that is thread-safe, but so is a nice Task class... maybe we will find time in near future to do it. In order to have real impact and because the core is partially in C, it would be nice to have a C version that would be implemented in the CPP as well. Then we can go around and replace all lists with that

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.

Click to expand the detailed deltas report [usage change in BYTES]

Choose a reason for hiding this comment

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

maybe replace default construction with non-default member initialization?
last->next = new RequestArgument{.key = headerName, .value = headerValue};

Choose a reason for hiding this comment

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

Choose a reason for hiding this comment

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

we can use consteval in arduino code ? removing it to your sample and switching to c++11 or 17 leads to a completely different output. So is it worth doing it ?

Choose a reason for hiding this comment

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

we can use consteval in arduino code ?

consteval introduce in c++20 -- if this standard is available, consteval will be available.
but I gave that code as a demonstration that everything will be fine (even in constexpr context)

Choose a reason for hiding this comment

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

Choose a reason for hiding this comment

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

I wanted to say in general that instead of several operations, you can do all of them at once with one.

last->next = new RequestArgument(); last->next->key = headerName; last->next->value = headerValue;

->
last->next = new RequestArgument{ headerName, headerValue };

Choose a reason for hiding this comment

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

yes, completely agree!

Labels