[Form] Trigger partialSave on username/email only form submit (#702)

* feat: add API call * feat: allow partial save in form submission * fix: don't need additional API * feat: update heuristics for save and update tests * feat: prompt when autofilled * chore: rebuild assets * fix: narrow down identities for partial save * chore: address PR comments * fix: make credentials storing more liberal * feat: preserve autosubmit * refactor: simply value storage * style: minor PR comments
duckduckgo · Dec 6, 2024 · 88982a3 · 88982a3
1 parent ca1722c
commit 88982a3
Show file tree

Hide file tree

Showing 18 changed files with 312 additions and 182 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/pages/loginPage.js b/integration-test/helpers/pages/loginPage.js
@@ -215,6 +215,12 @@ export function loginPage(page, opts = {}) {
             expect(mockCalls.length).toBe(0);
         }
 
+        async shouldPromptToSave() {
+            let mockCalls = [];
+            mockCalls = await mockedCalls(page, { names: ['storeFormData'] });
+            expect(mockCalls.length).toBeGreaterThan(0);
+        }
+
         /**
          * This is used mostly to avoid false negatives when we check for something _not_ happening.
          * Basically, you check that a specific call hasn't happened but the rest of the script ran just fine.

diff --git a/integration-test/tests/save-prompts.android.spec.js b/integration-test/tests/save-prompts.android.spec.js
@@ -81,11 +81,11 @@ test.describe('Android Save prompts', () => {
                 await login.submitPasswordOnlyForm(credentials);
                 await login.assertWasPromptedToSave(credentials);
             });
-            test('with username only (should NOT prompt)', async ({ page }) => {
+            test('with username only (should prompt)', async ({ page }) => {
                 const { login } = await setup(page);
                 const credentials = { username: '123456' };
                 await login.submitUsernameOnlyForm(credentials.username);
-                await login.promptWasNotShown();
+                await login.shouldPromptToSave();
             });
         });
     });

diff --git a/integration-test/tests/save-prompts.ios.spec.js b/integration-test/tests/save-prompts.ios.spec.js
@@ -105,12 +105,12 @@ test.describe('iOS Save prompts', () => {
                 await login.assertWasPromptedToSave(credentials);
             });
 
-            test('username only (should NOT prompt)', async ({ page }) => {
+            test('username only (should prompt)', async ({ page }) => {
                 const login = await setup(page);
 
                 const credentials = { username: '123456' };
                 await login.submitUsernameOnlyForm(credentials.username);
-                await login.shouldNotPromptToSave();
+                await login.shouldPromptToSave();
             });
         });
 

diff --git a/integration-test/tests/save-prompts.macos.spec.js b/integration-test/tests/save-prompts.macos.spec.js
@@ -64,7 +64,7 @@ test.describe('macos', () => {
                 await login.submitPasswordOnlyForm(credentials);
                 await login.assertWasPromptedToSave(credentials);
             });
-            test('username only (should NOT prompt)', async ({ page }) => {
+            test('username only (should prompt)', async ({ page }) => {
                 // enable in-terminal exceptions
                 await forwardConsoleMessages(page);
 
@@ -76,7 +76,7 @@ test.describe('macos', () => {
                 const login = loginPage(page);
                 await login.navigate();
                 await login.submitUsernameOnlyForm(credentials.username);
-                await login.shouldNotPromptToSave();
+                await login.shouldPromptToSave();
             });
         });
     });

diff --git a/src/DeviceInterface/InterfacePrototype.js b/src/DeviceInterface/InterfacePrototype.js
@@ -799,14 +799,18 @@ class InterfacePrototype {
     postSubmit(values, form) {
         if (!form.form) return;
         if (!form.hasValues(values)) return;
-        const checks = [form.shouldPromptToStoreData && !form.submitHandlerExecuted, this.passwordGenerator.generated];
 
+        const isUsernameOnly = Object.keys(values?.credentials || {}).length === 1 && values?.credentials?.username;
+        const checks = [form.shouldPromptToStoreData && !form.submitHandlerExecuted, this.passwordGenerator.generated, isUsernameOnly];
         if (checks.some(Boolean)) {
             const formData = appendGeneratedKey(values, {
                 password: this.passwordGenerator.password,
                 username: this.emailProtection.lastGenerated,
             });
-            this.storeFormData(formData, 'formSubmission');
+
+            // If credentials has only username field, and no password field, then trigger is a partialSave
+            const trigger = isUsernameOnly ? 'partialSave' : 'formSubmission';
+            this.storeFormData(formData, trigger);
         }
     }
 

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: false,
-            expValues: { credentials: undefined },
+            expHasValues: true,
+            expValues: { credentials: { username: 'testUsername' } },
         },
         {
             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: false,
-            expValues: { credentials: undefined },
+            expHasValues: true,
+            expValues: { credentials: { username: 'testUsername' } },
         },
         {
             testCase: 'form with hidden email field',