Merge pull request #553 from wordpress-mobile/try/fix-magic-link-login-and-signup

Fix magic link issues.

Author: diegoreymendez

Podfile.lock

@@ -48,7 +48,7 @@ PODS:
   - Specta (1.0.7)
   - SVProgressHUD (2.2.5)
   - UIDeviceIdentifier (1.6.0)
-  - WordPressKit (4.24.0-beta.4):
+  - WordPressKit (4.24.0-beta.6):
     - Alamofire (~> 4.8.0)
     - CocoaLumberjack (~> 3.4)
     - NSObject-SafeExpectations (= 0.0.4)
@@ -123,7 +123,7 @@ SPEC CHECKSUMS:
   Specta: 3e1bd89c3517421982dc4d1c992503e48bd5fe66
   SVProgressHUD: 1428aafac632c1f86f62aa4243ec12008d7a51d6
   UIDeviceIdentifier: f4bf3b343581a1beacdbf5fb1a8825bd5f05a4a4
-  WordPressKit: d084acd74bafd78d70ccb95686ceb927c825324e
+  WordPressKit: 6fde9c226f9570e7c440c315a93b58a507dc8db1
   WordPressShared: 38cb62e9cb998d4dc3c1611f17934c6875a6b3e8
   WordPressUI: 1cf47a3b78154faf69caa18569ee7ece1e510fa0
   wpxmlrpc: bf55a43a7e710bd2a4fb8c02dfe83b1246f14f13

WordPressAuthenticator.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name          = "WordPressAuthenticator"
-  s.version       = "1.33.0-beta.3"
+  s.version       = "1.33.0-beta.4"
   s.summary       = "WordPressAuthenticator implements an easy and elegant way to authenticate your WordPress Apps."
 
   s.description   = <<-DESC

WordPressAuthenticator/Authenticator/WordPressAuthenticator.swift

@@ -1,10 +1,11 @@
-import UIKit
+import AuthenticationServices
 import CocoaLumberjack
-import NSURL_IDN
 import GoogleSignIn
+import NSURL_IDN
+import UIKit
 import WordPressShared
 import WordPressUI
-import AuthenticationServices
+import WordPressKit
 
 // MARK: - WordPressAuthenticator: Public API to deal with WordPress.com and WordPress.org authentication.
 //
@@ -56,14 +57,9 @@ import AuthenticationServices
     ///
     @objc public static let WPSigninDidFinishNotification = "WPSigninDidFinishNotification"
 
-    /// Internal Constants.
+    /// The host name that identifies magic link URLs
     ///
-    private enum Constants {
-        static let authenticationInfoKey    = "authenticationInfoKey"
-        static let username                 = "username"
-        static let emailMagicLinkSource     = "emailMagicLinkSource"
-        static let magicLinkUrlPath         = "magic-login"
-    }
+    private static let magicLinkUrlHostname = "magic-login"
 
     // MARK: - Initialization
 
@@ -126,7 +122,7 @@ import AuthenticationServices
     /// Indicates if the received URL is a WordPress.com Authentication Callback.
     ///
     @objc public func isWordPressAuthUrl(_ url: URL) -> Bool {
-        let expectedPrefix = configuration.wpcomScheme + "://" + Constants.magicLinkUrlPath
+        let expectedPrefix = configuration.wpcomScheme + "://" + Self.magicLinkUrlHostname
         return url.absoluteString.hasPrefix(expectedPrefix)
     }
 
@@ -138,8 +134,8 @@ import AuthenticationServices
 
     /// Attempts to process the specified URL as a WordPress Authentication Link. Returns *true* on success.
     ///
