ENGCOM-5187: Add more descriptive exception when data patch fails to apply. #23046

 - Merge Pull Request #23046 from ashsmith/magento2:data-patch-exception
 - Merged commits:
   1. 199887d
   2. c0d920d

Author: magento-engcom-team

lib/internal/Magento/Framework/Setup/Patch/PatchApplier.php

@@ -10,7 +10,7 @@
 use Magento\Framework\Module\ModuleList;
 use Magento\Framework\ObjectManagerInterface;
 use Magento\Framework\Phrase;
-use Magento\Framework\Setup\Exception;
+use Magento\Framework\Setup\Exception as SetupException;
 use Magento\Framework\Setup\ModuleDataSetupInterface;
 
 /**
@@ -129,8 +129,8 @@ public function __construct(
     /**
      * Apply all patches for one module
      *
-     * @param null | string $moduleName
-     * @throws Exception
+     * @param null|string $moduleName
+     * @throws SetupException
      */
     public function applyDataPatch($moduleName = null)
     {
@@ -149,7 +149,7 @@ public function applyDataPatch($moduleName = null)
                 ['moduleDataSetup' => $this->moduleDataSetup]
             );
             if (!$dataPatch instanceof DataPatchInterface) {
-                throw new Exception(
+                throw new SetupException(
                     new Phrase("Patch %1 should implement DataPatchInterface", [get_class($dataPatch)])
                 );
             }
@@ -164,7 +164,17 @@ public function applyDataPatch($moduleName = null)
                     $this->moduleDataSetup->getConnection()->commit();
                 } catch (\Exception $e) {
                     $this->moduleDataSetup->getConnection()->rollBack();
-                    throw new Exception(new Phrase($e->getMessage()));
+                    throw new SetupException(
+                        new Phrase(
+                            'Unable to apply data patch %1 for module %2. Original exception message: %3',
+                            [
+                                get_class($dataPatch),
+                                $moduleName,
+                                $e->getMessage()
+                            ]
+                        ),
+                        $e
+                    );
                 } finally {
                     unset($dataPatch);
                 }
@@ -173,8 +183,7 @@ public function applyDataPatch($moduleName = null)
     }
 
     /**
-     * Register all patches in registry in order to manipulate chains and dependencies of patches
-     * of patches
+     * Register all patches in registry in order to manipulate chains and dependencies of patches of patches
      *
      * @param string $moduleName
      * @param string $patchType
@@ -207,8 +216,8 @@ private function prepareRegistry($moduleName, $patchType)
      *
      * Please note: that schema patches are not revertable
      *
-     * @param null | string $moduleName
-     * @throws Exception
+     * @param null|string $moduleName
+     * @throws SetupException
      */
     public function applySchemaPatch($moduleName = null)
     {
@@ -229,7 +238,7 @@ public function applySchemaPatch($moduleName = null)
                 $schemaPatch->apply();
                 $this->patchHistory->fixPatch(get_class($schemaPatch));
             } catch (\Exception $e) {
-                throw new Exception(
+                throw new SetupException(
                     new Phrase(
                         'Unable to apply patch %1 for module %2. Original exception message: %3',
                         [
@@ -248,8 +257,8 @@ public function applySchemaPatch($moduleName = null)
     /**
      * Revert data patches for specific module
      *
-     * @param null | string $moduleName
-     * @throws Exception
+     * @param null|string $moduleName
+     * @throws SetupException
      */
     public function revertDataPatches($moduleName = null)
     {
@@ -270,7 +279,7 @@ public function revertDataPatches($moduleName = null)
                     $adapter->commit();
                 } catch (\Exception $e) {
                     $adapter->rollBack();
-                    throw new Exception(new Phrase($e->getMessage()));
+                    throw new SetupException(new Phrase($e->getMessage()));
                 } finally {
                     unset($dataPatch);
                 }