Changed webextension api namespace from shieldUtils to study

examples/test-addon/bin/bundle-shield-studies-addon-utils.sh

@@ -7,10 +7,10 @@ set -o errexit
 script_path=`dirname $0`
 cd "$script_path/../../"
 
-# bundle the shieldUtils web extension experiment
-mkdir -p test-addon/src/privileged/shieldUtils
-cp webExtensionApis/shieldUtils/api.js test-addon/src/privileged/shieldUtils/api.js
-cp webExtensionApis/shieldUtils/schema.json test-addon/src/privileged/shieldUtils/schema.json
+# bundle the study web extension experiment
+mkdir -p test-addon/src/privileged/study
+cp webExtensionApis/study/api.js test-addon/src/privileged/study/api.js
+cp webExtensionApis/study/schema.json test-addon/src/privileged/study/schema.json
 
 # bundle the prefs web extension experiment
 mkdir -p test-addon/src/privileged/prefs

examples/test-addon/src/background.js

@@ -52,10 +52,10 @@ async function initiateStudy() {
   // Set dynamic study configuration flags
   studySetup.eligible = await Study.isEligible();
   studySetup.expired = await Study.hasExpired();
-  // Ensure we have configured shieldUtils and are supposed to run our feature
-  await browser.shieldUtils.bootstrapStudy(studySetup);
+  // Ensure we have configured study and are supposed to run our feature
+  await browser.study.bootstrapStudy(studySetup);
   // Get study variation
-  const { variation } = await browser.shieldUtils.info();
+  const { variation } = await browser.study.info();
   // Initiate the study
   new Study(variation);
 }

examples/test-addon/src/manifest.json

@@ -18,12 +18,12 @@
         "paths": [["prefs"]]
       }
     },
-    "shieldUtils": {
-      "schema": "./privileged/shieldUtils/schema.json",
+    "study": {
+      "schema": "./privileged/study/schema.json",
       "parent": {
         "scopes": ["addon_parent"],
-        "script": "./privileged/shieldUtils/api.js",
-        "paths": [["shieldUtils"]]
+        "script": "./privileged/study/api.js",
+        "paths": [["study"]]
       }
     }
   },

examples/test-addon/src/privileged/.gitignore

@@ -1,3 +1,3 @@
 # ignore APIs that are bundled from shield-studies-addon-utils
-shieldUtils/
+study/
 prefs/

examples/test-addon/test/functional/shield_utils_test.js

@@ -32,11 +32,11 @@ describe("Shield Study Add-on Utils Functional Tests", function() {
     assert(hasAccessToWebExtensionApi);
   });
 
-  it("should be able to access shieldUtils WebExtensions API from the extension page for tests", async () => {
+  it("should be able to access study WebExtensions API from the extension page for tests", async () => {
     const hasAccessToShieldUtilsWebExtensionApi = await utils.executeJs.executeAsyncScriptInExtensionPageForTests(
       driver,
       async callback => {
-        callback(browser && typeof browser.shieldUtils === "object");
+        callback(browser && typeof browser.study === "object");
       },
     );
     assert(hasAccessToShieldUtilsWebExtensionApi);

package.json

@@ -46,7 +46,7 @@
     "url": "git://github.com/mozilla/shield-studies-addon-utils.git"
   },
   "scripts": {
-    "build": "cd webExtensionApis/shieldUtils && webpack",
+    "build": "cd webExtensionApis/study && webpack",
     "docformat": "doctoc --title '**Contents**' docs/*.md && prettier '**/*.md' --write",
     "eslint": "eslint src --ext jsm --ext js --ext json",
     "eslint-fix": "npm run eslint -- --fix",

webExtensionApis/shieldUtils/schema.json → webExtensionApis/study/schema.json

@@ -1,7 +1,7 @@
 [
   {
-    "namespace": "shieldUtils",
-    "description": "shieldUtils",
+    "namespace": "study",
+    "description": "study",
     "functions": [
       {
         "name": "bootstrapStudy",

webExtensionApis/shieldUtils/src/index.js → webExtensionApis/study/src/index.js

@@ -2,7 +2,7 @@
 
 /* global ExtensionAPI */
 
-this.shieldUtils = class extends ExtensionAPI {
+this.study = class extends ExtensionAPI {
   /**
    * We don't need to override the constructor for other
    * reasons than to clarify the class member "extension"
@@ -39,9 +39,9 @@ this.shieldUtils = class extends ExtensionAPI {
     const { extension } = this;
 
     return {
-      shieldUtils: {
+      study: {
         /**
-         * ensure we have configured shieldUtils
+         * ensure we have configured study
          * and are supposed to run our feature
          * @returns {Promise<void>}
          */