From 3e60128037252fb62067315eaeff67f517967119 Mon Sep 17 00:00:00 2001
From: epriestley <git@epriestley.com>
Date: Thu, 12 Sep 2019 13:11:18 -0700
Subject: [PATCH] Support "Subtype" in Herald

Summary: See PHI1434. For objects that support subtypes and have subtypes configured, allow Herald rules to act on subtypes.

Test Plan:
  - Configured task and project subtypes, wrote Herald rules, saw "Subtypes" as an option, saw appropriate typeahead values and detail page rendering.
  - Unconfigured project subtypes, saw field vanish from UI for new rules.
  - Wrote a "subtype"-depenent rule that added a comment, interacted with tasks of that subtype and a different subtype. Saw Herald act only on tasks with the correct subtype.

Differential Revision: https://secure.phabricator.com/D20809
---
 src/__phutil_library_map__.php                |  2 +
 .../maniphest/storage/ManiphestTask.php       |  3 +-
 .../project/storage/PhabricatorProject.php    |  3 +-
 .../PhabricatorEditEngineSubtypeMap.php       | 14 +++++
 ...habricatorEditEngineSubtypeHeraldField.php | 52 +++++++++++++++++++
 5 files changed, 72 insertions(+), 2 deletions(-)
 create mode 100644 src/applications/transactions/herald/PhabricatorEditEngineSubtypeHeraldField.php

