Merge pull request #14300 from craftcms/feature/cms-1254-convert-json…

…-only-columns-to-json Convert JSON columns
craftcms · Feb 6, 2024 · e2db1bf · e2db1bf
2 parents 0280d64 + b0ebbfd
commit e2db1bf
Show file tree

Hide file tree

Showing 10 changed files with 61 additions and 26 deletions.
diff --git a/src/config/app.php b/src/config/app.php
@@ -4,7 +4,7 @@
     'id' => 'CraftCMS',
     'name' => 'Craft CMS',
     'version' => '5.0.0-alpha.12',
-    'schemaVersion' => '5.0.0.17',
+    'schemaVersion' => '5.0.0.18',
     'minVersionRequired' => '4.4.0',
     'basePath' => dirname(__DIR__), // Defines the @app alias
     'runtimePath' => '@storage/runtime', // Defines the @runtime alias

diff --git a/src/migrations/Install.php b/src/migrations/Install.php
@@ -288,7 +288,7 @@ public function createTables(): void
             'file' => $this->string()->notNull(),
             'line' => $this->smallInteger()->unsigned(),
             'message' => $this->text(),
-            'traces' => $this->text(),
+            'traces' => $this->json(),
             'dateCreated' => $this->dateTime()->notNull(),
             'dateUpdated' => $this->dateTime()->notNull(),
             'uid' => $this->uid(),
