Merge pull request #2637 from neos/dependabot/composer/doctrine/dbal-tw-3.2

!!! FEATURE: update to `doctrine/dbal` version 3

Author: kitsunet

Neos.Flow/Classes/Cache/CacheManager.php

@@ -218,6 +218,7 @@ public function getSimpleCache(string $identifier): CacheInterface
      *
      * @param string $identifier
      * @return CacheItemPoolInterface
+     * @throws NoSuchCacheException
      */
     public function getCacheItemPool(string $identifier): CacheItemPoolInterface
     {

Neos.Flow/Classes/Command/DatabaseCommandController.php

@@ -124,7 +124,7 @@ protected function convertToCharacterSetAndCollation(string $characterSet, strin
 
         $statements[] = 'ALTER DATABASE ' . $this->connection->quoteIdentifier($this->persistenceSettings['backendOptions']['dbname']) . ' CHARACTER SET ' . $characterSet . ' COLLATE ' . $collation;
 
-        $tableNames = $this->connection->getSchemaManager()?->listTableNames() ?? [];
+        $tableNames = $this->connection->createSchemaManager()->listTableNames() ?? [];
         foreach ($tableNames as $tableName) {
             $statements[] = 'ALTER TABLE ' . $this->connection->quoteIdentifier($tableName) . ' DEFAULT CHARACTER SET ' . $characterSet . ' COLLATE ' . $collation;
             $statements[] = 'ALTER TABLE ' . $this->connection->quoteIdentifier($tableName) . ' CONVERT TO CHARACTER SET ' . $characterSet . ' COLLATE ' . $collation;

Neos.Flow/Classes/Command/DoctrineCommandController.php

@@ -14,6 +14,7 @@
 use Doctrine\Common\Util\Debug;
 use Doctrine\DBAL\Exception as DBALException;
 use Doctrine\Migrations\Exception\MigrationException;
+use Doctrine\ORM\ORMException;
 use Doctrine\ORM\Tools\ToolsException;
 use Doctrine\Persistence\Mapping\ClassMetadata;
 use Neos\Flow\Annotations as Flow;
@@ -200,7 +201,7 @@ public function updateCommand(bool $unsafeMode = false, string $output = null):
      * @param boolean $dumpMappingData If set, the mapping data will be output
      * @param string|null $entityClassName If given, the mapping data for just this class will be output
      * @return void
-     * @throws \Doctrine\ORM\ORMException
+     * @throws ORMException
      * @see neos.flow:doctrine:validate
      */
     public function entityStatusCommand(bool $dumpMappingData = false, string $entityClassName = null): void
@@ -282,22 +283,24 @@ public function dqlCommand(int $depth = 3, string $hydrationMode = 'array', int
      * available, executed and pending migrations.
      *
      * @param boolean $showMigrations Output a list of all migrations and their status
+     * @param string|null $migrationFolder Provide alternative platform folder name (as in "Mysql"), otherwise configured connection is used.
      * @return void
-     * @throws StopCommandException
      * @throws DBALException
+     * @throws StopCommandException
      * @see neos.flow:doctrine:migrate
      * @see neos.flow:doctrine:migrationexecute
      * @see neos.flow:doctrine:migrationgenerate
      * @see neos.flow:doctrine:migrationversion
      */
-    public function migrationStatusCommand(bool $showMigrations = false): void
+    public function migrationStatusCommand(bool $showMigrations = false, ?string $migrationFolder = null): void
     {
         if (!$this->isDatabaseConfigured()) {
             $this->outputLine('Doctrine migration status not available, the driver and host backend options are not set in /Configuration/Settings.yaml.');
             $this->quit(1);
         }
 
-        $this->outputLine($this->doctrineService->getFormattedMigrationStatus($showMigrations));
+        $this->maybeOutputMigrationFolderWarning($migrationFolder);
+        $this->outputLine($this->doctrineService->getFormattedMigrationStatus($showMigrations, $migrationFolder));
     }
 
     /**
@@ -310,14 +313,15 @@ public function migrationStatusCommand(bool $showMigrations = false): void
      * @param string|null $output A file to write SQL to, instead of executing it
      * @param boolean $dryRun Whether to do a dry run or not
      * @param boolean $quiet If set, only the executed migration versions will be output, one per line
+     * @param string|null $migrationFolder Provide alternative platform folder name (as in "Mysql"), otherwise configured connection is used.
      * @return void
      * @throws StopCommandException
      * @see neos.flow:doctrine:migrationstatus
      * @see neos.flow:doctrine:migrationexecute
      * @see neos.flow:doctrine:migrationgenerate
      * @see neos.flow:doctrine:migrationversion
      */
-    public function migrateCommand(string $version = 'latest', string $output = null, bool $dryRun = false, bool $quiet = false): void
+    public function migrateCommand(string $version = 'latest', string $output = null, bool $dryRun = false, bool $quiet = false, ?string $migrationFolder = null): void
     {
         if (!$this->isDatabaseConfigured()) {
             $this->outputLine('Doctrine migration not possible, the driver and host backend options are not set in /Configuration/Settings.yaml.');
@@ -328,8 +332,9 @@ public function migrateCommand(string $version = 'latest', string $output = null
             $this->outputLine(sprintf('The path "%s" is not writeable!', dirname($output)));
         }
 
+        $this->maybeOutputMigrationFolderWarning($migrationFolder);
         try {
-            $result = $this->doctrineService->executeMigrations($this->normalizeVersion($version), $output, $dryRun, $quiet);
+            $result = $this->doctrineService->executeMigrations($this->normalizeVersion($version), $output, $dryRun, $quiet, $migrationFolder);
             if ($result !== '' && $quiet === false) {
                 $this->outputLine($result);
             }
@@ -357,14 +362,15 @@ protected function emitAfterDatabaseMigration(): void
      * @param string $direction Whether to execute the migration up (default) or down
      * @param string|null $output A file to write SQL to, instead of executing it
      * @param boolean $dryRun Whether to do a dry run or not
+     * @param string|null $migrationFolder Provide alternative platform folder name (as in "Mysql"), otherwise configured connection is used.
      * @return void
      * @throws StopCommandException
      * @see neos.flow:doctrine:migrate
      * @see neos.flow:doctrine:migrationstatus
      * @see neos.flow:doctrine:migrationgenerate
      * @see neos.flow:doctrine:migrationversion
      */
-    public function migrationExecuteCommand(string $version, string $direction = 'up', string $output = null, bool $dryRun = false): void
+    public function migrationExecuteCommand(string $version, string $direction = 'up', string $output = null, bool $dryRun = false, ?string $migrationFolder = null): void
     {
         if (!$this->isDatabaseConfigured()) {
             $this->outputLine('Doctrine migration not possible, the driver and host backend options are not set in /Configuration/Settings.yaml.');
@@ -375,8 +381,9 @@ public function migrationExecuteCommand(string $version, string $direction = 'up
             $this->outputLine(sprintf('The path "%s" is not writeable!', dirname($output)));
         }
 
+        $this->maybeOutputMigrationFolderWarning($migrationFolder);
         try {
-            $this->outputLine($this->doctrineService->executeMigration($this->normalizeVersion($version), $direction, $output, $dryRun));
+            $this->outputLine($this->doctrineService->executeMigration($this->normalizeVersion($version), $direction, $output, $dryRun, $migrationFolder));
         } catch (\Exception $exception) {
             $this->handleException($exception);
         }
@@ -391,15 +398,17 @@ public function migrationExecuteCommand(string $version, string $direction = 'up
      * @param string $version The migration to execute
      * @param boolean $add The migration to mark as migrated
      * @param boolean $delete The migration to mark as not migrated
+     * @param string|null $migrationFolder Provide alternative platform folder name (as in "Mysql"), otherwise configured connection is used.
      * @return void
-     * @throws StopCommandException
      * @throws DBALException
+     * @throws FilesException
+     * @throws StopCommandException
      * @see neos.flow:doctrine:migrate
      * @see neos.flow:doctrine:migrationstatus
      * @see neos.flow:doctrine:migrationexecute
      * @see neos.flow:doctrine:migrationgenerate
      */
-    public function migrationVersionCommand(string $version, bool $add = false, bool $delete = false): void
+    public function migrationVersionCommand(string $version, bool $add = false, bool $delete = false, ?string $migrationFolder = null): void
     {
         if (!$this->isDatabaseConfigured()) {
             $this->outputLine('Doctrine migration not possible, the driver and host backend options are not set in /Configuration/Settings.yaml.');
@@ -410,8 +419,9 @@ public function migrationVersionCommand(string $version, bool $add = false, bool
             throw new \InvalidArgumentException('You must specify whether you want to --add or --delete the specified version.');
         }
 
+        $this->maybeOutputMigrationFolderWarning($migrationFolder);
         try {
-            $this->doctrineService->markAsMigrated($this->normalizeVersion($version), $add ?: false);
+            $this->doctrineService->markAsMigrated($this->normalizeVersion($version), $add ?: false, $migrationFolder);
         } catch (MigrationException $exception) {
             $this->outputLine($exception->getMessage());
             $this->quit(1);
@@ -440,6 +450,7 @@ public function migrationVersionCommand(string $version, bool $add = false, bool
      * @param boolean $diffAgainstCurrent Whether to base the migration on the current schema structure
      * @param string|null $filterExpression Only include tables/sequences matching the filter expression regexp
      * @param boolean $force Generate migrations even if there are migrations left to execute
+     * @param string|null $migrationFolder Provide alternative platform folder name (as in "Mysql"), otherwise configured connection is used.
      * @return void
      * @throws DBALException
      * @throws StopCommandException
@@ -449,14 +460,14 @@ public function migrationVersionCommand(string $version, bool $add = false, bool
      * @see neos.flow:doctrine:migrationexecute
      * @see neos.flow:doctrine:migrationversion
      */
-    public function migrationGenerateCommand(bool $diffAgainstCurrent = true, string $filterExpression = null, bool $force = false): void
+    public function migrationGenerateCommand(bool $diffAgainstCurrent = true, string $filterExpression = null, bool $force = false, ?string $migrationFolder = null): void
     {
         if (!$this->isDatabaseConfigured()) {
             $this->outputLine('Doctrine migration generation has been SKIPPED, the driver and host backend options are not set in /Configuration/Settings.yaml.');
             $this->quit(1);
         }
 
-        $migrationStatus = $this->doctrineService->getMigrationStatus();
+        $migrationStatus = $this->doctrineService->getMigrationStatus($migrationFolder);
         if ($force === false && $migrationStatus['new'] !== 0) {
             $this->outputLine('There are %d new migrations available. To avoid duplication those should be executed via `doctrine:migrate` before creating additional migrations.', [$migrationStatus['new']]);
             $this->quit(1);
@@ -474,7 +485,9 @@ public function migrationGenerateCommand(bool $diffAgainstCurrent = true, string
             }
         }
 
-        [$status, $migrationClassPathAndFilename] = $this->doctrineService->generateMigration($diffAgainstCurrent, $filterExpression);
+        $this->maybeOutputMigrationFolderWarning($migrationFolder);
+
+        [$status, $migrationClassPathAndFilename] = $this->doctrineService->generateMigration($diffAgainstCurrent, $filterExpression, $migrationFolder);
 
         $this->outputLine('<info>%s</info>', [$status]);
         $this->outputLine();
@@ -495,18 +508,20 @@ public function migrationGenerateCommand(bool $diffAgainstCurrent = true, string
             $selectedPackage = $this->output->select('Do you want to move the migration to one of these packages?', $choices, $choices[0]);
             $this->outputLine();
 
+            $migrationPlatformFolderPart = $migrationFolder ?? $this->doctrineService->getMigrationFolderName();
+
             if ($selectedPackage !== $choices[0]) {
-                /** @var Package $selectedPackage */
                 $selectedPackage = $packages[$selectedPackage];
-                $targetPathAndFilename = Files::concatenatePaths([$selectedPackage->getPackagePath(), 'Migrations', $this->doctrineService->getDatabasePlatformName(), basename($migrationClassPathAndFilename)]);
+                /** @var Package $selectedPackage */
+                $targetPathAndFilename = Files::concatenatePaths([$selectedPackage->getPackagePath(), 'Migrations', $migrationPlatformFolderPart, basename($migrationClassPathAndFilename)]);
                 Files::createDirectoryRecursively(dirname($targetPathAndFilename));
                 rename($migrationClassPathAndFilename, $targetPathAndFilename);
                 $this->outputLine('The migration was moved to: <comment>%s</comment>', [substr($targetPathAndFilename, strlen(FLOW_PATH_ROOT))]);
                 $this->outputLine();
                 $this->outputLine('Next Steps:');
             } else {
                 $this->outputLine('Next Steps:');
-                $this->outputLine(sprintf('- Move <comment>%s</comment> to YourPackage/<comment>Migrations/%s/</comment>', $migrationClassPathAndFilename, $this->doctrineService->getDatabasePlatformName()));
+                $this->outputLine(sprintf('- Move <comment>%s</comment> to YourPackage/<comment>Migrations/%s/</comment>', $migrationClassPathAndFilename, $migrationPlatformFolderPart));
             }
             $this->outputLine('- Review and adjust the generated migration.');
             $this->outputLine('- (optional) execute the migration using <comment>%s doctrine:migrate</comment>', [$this->getFlowInvocationString()]);
@@ -553,4 +568,11 @@ private function normalizeVersion(string $version): string
         }
         return sprintf('Neos\Flow\Persistence\Doctrine\Migrations\Version%s', $version);
     }
+
+    private function maybeOutputMigrationFolderWarning(?string $migrationFolder = null)
+    {
+        if ($migrationFolder !== null) {
+            $this->outputLine('<comment>Migration folder override is in effect, migration files are not searched in folder matching the configured connection but in ...Migrations/%s/</comment>', [$migrationFolder]);
+        }
+    }
 }

Neos.Flow/Classes/Persistence/Doctrine/AllowedObjectsListener.php

@@ -67,9 +67,9 @@ class AllowedObjectsListener
      * @param OnFlushEventArgs $args
      * @throws PersistenceException
      */
-    public function onFlush(OnFlushEventArgs $args)
+    public function onFlush(OnFlushEventArgs $args): void
     {
-        $unitOfWork = $args->getEntityManager()->getUnitOfWork();
+        $unitOfWork = $args->getObjectManager()->getUnitOfWork();
         if ($unitOfWork->getScheduledEntityInsertions() === []
             && $unitOfWork->getScheduledEntityUpdates() === []
             && $unitOfWork->getScheduledEntityDeletions() === []
@@ -87,7 +87,7 @@ public function onFlush(OnFlushEventArgs $args)
             }
         }
 
-        $connection = $args->getEntityManager()->getConnection();
+        $connection = $args->getObjectManager()->getConnection();
         try {
             if ($this->ping($connection) === false) {
                 $this->logger->info('Reconnecting the Doctrine EntityManager to the persistence backend.', LogEnvironment::fromMethodName(__METHOD__));
@@ -120,7 +120,7 @@ protected function ping(Connection $connection): bool
      * @return void
      * @throws \Neos\Flow\Persistence\Exception
      */
-    protected function throwExceptionIfObjectIsNotAllowed($object)
+    protected function throwExceptionIfObjectIsNotAllowed($object): void
     {
         if (!$this->allowedObjects->contains($object)) {
             $message = 'Detected modified or new objects (' . get_class($object) . ', uuid:' . $this->persistenceManager->getIdentifierByObject($object) . ') to be persisted which is not allowed for "safe requests"' . chr(10) .