diff --git a/src/__phutil_library_map__.php b/src/__phutil_library_map__.php
index 1f844f9695..95c5059d06 100644
--- a/src/__phutil_library_map__.php
+++ b/src/__phutil_library_map__.php
@@ -3217,6 +3217,7 @@ phutil_register_library_map(array(
     'PhabricatorEditEngineSettingsPanel' => 'applications/settings/panel/PhabricatorEditEngineSettingsPanel.php',
     'PhabricatorEditEngineStaticCommentAction' => 'applications/transactions/commentaction/PhabricatorEditEngineStaticCommentAction.php',
     'PhabricatorEditEngineSubtype' => 'applications/transactions/editengine/PhabricatorEditEngineSubtype.php',
+    'PhabricatorEditEngineSubtypeHeraldField' => 'applications/transactions/herald/PhabricatorEditEngineSubtypeHeraldField.php',
     'PhabricatorEditEngineSubtypeInterface' => 'applications/transactions/editengine/PhabricatorEditEngineSubtypeInterface.php',
     'PhabricatorEditEngineSubtypeMap' => 'applications/transactions/editengine/PhabricatorEditEngineSubtypeMap.php',
     'PhabricatorEditEngineSubtypeTestCase' => 'applications/transactions/editengine/__tests__/PhabricatorEditEngineSubtypeTestCase.php',
@@ -9550,6 +9551,7 @@ phutil_register_library_map(array(
     'PhabricatorEditEngineSettingsPanel' => 'PhabricatorSettingsPanel',
     'PhabricatorEditEngineStaticCommentAction' => 'PhabricatorEditEngineCommentAction',
     'PhabricatorEditEngineSubtype' => 'Phobject',
+    'PhabricatorEditEngineSubtypeHeraldField' => 'HeraldField',
     'PhabricatorEditEngineSubtypeMap' => 'Phobject',
     'PhabricatorEditEngineSubtypeTestCase' => 'PhabricatorTestCase',
     'PhabricatorEditEngineSubtypeTransaction' => 'PhabricatorEditEngineTransactionType',
diff --git a/src/applications/maniphest/storage/ManiphestTask.php b/src/applications/maniphest/storage/ManiphestTask.php
index d2700895ce..c56d8fe57a 100644
--- a/src/applications/maniphest/storage/ManiphestTask.php
+++ b/src/applications/maniphest/storage/ManiphestTask.php
@@ -564,7 +564,8 @@ final class ManiphestTask extends ManiphestDAO
 
   public function newEditEngineSubtypeMap() {
     $config = PhabricatorEnv::getEnvConfig('maniphest.subtypes');
-    return PhabricatorEditEngineSubtype::newSubtypeMap($config);
+    return PhabricatorEditEngineSubtype::newSubtypeMap($config)
+      ->setDatasource(new ManiphestTaskSubtypeDatasource());
   }
 
 
diff --git a/src/applications/project/storage/PhabricatorProject.php b/src/applications/project/storage/PhabricatorProject.php
index 54267829d3..1d234d4285 100644
--- a/src/applications/project/storage/PhabricatorProject.php
+++ b/src/applications/project/storage/PhabricatorProject.php
@@ -904,7 +904,8 @@ final class PhabricatorProject extends PhabricatorProjectDAO
 
   public function newEditEngineSubtypeMap() {
     $config = PhabricatorEnv::getEnvConfig('projects.subtypes');
-    return PhabricatorEditEngineSubtype::newSubtypeMap($config);
+    return PhabricatorEditEngineSubtype::newSubtypeMap($config)
+      ->setDatasource(new PhabricatorProjectSubtypeDatasource());
   }
 
   public function newSubtypeObject() {
diff --git a/src/applications/transactions/editengine/PhabricatorEditEngineSubtypeMap.php b/src/applications/transactions/editengine/PhabricatorEditEngineSubtypeMap.php
index 638b665184..dc1ee2842a 100644
--- a/src/applications/transactions/editengine/PhabricatorEditEngineSubtypeMap.php
+++ b/src/applications/transactions/editengine/PhabricatorEditEngineSubtypeMap.php
@@ -5,6 +5,7 @@ final class PhabricatorEditEngineSubtypeMap
   extends Phobject {
 
   private $subtypes;
+  private $datasource;
 
   public function __construct(array $subtypes) {
     assert_instances_of($subtypes, 'PhabricatorEditEngineSubtype');
@@ -39,6 +40,19 @@ final class PhabricatorEditEngineSubtypeMap
     return $this->subtypes[$subtype_key];
   }
 
+  public function setDatasource(PhabricatorTypeaheadDatasource $datasource) {
+    $this->datasource = $datasource;
+    return $this;
+  }
+
+  public function newDatasource() {
+    if (!$this->datasource) {
+      throw new PhutilInvalidStateException('setDatasource');
+    }
+
+    return clone($this->datasource);
+  }
+
   public function getCreateFormsForSubtype(
     PhabricatorEditEngine $edit_engine,
     PhabricatorEditEngineSubtypeInterface $object) {
diff --git a/src/applications/transactions/herald/PhabricatorEditEngineSubtypeHeraldField.php b/src/applications/transactions/herald/PhabricatorEditEngineSubtypeHeraldField.php
new file mode 100644
index 0000000000..be15540fc9
--- /dev/null
+++ b/src/applications/transactions/herald/PhabricatorEditEngineSubtypeHeraldField.php
@@ -0,0 +1,52 @@
+<?php
+
+final class PhabricatorEditEngineSubtypeHeraldField
+  extends HeraldField {
+
+  const FIELDCONST = 'subtype';
+
+  public function getHeraldFieldName() {
+    return pht('Subtype');
+  }
+
+  public function getFieldGroupKey() {
+    return HeraldSupportFieldGroup::FIELDGROUPKEY;
+  }
+
+  public function supportsObject($object) {
+    return ($object instanceof PhabricatorEditEngineSubtypeInterface);
+  }
+
+  public function getHeraldFieldValue($object) {
+    return $object->getEditEngineSubtype();
+  }
+
+  protected function getHeraldFieldStandardType() {
+    return self::STANDARD_PHID;
+  }
+
+  protected function getDatasource() {
+    $object = $this->getAdapter()->getObject();
+    $map = $object->newEditEngineSubtypeMap();
+    return $map->newDatasource();
+  }
+
+  protected function getDatasourceValueMap() {
+    $object = $this->getAdapter()->getObject();
+    $map = $object->newEditEngineSubtypeMap();
+
+    $result = array();
+    foreach ($map->getSubtypes() as $subtype) {
+      $result[$subtype->getKey()] = $subtype->getName();
+    }
+
+    return $result;
+  }
+
+  public function isFieldAvailable() {
+    $object = $this->getAdapter()->getObject();
+    $map = $object->newEditEngineSubtypeMap();
+    return ($map->getCount() > 1);
+  }
+
+}