Prompt to store cards and identities (#76)

Task/Issue URL: https://app.asana.com/0/0/1201938691568505/f
iOS PR: duckduckgo/iOS#1086
macOS PR: duckduckgo/macos-browser#461

Optional:

CC: @brindy

Description:

This PR updates BrowserServicesKit to handle the new pmHandlerStoreData call. As a part of this, it runs some logic to look up whether the provided payment method or address already exist in the database.

Steps to test this PR:

See macOS PR for more information

Sources/BrowserServicesKit/Autofill/AutofillUserScript+SecureVault.swift

@@ -28,7 +28,7 @@ public protocol AutofillSecureVaultDelegate: AnyObject {
     ) -> Void)
 
     func autofillUserScript(_: AutofillUserScript, didRequestPasswordManagerForDomain domain: String)
-    func autofillUserScript(_: AutofillUserScript, didRequestStoreCredentialsForDomain domain: String, username: String, password: String)
+    func autofillUserScript(_: AutofillUserScript, didRequestStoreDataForDomain domain: String, data: AutofillUserScript.DetectedAutofillData)
     func autofillUserScript(_: AutofillUserScript, didRequestAccountsForDomain domain: String,
                             completionHandler: @escaping ([SecureVaultModels.WebsiteAccount]) -> Void)
     func autofillUserScript(_: AutofillUserScript, didRequestCredentialsForAccount accountId: Int64,
@@ -84,7 +84,7 @@ extension AutofillUserScript {
                                   addressPostalCode: identity.addressPostalCode,
                                   addressCountryCode: identity.addressCountryCode,
                                   phone: identity.homePhone, // Replace with single "phone number" column
-                                  emailAddress: identity.emailAddress)
+                                  emailAddress: identity.emailAddress ?? "")
         }
     }
 
@@ -131,6 +131,60 @@ extension AutofillUserScript {
         let id: Int64
         let username: String
     }
+
+    // MARK: - Requests
+
+    public struct IncomingCredentials {
+
+        private enum Constants {
+            static let credentialsKey = "credentials"
+            static let usernameKey = "username"
+            static let passwordKey = "password"
+        }
+
+        let username: String?
+        let password: String
+
+        init(username: String?, password: String) {
+            self.username = username
+            self.password = password
+        }
+
+        init?(autofillDictionary: [String: Any]) {
+            guard let credentialsDictionary = autofillDictionary[Constants.credentialsKey] as? [String: String],
+                  let password = credentialsDictionary[Constants.passwordKey] else {
+                      return nil
+                  }
+
+            // Usernames are optional, as the Autofill script can pass a generated password through without a corresponding username.
+            self.init(username: credentialsDictionary[Constants.usernameKey], password: password)
+        }
+
+    }
+
+    /// Represents the incoming Autofill data provided by the user script.
+    ///
+    /// Identities and Credit Cards can be converted to their final model objects directly, but credentials cannot as they have to looked up in the Secure Vault first, hence the existence of a standalone
+    /// `IncomingCredentials` type.
+    public struct DetectedAutofillData {
+
+        public let identity: SecureVaultModels.Identity?
+        public let credentials: IncomingCredentials?
+        public let creditCard: SecureVaultModels.CreditCard?
+
+        init(dictionary: [String: Any]) {
+            self.identity = .init(autofillDictionary: dictionary)
+            self.creditCard = .init(autofillDictionary: dictionary)
+            self.credentials = IncomingCredentials(autofillDictionary: dictionary)
+        }
+
+        init(identity: SecureVaultModels.Identity?, credentials: AutofillUserScript.IncomingCredentials?, creditCard: SecureVaultModels.CreditCard?) {
+            self.identity = identity
+            self.credentials = credentials
+            self.creditCard = creditCard
+        }
+
+    }
 
     // MARK: - Responses
 
@@ -210,20 +264,20 @@ extension AutofillUserScript {
         }
 
     }
