AC-9755:Set default collation to utf8mb4 for MySQL

Author: glo17680

lib/internal/Magento/Framework/DB/Adapter/Pdo/Mysql.php

@@ -1270,7 +1270,7 @@ public function modifyColumn($tableName, $columnName, $definition, $flushData =
         // Add charset and collation for DBC failures
         if (!empty($definition)) {
             $type = explode(' ', trim($definition));
-            $definition = $this->applyCharsetAndCollation($type[0], $definition, 1);
+            $definition = $this->setDefaultCharsetAndCollation($type[0], $definition, 1);
         }
         $sql = sprintf(
             'ALTER TABLE %s MODIFY COLUMN %s %s',
@@ -2450,7 +2450,7 @@ protected function _getColumnsDefinition(Table $table)
         if (count($definition)) {
             foreach ($definition as $index => $columnDefinition) {
                 $type = explode(' ', trim($columnDefinition));
-                $definition[$index] = $this->applyCharsetAndCollation($type[1], $columnDefinition, 2);
+                $definition[$index] = $this->setDefaultCharsetAndCollation($type[1], $columnDefinition, 2);
             }
         }
         // PRIMARY KEY
@@ -4309,14 +4309,14 @@ public function __debugInfo()
     }
 
     /***
-     * Adding charset and collation for DBC failures
+     * Set default collation & charset (e.g.,utf8mb4_general_ci & utf8mb4) for tables
      *
      * @param string $columnType
      * @param string $definition
      * @param int $position
      * @return string
      */
-    private function applyCharsetAndCollation($columnType, $definition, $position) : string
+    private function setDefaultCharsetAndCollation($columnType, $definition, $position) : string
     {
         $pattern = '/\b(' . implode('|', array_map('preg_quote', self::COLUMN_TYPE)) . ')\b/i';
         if (preg_match($pattern, $columnType) === 1) {

lib/internal/Magento/Framework/Setup/Declaration/Schema/Db/MySQL/DbSchemaWriter.php

@@ -112,7 +112,7 @@ public function createTable($tableName, $resource, array $definition, array $opt
             foreach ($definition as $index => $value) {
                 if ($this->isColumnExists($value, self::COLUMN_TYPE)) {
                     if (str_contains($index, 'column')) {
-                        $definition[$index] = $this->applyCharsetAndCollation($value);
+                        $definition[$index] = $this->setDefaultCharsetAndCollation($value);
                     }
                 }
             }
@@ -238,7 +238,7 @@ public function modifyTableOption($tableName, $resource, $optionName, $optionVal
     public function modifyColumn($columnName, $resource, $tableName, $columnDefinition)
     {
         if ($this->isColumnExists($columnDefinition, self::COLUMN_TYPE)) {
-            $columnDefinition = $this->applyCharsetAndCollation($columnDefinition);
+            $columnDefinition = $this->setDefaultCharsetAndCollation($columnDefinition);
         }
 
         $sql = sprintf(
@@ -483,12 +483,12 @@ private function getPreparedStatements(array $statementBank) : array
     }
 
     /***
-     * Adding charset and collation for DBC failures
+     * Set default collation & charset (e.g.,utf8mb4_general_ci & utf8mb4) for tables
      *
      * @param string $columnDefinition
      * @return string
      */
-    private function applyCharsetAndCollation(string $columnDefinition): string
+    private function setDefaultCharsetAndCollation(string $columnDefinition): string
     {
         $charset = $this->columnConfig->getDefaultCharset();
         $collate = $this->columnConfig->getDefaultCollation();

setup/src/Magento/Setup/Model/Installer.php

@@ -667,7 +667,7 @@ private function setupModuleRegistry(SchemaSetupInterface $setup)
                 $columns = ['module' => ['varchar(50)',''],
                             'schema_version' => ['varchar(50)',''],
                             'data_version' => ['varchar(50)','']];
-                $this->setColumnCollationAndCharset($tableName, $columns, $connection);
+                $this->setDefaultCharsetAndCollation($tableName, $columns, $connection);
             }
         }
     }
@@ -734,7 +734,7 @@ private function setupSessionTable(
             if (preg_match('/\b('. self::OLDCHARSET .')\b/', $getTableSchema)) {
                 $tableName = $setup->getTable('session');
                 $columns = ['session_id' => ['varchar(255)','']];
-                $this->setColumnCollationAndCharset($tableName, $columns, $connection);
+                $this->setDefaultCharsetAndCollation($tableName, $columns, $connection);
             }
         }
     }
@@ -797,7 +797,7 @@ private function setupCacheTable(
             if (preg_match('/\b('. self::OLDCHARSET .')\b/', $getTableSchema)) {
                 $tableName = $setup->getTable('cache');
                 $columns = ['id' => ['varchar(200)','']];
-                $this->setColumnCollationAndCharset($tableName, $columns, $connection);
+                $this->setDefaultCharsetAndCollation($tableName, $columns, $connection);
             }
         }
     }
@@ -842,7 +842,7 @@ private function setupCacheTagTable(
             if (preg_match('/\b('. self::OLDCHARSET .')\b/', $getTableSchema)) {
                 $tableName = $setup->getTable('cache_tag');
                 $columns = ['tag' => ['varchar(100)',''],'cache_id' => ['varchar(200)','']];
-                $this->setColumnCollationAndCharset($tableName, $columns, $connection);
+                $this->setDefaultCharsetAndCollation($tableName, $columns, $connection);
             }
         }
     }
@@ -906,7 +906,7 @@ private function setupFlagTable(
             $getTableSchema = $connection->getCreateTable($tableName) ?? '';
             if (preg_match('/\b('. self::OLDCHARSET .')\b/', $getTableSchema)) {
                 $columns = ['flag_code' => ['varchar(255)','NOT NULL'],'flag_data' => ['mediumtext','']];
-                $this->setColumnCollationAndCharset($tableName, $columns, $connection);
+                $this->setDefaultCharsetAndCollation($tableName, $columns, $connection);
             }
         }
     }
@@ -1884,14 +1884,14 @@ private function reindexAll(): void
     }
 
     /**
-     * Add column attribute and update table
+     * Set default collation & charset (e.g.,utf8mb4_general_ci & utf8mb4) for core setup tables
      *
      * @param string $tableName
      * @param array $columns
      * @param AdapterInterface $connection
      * @return void
      */
-    private function setColumnCollationAndCharset(string $tableName, array $columns, $connection) : void
+    private function setDefaultCharsetAndCollation(string $tableName, array $columns, $connection) : void
     {
         $charset = $this->columnConfig->getDefaultCharset();
         $collate = $this->columnConfig->getDefaultCollation();