Add tests for FlowResult.

2026-04-19 08:03:50 +02:00 · 2022-05-18 13:51:23 +01:00
parent 792d3ed355
commit 68b5a9e88b
6 changed files with 345 additions and 100 deletions
@@ -0,0 +1,102 @@
+// 
+// Copyright 2022 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import Foundation
+
+/// The parameters used for registration requests.
+struct RegistrationParameters: Codable {
+    /// Authentication parameters
+    var auth: AuthenticationParameters?
+    
+    /// The account username
+    var username: String?
+    
+    /// The account password
+    var password: String?
+    
+    /// Device name
+    var initialDeviceDisplayName: String?
+    
+    /// Temporary flag to notify the server that we support MSISDN flow. Used to prevent old app
+    /// versions to end up in fallback because the HS returns the MSISDN flow which they don't support
+    var xShowMSISDN: Bool?
+    
+    enum CodingKeys: String, CodingKey {
+        case auth
+        case username
+        case password
+        case initialDeviceDisplayName = "initial_device_display_name"
+        case xShowMSISDN = "x_show_msisdn"
+    }
+    
+    /// The parameters as a JSON dictionary for use in MXRestClient.
+    func dictionary() throws -> [String: Any] {
+        let jsonData = try JSONEncoder().encode(self)
+        let object = try JSONSerialization.jsonObject(with: jsonData)
+        guard let dictionary = object as? [String: Any] else {
+            MXLog.error("[RegistrationParameters] dictionary: Unexpected type decoded \(type(of: object)). Expected a Dictionary.")
+            throw AuthenticationError.dictionaryError
+        }
+        
+        return dictionary
+    }
+}
+
+/// The data passed to the `auth` parameter in registration requests.
+struct AuthenticationParameters: Codable {
+    /// The type of authentication taking place. The identifier from `MXLoginFlowType`.
+    let type: String
+    
+    /// Note: session can be null for reset password request
+    var session: String?
+    
+    /// parameter for "m.login.recaptcha" type
+    var captchaResponse: String?
+    
+    /// parameter for "m.login.email.identity" type
+    var threePIDCredentials: ThreePIDCredentials?
+    
+    enum CodingKeys: String, CodingKey {
+        case type
+        case session
+        case captchaResponse = "response"
+        case threePIDCredentials = "threepid_creds"
+    }
+    
+    /// Creates the authentication parameters for a captcha step.
+    static func captchaParameters(session: String, captchaResponse: String) -> AuthenticationParameters {
+        AuthenticationParameters(type: kMXLoginFlowTypeRecaptcha, session: session, captchaResponse: captchaResponse)
+    }
+    
+    /// Creates the authentication parameters for a third party ID step using an email address.
+    static func emailIdentityParameters(session: String, threePIDCredentials: ThreePIDCredentials) -> AuthenticationParameters {
+        AuthenticationParameters(type: kMXLoginFlowTypeEmailIdentity, session: session, threePIDCredentials: threePIDCredentials)
+    }
+    
+    // Note that there is a bug in Synapse (needs investigation), but if we pass .msisdn,
+    // the homeserver answer with the login flow with MatrixError fields and not with a simple MatrixError 401.
+    /// Creates the authentication parameters for a third party ID step using a phone number.
+    static func msisdnIdentityParameters(session: String, threePIDCredentials: ThreePIDCredentials) -> AuthenticationParameters {
+        AuthenticationParameters(type: kMXLoginFlowTypeMSISDN, session: session, threePIDCredentials: threePIDCredentials)
+    }
+    
+    /// Creates the authentication parameters for a password reset step.
+    static func resetPasswordParameters(clientSecret: String, sessionID: String) -> AuthenticationParameters {
+        AuthenticationParameters(type: kMXLoginFlowTypeEmailIdentity,
+                                 session: nil,
+                                 threePIDCredentials: ThreePIDCredentials(clientSecret: clientSecret, sessionID: sessionID))
+    }
+}