Bug 1085393 - Remove pre-Runtime ADB support. r=ochameau draft
authorJ. Ryan Stinnett <jryans@gmail.com>
Thu, 06 Apr 2017 20:51:53 -0500
changeset 557600 3b2b5f466fae1adc377ed0224f7ec692113e4986
parent 557282 facaf90aeaaf6d7cf5e2966f9f918319536bddea
child 623098 5fd66611cc49ba8d8528bbdf32b4cae1d15d6650
push id52764
push userbmo:jryans@gmail.com
push dateFri, 07 Apr 2017 01:57:53 +0000
reviewersochameau
bugs1085393
milestone55.0a1
Bug 1085393 - Remove pre-Runtime ADB support. r=ochameau Removes support for old versions of ADB Helper which haven't been in use for years. It also removes `test_telemetry` because it referenced this code and is also disabled for all configurations in a product we intend to remove. MozReview-Commit-ID: AUAbwxVczWb
devtools/client/webide/modules/runtimes.js
devtools/client/webide/test/chrome.ini
devtools/client/webide/test/test_telemetry.html
--- a/devtools/client/webide/modules/runtimes.js
+++ b/devtools/client/webide/modules/runtimes.js
@@ -232,74 +232,16 @@ var SimulatorScanner = {
   }
 
 };
 
 EventEmitter.decorate(SimulatorScanner);
 RuntimeScanners.add(SimulatorScanner);
 
 /**
- * TODO: Remove this comaptibility layer in the future (bug 1085393)
- * This runtime exists to support the ADB Helper add-on below version 0.7.0.
- *
- * This scanner will list all ADB devices as runtimes, even if they may or may
- * not actually connect (since the |DeprecatedUSBRuntime| assumes a Firefox OS
- * device).
- */
-var DeprecatedAdbScanner = {
-
-  _runtimes: [],
-
-  enable() {
-    this._updateRuntimes = this._updateRuntimes.bind(this);
-    Devices.on("register", this._updateRuntimes);
-    Devices.on("unregister", this._updateRuntimes);
-    Devices.on("addon-status-updated", this._updateRuntimes);
-    this._updateRuntimes();
-  },
-
-  disable() {
-    Devices.off("register", this._updateRuntimes);
-    Devices.off("unregister", this._updateRuntimes);
-    Devices.off("addon-status-updated", this._updateRuntimes);
-  },
-
-  _emitUpdated() {
-    this.emit("runtime-list-updated");
-  },
-
-  _updateRuntimes() {
-    this._runtimes = [];
-    for (let id of Devices.available()) {
-      let runtime = new DeprecatedUSBRuntime(id);
-      this._runtimes.push(runtime);
-      runtime.updateNameFromADB().then(() => {
-        this._emitUpdated();
-      }, () => {});
-    }
-    this._emitUpdated();
-  },
-
-  scan() {
-    return promise.resolve();
-  },
-
-  listRuntimes: function () {
-    return this._runtimes;
-  }
-
-};
-
-EventEmitter.decorate(DeprecatedAdbScanner);
-RuntimeScanners.add(DeprecatedAdbScanner);
-
-// ADB Helper 0.7.0 and later will replace this scanner on startup
-exports.DeprecatedAdbScanner = DeprecatedAdbScanner;
-
-/**
  * This is a lazy ADB scanner shim which only tells the ADB Helper to start and
  * stop as needed.  The real scanner that lists devices lives in ADB Helper.
  * ADB Helper 0.8.0 and later wait until these signals are received before
  * starting ADB polling.  For earlier versions, they have no effect.
  */
 var LazyAdbScanner = {
 
   enable() {
@@ -420,68 +362,16 @@ var RuntimeTypes = exports.RuntimeTypes 
   USB: "USB",
   WIFI: "WIFI",
   SIMULATOR: "SIMULATOR",
   REMOTE: "REMOTE",
   LOCAL: "LOCAL",
   OTHER: "OTHER"
 };
 
-/**
- * TODO: Remove this comaptibility layer in the future (bug 1085393)
- * This runtime exists to support the ADB Helper add-on below version 0.7.0.
- *
- * This runtime assumes it is connecting to a Firefox OS device.
- */
-function DeprecatedUSBRuntime(id) {
-  this._id = id;
-}
-
-DeprecatedUSBRuntime.prototype = {
-  type: RuntimeTypes.USB,
-  get device() {
-    return Devices.getByName(this._id);
-  },
-  connect: function (connection) {
-    if (!this.device) {
-      return promise.reject(new Error("Can't find device: " + this.name));
-    }
-    return this.device.connect().then((port) => {
-      connection.host = "localhost";
-      connection.port = port;
-      connection.connect();
-    });
-  },
-  get id() {
-    return this._id;
-  },
-  get name() {
-    return this._productModel || this._id;
-  },
-  updateNameFromADB: function () {
-    if (this._productModel) {
-      return promise.reject();
-    }
-    let deferred = promise.defer();
-    if (this.device && this.device.shell) {
-      this.device.shell("getprop ro.product.model").then(stdout => {
-        this._productModel = stdout;
-        deferred.resolve();
-      }, () => {});
-    } else {
-      this._productModel = null;
-      deferred.reject();
-    }
-    return deferred.promise;
-  },
-};
-
-// For testing use only
-exports._DeprecatedUSBRuntime = DeprecatedUSBRuntime;
-
 function WiFiRuntime(deviceName) {
   this.deviceName = deviceName;
 }
 
 WiFiRuntime.prototype = {
   type: RuntimeTypes.WIFI,
   // Mark runtime as taking a long time to connect
   prolongedConnection: true,
--- a/devtools/client/webide/test/chrome.ini
+++ b/devtools/client/webide/test/chrome.ini
@@ -52,18 +52,16 @@ skip-if = (os == "linux") # Bug 1024734
 [test_duplicate_import.html]
 [test_runtime.html]
 [test_manifestUpdate.html]
 [test_addons.html]
 skip-if = true # Bug 1201392 - Update add-ons after migration
 [test_device_runtime.html]
 [test_autoconnect_runtime.html]
 [test_autoselect_project.html]
-[test_telemetry.html]
-skip-if = true # Bug 1201392 - Update add-ons after migration
 [test_device_preferences.html]
 [test_fullscreenToolbox.html]
 [test_zoom.html]
 [test_build.html]
 [test_simulators.html]
 skip-if = true # Bug 1281138 - intermittent failures
 [test_toolbox.html]
 [test_app_validator.html]
deleted file mode 100644
--- a/devtools/client/webide/test/test_telemetry.html
+++ /dev/null
@@ -1,325 +0,0 @@
-<!DOCTYPE html>
-
-<html>
-
-  <head>
-    <meta charset="utf8">
-    <title></title>
-
-    <script type="application/javascript" src="chrome://mochikit/content/tests/SimpleTest/SimpleTest.js"></script>
-    <script type="application/javascript" src="chrome://mochikit/content/chrome-harness.js"></script>
-    <script type="application/javascript" src="head.js"></script>
-    <link rel="stylesheet" type="text/css" href="chrome://mochikit/content/tests/SimpleTest/test.css">
-  </head>
-
-  <body>
-
-    <script type="application/javascript">
-      const Telemetry = require("devtools/client/shared/telemetry");
-      const { _DeprecatedUSBRuntime, _WiFiRuntime, _SimulatorRuntime,
-              _gRemoteRuntime, _gLocalRuntime, RuntimeTypes }
-            = require("devtools/client/webide/modules/runtimes");
-
-      // Because we need to gather stats for the period of time that a tool has
-      // been opened we make use of setTimeout() to create tool active times.
-      const TOOL_DELAY = 200;
-
-      function patchTelemetry() {
-        Telemetry.prototype.telemetryInfo = {};
-        Telemetry.prototype._oldlog = Telemetry.prototype.log;
-        Telemetry.prototype.log = function(histogramId, value) {
-          if (histogramId) {
-            if (!this.telemetryInfo[histogramId]) {
-              this.telemetryInfo[histogramId] = [];
-            }
-            this.telemetryInfo[histogramId].push(value);
-          }
-        }
-        Telemetry.prototype._oldlogKeyed = Telemetry.prototype.logKeyed;
-        Telemetry.prototype.logKeyed = function(histogramId, key, value) {
-          // This simple reduction is enough to test WebIDE's usage
-          this.log(`${histogramId}|${key}`, value);
-        }
-      }
-
-      function resetTelemetry() {
-        Telemetry.prototype.log = Telemetry.prototype._oldlog;
-        Telemetry.prototype.logKeyed = Telemetry.prototype._oldlogKeyed;
-        delete Telemetry.prototype._oldlog;
-        delete Telemetry.prototype._oldlogKeyed;
-        delete Telemetry.prototype.telemetryInfo;
-      }
-
-      function cycleWebIDE() {
-        return Task.spawn(function*() {
-          let win = yield openWebIDE();
-          // Wait a bit, so we're open for a non-zero time
-          yield waitForTime(TOOL_DELAY);
-          yield closeWebIDE(win);
-        });
-      }
-
-      function addFakeRuntimes(win) {
-        // We use the real runtimes here (and switch out some functionality)
-        // so we can ensure that logging happens as it would in real use.
-
-        let usb = new _DeprecatedUSBRuntime("fakeUSB");
-        // Use local pipe instead
-        usb.connect = function(connection) {
-          ok(connection, win.AppManager.connection, "connection is valid");
-          connection.host = null; // force connectPipe
-          connection.connect();
-          return promise.resolve();
-        };
-        win.AppManager.runtimeList.usb.push(usb);
-
-        let wifi = new _WiFiRuntime("fakeWiFi");
-        // Use local pipe instead
-        wifi.connect = function(connection) {
-          ok(connection, win.AppManager.connection, "connection is valid");
-          connection.host = null; // force connectPipe
-          connection.connect();
-          return promise.resolve();
-        };
-        win.AppManager.runtimeList.wifi.push(wifi);
-
-        let sim = new _SimulatorRuntime({ id: "fakeSimulator" });
-        // Use local pipe instead
-        sim.connect = function(connection) {
-          ok(connection, win.AppManager.connection, "connection is valid");
-          connection.host = null; // force connectPipe
-          connection.connect();
-          return promise.resolve();
-        };
-        Object.defineProperty(sim, "name", {
-          get() {
-            return this.version;
-          }
-        });
-        win.AppManager.runtimeList.simulator.push(sim);
-
-        let remote = _gRemoteRuntime;
-        // Use local pipe instead
-        remote.connect = function(connection) {
-          ok(connection, win.AppManager.connection, "connection is valid");
-          connection.host = null; // force connectPipe
-          connection.connect();
-          return promise.resolve();
-        };
-        let local = _gLocalRuntime;
-
-        let other = Object.create(_gLocalRuntime);
-        other.type = RuntimeTypes.OTHER;
-
-        win.AppManager.runtimeList.other = [remote, local, other];
-
-        win.AppManager.update("runtime-list");
-      }
-
-      function addTestApp(win) {
-        return Task.spawn(function*() {
-          let packagedAppLocation = getTestFilePath("../app");
-          let winProject = getProjectWindow(win);
-          let onValidated = waitForUpdate(win, "project-validated");
-          let onDetails = waitForUpdate(win, "details");
-          yield winProject.projectList.importPackagedApp(packagedAppLocation);
-          yield onValidated;
-          yield onDetails;
-        });
-      }
-
-      function startConnection(win, docRuntime, type, index) {
-        let panelNode = docRuntime.querySelector("#runtime-panel");
-        let items = panelNode.querySelectorAll(".runtime-panel-item-" + type);
-        if (index === undefined) {
-          is(items.length, 1, "Found one runtime button");
-        }
-
-        let deferred = promise.defer();
-        win.AppManager.connection.once(
-            win.Connection.Events.CONNECTED,
-            () => deferred.resolve());
-
-        items[index || 0].click();
-
-        return deferred.promise;
-      }
-
-      function waitUntilConnected(win) {
-        return Task.spawn(function*() {
-          ok(win.document.querySelector("window").className, "busy", "UI is busy");
-          yield win.UI._busyPromise;
-          is(Object.keys(DebuggerServer._connections).length, 1, "Connected");
-          // Logging runtime info needs to use the device actor
-          yield waitForUpdate(win, "runtime-global-actors");
-          // Ensure detailed telemetry is recorded
-          yield waitForUpdate(win, "runtime-telemetry");
-        });
-      }
-
-      function connectToRuntime(win, docRuntime, type, index) {
-        return Task.spawn(function*() {
-          startConnection(win, docRuntime, type, index);
-          yield waitUntilConnected(win);
-        });
-      }
-
-      function checkResults() {
-        let result = Telemetry.prototype.telemetryInfo;
-        for (let [histId, value] of Object.entries(result)) {
-          if (histId === "DEVTOOLS_WEBIDE_IMPORT_PROJECT_BOOLEAN") {
-            ok(value.length === 1 && !!value[0],
-               histId + " has 1 successful entry");
-          } else if (histId ===
-                     "DEVTOOLS_WEBIDE_PROJECT_EDITOR_OPENED_COUNT") {
-            ok(value.length === 1 && !!value[0],
-               histId + " has 1 successful entry");
-          } else if (histId === "DEVTOOLS_WEBIDE_OPENED_COUNT") {
-            ok(value.length > 1, histId + " has more than one entry");
-
-            let okay = value.every(function(element) {
-              return !!element;
-            });
-
-            ok(okay, "All " + histId + " entries are true");
-          } else if (histId.endsWith("WEBIDE_TIME_ACTIVE_SECONDS")) {
-            ok(value.length > 1, histId + " has more than one entry");
-
-            let okay = value.every(function(element) {
-              return element > 0;
-            });
-
-            ok(okay, "All " + histId + " entries have time > 0");
-          } else if (histId.endsWith("EDITOR_TIME_ACTIVE_SECONDS")) {
-            ok(value.length === 1 && value[0] > 0,
-               histId + " has 1 entry with time > 0");
-          } else if (histId === "DEVTOOLS_WEBIDE_CONNECTION_RESULT") {
-            ok(value.length === 6, histId + " has 6 connection results");
-
-            let okay = value.every(function(element) {
-              return !!element;
-            });
-
-            ok(okay, "All " + histId + " connections succeeded");
-          } else if (histId.endsWith("CONNECTION_RESULT")) {
-            ok(value.length === 1 && !!value[0],
-               histId + " has 1 successful connection");
-          } else if (histId === "DEVTOOLS_WEBIDE_CONNECTION_TIME_SECONDS") {
-            ok(value.length === 6, histId + " has 6 connection results");
-
-            let okay = value.every(function(element) {
-              return element > 0;
-            });
-
-            ok(okay, "All " + histId + " connections have time > 0");
-          } else if (histId.endsWith("USED")) {
-            ok(value.length === 6, histId + " has 6 connection actions");
-
-            let okay = value.every(function(element) {
-              return !element;
-            });
-
-            ok(okay, "All " + histId + " actions were skipped");
-          } else if (histId === "DEVTOOLS_WEBIDE_CONNECTED_RUNTIME_TYPE|USB") {
-            is(value.length, 1, histId + " has 1 connection results");
-          } else if (histId === "DEVTOOLS_WEBIDE_CONNECTED_RUNTIME_TYPE|WIFI") {
-            is(value.length, 1, histId + " has 1 connection results");
-          } else if (histId === "DEVTOOLS_WEBIDE_CONNECTED_RUNTIME_TYPE|SIMULATOR") {
-            is(value.length, 1, histId + " has 1 connection results");
-          } else if (histId === "DEVTOOLS_WEBIDE_CONNECTED_RUNTIME_TYPE|REMOTE") {
-            is(value.length, 1, histId + " has 1 connection results");
-          } else if (histId === "DEVTOOLS_WEBIDE_CONNECTED_RUNTIME_TYPE|LOCAL") {
-            is(value.length, 1, histId + " has 1 connection results");
-          } else if (histId === "DEVTOOLS_WEBIDE_CONNECTED_RUNTIME_TYPE|OTHER") {
-            is(value.length, 1, histId + " has 1 connection results");
-          } else if (histId === "DEVTOOLS_WEBIDE_CONNECTED_RUNTIME_ID|fakeUSB") {
-            is(value.length, 1, histId + " has 1 connection results");
-          } else if (histId === "DEVTOOLS_WEBIDE_CONNECTED_RUNTIME_ID|fakeWiFi") {
-            is(value.length, 1, histId + " has 1 connection results");
-          } else if (histId === "DEVTOOLS_WEBIDE_CONNECTED_RUNTIME_ID|fakeSimulator") {
-            is(value.length, 1, histId + " has 1 connection results");
-          } else if (histId === "DEVTOOLS_WEBIDE_CONNECTED_RUNTIME_ID|unknown") {
-            is(value.length, 1, histId + " has 1 connection results");
-          } else if (histId === "DEVTOOLS_WEBIDE_CONNECTED_RUNTIME_ID|local") {
-            is(value.length, 2, histId + " has 2 connection results");
-          } else if (histId.startsWith("DEVTOOLS_WEBIDE_CONNECTED_RUNTIME_PROCESSOR")) {
-            let processor = histId.split("|")[1];
-            is(processor, Services.appinfo.XPCOMABI.split("-")[0], "Found runtime processor");
-            is(value.length, 6, histId + " has 6 connection results");
-          } else if (histId.startsWith("DEVTOOLS_WEBIDE_CONNECTED_RUNTIME_OS")) {
-            let os = histId.split("|")[1];
-            is(os, Services.appinfo.OS, "Found runtime OS");
-            is(value.length, 6, histId + " has 6 connection results");
-          } else if (histId.startsWith("DEVTOOLS_WEBIDE_CONNECTED_RUNTIME_PLATFORM_VERSION")) {
-            let platformversion = histId.split("|")[1];
-            is(platformversion, Services.appinfo.platformVersion, "Found runtime platform version");
-            is(value.length, 6, histId + " has 6 connection results");
-          } else if (histId.startsWith("DEVTOOLS_WEBIDE_CONNECTED_RUNTIME_APP_TYPE")) {
-            let apptype = histId.split("|")[1];
-            is(apptype, "firefox", "Found runtime app type");
-            is(value.length, 6, histId + " has 6 connection results");
-          } else if (histId.startsWith("DEVTOOLS_WEBIDE_CONNECTED_RUNTIME_VERSION")) {
-            let version = histId.split("|")[1];
-            is(version, Services.appinfo.version, "Found runtime version");
-            is(value.length, 6, histId + " has 6 connection results");
-          } else {
-            ok(false, "Unexpected " + histId + " was logged");
-          }
-        }
-      }
-
-      window.onload = function() {
-        SimpleTest.testInChaosMode();
-        SimpleTest.waitForExplicitFinish();
-
-        let win;
-
-        SimpleTest.registerCleanupFunction(() => {
-          return Task.spawn(function*() {
-            if (win) {
-              yield closeWebIDE(win);
-            }
-            DebuggerServer.destroy();
-            yield removeAllProjects();
-            resetTelemetry();
-          });
-        });
-
-        Task.spawn(function*() {
-          if (!DebuggerServer.initialized) {
-            DebuggerServer.init();
-            DebuggerServer.addBrowserActors();
-          }
-
-          patchTelemetry();
-
-          // Cycle once, so we can test for multiple opens
-          yield cycleWebIDE();
-
-          win = yield openWebIDE();
-          let docRuntime = getRuntimeDocument(win);
-
-          // Wait a bit, so we're open for a non-zero time
-          yield waitForTime(TOOL_DELAY);
-          addFakeRuntimes(win);
-          yield addTestApp(win);
-
-          // Each one should log a connection result and non-zero connection
-          // time
-          yield connectToRuntime(win, docRuntime, "usb");
-          yield connectToRuntime(win, docRuntime, "wifi");
-          yield connectToRuntime(win, docRuntime, "simulator");
-          yield connectToRuntime(win, docRuntime, "other", 0 /* remote */);
-          yield connectToRuntime(win, docRuntime, "other", 1 /* local */);
-          yield connectToRuntime(win, docRuntime, "other", 2 /* other */);
-          yield closeWebIDE(win);
-          win = null;
-
-          checkResults();
-
-          SimpleTest.finish();
-        });
-      }
-    </script>
-  </body>
-</html>