Merge branch 'develop' into issue/5369-install-jetpack-row-in-settings

Author: Sharma Elanthiriayan

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,5 +1,19 @@
+<!-- Remember about a good descriptive title. -->
 
+Closes: #
+<!-- Id number of the GitHub issue this PR addresses. -->
 
+### Description
+<!-- Take the time to write a good summary. Why is it needed? What does it do? When fixing bugs try to avoid just writing “See original issue” – clarify what the problem was and how you’ve fixed it. -->
 
-Update release notes:
+### Testing instructions
+<!-- Step by step testing instructions. When necessary break out individual scenarios that need testing, consider including a checklist for the reviewer to go through. -->
+
+### Screenshots
+<!-- Include before and after images or gifs when appropriate. -->
+
+
+---
 - [ ] I have considered if this change warrants user-facing release notes and have added them to `RELEASE-NOTES.txt` if necessary.
+
+<!-- Pull request guidelines: https://github.com/woocommerce/woocommerce-android/blob/develop/docs/pull-request-guidelines.md -->

Hardware/Hardware/CardReader/CardReaderConfigProvider.swift

@@ -3,14 +3,14 @@
 /// It is meant to abstract an implementation of the [adapter pattern](https://en.wikipedia.org/wiki/Adapter_pattern)
 
 public protocol ReaderTokenProvider {
-    func fetchToken(completion: @escaping(String?, Error?) -> Void)
+    func fetchToken(completion: @escaping(Result<String, Error>) -> Void)
 }
 
 public protocol ReaderLocationProvider {
-    func fetchDefaultLocationID(completion: @escaping(String?, Error?) -> Void)
+    func fetchDefaultLocationID(completion: @escaping(Result<String, Error>) -> Void)
 }
 
