Modularize content sources

Summary: Ref T10537. For Nuance, I want to introduce new sources (like "GitHub" or "GitHub via Nuance" or something) but this needs to modularize eventually. Split ContentSource apart so applications can add new content sources. Test Plan: This change has huge surface area, so I'll hold it until post-release. I think it's fairly safe (and if it does break anything, the breaks should be fatals, not anything subtle or difficult to fix), there's just no reason not to hold it for a few hours. - Viewed new module page. - Grepped for all removed functions/constants. - Viewed some transactions. - Hovered over timestamps to get content source details. - Added a comment via Conduit. - Added a comment via web. - Ran `bin/storage upgrade --namespace XXXXX --no-quickstart -f` to re-run all historic migrations. - Generated some objects with `bin/lipsum`. - Ran a bulk job on some tasks. - Ran unit tests. {F1190182} Reviewers: chad Reviewed By: chad Maniphest Tasks: T10537 Differential Revision: https://secure.phabricator.com/D15521
phacility · Mar 26, 2016 · 601aaa5 · 601aaa5
1 parent d784d9c
commit 601aaa5
Show file tree

Hide file tree

Showing 83 changed files with 495 additions and 265 deletions.
diff --git a/resources/sql/autopatches/20140211.dx.2.migcommenttext.php b/resources/sql/autopatches/20140211.dx.2.migcommenttext.php
@@ -4,8 +4,7 @@
 $rows = new LiskRawMigrationIterator($conn_w, 'differential_comment');
 
 $content_source = PhabricatorContentSource::newForSource(
-  PhabricatorContentSource::SOURCE_LEGACY,
-  array())->serialize();
+  PhabricatorOldWorldContentSource::SOURCECONST)->serialize();
 
 echo pht('Migrating Differential comment text to modern storage...')."\n";
 foreach ($rows as $row) {

diff --git a/resources/sql/autopatches/20140212.dx.1.armageddon.php b/resources/sql/autopatches/20140212.dx.1.armageddon.php
@@ -4,8 +4,7 @@
 $rows = new LiskRawMigrationIterator($conn_w, 'differential_comment');
 
 $content_source = PhabricatorContentSource::newForSource(
-  PhabricatorContentSource::SOURCE_LEGACY,
-  array())->serialize();
+  PhabricatorOldWorldContentSource::SOURCECONST)->serialize();
 
 echo pht('Migrating Differential comments to modern storage...')."\n";
 foreach ($rows as $row) {

diff --git a/resources/sql/autopatches/20140722.audit.3.miginlines.php b/resources/sql/autopatches/20140722.audit.3.miginlines.php
@@ -10,8 +10,7 @@
 echo pht('Migrating Audit inline comments to new format...')."\n";
 
 $content_source = PhabricatorContentSource::newForSource(
-  PhabricatorContentSource::SOURCE_LEGACY,
-  array())->serialize();
+  PhabricatorOldWorldContentSource::SOURCECONST)->serialize();
 
 $rows = new LiskRawMigrationIterator($conn_w, $src_table);
 foreach ($rows as $row) {

diff --git a/resources/sql/autopatches/20140722.audit.4.migtext.php b/resources/sql/autopatches/20140722.audit.4.migtext.php
@@ -4,8 +4,7 @@
 $rows = new LiskRawMigrationIterator($conn_w, 'audit_comment');
 
 $content_source = PhabricatorContentSource::newForSource(
-  PhabricatorContentSource::SOURCE_LEGACY,
-  array())->serialize();
+  PhabricatorOldWorldContentSource::SOURCECONST)->serialize();
 
 echo pht('Migrating Audit comment text to modern storage...')."\n";
 foreach ($rows as $row) {

diff --git a/resources/sql/autopatches/20140725.audit.1.migxactions.php b/resources/sql/autopatches/20140725.audit.1.migxactions.php
@@ -4,8 +4,7 @@
 $rows = new LiskRawMigrationIterator($conn_w, 'audit_comment');
 
 $content_source = PhabricatorContentSource::newForSource(
-  PhabricatorContentSource::SOURCE_LEGACY,
-  array())->serialize();
+  PhabricatorOldWorldContentSource::SOURCECONST)->serialize();
 
 echo pht('Migrating Audit comments to modern storage...')."\n";
 foreach ($rows as $row) {

diff --git a/resources/sql/patches/20130715.votecomments.php b/resources/sql/patches/20130715.votecomments.php
@@ -46,9 +46,8 @@
     PhabricatorApplicationTransactionTransactionPHIDType::TYPECONST,
     PhabricatorSlowvotePollPHIDType::TYPECONST);
 
