Add fix/checks for project config mismatches from Craft 3 > 3.1

Author: engram-design

config.codekit3

@@ -126,16 +126,6 @@
 		"oAP": "/build/src/fields",
 		"oF": 0
 		},
-	"/src/icon.svg": {
-		"ft": 2097152,
-		"miP": 0,
-		"oA": 2,
-		"oAP": "/src/icon.svg",
-		"oF": 0,
-		"opt": 0,
-		"plM": 3758088159,
-		"prP": 0
-		},
 	"/src/integrations": {
 		"ft": 65536,
 		"oA": 1,
@@ -166,121 +156,12 @@
 		"oAP": "/build/src/resources/dist",
 		"oF": 0
 		},
-	"/src/resources/src/js/_configurator.js": {
-		"ft": 64,
-		"ma": 1,
-		"mi": 1,
-		"oA": 1,
-		"oAP": "/src/resources/dist/js/_configurator.js",
-		"oF": 0,
-		"sC": 0,
-		"tS": 0
-		},
-	"/src/resources/src/js/_input.js": {
-		"ft": 64,
-		"ma": 1,
-		"mi": 1,
-		"oA": 1,
-		"oAP": "/src/resources/dist/js/_input.js",
-		"oF": 0,
-		"sC": 0,
-		"tS": 0
-		},
-	"/src/resources/src/js/_matrix-configurator.js": {
-		"ft": 64,
-		"ma": 1,
-		"mi": 1,
-		"oA": 1,
-		"oAP": "/src/resources/dist/js/_matrix-configurator.js",
-		"oF": 0,
-		"sC": 0,
-		"tS": 0
-		},
-	"/src/resources/src/js/_matrix-input.js": {
-		"ft": 64,
-		"ma": 1,
-		"mi": 1,
-		"oA": 1,
-		"oAP": "/src/resources/dist/js/_matrix-input.js",
-		"oF": 0,
-		"sC": 0,
-		"tS": 0
-		},
-	"/src/resources/src/js/super-table.js": {
-		"ft": 64,
-		"ma": 1,
-		"mi": 1,
-		"oA": 0,
-		"oAP": "/src/resources/dist/js/super-table.js",
-		"oF": 0,
-		"sC": 0,
-		"tS": 0
-		},
-	"/src/resources/src/scss/_base.scss": {
-		"aP": 1,
-		"bl": 0,
-		"dP": 10,
-		"dS": 0,
-		"ft": 4,
-		"ma": 0,
-		"oA": 1,
-		"oAP": "/src/resources/dist/css/_base.css",
-		"oF": 0,
-		"oS": 3,
-		"uL": 1
-		},
-	"/src/resources/src/scss/_configurator.scss": {
-		"aP": 1,
-		"bl": 0,
-		"dP": 10,
-		"dS": 0,
-		"ft": 4,
-		"ma": 0,
-		"oA": 1,
-		"oAP": "/src/resources/dist/css/_configurator.css",
-		"oF": 0,
-		"oS": 3,
-		"uL": 1
-		},
-	"/src/resources/src/scss/_input.scss": {
-		"aP": 1,
-		"bl": 0,
-		"dP": 10,
-		"dS": 0,
-		"ft": 4,
-		"ma": 0,
-		"oA": 1,
-		"oAP": "/src/resources/dist/css/_input.css",
-		"oF": 0,
-		"oS": 3,
-		"uL": 1
-		},
-	"/src/resources/src/scss/super-table.scss": {
-		"aP": 1,
-		"bl": 0,
-		"dP": 10,
-		"dS": 0,
-		"ft": 4,
-		"ma": 0,
-		"oA": 0,
-		"oAP": "/src/resources/dist/css/super-table.css",
-		"oF": 0,
-		"oS": 3,
-		"uL": 1
-		},
 	"/src/services": {
 		"ft": 65536,
 		"oA": 1,
 		"oAP": "/build/src/services",
 		"oF": 0
 		},
-	"/src/SuperTable.php": {
-		"cB": 0,
-		"ft": 8192,
-		"oA": 2,
-		"oAP": "/src/SuperTable.php",
-		"oF": 0
-		},
 	"/src/templates": {
 		"ft": 65536,
 		"oA": 1,

src/controllers/PluginController.php

@@ -14,6 +14,7 @@
 use craft\helpers\Json;
 use craft\helpers\MigrationHelper;
 use craft\helpers\UrlHelper;
+use craft\services\Fields;
 use craft\web\Controller;
 
 class PluginController extends Controller
@@ -63,6 +64,7 @@ public function actionCheckContentTables()
         $fieldsService = Craft::$app->getFields();
         $superTableService = SuperTable::$plugin->getService();
         $matrixService = Craft::$app->getMatrix();
+        $projectConfig = Craft::$app->getProjectConfig();
 
         // Find all top-level Super Table fields and make sure their content table exists
         $superTableFields = (new Query())
@@ -207,6 +209,24 @@ public function actionCheckContentTables()
             }
         }
 
+        // Check for project config inconsistencies
+        $superTableFields = (new Query())
+            ->select(['uid', 'settings'])
+            ->from([Table::FIELDS])
+            ->where(['type' => SuperTableField::class])
+            ->all();
+
+        foreach ($superTableFields as $superTableField) {
+            $path = Fields::CONFIG_FIELDS_KEY . '.' . $superTableField['uid'] . '.settings';
+            $settings = Json::decode($superTableField['settings']);
+            $configSettings = $projectConfig->get($path);
+
+            if ($settings != $configSettings) {
+                $errors = true;
+                echo "    > ERROR: #{$superTableField->id} has inconsistent field settings in its project config ...\n";
+            }
+        }
+
         $output = ob_get_contents();
         ob_end_clean();
 

src/migrations/m190120_000000_fix_supertablecontent_tables.php

@@ -12,6 +12,7 @@
 use craft\helpers\Db;
 use craft\helpers\Json;
 use craft\helpers\MigrationHelper;
+use craft\services\Fields;
 
 class m190120_000000_fix_supertablecontent_tables extends Migration
 {
@@ -20,6 +21,7 @@ public function safeUp()
         $fieldsService = Craft::$app->getFields();
         $superTableService = SuperTable::$plugin->getService();
         $matrixService = Craft::$app->getMatrix();
+        $projectConfig = Craft::$app->getProjectConfig();
 
         // Find any `supertablecontents_*` tables, these should be `stc_*`. But we should check if these tables are completely empty
         foreach (Craft::$app->db->schema->getTableNames() as $tableName) {
@@ -218,6 +220,25 @@ public function safeUp()
                 }
             }
         }
+
+        // Update Super Table settings in the project config to match the DB. This is because Craft 3.0 > 3.1 migration
+        // has already fired, dumping potentially incorrect values into the project config. Because we've fixed above, 
+        // we should be good to update it again with correct values.
+        $projectConfig->muteEvents = true;
+
+        $superTableFields = (new Query())
+            ->select(['uid', 'settings'])
+            ->from([Table::FIELDS])
+            ->where(['type' => SuperTableField::class])
+            ->all();
+
+        foreach ($superTableFields as $superTableField) {
+            $path = Fields::CONFIG_FIELDS_KEY . '.' . $superTableField['uid'] . '.settings';
+            $settings = Json::decode($superTableField['settings']);
+            $projectConfig->set($path, $settings);
+        }
+
+        $projectConfig->muteEvents = false;
     }
 
     public function safeDown()