-public protocol CardReaderConfigProvider: ReaderLocationProvider {
-    func fetchToken(completion: @escaping(String?, Error?) -> Void)
-    func fetchDefaultLocationID(completion: @escaping(String?, Error?) -> Void)
+public protocol CardReaderConfigProvider: ReaderLocationProvider, ReaderTokenProvider {
+    func fetchToken(completion: @escaping(Result<String, Error>) -> Void)
+    func fetchDefaultLocationID(completion: @escaping(Result<String, Error>) -> Void)
 }

Hardware/Hardware/CardReader/CardReaderService.swift

@@ -10,15 +10,6 @@ public protocol CardReaderService {
     /// The Publisher that emits the connected readers
     var connectedReaders: AnyPublisher<[CardReader], Never> { get }
 
-    /// The Publisher that emits the service status
-    var serviceStatus: AnyPublisher<CardReaderServiceStatus, Never> { get }
-
-    /// The Publisher that emits the service discovery status
-    var discoveryStatus: AnyPublisher<CardReaderServiceDiscoveryStatus, Never> { get }
-
-    /// The Publisher that emits the payment status
-    var paymentStatus: AnyPublisher<PaymentStatus, Never> { get }
-
     /// The Publisher that emits reader events
     var readerEvents: AnyPublisher<CardReaderEvent, Never> { get }
 

Hardware/Hardware/CardReader/StripeCardReader/DefaultConnectionTokenProvider.swift

@@ -4,13 +4,20 @@ import StripeTerminal
 /// uses the networking adapter provided by clients of Hardware
 /// to fetch a connection token
 final class DefaultConnectionTokenProvider: ConnectionTokenProvider {
-    private let provider: CardReaderConfigProvider
+    private let provider: ReaderTokenProvider
 
-    init(provider: CardReaderConfigProvider) {
+    init(provider: ReaderTokenProvider) {
         self.provider = provider
     }
 
     public func fetchConnectionToken(_ completion: @escaping ConnectionTokenCompletionBlock) {
-        provider.fetchToken(completion: completion)
+        provider.fetchToken() { result in
+            switch result {
+            case .success(let token):
+                completion(token, nil)
+            case .failure(let error):
+                completion(nil, error)
+            }
+        }
     }
 }

Hardware/Hardware/CardReader/StripeCardReader/StripeCardReaderService.swift

@@ -10,9 +10,7 @@ public final class StripeCardReaderService: NSObject {
 
     private var discoveredReadersSubject = CurrentValueSubject<[CardReader], Error>([])
     private let connectedReadersSubject = CurrentValueSubject<[CardReader], Never>([])
-    private let serviceStatusSubject = CurrentValueSubject<CardReaderServiceStatus, Never>(.ready)
     private let discoveryStatusSubject = CurrentValueSubject<CardReaderServiceDiscoveryStatus, Never>(.idle)
-    private let paymentStatusSubject = CurrentValueSubject<PaymentStatus, Never>(.notReady)
     private let readerEventsSubject = PassthroughSubject<CardReaderEvent, Never>()
     private let softwareUpdateSubject = CurrentValueSubject<CardReaderSoftwareUpdateState, Never>(.none)
 
@@ -46,19 +44,6 @@ extension StripeCardReaderService: CardReaderService {
         connectedReadersSubject.eraseToAnyPublisher()
     }
 
-    public var serviceStatus: AnyPublisher<CardReaderServiceStatus, Never> {
-        serviceStatusSubject.eraseToAnyPublisher()
-    }
-
-    public var discoveryStatus: AnyPublisher<CardReaderServiceDiscoveryStatus, Never> {
-        discoveryStatusSubject.removeDuplicates().eraseToAnyPublisher()
-    }
-
-    /// The Publisher that emits the payment status
-    public var paymentStatus: AnyPublisher<PaymentStatus, Never> {
-        paymentStatusSubject.eraseToAnyPublisher()
-    }
-
     /// The Publisher that emits reader events
     public var readerEvents: AnyPublisher<CardReaderEvent, Never> {
         readerEventsSubject.eraseToAnyPublisher()
@@ -291,17 +276,14 @@ extension StripeCardReaderService: CardReaderService {
 
             // TODO - If we've recently connected to this reader, use the cached locationId from the
             // Terminal SDK instead of making this fetch. See #5116 and #5087
-            self.readerLocationProvider?.fetchDefaultLocationID { (locationId, error) in
-                if let error = error {
+            self.readerLocationProvider?.fetchDefaultLocationID { result in
+                switch result {
+                case .success(let locationId):
+                    return promise(.success(BluetoothConnectionConfiguration(locationId: locationId)))
+                case .failure(let error):
                     let underlyingError = UnderlyingError(with: error)
                     return promise(.failure(CardReaderServiceError.connection(underlyingError: underlyingError)))
                 }
-
-                if let locationId = locationId {
-                    return promise(.success(BluetoothConnectionConfiguration(locationId: locationId)))
-                }
-
-                promise(.failure(CardReaderServiceError.connection()))
             }
         }
     }
@@ -408,12 +390,12 @@ private extension StripeCardReaderService {
                     /// https://stripe.dev/stripe-terminal-ios/docs/Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectPaymentMethod:delegate:completion:
 
                     if underlyingError != .commandCancelled {
-                        print("==== collect payment method was not cancelled. this is an actual error ", underlyingError)
+                        DDLogError("💳 Error: collect payment method \(underlyingError)")
                         promise(.failure(CardReaderServiceError.paymentMethodCollection(underlyingError: underlyingError)))
                     }
 
                     if underlyingError == .commandCancelled {
-                        print("==== collect payment method cancelled. this is an error we ignore ", error)
+                        DDLogWarn("💳 Warning: collect payment error cancelled. We actively ignore this error \(error)")
                     }
 
                 }
@@ -488,12 +470,10 @@ extension StripeCardReaderService: BluetoothReaderDelegate {
     }
 
     public func reader(_ reader: Reader, didStartInstallingUpdate update: ReaderSoftwareUpdate, cancelable: StripeTerminal.Cancelable?) {
-        print("==== started software update")
         softwareUpdateSubject.send(.started(cancelable: cancelable.map(StripeCancelable.init(cancelable:))))
     }
 
     public func reader(_ reader: Reader, didReportReaderSoftwareUpdateProgress progress: Float) {
-        print("==== did repost software update progress ", progress)
         softwareUpdateSubject.send(.installing(progress: progress))
     }
 

Hardware/HardwareTests/AirPrintReceipt/ReceiptRendererTest.swift

@@ -24,8 +24,6 @@ final class ReceiptRendererTest: XCTestCase {
 
         let renderer = ReceiptRenderer(content: content)
 
-        print(renderer.htmlContent())
-
         XCTAssertEqual(
             Insecure.MD5.hash(data: renderer.htmlContent().data(using: .utf8)!).description,
             expectedResultWithHtmlSymbolsMd5Description

Networking/Networking.xcodeproj/project.pbxproj

@@ -47,11 +47,15 @@
 		029BA4F0255D7282006171FD /* ShippingLabelRemote.swift in Sources */ = {isa = PBXBuildFile; fileRef = 029BA4EF255D7282006171FD /* ShippingLabelRemote.swift */; };
 		029BA4F4255D72EC006171FD /* ShippingLabelPrintData.swift in Sources */ = {isa = PBXBuildFile; fileRef = 029BA4F3255D72EC006171FD /* ShippingLabelPrintData.swift */; };
 		029BA53B255DFABD006171FD /* ShippingLabelPrintDataMapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = 029BA53A255DFABD006171FD /* ShippingLabelPrintDataMapper.swift */; };
+		02A26F1B2744F5FC008E4EDB /* wc-site-settings-partial.json in Resources */ = {isa = PBXBuildFile; fileRef = 02A26F192744F5FC008E4EDB /* wc-site-settings-partial.json */; };
+		02A26F1C2744F5FC008E4EDB /* wp-site-settings.json in Resources */ = {isa = PBXBuildFile; fileRef = 02A26F1A2744F5FC008E4EDB /* wp-site-settings.json */; };
 		02AAD53F250092A400BA1E26 /* product-add-or-delete.json in Resources */ = {isa = PBXBuildFile; fileRef = 02AAD53E250092A300BA1E26 /* product-add-or-delete.json */; };
 		02BA23C922EEF62C009539E7 /* order-stats-v4-wcadmin-deactivated.json in Resources */ = {isa = PBXBuildFile; fileRef = 02BA23C722EEF62C009539E7 /* order-stats-v4-wcadmin-deactivated.json */; };
 		02BA23CA22EEF62C009539E7 /* order-stats-v4-wcadmin-activated.json in Resources */ = {isa = PBXBuildFile; fileRef = 02BA23C822EEF62C009539E7 /* order-stats-v4-wcadmin-activated.json */; };
 		02BDB83523EA98C800BCC63E /* String+HTML.swift in Sources */ = {isa = PBXBuildFile; fileRef = 02BDB83423EA98C800BCC63E /* String+HTML.swift */; };
 		02BDB83723EA9C4D00BCC63E /* String+HTMLTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 02BDB83623EA9C4D00BCC63E /* String+HTMLTests.swift */; };
+		02C11276274285FF00F4F0B4 /* WooCommerceAvailabilityMapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = 02C11275274285FF00F4F0B4 /* WooCommerceAvailabilityMapper.swift */; };
+		02C112782742862600F4F0B4 /* WordPressSiteSettingsMapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = 02C112772742862600F4F0B4 /* WordPressSiteSettingsMapper.swift */; };
 		02C1CEF424C6A02B00703EBA /* ProductVariationMapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = 02C1CEF324C6A02B00703EBA /* ProductVariationMapper.swift */; };
 		02C2548425635BD000A04423 /* ShippingLabelPaperSize.swift in Sources */ = {isa = PBXBuildFile; fileRef = 02C2548325635BD000A04423 /* ShippingLabelPaperSize.swift */; };
 		02C2549A25636E1500A04423 /* ShippingLabelAddress.swift in Sources */ = {isa = PBXBuildFile; fileRef = 02C2549925636E1500A04423 /* ShippingLabelAddress.swift */; };
@@ -625,11 +629,15 @@
 		029BA4EF255D7282006171FD /* ShippingLabelRemote.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ShippingLabelRemote.swift; sourceTree = "<group>"; };
 		029BA4F3255D72EC006171FD /* ShippingLabelPrintData.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ShippingLabelPrintData.swift; sourceTree = "<group>"; };
 		029BA53A255DFABD006171FD /* ShippingLabelPrintDataMapper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ShippingLabelPrintDataMapper.swift; sourceTree = "<group>"; };
+		02A26F192744F5FC008E4EDB /* wc-site-settings-partial.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "wc-site-settings-partial.json"; sourceTree = "<group>"; };
+		02A26F1A2744F5FC008E4EDB /* wp-site-settings.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "wp-site-settings.json"; sourceTree = "<group>"; };
 		02AAD53E250092A300BA1E26 /* product-add-or-delete.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "product-add-or-delete.json"; sourceTree = "<group>"; };
 		02BA23C722EEF62C009539E7 /* order-stats-v4-wcadmin-deactivated.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "order-stats-v4-wcadmin-deactivated.json"; sourceTree = "<group>"; };
 		02BA23C822EEF62C009539E7 /* order-stats-v4-wcadmin-activated.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "order-stats-v4-wcadmin-activated.json"; sourceTree = "<group>"; };
 		02BDB83423EA98C800BCC63E /* String+HTML.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "String+HTML.swift"; sourceTree = "<group>"; };
 		02BDB83623EA9C4D00BCC63E /* String+HTMLTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "String+HTMLTests.swift"; sourceTree = "<group>"; };
+		02C11275274285FF00F4F0B4 /* WooCommerceAvailabilityMapper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WooCommerceAvailabilityMapper.swift; sourceTree = "<group>"; };
+		02C112772742862600F4F0B4 /* WordPressSiteSettingsMapper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WordPressSiteSettingsMapper.swift; sourceTree = "<group>"; };
 		02C1CEF324C6A02B00703EBA /* ProductVariationMapper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ProductVariationMapper.swift; sourceTree = "<group>"; };
 		02C2548325635BD000A04423 /* ShippingLabelPaperSize.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ShippingLabelPaperSize.swift; sourceTree = "<group>"; };
 		02C2549925636E1500A04423 /* ShippingLabelAddress.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ShippingLabelAddress.swift; sourceTree = "<group>"; };
@@ -1496,7 +1504,6 @@
 				029BA4EF255D7282006171FD /* ShippingLabelRemote.swift */,
 				D8EDFE1D25EE87F1003D2213 /* WCPayRemote.swift */,
 				FE28F6E5268429B6004465C7 /* UserRemote.swift */,
-				077F39D526A58E4500ABEADC /* SystemPluginsRemote.swift */,
 				077F39D526A58E4500ABEADC /* SystemStatusRemote.swift */,
 				AEF94584272974F2001DCCFB /* TelemetryRemote.swift */,
 			);
@@ -1737,6 +1744,7 @@
 				74ABA1C7213F19FE00FFAD30 /* top-performers-year.json */,
 				FE28F6E726842D57004465C7 /* user-complete.json */,
 				7495AACE225D366D00801A89 /* variation-as-product.json */,
+				02A26F192744F5FC008E4EDB /* wc-site-settings-partial.json */,
 				D800DA0D25EFEC21001E13CE /* wcpay-connection-token.json */,
 				318E8FD626C322EA00F519D7 /* wcpay-customer.json */,
 				318E8FD826C324D900F519D7 /* wcpay-customer-error.json */,
@@ -1767,6 +1775,7 @@
 				31B8D6B526583970008E3DB2 /* wcpay-account-implicitly-not-eligible.json */,
 				31799AFB2705189200D78179 /* wcpay-location.json */,
 				31799AFD270518AD00D78179 /* wcpay-location-error.json */,
+				02A26F1A2744F5FC008E4EDB /* wp-site-settings.json */,
 				077F39D726A58EB600ABEADC /* systemStatus.json */,
 			);
 			path = Responses;
@@ -1844,6 +1853,8 @@
 				CC0786C4267BAF0F00BA9AC1 /* ShippingLabelStatusMapper.swift */,
 				FE28F6E326842848004465C7 /* UserMapper.swift */,
 				077F39D326A58DE700ABEADC /* SystemStatusMapper.swift */,
+				02C11275274285FF00F4F0B4 /* WooCommerceAvailabilityMapper.swift */,
+				02C112772742862600F4F0B4 /* WordPressSiteSettingsMapper.swift */,
 			);
 			path = Mapper;
 			sourceTree = "<group>";
