Issue #3247478 by tedbow, phenaproxima: Only pre-operation events should be...

Issue #3247478 by tedbow, phenaproxima: Only pre-operation events should be able to flag errors that stop an update

package_manager/src/Event/ErrorEventInterface.php

+<?php
+
+namespace Drupal\package_manager\Event;
+
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+
+/**
+ * Defines an interface for events which can collect validation errors.
+ */
+interface ErrorEventInterface {
+
+  /**
+   * Adds a validation error.
+   *
+   * @param \Drupal\Core\StringTranslation\TranslatableMarkup[] $messages
+   *   The error messages.
+   * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $summary
+   *   (optional) The summary.
+   */
+  public function addError(array $messages, TranslatableMarkup $summary = NULL);
+
+}

package_manager/src/Event/PostApplyEvent.php

@@ -5,5 +5,5 @@ namespace Drupal\package_manager\Event;
 /**
  * Event fired after staged changes are synced to the active directory.
  */
-class PostApplyEvent extends StageEvent {
+class PostApplyEvent extends PostOperationStageEvent {
 }

package_manager/src/Event/PostCreateEvent.php

@@ -5,5 +5,5 @@ namespace Drupal\package_manager\Event;
 /**
  * Event fired after a staging area has been created.
  */
-class PostCreateEvent extends StageEvent {
+class PostCreateEvent extends PostOperationStageEvent {
 }

package_manager/src/Event/PostDestroyEvent.php

@@ -5,5 +5,5 @@ namespace Drupal\package_manager\Event;
 /**
  * Event fired after the staging area is destroyed.
  */
-class PostDestroyEvent extends StageEvent {
+class PostDestroyEvent extends PostOperationStageEvent {
 }

package_manager/src/Event/PostOperationStageEvent.php

+<?php
+
+namespace Drupal\package_manager\Event;
+
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\package_manager\ValidationResult;
+
+/**
+ * Base class for events dispatched after a stage life cycle operation.
+ */
+abstract class PostOperationStageEvent extends StageEvent implements WarningEventInterface {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function addWarning(array $messages, ?TranslatableMarkup $summary = NULL) {
+    $this->results[] = ValidationResult::createWarning($messages, $summary);
+  }
+
+}

package_manager/src/Event/PostRequireEvent.php

@@ -5,5 +5,5 @@ namespace Drupal\package_manager\Event;
 /**
  * Event fired after packages are added to the staging area.
  */
-class PostRequireEvent extends StageEvent {
+class PostRequireEvent extends PostOperationStageEvent {
 }

package_manager/src/Event/PreApplyEvent.php

@@ -5,7 +5,7 @@ namespace Drupal\package_manager\Event;
 /**
  * Event fired before staged changes are synced to the active directory.
  */
-class PreApplyEvent extends StageEvent {
+class PreApplyEvent extends PreOperationStageEvent {
 
   use ExcludedPathsTrait;
 

package_manager/src/Event/PreCreateEvent.php

@@ -5,7 +5,7 @@ namespace Drupal\package_manager\Event;
 /**
  * Event fired before a staging area is created.
  */
-class PreCreateEvent extends StageEvent {
+class PreCreateEvent extends PreOperationStageEvent {
 
   use ExcludedPathsTrait;
 

package_manager/src/Event/PreDestroyEvent.php

@@ -5,5 +5,5 @@ namespace Drupal\package_manager\Event;
 /**
  * Event fired before the staging area is destroyed.
  */
-class PreDestroyEvent extends StageEvent {
+class PreDestroyEvent extends PreOperationStageEvent {
 }

package_manager/src/Event/PreOperationStageEvent.php

+<?php
+
+namespace Drupal\package_manager\Event;
+
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\package_manager\ValidationResult;
+
+/**
+ * Base class for events dispatched before a stage life cycle operation.
+ */
+abstract class PreOperationStageEvent extends StageEvent implements ErrorEventInterface {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function addError(array $messages, ?TranslatableMarkup $summary = NULL) {
+    $this->results[] = ValidationResult::createError($messages, $summary);
+  }
+
+}

package_manager/src/Event/PreRequireEvent.php

@@ -5,5 +5,5 @@ namespace Drupal\package_manager\Event;
 /**
  * Event fired before packages are added to the staging area.
  */
-class PreRequireEvent extends StageEvent {
+class PreRequireEvent extends PreOperationStageEvent {
 }

package_manager/src/Event/StageEvent.php

@@ -3,7 +3,6 @@
 namespace Drupal\package_manager\Event;
 
 use Drupal\package_manager\Stage;
-use Drupal\package_manager\ValidationResult;
 use Symfony\Contracts\EventDispatcher\Event;
 
 /**
@@ -64,14 +63,4 @@ abstract class StageEvent extends Event {
     return $this->results;
   }
 
-  /**
-   * Adds a validation result.
-   *
-   * @param \Drupal\package_manager\ValidationResult $validation_result
-   *   The validation result.
-   */
-  public function addValidationResult(ValidationResult $validation_result): void {
-    $this->results[] = $validation_result;
-  }
-
 }

package_manager/src/Event/WarningEventInterface.php

+<?php
+
+namespace Drupal\package_manager\Event;
+
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+
+/**
+ * Defines an interface for events which can collect validation warnings.
+ */
+interface WarningEventInterface {
+
+  /**
+   * Adds a warning.
+   *
+   * @param array $messages
+   *   The warning messages.
+   * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $summary
+   *   (optional) The summary.
+   */
+  public function addWarning(array $messages, TranslatableMarkup $summary = NULL);
+
+}

package_manager/src/EventSubscriber/ComposerExecutableValidator.php

@@ -3,8 +3,7 @@
 namespace Drupal\package_manager\EventSubscriber;
 
 use Drupal\package_manager\Event\PreCreateEvent;
-use Drupal\package_manager\Event\StageEvent;
-use Drupal\package_manager\ValidationResult;
+use Drupal\package_manager\Event\PreOperationStageEvent;
 use Drupal\Core\Extension\ExtensionVersion;
 use Drupal\Core\StringTranslation\StringTranslationTrait;
 use Drupal\Core\StringTranslation\TranslationInterface;
@@ -15,7 +14,7 @@ use PhpTuf\ComposerStager\Infrastructure\Process\Runner\ComposerRunnerInterface;
 /**
  * Validates that the Composer executable can be found in the correct version.
  */
-class ComposerExecutableValidator implements StageValidatorInterface, ProcessOutputCallbackInterface {
+class ComposerExecutableValidator implements PreOperationStageValidatorInterface, ProcessOutputCallbackInterface {
 
   use StringTranslationTrait;
 
@@ -49,15 +48,14 @@ class ComposerExecutableValidator implements StageValidatorInterface, ProcessOut
   /**
    * {@inheritdoc}
    */
-  public function validateStage(StageEvent $event): void {
+  public function validateStagePreOperation(PreOperationStageEvent $event): void {
     try {
       $this->composer->run(['--version'], $this);
     }
     catch (ExceptionInterface $e) {
-      $error = ValidationResult::createError([
+      $event->addError([
         $e->getMessage(),
       ]);
-      $event->addValidationResult($error);
       return;
     }
 
@@ -66,19 +64,17 @@ class ComposerExecutableValidator implements StageValidatorInterface, ProcessOut
         ->getMajorVersion();
 
       if ($major_version < 2) {
-        $error = ValidationResult::createError([
+        $event->addError([
           $this->t('Composer 2 or later is required, but version @version was detected.', [
             '@version' => $this->version,
           ]),
         ]);
-        $event->addValidationResult($error);
       }
     }
     else {
-      $error = ValidationResult::createError([
+      $event->addError([
         $this->t('The Composer version could not be detected.'),
       ]);
-      $event->addValidationResult($error);
     }
   }
 
@@ -87,7 +83,7 @@ class ComposerExecutableValidator implements StageValidatorInterface, ProcessOut
    */
   public static function getSubscribedEvents() {
     return [
-      PreCreateEvent::class => 'validateStage',
+      PreCreateEvent::class => 'validateStagePreOperation',
     ];
   }
 

package_manager/src/EventSubscriber/DiskSpaceValidator.php

@@ -3,8 +3,7 @@
 namespace Drupal\package_manager\EventSubscriber;
 
 use Drupal\package_manager\Event\PreCreateEvent;
-use Drupal\package_manager\Event\StageEvent;
-use Drupal\package_manager\ValidationResult;
+use Drupal\package_manager\Event\PreOperationStageEvent;
 use Drupal\Component\FileSystem\FileSystem;
 use Drupal\Component\Utility\Bytes;
 use Drupal\Core\StringTranslation\StringTranslationTrait;
@@ -14,7 +13,7 @@ use Drupal\package_manager\PathLocator;
 /**
  * Validates that there is enough free disk space to do automatic updates.
  */
-class DiskSpaceValidator implements StageValidatorInterface {
+class DiskSpaceValidator implements PreOperationStageValidatorInterface {
 
   use StringTranslationTrait;
 
@@ -99,7 +98,7 @@ class DiskSpaceValidator implements StageValidatorInterface {
   /**
    * {@inheritdoc}
    */
-  public function validateStage(StageEvent $event): void {
+  public function validateStagePreOperation(PreOperationStageEvent $event): void {
     $root_path = $this->pathLocator->getProjectRoot();
     $vendor_path = $this->pathLocator->getVendorDirectory();
     $messages = [];
@@ -140,9 +139,7 @@ class DiskSpaceValidator implements StageValidatorInterface {
       $summary = count($messages) > 1
         ? $this->t("There is not enough disk space to create a staging area.")
         : NULL;
-
-      $error = ValidationResult::createError($messages, $summary);
-      $event->addValidationResult($error);
+      $event->addError($messages, $summary);
     }
   }
 
@@ -161,7 +158,7 @@ class DiskSpaceValidator implements StageValidatorInterface {
    */
   public static function getSubscribedEvents() {
     return [
-      PreCreateEvent::class => 'validateStage',
+      PreCreateEvent::class => 'validateStagePreOperation',
     ];
   }
 

package_manager/src/EventSubscriber/LockFileValidator.php

@@ -8,15 +8,14 @@ use Drupal\Core\StringTranslation\TranslationInterface;
 use Drupal\package_manager\Event\PostDestroyEvent;
 use Drupal\package_manager\Event\PreApplyEvent;
 use Drupal\package_manager\Event\PreCreateEvent;
+use Drupal\package_manager\Event\PreOperationStageEvent;
 use Drupal\package_manager\Event\PreRequireEvent;
-use Drupal\package_manager\Event\StageEvent;
 use Drupal\package_manager\PathLocator;
-use Drupal\package_manager\ValidationResult;
 
 /**
  * Checks that the active lock file is unchanged during stage operations.
  */
-class LockFileValidator implements StageValidatorInterface {
+class LockFileValidator implements PreOperationStageValidatorInterface {
 
   use StringTranslationTrait;
 
@@ -87,17 +86,16 @@ class LockFileValidator implements StageValidatorInterface {
       $this->state->set(static::STATE_KEY, $hash);
     }
     else {
-      $result = ValidationResult::createError([
+      $event->addError([
         $this->t('Could not hash the active lock file.'),
       ]);
-      $event->addValidationResult($result);
     }
   }
 
   /**
    * {@inheritdoc}
    */
-  public function validateStage(StageEvent $event): void {
+  public function validateStagePreOperation(PreOperationStageEvent $event): void {
     // Ensure we can get a current hash of the lock file.
     $hash = $this->getHash();
     if (empty($hash)) {
@@ -118,8 +116,7 @@ class LockFileValidator implements StageValidatorInterface {
     // @todo Let the validation result carry all the relevant messages in
     //   https://www.drupal.org/i/3247479.
     if (isset($error)) {
-      $result = ValidationResult::createError([$error]);
-      $event->addValidationResult($result);
+      $event->addError([$error]);
     }
   }
 
@@ -136,8 +133,8 @@ class LockFileValidator implements StageValidatorInterface {
   public static function getSubscribedEvents() {
     return [
       PreCreateEvent::class => 'storeHash',
-      PreRequireEvent::class => 'validateStage',
-      PreApplyEvent::class => 'validateStage',
+      PreRequireEvent::class => 'validateStagePreOperation',
+      PreApplyEvent::class => 'validateStagePreOperation',
       PostDestroyEvent::class => 'deleteHash',
     ];
   }

package_manager/src/EventSubscriber/PendingUpdatesValidator.php

@@ -3,8 +3,7 @@
 namespace Drupal\package_manager\EventSubscriber;
 
 use Drupal\package_manager\Event\PreCreateEvent;
-use Drupal\package_manager\Event\StageEvent;
-use Drupal\package_manager\ValidationResult;
+use Drupal\package_manager\Event\PreOperationStageEvent;
 use Drupal\Core\StringTranslation\StringTranslationTrait;
 use Drupal\Core\StringTranslation\TranslationInterface;
 use Drupal\Core\Update\UpdateRegistry;
@@ -13,7 +12,7 @@ use Drupal\Core\Url;
 /**
  * Validates that there are no pending database updates.
  */
-class PendingUpdatesValidator implements StageValidatorInterface {
+class PendingUpdatesValidator implements PreOperationStageValidatorInterface {
 
   use StringTranslationTrait;
 
@@ -50,7 +49,7 @@ class PendingUpdatesValidator implements StageValidatorInterface {
   /**
    * {@inheritdoc}
    */
-  public function validateStage(StageEvent $event): void {
+  public function validateStagePreOperation(PreOperationStageEvent $event): void {
     require_once $this->appRoot . '/core/includes/install.inc';
     require_once $this->appRoot . '/core/includes/update.inc';
 
@@ -62,8 +61,7 @@ class PendingUpdatesValidator implements StageValidatorInterface {
       $message = $this->t('Some modules have database schema updates to install. You should run the <a href=":update">database update script</a> immediately.', [
         ':update' => Url::fromRoute('system.db_update')->toString(),
       ]);
-      $error = ValidationResult::createError([$message]);
-      $event->addValidationResult($error);
+      $event->addError([$message]);
     }
   }
 
@@ -72,7 +70,7 @@ class PendingUpdatesValidator implements StageValidatorInterface {
    */
   public static function getSubscribedEvents() {
     return [
-      PreCreateEvent::class => 'validateStage',
+      PreCreateEvent::class => 'validateStagePreOperation',
     ];
   }
 

package_manager/src/EventSubscriber/PostOperationStageValidatorInterface.php

+<?php
+
+namespace Drupal\package_manager\EventSubscriber;
+
+use Drupal\package_manager\Event\PostOperationStageEvent;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+/**
+ * Defines an interface for classes that validate a stage after an operation.
+ */
+interface PostOperationStageValidatorInterface extends EventSubscriberInterface {
+
+  /**
+   * Validates a stage after an operation.
+   *
+   * @param \Drupal\package_manager\Event\PostOperationStageEvent $event
+   *   The stage event.
+   */
+  public function validateStagePostOperation(PostOperationStageEvent $event): void;
+
+}

package_manager/src/EventSubscriber/PreOperationStageValidatorInterface.php

+<?php
+
+namespace Drupal\package_manager\EventSubscriber;
+
+use Drupal\package_manager\Event\PreOperationStageEvent;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+/**
+ * Defines an interface for classes that validate a stage before an operation.
+ */
+interface PreOperationStageValidatorInterface extends EventSubscriberInterface {
+
+  /**
+   * Validates a stage before an operation.
+   *
+   * @param \Drupal\package_manager\Event\PreOperationStageEvent $event
+   *   The stage event.
+   */
+  public function validateStagePreOperation(PreOperationStageEvent $event): void;
+
+}

package_manager/src/EventSubscriber/StageValidatorInterface.php

-<?php
-
-namespace Drupal\package_manager\EventSubscriber;
-
-use Drupal\package_manager\Event\StageEvent;
-use Symfony\Component\EventDispatcher\EventSubscriberInterface;
-
-/**
- * Defines an interface for services that validate a stage over its life cycle.
- */
-interface StageValidatorInterface extends EventSubscriberInterface {
-
-  /**
-   * Validates a stage at various points during its life cycle.
-   *
-   * @param \Drupal\package_manager\Event\StageEvent $event
-   *   The event object.
-   */
-  public function validateStage(StageEvent $event): void;
-
-}