[CrOS Cellular] Add Network.Cellular.PSim.SetupFlowResult.

Provides insight into what issues stop users from successfully
activating their physical SIM cards.

See go/cros-cellular-success-metrics

Bug: 1183573, 1186344
Change-Id: Id9fafbae92cd0c08a091dc67c051f785e9298032
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2740118
Reviewed-by: Steven Holte <holte@chromium.org>
Reviewed-by: Azeem Arshad <azeemarshad@chromium.org>
Commit-Queue: Regan Hsu <hsuregan@chromium.org>
Cr-Commit-Position: refs/heads/master@{#862124}

Author: Regan Hsu

chrome/test/data/webui/cr_components/chromeos/cellular_setup/psim_flow_ui_test.js

@@ -6,7 +6,7 @@
 // #import 'chrome://os-settings/strings.m.js';
 // #import 'chrome://resources/cr_components/chromeos/cellular_setup/psim_flow_ui.m.js';
 
-// #import {PSimUIState, PSimPageName} from 'chrome://resources/cr_components/chromeos/cellular_setup/psim_flow_ui.m.js';
+// #import {PSimUIState, PSimPageName, PSimSetupFlowResult} from 'chrome://resources/cr_components/chromeos/cellular_setup/psim_flow_ui.m.js';
 // #import {setCellularSetupRemoteForTesting} from 'chrome://resources/cr_components/chromeos/cellular_setup/mojo_interface_provider.m.js';
 // #import {flush, Polymer} from 'chrome://resources/polymer/v3_0/polymer/polymer_bundled.min.js';
 // #import {assertTrue} from '../../../chai_assert.js';
@@ -16,6 +16,28 @@
 // clang-format on
 
 suite('CrComponentsPsimFlowUiTest', function() {
+  class MockMetricsPrivate {
+    constructor() {
+      this.cellularSetupResultDict = {};
+    }
+
+    recordEnumerationValue(histogramName, pSimSetupFlowResult, enumSize) {
+      assertEquals(histogramName, 'Network.Cellular.PSim.CellularSetupResult');
+      if (pSimSetupFlowResult in this.cellularSetupResultDict) {
+        this.cellularSetupResultDict[pSimSetupFlowResult]++;
+        return;
+      }
+      this.cellularSetupResultDict[pSimSetupFlowResult] = 1;
+    }
+
+    getSetupResultMetricCount(metricEnum) {
+      if (metricEnum in this.cellularSetupResultDict) {
+        return this.cellularSetupResultDict[metricEnum];
+      }
+      return 0;
+    }
+  }
+
   let pSimPage;
 
   /** @type {?chromeos.cellularSetup.mojom.CellularSetupRemote} */
@@ -33,12 +55,24 @@ suite('CrComponentsPsimFlowUiTest', function() {
     return new Promise(resolve => setTimeout(resolve));
   }
 
+  /** @param {PSimSetupFlowResult} pSimSetupFlowResult */
+  function endFlowAndVerifyResult(pSimSetupFlowResult) {
+    const resultCount =
+        chrome.metricsPrivate.getSetupResultMetricCount(pSimSetupFlowResult);
+    pSimPage.remove();
+    Polymer.dom.flush();
+    assertEquals(
+        chrome.metricsPrivate.getSetupResultMetricCount(pSimSetupFlowResult),
+        resultCount + 1);
+  }
+
   setup(function() {
     cellularCarrierHandler =
         new cellular_setup.FakeCarrierPortalHandlerRemote();
     cellularSetupRemote =
         new cellular_setup.FakeCellularSetupRemote(cellularCarrierHandler);
     cellular_setup.setCellularSetupRemoteForTesting(cellularSetupRemote);
+    chrome.metricsPrivate = new MockMetricsPrivate();
 
     pSimPage = document.createElement('psim-flow-ui');
     pSimPage.delegate = new cellular_setup.FakeCellularSetupDelegate();
@@ -66,6 +100,8 @@ suite('CrComponentsPsimFlowUiTest', function() {
     assertTrue(
         pSimPage.selectedPSimPageName_ ===
         cellularSetup.PSimPageName.PROVISIONING);
+
+    endFlowAndVerifyResult(PSimSetupFlowResult.SUCCESS);
   });
 
   test('Sim detection failure with retries', async function() {
@@ -136,8 +172,9 @@ suite('CrComponentsPsimFlowUiTest', function() {
             .kPortalLoadedWithoutPaidUser);
 
     await flushAsync();
-
     assertTrue(pSimPage.nameOfCarrierPendingSetup === 'Verizon wireless');
+
+    endFlowAndVerifyResult(PSimSetupFlowResult.CANCELLED);
   });
 
   test('forward navigation and finish cellular setup test', async function() {
@@ -159,5 +196,31 @@ suite('CrComponentsPsimFlowUiTest', function() {
 
     await flushAsync();
     assertTrue(exitCellularSetupEventFired);
+
+    endFlowAndVerifyResult(PSimSetupFlowResult.SUCCESS);
+  });
+
+  test('Activation failure metric logged', async () => {
+    cellularActivationDelegate =
+        cellularSetupRemote.getLastActivationDelegate();
+
+    let provisioningPage = pSimPage.$$('#provisioningPage');
+    assertTrue(!!provisioningPage);
+    assertFalse(
+        pSimPage.selectedPSimPageName_ ===
+        cellularSetup.PSimPageName.provisioningPage);
+
+    cellularActivationDelegate.onActivationFinished(
+        chromeos.cellularSetup.mojom.ActivationResult.kFailedToActivate);
+
+    await flushAsync();
+    endFlowAndVerifyResult(PSimSetupFlowResult.NETWORK_ERROR);
+  });
+
+  test('Portal error metric logged', () => {
+    let provisioningPage = pSimPage.$$('#provisioningPage');
+    provisioningPage.fire('carrier-portal-result', false);
+
+    endFlowAndVerifyResult(PSimSetupFlowResult.CANCELLED_PORTAL_ERROR);
   });
 });

tools/metrics/histograms/enums.xml

@@ -63715,6 +63715,18 @@ https://www.dmtf.org/sites/default/files/standards/documents/DSP0134_2.7.1.pdf
   <int value="4" label="PROXY_HAS_RULES"/>
 </enum>
 
+<enum name="PSimSetupFlowResult">
+  <int value="0" label="SUCCESS"/>
+  <int value="1" label="CANCELLED"/>
+  <int value="2" label="CANCELLED_NO_SIM"/>
+  <int value="3" label="CANCELLED_COLD_SIM_DEFER"/>
+  <int value="4" label="CANCELLED_CARRIER_PORTAL"/>
+  <int value="5" label="CANCELLED_PORTAL_ERROR"/>
+  <int value="6" label="CARRIER_PORTAL_TIMEOUT"/>
+  <int value="7" label="TIMEOUT_FINISH_ACTIVATION"/>
+  <int value="8" label="NETWORK_ERROR"/>
+</enum>
+
 <enum name="PsmHashDanceDifferentResultsComparison">
   <int value="0" label="Hash dance true and PSM false"/>
   <int value="1" label="PSM true and Hash dance false"/>

tools/metrics/histograms/histograms_xml/network/histograms.xml

@@ -158,6 +158,17 @@ reviews. Googlers can read more about this at go/gwsq-gerrit.
   </summary>
 </histogram>
 
+<histogram name="Network.Cellular.PSim.SetupFlowResult"
+    enum="PSimSetupFlowResult" expires_after="2022-03-01">
+  <owner>azeemarshad@chromium.org</owner>
+  <owner>cros-connectivity@google.com</owner>
+  <owner>hsuregan@chromium.org</owner>
+  <summary>
+    Tracks the result of the physical SIM card setup flow when the setup dialog
+    closes.
+  </summary>
+</histogram>
+
 <histogram name="Network.Cellular.PSim.Usage.Count" enum="NetworkCellularUsage"
     expires_after="2022-03-01">
   <owner>azeemarshad@chromium.org</owner>

ui/webui/resources/cr_components/chromeos/cellular_setup/BUILD.gn

@@ -195,6 +195,7 @@ js_library("psim_flow_ui.m") {
     "//ui/webui/resources/js:i18n_behavior.m",
   ]
   extra_deps = [ ":psim_flow_ui_module" ]
+  externs_list = [ "$externs_path/metrics_private.js" ]
 }
 
 js_library("esim_flow_ui.m") {

ui/webui/resources/cr_components/chromeos/cellular_setup/psim_flow_ui.js

@@ -26,6 +26,23 @@ cr.define('cellularSetup', function() {
     ACTIVATION_FAILURE: 'activation-failure',
   };
 
+  /**
+   * The reason that caused the user to exit the PSim Setup flow.
+   * These values are persisted to logs. Entries should not be renumbered
+   * and numeric values should never be reused.
+   * @enum{number}
+   */
+  /* #export */ const PSimSetupFlowResult = {
+    SUCCESS: 0,
+    CANCELLED: 1,
+    CANCELLED_NO_SIM: 2,
+    CANCELLED_COLD_SIM_DEFER: 3,
+    CANCELLED_CARRIER_PORTAL: 4,
+    CANCELLED_PORTAL_ERROR: 5,
+    CARRIER_PORTAL_TIMEOUT: 6,
+    NETWORK_ERROR: 7,
+  };
+
   /**
    * @param {!cellularSetup.PSimUIState} state
    * @return {?number} The time delta, in ms, for the timeout corresponding to
@@ -179,11 +196,62 @@ cr.define('cellularSetup', function() {
      */
     carrierPortalHandler_: null,
 
+
+    /**
+     * Whether there was a carrier portal error.
+     * @private {boolean}
+     */
+    didCarrierPortalResultFail_: false,
+
     /** @override */
     created() {
       this.cellularSetupRemote_ = cellular_setup.getCellularSetupRemote();
     },
 
+    /** @override */
+    detached() {
+      let resultCode = null;
+      switch (this.state_) {
+        case PSimUIState.IDLE:
+        case PSimUIState.STARTING_ACTIVATION:
+          resultCode = PSimSetupFlowResult.CANCELLED;
+          break;
+        case PSimUIState.WAITING_FOR_ACTIVATION_TO_START:
+          resultCode = PSimSetupFlowResult.CANCELLED_COLD_SIM_DEFER;
+          break;
+        case PSimUIState.TIMEOUT_START_ACTIVATION:
+          resultCode = PSimSetupFlowResult.CANCELLED_NO_SIM;
+          break;
+        case PSimUIState.WAITING_FOR_PORTAL_TO_LOAD:
+          resultCode = PSimSetupFlowResult.CANCELLED;
+          break;
+        case PSimUIState.TIMEOUT_PORTAL_LOAD:
+          resultCode = PSimSetupFlowResult.CARRIER_PORTAL_TIMEOUT;
+          break;
+        case PSimUIState.WAITING_FOR_USER_PAYMENT:
+          resultCode = PSimSetupFlowResult.CANCELLED_CARRIER_PORTAL;
+          break;
+        case PSimUIState.ACTIVATION_SUCCESS:
+        case PSimUIState.WAITING_FOR_ACTIVATION_TO_FINISH:
+        case PSimUIState.TIMEOUT_FINISH_ACTIVATION:
+        case PSimUIState.ALREADY_ACTIVATED:
+          resultCode = PSimSetupFlowResult.SUCCESS;
+          break;
+        case PSimUIState.ACTIVATION_FAILURE:
+          resultCode = this.didCarrierPortalResultFail_ ?
+              PSimSetupFlowResult.CANCELLED_PORTAL_ERROR :
+              PSimSetupFlowResult.NETWORK_ERROR;
+          break;
+        default:
+          assertNotReached();
+      }
+
+      assert(resultCode !== null);
+      chrome.metricsPrivate.recordEnumerationValue(
+          'Network.Cellular.PSim.CellularSetupResult', resultCode,
+          Object.keys(PSimSetupFlowResult).length);
+    },
+
     /**
      * Overrides chromeos.cellularSetup.mojom.ActivationDelegateInterface.
      * @param {!chromeos.cellularSetup.mojom.CellularMetadata} metadata
@@ -459,6 +527,7 @@ cr.define('cellularSetup', function() {
      */
     onCarrierPortalResult_(event) {
       const success = event.detail;
+      this.didCarrierPortalResultFail_ = !success;
       this.state_ = success ? PSimUIState.ACTIVATION_SUCCESS :
                               PSimUIState.ACTIVATION_FAILURE;
     },