refactor: add feature toggle to support apple-only

duckduckgo · Dec 18, 2024 · fbec6fc · fbec6fc
1 parent 31fd22f
commit fbec6fc
Show file tree

Hide file tree

Showing 15 changed files with 124 additions and 138 deletions.
diff --git a/dist/autofill-debug.js b/dist/autofill-debug.js
diff --git a/dist/autofill.js b/dist/autofill.js
diff --git a/integration-test/helpers/mocks.webkit.js b/integration-test/helpers/mocks.webkit.js
@@ -244,6 +244,7 @@ export function createWebkitMocks(platform = 'macos') {
                                     password_generation: true,
                                     credentials_saving: true,
                                     inlineIcon_credentials: true,
+                                    partial_form_saves: true,
                                     email: true,
                                 },
                             },

diff --git a/integration-test/tests/save-prompts.android.spec.js b/integration-test/tests/save-prompts.android.spec.js
@@ -56,6 +56,7 @@ test.describe('Android Save prompts', () => {
                         androidStringReplacements({
                             featureToggles: {
                                 credentials_saving: true,
+                                partial_form_saves: false,
                             },
                             availableInputTypes: {
                                 credentials: { username: false, password: false },
@@ -81,11 +82,11 @@ test.describe('Android Save prompts', () => {
                 await login.submitPasswordOnlyForm(credentials);
                 await login.assertWasPromptedToSave(credentials);
             });
-            test('with username only (should prompt)', async ({ page }) => {
+            test('with username only (should NOT prompt)', async ({ page }) => {
                 const { login } = await setup(page);
                 const credentials = { username: '123456' };
                 await login.submitUsernameOnlyForm(credentials.username);
-                await login.shouldPromptToSave();
+                await login.shouldNotPromptToSave();
             });
         });
     });

diff --git a/integration-test/tests/save-prompts.windows.spec.js b/integration-test/tests/save-prompts.windows.spec.js
@@ -58,4 +58,31 @@ test.describe('Save prompts on windows', () => {
             await signup.assertWasNotPromptedToSaveWindows();
         });
     });
+
+    test.describe('When partial form saves are disabled', () => {
+        test('I should not be prompted to save for username only', async ({ page }) => {
+            // enable in-terminal exceptions
+            await forwardConsoleMessages(page);
+
+            const { personalAddress } = constants.fields.email;
+
+            const credentials = {
+                username: personalAddress,
+            };
+
+            const signup = signupPage(page);
+            await signup.navigate();
+
+            await createWindowsMocks()
+                .withFeatureToggles({
+                    partial_form_saves: false,
+                })
+                .applyTo(page);
+
+            await createAutofillScript().platform('windows').applyTo(page);
+
+            await signup.enterCredentials(credentials);
+            await signup.assertWasNotPromptedToSaveWindows();
+        });
+    });
 });
diff --git a/src/DeviceInterface/InterfacePrototype.js b/src/DeviceInterface/InterfacePrototype.js
@@ -785,17 +785,6 @@ class InterfacePrototype {
         }
     }
 
