NEW Add additional session handler implementations by GuySartorelli · Pull Request #11783 · silverstripe/silverstripe-framework

GuySartorelli · 2025-07-14T05:57:35Z

Doing this in several commits - DO NOT SQUASH

Commit 1: The cache-based session handler that can be used for Redis and Memcached
Commit 2: The database session handler
Commit 3: Add new environment variable to set the save handler
Commit 4: Injector allows backticks in the factory key now. This isn't a breaking change, because using backticks for that before would be trying to get a class name that has backticks in it, which PHP doesn't allow.

Issue

New session handlers #11719

GuySartorelli · 2025-07-15T01:20:12Z

Implementing the session handler for cache adapters as a single abstracted handler ended up being simpler than if I tried to implement Redis and Memcached handlers separately - with the bonus that it's also easier to test since we can use Symfony's ArrayAdapter.

GuySartorelli · 2025-07-15T01:20:55Z

The session lifetime is the same across all session handlers so it made sense to move into its own abstract class (pulled from FileSessionHandler).

GuySartorelli · 2025-07-15T01:47:50Z

-    /**
-     * @dataProvider provideDefaultSort
-     */
+    #[DataProvider('provideDefaultSort')]


Unrelated MNT fix. Noticed a warning about this in the test run so I figured I may as well just get it fixed.

GuySartorelli · 2025-07-15T01:48:23Z


        ini_set('session.gc_maxlifetime', $gcLifetime);
-        Session::config()->set('lifetime', $configLifetime);
+        Session::config()->set('timeout', $configLifetime);


This and the implementation in FileSessionHandler were looking at the wrong config name.

GuySartorelli · 2025-07-22T00:19:20Z

+    private function isDatabaseReady()
+    {
+        if (!DB::connection_attempted() || !DB::is_active()) {
+            return false;
+        }
+        return DB::get_schema()->hasTable(static::config()->get('table_name'));
+    }


This was originally going to use the new DataObjectSchema::tablesAreReadyForClass() method, but since we aren't using a DataObject (see phpdoc comment for requireTable() for reasons why not) that's not suitable.
Ultimately since the schema for this table isn't configurable, the table will either exist and have the correct schema, or not exist.

GuySartorelli · 2025-07-22T00:56:12Z

 use SilverStripe\Core\Config\Config;
 use SilverStripe\Core\Injector\Injector;
 use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\PreserveGlobalState;


Noticed this use statement was missing... I have no idea why it wasn't causing CI failures but this class is referenced in some of the tests higher up in this class.

emteknetnz · 2025-07-23T22:05:56Z

