Merge pull request #74 from magento-commerce/ACP2E-1963

ACP2E-1963: Add warning to the QPT CLI wizard/output in case patch has dependencies

Author: BaDos

src/Command/Process/Action/ConfirmRequiredAction.php

@@ -21,6 +21,8 @@
  */
 class ConfirmRequiredAction implements ActionInterface
 {
+    const PATCH_INFO_URL = "https://experienceleague.adobe.com/tools/commerce-quality-patches/index.html";
+
     /**
      * @var OptionalPool
      */
@@ -76,10 +78,16 @@ function ($patch) {
         }
 
         if ($requiredNotAppliedPatches) {
+            $url = self::PATCH_INFO_URL . '?keyword=' . current($patchFilter);
+            $output->writeln(
+                '<info>Please double check patch details and requirements at ' .
+                sprintf('<href=%1$s>%1$s</>', $url) .
+                '</info>' .
+                PHP_EOL
+            );
             $output->writeln(
                 '<info>Next patches are required by ' . implode(' ', $patchFilter) . ':</info>' . PHP_EOL
             );
-
             $aggregatedPatches = $this->aggregator->aggregate($requiredNotAppliedPatches);
             $this->renderer->printTable($output, $aggregatedPatches);
 

src/Command/Process/Renderer.php

@@ -220,6 +220,11 @@ function ($item) {
             $details .= 'Affected components:' . $glue . implode($glue, $patch->getAffectedComponents());
         }
 
+        if ($patch->getRequirements()) {
+            $requirements = rtrim(chunk_split($patch->getRequirements(), 50, PHP_EOL));
+            $details .= PHP_EOL . '<comment>Requirements:</comment>' . PHP_EOL . ' - ' . $requirements;
+        }
+
         $id = $patch->getType() === PatchInterface::TYPE_CUSTOM ? 'N/A' : $patch->getId();
         $title = chunk_split($patch->getTitle(), 60, PHP_EOL);
 

src/Command/Process/ShowStatus.php

@@ -284,8 +284,9 @@ private function getPatchCategories(array $patches): array
      */
     private function printDetailsInfo(OutputInterface $output)
     {
-        $supportUrl = 'https://support.magento.com';
-        $releaseNotesUrl = 'https://devdocs.magento.com/quality-patches/release-notes.html';
+        // phpcs:ignore
+        $releaseNotesUrl = 'https://experienceleague.adobe.com/docs/commerce-operations/tools/quality-patches-tool/release-notes.html';
+        $supportUrl = 'https://experienceleague.adobe.com/tools/commerce-quality-patches/index.html';
 
         $output->writeln(
             '<info>Patch details you can find on </info>' .

src/Patch/AggregatedPatchFactory.php

@@ -36,6 +36,7 @@ public function create(
         $require = $this->getRequire($items);
         $replacedWith = $this->getReplacedWith($items);
         $isDeprecated = $this->isDeprecated($items);
+        $requirements = $this->getRequirements($items);
 
         return new AggregatedPatch(
             $id,
@@ -47,7 +48,8 @@ public function create(
             $require,
             $replacedWith,
             $isDeprecated,
-            $items
+            $items,
+            $requirements
         );
     }
 
@@ -189,4 +191,17 @@ private function isDeprecated(array $patches): bool
 
         return false;
     }
+
+    /**
+     * Returns aggregated patch requirements.
+     *
+     * @param PatchInterface[] $patches
+     * @return string
+     */
+    private function getRequirements(array $patches): string
+    {
+        $patch = reset($patches);
+
+        return $patch->getRequirements();
+    }
 }

src/Patch/Collector/SupportCollector.php

@@ -55,6 +55,8 @@ class SupportCollector implements CollectorInterface
 
     const ORIGIN = 'Adobe Commerce Support';
 
+    const PROP_REQUIREMENTS = 'requirements';
+
     /**
      * @var Package
      */
@@ -113,6 +115,7 @@ public function collect(): array
                     $category = !empty($patchGeneralConfig[self::PROP_CATEGORIES])
                         ? array_map('trim', $patchGeneralConfig[self::PROP_CATEGORIES])
                         : ['Other'];
+                    $patchRequirements = $patchGeneralConfig[self::PROP_REQUIREMENTS] ?? '';
 
                     if ($this->package->matchConstraint($packageName, $packageConstraint)) {
                         $result[] = $this->createPatch(
@@ -124,7 +127,8 @@ public function collect(): array
                             $packageConstraint,
                             $patchRequire,
                             $patchReplacedWith,
-                            $patchDeprecated
+                            $patchDeprecated,
+                            $patchRequirements
                         );
                     }
                 }
@@ -145,9 +149,11 @@ public function collect(): array
      * @param array $patchRequire
      * @param string $patchReplacedWith
      * @param bool $patchDeprecated
+     * @param string $patchRequirements
      *
      * @return PatchInterface
      * @throws CollectorException
+     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     private function createPatch(
         string $patchId,
@@ -158,7 +164,8 @@ private function createPatch(
         string $packageConstraint,
         array $patchRequire,
         string $patchReplacedWith,
-        bool $patchDeprecated
+        bool $patchDeprecated,
+        string $patchRequirements
     ): PatchInterface {
         try {
             $patchPath = $this->qualityPackage->getPatchesDirectoryPath() . '/' . $patchFile;
@@ -174,6 +181,7 @@ private function createPatch(
             $this->patchBuilder->setRequire($patchRequire);
             $this->patchBuilder->setReplacedWith($patchReplacedWith);
             $this->patchBuilder->setDeprecated($patchDeprecated);
+            $this->patchBuilder->setRequirements($patchRequirements);
             $patch = $this->patchBuilder->build();
         } catch (PatchIntegrityException $e) {
             throw new CollectorException($e->getMessage(), $e->getCode(), $e);

src/Patch/Data/AggregatedPatch.php

@@ -62,6 +62,11 @@ class AggregatedPatch implements AggregatedPatchInterface
      */
     private $origin;
 
+    /**
+     * @var string
+     */
+    private $requirements = '';
+
     /**
      * @param string $id
      * @param string $type
@@ -85,7 +90,8 @@ public function __construct(
         array $require,
         string $replacedWith,
         bool $isDeprecated,
-        array $items
+        array $items,
+        string $requirements = ''
     ) {
 
         $this->id = $id;
@@ -98,6 +104,7 @@ public function __construct(
         $this->replacedWith = $replacedWith;
         $this->isDeprecated = $isDeprecated;
         $this->items = $items;
+        $this->requirements = $requirements;
     }
 
     /**
@@ -187,4 +194,11 @@ public function getItems(): array
     {
         return $this->items;
     }
+    /**
+     * @inheritDoc
+     */
+    public function getRequirements(): string
+    {
+        return $this->requirements;
+    }
 }

src/Patch/Data/AggregatedPatchInterface.php

@@ -83,4 +83,11 @@ public function isDeprecated(): bool;
      * @return PatchInterface[]
      */
     public function getItems(): array;
+
+    /**
+     * Patch requirements.
+     *
+     * @return string
+     */
+    public function getRequirements(): string;
 }

src/Patch/Data/Patch.php

@@ -76,6 +76,11 @@ class Patch implements PatchInterface
      */
     private $origin;
 
+    /**
+     * @var string
+     */
+    private $requirements = '';
+
     /**
      * @param string $id
      * @param string $type
@@ -90,6 +95,7 @@ class Patch implements PatchInterface
      * @param string[] $require
      * @param string $replacedWith
      * @param bool $isDeprecated
+     * @param string $requirements
      *
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
@@ -106,7 +112,8 @@ public function __construct(
         array $affectedComponents,
         array $require,
         string $replacedWith,
-        bool $isDeprecated
+        bool $isDeprecated,
+        string $requirements = ''
     ) {
 
         $this->id = $id;
@@ -122,6 +129,7 @@ public function __construct(
         $this->require = $require;
         $this->replacedWith = $replacedWith;
         $this->isDeprecated = $isDeprecated;
+        $this->requirements = $requirements;
     }
 
     /**
@@ -235,4 +243,12 @@ public function isDeprecated(): bool
     {
         return $this->isDeprecated;
     }
+
+    /**
+     * @inheritDoc
+     */
+    public function getRequirements(): string
+    {
+        return $this->requirements;
+    }
 }

src/Patch/Data/PatchInterface.php

@@ -119,4 +119,11 @@ public function getReplacedWith(): string;
      * @return bool
      */
     public function isDeprecated(): bool;
+
+    /**
+     * Patch requirements.
+     *
+     * @return string
+     */
+    public function getRequirements(): string;
 }

src/Patch/PatchBuilder.php

@@ -84,6 +84,11 @@ class PatchBuilder
      */
     private $filesystem;
 
+    /**
+     * @var string
+     */
+    private $requirements = '';
+
     /**
      * @param Filesystem $filesystem
      */
@@ -226,6 +231,17 @@ public function setDeprecated(bool $deprecated)
         $this->deprecated = $deprecated;
     }
 
+    /**
+     * Sets patch requirements.
+     *
+     * @param string $requirements
+     * @return void
+     */
+    public function setRequirements(string $requirements)
+    {
+        $this->requirements = $requirements;
+    }
+
     /**
      * Builds patch data object.
      *
@@ -250,7 +266,8 @@ public function build()
             $components,
             $this->require,
             $this->replacedWith,
-            $this->deprecated
+            $this->deprecated,
+            $this->requirements
         );
     }