Roughly support inline comment suggestions

Summary:
Ref T13513. This still has quite a few rough edges and some significant performance isssues, but appears to mostly work.

Allow reviewers to "Suggest Edit" on an inline comment and provide replacement text for the highlighted source.

Test Plan: Created, edited, reloaded, and submitted inline comments in various states with and without suggestion text.

Maniphest Tasks: T13513

Differential Revision: https://secure.phabricator.com/D21276

Author: epriestley

resources/celerity/map.php

@@ -12,8 +12,8 @@
     'core.pkg.css' => 'ba768cdb',
     'core.pkg.js' => '845355f4',
     'dark-console.pkg.js' => '187792c2',
-    'differential.pkg.css' => '42a2334f',
-    'differential.pkg.js' => 'd0ddfb19',
+    'differential.pkg.css' => 'f924dbcf',
+    'differential.pkg.js' => '256a327a',
     'diffusion.pkg.css' => '42c75c37',
     'diffusion.pkg.js' => 'a98c0bf7',
     'maniphest.pkg.css' => '35995d6d',
@@ -65,7 +65,7 @@
     'rsrc/css/application/differential/add-comment.css' => '7e5900d9',
     'rsrc/css/application/differential/changeset-view.css' => '60c3d405',
     'rsrc/css/application/differential/core.css' => '7300a73e',
-    'rsrc/css/application/differential/phui-inline-comment.css' => 'd5749acc',
+    'rsrc/css/application/differential/phui-inline-comment.css' => '4107254a',
     'rsrc/css/application/differential/revision-comment.css' => '7dbc8d1d',
     'rsrc/css/application/differential/revision-history.css' => '8aa3eac5',
     'rsrc/css/application/differential/revision-list.css' => '93d2df7d',
@@ -381,7 +381,7 @@
     'rsrc/js/application/dashboard/behavior-dashboard-tab-panel.js' => '0116d3e8',
     'rsrc/js/application/diff/DiffChangeset.js' => '6e5e03d2',
     'rsrc/js/application/diff/DiffChangesetList.js' => 'b51ba93a',
-    'rsrc/js/application/diff/DiffInline.js' => '6fa445ef',
+    'rsrc/js/application/diff/DiffInline.js' => '829b88bf',
     'rsrc/js/application/diff/DiffPathView.js' => '8207abf9',
     'rsrc/js/application/diff/DiffTreeView.js' => '5d83623b',
     'rsrc/js/application/differential/behavior-diff-radios.js' => '925fe8cd',
@@ -776,7 +776,7 @@
     'phabricator-dashboard-css' => '5a205b9d',
     'phabricator-diff-changeset' => '6e5e03d2',
     'phabricator-diff-changeset-list' => 'b51ba93a',
-    'phabricator-diff-inline' => '6fa445ef',
+    'phabricator-diff-inline' => '829b88bf',
     'phabricator-diff-path-view' => '8207abf9',
     'phabricator-diff-tree-view' => '5d83623b',
     'phabricator-drag-and-drop-file-upload' => '4370900d',
@@ -854,7 +854,7 @@
     'phui-icon-view-css' => '4cbc684a',
     'phui-image-mask-css' => '62c7f4d2',
     'phui-info-view-css' => 'a10a909b',
-    'phui-inline-comment-view-css' => 'd5749acc',
+    'phui-inline-comment-view-css' => '4107254a',
     'phui-invisible-character-view-css' => 'c694c4a4',
     'phui-left-right-css' => '68513c34',
     'phui-lightbox-css' => '4ebf22da',
@@ -1561,9 +1561,6 @@
       'phabricator-diff-path-view',
       'phuix-button-view',
     ),
