Merge pull request #4 from mozilla-conduit/1734925-emails-to-watchers

Bug 1734925: Send emails to reviewer group "watchers"

Author: Mitchell Hentges

moz-extensions/src/email/adapter/GroupPhabricatorReviewer.php

@@ -5,14 +5,17 @@ class GroupPhabricatorReviewer implements PhabricatorReviewer {
   private string $name;
   /** @var PhabricatorUser[] */
   private array $rawUsers;
+  private array $rawWatcherUsers;
 
   /**
    * @param string $name
    * @param PhabricatorUser[] $rawUsers
+   * @param PhabricatorUser[] $rawWatcherUsers
    */
-  public function __construct(string $name, array $rawUsers) {
+  public function __construct(string $name, array $rawUsers, array $rawWatcherUsers) {
     $this->name = $name;
     $this->rawUsers = $rawUsers;
+    $this->rawWatcherUsers = $rawWatcherUsers;
   }
 
   public function name(): string {
@@ -24,4 +27,11 @@ public function toRecipients(string $actorEmail): array {
       return EmailRecipient::from($user, $actorEmail);
     }, $this->rawUsers)));
   }
-}
+
+  public function getWatchersAsRecipients(string $actorEmail): array
+  {
+    return array_values(array_filter(array_map(function($user) use ($actorEmail) {
+      return EmailRecipient::from($user, $actorEmail);
+    }, $this->rawWatcherUsers)));
+  }
+}

moz-extensions/src/email/adapter/PhabricatorReviewer.php

@@ -8,4 +8,9 @@ public function name(): string;
    * @return EmailRecipient[]
    */
   public function toRecipients(string $actorEmail): array;
-}
+
+  /**
+   * @return EmailRecipient[]
+   */
+  public function getWatchersAsRecipients(string $actorEmail): array;
+}

moz-extensions/src/email/adapter/PhabricatorUserStore.php

@@ -62,12 +62,13 @@ public function findReviewerByPHID(string $PHID): PhabricatorReviewer {
       // This is a group reviewer
       $project = self::fetchProject($PHID);
       $users = array_values($this->queryAll($project->getMemberPHIDs()));
-      return new GroupPhabricatorReviewer($project->getDisplayName(), $users);
+      $watchers = array_values($this->queryAll($project->getWatcherPHIDs()));
+      return new GroupPhabricatorReviewer($project->getDisplayName(), $users, $watchers);
     } else if (substr($PHID, 0, strlen('PHID-OPKG')) == 'PHID-OPKG') {
       // This is a "code owner" reviewer
       $package = self::fetchPackage($PHID);
       $users = array_values($this->queryAll($package->getOwnerPHIDs()));
-      return new GroupPhabricatorReviewer($package->getName(), $users);
+      return new GroupPhabricatorReviewer($package->getName(), $users, []);
     } else {
       // PHID type must be "PHID-USER".
       // So, this is a single user reviewer.
@@ -95,6 +96,7 @@ private static function fetchProject(string $PHID): PhabricatorProject {
     return (new PhabricatorProjectQuery())
       ->setViewer(PhabricatorUser::getOmnipotentUser())
       ->needMembers(true)
+      ->needWatchers(true)
       ->withPHIDs([$PHID])
       ->executeOne();
   }
@@ -105,4 +107,4 @@ private static function fetchPackage(string $PHID): PhabricatorOwnersPackage {
       ->withPHIDs([$PHID])
       ->executeOne();
   }
-}
+}

moz-extensions/src/email/adapter/UserPhabricatorReviewer.php

@@ -15,4 +15,9 @@ public function name(): string {
   public function toRecipients(string $actorEmail): array {
     return array_filter([EmailRecipient::from($this->rawUser, $actorEmail)]);
   }
-}
+
+  public function getWatchersAsRecipients(string $actorEmail): array
+  {
+    return [];
+  }
+}

moz-extensions/src/email/resolve/ResolveUsers.php

@@ -46,14 +46,9 @@ public function resolveReviewersAsRecipients(): array {
    * @return EmailReviewer[]
    */
   public function resolveReviewers(bool $revisionChangedToNeedReview): array {
-    $rawReviewers = $this->rawRevision->getReviewers();
+    $rawReviewers = $this->resolveUnresignedReviewers();
     $reviewers = [];
     foreach ($rawReviewers as $reviewerPHID => $rawReviewer) {
-      if ($rawReviewer->isResigned()) {
-        // In the future, we could show resigned reviewers in the email body
-        continue;
-      }
-
       $allReviewerStatuses = array_map(function($reviewer) {
         return $reviewer->getReviewerStatus();
       }, $rawReviewers);
@@ -64,18 +59,22 @@ public function resolveReviewers(bool $revisionChangedToNeedReview): array {
       $reviewers[] = new EmailReviewer($reviewer->name(), $isActionable, $status, $reviewer->toRecipients($this->actorEmail));
     }
     return $reviewers;
-
   }
 
   /**
    * @return EmailRecipient[]
    */
   public function resolveSubscribersAsRecipients(): array {
     $recipientPHIDs = PhabricatorSubscribersQuery::loadSubscribersForPHID($this->rawRevision->getPHID());
-
     $recipientUsers = array_map(fn (string $phid) => $this->userStore->findAllBySubscribersById($phid), $recipientPHIDs);
     $recipientUsers = array_merge(...$recipientUsers); // Flatten array of arrays
     $recipients = array_map(fn (PhabricatorUser $user) => EmailRecipient::from($user, $this->actorEmail), $recipientUsers);
+
+    foreach (array_keys($this->resolveUnresignedReviewers()) as $reviewerPHID) {
+      $reviewer = $this->userStore->findReviewerByPHID($reviewerPHID);
+      $recipients = array_merge($recipients, $reviewer->getWatchersAsRecipients($this->actorEmail));
+    }
+
     return array_values(array_filter($recipients));
   }
 
@@ -95,4 +94,15 @@ public function resolveAllPossibleRecipients(): array
 
     return array_merge($subscribers, $reviewers, $authorList);
   }
-}
+
+  /**
+   * @return Phabricatoruser[]
+   */
+  private function resolveUnresignedReviewers(): array {
+    $reviewers = $this->rawRevision->getReviewers();
+    return array_filter($reviewers, function($rawReviewer) {
+      // In the future, we could show resigned reviewers in the email body
+      return !$rawReviewer->isResigned();
+    });
+  }
+}