Refactor - auto update credential provider script

Author: github-actions[bot]

firefox-ios/Client/Assets/CC_Script/AutofillFormFactory.sys.mjs

@@ -39,4 +39,8 @@ export const AutofillFormFactory = {
     }
     return lazy.FormLikeFactory.createFromField(aField, { ignoreForm });
   },
+
+  createFromDocumentRoot(aDocRoot) {
+    return lazy.FormLikeFactory.createFromDocumentRoot(aDocRoot);
+  },
 };

firefox-ios/Client/Assets/CC_Script/AutofillTelemetry.sys.mjs

@@ -12,10 +12,6 @@ class AutofillTelemetryBase {
   EVENT_CATEGORY = null;
   EVENT_OBJECT_FORM_INTERACTION = null;
 
-  HISTOGRAM_NUM_USES = null;
-  HISTOGRAM_PROFILE_NUM_USES = null;
-  HISTOGRAM_PROFILE_NUM_USES_KEY = null;
-
   #initFormEventExtra(value) {
     let extra = {};
     for (const field of Object.values(this.SUPPORTED_FIELDS)) {
@@ -183,17 +179,6 @@ class AutofillTelemetryBase {
     throw new Error("Not implemented.");
   }
 
-  recordNumberOfUse(records) {
-    let histogram = Services.telemetry.getKeyedHistogramById(
-      this.HISTOGRAM_PROFILE_NUM_USES
-    );
-    histogram.clear();
-
-    for (let record of records) {
-      histogram.add(this.HISTOGRAM_PROFILE_NUM_USES_KEY, record.timesUsed);
-    }
-  }
-
   recordIframeLayoutDetection(flowId, fieldDetails) {
     const fieldsInMainFrame = [];
     const fieldsInIframe = [];
@@ -238,9 +223,6 @@ export class AddressTelemetry extends AutofillTelemetryBase {
   EVENT_OBJECT_FORM_INTERACTION = "AddressForm";
   EVENT_OBJECT_FORM_INTERACTION_EXT = "AddressFormExt";
 
-  HISTOGRAM_PROFILE_NUM_USES = "AUTOFILL_PROFILE_NUM_USES";
-  HISTOGRAM_PROFILE_NUM_USES_KEY = "address";
-
   // Fields that are recorded in `address_form` and `address_form_ext` telemetry
   SUPPORTED_FIELDS = {
     "street-address": "street_address",
@@ -316,10 +298,6 @@ class CreditCardTelemetry extends AutofillTelemetryBase {
   EVENT_CATEGORY = "creditcard";
   EVENT_OBJECT_FORM_INTERACTION = "CcFormV2";
 
-  HISTOGRAM_NUM_USES = "CREDITCARD_NUM_USES";
-  HISTOGRAM_PROFILE_NUM_USES = "AUTOFILL_PROFILE_NUM_USES";
-  HISTOGRAM_PROFILE_NUM_USES_KEY = "credit_card";
-
   // Mapping of field name used in formautofill code to the field name
   // used in the telemetry.
   SUPPORTED_FIELDS = {
@@ -369,23 +347,6 @@ class CreditCardTelemetry extends AutofillTelemetryBase {
     }
   }
 
-  recordNumberOfUse(records) {
-    super.recordNumberOfUse(records);
-
-    if (!this.HISTOGRAM_NUM_USES) {
-      return;
-    }
-
-    let histogram = Services.telemetry.getHistogramById(
-      this.HISTOGRAM_NUM_USES
-    );
-    histogram.clear();
-
-    for (let record of records) {
-      histogram.add(record.timesUsed);
-    }
-  }
-
   recordAutofillProfileCount(count) {
     Glean.formautofillCreditcards.autofillProfilesCount.set(count);
   }
@@ -463,14 +424,6 @@ export class AutofillTelemetry {
     telemetry.recordAutofillProfileCount(count);
   }
 
-  /**
-   * Utility functions for address/credit card number of use
-   */
-  static recordNumberOfUse(type, records) {
-    const telemetry = this.#getTelemetryByType(type);
-    telemetry.recordNumberOfUse(records);
-  }
-
   static recordFormSubmissionHeuristicCount(label) {
     Glean.formautofill.formSubmissionHeuristic[label].add(1);
   }

firefox-ios/Client/Assets/CC_Script/FormAutofillHandler.sys.mjs

@@ -24,6 +24,7 @@ const { FIELD_STATES } = FormAutofillUtils;
 export const FORM_CHANGE_REASON = {
   NODES_ADDED: "nodes-added",
   NODES_REMOVED: "nodes-removed",
+  SELECT_OPTIONS_CHANGED: "select-options-changed",
   ELEMENT_INVISIBLE: "visible-element-became-invisible",
   ELEMENT_VISIBLE: "invisible-element-became-visible",
 };
@@ -268,6 +269,11 @@ export class FormAutofillHandler {
     return false;
   }
 
+  updateFormByElement(element) {
+    const formLike = lazy.AutofillFormFactory.createFromField(element);
+    this._updateForm(formLike);
+  }
+
   /**
    * Update the form with a new FormLike, and the related fields should be
    * updated or clear to ensure the data consistency.
@@ -344,7 +350,7 @@ export class FormAutofillHandler {
   }
 
   /**
-   * Resetting the state element's fieldDetail after it was removed from the form
+   * Resetting the filled state after an element was removed from the form
    * Todo: We'll need to update this.filledResult in FormAutofillParent (Bug 1948077).
    *
    * @param {HTMLElement} element that was removed
@@ -353,8 +359,7 @@ export class FormAutofillHandler {
     if (this.getFilledStateByElement(element) != FIELD_STATES.AUTO_FILLED) {
       return;
     }
-    const fieldDetail = this.getFieldDetailByElement(element);
-    this.#filledStateByElement.delete(fieldDetail);
+    this.#filledStateByElement.delete(element);
   }
 
   /**
@@ -493,6 +498,14 @@ export class FormAutofillHandler {
       } else if (HTMLSelectElement.isInstance(element)) {
         const option = this.matchSelectOptions(fieldDetail, profile);
         if (!option) {
+          if (
+            this.getFilledStateByElement(element) == FIELD_STATES.AUTO_FILLED
+          ) {
+            // The select element was previously autofilled, but there
+            // is no matching option under the current set of options anymore.
+            // Changing the state will also remove the highlighting from the element
+            this.changeFieldState(fieldDetail, FIELD_STATES.NORMAL);
+          }
           continue;
         }
 
@@ -684,18 +697,21 @@ export class FormAutofillHandler {
     const mutationObserver = new this.window.MutationObserver(
       (mutations, _) => {
         const collectMutatedNodes = mutations => {
-          let removedNodes = [];
-          let addedNodes = [];
+          let removedNodes = new Set();
+          let addedNodes = new Set();
+          let changedSelectElements = new Set();
           mutations.forEach(mutation => {
             if (mutation.type == "childList") {
-              if (mutation.addedNodes.length) {
-                addedNodes.push(...mutation.addedNodes);
+              if (HTMLSelectElement.isInstance(mutation.target)) {
+                changedSelectElements.add(mutation.target);
+              } else if (mutation.addedNodes.length) {
+                addedNodes.add(...mutation.addedNodes);
               } else if (mutation.removedNodes.length) {
-                removedNodes.push(...mutation.removedNodes);
+                removedNodes.add(...mutation.removedNodes);
               }
             }
           });
-          return [addedNodes, removedNodes];
+          return [addedNodes, removedNodes, changedSelectElements];
         };
 
         const collectAllSubtreeElements = node => {
@@ -715,22 +731,35 @@ export class FormAutofillHandler {
             );
         };
 
-        let [addedNodes, removedNodes] = collectMutatedNodes(mutations);
-        let relevantAddedElements = getCCAndAddressElements(addedNodes);
-        // We only care about removed elements that might change the
-        // currently detected fieldDetails
-        let relevantRemovedElements = getCCAndAddressElements(
-          removedNodes
-        ).filter(
+        const [addedNodes, removedNodes, changedSelectElements] =
+          collectMutatedNodes(mutations);
+        let relevantAddedElements = getCCAndAddressElements([...addedNodes]);
+        // We only care about removed elements and changed select options
+        // from the current set of detected fieldDetails
+        let relevantRemovedElements = getCCAndAddressElements([
+          ...removedNodes,
+        ]).filter(
+          element =>
+            this.#fieldDetails && !!this.getFieldDetailByElement(element)
+        );
+        let relevantChangedSelectElements = [...changedSelectElements].filter(
           element =>
             this.#fieldDetails && !!this.getFieldDetailByElement(element)
         );
 
-        if (!relevantRemovedElements.length && !relevantAddedElements.length) {
+        if (
+          !relevantRemovedElements.length &&
+          !relevantAddedElements.length &&
+          !relevantChangedSelectElements.length
+        ) {
           return;
         }
 
         let changes = {};
+        if (relevantChangedSelectElements.length) {
+          changes[FORM_CHANGE_REASON.SELECT_OPTIONS_CHANGED] =
+            relevantChangedSelectElements;
+        }
         if (relevantRemovedElements.length) {
           changes[FORM_CHANGE_REASON.NODES_REMOVED] = relevantRemovedElements;
         }
@@ -875,7 +904,8 @@ export class FormAutofillHandler {
     const value = profile[fieldName];
 
     let option = cache[value]?.deref();
-    if (!option) {
+
+    if (!option || !option.isConnected) {
       option = FormAutofillUtils.findSelectOption(element, profile, fieldName);
 
       if (option) {

firefox-ios/Client/Assets/CC_Script/FormAutofillSection.sys.mjs

@@ -333,27 +333,32 @@ export class FormAutofillSection {
     return data;
   }
 
+  shouldAutofillField(fieldDetail) {
+    // We don't save security code, but if somehow the profile has securty code,
+    // make sure we don't autofill it.
+    if (fieldDetail.fieldName == "cc-csc") {
+      return false;
+    }
+
+    // When both visible and invisible elements exist, we only autofill the
+    // visible element.
+    if (!fieldDetail.isVisible) {
+      return !this.fieldDetails.some(
+        field => field.fieldName == fieldDetail.fieldName && field.isVisible
+      );
+    }
+
+    return true;
+  }
+
   /**
    * Heuristics to determine which fields to autofill when a section contains
    * multiple fields of the same type.
    */
   getAutofillFields() {
-    return this.fieldDetails.filter(fieldDetail => {
-      // We don't save security code, but if somehow the profile has securty code,
-      // make sure we don't autofill it.
-      if (fieldDetail.fieldName == "cc-csc") {
-        return false;
-      }
-
-      // When both visible and invisible elements exist, we only autofill the
-      // visible element.
-      if (!fieldDetail.isVisible) {
-        return !this.fieldDetails.some(
-          field => field.fieldName == fieldDetail.fieldName && field.isVisible
-        );
-      }
-      return true;
-    });
+    return this.fieldDetails.filter(fieldDetail =>
+      this.shouldAutofillField(fieldDetail)
+    );
   }
 
   /*
@@ -645,7 +650,6 @@ export class FormAutofillCreditCardSection extends FormAutofillSection {
         result = decrypted ? "success" : "fail_user_canceled";
       } catch (ex) {
         result = "fail_error";
-        throw ex;
       } finally {
         Glean.formautofill.promptShownOsReauth.record({
           trigger: "autofill",
@@ -677,6 +681,7 @@ export class FormAutofillCreditCardSection extends FormAutofillSection {
     } catch (e) {
       errorResult = e.result;
       if (e.result != Cr.NS_ERROR_ABORT) {
+        this.log.warn(`Decryption failed with result: ${e.result}`);
         throw e;
       }
       this.log.warn("User canceled encryption login");

firefox-ios/Client/Assets/CC_Script/FormAutofillUtils.sys.mjs

@@ -456,7 +456,9 @@ FormAutofillUtils = {
    * @returns {boolean} true if the element can be autofilled
    */
   isFieldAutofillable(element) {
-    return element && !element.readOnly && !element.disabled;
+    return (
+      element && !element.readOnly && !element.disabled && element.isConnected
+    );
   },
 
   /**
@@ -684,16 +686,26 @@ FormAutofillUtils = {
    */
   buildRegionMapIfAvailable(subKeys, subIsoids, subNames, subLnames) {
     // Not all regions have sub_keys. e.g. DE
-    if (
-      !subKeys ||
-      !subKeys.length ||
-      (!subNames && !subLnames) ||
-      (subNames && subKeys.length != subNames.length) ||
-      (subLnames && subKeys.length != subLnames.length)
-    ) {
+    if (!subKeys?.length) {
       return null;
     }
 
+    let names;
+    if (!subNames && !subLnames) {
+      // Use the keys if sub_names does not exist
+      names = [...subKeys];
+    } else {
+      if (
+        (subNames && subKeys.length != subNames.length) ||
+        (subLnames && subKeys.length != subLnames.length)
+      ) {
+        return null;
+      }
+
+      // Apply sub_lnames if sub_names does not exist
+      names = subNames || subLnames;
+    }
+
     // Overwrite subKeys with subIsoids, when available
     if (subIsoids && subIsoids.length && subIsoids.length == subKeys.length) {
       for (let i = 0; i < subIsoids.length; i++) {
@@ -703,8 +715,6 @@ FormAutofillUtils = {
       }
     }
 
-    // Apply sub_lnames if sub_names does not exist
-    let names = subNames || subLnames;
     return new Map(subKeys.map((key, index) => [key, names[index]]));
   },
 
@@ -831,7 +841,7 @@ FormAutofillUtils = {
         continue;
       }
       // Apply sub_lnames if sub_names does not exist
-      subNames = subNames || subLnames;
+      subNames = subNames || subLnames || subKeys;
 
       let speculatedSubIndexes = [];
       for (const val of values) {
@@ -919,7 +929,8 @@ FormAutofillUtils = {
             continue;
           }
           // Apply sub_lnames if sub_names does not exist
-          let names = dataset.sub_names || dataset.sub_lnames;
+          let names =
+            dataset.sub_names || dataset.sub_lnames || dataset.sub_keys;
           let isoids = dataset.sub_isoids;
 
           // Go through options one by one to find a match.