feat: add support for automatic session driver config #13145
+1,180
−166
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
🦋 Changeset detectedLatest commit: d0fac27 The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
github-actions
bot
added
pkg: astro
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
CodSpeed Performance ReportMerging #13145 will not alter performanceComparing Summary
|
github-actions
bot
added
the
pkg: integration
|
!preview adapter-sessions |
|
!preview adapter-sessions |
|
❌ Snapshot release failed. |
|
!preview adapter-sessions |
|
Snapshots have been released for the following packages:
Build LogPublish Log |
ascorbic
force-pushed
the
session-config2
branch
from
8a63aac to
db142f0
Compare
|
|
|
@ematipico I will actually bump it to 5.3.0, because this PR changes the API |
ematipico
reviewed
Feb 10, 2025
| return driver; | ||
| } | ||
|
|
||
| export function validateSessionConfig(settings: AstroSettings): void { |
There was a problem hiding this comment.
Why don't we validate the configuration inside the zod schema using refine or superRefine?
EDIT: I understand why we need a function, I think it's worth adding a comment that explains that
sarah11918
reviewed
Feb 11, 2025
| }); | ||
| ``` | ||
|
|
||
| You do not need to configure the session driver if you are using an adapter that supports automatic session driver configuration. For more information, see the [experimental session docs](https://docs.astro.build/en/reference/experimental-flags/sessions/). |
There was a problem hiding this comment.
Suggested change
| You do not need to configure the session driver if you are using an adapter that supports automatic session driver configuration. For more information, see the [experimental session docs](https://docs.astro.build/en/reference/experimental-flags/sessions/). | |
| You no longer need to configure a session driver if you are using an adapter that supports automatic session driver configuration and wish to use its default settings. | |
| However, you can still manually configure additional driver options or choose a non-default driver to use with your adapter with the new top-level `session` config option. For more information, see the [experimental session docs](https://docs.astro.build/en/reference/experimental-flags/sessions/). |
Just thought somewhere we could mention that there are options that someone might want to set for even the default supported driver? (If I have this right.) It's not that session is only for choosing a different driver, but for setting any options like the new ttl etc.
|
|
||
| Changes the `experimental.session` option to a boolean flag and moves session config to a top-level value. This change is to allow the new automatic session driver support. You now need to separately enable the `experimental.session` flag, and then configure the session driver using the top-level `session` key if providing manual configuration. | ||
|
|
||
| ```diff |
There was a problem hiding this comment.
Following on the previous comment, I would suggest that the code sample not just move fs out to session, but demonstrate either:
- also showing an adapter like Netlify, so that it's clear that this is showing a non-default driver chosen OR
- show either the Node or Netlify adapter and do NOT show configuring a driver, but some option like
baseetc. to reinforce that stating the driver isn't needed for these
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.
Changes
Automatically configures session storage with the Node and Netlify adapters. If the
experimental.sessionflag is enabled, the Node adapter will configurefssession storage and Netlify will configurenetlify-blobssession storage.This also changes the
experimental.sessionoption to a boolean flag and moves session config to a top-level value. Separating them is to allow users to enable it without needing to set the config, thus allowing for adapters and integrations to handle it.You now need to separately enable the
experimental.sessionflag, and then configure the session driver using the top-levelsessionkey if providing manual configuration.defineConfig({ // ... experimental: { - session: { - driver: 'fs', - }, + session: true, }, + session: { + driver: 'fs', + }, });You do not need to configure the session driver if you are using the Node or Netlify adapters and want to use the default session drivers for each adapter. The default session driver for the Node adapter is
fs, and the default session driver for the Netlify adapter isnetlify-blobs.For example, if you are using the Node adapter, you can just enable the flag:
This will configure the session driver to use the default
fsdriver for the Node adapter. See the release notes for@astrojs/nodeand@astrojs/netlifyfor more information on the default session drivers for each adapter.If you enable the flag but are using an adapter that does not have a default session driver, you will need to configure the session driver manually or the build will fail.
Testing
Added test cases for the Node and Netlify adapters. The Netlify tests use the local mock blobs server.
Docs
Updated the docs for the config options. This adds several new error types, so I have moved session errors into their own section. I will do a separate PR to the docs repo to update the experimental feature page.