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

Add exponential backoff to HTTPQueue put #18013

Merged
merged 1 commit into from
Jul 7, 2023
Merged

Add exponential backoff to HTTPQueue put #18013

merged 1 commit into from
Jul 7, 2023

Conversation

lantiga
Copy link
Collaborator

@lantiga lantiga commented Jul 7, 2023

What does this PR do?

This PR adds exponential backoff to posts to the HTTP queue, for added resiliency on the works.
The PR introduces https://github.com/litl/backoff as a dependency.

In general, I think we need to encourage developers to take backoff strategies into account whenever they consume APIs.

Although the backoff package has been released 8 months ago, so it's not moving fast, it is quite ideal for our purposes.

It's very minimal. Not a lot of code and we can easily fix it ourselves. No transitive dependencies.

It has a clean design:

  • you can associate backoff to specific exceptions or predicates, so it's very flexible
  • you can control every aspect of backoff, not just how many retries and how long to retry, but also conditions on when to give up, and hooks to be called when it's backing off and retrying

So given the low risk and the high convenience, I recommend adding this dependency to our package.

Before submitting
  • Was this discussed/agreed via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

Reviewer checklist
  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

cc @Borda

@lantiga lantiga self-assigned this Jul 7, 2023
@lantiga lantiga changed the title Add backoff to queue put Add exponential backoff to HTTPQueue put Jul 7, 2023
@github-actions github-actions bot added the app (removed) Generic label for Lightning App package label Jul 7, 2023
@lantiga lantiga marked this pull request as ready for review July 7, 2023 07:50
@github-actions
Copy link
Contributor

github-actions bot commented Jul 7, 2023

⚡ Required checks status: All passing 🟢

Groups summary

🟢 lightning_app: Tests workflow
Check ID Status
app-pytest (macOS-11, lightning, 3.8, latest) success
app-pytest (macOS-11, lightning, 3.8, oldest) success
app-pytest (macOS-11, app, 3.9, latest) success
app-pytest (ubuntu-20.04, lightning, 3.8, latest) success
app-pytest (ubuntu-20.04, lightning, 3.8, oldest) success
app-pytest (ubuntu-20.04, app, 3.9, latest) success
app-pytest (windows-2022, lightning, 3.8, latest) success
app-pytest (windows-2022, lightning, 3.8, oldest) success
app-pytest (windows-2022, app, 3.8, latest) success

These checks are required after the changes to src/lightning/app/core/queues.py, tests/tests_app/core/test_queues.py, requirements/app/base.txt.

🟢 lightning_app: Examples
Check ID Status
app-examples (macOS-11, lightning, 3.9, latest) success
app-examples (macOS-11, lightning, 3.9, oldest) success
app-examples (macOS-11, app, 3.9, latest) success
app-examples (ubuntu-20.04, lightning, 3.9, latest) success
app-examples (ubuntu-20.04, lightning, 3.9, oldest) success
app-examples (ubuntu-20.04, app, 3.9, latest) success
app-examples (windows-2022, lightning, 3.9, latest) success
app-examples (windows-2022, lightning, 3.9, oldest) success
app-examples (windows-2022, app, 3.9, latest) success

These checks are required after the changes to src/lightning/app/core/queues.py, requirements/app/base.txt.

🟢 lightning_app: Docs
Check ID Status
make-doctest (app) success
make-html (app) success

These checks are required after the changes to src/lightning/app/core/queues.py, requirements/app/base.txt.

🟢 mypy
Check ID Status
mypy success

These checks are required after the changes to requirements/app/base.txt, src/lightning/app/core/queues.py.

🟢 install
Check ID Status
install-pkg (ubuntu-22.04, app, 3.8) success
install-pkg (ubuntu-22.04, app, 3.10) success
install-pkg (ubuntu-22.04, fabric, 3.8) success
install-pkg (ubuntu-22.04, fabric, 3.10) success
install-pkg (ubuntu-22.04, pytorch, 3.8) success
install-pkg (ubuntu-22.04, pytorch, 3.10) success
install-pkg (ubuntu-22.04, lightning, 3.8) success
install-pkg (ubuntu-22.04, lightning, 3.10) success
install-pkg (ubuntu-22.04, notset, 3.8) success
install-pkg (ubuntu-22.04, notset, 3.10) success
install-pkg (macOS-12, app, 3.8) success
install-pkg (macOS-12, app, 3.10) success
install-pkg (macOS-12, fabric, 3.8) success
install-pkg (macOS-12, fabric, 3.10) success
install-pkg (macOS-12, pytorch, 3.8) success
install-pkg (macOS-12, pytorch, 3.10) success
install-pkg (macOS-12, lightning, 3.8) success
install-pkg (macOS-12, lightning, 3.10) success
install-pkg (macOS-12, notset, 3.8) success
install-pkg (macOS-12, notset, 3.10) success
install-pkg (windows-2022, app, 3.8) success
install-pkg (windows-2022, app, 3.10) success
install-pkg (windows-2022, fabric, 3.8) success
install-pkg (windows-2022, fabric, 3.10) success
install-pkg (windows-2022, pytorch, 3.8) success
install-pkg (windows-2022, pytorch, 3.10) success
install-pkg (windows-2022, lightning, 3.8) success
install-pkg (windows-2022, lightning, 3.10) success
install-pkg (windows-2022, notset, 3.8) success
install-pkg (windows-2022, notset, 3.10) success

These checks are required after the changes to src/lightning/app/core/queues.py, requirements/app/base.txt.


Thank you for your contribution! 💜

Note
This comment is automatically generated and updates for 60 minutes every 180 seconds. If you have any other questions, contact carmocca for help.

Copy link
Member

@ethanwharris ethanwharris left a comment

Choose a reason for hiding this comment

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

LGTM!

requirements/app/base.txt Show resolved Hide resolved
@mergify mergify bot added the ready PRs ready to be merged label Jul 7, 2023
@Borda Borda enabled auto-merge (squash) July 7, 2023 08:31
@Borda Borda added this to the 2.0.x milestone Jul 7, 2023
@Borda Borda merged commit bb47517 into master Jul 7, 2023
@Borda Borda deleted the queue-expo-backoff branch July 7, 2023 09:11
Borda pushed a commit that referenced this pull request Jul 7, 2023
Borda pushed a commit that referenced this pull request Jul 7, 2023
lantiga added a commit that referenced this pull request Jul 10, 2023
weiji14 added a commit to regro-cf-autotick-bot/lightning-feedstock that referenced this pull request Jul 17, 2023
weiji14 added a commit to conda-forge/lightning-feedstock that referenced this pull request Jul 17, 2023
* updated v2.0.5

* Update pins for croniter, pydantic, websockets

Xref https://github.com/Lightning-AI/lightning/blame/2.0.5/requirements/app/base.txt

* Add backoff

Xref Lightning-AI/pytorch-lightning#18013

---------

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
app (removed) Generic label for Lightning App package ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants