add named pages to entity types

Author: Simpcyclassy

.eslintignore

@@ -9,4 +9,5 @@ extension/onboarding/onboardingController.js
 extension/onboarding/onboardingView.js
 extension/wakeword/wakewordController.js
 extension/wakeword/wakewordView.js
-extension/intents/pocket/contentScript.js
+extension/intents/pocket/contentScript.js
+*.bundle.js

.gitignore

@@ -37,3 +37,4 @@ manifest.json
 Thumbs.db
 /build
 /bin/username-cache.json
+*.bundle.js

.taskcluster.yml

@@ -0,0 +1,28 @@
+#!/usr/bin/env node
+
+const rollup = require("rollup");
+const glob = require("glob");
+const scriptUtils = require("./script-utils.js");
+const path = require("path");
+const tmp = require("tmp");
+
+async function run() {
+  for (const input of glob.sync(
+    path.join(scriptUtils.extensionDir, "**/*.content.js")
+  )) {
+    const tmpObj = tmp.fileSync();
+    const outputFilename = input.replace(/\.content\.js$/, ".bundle.js");
+    const bundle = await rollup.rollup({
+      input,
+    });
+    await bundle.write({
+      format: "iife",
+      sourcemap: "inline",
+      file: tmpObj.name,
+    });
+    scriptUtils.copyFile(tmpObj.name, outputFilename, true);
+    tmpObj.removeCallback();
+  }
+}
+
+run();

bin/rollup-content-scripts.js

@@ -27,3 +27,8 @@ exports.writeFile = function(path, content, verbose = false) {
     console.log(`Wrote ${displayPath(path)} (${content.length} chars)`);
   }
 };
+
+exports.copyFile = function(source, dest, verbose = false) {
+  const existing = fs.readFileSync(source, { encoding: "UTF-8" });
+  exports.writeFile(dest, existing, verbose);
+};

bin/script-utils.js

