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

Protect Flow from exception during request processing #15187

Merged
merged 16 commits into from
Oct 19, 2022
Merged

Conversation

tchaton
Copy link
Contributor

@tchaton tchaton commented Oct 19, 2022

What does this PR do?

This PR adds a try / catch mechanism around request processing on the flow to avoid failure points coming from the Rest API.

Furthermore, a user can return the expection status code he wishes using fastapi HTTPException.

from fastapi import HTTPException

class FlowAPI(LightningFlow):
    def __init__(self):
        super().__init__()
        self.counter = 0

    def run(self):
         pass

    def request(self, ...):
        self.counter += 1
        if config.index % 5 == 0:
            raise HTTPException(status_code=400, detail="HERE")
        return OutputRequestModel(name=config.name, counter=self.counter)

    def configure_api(self):
        return [Post("/api/v1/request", self.request)]

Note: The state isn't restored if a failure happens. This is left for another PR.

Fixes #<issue_number>

Does your PR introduce any breaking changes? If yes, please list them.

Before submitting

  • Was this discussed/approved 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:

  • 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

Did you have fun?

Make sure you had fun coding 🙃

cc @Borda

@tchaton tchaton changed the title Protect Flow Protect Flow from exception in request processing Oct 19, 2022
@github-actions github-actions bot added the app (removed) Generic label for Lightning App package label Oct 19, 2022
@tchaton tchaton self-assigned this Oct 19, 2022
@tchaton tchaton added this to the future milestone Oct 19, 2022
@tchaton tchaton changed the title Protect Flow from exception in request processing Protect Flow from exception during request processing Oct 19, 2022
@tchaton tchaton added bug Something isn't working app:lightningflow labels Oct 19, 2022
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, small question

src/lightning_app/api/http_methods.py Outdated Show resolved Hide resolved
@mergify mergify bot added the ready PRs ready to be merged label Oct 19, 2022
@tchaton tchaton enabled auto-merge (squash) October 19, 2022 15:34
@mergify mergify bot added has conflicts and removed ready PRs ready to be merged labels Oct 19, 2022
@mergify mergify bot added ready PRs ready to be merged and removed has conflicts ready PRs ready to be merged labels Oct 19, 2022
@tchaton tchaton merged commit d675d06 into master Oct 19, 2022
@tchaton tchaton deleted the protect_flow branch October 19, 2022 18:29
@carmocca carmocca modified the milestones: future, v1.8 Oct 19, 2022
@tchaton tchaton mentioned this pull request Oct 20, 2022
12 tasks
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 bug Something isn't working ready PRs ready to be merged
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants