Bug 1837183 - Load httpd.js as a module for mochitest's server.js. r=ahal,necko-reviewers,valentin

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

Author: Standard8

layout/tools/reftest/remotereftest.py

@@ -103,12 +103,12 @@ def start(self):
         args = [
             "-g",
             self.xrePath,
-            "-f",
-            os.path.join(self.httpdPath, "httpd.js"),
             "-e",
             "const _PROFILE_PATH = '%(profile)s';const _SERVER_PORT = "
-            "'%(port)s'; const _SERVER_ADDR ='%(server)s';"
+            "'%(port)s'; const _SERVER_ADDR ='%(server)s'; "
+            "const _HTTPD_PATH = '%(httpdPath)s';"
             % {
+                "httpdPath": self.httpdPath.replace("\\", "\\\\"),
                 "profile": self.profileDir.replace("\\", "\\\\"),
                 "port": self.httpPort,
                 "server": self.webServer,

netwerk/test/httpserver/httpd.js

@@ -42,6 +42,7 @@ var EXPORTED_SYMBOLS = [
   "nsHttpHeaders",
   "overrideBinaryStreamsForTests",
   "WriteThroughCopier",
+  "setDebuggingStatus",
 ];
 
 const CC = Components.Constructor;
@@ -54,6 +55,19 @@ var DEBUG = false; // non-const *only* so tweakable in server tests
 /** True if debugging output should be timestamped. */
 var DEBUG_TIMESTAMP = false; // non-const so tweakable in server tests
 
+/**
+ * Sets the debugging status, intended for tweaking in server tests.
+ *
+ * @param {boolean} debug
+ *   Enables debugging output
+ * @param {boolean} debugTimestamp
+ *   Enables timestamping of the debugging output.
+ */
+function setDebuggingStatus(debug, debugTimestamp) {
+  DEBUG = debug;
+  DEBUG_TIMESTAMP = debugTimestamp;
+}
+
 const { AppConstants } = ChromeUtils.importESModule(
   "resource://gre/modules/AppConstants.sys.mjs"
 );

testing/mochitest/runtests.py

@@ -546,13 +546,13 @@ def start(self):
         args = [
             "-g",
             self._xrePath,
-            "-f",
-            os.path.join(self._httpdPath, "httpd.js"),
             "-e",
             "const _PROFILE_PATH = '%(profile)s'; const _SERVER_PORT = '%(port)s'; "
             "const _SERVER_ADDR = '%(server)s'; const _TEST_PREFIX = %(testPrefix)s; "
-            "const _DISPLAY_RESULTS = %(displayResults)s;"
+            "const _DISPLAY_RESULTS = %(displayResults)s; "
+            "const _HTTPD_PATH = '%(httpdPath)s';"
             % {
+                "httpdPath": self._httpdPath.replace("\\", "\\\\"),
                 "profile": self._profileDir.replace("\\", "\\\\"),
                 "port": self.httpPort,
                 "server": self.webServer,

testing/mochitest/server.js

@@ -6,27 +6,50 @@
 
 // We expect these to be defined in the global scope by runtest.py.
 /* global __LOCATION__, _PROFILE_PATH, _SERVER_PORT, _SERVER_ADDR, _DISPLAY_RESULTS,
-          _TEST_PREFIX */
+          _TEST_PREFIX, _HTTPD_PATH */
 // Defined by xpcshell
 /* global quit */
 
-/* import-globals-from ../../netwerk/test/httpserver/httpd.js */
 /* eslint-disable mozilla/use-chromeutils-generateqi */
 
 // Set up a protocol substituion so that we can load the httpd.js file.
 let protocolHandler = Services.io
   .getProtocolHandler("resource")
   .QueryInterface(Ci.nsIResProtocolHandler);
-let httpdJSPath = __LOCATION__.parent;
-let modulesURI = Services.io.newFileURI(httpdJSPath);
-protocolHandler.setSubstitution("mochitest-server", modulesURI);
+let httpdJSPath = PathUtils.toFileURI(_HTTPD_PATH);
+protocolHandler.setSubstitution(
+  "httpd-server",
+  Services.io.newURI(httpdJSPath)
+);
+
+const { HttpServer, dumpn, setDebuggingStatus } = ChromeUtils.import(
+  "resource://httpd-server/httpd.js"
+);
+
+protocolHandler.setSubstitution(
+  "mochitest-server",
+  Services.io.newFileURI(__LOCATION__.parent)
+);
 
 /* import-globals-from mochitestListingsUtils.js */
 Services.scriptloader.loadSubScript(
   "resource://mochitest-server/mochitestListingsUtils.js",
   this
 );
 
+const CC = Components.Constructor;
+
+const FileInputStream = CC(
+  "@mozilla.org/network/file-input-stream;1",
+  "nsIFileInputStream",
+  "init"
+);
+const ConverterInputStream = CC(
+  "@mozilla.org/intl/converter-input-stream;1",
+  "nsIConverterInputStream",
+  "init"
+);
+
 // Disable automatic network detection, so tests work correctly when
 // not connected to a network.
 // eslint-disable-next-line mozilla/use-services
@@ -43,24 +66,21 @@ function serverStopped() {
   _quitting = true;
 }
 
-// only run the "main" section if httpd.js was loaded ahead of us
-if (this.nsHttpServer) {
-  //
-  // SCRIPT CODE
-  //
-  runServer();
-
-  // We can only have gotten here if the /server/shutdown path was requested.
-  if (_quitting) {
-    dumpn("HTTP server stopped, all pending requests complete");
-    quit(0);
-  }
+//
+// SCRIPT CODE
+//
+runServer();
 
-  // Impossible as the stop callback should have been called, but to be safe...
-  dumpn("TEST-UNEXPECTED-FAIL | failure to correctly shut down HTTP server");
-  quit(1);
+// We can only have gotten here if the /server/shutdown path was requested.
+if (_quitting) {
+  dumpn("HTTP server stopped, all pending requests complete");
+  quit(0);
 }
 
+// Impossible as the stop callback should have been called, but to be safe...
+dumpn("TEST-UNEXPECTED-FAIL | failure to correctly shut down HTTP server");
+quit(1);
+
 var serverBasePath;
 var displayResults = true;
 
@@ -170,7 +190,7 @@ function runServer() {
 
 /** Creates and returns an HTTP server configured to serve Mochitests. */
 function createMochitestServer(serverBasePath) {
-  var server = new nsHttpServer();
+  var server = new HttpServer();
 
   server.registerDirectory("/", serverBasePath);
   server.registerPathHandler("/server/shutdown", serverShutdown);
@@ -308,16 +328,13 @@ function serverDebug(metadata, response) {
   if (metadata.queryString === "0") {
     // do this now so it gets logged with the old mode
     dumpn("Server debug logs disabled.");
-    DEBUG = false;
-    DEBUG_TIMESTAMP = false;
+    setDebuggingStatus(false, false);
     mode = "disabled";
   } else if (metadata.queryString === "1") {
-    DEBUG = true;
-    DEBUG_TIMESTAMP = false;
+    setDebuggingStatus(true, false);
     mode = "enabled";
   } else if (metadata.queryString === "2") {
-    DEBUG = true;
-    DEBUG_TIMESTAMP = true;
+    setDebuggingStatus(true, true);
     mode = "enabled, with timestamps";
   } else {
     return;

testing/xpcshell/remotexpcshelltests.py

@@ -638,8 +638,8 @@ def setupUtilities(self):
                     file=sys.stderr,
                 )
 
-        local = os.path.join(self.localBin, "components/httpd.js")
-        remoteFile = posixpath.join(self.remoteComponentsDir, "httpd.js")
+        local = os.path.join(self.localBin, "components/httpd.sys.mjs")
+        remoteFile = posixpath.join(self.remoteComponentsDir, "httpd.sys.mjs")
         self.device.push(local, remoteFile)
         self.device.chmod(remoteFile)