Skip to content

Commit 26cd798

Browse files
allendavallendav
authored
Merge pull request #4957 from woocommerce/issue/4947-connecting-failed
[Mobile Payments] Display connecting-to-reader failures
2 parents 16ca58b + 0db9ef0 commit 26cd798

File tree

9 files changed

+298
-9
lines changed

9 files changed

+298
-9
lines changed

‎WooCommerce/Classes/ViewModels/CardPresentPayments/CardPresentModalConnectingFailed.swift‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
import UIKit
2+
import Yosemite
3+
4+
/// Modal presented when an error occurs while connecting to a reader
5+
///
6+
final class CardPresentModalConnectingFailed: CardPresentPaymentsModalViewModel {
7+
private let continueSearchAction: () -> Void
8+
private let cancelSearchAction: () -> Void
9+
10+
let textMode: PaymentsModalTextMode = .reducedTopInfo
11+
let actionsMode: PaymentsModalActionsMode = .twoAction
12+
13+
let topTitle: String = Localization.title
14+
15+
var topSubtitle: String? = nil
16+
17+
let image: UIImage = .paymentErrorImage
18+
19+
let primaryButtonTitle: String? = Localization.tryAgain
20+
21+
let secondaryButtonTitle: String? = Localization.cancel
22+
23+
let auxiliaryButtonTitle: String? = nil
24+
25+
var bottomTitle: String? = nil
26+
27+
let bottomSubtitle: String? = nil
28+
29+
init(continueSearch: @escaping () -> Void, cancelSearch: @escaping () -> Void) {
30+
self.continueSearchAction = continueSearch
31+
self.cancelSearchAction = cancelSearch
32+
}
33+
34+
func didTapPrimaryButton(in viewController: UIViewController?) {
35+
continueSearchAction()
36+
}
37+
38+
func didTapSecondaryButton(in viewController: UIViewController?) {
39+
cancelSearchAction()
40+
}
41+
42+
func didTapAuxiliaryButton(in viewController: UIViewController?) { }
43+
}
44+
45+
private extension CardPresentModalConnectingFailed {
46+
enum Localization {
47+
static let title = NSLocalizedString(
48+
"We couldn't connect your reader",
49+
comment: "Title of the alert presented when the user tries to connect to a specific card reader and it fails"
50+
)
51+
52+
static let tryAgain = NSLocalizedString(
53+
"Try again",
54+
comment: "Button to dismiss the alert presented when connecting to a specific reader fails. This allows the search to continue."
55+
)
56+
57+
static let cancel = NSLocalizedString(
58+
"Cancel",
59+
comment: "Button to dismiss the alert presented when connecting to a specific reader fails. This also cancels searching."
60+
)
61+
}
62+
}

‎WooCommerce/Classes/ViewRelated/CardPresentPayments/CardReaderConnectionController.swift‎

Lines changed: 37 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ final class CardReaderConnectionController {
3333
///
3434
case connectToReader
3535

36+
/// A failure occurred while connecting. The search may continue or be canceled. At this time we
37+
/// do not present the detailed error from the service.
38+
///
39+
case connectingFailed(Error)
40+
3641
/// User cancelled search/connecting to a card reader. The completion passed to `searchAndConnect`
3742
/// will be called with a `success` `Bool` `False` result. The view controller passed to `searchAndConnect` will be
3843
/// dereferenced and the state set to `idle`
@@ -43,7 +48,7 @@ final class CardReaderConnectionController {
4348
/// will be called with a `failure` result. The view controller passed to `searchAndConnect` will be
4449
/// dereferenced and the state set to `idle`
4550
///
46-
case failed(Error)
51+
case discoveryFailed(Error)
4752
}
4853

4954
private var state: ControllerState {
@@ -122,8 +127,10 @@ private extension CardReaderConnectionController {
122127
onCancel()
123128
case .connectToReader:
124129
onConnectToReader()
125-
case .failed(let error):
126-
onFailed(error: error)
130+
case .connectingFailed(let error):
131+
onConnectingFailed(error: error)
132+
case .discoveryFailed(let error):
133+
onDiscoveryFailed(error: error)
127134
}
128135
}
129136

@@ -222,7 +229,7 @@ private extension CardReaderConnectionController {
222229
}
223230

224231
ServiceLocator.analytics.track(.cardReaderDiscoveryFailed, withError: error)
225-
self.state = .failed(error)
232+
self.state = .discoveryFailed(error)
226233
})
227234

228235
ServiceLocator.stores.dispatch(action)
@@ -312,18 +319,41 @@ private extension CardReaderConnectionController {
312319
self.returnSuccess(connected: true)
313320
case .failure(let error):
314321
ServiceLocator.analytics.track(.cardReaderConnectionFailed, withError: error)
315-
self.returnFailure(error: error)
322+
self.state = .connectingFailed(error)
316323
}
317324
}
318325
ServiceLocator.stores.dispatch(action)
319326

