AC-9755:Set default collation to utf8mb4 for MySQL

glo17680 · glo17680 · commit c441b38559bb · 2024-10-28T16:37:36.000+05:30
diff --git a/lib/internal/Magento/Framework/DB/Adapter/Pdo/Mysql.php b/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) {
diff --git a/lib/internal/Magento/Framework/Setup/Declaration/Schema/Db/MySQL/DbSchemaWriter.php b/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();
diff --git a/setup/src/Magento/Setup/Model/Installer.php b/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();

Original file line number	Diff line number	Diff line change
`@@ -1270,7 +1270,7 @@ public function modifyColumn($tableName, $columnName, $definition, $flushData =`
`1270`	`1270`	`// Add charset and collation for DBC failures`
`1271`	`1271`	`if (!empty($definition)) {`
`1272`	`1272`	`$type = explode(' ', trim($definition));`
`1273`		`- $definition = $this->applyCharsetAndCollation($type[0], $definition, 1);`
	`1273`	`+ $definition = $this->setDefaultCharsetAndCollation($type[0], $definition, 1);`
`1274`	`1274`	`}`
`1275`	`1275`	`$sql = sprintf(`
`1276`	`1276`	`'ALTER TABLE %s MODIFY COLUMN %s %s',`
`@@ -2450,7 +2450,7 @@ protected function _getColumnsDefinition(Table $table)`
`2450`	`2450`	`if (count($definition)) {`
`2451`	`2451`	`foreach ($definition as $index => $columnDefinition) {`
`2452`	`2452`	`$type = explode(' ', trim($columnDefinition));`
`2453`		`- $definition[$index] = $this->applyCharsetAndCollation($type[1], $columnDefinition, 2);`
	`2453`	`+ $definition[$index] = $this->setDefaultCharsetAndCollation($type[1], $columnDefinition, 2);`
`2454`	`2454`	`}`
`2455`	`2455`	`}`
`2456`	`2456`	`// PRIMARY KEY`
`@@ -4309,14 +4309,14 @@ public function __debugInfo()`
`4309`	`4309`	`}`
`4310`	`4310`
`4311`	`4311`	`/***`
`4312`		`- * Adding charset and collation for DBC failures`
	`4312`	`+ * Set default collation & charset (e.g.,utf8mb4_general_ci & utf8mb4) for tables`
`4313`	`4313`	`*`
`4314`	`4314`	`* @param string $columnType`
`4315`	`4315`	`* @param string $definition`
`4316`	`4316`	`* @param int $position`
`4317`	`4317`	`* @return string`
`4318`	`4318`	`*/`
`4319`		`- private function applyCharsetAndCollation($columnType, $definition, $position) : string`
	`4319`	`+ private function setDefaultCharsetAndCollation($columnType, $definition, $position) : string`
`4320`	`4320`	`{`
`4321`	`4321`	`$pattern = '/\b(' . implode('\|', array_map('preg_quote', self::COLUMN_TYPE)) . ')\b/i';`
`4322`	`4322`	`if (preg_match($pattern, $columnType) === 1) {`
Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ public function createTable($tableName, $resource, array $definition, array $opt`
`112`	`112`	`foreach ($definition as $index => $value) {`
`113`	`113`	`if ($this->isColumnExists($value, self::COLUMN_TYPE)) {`
`114`	`114`	`if (str_contains($index, 'column')) {`
`115`		`- $definition[$index] = $this->applyCharsetAndCollation($value);`
	`115`	`+ $definition[$index] = $this->setDefaultCharsetAndCollation($value);`
`116`	`116`	`}`
`117`	`117`	`}`
`118`	`118`	`}`
`@@ -238,7 +238,7 @@ public function modifyTableOption($tableName, $resource, $optionName, $optionVal`
`238`	`238`	`public function modifyColumn($columnName, $resource, $tableName, $columnDefinition)`
`239`	`239`	`{`
`240`	`240`	`if ($this->isColumnExists($columnDefinition, self::COLUMN_TYPE)) {`
`241`		`- $columnDefinition = $this->applyCharsetAndCollation($columnDefinition);`
	`241`	`+ $columnDefinition = $this->setDefaultCharsetAndCollation($columnDefinition);`
`242`	`242`	`}`
`243`	`243`
`244`	`244`	`$sql = sprintf(`
`@@ -483,12 +483,12 @@ private function getPreparedStatements(array $statementBank) : array`
`483`	`483`	`}`
`484`	`484`
`485`	`485`	`/***`
`486`		`- * Adding charset and collation for DBC failures`
	`486`	`+ * Set default collation & charset (e.g.,utf8mb4_general_ci & utf8mb4) for tables`
`487`	`487`	`*`
`488`	`488`	`* @param string $columnDefinition`
`489`	`489`	`* @return string`
`490`	`490`	`*/`
`491`		`- private function applyCharsetAndCollation(string $columnDefinition): string`
	`491`	`+ private function setDefaultCharsetAndCollation(string $columnDefinition): string`
`492`	`492`	`{`
`493`	`493`	`$charset = $this->columnConfig->getDefaultCharset();`
`494`	`494`	`$collate = $this->columnConfig->getDefaultCollation();`
Original file line number	Diff line number	Diff line change
`@@ -667,7 +667,7 @@ private function setupModuleRegistry(SchemaSetupInterface $setup)`
`667`	`667`	`$columns = ['module' => ['varchar(50)',''],`
`668`	`668`	`'schema_version' => ['varchar(50)',''],`
`669`	`669`	`'data_version' => ['varchar(50)','']];`
`670`		`- $this->setColumnCollationAndCharset($tableName, $columns, $connection);`
	`670`	`+ $this->setDefaultCharsetAndCollation($tableName, $columns, $connection);`
`671`	`671`	`}`
`672`	`672`	`}`
`673`	`673`	`}`
`@@ -734,7 +734,7 @@ private function setupSessionTable(`
`734`	`734`	`if (preg_match('/\b('. self::OLDCHARSET .')\b/', $getTableSchema)) {`
`735`	`735`	`$tableName = $setup->getTable('session');`
`736`	`736`	`$columns = ['session_id' => ['varchar(255)','']];`
`737`		`- $this->setColumnCollationAndCharset($tableName, $columns, $connection);`
	`737`	`+ $this->setDefaultCharsetAndCollation($tableName, $columns, $connection);`
`738`	`738`	`}`
`739`	`739`	`}`
`740`	`740`	`}`
`@@ -797,7 +797,7 @@ private function setupCacheTable(`
`797`	`797`	`if (preg_match('/\b('. self::OLDCHARSET .')\b/', $getTableSchema)) {`
`798`	`798`	`$tableName = $setup->getTable('cache');`
`799`	`799`	`$columns = ['id' => ['varchar(200)','']];`
`800`		`- $this->setColumnCollationAndCharset($tableName, $columns, $connection);`
	`800`	`+ $this->setDefaultCharsetAndCollation($tableName, $columns, $connection);`
`801`	`801`	`}`
`802`	`802`	`}`
`803`	`803`	`}`
`@@ -842,7 +842,7 @@ private function setupCacheTagTable(`
`842`	`842`	`if (preg_match('/\b('. self::OLDCHARSET .')\b/', $getTableSchema)) {`
`843`	`843`	`$tableName = $setup->getTable('cache_tag');`
`844`	`844`	`$columns = ['tag' => ['varchar(100)',''],'cache_id' => ['varchar(200)','']];`
`845`		`- $this->setColumnCollationAndCharset($tableName, $columns, $connection);`
	`845`	`+ $this->setDefaultCharsetAndCollation($tableName, $columns, $connection);`
`846`	`846`	`}`
`847`	`847`	`}`
`848`	`848`	`}`
`@@ -906,7 +906,7 @@ private function setupFlagTable(`
`906`	`906`	`$getTableSchema = $connection->getCreateTable($tableName) ?? '';`
`907`	`907`	`if (preg_match('/\b('. self::OLDCHARSET .')\b/', $getTableSchema)) {`
`908`	`908`	`$columns = ['flag_code' => ['varchar(255)','NOT NULL'],'flag_data' => ['mediumtext','']];`
`909`		`- $this->setColumnCollationAndCharset($tableName, $columns, $connection);`
	`909`	`+ $this->setDefaultCharsetAndCollation($tableName, $columns, $connection);`
`910`	`910`	`}`
`911`	`911`	`}`
`912`	`912`	`}`
`@@ -1884,14 +1884,14 @@ private function reindexAll(): void`
`1884`	`1884`	`}`
`1885`	`1885`
`1886`	`1886`	`/**`
`1887`		`- * Add column attribute and update table`
	`1887`	`+ * Set default collation & charset (e.g.,utf8mb4_general_ci & utf8mb4) for core setup tables`
`1888`	`1888`	`*`
`1889`	`1889`	`* @param string $tableName`
`1890`	`1890`	`* @param array $columns`
`1891`	`1891`	`* @param AdapterInterface $connection`
`1892`	`1892`	`* @return void`
`1893`	`1893`	`*/`
`1894`		`- private function setColumnCollationAndCharset(string $tableName, array $columns, $connection) : void`
	`1894`	`+ private function setDefaultCharsetAndCollation(string $tableName, array $columns, $connection) : void`
`1895`	`1895`	`{`
`1896`	`1896`	`$charset = $this->columnConfig->getDefaultCharset();`
`1897`	`1897`	`$collate = $this->columnConfig->getDefaultCollation();`