Source code
Revision control
Copy as Markdown
Other Tools
Test Info: Warnings
- This test gets skipped with pattern: os == 'android'
- Manifest: devtools/shared/security/tests/xpcshell/xpcshell.toml
/* Any copyright is dedicated to the Public Domain.
"use strict";
const {
useDistinctSystemPrincipalLoader,
releaseDistinctSystemPrincipalLoader,
} = ChromeUtils.importESModule(
);
const { DevToolsSocketStatus } = ChromeUtils.importESModule(
);
add_task(async function () {
Services.prefs.setBoolPref("devtools.debugger.remote-enabled", true);
Services.prefs.setBoolPref("devtools.debugger.prompt-connection", false);
info("Without any server started, all states should be set to false");
checkSocketStatus(false, false);
info("Start a first server, expect all states to change to true");
const server = await setupDevToolsServer({ fromBrowserToolbox: false });
checkSocketStatus(true, true);
info("Start another server, expect all states to remain true");
const otherServer = await setupDevToolsServer({ fromBrowserToolbox: false });
checkSocketStatus(true, true);
info("Shutdown one of the servers, expect all states to remain true");
teardownDevToolsServer(otherServer);
checkSocketStatus(true, true);
info("Shutdown the other server, expect all states to change to false");
teardownDevToolsServer(server);
checkSocketStatus(false, false);
info(
"Start a 'browser toolbox' server, expect only the 'include' state to become true"
);
const browserToolboxServer = await setupDevToolsServer({
fromBrowserToolbox: true,
});
checkSocketStatus(true, false);
info(
"Shutdown the 'browser toolbox' server, expect all states to become false"
);
teardownDevToolsServer(browserToolboxServer);
checkSocketStatus(false, false);
Services.prefs.clearUserPref("devtools.debugger.remote-enabled");
Services.prefs.clearUserPref("devtools.debugger.prompt-connection");
});
function checkSocketStatus(expectedExcludeFalse, expectedExcludeTrue) {
const openedDefault = DevToolsSocketStatus.hasSocketOpened();
const openedExcludeFalse = DevToolsSocketStatus.hasSocketOpened({
excludeBrowserToolboxSockets: false,
});
const openedExcludeTrue = DevToolsSocketStatus.hasSocketOpened({
excludeBrowserToolboxSockets: true,
});
equal(
openedDefault,
openedExcludeFalse,
"DevToolsSocketStatus.hasSocketOpened should default to excludeBrowserToolboxSockets=false"
);
equal(
openedExcludeFalse,
expectedExcludeFalse,
"DevToolsSocketStatus matches the expectation for excludeBrowserToolboxSockets=false"
);
equal(
openedExcludeTrue,
expectedExcludeTrue,
"DevToolsSocketStatus matches the expectation for excludeBrowserToolboxSockets=true"
);
}
async function setupDevToolsServer({ fromBrowserToolbox }) {
info("Use the dedicated system principal loader for the DevToolsServer.");
const requester = {};
const loader = useDistinctSystemPrincipalLoader(requester);
const { DevToolsServer } = loader.require(
);
DevToolsServer.init();
DevToolsServer.registerAllActors();
DevToolsServer.allowChromeProcess = true;
const socketOptions = {
fromBrowserToolbox,
// Pass -1 to automatically choose an available port
portOrPath: -1,
};
const listener = new SocketListener(DevToolsServer, socketOptions);
ok(listener, "Socket listener created");
// Note that useDistinctSystemPrincipalLoader will lead to reuse the same
// loader if we are creating several servers in a row. The DevToolsServer
// singleton might already have sockets opened.
const listeningSockets = DevToolsServer.listeningSockets;
await listener.open();
equal(
DevToolsServer.listeningSockets,
listeningSockets + 1,
"A new listening socket was created"
);
return { DevToolsServer, listener, requester };
}
function teardownDevToolsServer({ DevToolsServer, listener, requester }) {
info("Close the listener socket");
const listeningSockets = DevToolsServer.listeningSockets;
listener.close();
equal(
DevToolsServer.listeningSockets,
listeningSockets - 1,
"A listening socket was closed"
);
if (DevToolsServer.listeningSockets == 0) {
info("Destroy the temporary devtools server");
DevToolsServer.destroy();
}
if (requester) {
releaseDistinctSystemPrincipalLoader(requester);
}
}