@@ -64,7 +64,7 @@ intentRunner.registerIntent({
 
 Some things to note:
 
-- We use [JavaScript modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) in most of the extension (except for content scripts).
+- We use [JavaScript modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) in most of the extension
 - Intents often don't actually export anything, they work by calling `intentRunner.register()`. But you can [export](https://developer.mozilla.org/en-US/docs/web/javascript/reference/statements/export) if you want.
 - We use [eslint](https://eslint.org/) in the codebase, and it's recommended you configure your editor to show warnings.
 - You can (and usually will) have multiple intents in a single module and config file (e.g., `someIntent.otherCommand` and so on)
@@ -95,7 +95,7 @@ Patterns have words, words with alternatives, slots, typed slots, and parameters
 
 **Typed slots:** these are things like `[service:musicServiceName]`. These "types" are lists of specific strings. These types are in the `background/entityTypes.js` module. Right now this system isn't very extensible.
 
-**Parameters:** sometimes you care _which_ phrase is matched, not just a slot. If you include `[param=value]` then `contents.parameters.param === "value"` (if that specific phrase is matched). You can see an example in [`extensions/intents/music/music.js`](https://github.com/mozilla/firefox-voice/blob/master/extension/intents/music/music.js) in `music.move`.
+**Parameters:** sometimes you care _which_ phrase is matched, not just a slot. If you include `[param=value]` then `context.parameters.param === "value"` (if that specific phrase is matched). You can see an example in [`extensions/intents/music/music.js`](https://github.com/mozilla/firefox-voice/blob/master/extension/intents/music/music.js) in `music.move`.
 
 ### Matching an utterance to an intent
 
@@ -138,38 +138,38 @@ To prepare a tab to do your custom stuff, run:
 ```js
 async run(context) {
   const activeTab = await browserUtil.activeTab();
-  await content.inject(activeTab.id, "intents/someName/contentScript.js");
+  await content.inject(activeTab.id, "intents/someName/someScript.content.js");
   // Now the script, and a bunch of helpers are available
   const resp = await browser.tabs.sendMessage(activeTab.id, {type: "doSomething"});
 }
 ```
 
-`content.inject` will make sure the script is available and fully loaded, and will not re-load the script if called multiple times on the same tab. It also loads [`content/communicate.js`](../extension/content/communicate.js) and [`content/helpers.js`](../extension/content/helpers.js).
+`content.inject` will load the built script (scripts like these are packaged up into `someScript.bundle.js`). These scripts _must_ be named with `.content.js`.
 
-You can use this pattern in your script (`contentScript.js` in this example):
+You can use this pattern in your script (`someScript.content.js` in this example):
 
 ```js
-(function() {
-  communicate.register("doSomething", message => {
-    // Do something, and return a value
-  });
-})();
+import { registerHandler } from "../../communicate.js";
+
+registerHandler("doSomething", message => {
+  // Do something, and return a value
+});
 ```
 
 Or maybe:
 
 ```js
-(function() {
-  class MyThing extends helpers.Runner {
-    async action_doSomething(message) {
-      const el = await this.waitForSelector(".some-element");
-      ...
-    }
-  };
-})();
-```
+import {Runner} from "../../content/helpers.js";
 
-Note you _cannot_ use JavaScript modules in content scripts.
+class MyThing extends Runner {
+  async action_doSomething(message) {
+    const el = await this.waitForSelector(".some-element");
+    ...
+  }
+}
+
+MyThing.register();
+```
 
 ## Logging
 

docs/writing-an-intent.md

@@ -1,61 +1,20 @@
-/* globals log */
-
-const NO_RECEIVER_MESSAGE =
-  "Could not establish connection. Receiving end does not exist";
-
 export async function inject(tabId, scripts) {
   if (!tabId) {
     throw new Error(`Invalid tabId: ${tabId}`);
   }
   if (typeof scripts === "string") {
     scripts = [scripts];
   }
-  const scriptKey = scripts.join(",");
-  let available = true;
-  try {
-    available = await browser.tabs.sendMessage(tabId, {
-      type: "ping",
-      scriptKey,
-    });
-    if (!available) {
-      available = "some";
-    }
-  } catch (e) {
-    available = false;
-    if (String(e).includes(NO_RECEIVER_MESSAGE)) {
-      // This is a normal error
-    } else {
-      log.error("Error sending message:", String(e));
-    }
-  }
-  if (available === "some") {
-    for (const script of scripts) {
-      await browser.tabs.executeScript(tabId, {
-        file: script,
-        runAt: "document_idle",
-      });
-    }
-    await browser.tabs.sendMessage(tabId, {
-      type: "scriptsLoaded",
-      scriptKey,
-    });
-    return;
+  if (!scripts.filter(s => s.endsWith(".content.js")).length) {
+    throw new Error(`Not a bundle script: ${scripts}`);
   }
-  if (available) {
-    return;
-  }
-  scripts = [
-    "/buildSettings.js",
-    "/log.js",
-    "/content/helpers.js",
-    "/content/communicate.js",
-  ]
-    .concat(scripts)
-    .concat(["/content/responder.js"]);
-
-  for (const script of scripts) {
+  const bundleScripts = scripts.map(script =>
+    script.replace(/\.content\.js$/, ".bundle.js")
+  );
+  const execScripts = ["/buildSettings.js", "/log.js"].concat(bundleScripts);
+  for (const file of execScripts) {
     try {
-      await browser.tabs.executeScript(tabId, { file: script });
+      await browser.tabs.executeScript(tabId, { file });
     } catch (error) {
       if (error.message.includes("Missing host permission for the tab")) {
         const e = new Error("That does not work on this kind of page");
@@ -66,29 +25,4 @@ export async function inject(tabId, scripts) {
       }
     }
   }
-
-  await browser.tabs.sendMessage(tabId, {
-    type: "scriptsLoaded",
-    scriptKey,
-  });
-}
-
-export async function hasScript(tabId, scripts) {
-  if (!tabId) {
-    throw new Error(`Invalid tabId: ${tabId}`);
-  }
-  if (typeof scripts === "string") {
-    scripts = [scripts];
-  }
-  const scriptKey = scripts.join(",");
-  let available;
-  try {
-    available = await browser.tabs.sendMessage(tabId, {
-      type: "ping",
-      scriptKey,
-    });
-  } catch (e) {
-    available = false;
-  }
-  return available;
 }

extension/background/content.js

@@ -21,6 +21,15 @@ for (const id in metadata.music) {
   }
 }
 
+export const namedPages = [];
+
+for (const id in metadata.name) {
+  const item = metadata.name[id];
+  for (const name of item.names) {
+    namedPages.push(name);
+  }
+}
+
 export const entityTypes = convertEntities({
   serviceName: allServiceNames,
   musicServiceName: musicServiceNames,