KTOR-7194 Deferred session fetching for public endpoints #4609
+275
−30
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
bjhham
force-pushed
the
bjhham/deferred-session-retrieval
branch
from
38f8ec5 to
9e7c373
Compare
bjhham
force-pushed
the
bjhham/deferred-session-retrieval
branch
from
9e7c373 to
0f5ad71
Compare
e5l
requested changes
Jan 16, 2025
| * | ||
| * Note: this is only available for JVM in Ktor 3.0 | ||
| */ | ||
| public var deferred: Boolean = false |
There was a problem hiding this comment.
I would mark it with OptIn and look for a better explaining name
There was a problem hiding this comment.
Maybe we should have a system property (like io.ktor.server.sessions.lazycreate) for this instead
There was a problem hiding this comment.
Good idea, this way we don't need to change the API 👍
osipxd
reviewed
Jan 16, 2025
...rver/ktor-server-plugins/ktor-server-sessions/common/src/io/ktor/server/sessions/Sessions.kt
Outdated
Show resolved
Hide resolved
.../ktor-server-sessions/jvmAndPosix/src/io/ktor/server/sessions/BlockingDeferredSessionData.kt
Outdated
Show resolved
Hide resolved
| /** | ||
| * When set to true, sessions will be lazily retrieved from storage. | ||
| * | ||
| * Note: this is only available for JVM in Ktor 3.0 |
| import kotlin.test.assertEquals | ||
| import kotlin.test.assertFailsWith | ||
|
|
||
| class SessionAuthJvmTest { |
There was a problem hiding this comment.
Can't this test be moved to the jvmAndPosix source-set?
Comment on lines
+76
to
+78
| assertFailsWith<IllegalStateException> { | ||
| client.get("/authenticated", withCookie).status | ||
| } |
There was a problem hiding this comment.
Could you also add a successful call after the failed one? Maybe move one of the calls made above
…c/io/ktor/server/sessions/Sessions.kt Co-authored-by: Osip Fatkullin <[email protected]>
…ix/src/io/ktor/server/sessions/BlockingDeferredSessionData.kt Co-authored-by: Osip Fatkullin <[email protected]>
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.
Subsystem
Server, Sessions
Motivation
KTOR-7194 SessionStorage.read() is called for non-authenticated routes and static assets
Solution
This change provides an option in the sessions configuration
deferred = truethat defers session retrieval until it is used in the request.This works by introducing a
CurrentSessionimplementation that uses lazy retrieval to avoid unnecessary calls to the backing storage.