320327
alerts.connectingToReader(from: from)
321328
}
322329

323-
/// An error has occurred
330+
/// An error occurred while connecting
331+
///
332+
private func onConnectingFailed(error: Error) {
333+
guard let from = fromController else {
334+
return
335+
}
336+
337+
/// Clear our copy of found readers to avoid connecting to a reader that isn't
338+
/// there while we wait for `onReaderDiscovered` to receive an update.
339+
/// See also https://github.com/stripe/stripe-terminal-ios/issues/104#issuecomment-916285167
340+
///
341+
self.foundReaders = []
342+
343+
alerts.connectingFailed(
344+
from: from,
345+
continueSearch: {
346+
self.state = .searching
347+
}, cancelSearch: {
348+
self.state = .cancel
349+
}
350+
)
351+
}
352+
353+
/// An error occurred during discovery
324354
/// Presents the error in a modal
325355
///
326-
private func onFailed(error: Error) {
356+
private func onDiscoveryFailed(error: Error) {
327357
guard let from = fromController else {
328358
return
329359
}

‎WooCommerce/Classes/ViewRelated/Dashboard/Settings/CardReadersV2/CardReaderSettingsAlerts.swift‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ final class CardReaderSettingsAlerts: CardReaderSettingsAlertsProvider {
2020
setViewModelAndPresent(from: from, viewModel: connectingToReader())
2121
}
2222

23+
func connectingFailed(from: UIViewController, continueSearch: @escaping () -> Void, cancelSearch: @escaping () -> Void) {
24+
setViewModelAndPresent(from: from, viewModel: connectingFailed(continueSearch: continueSearch, cancelSearch: cancelSearch))
25+
}
26+
2327
func foundReader(from: UIViewController,
2428
name: String,
2529
connect: @escaping () -> Void,
@@ -57,6 +61,10 @@ private extension CardReaderSettingsAlerts {
5761
CardPresentModalConnectingToReader()
5862
}
5963

64+
func connectingFailed(continueSearch: @escaping () -> Void, cancelSearch: @escaping () -> Void) -> CardPresentPaymentsModalViewModel {
65+
CardPresentModalConnectingFailed(continueSearch: continueSearch, cancelSearch: cancelSearch)
66+
}
67+
6068
func foundReader(name: String, connect: @escaping () -> Void, continueSearch: @escaping () -> Void) -> CardPresentPaymentsModalViewModel {
6169
CardPresentModalFoundReader(name: name, connect: connect, continueSearch: continueSearch)
6270
}

‎WooCommerce/Classes/ViewRelated/Dashboard/Settings/CardReadersV2/CardReaderSettingsAlertsProvider.swift‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,13 @@ protocol CardReaderSettingsAlertsProvider {
2626
///
2727
func connectingToReader(from: UIViewController)
2828

29+
/// Defines an alert indicating connecting failed. The user may continue the search
30+
/// or cancel
31+
///
32+
func connectingFailed(from: UIViewController,
33+
continueSearch: @escaping () -> Void,
34+
cancelSearch: @escaping () -> Void)
35+
2936
/// Dismisses any alert being presented
3037
///
3138
func dismiss()

‎WooCommerce/WooCommerce.xcodeproj/project.pbxproj‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -502,6 +502,8 @@
502502
3190D61B26D6D82900EF364D /* CardPresentRetryableError.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3190D61A26D6D82900EF364D /* CardPresentRetryableError.swift */; };
503503
3190D61D26D6E97B00EF364D /* CardPresentModalRetryableErrorTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3190D61C26D6E97B00EF364D /* CardPresentModalRetryableErrorTests.swift */; };
504504
3198A1E82694DC7200597213 /* MockKnownReadersProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3198A1E72694DC7200597213 /* MockKnownReadersProvider.swift */; };
505+
31AD0B1126E9575F000B6391 /* CardPresentModalConnectingFailed.swift in Sources */ = {isa = PBXBuildFile; fileRef = 31AD0B1026E9575F000B6391 /* CardPresentModalConnectingFailed.swift */; };
506+
31AD0B1326E95998000B6391 /* CardPresentModalConnectingFailedTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 31AD0B1226E95998000B6391 /* CardPresentModalConnectingFailedTests.swift */; };
505507
31B0551E264B3C7A00134D87 /* CardPresentModalFoundReader.swift in Sources */ = {isa = PBXBuildFile; fileRef = 31B0551D264B3C7A00134D87 /* CardPresentModalFoundReader.swift */; };
506508
31B05523264B3C8900134D87 /* CardPresentModalConnectingToReader.swift in Sources */ = {isa = PBXBuildFile; fileRef = 31B05522264B3C8900134D87 /* CardPresentModalConnectingToReader.swift */; };
507509
31B19B67263B5E580099DAA6 /* CardReaderSettingsSearchingViewModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = 31B19B66263B5E580099DAA6 /* CardReaderSettingsSearchingViewModel.swift */; };
@@ -1911,6 +1913,8 @@
19111913
3190D61A26D6D82900EF364D /* CardPresentRetryableError.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CardPresentRetryableError.swift; sourceTree = "<group>"; };
19121914
3190D61C26D6E97B00EF364D /* CardPresentModalRetryableErrorTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CardPresentModalRetryableErrorTests.swift; sourceTree = "<group>"; };
19131915
3198A1E72694DC7200597213 /* MockKnownReadersProvider.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockKnownReadersProvider.swift; sourceTree = "<group>"; };
1916+
31AD0B1026E9575F000B6391 /* CardPresentModalConnectingFailed.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CardPresentModalConnectingFailed.swift; sourceTree = "<group>"; };
1917+
31AD0B1226E95998000B6391 /* CardPresentModalConnectingFailedTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CardPresentModalConnectingFailedTests.swift; sourceTree = "<group>"; };
19141918
31B0551D264B3C7A00134D87 /* CardPresentModalFoundReader.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CardPresentModalFoundReader.swift; sourceTree = "<group>"; };
19151919
31B05522264B3C8900134D87 /* CardPresentModalConnectingToReader.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CardPresentModalConnectingToReader.swift; sourceTree = "<group>"; };
19161920
31B19B66263B5E580099DAA6 /* CardReaderSettingsSearchingViewModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CardReaderSettingsSearchingViewModel.swift; sourceTree = "<group>"; };
@@ -6128,6 +6132,7 @@
61286132
E17E3BFA266917E20009D977 /* CardPresentModalBluetoothRequiredTests.swift */,
61296133
E17E3BF8266917C10009D977 /* CardPresentModalScanningFailedTests.swift */,
61306134
3190D61C26D6E97B00EF364D /* CardPresentModalRetryableErrorTests.swift */,
6135+
31AD0B1226E95998000B6391 /* CardPresentModalConnectingFailedTests.swift */,
61316136
);
61326137
path = CardPresentPayments;
61336138
sourceTree = "<group>";
@@ -6232,6 +6237,7 @@
62326237
3190D61A26D6D82900EF364D /* CardPresentRetryableError.swift */,
62336238
E1F52DC52668E03B00349D75 /* CardPresentModalBluetoothRequired.swift */,
62346239
31B05522264B3C8900134D87 /* CardPresentModalConnectingToReader.swift */,
6240+
31AD0B1026E9575F000B6391 /* CardPresentModalConnectingFailed.swift */,
62356241
D8EE9697264D3CCB0033B2F9 /* ReceiptViewModel.swift */,
62366242
D8752EF6265E60F4008ACC80 /* PaymentCaptureCelebration.swift */,
62376243
);
@@ -7130,6 +7136,7 @@
71307136
77E53EB8250E6A4E003D385F /* ProductDownloadListViewController.swift in Sources */,
71317137
74460D4022289B7600D7316A /* Coordinator.swift in Sources */,
71327138
B57C743D20F5493300EEFC87 /* AccountHeaderView.swift in Sources */,
7139+
31AD0B1126E9575F000B6391 /* CardPresentModalConnectingFailed.swift in Sources */,
71337140
576EA39425264C9B00AFC0B3 /* RefundConfirmationViewModel.swift in Sources */,
71347141
CC4A4E962655273D00B75DCD /* ShippingLabelPaymentMethods.swift in Sources */,
71357142
45DB6D972632CF9300E83C1A /* ActivityIndicator.swift in Sources */,
@@ -8013,6 +8020,7 @@
80138020
DE126D0F26CA71E8007F901D /* ShippingLabelCustomsFormInputViewModelTests.swift in Sources */,
80148021
0277AE9B256CA8A200F45C4A /* AggregatedShippingLabelOrderItemsTests.swift in Sources */,
80158022
0225C42A24768CE900C5B4F0 /* FilterProductListViewModelProductListFilterTests.swift in Sources */,
8023+
31AD0B1326E95998000B6391 /* CardPresentModalConnectingFailedTests.swift in Sources */,
80168024
E16715CD2666543000326230 /* CardPresentModalSuccessWithoutEmailTests.swift in Sources */,
80178025
02691780232600A6002AFC20 /* ProductsTabProductViewModelTests.swift in Sources */,
80188026
024F1452250B65A40003030A /* AddProductCoordinatorTests.swift in Sources */,