@@ -424,7 +424,7 @@ public function createTables(): void
         $this->createTable(Table::FIELDLAYOUTS, [
             'id' => $this->primaryKey(),
             'type' => $this->string()->notNull(),
-            'config' => $this->text(),
+            'config' => $this->json(),
             'dateCreated' => $this->dateTime()->notNull(),
             'dateUpdated' => $this->dateTime()->notNull(),
             'dateDeleted' => $this->dateTime()->null(),
@@ -471,7 +471,7 @@ public function createTables(): void
         $this->createTable(Table::GQLSCHEMAS, [
             'id' => $this->primaryKey(),
             'name' => $this->string()->notNull(),
-            'scope' => $this->text(),
+            'scope' => $this->json(),
             'isPublic' => $this->boolean()->notNull()->defaultValue(false),
             'dateCreated' => $this->dateTime()->notNull(),
             'dateUpdated' => $this->dateTime()->notNull(),
@@ -558,7 +558,7 @@ public function createTables(): void
             'maxAuthors' => $this->smallInteger()->unsigned()->defaultValue(1)->notNull(),
             'propagationMethod' => $this->string()->defaultValue(PropagationMethod::All->value)->notNull(),
             'defaultPlacement' => $this->enum('defaultPlacement', [Section::DEFAULT_PLACEMENT_BEGINNING, Section::DEFAULT_PLACEMENT_END])->defaultValue('end')->notNull(),
-            'previewTargets' => $this->text(),
+            'previewTargets' => $this->json(),
             'dateCreated' => $this->dateTime()->notNull(),
             'dateUpdated' => $this->dateTime()->notNull(),
             'dateDeleted' => $this->dateTime()->null(),
@@ -714,7 +714,7 @@ public function createTables(): void
         ]);
         $this->createTable(Table::USERPREFERENCES, [
             'userId' => $this->primaryKey(),
-            'preferences' => $this->text(),
+            'preferences' => $this->json(),
         ]);
         $this->createTable(Table::USERS, [
             'id' => $this->integer()->notNull(),
@@ -792,7 +792,7 @@ public function createTables(): void
             'type' => $this->string()->notNull(),
             'sortOrder' => $this->smallInteger()->unsigned(),
             'colspan' => $this->tinyInteger(),
-            'settings' => $this->text(),
+            'settings' => $this->json(),
             'enabled' => $this->boolean()->defaultValue(true)->notNull(),
             'dateCreated' => $this->dateTime()->notNull(),
             'dateUpdated' => $this->dateTime()->notNull(),

diff --git a/src/migrations/m240206_035135_convert_json_columns.php b/src/migrations/m240206_035135_convert_json_columns.php
@@ -0,0 +1,36 @@
+<?php
+
+namespace craft\migrations;
+
+use craft\db\Migration;
+use craft\db\Table;
+
+/**
+ * m240206_035135_convert_json_columns migration.
+ */
+class m240206_035135_convert_json_columns extends Migration
+{
+    /**
+     * @inheritdoc
+     */
+    public function safeUp(): bool
+    {
+        $this->alterColumn(Table::DEPRECATIONERRORS, 'traces', $this->json());
+        $this->alterColumn(Table::FIELDLAYOUTS, 'config', $this->json());
+        $this->alterColumn(Table::GQLSCHEMAS, 'scope', $this->json());
+        $this->alterColumn(Table::SECTIONS, 'previewTargets', $this->json());
+        $this->alterColumn(Table::USERPREFERENCES, 'preferences', $this->json());
+        $this->alterColumn(Table::WIDGETS, 'settings', $this->json());
+
+        return true;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function safeDown(): bool
+    {
+        echo "m240206_035135_convert_json_columns cannot be reverted.\n";
+        return false;
+    }
+}
diff --git a/src/models/GqlSchema.php b/src/models/GqlSchema.php
@@ -8,7 +8,6 @@
 namespace craft\models;
 
 use craft\base\Model;
-use craft\helpers\Json;
 use craft\helpers\StringHelper;
 use craft\records\GqlSchema as GqlSchemaRecord;
 use craft\validators\UniqueValidator;
@@ -52,15 +51,6 @@ class GqlSchema extends Model
      */
     private array $_cachedPairs = [];
 
-    public function __construct($config = [])
-    {
-        if (isset($config['scope']) && is_string($config['scope'])) {
-            $config['scope'] = Json::decode($config['scope']);
-        }
-
-        parent::__construct($config);
-    }
-
     /**
      * @inheritdoc
      */

diff --git a/src/services/Dashboard.php b/src/services/Dashboard.php
@@ -26,6 +26,7 @@
 use craft\widgets\QuickPost as QuickPostWidget;
 use craft\widgets\RecentEntries as RecentEntriesWidget;
 use craft\widgets\Updates as UpdatesWidget;
+use DateTime;
 use Throwable;
 use yii\base\Component;
 use yii\base\Exception;
@@ -113,7 +114,7 @@ public function getAllWidgetTypes(): array
      *
      * @template T of WidgetInterface
      * @param string|array $config The widget’s class name, or its config, with a `type` value and optionally a `settings` value.
-     * @phpstan-param class-string<T>|array{type:class-string<T>} $config
+     * @phpstan-param class-string<T>|array{type:class-string<T>,id?:int,dateCreated?:DateTime,dateUpdated?:DateTime,colspan?:int,settings?:array|string} $config
      * @return T
      */
     public function createWidget(mixed $config): WidgetInterface

diff --git a/src/services/Deprecator.php b/src/services/Deprecator.php
@@ -13,7 +13,6 @@
 use craft\elements\db\ElementQuery;
 use craft\errors\DeprecationException;
 use craft\helpers\Db;
-use craft\helpers\Json;
 use craft\helpers\StringHelper;
 use craft\helpers\Template;
 use craft\models\DeprecationError;
@@ -139,6 +138,7 @@ private function _storeLogsInDb(): bool
     public function storeLogs(): void
     {
         $db = Craft::$app->getDb();
+        $tableSchema = $db->getSchema()->getTableSchema(Table::DEPRECATIONERRORS);
 
         foreach ($this->_pendingRequestLogs as $log) {
             try {
@@ -149,7 +149,7 @@ public function storeLogs(): void
                     'file' => $log->file,
                     'line' => $log->line,
                     'message' => $log->message,
-                    'traces' => Json::encode($log->traces),
+                    'traces' => Db::prepareValueForDb($log->traces, $tableSchema->columns['traces']->dbType),
                 ]);
                 $log->id = (int)$db->getLastInsertID();
             } catch (Exception $e) {

diff --git a/src/services/Entries.php b/src/services/Entries.php
@@ -227,7 +227,7 @@ private function _sections(): MemoizableArray
             }
 
             $this->_sections = new MemoizableArray($results, function(array $result) use (&$siteSettingsBySection) {
-                if (!empty($result['previewTargets'])) {
+                if (!empty($result['previewTargets']) && is_string($result['previewTargets'])) {
                     $result['previewTargets'] = Json::decode($result['previewTargets']);
                 } else {
                     $result['previewTargets'] = [];

diff --git a/src/services/Fields.php b/src/services/Fields.php
@@ -757,7 +757,7 @@ private function _layouts(): MemoizableArray
                 if (array_key_exists('config', $config)) {
                     $nestedConfig = ArrayHelper::remove($config, 'config');
                     if ($nestedConfig) {
-                        $config += Json::decode($nestedConfig);
+                        $config += is_string($nestedConfig) ? Json::decode($nestedConfig) : $nestedConfig;
                     }
                     $loadTabs = false;
                 } else {

diff --git a/src/services/Gql.php b/src/services/Gql.php
@@ -68,7 +68,6 @@
 use craft\helpers\DateTimeHelper;
 use craft\helpers\Db;
 use craft\helpers\Gql as GqlHelper;
-use craft\helpers\Json;
 use craft\helpers\ProjectConfig as ProjectConfigHelper;
 use craft\helpers\StringHelper;
 use craft\models\FieldLayout;
@@ -992,7 +991,7 @@ public function handleChangedSchema(ConfigEvent $event): void
             $schemaRecord->uid = $schemaUid;
             $schemaRecord->name = $data['name'];
             $schemaRecord->isPublic = (bool)($data['isPublic'] ?? false);
-            $schemaRecord->scope = (!empty($data['scope']) && is_array($data['scope'])) ? Json::encode($data['scope']) : [];
+            $schemaRecord->scope = ($data['scope'] ?? false) ?: [];
 
             // Save the schema record
             $schemaRecord->save(false);

diff --git a/src/services/Users.php b/src/services/Users.php
@@ -371,7 +371,15 @@ public function getUserPreferences(int $userId): array
                 ->where(['userId' => $userId])
                 ->scalar();
 
-            $this->_userPreferences[$userId] = $preferences ? Json::decode($preferences) : [];
+            if ($preferences) {
+                if (is_string($preferences)) {
+                    $preferences = Json::decode($preferences);
+                }
+            } else {
+                $preferences = [];
+            }
+
+            $this->_userPreferences[$userId] = $preferences;
         }
 
         return $this->_userPreferences[$userId];
@@ -387,10 +395,11 @@ public function saveUserPreferences(User $user, array $preferences): void
     {
         // Merge in any other saved preferences
         $preferences += $this->getUserPreferences($user->id);
+        $tableSchema = Craft::$app->getDb()->getSchema()->getTableSchema(Table::USERPREFERENCES);
 
         Db::upsert(Table::USERPREFERENCES, [
             'userId' => $user->id,
-            'preferences' => Json::encode($preferences),
+            'preferences' => Db::prepareValueForDb($preferences, $tableSchema->columns['preferences']->dbType),
         ]);
 
         $this->_userPreferences[$user->id] = $preferences;