Issue mozilla-mobile#9838: Introduce CreditCardValidationDelegate and…

… implement onCreditCardSave in GeckoCreditCardsAddressesStorageDelegate - Introduces `CreditCardValidationDelegate` and a default implementation in `DefaultCreditCardValidationDelegate` - Implements `onCreditCardSave` in `GeckoCreditCardsAddressesStorageDelegate` - Refactors `CreditCard` from concept-engine to `CreditCardEntry` in concept-storage so that it can validated with the `CreditCardValidationDelegate`
gabrielluong · Apr 5, 2022 · e9854db · e9854db
1 parent 6dc0754
commit e9854db
Show file tree

Hide file tree

Showing 28 changed files with 550 additions and 215 deletions.
diff --git a/...java/mozilla/components/browser/engine/gecko/autofill/GeckoAutocompleteStorageDelegate.kt b/...java/mozilla/components/browser/engine/gecko/autofill/GeckoAutocompleteStorageDelegate.kt
@@ -31,15 +31,17 @@ class GeckoAutocompleteStorageDelegate(
     private val loginStorageDelegate: LoginStorageDelegate
 ) : Autocomplete.StorageDelegate {
 
-    override fun onCreditCardFetch(): GeckoResult<Array<Autocomplete.CreditCard>>? {
+    override fun onCreditCardFetch(): GeckoResult<Array<Autocomplete.CreditCard>> {
         val result = GeckoResult<Array<Autocomplete.CreditCard>>()
 
         @OptIn(DelicateCoroutinesApi::class)
         GlobalScope.launch(IO) {
-            val creditCards = creditCardsAddressesStorageDelegate.onCreditCardsFetch().await()
+            val key = creditCardsAddressesStorageDelegate.getOrGenerateKey()
+
+            val creditCards = creditCardsAddressesStorageDelegate.onCreditCardsFetch()
                 .mapNotNull {
                     val plaintextCardNumber =
-                        creditCardsAddressesStorageDelegate.decrypt(it.encryptedCardNumber)?.number
+                        creditCardsAddressesStorageDelegate.decrypt(key, it.encryptedCardNumber)?.number
 
                     if (plaintextCardNumber == null) {
                         null
@@ -54,6 +56,7 @@ class GeckoAutocompleteStorageDelegate(
                     }
                 }
                 .toTypedArray()
+
             result.complete(creditCards)
         }
 
@@ -64,7 +67,7 @@ class GeckoAutocompleteStorageDelegate(
         loginStorageDelegate.onLoginSave(login.toLoginEntry())
     }
 
-    override fun onLoginFetch(domain: String): GeckoResult<Array<Autocomplete.LoginEntry>>? {
+    override fun onLoginFetch(domain: String): GeckoResult<Array<Autocomplete.LoginEntry>> {
         val result = GeckoResult<Array<Autocomplete.LoginEntry>>()
 
         @OptIn(DelicateCoroutinesApi::class)

diff --git a/...wser/engine-gecko/src/main/java/mozilla/components/browser/engine/gecko/ext/CreditCard.kt b/...wser/engine-gecko/src/main/java/mozilla/components/browser/engine/gecko/ext/CreditCard.kt
@@ -4,14 +4,14 @@
 
 package mozilla.components.browser.engine.gecko.ext
 
-import mozilla.components.concept.engine.prompt.CreditCard
+import mozilla.components.concept.storage.CreditCardEntry
 import mozilla.components.support.utils.creditCardIIN
 import org.mozilla.geckoview.Autocomplete
 
 /**
- * Converts a GeckoView [Autocomplete.CreditCard] to an Android Components [CreditCard].
+ * Converts a GeckoView [Autocomplete.CreditCard] to an Android Components [CreditCardEntry].
  */
-fun Autocomplete.CreditCard.toCreditCard() = CreditCard(
+fun Autocomplete.CreditCard.toCreditCardEntry() = CreditCardEntry(
     guid = guid,
     name = name,
     number = number,
@@ -21,9 +21,9 @@ fun Autocomplete.CreditCard.toCreditCard() = CreditCard(
 )
 
 /**
- * Converts an Android Components [CreditCard] to a GeckoView [Autocomplete.CreditCard].
+ * Converts an Android Components [CreditCardEntry] to a GeckoView [Autocomplete.CreditCard].
  */
-fun CreditCard.toAutocompleteCreditCard() = Autocomplete.CreditCard.Builder()
+fun CreditCardEntry.toAutocompleteCreditCard() = Autocomplete.CreditCard.Builder()
     .guid(guid)
     .name(name)
     .number(number)

diff --git a/...gecko/src/main/java/mozilla/components/browser/engine/gecko/prompt/GeckoPromptDelegate.kt b/...gecko/src/main/java/mozilla/components/browser/engine/gecko/prompt/GeckoPromptDelegate.kt
@@ -9,15 +9,15 @@ import android.net.Uri
 import androidx.annotation.VisibleForTesting
 import mozilla.components.browser.engine.gecko.GeckoEngineSession
 import mozilla.components.browser.engine.gecko.ext.toAutocompleteCreditCard
-import mozilla.components.browser.engine.gecko.ext.toCreditCard
+import mozilla.components.browser.engine.gecko.ext.toCreditCardEntry
 import mozilla.components.browser.engine.gecko.ext.toLoginEntry
 import mozilla.components.concept.engine.prompt.Choice
-import mozilla.components.concept.engine.prompt.CreditCard
 import mozilla.components.concept.engine.prompt.PromptRequest
 import mozilla.components.concept.engine.prompt.PromptRequest.MenuChoice
 import mozilla.components.concept.engine.prompt.PromptRequest.MultipleChoice
 import mozilla.components.concept.engine.prompt.PromptRequest.SingleChoice
 import mozilla.components.concept.engine.prompt.ShareData
+import mozilla.components.concept.storage.CreditCardEntry
 import mozilla.components.concept.storage.Login
 import mozilla.components.concept.storage.LoginEntry
 import mozilla.components.support.base.log.logger.Logger
@@ -77,7 +77,7 @@ internal class GeckoPromptDelegate(private val geckoEngineSession: GeckoEngineSe
     ): GeckoResult<PromptResponse>? {
         val geckoResult = GeckoResult<PromptResponse>()
 
-        val onConfirm: (CreditCard) -> Unit = { creditCard ->
+        val onConfirm: (CreditCardEntry) -> Unit = { creditCard ->
             if (!request.isComplete) {
                 geckoResult.complete(
                     request.confirm(
@@ -94,7 +94,7 @@ internal class GeckoPromptDelegate(private val geckoEngineSession: GeckoEngineSe
         geckoEngineSession.notifyObservers {
             onPromptRequest(
                 PromptRequest.SelectCreditCard(
-                    creditCards = request.options.map { it.value.toCreditCard() },
+                    creditCards = request.options.map { it.value.toCreditCardEntry() },
                     onDismiss = onDismiss,
                     onConfirm = onConfirm
                 )

diff --git a/...o/src/test/java/mozilla/components/browser/engine/gecko/prompt/GeckoPromptDelegateTest.kt b/...o/src/test/java/mozilla/components/browser/engine/gecko/prompt/GeckoPromptDelegateTest.kt
@@ -12,10 +12,10 @@ import mozilla.components.browser.engine.gecko.ext.toAutocompleteCreditCard
 import mozilla.components.browser.engine.gecko.ext.toLoginEntry
 import mozilla.components.concept.engine.EngineSession
 import mozilla.components.concept.engine.prompt.Choice
-import mozilla.components.concept.engine.prompt.CreditCard
 import mozilla.components.concept.engine.prompt.PromptRequest
 import mozilla.components.concept.engine.prompt.PromptRequest.MultipleChoice
 import mozilla.components.concept.engine.prompt.PromptRequest.SingleChoice
+import mozilla.components.concept.storage.CreditCardEntry
 import mozilla.components.concept.storage.Login
 import mozilla.components.concept.storage.LoginEntry
 import mozilla.components.support.ktx.kotlin.toDate
@@ -850,7 +850,7 @@ class GeckoPromptDelegateTest {
             }
         })
 
-        val creditCard1 = CreditCard(
+        val creditCard1 = CreditCardEntry(
             guid = "1",
             name = "Banana Apple",
             number = "4111111111111110",
@@ -861,7 +861,7 @@ class GeckoPromptDelegateTest {
         val creditCardSelectOption1 =
             Autocomplete.CreditCardSelectOption(creditCard1.toAutocompleteCreditCard())
 
-        val creditCard2 = CreditCard(
+        val creditCard2 = CreditCardEntry(
             guid = "2",
             name = "Orange Pineapple",
             number = "4111111111115555",

diff --git a/...nents/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/CreditCard.kt b/...nents/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/CreditCard.kt
diff --git a/...ts/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt b/...ts/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt
@@ -9,6 +9,7 @@ import android.net.Uri
 import mozilla.components.concept.engine.prompt.PromptRequest.Authentication.Level
 import mozilla.components.concept.engine.prompt.PromptRequest.Authentication.Method
 import mozilla.components.concept.engine.prompt.PromptRequest.TimeSelection.Type
+import mozilla.components.concept.storage.CreditCardEntry
 import mozilla.components.concept.storage.Login
 import mozilla.components.concept.storage.LoginEntry
 import java.util.UUID
@@ -93,13 +94,13 @@ sealed class PromptRequest(
 
     /**
      * Value type that represents a request for a select credit card prompt.
-     * @property creditCards a list of [CreditCard]s to select from.
+     * @property creditCards a list of [CreditCardEntry]s to select from.
      * @property onConfirm callback that is called when the user confirms the credit card selection.
      * @property onDismiss callback to let the page know the user dismissed the dialog.
      */
     data class SelectCreditCard(
-        val creditCards: List<CreditCard>,
-        val onConfirm: (CreditCard) -> Unit,
+        val creditCards: List<CreditCardEntry>,
+        val onConfirm: (CreditCardEntry) -> Unit,
         override val onDismiss: () -> Unit
     ) : PromptRequest(), Dismissible
 

diff --git a/...s/concept/engine/src/test/java/mozilla/components/concept/engine/prompt/CreditCardTest.kt b/...s/concept/engine/src/test/java/mozilla/components/concept/engine/prompt/CreditCardTest.kt
diff --git a/...oncept/engine/src/test/java/mozilla/components/concept/engine/prompt/PromptRequestTest.kt b/...oncept/engine/src/test/java/mozilla/components/concept/engine/prompt/PromptRequestTest.kt
@@ -20,6 +20,7 @@ import mozilla.components.concept.engine.prompt.PromptRequest.SingleChoice
 import mozilla.components.concept.engine.prompt.PromptRequest.TextPrompt
 import mozilla.components.concept.engine.prompt.PromptRequest.TimeSelection
 import mozilla.components.concept.engine.prompt.PromptRequest.TimeSelection.Type
+import mozilla.components.concept.storage.CreditCardEntry
 import mozilla.components.concept.storage.Login
 import mozilla.components.concept.storage.LoginEntry
 import mozilla.components.support.test.mock
@@ -271,7 +272,7 @@ class PromptRequestTest {
 
     @Test
     fun `GIVEN a list of credit cards WHEN SelectCreditCard is confirmed or dismissed THEN their respective callback is invoked`() {
-        val creditCard = CreditCard(
+        val creditCard = CreditCardEntry(
             guid = "id",
             name = "Banana Apple",
             number = "4111111111111110",
@@ -281,7 +282,7 @@ class PromptRequestTest {
         )
         var onDismissCalled = false
         var onConfirmCalled = false
-        var confirmedCreditCard: CreditCard? = null
+        var confirmedCreditCard: CreditCardEntry? = null
 
         val selectCreditCardRequest = SelectCreditCard(
             creditCards = listOf(creditCard),

diff --git a/components/concept/storage/build.gradle b/components/concept/storage/build.gradle
@@ -27,6 +27,8 @@ dependencies {
     // dependency, but it will crash at runtime.
     // Included via 'api' because this module is unusable without coroutines.
     api Dependencies.kotlin_coroutines
+
+    implementation project(':support-ktx')
 }
 
 apply from: '../../../publish.gradle'