KM-17445: use token on signup if present

Author: kp-mario-nachbaur

LocalPackages/PIAAccount/Sources/PIAAccount/Models/ResponseModels.swift

@@ -296,8 +296,21 @@ public struct DedicatedIPTokenDetails: Codable, Sendable {
     }
 }
 
-/// New account credentials after VPN sign up
+/// New account credentials after VPN sign up. Can be either:
+/// - username + password
+/// - username + apiToken + expiresAt
 public struct VpnSignUpInformation: Codable, Sendable {
     public let username: String
-    public let password: String
+    public let password: String?
+    /// The API token string
+    public let apiToken: String?
+    /// ISO 8601 expiration date string
+    public let expiresAt: String?
+
+    enum CodingKeys: String, CodingKey {
+        case username = "username"
+        case password = "password"
+        case apiToken = "api_token"
+        case expiresAt = "expires_at"
+    }
 }

LocalPackages/PIAAccount/Sources/PIAAccount/PIAAccountClient.swift

@@ -408,11 +408,19 @@ public actor PIAAccountClient: PIAAccountAPI {
     public func signUp(information: IOSSignupInformation) async throws -> VpnSignUpInformation {
         let bodyData = try JSONEncoder.piaCodable.encode(information)
 
-        return try await endpointManager.executeWithFailover(
+        let response: VpnSignUpInformation = try await endpointManager.executeWithFailover(
             path: .signup,
             method: .post,
             bodyType: .json(bodyData)
         )
+
+        // store a token if we received one
+        if let token = response.apiToken, let expiresAt = response.expiresAt {
+            let tokenResponse = APITokenResponse(apiToken: token, expiresAt: expiresAt)
+            try await tokenManager.storeAPIToken(tokenResponse)
+        }
+
+        return response
     }
 
     // MARK: - Social

LocalPackages/PIALibrary/Sources/PIALibrary/Account/DefaultAccountProvider.swift

@@ -495,7 +495,7 @@ public final class DefaultAccountProvider: AccountProvider, ConfigurationAccess,
             accessedDatabase.plain.lastSignupEmail = request.email
 
             do {
-                let credentials = try await webServices.signup(with: signup)
+                let (credentials, needsToken) = try await webServices.signup(with: signup)
 
                 if let transaction = request.transaction {
                     accessedStore.finishTransaction(transaction, success: true)
@@ -504,9 +504,13 @@ public final class DefaultAccountProvider: AccountProvider, ConfigurationAccess,
                 accessedDatabase.plain.lastSignupEmail = nil
                 accessedDatabase.secure.setPublicUsername(credentials.username)
                 accessedDatabase.secure.setUsername(credentials.username)
-                accessedDatabase.secure.setPassword(credentials.password, for: credentials.username)
+                if !credentials.password.isEmpty {
+                    accessedDatabase.secure.setPassword(credentials.password, for: credentials.username)
+                }
 
-                try await webServices.token(credentials: credentials)
+                if needsToken {
+                    try await webServices.token(credentials: credentials)
+                }
                 let accountInfo = try await webServices.info()
                 accessedDatabase.plain.accountInfo = accountInfo
                 accessedDatabase.secure.setPublicUsername(accountInfo.username)

LocalPackages/PIALibrary/Sources/PIALibrary/Account/EphemeralAccountProvider.swift

@@ -120,7 +120,7 @@ final class EphemeralAccountProvider: AccountProvider, ProvidersAccess, InAppAcc
             }
 
             do {
-                guard let credentials = try await webServices?.signup(with: signup) else {
+                guard let (credentials, _) = try await webServices?.signup(with: signup) else {
                     DispatchQueue.main.async { callback?(nil, nil) }
                     return
                 }

LocalPackages/PIALibrary/Sources/PIALibrary/Account/UserAccount.swift

@@ -23,7 +23,7 @@
 import Foundation
 
 /// The compound user account.
-public struct UserAccount: CustomStringConvertible, Equatable {
+public struct UserAccount: CustomStringConvertible, Equatable, Sendable {
 
     /// The account credentials.
     public let credentials: Credentials

LocalPackages/PIALibrary/Sources/PIALibrary/Mock/MockWebServices.swift

@@ -70,11 +70,11 @@ final class MockWebServices: WebServices {
 
     func deleteAccount() async throws {}
 
-    func signup(with request: Signup) async throws -> Credentials {
+    func signup(with request: Signup) async throws -> (credentials: Credentials, needsToken: Bool) {
         guard let result = credentials?() else {
             throw ClientError.unsupported
         }
-        return result
+        return (credentials: result, needsToken: true)
     }
 
     func redeem(with request: Redeem, _ callback: ((Credentials?, Error?) -> Void)?) {

LocalPackages/PIALibrary/Sources/PIALibrary/WebServices/AccountInfo.swift

@@ -23,7 +23,7 @@
 import Foundation
 
 /// The information associated with a `Credentials`.
-public struct AccountInfo: Codable, Equatable {
+public struct AccountInfo: Codable, Equatable, Sendable {
 
     /// The linked email address if any.
     public internal(set) var email: String?

LocalPackages/PIALibrary/Sources/PIALibrary/WebServices/Credentials.swift

@@ -23,7 +23,7 @@
 import Foundation
 
 /// The account credentials.
-public struct Credentials: Codable, Equatable {
+public struct Credentials: Codable, Equatable, Sendable {
 
     /// The username, typically a number prefixed with "p".
     public let username: String

LocalPackages/PIALibrary/Sources/PIALibrary/WebServices/PIAWebServices.swift

@@ -258,7 +258,7 @@ final class PIAWebServices: WebServices, ConfigurationAccess {
     }
 
     #if os(iOS) || os(tvOS)
-        func signup(with request: Signup) async throws -> Credentials {
+        func signup(with request: Signup) async throws -> (credentials: Credentials, needsToken: Bool) {
             var marketingJSON = ""
             if let marketing = request.marketing {
                 marketingJSON = stringify(json: marketing)
@@ -278,7 +278,9 @@ final class PIAWebServices: WebServices, ConfigurationAccess {
 
             do {
                 let response = try await nativeAccountAPI.signUp(information: info)
-                return Credentials(username: response.username, password: response.password)
+                let needsToken = response.apiToken == nil || response.apiToken!.isEmpty
+                let credentials = Credentials(username: response.username, password: response.password ?? "")
+                return (credentials: credentials, needsToken: needsToken)
             } catch {
                 let code = (error as? PIAAccountError)?.code ?? (error as? PIAMultipleErrors)?.code
                 throw code == 400 ? ClientError.badReceipt : ClientError.invalidParameter

LocalPackages/PIALibrary/Sources/PIALibrary/WebServices/WebServices.swift

@@ -62,11 +62,9 @@ protocol WebServices: AnyObject {
      */
     func deleteAccount() async throws
 
-    #if os(iOS) || os(tvOS)
-        func signup(with request: Signup) async throws -> Credentials
+    func signup(with request: Signup) async throws -> (credentials: Credentials, needsToken: Bool)
 
-        func processPayment(credentials: Credentials, request: Payment) async throws
-    #endif
+    func processPayment(credentials: Credentials, request: Payment) async throws
 
     // MARK: Store