Bug 1868097 - Whats New Page nimbus tooling r=omc-reviewers,aminomancer

Differential Revision: https://phabricator.services.mozilla.com/D200392

Author: halemu

browser/app/profile/firefox.js

@@ -3024,3 +3024,6 @@ pref("browser.mailto.dualPrompt.os", false);
 pref("browser.mailto.prompt.os", true);
 
 pref("browser.backup.enabled", false);
+
+pref("startup.homepage_override_url_nimbus", "");
+pref("startup.homepage_override_nimbus_maxVersion", "");

browser/components/BrowserContentHandler.sys.mjs

@@ -240,10 +240,16 @@ function needHomepageOverride(updateMilestones = true) {
  * @param  update
  *         The nsIUpdate for the update that has been applied.
  * @param  defaultOverridePage
- *         The default override page.
+ *         The default override page
+ * @param  nimbusOverridePage
+ *         Nimbus provided URL
  * @return The override page.
  */
-function getPostUpdateOverridePage(update, defaultOverridePage) {
+function getPostUpdateOverridePage(
+  update,
+  defaultOverridePage,
+  nimbusOverridePage
+) {
   update = update.QueryInterface(Ci.nsIWritablePropertyBag);
   let actions = update.getProperty("actions");
   // When the update doesn't specify actions fallback to the original behavior
@@ -258,13 +264,16 @@ function getPostUpdateOverridePage(update, defaultOverridePage) {
     return "";
   }
 
-  // If a policy was set to not allow the update.xml-provided
-  // URL to be used, use the default fallback (which will also
-  // be provided by the policy).
+  // If a policy was set to not allow the update.xml-provided URL to be used,
+  // use the default fallback (which will also be provided by the policy).
   if (!Services.policies.isAllowed("postUpdateCustomPage")) {
     return defaultOverridePage;
   }
 
+  if (nimbusOverridePage) {
+    return nimbusOverridePage;
+  }
+
   return update.getProperty("openURL") || defaultOverridePage;
 }
 
@@ -798,7 +807,7 @@ nsBrowserContentHandler.prototype = {
             // Turn on 'later run' pages for new profiles.
             lazy.LaterRun.enable(lazy.LaterRun.ENABLE_REASON_NEW_PROFILE);
             break;
-          case OVERRIDE_NEW_MSTONE:
+          case OVERRIDE_NEW_MSTONE: {
             // Check whether we will restore a session. If we will, we assume
             // that this is an "update" session. This does not take crashes
             // into account because that requires waiting for the session file
@@ -811,18 +820,78 @@ nsBrowserContentHandler.prototype = {
               "startup.homepage_override_url"
             );
             let update = lazy.UpdateManager.readyUpdate;
+
+            /** If the override URL is provided by an experiment, is a valid
+             * Firefox What's New Page URL, and the update version is less than
+             * or equal to the maxVersion set by the experiment, we'll try to use
+             * the experiment override URL instead of the default or the
+             * update-provided URL. Additional policy checks are done in
+             * @see getPostUpdateOverridePage */
+            const nimbusOverrideUrl = Services.urlFormatter.formatURLPref(
+              "startup.homepage_override_url_nimbus"
+            );
+            const maxVersion = Services.prefs.getCharPref(
+              "startup.homepage_override_nimbus_maxVersion",
+              ""
+            );
+            let nimbusWNP;
+
+            // Update version should be less than or equal to maxVersion set by
+            // the experiment
+            if (
+              nimbusOverrideUrl &&
+              Services.vc.compare(update.appVersion, maxVersion) <= 0
+            ) {
+              try {
+                let uri = Services.io.newURI(nimbusOverrideUrl);
+                // Only allow https://www.mozilla.org and https://www.mozilla.com
+                if (
+                  uri.scheme === "https" &&
+                  ["www.mozilla.org", "www.mozilla.com"].includes(uri.host)
+                ) {
+                  nimbusWNP = uri.spec;
+                } else {
+                  throw new Error("Bad URL");
+                }
+              } catch {
+                console.error("Invalid WNP URL: ", nimbusOverrideUrl);
+              }
+            }
+
             if (
               update &&
               Services.vc.compare(update.appVersion, old_mstone) > 0
             ) {
-              overridePage = getPostUpdateOverridePage(update, overridePage);
+              overridePage = getPostUpdateOverridePage(
+                update,
+                overridePage,
+                nimbusWNP
+              );
+              // Record a Nimbus exposure event for the whatsNewPage feature.
+              // The override page could be set in 3 ways: 1. set by Nimbus 2.
+              // set by the update file(openURL) 3. The default evergreen page(Set by the
+              // startup.homepage_override_url pref, could be different
+              // depending on the Fx channel). This is done to record that the
+              // control cohort could have seen the experimental What's New Page
+              // (and will instead see the default What's New Page).
+              // recordExposureEvent only records an event if the user is
+              // enrolled in an experiment or rollout on the whatsNewPage
+              // feature, so it's safe to call it unconditionally.
+              if (overridePage) {
+                let nimbusWNPFeature = lazy.NimbusFeatures.whatsNewPage;
+                nimbusWNPFeature
+                  .ready()
+                  .then(() => nimbusWNPFeature.recordExposureEvent());
+              }
+
               // Send the update ping to signal that the update was successful.
               lazy.UpdatePing.handleUpdateSuccess(old_mstone, old_buildId);
               lazy.LaterRun.enable(lazy.LaterRun.ENABLE_REASON_UPDATE_APPLIED);
             }
 
             overridePage = overridePage.replace("%OLD_VERSION%", old_mstone);
             break;
+          }
           case OVERRIDE_NEW_BUILD_ID:
             if (lazy.UpdateManager.readyUpdate) {
               // Send the update ping to signal that the update was successful.

browser/components/tests/browser/whats_new_page/browser.toml

@@ -19,3 +19,5 @@ prefs = [
 ]
 
 ["browser_whats_new_page.js"]
+
+["include:./browser_whats_new_page_nimbus.toml"]

browser/components/tests/browser/whats_new_page/browser_whats_new_page_nimbus.js

@@ -0,0 +1,109 @@
+/* Any copyright is dedicated to the Public Domain.
+ * http://creativecommons.org/publicdomain/zero/1.0/ */
+
+"use strict";
+
+add_task(async function nimbus_whats_new_page() {
+  // The test harness will use the current tab and remove the tab's history.
+  // Since the page that is tested is opened prior to the test harness taking
+  // over the current tab the active-update.xml specifies two pages to open by
+  // having 'https://example.com/|https://example.com/' for the value of openURL
+  // and then uses the first tab for the test.
+  gBrowser.selectedTab = gBrowser.tabs[0];
+  // The test harness also changes the page to about:blank so go back to the
+  // page that was originally opened.
+  gBrowser.goBack();
+  // Wait for the page to go back to the original page.
+  await TestUtils.waitForCondition(
+    () =>
+      gBrowser.selectedBrowser &&
+      gBrowser.selectedBrowser.currentURI &&
+      gBrowser.selectedBrowser.currentURI.spec ==
+        "https://www.mozilla.org/en-US/projects/firefox/whatsnew/",
+    `Waiting for the expected page to reopen, ${gBrowser.selectedBrowser.currentURI.spec}`
+  );
+  is(
+    gBrowser.selectedBrowser.currentURI.spec,
+    "https://www.mozilla.org/en-US/projects/firefox/whatsnew/",
+    "The what's new page's url should equal https://www.mozilla.org/en-US/projects/firefox/whatsnew/"
+  );
+  gBrowser.removeTab(gBrowser.selectedTab);
+
+  let um = Cc["@mozilla.org/updates/update-manager;1"].getService(
+    Ci.nsIUpdateManager
+  );
+  await TestUtils.waitForCondition(
+    () => !um.readyUpdate,
+    "Waiting for the ready update to be removed"
+  );
+  ok(!um.readyUpdate, "There should not be a ready update");
+  await TestUtils.waitForCondition(
+    () => !!um.getUpdateAt(0),
+    "Waiting for the ready update to be moved to the update history"
+  );
+  ok(!!um.getUpdateAt(0), "There should be an update in the update history");
+
+  // Leave no trace. Since this test modifies its support files put them back in
+  // their original state.
+  let alternatePath = Services.prefs.getCharPref("app.update.altUpdateDirPath");
+  let testRoot = Services.prefs.getCharPref("mochitest.testRoot");
+  let relativePath = alternatePath.substring("<test-root>".length);
+  if (AppConstants.platform == "win") {
+    relativePath = relativePath.replace(/\//g, "\\");
+  }
+  alternatePath = testRoot + relativePath;
+  let updateDir = Cc["@mozilla.org/file/local;1"].createInstance(Ci.nsIFile);
+  updateDir.initWithPath(alternatePath);
+
+  let activeUpdateFile = updateDir.clone();
+  activeUpdateFile.append("active-update.xml");
+  await TestUtils.waitForCondition(
+    () => !activeUpdateFile.exists(),
+    "Waiting until the active-update.xml file does not exist"
+  );
+
+  let updatesFile = updateDir.clone();
+  updatesFile.append("updates.xml");
+  await TestUtils.waitForCondition(
+    () => updatesFile.exists(),
+    "Waiting until the updates.xml file exists"
+  );
+
+  let fos = Cc["@mozilla.org/network/file-output-stream;1"].createInstance(
+    Ci.nsIFileOutputStream
+  );
+  let flags =
+    FileUtils.MODE_WRONLY | FileUtils.MODE_CREATE | FileUtils.MODE_TRUNCATE;
+
+  let stateSucceeded = "succeeded\n";
+  let updateStatusFile = updateDir.clone();
+  updateStatusFile.append("updates");
+  updateStatusFile.append("0");
+  updateStatusFile.append("update.status");
+  updateStatusFile.create(Ci.nsIFile.NORMAL_FILE_TYPE, FileUtils.PERMS_FILE);
+  fos.init(updateStatusFile, flags, FileUtils.PERMS_FILE, 0);
+  fos.write(stateSucceeded, stateSucceeded.length);
+  fos.close();
+
+  let xmlContents =
+    '<?xml version="1.0"?><updates xmlns="http://www.mozilla.org/2005/' +
+    'app-update"><update xmlns="http://www.mozilla.org/2005/app-update" ' +
+    'appVersion="99999999.0" buildID="20990101111111" channel="test" ' +
+    'detailsURL="https://127.0.0.1/" displayVersion="1.0" installDate="' +
+    '1555716429454" isCompleteUpdate="true" name="What\'s New Page Test" ' +
+    'previousAppVersion="60.0" serviceURL="https://127.0.0.1/update.xml" ' +
+    'type="minor" platformVersion="99999999.0" actions="showURL" ' +
+    'openURL="https://example.com/|https://example.com/"><patch size="1" ' +
+    'type="complete" URL="https://127.0.0.1/complete.mar" ' +
+    'selected="true" state="pending"/></update></updates>\n';
+  activeUpdateFile.create(Ci.nsIFile.NORMAL_FILE_TYPE, FileUtils.PERMS_FILE);
+  fos.init(activeUpdateFile, flags, FileUtils.PERMS_FILE, 0);
+  fos.write(xmlContents, xmlContents.length);
+  fos.close();
+
+  updatesFile.remove(false);
+  Cc["@mozilla.org/updates/update-manager;1"]
+    .getService(Ci.nsIUpdateManager)
+    .QueryInterface(Ci.nsIObserver)
+    .observe(null, "um-reload-update-data", "");
+});

browser/components/tests/browser/whats_new_page/browser_whats_new_page_nimbus.toml

@@ -0,0 +1,6 @@
+[DEFAULT]
+
+["browser_whats_new_page_nimbus.js"]
+# This is a pref set by nimbus to be used for What's new pages
+prefs = ["startup.homepage_override_url_nimbus='https://www.mozilla.org/en-US/projects/firefox/whatsnew/|https://www.mozilla.org/en-US/projects/firefox/whatsnew/'",
+"startup.homepage_override_nimbus_maxVersion='99999999.0'"]

toolkit/components/nimbus/FeatureManifest.yaml

@@ -1251,6 +1251,26 @@ fxms-message-11:
     path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
   variables: {}
 
+whatsNewPage:
+  description: "A Firefox Messaging System message for the What's new page channel"
+  owner: omc@mozilla.com
+  hasExposure: true
+  exposureDescription: >-
+    "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched."
+  variables:
+    overrideUrl:
+      description: URL of the What's new page
+      type: string
+      setPref:
+        branch: user
+        pref: startup.homepage_override_url_nimbus
+    maxVersion:
+      description: Maximum Firefox update version
+      type: string
+      setPref:
+        branch: user
+        pref: startup.homepage_override_nimbus_maxVersion
+
 pbNewtab:
   description: "A Firefox Messaging System message for the pbNewtab message channel"
   owner: omc@mozilla.com