-  $source = PhabricatorContentSource::newForSource(
-    PhabricatorContentSource::SOURCE_LEGACY,
-    array())->serialize();
+  $content_source = PhabricatorContentSource::newForSource(
+    PhabricatorOldWorldContentSource::SOURCECONST)->serialize();
 
   queryfx(
     $conn_w,

diff --git a/resources/sql/patches/20130728.ponderxcomment.php b/resources/sql/patches/20130728.ponderxcomment.php
@@ -49,8 +49,7 @@
     1,
     $row['content'],
     PhabricatorContentSource::newForSource(
-      PhabricatorContentSource::SOURCE_LEGACY,
-      array())->serialize(),
+      PhabricatorOldWorldContentSource::SOURCECONST)->serialize(),
     0,
     $row['dateCreated'],
     $row['dateModified']);
@@ -73,8 +72,7 @@
     'null',
     'null',
     PhabricatorContentSource::newForSource(
-      PhabricatorContentSource::SOURCE_LEGACY,
-      array())->serialize(),
+      PhabricatorOldWorldContentSource::SOURCECONST)->serialize(),
     '[]',
     $row['dateCreated'],
     $row['dateModified']);

diff --git a/resources/sql/patches/20130801.pastexactions.php b/resources/sql/patches/20130801.pastexactions.php
@@ -34,8 +34,7 @@
     'null',
     $row['filePHID'],
     PhabricatorContentSource::newForSource(
-      PhabricatorContentSource::SOURCE_LEGACY,
-      array())->serialize(),
+      PhabricatorOldWorldContentSource::SOURCECONST)->serialize(),
     '[]',
     $row['dateCreated'],
     $row['dateCreated'],