‎WooCommerce/WooCommerceTests/Mocks/MockCardPresentPaymentsStoresManager.swift‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,24 @@ final class MockCardPresentPaymentsStoresManager: DefaultStoresManager {
1010
private var readerUpdateAvailable: Bool
1111
private var failReaderUpdateCheck: Bool
1212
private var failUpdate: Bool
13+
private var failConnection: Bool
1314

1415
init(connectedReaders: [CardReader],
1516
discoveredReader: CardReader? = nil,
1617
sessionManager: SessionManager,
1718
failDiscovery: Bool = false,
1819
readerUpdateAvailable: Bool = false,
1920
failReaderUpdateCheck: Bool = false,
20-
failUpdate: Bool = false
21+
failUpdate: Bool = false,
22+
failConnection: Bool = false
2123
) {
2224
self.connectedReaders = connectedReaders
2325
self.discoveredReader = discoveredReader
2426
self.failDiscovery = failDiscovery
2527
self.readerUpdateAvailable = readerUpdateAvailable
2628
self.failReaderUpdateCheck = failReaderUpdateCheck
2729
self.failUpdate = failUpdate
30+
self.failConnection = failConnection
2831
super.init(sessionManager: sessionManager)
2932
}
3033

@@ -50,6 +53,10 @@ final class MockCardPresentPaymentsStoresManager: DefaultStoresManager {
5053
}
5154
onReaderDiscovered([discoveredReader])
5255
case .connect(let reader, let onCompletion):
56+
guard !failConnection else {
57+
onCompletion(Result.failure(MockErrors.connectionFailure))
58+
return
59+
}
5360
onCompletion(Result.success(reader))
5461
case .cancelCardReaderDiscovery(let onCompletion):
5562
onCompletion(Result.success(()))
@@ -81,6 +88,7 @@ extension MockCardPresentPaymentsStoresManager {
8188
case discoveryFailure
8289
case readerUpdateCheckFailure
8390
case readerUpdateFailure
91+
case connectionFailure
8492
}
8593
}
8694