@@ -2147,6 +2158,7 @@
 				D88D5A43230BC668007B6E01 /* reviews-single.json in Resources */,
 				02DD6492248A3EC00082523E /* product-external.json in Resources */,
 				45A4B85C25D2FAB500776FB4 /* shipping-label-address-validation-error.json in Resources */,
+				02A26F1C2744F5FC008E4EDB /* wp-site-settings.json in Resources */,
 				740211DF2193985A002248DA /* comment-moderate-spam.json in Resources */,
 				B5147876211B9227007562E5 /* broken-orders-mark-2.json in Resources */,
 				3158FE6C26129D2E00E566B9 /* wcpay-account-rejected-terms-of-service.json in Resources */,
@@ -2157,6 +2169,7 @@
 				CE50346721B5DCBE007573C6 /* site-plan.json in Resources */,
 				743E84F322172D0A00FAC9D7 /* shipment_tracking_empty.json in Resources */,
 				B505F6D520BEE4E700BB1B69 /* me.json in Resources */,
+				02A26F1B2744F5FC008E4EDB /* wc-site-settings-partial.json in Resources */,
 				028FA474257E110700F88A48 /* shipping-label-refund-success.json in Resources */,
 				02BA23C922EEF62C009539E7 /* order-stats-v4-wcadmin-deactivated.json in Resources */,
 				CCB2CAA226209A1200285CA0 /* generic_success_data.json in Resources */,
