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

Shield background tasks #1654

Closed
wants to merge 3 commits into from
Closed

Shield background tasks #1654

wants to merge 3 commits into from

Conversation

Kludex
Copy link
Sponsor Member

@Kludex Kludex commented May 31, 2022

I'm not sure if we should be touching BackgroundTasks.

This PR allows BackgroundTasks to run until they finish.

starlette/background.py Outdated Show resolved Hide resolved
Comment on lines +45 to +46
with anyio.CancelScope(shield=True):
for task in self.tasks:
Copy link
Member

Choose a reason for hiding this comment

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

Could we make this opt in on a per-task basis? For backwards compatibility and because I don't think in some cases it does make sense to cancel the background task if the client closes the connection.

Copy link
Sponsor Member Author

Choose a reason for hiding this comment

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

Which cases?

Copy link
Member

Choose a reason for hiding this comment

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

Business logic. Like if you're doing something that is expensive and you don't care if it succeeds or fails if the client closes the connection. No specific use case in mind, just thinking in general.

Although now I realize this is even more complicated because the behavior changes depending on if there is a BaseHTTPMiddleware involved, right? What happens if there isn't a BaseHTTPMiddleaware involved? Does it depend on the ASGI server?

Copy link
Sponsor Member Author

Choose a reason for hiding this comment

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

fails if the client closes the connection

bkg tasks runs after the response 🤔

Copy link
Member

Choose a reason for hiding this comment

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

Sorry I was maybe getting a bit confused as to what actually causes the issue.

for task in self.tasks:
await task()
async with anyio.create_task_group():
with anyio.CancelScope(shield=True):
Copy link
Member

@adriangb adriangb Jun 3, 2022

Choose a reason for hiding this comment

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

Is this task group needed? I think just the cancel scope should be enough.

@Kludex
Copy link
Sponsor Member Author

Kludex commented Jun 9, 2022

This is not what we want. 😞

Trying to fix issues of BaseHTTPMiddleware outside of it doesn't look good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Background tasks are cancelled if the client closes connection
2 participants