Use the async session.asave method if it exists #2092
Conversation
This file contains 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
bigfootjon
force-pushed
the
async-sessions-api
branch
from
6b33357
to
0bcd7a4
Compare
bigfootjon
commented
Apr 21, 2024
| if django.VERSION >= (5, 1): | ||
| await self.scope["session"].asave() | ||
| else: | ||
| await database_sync_to_async(self.scope["session"].save)() | ||
| except UpdateError: | ||
| raise SuspiciousOperation( | ||
| "The request's session was deleted before the " |
There was a problem hiding this comment.
I'm not actually sure how to trigger this logic, because based on reading the Django source code I can't figure out where it would be raised when calling save() without must_create=True
bigfootjon
force-pushed
the
async-sessions-api
branch
from
0bcd7a4
to
545b4e1
Compare
|
@carltongibson: I've added the missing test coverage (such as I could, see inline comment) and fixed the thing you noted. I'm not sure this should be merged before #2090 is resolved since sessions can use the Django ORM under the hood. |
bigfootjon
force-pushed
the
async-sessions-api
branch
from
545b4e1
to
2ac042f
Compare
|
Yes, I too was thinking we need to settle that first 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Support was added in django/django#17372 (slated for release in 5.1)
We can use this API if it exists, otherwise, we fallback to a
sync_to_asyncbridge.This does break backwards compatibility, which I'm not terribly happy about but I'm not sure how best to fix it.
If users overrode
save_sessionin a subclass they would expect that to still work, so I thought the best way to do this was to make it async in the base class and thenawaitit, so at least it will be obvious that it doesn't work (python will raise an exception aboutawaiting a non-awaitable), but I'm open to other solutions.