-    @objc public func handleWordPressAuthUrl(_ url: URL, rootViewController: UIViewController) -> Bool {
-        return WordPressAuthenticator.openAuthenticationURL(url, fromRootViewController: rootViewController)
+    @objc public func handleWordPressAuthUrl(_ url: URL, rootViewController: UIViewController, automatedTesting: Bool = false) -> Bool {
+        return WordPressAuthenticator.openAuthenticationURL(url, fromRootViewController: rootViewController, automatedTesting: automatedTesting)
     }
 
 
@@ -309,68 +305,91 @@ import AuthenticationServices
 
     // MARK: - Authentication Link Helpers
 
-
     /// Present a signin view controller to handle an authentication link.
     ///
     /// - Parameters:
     ///     - url: The authentication URL
-    ///     - rootViewController: The view controller to act as the presenter for the signin view controller.
-    ///                           By convention this is the app's root vc.
+    ///     - rootViewController: The view controller to act as the presenter for the signin view controller.  By convention this is the app's root vc.
+    ///     - automatedTesting: for calling this method for automated testing.  It won't sync the account or load any other VCs.
     ///
-    @objc public class func openAuthenticationURL(_ url: URL, fromRootViewController rootViewController: UIViewController) -> Bool {
-        guard let token = url.query?.dictionaryFromQueryString().string(forKey: "token") else {
-            DDLogError("Signin Error: The authentication URL did not have the expected path.")
+    @objc public class func openAuthenticationURL(
+        _ url: URL,
+        fromRootViewController rootViewController: UIViewController,
+        automatedTesting: Bool = false) -> Bool {
+
+        guard let queryDictionary = url.query?.dictionaryFromQueryString() else {
+            DDLogError("Magic link error: we couldn't retrieve the query dictionary from the sign-in URL.")
             return false
         }
-
-        let loginFields = retrieveLoginInfoForTokenAuth()
-
+        
+        guard let authToken = queryDictionary.string(forKey: "token") else {
+            DDLogError("Magic link error: we couldn't retrieve the authentication token from the sign-in URL.")
+            return false
+        }
+        
+        guard let flowRawValue = queryDictionary.string(forKey: "flow") else {
+            DDLogError("Magic link error: we couldn't retrieve the flow from the sign-in URL.")
+            return false
+        }
+        
+        let loginFields = LoginFields()
+        
         if url.isJetpackConnect {
             loginFields.meta.jetpackLogin = true
         }
-
-        let storyboard = Storyboard.emailMagicLink.instance
-        guard let loginController = storyboard.instantiateViewController(withIdentifier: "LinkAuthView") as? NUXLinkAuthViewController else {
-            DDLogInfo("App opened with authentication link but couldn't create login screen.")
+        
+        // We could just use the flow, but since `MagicLinkFlow` is an ObjC enum, it always
+        // allows a `default` value.  By mapping the ObjC enum to a Swift enum we can avoid that afterwards.
+        let flow: NUXLinkAuthViewController.Flow
+        
+        switch MagicLinkFlow(rawValue: flowRawValue) {
+        case .signup:
+            flow = .signup
+            loginFields.meta.emailMagicLinkSource = .signup
+            Self.track(.signupMagicLinkOpened)
+        case .login:
+            flow = .login
+            loginFields.meta.emailMagicLinkSource = .login
+            Self.track(.loginMagicLinkOpened)
+        default:
+            DDLogError("Magic link error: the flow should be either `signup` or `login`. We can't handle an unsupported flow.")
             return false
         }
-        loginController.loginFields = loginFields
-        loginController.token = token
-        let controller = loginController
-
-        if let linkSource = loginFields.meta.emailMagicLinkSource {
-            switch linkSource {
-            case .signup:
-                WordPressAuthenticator.track(.signupMagicLinkOpened)
-            case .login:
-                WordPressAuthenticator.track(.loginMagicLinkOpened)
+        
+        if !automatedTesting {
+            let storyboard = Storyboard.emailMagicLink.instance
+            guard let loginVC = storyboard.instantiateViewController(withIdentifier: "LinkAuthView") as? NUXLinkAuthViewController else {
+                DDLogInfo("App opened with authentication link but couldn't create login screen.")
+                return false
             }
+            loginVC.loginFields = loginFields
+            
+            let navController = LoginNavigationController(rootViewController: loginVC)
+            navController.modalPresentationStyle = .fullScreen
+            
+            // The way the magic link flow works some view controller might
+            // still be presented when the app is resumed by tapping on the auth link.
+            // We need to do a little work to present the SigninLinkAuth controller
+            // from the right place.
+            // - If the rootViewController is not presenting another vc then just
+            // present the auth controller.
+            // - If the rootViewController is presenting another NUX vc, dismiss the
+            // NUX vc then present the auth controller.
+            // - If the rootViewController is presenting *any* other vc, present the
+            // auth controller from the presented vc.
+            let presenter = rootViewController.topmostPresentedViewController
+            if presenter.isKind(of: NUXNavigationController.self) || presenter.isKind(of: LoginNavigationController.self),
+                let parent = presenter.presentingViewController {
+                parent.dismiss(animated: false, completion: {
+                    parent.present(navController, animated: false, completion: nil)
+                })
+            } else {
+                presenter.present(navController, animated: false, completion: nil)
+            }
+            
+            loginVC.syncAndContinue(authToken: authToken, flow: flow, isJetpackConnect: url.isJetpackConnect)
         }
-
-        let navController = LoginNavigationController(rootViewController: controller)
-        navController.modalPresentationStyle = .fullScreen
-
-        // The way the magic link flow works some view controller might
-        // still be presented when the app is resumed by tapping on the auth link.
-        // We need to do a little work to present the SigninLinkAuth controller
-        // from the right place.
-        // - If the rootViewController is not presenting another vc then just
-        // present the auth controller.
-        // - If the rootViewController is presenting another NUX vc, dismiss the
-        // NUX vc then present the auth controller.
-        // - If the rootViewController is presenting *any* other vc, present the
-        // auth controller from the presented vc.
-        let presenter = rootViewController.topmostPresentedViewController
-        if presenter.isKind(of: NUXNavigationController.self) || presenter.isKind(of: LoginNavigationController.self),
-            let parent = presenter.presentingViewController {
-            parent.dismiss(animated: false, completion: {
-                parent.present(navController, animated: false, completion: nil)
-            })
-        } else {
-            presenter.present(navController, animated: false, completion: nil)
-        }
-
-        deleteLoginInfoForTokenAuth()
+        
         return true
     }
 
@@ -409,58 +428,6 @@ import AuthenticationServices
         return path
     }
 
-
-    // MARK: - Helpers for Saved Magic Link Info
-
-    /// Saves certain login information in NSUserDefaults
-    ///
-    /// - Parameter loginFields: The loginFields instance from which to save.
-    ///
-    class func storeLoginInfoForTokenAuth(_ loginFields: LoginFields) {
-        var dict: [String: String] = [
-            Constants.username: loginFields.username
-        ]
-
-        if let linkSource = loginFields.meta.emailMagicLinkSource {
-            dict[Constants.emailMagicLinkSource] = String(linkSource.rawValue)
-        }
-
-        UserDefaults.standard.set(dict, forKey: Constants.authenticationInfoKey)
-    }
-
-
-    /// Retrieves stored login information if any.
-    ///
-    /// - Returns: A loginFields instance or nil.
-    ///
-    class func retrieveLoginInfoForTokenAuth() -> LoginFields {
-
-        let loginFields = LoginFields()
-
-        guard let dict = UserDefaults.standard.dictionary(forKey: Constants.authenticationInfoKey) else {
-            return loginFields
-        }
-
-        if let username = dict[Constants.username] as? String {
-            loginFields.username = username
-        }
-
-        if let linkSource = dict[Constants.emailMagicLinkSource] as? String,
-            let linkSourceRawValue = Int(linkSource) {
-            loginFields.meta.emailMagicLinkSource = EmailMagicLinkSource(rawValue: linkSourceRawValue)
-        }
-
-        return loginFields
-    }
-
-
-    /// Removes stored login information from NSUserDefaults
-    ///
-    class func deleteLoginInfoForTokenAuth() {
-        UserDefaults.standard.removeObject(forKey: Constants.authenticationInfoKey)
-    }
-
-
     // MARK: - Other Helpers
 
 

WordPressAuthenticator/Credentials/WordPressComCredentials.swift

@@ -19,17 +19,19 @@ public struct WordPressComCredentials: Equatable {
     /// The site address used during login
     ///
     public var siteURL: String
-
-    /// Designated initializer
+    
+    private let wpComURL = "https://wordpress.com"
+    
+    /// Legacy  initializer, for backwards compatibility
     ///
     public init(authToken: String,
                 isJetpackLogin: Bool,
                 multifactor: Bool,
-                siteURL: String) {
+                siteURL: String = "https://wordpress.com") {
         self.authToken = authToken
         self.isJetpackLogin = isJetpackLogin
         self.multifactor = multifactor
-        self.siteURL = !siteURL.isEmpty ? siteURL : "https://wordpress.com"
+        self.siteURL = !siteURL.isEmpty ? siteURL : wpComURL
     }
 }
 

WordPressAuthenticator/NUX/NUXLinkAuthViewController.swift

@@ -9,31 +9,28 @@ import WordPressShared
 ///
 class NUXLinkAuthViewController: LoginViewController {
     @IBOutlet weak var statusLabel: UILabel?
-    @objc var token: String = ""
-    @objc var didSync: Bool = false
-
-    override func viewDidAppear(_ animated: Bool) {
-        super.viewDidAppear(animated)
-
-        // Gotta have a token to use this vc
-        assert(!token.isEmpty, "Email token cannot be nil")
-
-        if didSync {
-            return
-        }
-
-        didSync = true // Make sure we don't call this twice by accident
+    
+    enum Flow {
+        case signup
+        case login
+    }
 
-        let wpcom = WordPressComCredentials(authToken: token, isJetpackLogin: isJetpackLogin, multifactor: false, siteURL: loginFields.siteAddress)
+    /// Displays the specified text in the status label.
+    ///
+    /// - Parameter message: The text to display in the label.
+    ///
+    override func configureStatusLabel(_ message: String) {
+        statusLabel?.text = message
+    }
+    
+    func syncAndContinue(authToken: String, flow: Flow, isJetpackConnect: Bool) {
+        let wpcom = WordPressComCredentials(authToken: authToken, isJetpackLogin: isJetpackConnect, multifactor: false, siteURL: "https://wordpress.com")
         let credentials = AuthenticatorCredentials(wpcom: wpcom)
 
-        tracker.track(step: .success)
-        syncWPComAndPresentEpilogue(credentials: credentials)
-
-        // Count this as success since we're authed. Even if there is a glitch
-        // while syncing the user has valid credentials.
-        if let linkSource = loginFields.meta.emailMagicLinkSource {
-            switch linkSource {
+        syncWPComAndPresentEpilogue(credentials: credentials) {
+            self.tracker.track(step: .success)
+            
+            switch flow {
             case .signup:
                 // This stat is part of a funnel that provides critical information.  Before
                 // making ANY modification to this stat please refer to: p4qSXL-35X-p2
@@ -44,12 +41,4 @@ class NUXLinkAuthViewController: LoginViewController {
             }
         }
     }
-
-    /// Displays the specified text in the status label.
-    ///
-    /// - Parameter message: The text to display in the label.
-    ///
-    override func configureStatusLabel(_ message: String) {
-        statusLabel?.text = message
-    }
 }

WordPressAuthenticator/Services/WordPressComAccountService.swift

@@ -51,7 +51,7 @@ class WordPressComAccountService {
         remote.requestWPComAuthLink(forEmail: email,
                                     clientID: configuration.wpcomClientId,
                                     clientSecret: configuration.wpcomSecret,
-                                    jetpackLogin: jetpackLogin,
+                                    source: jetpackLogin ? .jetpackConnect : .default,
                                     wpcomScheme: configuration.wpcomScheme,
                                     success: success,
                                     failure: { error in

WordPressAuthenticator/Signin/LoginLinkRequestViewController.swift

@@ -154,7 +154,6 @@ class LoginLinkRequestViewController: LoginViewController {
 
     @objc func didRequestAuthenticationLink() {
         WordPressAuthenticator.track(.loginMagicLinkRequested)
-        WordPressAuthenticator.storeLoginInfoForTokenAuth(loginFields)
 
         guard let vc = NUXLinkMailViewController.instantiate(from: .emailMagicLink) else {
             DDLogError("Failed to navigate to NUXLinkMailViewController")