Bug 1773583 - Synchronously fetch NimbusEnrollment schema in NimbusTestUtils r=emcminn

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

UltraBlame original commit: 3642698fa9e48a18de9aeb060e8887dcb9fb16c1

Author: marco-c

toolkit/components/nimbus/test/NimbusTestUtils.sys.mjs

@@ -4,6 +4,7 @@
 
 import { ExperimentStore } from "resource://nimbus/lib/ExperimentStore.sys.mjs";
 import { FileTestUtils } from "resource://testing-common/FileTestUtils.sys.mjs";
+import { XPCOMUtils } from "resource://gre/modules/XPCOMUtils.sys.mjs";
 
 const lazy = {};
 
@@ -19,6 +20,36 @@ ChromeUtils.defineESModuleGetters(lazy, {
   sinon: "resource://testing-common/Sinon.sys.mjs",
 });
 
+XPCOMUtils.defineLazyModuleGetters(lazy, {
+  NetUtil: "resource://gre/modules/NetUtil.jsm",
+});
+
+function fetchSchemaSync(uri) {
+  // Yes, this is doing a sync load, but this is only done *once* and we cache
+  // the result after *and* it is test-only.
+  const channel = lazy.NetUtil.newChannel({
+    uri,
+    loadUsingSystemPrincipal: true,
+  });
+  const stream = Cc["@mozilla.org/scriptableinputstream;1"].createInstance(
+    Ci.nsIScriptableInputStream
+  );
+
+  stream.init(channel.open());
+
+  const available = stream.available();
+  const json = stream.read(available);
+  stream.close();
+
+  return JSON.parse(json);
+}
+
+XPCOMUtils.defineLazyGetter(lazy, "enrollmentSchema", () => {
+  return fetchSchemaSync(
+    "resource://nimbus/schemas/NimbusEnrollment.schema.json"
+  );
+});
+
 const { SYNC_DATA_PREF_BRANCH, SYNC_DEFAULTS_PREF_BRANCH } = ExperimentStore;
 
 const PATH = FileTestUtils.getTempFile("shared-data-map").path;
@@ -97,11 +128,7 @@ export const ExperimentTestUtils = {
       `Experiment ${experiment.slug} not valid`
     );
   },
-  async validateEnrollment(enrollment) {
-    const schema = await fetchSchema(
-      "resource://nimbus/schemas/NimbusEnrollment.schema.json"
-    );
-
+  validateEnrollment(enrollment) {
     // We still have single feature experiment recipes for backwards
     // compatibility testing but we don't do schema validation
     if (!enrollment.branch.features && enrollment.branch.feature) {
@@ -111,7 +138,7 @@ export const ExperimentTestUtils = {
     return (
       this._validateFeatureValueEnum(enrollment) &&
       this._validateSchema(
-        schema,
+        lazy.enrollmentSchema,
         enrollment,
         `Enrollment ${enrollment.slug} is not valid`
       )
@@ -217,6 +244,12 @@ export const ExperimentFakes = {
       return promise;
     };
   },
+  /**
+   * Enroll in an experiment branch with the given feature configuration.
+   *
+   * NB: It is unnecessary to await the enrollmentPromise.
+   *     See bug 1773583 and bug 1829412.
+   */
   async enrollWithFeatureConfig(
     featureConfig,
     { manager = lazy.ExperimentAPI._manager, isRollout = false } = {}
@@ -255,6 +288,12 @@ export const ExperimentFakes = {
 
     return doExperimentCleanup;
   },
+  /**
+   * Enroll in the given recipe.
+   *
+   * NB: It is unnecessary to await the enrollmentPromise.
+   *     See bug 1773583 and bug 1829412.
+   */
   enrollmentHelper(
     recipe,
     { manager = lazy.ExperimentAPI._manager, source = "enrollmentHelper" } = {}

toolkit/components/nimbus/test/browser/browser_remotesettingsexperimentloader_remote_defaults.js

@@ -93,20 +93,21 @@ const REMOTE_CONFIGURATION_BAR = ExperimentFakes.recipe("bar-rollout", {
 
 const SYNC_DEFAULTS_PREF_BRANCH = "nimbus.syncdefaultsstore.";
 
+add_setup(function() {
+  const client = RemoteSettings("nimbus-desktop-experiments");
+  sinon.stub(client, "get").resolves([]);
+
+  registerCleanupFunction(() => client.get.restore());
+});
+
 async function setup(configuration) {
   const client = RemoteSettings("nimbus-desktop-experiments");
-  await client.db.importChanges(
-    {},
-    Date.now(),
-    configuration || [REMOTE_CONFIGURATION_FOO, REMOTE_CONFIGURATION_BAR],
-    {
-      clear: true,
-    }
+  client.get.resolves(
+    configuration ?? [REMOTE_CONFIGURATION_FOO, REMOTE_CONFIGURATION_BAR]
   );
 
 
-  const cleanup = () =>
-    client.db.importChanges({}, Date.now(), [], { clear: true });
+  const cleanup = () => client.get.resolves([]);
   return { client, cleanup };
 }
 

toolkit/components/nimbus/test/browser/head.js

@@ -27,8 +27,8 @@ add_setup(function() {
   );
   sandbox
     .stub(ExperimentManager.store, "addEnrollment")
-    .callsFake(async enrollment => {
-      await ExperimentTestUtils.validateEnrollment(enrollment);
+    .callsFake(enrollment => {
+      ExperimentTestUtils.validateEnrollment(enrollment);
       return origAddExperiment(enrollment);
     });
 

toolkit/components/nimbus/test/unit/test_ExperimentManager_lifecycle.js

@@ -141,9 +141,6 @@ add_task(async function test_onRecipe_enroll() {
   sandbox.spy(manager, "updateEnrollment");
 
   const fooRecipe = ExperimentFakes.recipe("foo");
-  const experimentUpdate = new Promise(resolve =>
-    manager.store.on(`update:${fooRecipe.slug}`, resolve)
-  );
   await manager.onStartup();
   await manager.onRecipe(fooRecipe, "test");
 
@@ -152,7 +149,6 @@ add_task(async function test_onRecipe_enroll() {
     true,
     "should call .enroll() the first time a recipe is seen"
   );
-  await experimentUpdate;
   Assert.equal(
     manager.store.has("foo"),
     true,
@@ -205,15 +201,11 @@ add_task(async function test_onRecipe_rollout_update() {
   };
 
   fooRecipe.branches = fooRecipe.branches.slice(0, 1);
-  const experimentUpdate = new Promise(resolve =>
-    manager.store.on(`update:${fooRecipe.slug}`, resolve)
-  );
 
   await manager.onStartup();
   await manager.onRecipe(fooRecipe, "test");
 
 
-  await experimentUpdate;
 
   await manager.onRecipe(fooRecipe, "test");