test_console_filtering.js

Enable keyboard shortcuts

/* Any copyright is dedicated to the Public Domain.

   http://creativecommons.org/publicdomain/zero/1.0/ */

"use strict";

const { ConsoleAPI } = ChromeUtils.importESModule(

  "resource://gre/modules/Console.sys.mjs"

);

const {

  ConsoleAPIListener,

} = require("resource://devtools/server/actors/webconsole/listeners/console-api.js");

var seenMessages = 0;

var seenTypes = 0;

var onConsoleAPICall = function (message) {

  if (message.consoleID && message.consoleID == "addon/foo") {

    Assert.equal(message.level, "warn");

    Assert.equal(message.arguments[0], "Warning from foo");

    seenTypes |= 1;

  } else if (message.addonId == "bar") {

    Assert.equal(message.level, "error");

    Assert.equal(message.arguments[0], "Error from bar");

    seenTypes |= 2;

  } else {

    Assert.equal(message.level, "log");

    Assert.equal(message.arguments[0], "Hello from default console");

    seenTypes |= 4;

  seenMessages++;

};

let policy;

registerCleanupFunction(() => {

  policy.active = false;

});

function createFakeAddonWindow({ addonId } = {}) {

  const uuidGen = Services.uuid;

  const uuid = uuidGen.generateUUID().number.slice(1, -1);

  if (policy) {

    policy.active = false;

  /* globals MatchPatternSet, WebExtensionPolicy */

  policy = new WebExtensionPolicy({

    id: addonId,

    mozExtensionHostname: uuid,

    baseURL: "file:///",

    allowedOrigins: new MatchPatternSet([]),

    localizeCallback() {},

});

  policy.active = true;

  const baseURI = Services.io.newURI(`moz-extension://${uuid}/`);

  const principal = Services.scriptSecurityManager.createContentPrincipal(

    baseURI,

{}

);

  const chromeWebNav = Services.appShell.createWindowlessBrowser(true);

  const { docShell } = chromeWebNav;

  docShell.createAboutBlankDocumentViewer(principal, principal);

  const addonWindow = docShell.docViewer.DOMDocument.defaultView;

  return { addonWindow, chromeWebNav };

/**

 * Tests that the consoleID property of the ConsoleAPI options gets passed

 * through to console messages.

*/

function run_test() {

  // console1 Test Console.sys.mjs messages tagged by the Addon SDK

  // are still filtered correctly.

  const console1 = new ConsoleAPI({

    consoleID: "addon/foo",

});

  // console2 - WebExtension page's console messages tagged

  // by 'originAttributes.addonId' are filtered correctly.

  const { addonWindow, chromeWebNav } = createFakeAddonWindow({

    addonId: "bar",

});

  const console2 = addonWindow.console;

  // console - Plain console object (messages are tagged with window ids

  // and originAttributes, but the addonId will be empty).

  console.log("Hello from default console");

  console1.warn("Warning from foo");

  console2.error("Error from bar");

  let listener = new ConsoleAPIListener(null, onConsoleAPICall);

  listener.init();

  let messages = listener.getCachedMessages();

  seenTypes = 0;

  seenMessages = 0;

  messages.forEach(onConsoleAPICall);

  Assert.equal(seenMessages, 3);

  Assert.equal(seenTypes, 7);

  seenTypes = 0;

  seenMessages = 0;

  console.log("Hello from default console");

  console1.warn("Warning from foo");

  console2.error("Error from bar");

  Assert.equal(seenMessages, 3);

  Assert.equal(seenTypes, 7);

  listener.destroy();

  listener = new ConsoleAPIListener(null, onConsoleAPICall, { addonId: "foo" });

  listener.init();

  messages = listener.getCachedMessages();

  seenTypes = 0;

  seenMessages = 0;

  messages.forEach(onConsoleAPICall);

  Assert.equal(seenMessages, 2);

  Assert.equal(seenTypes, 1);

  seenTypes = 0;

  seenMessages = 0;

  console.log("Hello from default console");

  console1.warn("Warning from foo");

  console2.error("Error from bar");

  Assert.equal(seenMessages, 1);

  Assert.equal(seenTypes, 1);

  listener.destroy();

  listener = new ConsoleAPIListener(null, onConsoleAPICall, { addonId: "bar" });

  listener.init();

  messages = listener.getCachedMessages();

  seenTypes = 0;

  seenMessages = 0;

  messages.forEach(onConsoleAPICall);

  Assert.equal(seenMessages, 3);

  Assert.equal(seenTypes, 2);

  seenTypes = 0;

  seenMessages = 0;

  console.log("Hello from default console");

  console1.warn("Warning from foo");

  console2.error("Error from bar");

  Assert.equal(seenMessages, 1);

  Assert.equal(seenTypes, 2);

  listener.destroy();

  // Close the addon window's chromeWebNav.

  chromeWebNav.close();