-    '6fa445ef' => array(
-      'javelin-dom',
-    ),
     70245195 => array(
       'javelin-behavior',
       'javelin-stratcom',
@@ -1642,6 +1639,9 @@
     '8207abf9' => array(
       'javelin-dom',
     ),
+    '829b88bf' => array(
+      'javelin-dom',
+    ),
     83754533 => array(
       'javelin-install',
       'javelin-util',

src/__phutil_library_map__.php

@@ -3161,6 +3161,7 @@
     'PhabricatorDeveloperConfigOptions' => 'applications/config/option/PhabricatorDeveloperConfigOptions.php',
     'PhabricatorDeveloperPreferencesSettingsPanel' => 'applications/settings/panel/PhabricatorDeveloperPreferencesSettingsPanel.php',
     'PhabricatorDiffInlineCommentContentState' => 'infrastructure/diff/inline/PhabricatorDiffInlineCommentContentState.php',
+    'PhabricatorDiffInlineCommentContext' => 'infrastructure/diff/inline/PhabricatorDiffInlineCommentContext.php',
     'PhabricatorDiffInlineCommentQuery' => 'infrastructure/diff/query/PhabricatorDiffInlineCommentQuery.php',
     'PhabricatorDiffPreferencesSettingsPanel' => 'applications/settings/panel/PhabricatorDiffPreferencesSettingsPanel.php',
     'PhabricatorDiffScopeEngine' => 'infrastructure/diff/PhabricatorDiffScopeEngine.php',
@@ -3594,6 +3595,7 @@
     'PhabricatorInlineComment' => 'infrastructure/diff/interface/PhabricatorInlineComment.php',
     'PhabricatorInlineCommentAdjustmentEngine' => 'infrastructure/diff/engine/PhabricatorInlineCommentAdjustmentEngine.php',
     'PhabricatorInlineCommentContentState' => 'infrastructure/diff/inline/PhabricatorInlineCommentContentState.php',
+    'PhabricatorInlineCommentContext' => 'infrastructure/diff/inline/PhabricatorInlineCommentContext.php',
     'PhabricatorInlineCommentController' => 'infrastructure/diff/PhabricatorInlineCommentController.php',
     'PhabricatorInlineCommentInterface' => 'applications/transactions/interface/PhabricatorInlineCommentInterface.php',
     'PhabricatorInlineSummaryView' => 'infrastructure/diff/view/PhabricatorInlineSummaryView.php',
@@ -9630,6 +9632,7 @@
     'PhabricatorDeveloperConfigOptions' => 'PhabricatorApplicationConfigOptions',
     'PhabricatorDeveloperPreferencesSettingsPanel' => 'PhabricatorEditEngineSettingsPanel',
     'PhabricatorDiffInlineCommentContentState' => 'PhabricatorInlineCommentContentState',
+    'PhabricatorDiffInlineCommentContext' => 'PhabricatorInlineCommentContext',
     'PhabricatorDiffInlineCommentQuery' => 'PhabricatorApplicationTransactionCommentQuery',
     'PhabricatorDiffPreferencesSettingsPanel' => 'PhabricatorEditEngineSettingsPanel',
     'PhabricatorDiffScopeEngine' => 'Phobject',
@@ -10122,6 +10125,7 @@
     ),
     'PhabricatorInlineCommentAdjustmentEngine' => 'Phobject',
     'PhabricatorInlineCommentContentState' => 'Phobject',
+    'PhabricatorInlineCommentContext' => 'Phobject',
     'PhabricatorInlineCommentController' => 'PhabricatorController',
     'PhabricatorInlineSummaryView' => 'AphrontView',
     'PhabricatorInstructionsEditField' => 'PhabricatorEditField',

src/applications/audit/storage/PhabricatorAuditTransactionComment.php

@@ -17,6 +17,7 @@ final class PhabricatorAuditTransactionComment
   protected $attributes = array();
 
   private $replyToComment = self::ATTACHABLE;
+  private $inlineContext = self::ATTACHABLE;
 
   public function getApplicationTransactionObject() {
     return new PhabricatorAuditTransaction();
@@ -83,12 +84,18 @@ public function setAttribute($key, $value) {
     return $this;
   }
 
-  public function isEmptyInlineComment() {
-    return !strlen($this->getContent());
-  }
-
   public function newInlineCommentObject() {
     return PhabricatorAuditInlineComment::newFromModernComment($this);
   }
 
+  public function getInlineContext() {
+    return $this->assertAttached($this->inlineContext);
+  }
+
+  public function attachInlineContext(
+    PhabricatorInlineCommentContext $context = null) {
+    $this->inlineContext = $context;
+    return $this;
+  }
+
 }

src/applications/differential/controller/DifferentialChangesetViewController.php

@@ -200,6 +200,7 @@ public function handleRequest(AphrontRequest $request) {
         ->withPublishableComments(true)
         ->withPublishedComments(true)
         ->needHidden(true)
+        ->needInlineContext(true)
         ->execute();
 
       $inlines = mpull($inlines, 'newInlineCommentObject');

src/applications/differential/editor/DifferentialRevisionEditEngine.php

@@ -328,6 +328,13 @@ protected function newCommentPreviewContent($object, array $xactions) {
     $content = array();
 
     if ($inlines) {
+      // Reload inlines to get inline context.
+      $inlines = id(new DifferentialDiffInlineCommentQuery())
+        ->setViewer($viewer)
+        ->withIDs(mpull($inlines, 'getID'))
+        ->needInlineContext(true)
+        ->execute();
+
       $inline_preview = id(new PHUIDiffInlineCommentPreviewListView())
         ->setViewer($viewer)
         ->setInlineComments($inlines);

src/applications/differential/storage/DifferentialTransactionComment.php

@@ -18,6 +18,7 @@ final class DifferentialTransactionComment
   private $replyToComment = self::ATTACHABLE;
   private $isHidden = self::ATTACHABLE;
   private $changeset = self::ATTACHABLE;
+  private $inlineContext = self::ATTACHABLE;
 
   public function getApplicationTransactionObject() {
     return new DifferentialTransaction();
@@ -129,12 +130,18 @@ public function setAttribute($key, $value) {
     return $this;
   }
 
-  public function isEmptyInlineComment() {
-    return !strlen($this->getContent());
-  }
-
   public function newInlineCommentObject() {
     return DifferentialInlineComment::newFromModernComment($this);
   }
 
+  public function getInlineContext() {
+    return $this->assertAttached($this->inlineContext);
+  }
+
+  public function attachInlineContext(
+    PhabricatorInlineCommentContext $context = null) {
+    $this->inlineContext = $context;
+    return $this;
+  }
+
 }

src/applications/differential/view/DifferentialChangesetListView.php

@@ -373,6 +373,9 @@ public function render() {
 
         'Add new inline comment on selected source text.' =>
           pht('Add new inline comment on selected source text.'),
+
+        'Suggest Edit' => pht('Suggest Edit'),
+        'Discard Edit' => pht('Discard Edit'),
       ),
     ));
 

src/infrastructure/diff/PhabricatorInlineCommentController.php

@@ -240,7 +240,7 @@ public function processRequest() {
 
         $view = $this->buildScaffoldForView($edit_dialog);
 
-        return $this->newInlineResponse($inline, $view);
+        return $this->newInlineResponse($inline, $view, true);
       case 'cancel':
         $inline = $this->loadCommentByIDForEdit($this->getCommentID());
 
@@ -325,6 +325,9 @@ public function processRequest() {
 
         $this->saveComment($inline);
 
+        // Reload the inline to attach context.
+        $inline = $this->loadCommentByIDForEdit($inline->getID());
+
         $edit_dialog = $this->buildEditDialog($inline);
 
         if ($this->getOperation() == 'reply') {
@@ -335,7 +338,7 @@ public function processRequest() {
 
         $view = $this->buildScaffoldForView($edit_dialog);
 
-        return $this->newInlineResponse($inline, $view);
+        return $this->newInlineResponse($inline, $view, true);
     }
   }
 
@@ -431,7 +434,7 @@ private function buildRenderedCommentResponse(
 
     $view = $this->buildScaffoldForView($view);
 
-    return $this->newInlineResponse($inline, $view);
+    return $this->newInlineResponse($inline, $view, false);
   }
 
   private function buildScaffoldForView(PHUIDiffInlineCommentView $view) {
@@ -446,11 +449,29 @@ private function buildScaffoldForView(PHUIDiffInlineCommentView $view) {
 
   private function newInlineResponse(
     PhabricatorInlineComment $inline,
-    $view) {
+    $view,
+    $is_edit) {
+
+    if ($inline->getReplyToCommentPHID()) {
+      $can_suggest = false;
+    } else {
+      $can_suggest = (bool)$inline->getInlineContext();
+    }
+
+    if ($is_edit) {
+      $viewer = $this->getViewer();
+      $content_state = $inline->getContentStateForEdit($viewer);
+    } else {
+      $content_state = $inline->getContentState();
+    }
+
+    $state_map = $content_state->newStorageMap();
 
     $response = array(
       'inline' => array(
         'id' => $inline->getID(),
+        'contentState' => $state_map,
+        'canSuggestEdit' => $can_suggest,
       ),
       'view' => hsprintf('%s', $view),
     );
@@ -477,7 +498,8 @@ final protected function loadCommentByIDForEdit($id) {
     $viewer = $this->getViewer();
 
     $query = $this->newInlineCommentQuery()
-      ->withIDs(array($id));
+      ->withIDs(array($id))
+      ->needInlineContext(true);
 
     $inline = $this->loadCommentByQuery($query);
 

src/infrastructure/diff/inline/PhabricatorDiffInlineCommentContentState.php

@@ -12,7 +12,7 @@ public function isEmptyContentState() {
     }
 
     if ($this->getContentHasSuggestion()) {
-      if (strlen($this->getSuggestionText())) {
+      if (strlen($this->getContentSuggestionText())) {
         return false;
       }
     }

src/infrastructure/diff/inline/PhabricatorDiffInlineCommentContext.php

@@ -0,0 +1,37 @@
+<?php
+
+final class PhabricatorDiffInlineCommentContext
+  extends PhabricatorInlineCommentContext {
+
+  private $headLines;
+  private $bodyLines;
+  private $tailLines;
+
+  public function setHeadLines(array $head_lines) {
+    $this->headLines = $head_lines;
+    return $this;
+  }
+
+  public function getHeadLines() {
+    return $this->headLines;
+  }
+
+  public function setBodyLines(array $body_lines) {
+    $this->bodyLines = $body_lines;
+    return $this;
+  }
+
+  public function getBodyLines() {
+    return $this->bodyLines;
+  }
+
+  public function setTailLines(array $tail_lines) {
+    $this->tailLines = $tail_lines;
+    return $this;
+  }
+
+  public function getTailLines() {
+    return $this->tailLines;
+  }
+
+}

src/infrastructure/diff/inline/PhabricatorInlineCommentContext.php

@@ -0,0 +1,4 @@
+<?php
+
+abstract class PhabricatorInlineCommentContext
+  extends Phobject {}

src/infrastructure/diff/interface/PhabricatorInlineComment.php

@@ -350,6 +350,10 @@ public function setContentState(PhabricatorInlineCommentContentState $state) {
     return $this;
   }
 
+  public function getInlineContext() {
+    return $this->getStorageObject()->getInlineContext();
+  }
+
 
 /* -(  PhabricatorMarkupInterface Implementation  )-------------------------- */