diff --git a/resources/sql/patches/20130926.dinline.php b/resources/sql/patches/20130926.dinline.php
@@ -10,8 +10,7 @@
 echo pht('Migrating Differential inline comments to new format...')."\n";
 
 $content_source = PhabricatorContentSource::newForSource(
-  PhabricatorContentSource::SOURCE_LEGACY,
-  array())->serialize();
+  PhabricatorOldWorldContentSource::SOURCECONST)->serialize();
 
 $rows = new LiskRawMigrationIterator($conn_w, $src_table);
 foreach ($rows as $row) {

diff --git a/resources/sql/patches/20131020.pxactionmig.php b/resources/sql/patches/20131020.pxactionmig.php
@@ -10,8 +10,7 @@
 echo pht('Migrating Project transactions to new format...')."\n";
 
 $content_source = PhabricatorContentSource::newForSource(
-  PhabricatorContentSource::SOURCE_LEGACY,
-  array())->serialize();
+  PhabricatorOldWorldContentSource::SOURCECONST)->serialize();
 
 $rows = new LiskRawMigrationIterator($conn_w, $src_table);
 foreach ($rows as $row) {

diff --git a/src/__phutil_library_map__.php b/src/__phutil_library_map__.php
diff --git a/src/applications/almanac/management/AlmanacManagementWorkflow.php b/src/applications/almanac/management/AlmanacManagementWorkflow.php
@@ -3,7 +3,6 @@
 abstract class AlmanacManagementWorkflow
   extends PhabricatorManagementWorkflow {
 
-
   protected function loadServices(array $names) {
     if (!$names) {
       return array();
@@ -37,7 +36,7 @@ protected function updateServiceLock(AlmanacService $service, $lock) {
     $editor = id(new AlmanacServiceEditor())
       ->setActor($this->getViewer())
       ->setActingAsPHID($almanac_phid)
-      ->setContentSource(PhabricatorContentSource::newConsoleSource())
+      ->setContentSource($this->newContentSource())
       ->setContinueOnMissingFields(true);
 
     $editor->applyTransactions($service, array($xaction));

diff --git a/src/applications/audit/storage/PhabricatorAuditInlineComment.php b/src/applications/audit/storage/PhabricatorAuditInlineComment.php
@@ -34,8 +34,7 @@ public function isHidden() {
 
   public function getTransactionCommentForSave() {
     $content_source = PhabricatorContentSource::newForSource(
-      PhabricatorContentSource::SOURCE_LEGACY,
-      array());
+      PhabricatorOldWorldContentSource::SOURCECONST);
 
     $this->proxy
       ->setViewPolicy('public')

diff --git a/src/applications/conduit/protocol/ConduitAPIRequest.php b/src/applications/conduit/protocol/ConduitAPIRequest.php
@@ -57,4 +57,9 @@ public function getIsClusterRequest() {
     return $this->isClusterRequest;
   }
 
+  public function newContentSource() {
+    return PhabricatorContentSource::newForSource(
+      PhabricatorConduitContentSource::SOURCECONST);
+  }
+
 }
diff --git a/src/applications/conpherence/__tests__/ConpherenceRoomTestCase.php b/src/applications/conpherence/__tests__/ConpherenceRoomTestCase.php
@@ -147,7 +147,7 @@ private function createRoom(
 
     id(new ConpherenceEditor())
       ->setActor($creator)
-      ->setContentSource(PhabricatorContentSource::newConsoleSource())
+      ->setContentSource($this->newContentSource())
       ->setContinueOnNoEffect(true)
       ->applyTransactions($conpherence, $xactions);
 
@@ -166,7 +166,7 @@ private function changeEditPolicy(
 
     id(new ConpherenceEditor())
       ->setActor($actor)
-      ->setContentSource(PhabricatorContentSource::newConsoleSource())
+      ->setContentSource($this->newContentSource())
       ->setContinueOnNoEffect(true)
       ->applyTransactions($room, $xactions);
   }

diff --git a/src/applications/conpherence/__tests__/ConpherenceTestCase.php b/src/applications/conpherence/__tests__/ConpherenceTestCase.php
@@ -14,7 +14,7 @@ protected function addParticipants(
     );
     $editor = id(new ConpherenceEditor())
       ->setActor($actor)
-      ->setContentSource(PhabricatorContentSource::newConsoleSource())
+      ->setContentSource($this->newContentSource())
       ->applyTransactions($conpherence, $xactions);
 
   }
@@ -31,7 +31,7 @@ protected function removeParticipants(
     );
     $editor = id(new ConpherenceEditor())
       ->setActor($actor)
-      ->setContentSource(PhabricatorContentSource::newConsoleSource())
+      ->setContentSource($this->newContentSource())
       ->applyTransactions($conpherence, $xactions);
   }
 
@@ -45,7 +45,7 @@ protected function addMessageWithFile(
 
     $editor = id(new ConpherenceEditor())
       ->setActor($actor)
-      ->setContentSource(PhabricatorContentSource::newConsoleSource());
+      ->setContentSource($this->newContentSource());
 
     $xactions = $editor->generateTransactionsFromText(
       $actor,

diff --git a/src/applications/conpherence/conduit/ConpherenceCreateThreadConduitAPIMethod.php b/src/applications/conpherence/conduit/ConpherenceCreateThreadConduitAPIMethod.php
@@ -42,7 +42,7 @@ protected function execute(ConduitAPIRequest $request) {
       $participant_phids,
       $title,
       $message,
-      PhabricatorContentSource::newFromConduitRequest($request));
+      $request->newContentSource());
 
     if ($errors) {
       foreach ($errors as $error_code) {

diff --git a/src/applications/conpherence/conduit/ConpherenceUpdateThreadConduitAPIMethod.php b/src/applications/conpherence/conduit/ConpherenceUpdateThreadConduitAPIMethod.php
@@ -58,7 +58,7 @@ protected function execute(ConduitAPIRequest $request) {
       throw new ConduitException('ERR_USAGE_ROOM_NOT_FOUND');
     }
 
-    $source = PhabricatorContentSource::newFromConduitRequest($request);
+    $source = $request->newContentSource();
     $editor = id(new ConpherenceEditor())
       ->setContentSource($source)
       ->setActor($user);

diff --git a/src/applications/conpherence/mail/ConpherenceReplyHandler.php b/src/applications/conpherence/mail/ConpherenceReplyHandler.php
@@ -48,11 +48,7 @@ protected function receiveEmail(PhabricatorMetaMTAReceivedMail $mail) {
       $conpherence->attachParticipants($participants);
     }
 
-    $content_source = PhabricatorContentSource::newForSource(
-      PhabricatorContentSource::SOURCE_EMAIL,
-      array(
-        'id' => $mail->getID(),
-      ));
+    $content_source = $mail->newContentSource();
 
     $editor = id(new ConpherenceEditor())
       ->setActor($user)

diff --git a/src/applications/differential/conduit/DifferentialCloseConduitAPIMethod.php b/src/applications/differential/conduit/DifferentialCloseConduitAPIMethod.php
@@ -45,13 +45,11 @@ protected function execute(ConduitAPIRequest $request) {
       ->setTransactionType(DifferentialTransaction::TYPE_ACTION)
       ->setNewValue(DifferentialAction::ACTION_CLOSE);
 
-    $content_source = PhabricatorContentSource::newForSource(
-      PhabricatorContentSource::SOURCE_CONDUIT,
-      array());
+    $content_source = $request->newContentSource();
 
     $editor = id(new DifferentialTransactionEditor())
       ->setActor($viewer)
-      ->setContentSourceFromConduitRequest($request)
+      ->setContentSource($request->newContentSource())
       ->setContinueOnMissingFields(true)
       ->setContinueOnNoEffect(true);
 

diff --git a/src/applications/differential/conduit/DifferentialConduitAPIMethod.php b/src/applications/differential/conduit/DifferentialConduitAPIMethod.php
@@ -138,7 +138,7 @@ protected function applyFieldEdit(
 
     $editor = id(new DifferentialTransactionEditor())
       ->setActor($viewer)
-      ->setContentSourceFromConduitRequest($request)
+      ->setContentSource($request->newContentSource())
       ->setContinueOnNoEffect(true)
       ->setContinueOnMissingFields(true);
 

diff --git a/src/applications/differential/conduit/DifferentialCreateCommentConduitAPIMethod.php b/src/applications/differential/conduit/DifferentialCreateCommentConduitAPIMethod.php
@@ -77,7 +77,7 @@ protected function execute(ConduitAPIRequest $request) {
     $editor = id(new DifferentialTransactionEditor())
       ->setActor($viewer)
       ->setDisableEmail($request->getValue('silent'))
-      ->setContentSourceFromConduitRequest($request)
+      ->setContentSource($request->newContentSource())
       ->setContinueOnNoEffect(true)
       ->setContinueOnMissingFields(true);
 

diff --git a/src/applications/differential/conduit/DifferentialCreateDiffConduitAPIMethod.php b/src/applications/differential/conduit/DifferentialCreateDiffConduitAPIMethod.php
@@ -144,7 +144,7 @@ protected function execute(ConduitAPIRequest $request) {
 
     id(new DifferentialDiffEditor())
       ->setActor($viewer)
-      ->setContentSourceFromConduitRequest($request)
+      ->setContentSource($request->newContentSource())
       ->setContinueOnNoEffect(true)
       ->applyTransactions($diff, $xactions);
 

diff --git a/src/applications/differential/conduit/DifferentialCreateRawDiffConduitAPIMethod.php b/src/applications/differential/conduit/DifferentialCreateRawDiffConduitAPIMethod.php
@@ -85,7 +85,7 @@ protected function execute(ConduitAPIRequest $request) {
 
     id(new DifferentialDiffEditor())
       ->setActor($viewer)
-      ->setContentSourceFromConduitRequest($request)
+      ->setContentSource($request->newContentSource())
       ->setContinueOnNoEffect(true)
       ->setLookupRepository(false) // respect user choice
       ->applyTransactions($diff, $xactions);

diff --git a/src/applications/differential/management/PhabricatorDifferentialAttachCommitWorkflow.php b/src/applications/differential/management/PhabricatorDifferentialAttachCommitWorkflow.php
@@ -68,9 +68,7 @@ public function execute(PhutilArgumentParser $args) {
       ->setViewer($viewer)
       ->setAuthorPHID($differential_phid);
 
-    $content_source = PhabricatorContentSource::newForSource(
-      PhabricatorContentSource::SOURCE_CONSOLE,
-      array());
+    $content_source = $this->newContentSource();
 
     $extraction_engine->updateRevisionWithCommit(
       $revision,

diff --git a/src/applications/differential/storage/DifferentialInlineComment.php b/src/applications/differential/storage/DifferentialInlineComment.php
@@ -18,8 +18,7 @@ public function __clone() {
 
   public function getTransactionCommentForSave() {
     $content_source = PhabricatorContentSource::newForSource(
-      PhabricatorContentSource::SOURCE_LEGACY,
-      array());
+      PhabricatorOldWorldContentSource::SOURCECONST);
 
     $this->proxy
       ->setViewPolicy('public')

diff --git a/src/applications/diffusion/conduit/DiffusionCreateCommentConduitAPIMethod.php b/src/applications/diffusion/conduit/DiffusionCreateCommentConduitAPIMethod.php
@@ -95,7 +95,7 @@ protected function execute(ConduitAPIRequest $request) {
 
     id(new PhabricatorAuditEditor())
       ->setActor($request->getUser())
-      ->setContentSourceFromConduitRequest($request)
+      ->setContentSource($request->newContentSource())
       ->setDisableEmail($request->getValue('silent'))
       ->setContinueOnMissingFields(true)
       ->applyTransactions($commit, $xactions);

diff --git a/src/applications/harbormaster/engine/HarbormasterBuildEngine.php b/src/applications/harbormaster/engine/HarbormasterBuildEngine.php
@@ -458,8 +458,7 @@ private function updateBuildable(HarbormasterBuildable $buildable) {
       ->getPHID();
 
     $daemon_source = PhabricatorContentSource::newForSource(
-      PhabricatorContentSource::SOURCE_DAEMON,
-      array());
+      PhabricatorDaemonContentSource::SOURCECONST);
 
     $editor = $object->getApplicationTransactionEditor()
       ->setActor($viewer)

diff --git a/src/applications/herald/contentsource/PhabricatorHeraldContentSource.php b/src/applications/herald/contentsource/PhabricatorHeraldContentSource.php
@@ -0,0 +1,16 @@
+<?php
+
+final class PhabricatorHeraldContentSource
+  extends PhabricatorContentSource {
+
+  const SOURCECONST = 'herald';
+
+  public function getSourceName() {
+    return pht('Herald');
+  }
+
+  public function getSourceDescription() {
+    return pht('Changes triggered by Herald rules.');
+  }
+
+}
diff --git a/src/applications/herald/field/HeraldContentSourceField.php b/src/applications/herald/field/HeraldContentSourceField.php
@@ -24,12 +24,13 @@ public function getHeraldFieldConditions() {
   }
 
   public function getHeraldFieldValueType($condition) {
-    $map = PhabricatorContentSource::getSourceNameMap();
+    $map = PhabricatorContentSource::getAllContentSources();
+    $map = mpull($map, 'getSourceName');
     asort($map);
 
     return id(new HeraldSelectFieldValue())
       ->setKey(self::FIELDCONST)
-      ->setDefault(PhabricatorContentSource::SOURCE_WEB)
+      ->setDefault(PhabricatorWebContentSource::SOURCECONST)
       ->setOptions($map);
   }
 

diff --git a/src/applications/lipsum/generator/PhabricatorTestDataGenerator.php b/src/applications/lipsum/generator/PhabricatorTestDataGenerator.php
@@ -56,8 +56,7 @@ protected function loadRandomUser() {
 
   protected function getLipsumContentSource() {
     return PhabricatorContentSource::newForSource(
-      PhabricatorContentSource::SOURCE_LIPSUM,
-      array());
+      PhabricatorLipsumContentSource::SOURCECONST);
   }
 
   /**

diff --git a/src/applications/maniphest/__tests__/ManiphestTaskTestCase.php b/src/applications/maniphest/__tests__/ManiphestTaskTestCase.php
@@ -207,7 +207,7 @@ private function applyTaskTransactions(
     ManiphestTask $task,
     array $xactions) {
 
-    $content_source = PhabricatorContentSource::newConsoleSource();
+    $content_source = $this->newContentSource();
 
     $editor = id(new ManiphestTransactionEditor())
       ->setActor($viewer)

diff --git a/src/applications/maniphest/conduit/ManiphestConduitAPIMethod.php b/src/applications/maniphest/conduit/ManiphestConduitAPIMethod.php
@@ -192,9 +192,7 @@ protected function applyRequest(
       return;
     }
 
-    $content_source = PhabricatorContentSource::newForSource(
-      PhabricatorContentSource::SOURCE_CONDUIT,
-      array());
+    $content_source = $request->newContentSource();
 
     $editor = id(new ManiphestTransactionEditor())
       ->setActor($request->getUser())

diff --git a/src/applications/maniphest/lipsum/PhabricatorManiphestTaskTestDataGenerator.php b/src/applications/maniphest/lipsum/PhabricatorManiphestTaskTestDataGenerator.php
@@ -15,9 +15,7 @@ public function generateObject() {
       ->setSubPriority($this->generateTaskSubPriority())
       ->setTitle($this->generateTitle());
 
-    $content_source = PhabricatorContentSource::newForSource(
-      PhabricatorContentSource::SOURCE_UNKNOWN,
-      array());
+    $content_source = $this->getLipsumContentSource();
 
     $template = new ManiphestTransaction();
     // Accumulate Transactions