-
-    func pmStoreCredentials(_ message: AutofillMessage, _ replyHandler: @escaping MessageReplyHandler) {
+     
+    func pmStoreData(_ message: AutofillMessage, _ replyHandler: @escaping MessageReplyHandler) {
         defer {
             replyHandler(nil)
         }
-
-        guard let body = message.messageBody as? [String: Any],
-              let username = body["username"] as? String,
-              let password = body["password"] as? String else {
+
+        guard let body = message.messageBody as? [String: Any] else {
             return
         }
-
+
+        let incomingData = DetectedAutofillData(dictionary: body)
         let domain = hostProvider.hostForMessage(message)
-        vaultDelegate?.autofillUserScript(self, didRequestStoreCredentialsForDomain: domain, username: username, password: password)
+
+        vaultDelegate?.autofillUserScript(self, didRequestStoreDataForDomain: domain, data: incomingData)
     }
 
     func pmGetAccounts(_ message: AutofillMessage, _ replyHandler: @escaping MessageReplyHandler) {

Sources/BrowserServicesKit/Autofill/AutofillUserScript.swift

@@ -18,6 +18,7 @@
 //
 
 import WebKit
+import os.log
 
 public class AutofillUserScript: NSObject, UserScript {
 
@@ -35,7 +36,7 @@ public class AutofillUserScript: NSObject, UserScript {
 
         case pmHandlerGetAutofillInitData
 
-        case pmHandlerStoreCredentials
+        case pmHandlerStoreData
         case pmHandlerGetAccounts
         case pmHandlerGetAutofillCredentials
         case pmHandlerGetIdentity
@@ -80,8 +81,11 @@ public class AutofillUserScript: NSObject, UserScript {
 
     internal func messageHandlerFor(_ messageName: String) -> MessageHandler? {
         guard let message = MessageName(rawValue: messageName) else {
+            os_log("Failed to parse Autofill User Script message: '%{public}s'", log: .userScripts, type: .debug, messageName)
             return nil
         }
+
+        os_log("AutofillUserScript: received '%{public}s'", log: .userScripts, type: .debug, messageName)
 
         switch message {
             case .emailHandlerStoreToken: return emailStoreToken
@@ -93,10 +97,9 @@ public class AutofillUserScript: NSObject, UserScript {
 
             case .pmHandlerGetAutofillInitData: return pmGetAutoFillInitData
 
-            case .pmHandlerStoreCredentials: return pmStoreCredentials
+            case .pmHandlerStoreData: return pmStoreData
             case .pmHandlerGetAccounts: return pmGetAccounts
             case .pmHandlerGetAutofillCredentials: return pmGetAutofillCredentials
-
             case .pmHandlerGetIdentity: return pmGetIdentity
             case .pmHandlerGetCreditCard: return pmGetCreditCard
 

Sources/BrowserServicesKit/Common/Extensions/StringExtension.swift

@@ -37,5 +37,23 @@ extension String {
     func encodingPlusesAsSpaces() -> String {
         return replacingOccurrences(of: "+", with: "%20")
     }
+
+    func removingCharacters(in set: CharacterSet) -> String {
+      let filtered = unicodeScalars.filter { !set.contains($0) }
+      return String(String.UnicodeScalarView(filtered))
+    }
+
+    func autofillNormalized() -> String {
+        let autofillCharacterSet = CharacterSet.whitespacesAndNewlines.union(.punctuationCharacters).union(.symbols)
+
+        var normalizedString = self
+
+        normalizedString = normalizedString.removingCharacters(in: autofillCharacterSet)
+        normalizedString = normalizedString.folding(options: .diacriticInsensitive, locale: .current)
+        normalizedString = normalizedString.localizedLowercase
+
+        return normalizedString
+    }
 
 }
+

Sources/BrowserServicesKit/Common/Logging.swift

@@ -0,0 +1,43 @@
+//
+//  Logging.swift
+//  DuckDuckGo
+//
+//  Copyright © 2022 DuckDuckGo. All rights reserved.
+//
+//  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
+import os
+
+extension OSLog {
+
+    static var userScripts: OSLog {
+        Logging.userScriptsEnabled ? Logging.userScriptsLog : .disabled
+    }
+
+    static var passwordManager: OSLog {
+        Logging.passwordManagerEnabled ? Logging.passwordManagerLog : .disabled
+    }
+
+}
+
+struct Logging {
+
+    fileprivate static let userScriptsEnabled = false
+    fileprivate static let userScriptsLog: OSLog = OSLog(subsystem: Bundle.main.bundleIdentifier ?? "DuckDuckGo", category: "User Scripts")
+
+    fileprivate static let passwordManagerEnabled = false
+    fileprivate static let passwordManagerLog: OSLog = OSLog(subsystem: Bundle.main.bundleIdentifier ?? "DuckDuckGo", category: "Password Manager")
+
+}

Sources/BrowserServicesKit/SecureVault/CreditCardValidation.swift

@@ -31,7 +31,7 @@ public struct CreditCardValidation {
 
         case unknown
 
-        var displayName: String {
+        public var displayName: String {
             switch self {
             case .amex:
                 return "American Express"

Sources/BrowserServicesKit/SecureVault/SecureVault.swift

@@ -46,12 +46,14 @@ public protocol SecureVault {
 
     func identities() throws -> [SecureVaultModels.Identity]
     func identityFor(id: Int64) throws -> SecureVaultModels.Identity?
+    func existingIdentityForAutofill(matching proposedIdentity: SecureVaultModels.Identity) throws -> SecureVaultModels.Identity?
     @discardableResult
     func storeIdentity(_ identity: SecureVaultModels.Identity) throws -> Int64
     func deleteIdentityFor(identityId: Int64) throws
 
     func creditCards() throws -> [SecureVaultModels.CreditCard]
     func creditCardFor(id: Int64) throws -> SecureVaultModels.CreditCard?
+    func existingCardForAutofill(matching proposedCard: SecureVaultModels.CreditCard) throws -> SecureVaultModels.CreditCard?
     @discardableResult
     func storeCreditCard(_ card: SecureVaultModels.CreditCard) throws -> Int64
     func deleteCreditCardFor(cardId: Int64) throws
@@ -275,6 +277,14 @@ class DefaultSecureVault: SecureVault {
             try self.providers.database.deleteIdentityForIdentityId(identityId)
         }
     }
+
+    func existingIdentityForAutofill(matching proposedIdentity: SecureVaultModels.Identity) throws -> SecureVaultModels.Identity? {
+        let identities = try self.identities()
+
+        return identities.first { existingIdentity in
+            existingIdentity.hasAutofillEquality(comparedTo: proposedIdentity)
+        }
+    }
 
     // MARK: - Credit Cards
 
@@ -304,6 +314,14 @@ class DefaultSecureVault: SecureVault {
             return card
         }
     }
+
+    func existingCardForAutofill(matching proposedCard: SecureVaultModels.CreditCard) throws -> SecureVaultModels.CreditCard? {
+        let cards = try self.creditCards()
+
+        return cards.first { existingCard in
+            existingCard.hasAutofillEquality(comparedTo: proposedCard)
+        }
+    }
 
     @discardableResult
     func storeCreditCard(_ card: SecureVaultModels.CreditCard) throws -> Int64 {

Sources/BrowserServicesKit/SecureVault/SecureVaultDatabaseProvider.swift

@@ -878,6 +878,9 @@ extension SecureVaultModels.Identity: PersistableRecord, FetchableRecord {
         homePhone = row[Columns.homePhone]
         mobilePhone = row[Columns.mobilePhone]
         emailAddress = row[Columns.emailAddress]
+
+        autofillEqualityName = normalizedAutofillName()
+        autofillEqualityAddressStreet = addressStreet?.autofillNormalized()
     }
 
     public func encode(to container: inout PersistenceContainer) {