Better error handling for migrations. Adding support for uninstall with keeping tables

Author: gustavs-gutmanis

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "solspace/craft3-commons",
   "description": "Solspace Commons Library for Craft CMS 3 plugins",
-  "version": "1.0.19",
+  "version": "1.0.20",
   "type": "library",
   "license": "MIT",
   "require": {

src/Migrations/KeepTablesAfterUninstallInterface.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Solspace\Commons\Migrations;
+
+interface KeepTablesAfterUninstallInterface
+{
+}

src/Migrations/StreamlinedInstallMigration.php

@@ -16,6 +16,10 @@ final public function safeUp(): bool
         }
 
         foreach ($this->defineTableData() as $table) {
+            if ($this->db->tableExists($table->getDatabaseName())) {
+                continue;
+            }
+
             $table->addField('dateCreated', $this->dateTime()->notNull());
             $table->addField('dateUpdated', $this->dateTime()->notNull());
             $table->addField('uid', $this->uid());
@@ -34,15 +38,19 @@ final public function safeUp(): bool
 
         foreach ($this->defineTableData() as $table) {
             foreach ($table->getForeignKeys() as $foreignKey) {
-                $this->addForeignKey(
-                    $foreignKey->getName(),
-                    $table->getDatabaseName(),
-                    $foreignKey->getColumn(),
-                    $foreignKey->getDatabaseReferenceTableName(),
-                    $foreignKey->getReferenceColumn(),
-                    $foreignKey->getOnDelete(),
-                    $foreignKey->getOnUpdate()
-                );
+                try {
+                    $this->addForeignKey(
+                        $foreignKey->getName(),
+                        $table->getDatabaseName(),
+                        $foreignKey->getColumn(),
+                        $foreignKey->getDatabaseReferenceTableName(),
+                        $foreignKey->getReferenceColumn(),
+                        $foreignKey->getOnDelete(),
+                        $foreignKey->getOnUpdate()
+                    );
+                } catch (\Exception $e) {
+                    \Craft::warning($e->getMessage());
+                }
             }
         }
 
@@ -58,17 +66,23 @@ final public function safeDown(): bool
             return false;
         }
 
+        if ($this instanceof KeepTablesAfterUninstallInterface) {
+            return true;
+        }
+
         $tables = $this->defineTableData();
 
         foreach ($tables as $table) {
-            if (!\Craft::$app->db->tableExists($table->getDatabaseName())) {
+            if (!$this->db->tableExists($table->getDatabaseName())) {
                 continue;
             }
 
             foreach ($table->getForeignKeys() as $foreignKey) {
                 try {
                     $this->dropForeignKey($foreignKey->getName(), $table->getDatabaseName());
-                } catch (\Exception $e) {}
+                } catch (\Exception $e) {
+                    \Craft::warning($e->getMessage());
+                }
             }
         }