Ensure that invoice comments are returned when requested by GraphQL queries

Author: aligent-lturner

app/code/Magento/SalesGraphQl/Model/Resolver/Invoices.php

@@ -41,10 +41,31 @@ public function resolve(
             $invoices[] = [
                 'id' => base64_encode($invoice->getEntityId()),
                 'number' => $invoice['increment_id'],
+                'comments' => $this->getInvoiceComments($invoice),
                 'model' => $invoice,
                 'order' => $orderModel
             ];
         }
         return $invoices;
     }
+
+    /**
+     * Get invoice comments in proper format
+     *
+     * @param InvoiceInterface $invoice
+     * @return array
+     */
+    private function getInvoiceComments(InvoiceInterface $invoice): array
+    {
+        $comments = [];
+        foreach ($invoice->getComments() as $comment) {
+            if ($comment->getIsVisibleOnFront()) {
+                $comments[] = [
+                    'timestamp' => $comment->getCreatedAt(),
+                    'message' => $comment->getComment()
+                ];
+            }
+        }
+        return $comments;
+    }
 }

dev/tests/api-functional/testsuite/Magento/GraphQl/Sales/InvoiceTest.php

@@ -410,6 +410,44 @@ public function testPartialInvoiceForCustomerWithTaxesAndDiscounts()
         $this->deleteOrder();
     }
 
+    /**
+     * @magentoApiDataFixture Magento/Sales/_files/customer_invoice_comments_for_search.php
+     */
+    public function testInvoiceCommentsQuery()
+    {
+        $query =
+            <<<QUERY
+{
+  customer {
+    orders {
+      items {
+        invoices {
+          comments {
+            message
+            timestamp
+          }
+        }
+      }
+    }
+  }
+}
+QUERY;
+
+        $currentEmail = '[email protected]';
+        $currentPassword = 'password';
+        $response = $this->graphQlQuery(
+            $query,
+            [],
+            '',
+            $this->customerAuthenticationHeader->execute($currentEmail, $currentPassword)
+        );
+
+        $invoice = $response['customer']['orders']['items'][0]['invoices'][0];
+        $this->assertCount(1, $invoice['comments']);
+        $this->assertEquals('visible_comment', $invoice['comments'][0]['message']);
+        $this->assertNotEmpty($invoice['comments'][0]['timestamp']);
+    }
+
     /**
      * Prepare invoice for the order
      *

dev/tests/integration/testsuite/Magento/Sales/_files/customer_invoice_comments_for_search.php

@@ -0,0 +1,49 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+use Magento\Sales\Api\InvoiceCommentRepositoryInterface;
+use Magento\Sales\Api\Data\OrderInterfaceFactory;
+use Magento\Sales\Model\Order;
+use Magento\Sales\Model\Order\Invoice;
+use Magento\Sales\Model\Order\Invoice\Comment;
+use Magento\Sales\Model\ResourceModel\Order\Invoice\Comment as CommentResource;
+use Magento\TestFramework\Helper\Bootstrap;
+use Magento\TestFramework\Workaround\Override\Fixture\Resolver;
+
+Resolver::getInstance()->requireDataFixture(
+    'Magento/Sales/_files/customers_with_invoices.php'
+);
+
+$objectManager = Bootstrap::getObjectManager();
+
+/** @var Order $order */
+$order = $objectManager->get(OrderInterfaceFactory::class)->create()->loadByIncrementId('100000001');
+/** @var Invoice $invoice */
+$invoice = $order->getInvoiceCollection()->getFirstItem();
+
+$comments = [
+    [
+        'comment' => 'visible_comment',
+        'is_visible_on_front' => 1
+    ],
+    [
+        'comment' => 'non_visible_comment',
+        'is_visible_on_front' => 0,
+    ],
+];
+
+/** @var CommentResource $commentResource */
+$commentResource = $objectManager->get(CommentResource::class);
+
+foreach ($comments as $data) {
+    /** @var Comment $comment */
+    $comment = $objectManager->create(Comment::class);
+    $comment->setParentId($invoice->getId());
+    $comment->setComment($data['comment']);
+    $comment->setIsVisibleOnFront($data['is_visible_on_front']);
+    $comment->setIsCustomerNotified(false);
+    $commentResource->save($comment);
+}

dev/tests/integration/testsuite/Magento/Sales/_files/customer_invoice_comments_for_search_rollback.php

@@ -0,0 +1,9 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+use Magento\TestFramework\Workaround\Override\Fixture\Resolver;
+
+Resolver::getInstance()->requireDataFixture('Magento/Sales/_files/customers_with_invoices_rollback.php');