bug #49097 [HttpFoundation] inject SessionHandler in PdoSessionHandlerSchemaSubscriber (alli83)

nicolas-grekas · nicolas-grekas · commit a08a41c65fbb · 2023-01-29T11:32:45.000+01:00
This PR was merged into the 6.3 branch. Discussion ---------- [HttpFoundation] inject SessionHandler in PdoSessionHandlerSchemaSubscriber | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | yes | New feature? | no | Deprecations? | no | License | MIT | Doc PR | I'm working on it following the PR #48059. In #48059, it works only if you put the handler explicitly to PdoSessionHandler in the configuration (handler_id) but it stops working if the session is defined by the factory and we can't use it as follow: ```` handler_id: '%env(resolve:DATABASE_URL)%' ````` Linked to DoctrineBundle PR doctrine/DoctrineBundle#1623 Also imho, I think the second argument of configureSchema inPdoSessionHandler should be optional and set to return true if not defined since the function is public eg. one wants to add the table to the Schema. Commits ------- 9aded06 [HttpFoundation] inject SessionHandler in PdoSessionHandlerSchemaSubscriber
diff --git a/src/Symfony/Bridge/Doctrine/SchemaListener/PdoSessionHandlerSchemaSubscriber.php b/src/Symfony/Bridge/Doctrine/SchemaListener/PdoSessionHandlerSchemaSubscriber.php
@@ -16,22 +16,24 @@
 
 final class PdoSessionHandlerSchemaSubscriber extends AbstractSchemaSubscriber
 {
-    private iterable $pdoSessionHandlers;
+    private PdoSessionHandler $sessionHandler;
 
-    /**
-     * @param iterable<mixed, PdoSessionHandler> $pdoSessionHandlers
-     */
-    public function __construct(iterable $pdoSessionHandlers)
+    public function __construct(\SessionHandlerInterface $sessionHandler)
     {
-        $this->pdoSessionHandlers = $pdoSessionHandlers;
+        if ($sessionHandler instanceof PdoSessionHandler) {
+            $this->sessionHandler = $sessionHandler;
+        }
+    }
+
+    public function getSubscribedEvents(): array
+    {
+        return isset($this->sessionHandler) ? parent::getSubscribedEvents() : [];
     }
 
     public function postGenerateSchema(GenerateSchemaEventArgs $event): void
     {
         $connection = $event->getEntityManager()->getConnection();
 
-        foreach ($this->pdoSessionHandlers as $pdoSessionHandler) {
-            $pdoSessionHandler->configureSchema($event->getSchema(), $this->getIsSameDatabaseChecker($connection));
-        }
+        $this->sessionHandler->configureSchema($event->getSchema(), $this->getIsSameDatabaseChecker($connection));
     }
 }
diff --git a/src/Symfony/Bridge/Doctrine/Tests/SchemaListener/PdoSessionHandlerSchemaSubscriberTest.php b/src/Symfony/Bridge/Doctrine/Tests/SchemaListener/PdoSessionHandlerSchemaSubscriberTest.php
@@ -36,7 +36,7 @@ public function testPostGenerateSchemaPdo()
             ->method('configureSchema')
             ->with($schema, fn () => true);
 
-        $subscriber = new PdoSessionHandlerSchemaSubscriber([$pdoSessionHandler]);
+        $subscriber = new PdoSessionHandlerSchemaSubscriber($pdoSessionHandler);
         $subscriber->postGenerateSchema($event);
     }
 }
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/PdoSessionHandler.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/PdoSessionHandler.php
@@ -178,9 +178,12 @@ public function __construct(#[\SensitiveParameter] \PDO|string $pdoOrDsn = null,
         $this->ttl = $options['ttl'] ?? null;
     }
 
-    public function configureSchema(Schema $schema, \Closure $isSameDatabase): void
+    /**
+     * Adds the Table to the Schema if it doesn't exist.
+     */
+    public function configureSchema(Schema $schema, \Closure $isSameDatabase = null): void
     {
-        if ($schema->hasTable($this->table) || !$isSameDatabase($this->getConnection()->exec(...))) {
+        if ($schema->hasTable($this->table) || ($isSameDatabase && !$isSameDatabase($this->getConnection()->exec(...)))) {
             return;
         }
 

Original file line number	Diff line number	Diff line change
`@@ -16,22 +16,24 @@`
`16`	`16`
`17`	`17`	`final class PdoSessionHandlerSchemaSubscriber extends AbstractSchemaSubscriber`
`18`	`18`	`{`
`19`		`- private iterable $pdoSessionHandlers;`
	`19`	`+ private PdoSessionHandler $sessionHandler;`
`20`	`20`
`21`		`- /**`
`22`		`- * @param iterable<mixed, PdoSessionHandler> $pdoSessionHandlers`
`23`		`- */`
`24`		`- public function __construct(iterable $pdoSessionHandlers)`
	`21`	`+ public function __construct(\SessionHandlerInterface $sessionHandler)`
`25`	`22`	`{`
`26`		`- $this->pdoSessionHandlers = $pdoSessionHandlers;`
	`23`	`+ if ($sessionHandler instanceof PdoSessionHandler) {`
	`24`	`+ $this->sessionHandler = $sessionHandler;`
	`25`	`+ }`
	`26`	`+ }`
	`27`	`+`
	`28`	`+ public function getSubscribedEvents(): array`
	`29`	`+ {`
	`30`	`+ return isset($this->sessionHandler) ? parent::getSubscribedEvents() : [];`
`27`	`31`	`}`
`28`	`32`
`29`	`33`	`public function postGenerateSchema(GenerateSchemaEventArgs $event): void`
`30`	`34`	`{`
`31`	`35`	`$connection = $event->getEntityManager()->getConnection();`
`32`	`36`
`33`		`- foreach ($this->pdoSessionHandlers as $pdoSessionHandler) {`
`34`		`- $pdoSessionHandler->configureSchema($event->getSchema(), $this->getIsSameDatabaseChecker($connection));`
`35`		`- }`
	`37`	`+ $this->sessionHandler->configureSchema($event->getSchema(), $this->getIsSameDatabaseChecker($connection));`
`36`	`38`	`}`
`37`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public function testPostGenerateSchemaPdo()`
`36`	`36`	`->method('configureSchema')`
`37`	`37`	`->with($schema, fn () => true);`
`38`	`38`
`39`		`- $subscriber = new PdoSessionHandlerSchemaSubscriber([$pdoSessionHandler]);`
	`39`	`+ $subscriber = new PdoSessionHandlerSchemaSubscriber($pdoSessionHandler);`
`40`	`40`	`$subscriber->postGenerateSchema($event);`
`41`	`41`	`}`
`42`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -178,9 +178,12 @@ public function __construct(#[\SensitiveParameter] \PDO\|string $pdoOrDsn = null,`
`178`	`178`	`$this->ttl = $options['ttl'] ?? null;`
`179`	`179`	`}`
`180`	`180`
`181`		`- public function configureSchema(Schema $schema, \Closure $isSameDatabase): void`
	`181`	`+ /**`
	`182`	`+ * Adds the Table to the Schema if it doesn't exist.`
	`183`	`+ */`
	`184`	`+ public function configureSchema(Schema $schema, \Closure $isSameDatabase = null): void`
`182`	`185`	`{`
`183`		`- if ($schema->hasTable($this->table) \|\| !$isSameDatabase($this->getConnection()->exec(...))) {`
	`186`	`+ if ($schema->hasTable($this->table) \|\| ($isSameDatabase && !$isSameDatabase($this->getConnection()->exec(...)))) {`
`184`	`187`	`return;`
`185`	`188`	`}`
`186`	`189`