+    public function testGc(int $gcLifetime, int $configLifetime, array $sessionLifetimeMap, array $expectDeleted): void
+    {
+        $tableName = DatabaseSessionHandler::config()->get('table_name');
+        ini_set('session.gc_maxlifetime', $gcLifetime);


Shouldn't this be reset after the test?

I don't think it particularly matters (sessions aren't used in CI anyway and this doesn't actually set anything permanently, only for the current process) - but have reset anyway for this and FileSessionHandlerTest to avoid further ping pong.

emteknetnz · 2025-07-23T22:22:42Z

+
+    private function getSessionHandler(): ?DatabaseSessionHandler
+    {
+        $sessionHandlerServiceName = Session::getSaveHandler();


Session::getSaveHandler() returns an object, not a service name?

Probably means we don't need the $sessionHandler = Injector::inst()->get($sessionHandlerServiceName); below?

Oops, I must have had an earlier implementation of getSaveHandler() and not updated this or something. Fixed.

GuySartorelli · 2025-07-24T01:19:51Z

The CI failures are unrelated - compare with the 6 branch

emteknetnz

I set my .env to

SS_SESSION_SAVE_HANDLER_CLASS="SilverStripe\Control\SessionHandler\DatabaseSessionHandler"

and I ran dev/build flush

I got this on the login form when I went to /admin (which then redirects to /Security/login?BackURL=%2Fadmin%2Fpages)

         // Session start emits a cookie, but only if there's no existing session. If there is a session timeout
336                 // tied to this request, make sure the session is held for the entire timeout by refreshing the cookie age.
337                 if ($cookieParams['lifetime'] && $this->requestContainsSessionId()) {
338                     Cookie::set(
339                         session_name(),

Trace

    session_start()
    Session.php:333
    SilverStripe\Control\Session->start(SilverStripe\Control\HTTPRequest)
    Session.php:252
    SilverStripe\Control\Session->init(SilverStripe\Control\HTTPRequest)
    SessionMiddleware.php:17
    SilverStripe\Control\Middleware\SessionMiddleware->process(SilverStripe\Control\HTTPRequest, Closure)
    HTTPMiddlewareAware.php:62
    SilverStripe\Control\Director->SilverStripe\Control\Middleware\{closure}(SilverStripe\Control\HTTPRequest)
    AllowedHostsMiddleware.php:71
    SilverStripe\Control\Middleware\AllowedHostsMiddleware->process(SilverStripe\Control\HTTPRequest, Closure)
    HTTPMiddlewareAware.php:62
    SilverStripe\Control\Director->SilverStripe\Control\Middleware\{closure}(SilverStripe\Control\HTTPRequest)
    TrustedProxyMiddleware.php:179
    SilverStripe\Control\Middleware\TrustedProxyMiddleware->process(SilverStripe\Control\HTTPRequest, Closure)
    HTTPMiddlewareAware.php:62
    SilverStripe\Control\Director->SilverStripe\Control\Middleware\{closure}(SilverStripe\Control\HTTPRequest)
    HTTPMiddlewareAware.php:65
    SilverStripe\Control\Director->callMiddleware(SilverStripe\Control\HTTPRequest, Closure)
    Director.php:382
    SilverStripe\Control\Director->handleRequest(SilverStripe\Control\HTTPRequest)
    HTTPApplication.php:114
    SilverStripe\Control\HTTPApplication::SilverStripe\Control\{closure}(SilverStripe\Control\HTTPRequest)
    call_user_func(Closure, SilverStripe\Control\HTTPRequest)
    HTTPApplication.php:137
    SilverStripe\Control\HTTPApplication->SilverStripe\Control\{closure}(SilverStripe\Control\HTTPRequest)
    HTTPMiddlewareAware.php:65
    SilverStripe\Control\HTTPApplication->callMiddleware(SilverStripe\Control\HTTPRequest, Closure)
    HTTPApplication.php:130
    SilverStripe\Control\HTTPApplication->execute(SilverStripe\Control\HTTPRequest, Closure, )
    HTTPApplication.php:113
    SilverStripe\Control\HTTPApplication->handle(SilverStripe\Control\HTTPRequest)
    index.php:24

GuySartorelli · 2025-07-24T20:58:56Z

Huh. For some reason DB::connection_attempted() was returning false even though we had a connection.
Fixed now by removing that call. The call to DB::is_active() will still prevent us from asking the db if there's a table before we've made a db connection.

emteknetnz

I'm getting the following error on dev/build when I attempt to use memcached

Note there's a good chance one of my setup steps is incorrect. I've never used memcached before

In InjectionCreator.php line 20:
                                                          
  [SilverStripe\Core\Injector\InjectorNotFoundException]  
  Class `SS_SESSION_CACHE_FACTORY` does not exist

# .env
SS_SESSION_SAVE_HANDLER_CLASS="SilverStripe\Control\SessionHandler\CacheSessionHandler"
SS_SESSION_CACHE_FACTORY="SilverStripe\Core\Cache\MemcachedCacheFactory"
SS_MEMCACHED_DSN="memcached://localhost:11211"

I setup memcached in my docker container as follows, as ssh'd in as root user

apt update && apt install -y memcached php8.3-memcached
memcached -d -m 64 -p 11211 -u memcache

Exception trace:
  at /var/www/vendor/silverstripe/framework/src/Core/Injector/InjectionCreator.php:20
 SilverStripe\Core\Injector\InjectionCreator->create() at /var/www/vendor/silverstripe/framework/src/Core/Injector/Injector.php:631
 SilverStripe\Core\Injector\Injector->instantiate() at /var/www/vendor/silverstripe/framework/src/Core/Injector/Injector.php:1027
 SilverStripe\Core\Injector\Injector->getNamedService() at /var/www/vendor/silverstripe/framework/src/Core/Injector/Injector.php:979
 SilverStripe\Core\Injector\Injector->get() at /var/www/vendor/silverstripe/framework/src/Core/Injector/Injector.php:623
 SilverStripe\Core\Injector\Injector->instantiate() at /var/www/vendor/silverstripe/framework/src/Core/Injector/Injector.php:1027
 SilverStripe\Core\Injector\Injector->getNamedService() at /var/www/vendor/silverstripe/framework/src/Core/Injector/Injector.php:979
 SilverStripe\Core\Injector\Injector->get() at /var/www/vendor/silverstripe/framework/src/Core/Injector/Injector.php:521
 SilverStripe\Core\Injector\Injector->convertServiceProperty() at /var/www/vendor/silverstripe/framework/src/Core/Injector/Injector.php:513
 SilverStripe\Core\Injector\Injector->convertServiceProperty() at /var/www/vendor/silverstripe/framework/src/Core/Injector/Injector.php:497
 SilverStripe\Core\Injector\Injector->updateSpecConstructor() at /var/www/vendor/silverstripe/framework/src/Core/Injector/Injector.php:1023
 SilverStripe\Core\Injector\Injector->getNamedService() at /var/www/vendor/silverstripe/framework/src/Core/Injector/Injector.php:979
 SilverStripe\Core\Injector\Injector->get() at /var/www/vendor/silverstripe/framework/src/Control/Session.php:209
 SilverStripe\Control\Session::getSaveHandler() at /var/www/vendor/silverstripe/framework/src/Control/SessionHandler/DbBuildSessionExtension.php:56
 SilverStripe\Control\SessionHandler\DbBuildSessionExtension->getSessionHandler() at /var/www/vendor/silverstripe/framework/src/Control/SessionHandler/DbBuildSessionExtension.php:42
 SilverStripe\Control\SessionHandler\DbBuildSessionExtension->onAfterBuild() at /var/www/vendor/silverstripe/framework/src/Core/Extension.php:141
 SilverStripe\Core\Extension->invokeExtension() at /var/www/vendor/silverstripe/framework/src/Core/Extensible.php:437
 SilverStripe\Dev\Command\DbBuild->extend() at /var/www/vendor/silverstripe/framework/src/Dev/Command/DbBuild.php:178
 SilverStripe\Dev\Command\DbBuild->doBuild() at /var/www/vendor/silverstripe/framework/src/Dev/Command/DbBuild.php:78
 SilverStripe\Dev\Command\DbBuild->execute() at /var/www/vendor/silverstripe/framework/src/Dev/Command/DevCommand.php:37
 SilverStripe\Dev\Command\DevCommand->run() at /var/www/vendor/silverstripe/framework/src/Cli/Command/PolyCommandCliWrapper.php:39
 SilverStripe\Cli\Command\PolyCommandCliWrapper->execute() at /var/www/vendor/symfony/console/Command/Command.php:318
 Symfony\Component\Console\Command\Command->run() at /var/www/vendor/symfony/console/Application.php:1092
 Symfony\Component\Console\Application->doRunCommand() at /var/www/vendor/silverstripe/framework/src/Cli/Sake.php:219
 SilverStripe\Cli\Sake->doRunCommand() at /var/www/vendor/symfony/console/Application.php:341
 Symfony\Component\Console\Application->doRun() at /var/www/vendor/symfony/console/Application.php:192
 Symfony\Component\Console\Application->run() at /var/www/vendor/silverstripe/framework/src/Cli/Sake.php:118
 SilverStripe\Cli\Sake->run() at /var/www/vendor/silverstripe/framework/bin/sake:19
 include() at /var/www/vendor/bin/sake:119

db:build [--no-populate] [--dont_populate]

GuySartorelli · 2025-07-28T22:50:03Z

I think I must have only tested that before setting up the env var. The new injector config doesn't seem to be working based on that first error. I'll look into it.

GuySartorelli · 2025-07-28T23:24:42Z

For some reason with the cached session handler it's forcing dev/build if I'm not authenticated (after fixing the above).... will look into that now.

GuySartorelli · 2025-07-28T23:27:23Z

Rebased in case something where's happening as a result of recent changes

GuySartorelli · 2025-07-28T23:51:45Z

The dev/build thing is caused by #11806 - I'll need to rebase again after the fix is merged.

The intention is to use in-memory cache adapters such as Redis and Memcached - though theoretically any PSR16 adapter would work.

This is an easy option for multi-server hosting environments, though is likely less performant than the other session handlers on offer.

This allows hosting providers to set specific session save handlers if they have infrastructure set up for one that is preferred (e.g. if using redis).

This allows us to use environment variables to set a factory class name in injector configuration.

GuySartorelli marked this pull request as draft July 14, 2025 05:57

GuySartorelli mentioned this pull request Jul 14, 2025

New session handlers #11719

Closed

5 tasks

GuySartorelli force-pushed the pulls/6/session-handlers branch from fa09ce0 to 2a27e43 Compare July 15, 2025 01:18

GuySartorelli commented Jul 15, 2025

View reviewed changes

GuySartorelli force-pushed the pulls/6/session-handlers branch from 2a27e43 to 644e9c3 Compare July 15, 2025 01:46

GuySartorelli commented Jul 15, 2025

View reviewed changes

GuySartorelli force-pushed the pulls/6/session-handlers branch 2 times, most recently from 25821f6 to 7bdad43 Compare July 15, 2025 23:06

This was referenced Jul 16, 2025

NEW: Add method to check if a class is ready for db queries. #10276

Closed

NEW Add method to check if a class is ready for db queries #11784

Merged

NEW Port file-based session handler from CMS 6 silverstripe/silverstripe-non-blocking-sessions#1

Merged

GuySartorelli force-pushed the pulls/6/session-handlers branch 3 times, most recently from 14cf7dc to 8665121 Compare July 22, 2025 00:16

GuySartorelli commented Jul 22, 2025

View reviewed changes

GuySartorelli force-pushed the pulls/6/session-handlers branch 2 times, most recently from b9884bf to b034bcb Compare July 22, 2025 00:55

GuySartorelli commented Jul 22, 2025

View reviewed changes

GuySartorelli marked this pull request as ready for review July 22, 2025 01:03

emteknetnz requested changes Jul 22, 2025

View reviewed changes

Comment thread src/Control/SessionHandler/CacheSessionHandler.php Outdated

Comment thread _config/session.yml Outdated

Comment thread src/Control/SessionHandler/DatabaseSessionHandler.php

GuySartorelli force-pushed the pulls/6/session-handlers branch 3 times, most recently from 6716e3d to f5e2054 Compare July 23, 2025 01:32

emteknetnz requested changes Jul 23, 2025

View reviewed changes

GuySartorelli force-pushed the pulls/6/session-handlers branch from f5e2054 to a51be7e Compare July 23, 2025 03:36

emteknetnz requested changes Jul 23, 2025

View reviewed changes

GuySartorelli force-pushed the pulls/6/session-handlers branch from a51be7e to f0bf1d4 Compare July 23, 2025 22:55

emteknetnz requested changes Jul 24, 2025

View reviewed changes

GuySartorelli force-pushed the pulls/6/session-handlers branch from f0bf1d4 to f7c4336 Compare July 24, 2025 20:58

emteknetnz requested changes Jul 28, 2025

View reviewed changes

GuySartorelli force-pushed the pulls/6/session-handlers branch from 31130fd to 8fe18ae Compare July 28, 2025 23:27

GuySartorelli force-pushed the pulls/6/session-handlers branch from 8fe18ae to a06e507 Compare July 28, 2025 23:38

GuySartorelli force-pushed the pulls/6/session-handlers branch 2 times, most recently from 7b03459 to e1abf42 Compare July 29, 2025 00:13

GuySartorelli added 4 commits July 29, 2025 16:02

NEW Add cache-based session handler implementation

de7f9fe

The intention is to use in-memory cache adapters such as Redis and Memcached - though theoretically any PSR16 adapter would work.

NEW Add database session handler implementation

123a56f

This is an easy option for multi-server hosting environments, though is likely less performant than the other session handlers on offer.

ENH Add environment variable to set session save handler.

967623a

This allows hosting providers to set specific session save handlers if they have infrastructure set up for one that is preferred (e.g. if using redis).

ENH Allow backticks in "factory" injector config

e8e6948

This allows us to use environment variables to set a factory class name in injector configuration.

GuySartorelli force-pushed the pulls/6/session-handlers branch from e1abf42 to e8e6948 Compare July 29, 2025 04:03

emteknetnz approved these changes Jul 30, 2025

View reviewed changes

emteknetnz merged commit ad0b82a into silverstripe:6 Jul 30, 2025
12 checks passed

emteknetnz deleted the pulls/6/session-handlers branch July 30, 2025 02:59

Conversation

GuySartorelli commented Jul 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GuySartorelli commented Jul 24, 2025

Uh oh!

emteknetnz left a comment

Choose a reason for hiding this comment

Uh oh!

GuySartorelli commented Jul 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

emteknetnz left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GuySartorelli commented Jul 28, 2025

Uh oh!

GuySartorelli commented Jul 28, 2025

Uh oh!

GuySartorelli commented Jul 28, 2025

Uh oh!

GuySartorelli commented Jul 28, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

GuySartorelli commented Jul 14, 2025 •

edited

Loading

GuySartorelli commented Jul 24, 2025 •

edited

Loading

emteknetnz left a comment •

edited

Loading