Bug 2044749 - Expose code suggestions in feed.for_email.query inline comments

Add hasSuggestion and suggestionText fields to EmailInlineComment,
populated from the inline comment content state. Also adds unit tests
for the new fields.

Author: padenot

moz-extensions/src/__phutil_library_map__.php

@@ -35,6 +35,7 @@
     'EmailEndpointResponseData' => 'email/model/EmailEndpointResponseData.php',
     'EmailEvent' => 'email/model/EmailEvent.php',
     'EmailInlineComment' => 'email/model/EmailInlineComment.php',
+    'EmailInlineCommentTestCase' => 'email/model/__tests__/EmailInlineCommentTestCase.php',
     'EmailMetadataEditedReviewer' => 'email/model/EmailMetadataEditedReviewer.php',
     'EmailRecipient' => 'email/model/EmailRecipient.php',
     'EmailReplyContext' => 'email/model/EmailReplyContext.php',
@@ -137,6 +138,7 @@
     'DifferentialBugzillaBugIDCommitMessageField' => 'DifferentialCommitMessageCustomField',
     'DifferentialBugzillaBugIDCustomFieldTestCase' => 'PhabricatorTestCase',
     'DifferentialUpliftRequestCustomFieldTestCase' => 'PhabricatorTestCase',
+    'EmailInlineCommentTestCase' => 'PhabricatorTestCase',
     'DifferentialBugzillaBugIDField' => 'DifferentialStoredCustomField',
     'DifferentialBugzillaBugIDValidator' => 'Phobject',
     'DifferentialUpliftRequestCustomField' => 'DifferentialStoredCustomField',

moz-extensions/src/email/model/EmailInlineComment.php

@@ -9,12 +9,16 @@ class EmailInlineComment {
   public string $contextKind;
   /** @var EmailReplyContext|EmailCodeContext */
   public $context;
+  public bool $hasSuggestion;
+  public string $suggestionText;
 
-  public function __construct(string $fileContext, string $link, EmailCommentMessage $message, string $contextKind, $context) {
+  public function __construct(string $fileContext, string $link, EmailCommentMessage $message, string $contextKind, $context, bool $hasSuggestion = false, string $suggestionText = '') {
     $this->fileContext = $fileContext;
     $this->link = $link;
     $this->message = $message;
     $this->contextKind = $contextKind;
     $this->context = $context;
+    $this->hasSuggestion = $hasSuggestion;
+    $this->suggestionText = $suggestionText;
   }
-}
+}

moz-extensions/src/email/model/__tests__/EmailInlineCommentTestCase.php

@@ -0,0 +1,72 @@
+<?php
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+final class EmailInlineCommentTestCase extends PhabricatorTestCase {
+
+  private function newMessage(): EmailCommentMessage {
+    return new EmailCommentMessage('text', '<p>text</p>');
+  }
+
+  private function newCodeContext(): EmailCodeContext {
+    return new EmailCodeContext([]);
+  }
+
+  public function testDefaultsToNoSuggestion() {
+    $comment = new EmailInlineComment(
+      '/src/foo.php:10',
+      'https://example.com/D1',
+      $this->newMessage(),
+      'code',
+      $this->newCodeContext()
+    );
+
+    $this->assertFalse($comment->hasSuggestion);
+    $this->assertEqual('', $comment->suggestionText);
+  }
+
+  public function testStoresSuggestion() {
+    $comment = new EmailInlineComment(
+      '/src/foo.php:10',
+      'https://example.com/D1',
+      $this->newMessage(),
+      'code',
+      $this->newCodeContext(),
+      true,
+      'return $x + 1;'
+    );
+
+    $this->assertTrue($comment->hasSuggestion);
+    $this->assertEqual('return $x + 1;', $comment->suggestionText);
+  }
+
+  public function testNoSuggestionWithExplicitFalse() {
+    $comment = new EmailInlineComment(
+      '/src/foo.php:10',
+      'https://example.com/D1',
+      $this->newMessage(),
+      'code',
+      $this->newCodeContext(),
+      false,
+      ''
+    );
+
+    $this->assertFalse($comment->hasSuggestion);
+    $this->assertEqual('', $comment->suggestionText);
+  }
+
+  public function testFileContextAndLinkStored() {
+    $comment = new EmailInlineComment(
+      '/src/bar.php:42',
+      'https://example.com/D2#inline-99',
+      $this->newMessage(),
+      'reply',
+      $this->newCodeContext()
+    );
+
+    $this->assertEqual('/src/bar.php:42', $comment->fileContext);
+    $this->assertEqual('https://example.com/D2#inline-99', $comment->link);
+    $this->assertEqual('reply', $comment->contextKind);
+  }
+}

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

@@ -143,10 +143,14 @@ private function resolveInlineComments(PublicEventPings $pings): array {
         $context = new EmailCodeContext($diffLines);
       }
 
+      $contentState = $comment->newInlineCommentObject()->getContentState();
+      $hasSuggestion = $contentState->getContentHasSuggestion();
+      $suggestionText = $contentState->getContentSuggestionText();
+
       $commentLineNumber = $comment->getLineNumber();
       $rawMessage = $rawTransaction->getComment()->getContent();
       $message = self::renderCommentMarkup($rawMessage);
-      $inlineComment = new EmailInlineComment("$filename:$commentLineNumber", $link, $message, $contextKind, $context);
+      $inlineComment = new EmailInlineComment("$filename:$commentLineNumber", $link, $message, $contextKind, $context, $hasSuggestion, $suggestionText);
       foreach (self::findPingedUsers($rawMessage) as $user) {
         $pings->fromInlineComment($user, $inlineComment);
       }