1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
|
//
// DisplayChainedError.swift
// MullvadVPN
//
// Created by pronebird on 04/06/2020.
// Copyright © 2020 Mullvad VPN AB. All rights reserved.
//
import Foundation
import StoreKit
protocol DisplayChainedError {
var errorChainDescription: String? { get }
}
extension REST.Error: DisplayChainedError {
var errorChainDescription: String? {
switch self {
case .network(let urlError):
return String(
format: NSLocalizedString(
"NETWORK_ERROR",
tableName: "RESTClient",
value: "Network error: %@",
comment: "Network error. Use %@ placeholder to place localized failure description."
),
urlError.localizedDescription
)
case .server(let serverError):
if let knownErrorDescription = serverError.errorDescription {
return knownErrorDescription
} else {
return String(
format: NSLocalizedString(
"SERVER_ERROR",
tableName: "RESTClient",
value: "Server error: %@",
comment: "Server error. Use %@ placeholder to place localized failure description."
),
serverError.error ?? "(empty)"
)
}
case .encodePayload:
return NSLocalizedString(
"SERVER_REQUEST_ENCODING_ERROR",
tableName: "RESTClient",
value: "Server request encoding error",
comment: "Failure to encode the server request."
)
case .decodeSuccessResponse:
return NSLocalizedString(
"SERVER_SUCCESS_RESPONSE_DECODING_ERROR",
tableName: "RESTClient",
value: "Server success response decoding error",
comment: "Failure to decode the server success response."
)
case .decodeErrorResponse:
return NSLocalizedString(
"SERVER_FAILURE_RESPONSE_DECODING_ERROR",
tableName: "RESTClient",
value: "Server error response decoding error",
comment: "Failure to decode the server failure response."
)
}
}
}
extension TunnelManager.Error: DisplayChainedError {
var errorChainDescription: String? {
switch self {
case .loadAllVPNConfigurations(let systemError):
return String(
format: NSLocalizedString(
"LOAD_ALL_VPN_CONFIGURATIONS_ERROR",
tableName: "TunnelManager",
value: "Failed to load system VPN configurations: %@",
comment: ""
),
systemError.localizedDescription
)
case .reloadVPNConfiguration(let systemError):
return String(
format: NSLocalizedString(
"RELOAD_VPN_CONFIGURATIONS_ERROR",
tableName: "TunnelManager",
value: "Failed to reload a VPN configuration: %@",
comment: ""
),
systemError.localizedDescription
)
case .saveVPNConfiguration(let systemError):
return String(
format: NSLocalizedString(
"SAVE_VPN_CONFIGURATION_ERROR",
tableName: "TunnelManager",
value: "Failed to save a VPN tunnel configuration: %@",
comment: ""
),
systemError.localizedDescription
)
case .obtainPersistentKeychainReference(_):
return NSLocalizedString(
"OBTAIN_PERSISTENT_KEYCHAIN_REFERENCE_ERROR",
tableName: "TunnelManager",
value: "Failed to obtain the persistent keychain reference for the VPN configuration",
comment: ""
)
case .startVPNTunnel(let systemError):
return String(
format: NSLocalizedString(
"START_VPN_TUNNEL_ERROR",
tableName: "TunnelManager",
value: "System error when starting the VPN tunnel: %@",
comment: ""
),
systemError.localizedDescription
)
case .removeVPNConfiguration(let systemError):
return String(
format: NSLocalizedString(
"REMOVE_VPN_CONFIGURATION_ERROR",
tableName: "TunnelManager",
value: "Failed to remove the system VPN configuration: %@",
comment: ""
),
systemError.localizedDescription
)
case .removeInconsistentVPNConfiguration(let systemError):
return String(
format: NSLocalizedString(
"REMOVE_INCONSISTENT_VPN_CONFIGURATION",
tableName: "TunnelManager",
value: "Failed to remove the outdated system VPN configuration: %@",
comment: ""
),
systemError.localizedDescription
)
case .readTunnelSettings(_):
return NSLocalizedString(
"READ_TUNNEL_SETTINGS_ERROR",
tableName: "TunnelManager",
value: "Failed to read tunnel settings",
comment: ""
)
case .addTunnelSettings(_):
return NSLocalizedString(
"ADD_TUNNEL_SETTINGS_ERROR",
tableName: "TunnelManager",
value: "Failed to add tunnel settings",
comment: ""
)
case .updateTunnelSettings(_):
return NSLocalizedString(
"UPDATE_TUNNEL_SETTINGS_ERROR",
tableName: "TunnelManager",
value: "Failed to update tunnel settings",
comment: ""
)
case .removeTunnelSettings(_):
return NSLocalizedString(
"REMOVE_TUNNEL_SETTINGS_ERROR",
tableName: "TunnelManager",
value: "Failed to remove tunnel settings",
comment: ""
)
case .migrateTunnelSettings(_):
return NSLocalizedString(
"MIGRATE_TUNNEL_SETTINGS_ERROR",
tableName: "TunnelManager",
value: "Failed to migrate tunnel settings",
comment: ""
)
case .pushWireguardKey(let restError):
let reason = restError.errorChainDescription ?? ""
var message = String(
format: NSLocalizedString(
"PUSH_WIREGUARD_KEY_ERROR",
tableName: "TunnelManager",
value: "Failed to send the WireGuard key to server: %@",
comment: ""
),
reason
)
if case .server(.keyLimitReached) = restError {
// TODO: maybe use `restError.recoverySuggestion` instead?
message.append("\n\n")
message.append(NSLocalizedString(
"PUSH_WIREGUARD_KEY_RECOVERY_SUGGESTION",
tableName: "TunnelManager",
value: "Remove unused WireGuard keys and try again",
comment: ""
))
}
return message
case .replaceWireguardKey(let restError):
let reason = restError.errorChainDescription ?? ""
var message = String(
format: NSLocalizedString(
"REPLACE_WIREGUARD_KEY_ERROR",
tableName: "TunnelManager",
value: "Failed to replace the WireGuard key on server: %@",
comment: ""
),
reason
)
if case .server(.keyLimitReached) = restError {
// TODO: maybe use `restError.recoverySuggestion` instead?
message.append("\n\n")
message.append(NSLocalizedString(
"REPLACE_WIREGUARD_KEY_RECOVERY_SUGGESTION",
tableName: "TunnelManager",
value: "Remove unused WireGuard keys and try again",
comment: "")
)
}
return message
case .removeWireguardKey:
// This error is never displayed anywhere
return nil
case .missingAccount:
return NSLocalizedString(
"MISSING_ACCOUNT_INTERNAL_ERROR",
tableName: "TunnelManager",
value: "Internal error: missing account",
comment: ""
)
case .readRelays:
return NSLocalizedString(
"READ_RELAYS_ERROR",
tableName: "TunnelManager",
value: "Failed to read relays.",
comment: ""
)
case .cannotSatisfyRelayConstraints:
return NSLocalizedString(
"CANNOT_SATISFY_RELAY_CONSTRAINTS_ERROR",
tableName: "TunnelManager",
value: "Failed to satisfy relay constraints.",
comment: ""
)
case .backgroundTaskScheduler:
// This error is never displayed anywhere
return nil
}
}
}
extension Account.Error: DisplayChainedError {
var errorChainDescription: String? {
switch self {
case .createAccount(let restError), .verifyAccount(let restError):
return restError.errorChainDescription
case .tunnelConfiguration(let tunnelError):
return tunnelError.errorChainDescription
}
}
}
extension SKError: LocalizedError {
public var errorDescription: String? {
switch self.code {
case .unknown:
return NSLocalizedString(
"UNKNOWN_ERROR",
tableName: "StoreKitErrors",
value: "Unknown error",
comment: ""
)
case .clientInvalid:
return NSLocalizedString(
"CLIENT_INVALID",
tableName: "StoreKitErrors",
value: "Client is not allowed to issue the request",
comment: ""
)
case .paymentCancelled:
return NSLocalizedString(
"PAYMENT_CANCELLED",
tableName: "StoreKitErrors",
value: "User cancelled the request",
comment: ""
)
case .paymentInvalid:
return NSLocalizedString(
"PAYMENT_INVALID",
tableName: "StoreKitErrors",
value: "Invalid purchase identifier",
comment: ""
)
case .paymentNotAllowed:
return NSLocalizedString(
"PAYMENT_NOT_ALLOWED",
tableName: "StoreKitErrors",
value: "This device is not allowed to make the payment",
comment: ""
)
default:
return self.localizedDescription
}
}
}
extension AppStorePaymentManager.Error: DisplayChainedError {
var errorChainDescription: String? {
switch self {
case .noAccountSet:
return NSLocalizedString(
"NO_ACCOUNT_SET_ERROR",
tableName: "AppStorePaymentManager",
value: "Internal error: account is not set",
comment: ""
)
case .readReceipt(let readReceiptError):
switch readReceiptError {
case .refresh(let storeError):
let skErrorMessage = (storeError as? SKError)?.errorDescription ?? storeError.localizedDescription
return String(
format: NSLocalizedString(
"REFRESH_RECEIPT_ERROR",
tableName: "AppStorePaymentManager",
value: "Cannot refresh the AppStore receipt: %@",
comment: ""
),
skErrorMessage
)
case .io(let ioError):
return String(
format: NSLocalizedString(
"READ_RECEIPT_ERROR",
tableName: "AppStorePaymentManager",
value: "Cannot read the AppStore receipt from disk: %@",
comment: ""
),
ioError.localizedDescription
)
case .doesNotExist:
return NSLocalizedString(
"RECEIPT_NOT_FOUND_ERROR",
tableName: "AppStorePaymentManager",
value: "AppStore receipt is not found on disk.",
comment: ""
)
}
case .sendReceipt(let restError):
let reason = restError.errorChainDescription ?? ""
let errorFormat = NSLocalizedString(
"SEND_RECEIPT_ERROR",
tableName: "AppStorePaymentManager",
value: "Failed to send the receipt to server: %@",
comment: ""
)
let recoverySuggestion = NSLocalizedString(
"SEND_RECEIPT_RECOVERY_SUGGESTION",
tableName: "AppStorePaymentManager",
value: "Please retry by using the \"Restore purchases\" button.",
comment: ""
)
var errorString = String(format: errorFormat, reason)
errorString.append("\n\n")
errorString.append(recoverySuggestion)
return errorString
case .storePayment(let storeError):
return (storeError as? SKError)?.errorDescription ?? storeError.localizedDescription
}
}
}
|