-    /**
-     * Checks if partial save can be triggered
-     * @param {DataStorageObject} values
-     * @returns {boolean}
-     */
-    shouldTriggerPartialSave(values) {
-        // If credentials has only username field, and no password field, then trigger is a partialSave
-        const isUsernameOnly = Object.keys(values?.credentials || {}).length === 1 && Boolean(values?.credentials?.username);
-        return isUsernameOnly && Boolean(this.settings.featureToggles.partial_form_saves);
-    }
-
     /**
      * `postSubmit` gives features a one-time-only opportunity to perform an
      * action directly after a form submission was observed.
@@ -810,15 +799,22 @@ class InterfacePrototype {
     postSubmit(values, form) {
         if (!form.form) return;
         if (!form.hasValues(values)) return;
-        const shouldPartialSave = this.shouldTriggerPartialSave(values);
-        const checks = [form.shouldPromptToStoreData && !form.submitHandlerExecuted, this.passwordGenerator.generated, shouldPartialSave];
+        const shouldTriggerPartialSave =
+            Object.keys(values?.credentials || {}).length === 1 &&
+            Boolean(values?.credentials?.username) &&
+            Boolean(this.settings.featureToggles.partial_form_saves);
+        const checks = [
+            form.shouldPromptToStoreData && !form.submitHandlerExecuted,
+            this.passwordGenerator.generated,
+            shouldTriggerPartialSave,
+        ];
         if (checks.some(Boolean)) {
             const formData = appendGeneratedKey(values, {
                 password: this.passwordGenerator.password,
                 username: this.emailProtection.lastGenerated,
             });
 
-            const trigger = shouldPartialSave ? 'partialSave' : 'formSubmission';
+            const trigger = shouldTriggerPartialSave ? 'partialSave' : 'formSubmission';
             this.storeFormData(formData, trigger);
         }
     }

diff --git a/src/Form/Form.js b/src/Form/Form.js
@@ -240,7 +240,7 @@ class Form {
      */
     getValuesReadyForStorage() {
         const formValues = this.getRawValues();
-        return prepareFormValuesForStorage(formValues);
+        return prepareFormValuesForStorage(formValues, this.device.settings.featureToggles.partial_form_saves);
     }
 
     /**

diff --git a/src/Form/Form.test.js b/src/Form/Form.test.js
@@ -84,8 +84,8 @@ describe('Test the form class reading values correctly', () => {
     <input type="password" value="" autocomplete="new-password" />
     <button type="submit">Sign up</button>
 </form>`,
-            expHasValues: true,
-            expValues: { credentials: { username: 'testUsername' } },
+            expHasValues: false,
+            expValues: { credentials: undefined },
         },
         {
             testCase: 'form where the password is <=3 characters long',
@@ -95,8 +95,8 @@ describe('Test the form class reading values correctly', () => {
     <input type="password" value="abc" autocomplete="new-password" />
     <button type="submit">Sign up</button>
 </form>`,
-            expHasValues: true,
-            expValues: { credentials: { username: 'testUsername' } },
+            expHasValues: false,
+            expValues: { credentials: undefined },
         },
         {
             testCase: 'form with hidden email field',

diff --git a/src/Form/formatters.js b/src/Form/formatters.js
@@ -161,14 +161,14 @@ const getMMAndYYYYFromString = (expiration) => {
 };
 
 /**
- * @param {InternalDataStorageObject} credentials
+ * @param {InternalDataStorageObject} data
  * @return {boolean}
  */
 const shouldStoreIdentities = ({ identities }) =>
     Boolean((identities.firstName || identities.fullName) && identities.addressStreet && identities.addressCity);
 
 /**
- * @param {InternalDataStorageObject} credentials
+ * @param {InternalDataStorageObject} data
  * @return {boolean}
  */
 const shouldStoreCreditCards = ({ creditCards }) => {
@@ -193,7 +193,7 @@ const formatPhoneNumber = (phone) => phone.replaceAll(/[^0-9|+]/g, '');
  * @param {InternalDataStorageObject} formValues
  * @return {DataStorageObject}
  */
-const prepareFormValuesForStorage = (formValues) => {
+const prepareFormValuesForStorage = (formValues, canTriggerPartialSave = false) => {
     /** @type {Partial<InternalDataStorageObject>} */
     let { credentials, identities, creditCards } = formValues;
 
@@ -203,13 +203,12 @@ const prepareFormValuesForStorage = (formValues) => {
     }
 
     /** Fixes for credentials */
-    if (!credentials.username && hasUsernameLikeIdentity(identities)) {
-        // @ts-ignore - We know that username is not a useful value here
-        credentials.username = identities.emailAddress || identities.phone;
-    }
-
-    // If we still don't have any credentials, we discard the object
-    if (Object.keys(credentials ?? {}).length === 0) {
+    if (canTriggerPartialSave || Boolean(formValues.credentials?.password)) {
+        if (credentials.password && !credentials.username && hasUsernameLikeIdentity(identities)) {
+            // @ts-ignore
+            credentials.username = identities.emailAddress || identities.phone;
+        }
+    } else {
         credentials = undefined;
     }