@@ -2439,6 +2452,7 @@
 				743E84EC22171F4600FAC9D7 /* ShipmentTracking.swift in Sources */,
 				B56C1EB820EA76F500D749F9 /* Site.swift in Sources */,
 				26615473242D596B00A31661 /* ProductCategoriesRemote.swift in Sources */,
+				02C112782742862600F4F0B4 /* WordPressSiteSettingsMapper.swift in Sources */,
 				26615475242D7C9500A31661 /* ProductCategoryListMapper.swift in Sources */,
 				3178A49F2703E5CF00A8B4CA /* WCPayReaderLocationMapper.swift in Sources */,
 				45D685F823D0BC78005F87D0 /* ProductSkuMapper.swift in Sources */,
@@ -2517,6 +2531,7 @@
 				45152809257A7C6E0076B03C /* ProductAttributesRemote.swift in Sources */,
 				D8FBFF2222D5266E006E3336 /* OrderStatsV4Interval.swift in Sources */,
 				4568E2222459ADC60007E478 /* SitePostsRemote.swift in Sources */,
+				02C11276274285FF00F4F0B4 /* WooCommerceAvailabilityMapper.swift in Sources */,
 				CC0786C5267BAF0F00BA9AC1 /* ShippingLabelStatusMapper.swift in Sources */,
 				4515280D257A7EEC0076B03C /* ProductAttributeListMapper.swift in Sources */,
 				93D8BBFD226BBEE800AD2EB3 /* AccountSettingsMapper.swift in Sources */,

