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

[Examples] [Async Handlers] simplify code by splitting long_async_handler into two functions (IDFGH-14011) #14834

Merged
merged 1 commit into from
Dec 3, 2024

Conversation

chipweinberger
Copy link
Contributor

@chipweinberger chipweinberger commented Nov 5, 2024

I originally wrote this example, but made it too complicated.

I don't know what I was thinking. I was calling long_async_handler twice, and used a is_on_async_worker_thread to do different behavior depending on which thread you are on.

This is needlessly complicated.

It's much simpler to have two functions:
long_handler - called on http thread
long_async - called on async thread.

This leads to much more straight forward code.

I also simplified some variable names.

Copy link

github-actions bot commented Nov 5, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "[Examples] [Async Handlers] simplify code":
    • 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 chipweinberger, 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.
- 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 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 a89a954

@chipweinberger chipweinberger changed the title [Examples] [Async Handlers] simplify code by splittin long_async_handler into two functions [Examples] [Async Handlers] simplify code by splitting long_async_handler into two functions Nov 5, 2024
@espressif-bot espressif-bot added the Status: Opened Issue is new label Nov 5, 2024
@github-actions github-actions bot changed the title [Examples] [Async Handlers] simplify code by splitting long_async_handler into two functions [Examples] [Async Handlers] simplify code by splitting long_async_handler into two functions (IDFGH-14011) Nov 5, 2024
@nileshkale123
Copy link
Collaborator

sha=a89a954a850bdb425edfef920ce7c05ab77188c9

@nileshkale123 nileshkale123 added the PR-Sync-Merge Pull request sync as merge commit label Nov 6, 2024
@espressif-bot espressif-bot added Status: Reviewing Issue is being reviewed and removed Status: Opened Issue is new labels Nov 12, 2024
@espressif-bot espressif-bot added Status: Done Issue is done internally Resolution: NA Issue resolution is unavailable and removed Status: Reviewing Issue is being reviewed labels Nov 26, 2024
@espressif-bot espressif-bot merged commit ac35595 into espressif:master Dec 3, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR-Sync-Merge Pull request sync as merge commit Resolution: NA Issue resolution is unavailable Status: Done Issue is done internally
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants