Try to improve auth error messages

This commit is contained in:
Brandon Evans 2021-01-25 19:17:44 -07:00
parent a04bfb39d0
commit 58cddb88f6
No known key found for this signature in database
GPG key ID: D58A4B8DB64F8E93
2 changed files with 21 additions and 9 deletions

View file

@ -129,7 +129,7 @@ public class Client {
case 400, 401:
throw AuthenticationError.incorrectSecurityCode
case let code:
throw AuthenticationError.badStatusCode(code, data, urlResponse)
throw AuthenticationError.badStatusCode(statusCode: code, data: data, response: urlResponse)
}
}
.flatMap { (data, response) -> AnyPublisher<AuthenticationState, Error> in
@ -180,20 +180,31 @@ public enum AuthenticationError: Swift.Error, LocalizedError, Equatable {
case appleIDAndPrivacyAcknowledgementRequired
case accountUsesTwoStepAuthentication
case accountUsesUnknownAuthenticationKind(String?)
case badStatusCode(Int, Data, HTTPURLResponse)
case badStatusCode(statusCode: Int, data: Data, response: HTTPURLResponse)
public var errorDescription: String? {
switch self {
case .invalidUsernameOrPassword(let username):
return "Invalid username and password combination. Attempted to sign in with username \(username)."
case .invalidSession:
return "Your authentication session is invalid. Try signing in again."
case .invalidUsernameOrPassword:
return "Invalid username and password combination."
case .incorrectSecurityCode:
return "The code that was entered is incorrect."
case let .unexpectedSignInResponse(statusCode, message):
return """
Received an unexpected sign in response. If you continue to have problems, please submit a bug report in the Help menu and include the following information:
Status code: \(statusCode)
\(message != nil ? ("Message: " + message!) : "")
"""
case .appleIDAndPrivacyAcknowledgementRequired:
return "You must sign in to https://appstoreconnect.apple.com and acknowledge the Apple ID & Privacy agreement."
case .accountUsesTwoStepAuthentication:
return "Received a response from Apple that indicates this account has two-step authentication enabled. xcodes currently only supports the newer two-factor authentication, though. Please consider upgrading to two-factor authentication, or open an issue on GitHub explaining why this isn't an option for you here: https://github.com/RobotsAndPencils/xcodes/issues/new"
return "Received a response from Apple that indicates this account has two-step authentication enabled. xcodes currently only supports the newer two-factor authentication, though. Please consider upgrading to two-factor authentication, or explain why this isn't an option for you by making a new feature request in the Help menu."
case .accountUsesUnknownAuthenticationKind:
return "Received a response from Apple that indicates this account has two-step or two-factor authentication enabled, but xcodes is unsure how to handle this response:"
default:
return String(describing: self)
return "Received a response from Apple that indicates this account has two-step or two-factor authentication enabled, but xcodes is unsure how to handle this response. If you continue to have problems, please submit a bug report in the Help menu."
case let .badStatusCode(statusCode, _, _):
return "Received an unexpected status code: \(statusCode). If you continue to have problems, please submit a bug report in the Help menu."
}
}
}

View file

@ -6,6 +6,7 @@ import LegibleError
import KeychainAccess
import Path
import Version
import os.log
class AppState: ObservableObject {
private let client = AppleAPI.Client()
@ -181,7 +182,7 @@ class AppState: ObservableObject {
try? Current.keychain.remove(username)
}
// This error message is not user friendly... need to extract some meaningful data in the different cases
Logger.appState.error("Authentication error: \(error.legibleDescription)")
self.authError = error
case .finished:
switch self.authenticationState {