Fix #2643, force onboarding when you visit /#hello

addon/webextension/background/main.js

@@ -72,6 +72,18 @@ this.main = (function() {
       });
   }
 
+  function startSelectionWithOnboarding(tab) {
+    return analytics.refreshTelemetryPref().then(() => {
+      return selectorLoader.testIfLoaded(tab.id);
+    }).then((isLoaded) => {
+      if (!isLoaded) {
+        sendEvent("start-shot", "site-request");
+        setIconActive(true, tab.id);
+        selectorLoader.toggle(tab.id, false);
+      }
+    });
+  }
+
   function shouldOpenMyShots(url) {
     return /^about:(?:newtab|blank)/i.test(url) || /^resource:\/\/activity-streams\//i.test(url);
   }
@@ -295,5 +307,10 @@ this.main = (function() {
     return catcher.watchPromise(browser.tabs.create({url: "https://www.mozilla.org/privacy/firefox-cloud/"}));
   });
 
+  // A Screenshots page wants us to start/force onboarding
+  communication.register("requestOnboarding", (sender) => {
+    return startSelectionWithOnboarding(sender.tab);
+  });
+
   return exports;
 })();

addon/webextension/background/selectorLoader.js

@@ -48,6 +48,15 @@ this.selectorLoader = (function() {
     });
   };
 
+  exports.testIfLoaded = function(tabId) {
+    return browser.tabs.executeScript(tabId, {
+      code: "!!this.selectorLoader",
+      runAt: "document_start"
+    }).then(result => {
+      return result && result[0];
+    });
+  };
+
   exports.loadModules = function(tabId, hasSeenOnboarding) {
     if (hasSeenOnboarding) {
       return executeModules(tabId, standardScripts.concat(selectorScripts));

addon/webextension/sitehelper.js

@@ -31,6 +31,10 @@ this.sitehelper = (function() {
     }));
   }));
 
+  document.addEventListener("request-onboarding", catcher.watchFunction((event) => {
+    callBackground("requestOnboarding");
+  }));
+
   // Depending on the script loading order, the site might get the addon-present event,
   // but probably won't - instead the site will ask for that event after it has loaded
   document.addEventListener("request-addon-present", catcher.watchFunction(() => {

docs/METRICS.md

@@ -102,6 +102,7 @@ The primary change was in `server/src/pages/shot/share-buttons.js`
 1. [x] Toggle shot button on `addon/start-shot/toolbar-button` (previous to 54 launch the label was `toolbar-pageshot-button`)
 2. [ ] Use keyboard shortcut to start shot `addon/start-shot/keyboard-shortcut` (accel-alt-control-c) (FIXME: not yet implemented)
 3. [x] Use the right-click context menu to start a shot `addon/start-shot/context-menu`
+3. [x] Start shot with onboarding because the site requested it (typically a visit to `/#hello`) `addon/start-shot/site-request`
 2. [x] Make a selection `addon/make-selection/selection-drag` with `cd2: {px width}, cd1: {px height}`
 3. [x] Make a selection by clicking on an element `addon/make-selection/selection-click` with `cd2: {px width}, cd1: {px height}`
 4. [x] Click but fail to find an element that can be selected `addon/no-selection/no-element-found` (error case, not sure when it happens)

server/src/pages/homepage/controller.js

@@ -14,4 +14,12 @@ function render() {
   page.render(model);
 }
 
+document.addEventListener("addon-present", () => {
+  if (location.hash === "#hello") {
+    document.dispatchEvent(new CustomEvent("request-onboarding"));
+  }
+});
+
+document.dispatchEvent(new CustomEvent("request-addon-present"));
+
 window.controller = exports;