Merge pull request #5375 from woocommerce/issue/5342-quick-order-customer-note-on-receipt

joshheald · web-flow · commit 8a454f297854 · 2021-11-09T11:40:06.000Z
Quick order customer note on receipts
diff --git a/Hardware/Hardware/Printer/AirPrintReceipt/ReceiptRenderer.swift b/Hardware/Hardware/Printer/AirPrintReceipt/ReceiptRenderer.swift
@@ -3,9 +3,7 @@ import UIKit
 /// Renders a receipt in an AirPrint enabled printer.
 ///
 public final class ReceiptRenderer: UIPrintPageRenderer {
-    private let lines: [ReceiptLineItem]
-    private let parameters: CardPresentReceiptParameters
-    private let cartTotals: [ReceiptTotalLine]
+    private let content: ReceiptContent
 
     private let dateFormatter: DateFormatter = {
         let formatter = DateFormatter()
@@ -17,9 +15,7 @@ public final class ReceiptRenderer: UIPrintPageRenderer {
     }()
 
     public init(content: ReceiptContent) {
-        self.lines = content.lineItems
-        self.parameters = content.parameters
-        self.cartTotals = content.cartTotals
+        self.content = content
 
         super.init()
 
@@ -49,7 +45,7 @@ public extension ReceiptRenderer {
                         background-color:#F5F5F5;
                         width:100%;
                         color: #707070;
-                        margin: \(Constants.margin / 2)pt 0 0 0;
+                        margin: \(Constants.margin / 2)pt 0;
                         padding: \(Constants.margin / 2)pt;
                     }
                     table td:last-child { width: 30%; text-align: right; }
@@ -77,19 +73,20 @@ public extension ReceiptRenderer {
                         <h1>\(receiptTitle)</h1>
                         <h3>\(Localization.amountPaidSectionTitle.uppercased())</h3>
                         <p>
-                            \(parameters.formattedAmount) \(parameters.currency.uppercased())
+                            \(content.parameters.formattedAmount) \(content.parameters.currency.uppercased())
                         </p>
                         <h3>\(Localization.datePaidSectionTitle.uppercased())</h3>
                         <p>
-                            \(dateFormatter.string(from: parameters.date))
+                            \(dateFormatter.string(from: content.parameters.date))
                         </p>
                         <h3>\(Localization.paymentMethodSectionTitle.uppercased())</h3>
                         <p>
-                            <span class="card-icon \(parameters.cardDetails.brand.iconName)-icon"></span> - \(parameters.cardDetails.last4)
+                            <span class="card-icon \(content.parameters.cardDetails.brand.iconName)-icon"></span> - \(content.parameters.cardDetails.last4)
                         </p>
                     </header>
                     <h3>\(summarySectionTitle.uppercased())</h3>
                     \(summaryTable())
+                    \(orderNoteSection())
                     <footer>
                         <p>
                             \(requiredItems())
@@ -112,8 +109,8 @@ private extension ReceiptRenderer {
 
     private func summaryTable() -> String {
         var summaryContent = "<table>"
-        for line in lines {
-            summaryContent += "<tr><td>\(line.title) × \(line.quantity)</td><td>\(line.amount) \(parameters.currency.uppercased())</td></tr>"
+        for line in content.lineItems {
+            summaryContent += "<tr><td>\(line.title) × \(line.quantity)</td><td>\(line.amount) \(content.parameters.currency.uppercased())</td></tr>"
         }
         summaryContent += totalRows()
         summaryContent += "</table>"
@@ -123,7 +120,7 @@ private extension ReceiptRenderer {
 
     private func totalRows() -> String {
         var rows = ""
-        for total in cartTotals {
+        for total in content.cartTotals {
             rows += summaryRow(title: total.description, amount: total.amount)
         }
         return rows
@@ -136,14 +133,24 @@ private extension ReceiptRenderer {
                     \(title)
                 </td>
                 <td>
-                    \(amount) \(parameters.currency.uppercased())
+                    \(amount) \(content.parameters.currency.uppercased())
                 </td>
             </tr>
         """
     }
 
+    private func orderNoteSection() -> String {
+        guard let orderNote = content.orderNote else {
+            return ""
+        }
+        return """
+        <h3>\(Localization.orderNoteSectionTitle.uppercased())</h3>
+        <p>\(orderNote)</p>
+        """
+    }
+
     private func requiredItems() -> String {
-        guard let emv = parameters.cardDetails.receipt else {
+        guard let emv = content.parameters.cardDetails.receipt else {
             return "<br/>"
         }
 
@@ -163,15 +170,15 @@ private extension ReceiptRenderer {
     }
 
     private var receiptTitle: String {
-        guard let storeName = parameters.storeName else {
+        guard let storeName = content.parameters.storeName else {
             return Localization.receiptTitle
         }
 
         return .localizedStringWithFormat(Localization.receiptFromFormat, storeName)
     }
 
     private var summarySectionTitle: String {
-        guard let orderID = parameters.orderID else {
+        guard let orderID = content.parameters.orderID else {
             return Localization.summarySectionTitle
         }
         return String(format: Localization.summarySectionTitleWithOrderFormat, String(orderID))
@@ -218,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"
diff --git a/Hardware/Hardware/Printer/ReceiptContent.swift b/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"
     }
 }
 
diff --git a/Yosemite/Yosemite/Stores/ReceiptStore.swift b/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] {
diff --git a/Yosemite/YosemiteTests/Stores/ReceiptStoreTests.swift b/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,

Original file line number	Diff line number	Diff line change
`@@ -4,11 +4,16 @@ public struct ReceiptContent: Codable {`
`4`	`4`	`public let lineItems: [ReceiptLineItem]`
`5`	`5`	`public let parameters: CardPresentReceiptParameters`
`6`	`6`	`public let cartTotals: [ReceiptTotalLine]`
	`7`	`+ public let orderNote: String?`
`7`	`8`
`8`		`- public init(parameters: CardPresentReceiptParameters, lineItems: [ReceiptLineItem], cartTotals: [ReceiptTotalLine]) {`
	`9`	`+ public init(parameters: CardPresentReceiptParameters,`
	`10`	`+ lineItems: [ReceiptLineItem],`
	`11`	`+ cartTotals: [ReceiptTotalLine],`
	`12`	`+ orderNote: String?) {`
`9`	`13`	`self.lineItems = lineItems`
`10`	`14`	`self.parameters = parameters`
`11`	`15`	`self.cartTotals = cartTotals`
	`16`	`+ self.orderNote = orderNote`
`12`	`17`	`}`
`13`	`18`	`}`
`14`	`19`
`@@ -17,6 +22,7 @@ extension ReceiptContent {`
`17`	`22`	`case lineItems = "line_items"`
`18`	`23`	`case parameters = "parameters"`
`19`	`24`	`case cartTotals = "cart_totals"`
	`25`	`+ case orderNote = "order_note"`
`20`	`26`	`}`
`21`	`27`	`}`
`22`	`28`