‎WooCommerce/WooCommerceTests/Mocks/MockCardReaderSettingsAlerts.swift‎

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,30 @@ enum MockCardReaderSettingsAlertsMode {
77
case closeScanFailure
88
case continueSearching
99
case connectFoundReader
10+
case continueSearchingAfterConnectionFailure
11+
case cancelSearchingAfterConnectionFailure
1012
}
1113

1214
final class MockCardReaderSettingsAlerts: CardReaderSettingsAlertsProvider {
1315
private var mode: MockCardReaderSettingsAlertsMode
16+
private var didPresentFoundReader: Bool
1417

1518
init(mode: MockCardReaderSettingsAlertsMode) {
1619
self.mode = mode
20+
self.didPresentFoundReader = false
1721
}
1822
func scanningForReader(from: UIViewController, cancel: @escaping () -> Void) {
1923
if mode == .cancelScanning {
2024
cancel()
2125
}
26+
27+
if mode == .continueSearchingAfterConnectionFailure {
28+
/// If we've already presented a found reader once before, cancel this second search
29+
///
30+
if didPresentFoundReader {
31+
cancel()
32+
}
33+
}
2234
}
2335

2436
func scanningFailed(from: UIViewController, error: Error, close: @escaping () -> Void) {
@@ -28,11 +40,13 @@ final class MockCardReaderSettingsAlerts: CardReaderSettingsAlertsProvider {
2840
}
2941

3042
func foundReader(from: UIViewController, name: String, connect: @escaping () -> Void, continueSearch: @escaping () -> Void) {
43+
didPresentFoundReader = true
44+
3145
if mode == .continueSearching {
3246
continueSearch()
3347
}
3448

35-
if mode == .connectFoundReader {
49+
if mode == .connectFoundReader || mode == .cancelSearchingAfterConnectionFailure || mode == .continueSearchingAfterConnectionFailure {
3650
connect()
3751
}
3852
}
@@ -41,6 +55,16 @@ final class MockCardReaderSettingsAlerts: CardReaderSettingsAlertsProvider {
4155
// GNDN
4256
}
4357

58+
func connectingFailed(from: UIViewController, continueSearch: @escaping () -> Void, cancelSearch: @escaping () -> Void) {
59+
if mode == .continueSearchingAfterConnectionFailure {
60+
continueSearch()
61+
}
62+
63+
if mode == .cancelSearchingAfterConnectionFailure {
64+
cancelSearch()
65+
}
66+
}
67+
4468
func dismiss() {
4569
// GNDN
4670
}

0 commit comments

Comments
 (0)