5342 Include customerNote in receipts

Quick Orders do not include any information about what was sold, so adding the order notes to the receipt will enable the merchant to provide some context for what was sold.

Author: joshheald

Hardware/Hardware/Printer/AirPrintReceipt/ReceiptRenderer.swift

@@ -86,6 +86,7 @@ public extension ReceiptRenderer {
                     </header>
                     <h3>\(summarySectionTitle.uppercased())</h3>
                     \(summaryTable())
+                    \(orderNoteSection())
                     <footer>
                         <p>
                             \(requiredItems())
@@ -138,6 +139,16 @@ private extension ReceiptRenderer {
         """
     }
 
+    private func orderNoteSection() -> String {
+        guard let orderNote = content.orderNote else {
+            return ""
+        }
+        return """
+        <h3>\(Localization.orderNoteSectionTitle.uppercased())</h3>
+        <p>\(orderNote)
+        """
+    }
+
     private func requiredItems() -> String {
         guard let emv = content.parameters.cardDetails.receipt else {
             return "<br/>"
@@ -214,6 +225,10 @@ private extension ReceiptRenderer {
             comment: "Title of 'Summary' section in the receipt when the order number is unknown"
         )
 
+        static let orderNoteSectionTitle = NSLocalizedString(
+            "Notes",
+            comment: "Title of order note section in the receipt, commonly used for Quick Orders.")
+
         static let summarySectionTitleWithOrderFormat = NSLocalizedString(
             "Summary: Order #%1$@",
             comment: "Title of 'Summary' section in the receipt. %1$@ is the order number, e.g. 4920"

Hardware/Hardware/Printer/ReceiptContent.swift

@@ -4,11 +4,16 @@ public struct ReceiptContent: Codable {
     public let lineItems: [ReceiptLineItem]
     public let parameters: CardPresentReceiptParameters
     public let cartTotals: [ReceiptTotalLine]
+    public let orderNote: String?
 
-    public init(parameters: CardPresentReceiptParameters, lineItems: [ReceiptLineItem], cartTotals: [ReceiptTotalLine]) {
+    public init(parameters: CardPresentReceiptParameters,
+                lineItems: [ReceiptLineItem],
+                cartTotals: [ReceiptTotalLine],
+                orderNote: String?) {
         self.lineItems = lineItems
         self.parameters = parameters
         self.cartTotals = cartTotals
+        self.orderNote = orderNote
     }
 }
 
@@ -17,6 +22,7 @@ extension ReceiptContent {
         case lineItems = "line_items"
         case parameters = "parameters"
         case cartTotals = "cart_totals"
+        case orderNote = "order_note"
     }
 }
 

Yosemite/Yosemite/Stores/ReceiptStore.swift

@@ -59,7 +59,7 @@ public class ReceiptStore: Store {
 
 private extension ReceiptStore {
     func print(order: Order, parameters: CardPresentReceiptParameters, completion: @escaping (PrintingResult) -> Void) {
-        let content = generateReceiptContent(order: order, parameters: parameters)
+        let content = generateReceiptContent(order: order, parameters: parameters, removingHtml: true)
         receiptPrinterService.printReceipt(content: content, completion: completion)
     }
 
@@ -69,11 +69,27 @@ private extension ReceiptStore {
         onContent(renderer.htmlContent())
     }
 
-    func generateReceiptContent(order: Order, parameters: CardPresentReceiptParameters) -> ReceiptContent {
+    func generateReceiptContent(order: Order, parameters: CardPresentReceiptParameters, removingHtml: Bool = false) -> ReceiptContent {
         let lineItems = generateLineItems(order: order)
         let cartTotals = generateCartTotals(order: order, parameters: parameters)
+        let note = receiptOrderNote(order: order, removingHtml: removingHtml)
+
+        return ReceiptContent(parameters: parameters,
+                              lineItems: lineItems,
+                              cartTotals: cartTotals,
+                              orderNote: note)
+    }
 
-        return ReceiptContent(parameters: parameters, lineItems: lineItems, cartTotals: cartTotals)
+    private func receiptOrderNote(order: Order, removingHtml: Bool) -> String? {
+        guard let orderNote = order.customerNote else {
+            return nil
+        }
+        if removingHtml {
+            // TODO: move this logic to the WooCommerce target, and then use String.removedHTMLTags extension function
+            return orderNote.replacingOccurrences(of: "<[^>]+>", with: "", options: .regularExpression, range: nil)
+        } else {
+            return orderNote
+        }
     }
 
     func generateLineItems(order: Order) -> [ReceiptLineItem] {

Yosemite/YosemiteTests/Stores/ReceiptStoreTests.swift

@@ -352,11 +352,54 @@ final class ReceiptStoreTests: XCTestCase {
         }
         XCTAssertEqual("30.00", lineItemsTotalLine?.amount)
     }
+
+    func test_generateContent_callsGenerate_passingUnmodified_customerNote() throws {
+        let mockParameters = try XCTUnwrap(MockPaymentIntent.mock().receiptParameters())
+        let expectedNote = "<a href=\"https://example.com\">This note has a link</a>"
+        let mockOrder = makeOrder(customerNote: expectedNote)
+        let expectation = expectation(description: #function)
+
+        let receiptStore = ReceiptStore(dispatcher: dispatcher,
+                                        storageManager: storageManager,
+                                        network: network,
+                                        receiptPrinterService: receiptPrinterService,
+                                        fileStorage: MockInMemoryStorage())
+
+        let action = ReceiptAction.generateContent(
+            order: mockOrder,
+            parameters: mockParameters,
+            onContent: { content in
+                XCTAssert(content.contains(expectedNote))
+                expectation.fulfill()
+        })
+
+        receiptStore.onAction(action)
+
+        wait(for: [expectation], timeout: Constants.expectationTimeout)
+    }
+
+    func test_print_callsPrint_passingHTMLStripped_customerNote() throws {
+        let mockParameters = try XCTUnwrap(MockPaymentIntent.mock().receiptParameters())
+        let mockOrder = makeOrder(customerNote: "<a href=\"https://example.com\">This note has a link</a>")
+
+        let receiptStore = ReceiptStore(dispatcher: dispatcher,
+                                        storageManager: storageManager,
+                                        network: network,
+                                        receiptPrinterService: receiptPrinterService,
+                                        fileStorage: MockInMemoryStorage())
+
+        let action = ReceiptAction.print(order: mockOrder, parameters: mockParameters, completion: { _ in })
+
+        receiptStore.onAction(action)
+
+        XCTAssertEqual(receiptPrinterService.contentProvided?.orderNote, "This note has a link")
+    }
 }
 
 
 private extension ReceiptStoreTests {
-    func makeOrder(discountTotal: String = "",
+    func makeOrder(customerNote: String? = nil,
+                   discountTotal: String = "",
                    discountTax: String = "",
                    shippingTotal: String = "",
                    shippingTax: String = "",
@@ -371,7 +414,7 @@ private extension ReceiptStoreTests {
               number: "",
               status: .custom(""),
               currency: "usd",
-              customerNote: nil,
+              customerNote: customerNote,
               dateCreated: Date(),
               dateModified: Date(),
               datePaid: nil,