Networking/Networking/Mapper/WooCommerceAvailabilityMapper.swift

@@ -0,0 +1,12 @@
+import Foundation
+
+/// Mapper: From WooCommerce site settings response to a boolean that indicates whether WooCommerce is active on the site
+///
+struct WooCommerceAvailabilityMapper: Mapper {
+
+    /// Any store with valid WooCommerce site settings response data is considered to have an active WooCommerce plugin.
+    ///
+    func map(response: Data) throws -> Bool {
+        true
+    }
+}

Networking/Networking/Mapper/WordPressSiteSettingsMapper.swift

@@ -0,0 +1,30 @@
+import Foundation
+
+/// Mapper: WordPress Site Settings
+///
+struct WordPressSiteSettingsMapper: Mapper {
+    /// (Attempts) to convert a dictionary into `WordPressSiteSettings`.
+    func map(response: Data) throws -> WordPressSiteSettings {
+        let decoder = JSONDecoder()
+        return try decoder.decode(WordPressSiteSettings.self, from: response)
+    }
+}
+
+/// Represents a WordPress Site Settings response.
+///
+public struct WordPressSiteSettings: Decodable, Equatable {
+    /// Site's Name.
+    public let name: String
+
+    /// Site's Description.
+    public let description: String
+
+    /// Site's URL.
+    public let url: String
+
+    private enum CodingKeys: String, CodingKey {
+        case name = "title"
+        case description
+        case url
+    }
+}

Networking/Networking/Model/Order.swift

@@ -183,6 +183,35 @@ public struct Order: Decodable, GeneratedCopiable, GeneratedFakeable {
                   refunds: refunds,
                   fees: fees)
     }
+
+    public static var empty: Order {
+        self.init(siteID: 0,
+              orderID: 0,
+              parentID: 0,
+              customerID: 0,
+              number: "",
+              status: .pending,
+              currency: "",
+              customerNote: "",
+              dateCreated: Date(),
+              dateModified: Date(),
+              datePaid: Date(),
+              discountTotal: "",
+              discountTax: "",
+              shippingTotal: "",
+              shippingTax: "",
+              total: "",
+              totalTax: "",
+              paymentMethodID: "",
+              paymentMethodTitle: "",
+              items: [],
+              billingAddress: nil,
+              shippingAddress: nil,
+              shippingLines: [],
+              coupons: [],
+              refunds: [],
+              fees: [])
+    }
 }