From 71a2aafc959d1fcd60a6d69f5976193ecdf4be59 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Stefan=20B=C3=BCrk?= <stefan@buerk.tech>
Date: Fri, 16 Aug 2024 13:06:15 +0200
Subject: [PATCH] [TASK] Mitigate deprecated database configuration

This change writes functioal test instance database
configuration using doctrine/dbal identifiers and
structure directly. Thus, avoiding the need for the
TYPO3 ConnectionPool to transform these values on
the fly.

Instead of default connection array

 $GLOBALS['TYPO3_CONF_VARS_']['DB']['Connections']
   ['Default']['tableoptions'] = []

following array is written

 $GLOBALS['TYPO3_CONF_VARS']['DB']['Connections']
   ['Default']['defaultTableOptions'] = []

for database driver `mysqli` and `pdo_mysql`, other
platforms does not suport these settings.

Additionally, `COLLATION` is used instead of the
replaced `COLLATE` subkey to define the table
collation within the default table options.

Backport to typo3/testing-framework v8 will limit
this to TYPO3 v13 and for v12 using the old values.

[1] https://github.com/doctrine/dbal/pull/5246
[2] https://review.typo3.org/c/Packages/TYPO3.CMS/+/75211/4/typo3/sysext/core/Classes/Database/ConnectionPool.php#147

Releases: main, 8
---
 .../Core/Functional/FunctionalTestCase.php    | 36 ++++++++++++++++---
 1 file changed, 32 insertions(+), 4 deletions(-)

diff --git a/Classes/Core/Functional/FunctionalTestCase.php b/Classes/Core/Functional/FunctionalTestCase.php
index f539b84a..a265bf9c 100644
--- a/Classes/Core/Functional/FunctionalTestCase.php
+++ b/Classes/Core/Functional/FunctionalTestCase.php
@@ -299,6 +299,7 @@ protected function setUp(): void
             $testbase->linkFrameworkExtensionsToInstance($this->instancePath, $frameworkExtension);
             $testbase->linkPathsInTestInstance($this->instancePath, $this->pathsToLinkInTestInstance);
             $testbase->providePathsInTestInstance($this->instancePath, $this->pathsToProvideInTestInstance);
+            $localConfiguration = [];
             $localConfiguration['DB'] = $testbase->getOriginalDatabaseSettingsFromEnvironmentOrLocalConfiguration();
 
             $originalDatabaseName = '';
@@ -321,15 +322,42 @@ protected function setUp(): void
                 $localConfiguration['DB']['Connections']['Default']['dbname'] = $dbName;
                 $testbase->testDatabaseNameIsNotTooLong($originalDatabaseName, $localConfiguration);
                 if ($dbDriver === 'mysqli' || $dbDriver === 'pdo_mysql') {
-                    $localConfiguration['DB']['Connections']['Default']['charset'] = 'utf8mb4';
-                    $localConfiguration['DB']['Connections']['Default']['tableoptions']['charset'] = 'utf8mb4';
-                    $localConfiguration['DB']['Connections']['Default']['tableoptions']['collate'] = 'utf8mb4_unicode_ci';
-                    $localConfiguration['DB']['Connections']['Default']['initCommands'] = 'SET SESSION sql_mode = \'STRICT_ALL_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_VALUE_ON_ZERO,NO_ENGINE_SUBSTITUTION,NO_ZERO_DATE,NO_ZERO_IN_DATE,ONLY_FULL_GROUP_BY\';';
+                    // MySQL/MariaDB allows more specific settings, and default configuration specific to these
+                    // platforms are handled here. That includes using the more specific `utf8mb4` charset like
+                    // TYPO3 would determine and write during installation and also defining `defaultTableOptions`
+                    // based on selected charset.
+                    if (($localConfiguration['DB']['Connections']['Default']['charset'] ?? '') === '') {
+                        $localConfiguration['DB']['Connections']['Default']['charset'] = 'utf8mb4';
+                    }
+                    if (($localConfiguration['DB']['Connections']['Default']['defaultTableOptions']['charset'] ?? '') === '') {
+                        $localConfiguration['DB']['Connections']['Default']['defaultTableOptions']['charset'] = 'utf8mb4';
+                    }
+                    if (($localConfiguration['DB']['Connections']['Default']['defaultTableOptions']['collation'] ?? '') === '') {
+                        $localConfiguration['DB']['Connections']['Default']['defaultTableOptions']['collation']
+                            = $localConfiguration['DB']['Connections']['Default']['defaultTableOptions']['charset'] . '_unicode_ci';
+                    }
+                    $localConfiguration['DB']['Connections']['Default']['initCommands']
+                        = 'SET SESSION sql_mode = \'' . implode(',', [
+                            'STRICT_ALL_TABLES',
+                            'ERROR_FOR_DIVISION_BY_ZERO',
+                            'NO_AUTO_VALUE_ON_ZERO',
+                            'NO_ENGINE_SUBSTITUTION',
+                            'NO_ZERO_DATE',
+                            'NO_ZERO_IN_DATE',
+                            'ONLY_FULL_GROUP_BY',
+                        ]) . '\';';
+                }
+                // Postgres/SQLite requires to use `utf-8` as charset and does not support `utf8mb4`.
+                if (($localConfiguration['DB']['Connections']['Default']['charset'] ?? '') === '') {
+                    $localConfiguration['DB']['Connections']['Default']['charset'] = 'utf-8';
                 }
             } else {
                 // sqlite dbs of all tests are stored in a dir parallel to instance roots. Allows defining this path as tmpfs.
                 $testbase->createDirectory(dirname($this->instancePath) . '/functional-sqlite-dbs');
                 $localConfiguration['DB']['Connections']['Default']['path'] = $dbPathSqlite;
+                if (($localConfiguration['DB']['charset'] ?? '') === '') {
+                    $localConfiguration['DB']['charset'] = 'utf-8';
+                }
             }
 
             // Set some hard coded base settings for the instance. Those could be overruled by