sousa-gecko/browser/components/urlbar/tests/browser-quickactions/browser_devtools.js

/* Any copyright is dedicated to the Public Domain.
   http://creativecommons.org/publicdomain/zero/1.0/ */

/**
 * Tests QuickActions related to DevTools.
 */

"use strict";

requestLongerTimeout(2);

ChromeUtils.defineESModuleGetters(this, {
  DevToolsShim: "chrome://devtools-startup/content/DevToolsShim.sys.mjs",
  PromiseTestUtils: "resource://testing-common/PromiseTestUtils.sys.mjs",
});

add_setup(async function setup() {
  await SpecialPowers.pushPrefEnv({
    set: [
      ["browser.urlbar.quickactions.enabled", true],
      ["browser.urlbar.secondaryActions.featureGate", true],
      ["browser.urlbar.shortcuts.quickactions", true],
    ],
  });

  registerCleanupFunction(async function () {
    [
      "browser.urlbar.quickactions.timesShownOnboardingLabel",
      "devtools.toolsidebar-width.inspector.splitsidebar",
      "devtools.toolsidebar-height.inspector",
      "devtools.everOpened",
      "devtools.toolsidebar-width.inspector",
    ].forEach(pref => Services.prefs.clearUserPref(pref));
  });
});

const assertActionButtonStatus = async (name, expectedEnabled, description) => {
  await TestUtils.waitForCondition(() =>
    window.document.querySelector(`[data-action=${name}]`)
  );
  const target = window.document.querySelector(`[data-action=${name}]`);
  Assert.equal(!target.hasAttribute("disabled"), expectedEnabled, description);
};

const hasQuickActions = win =>
  !!win.document.querySelector(".urlbarView-action-btn");

add_task(async function test_inspector() {
  const testData = [
    {
      description: "Test for 'about:' page",
      page: "about:home",
      isDevToolsUser: true,
      actionVisible: true,
      actionEnabled: true,
    },
    {
      description: "Test for another 'about:' page",
      page: "about:about",
      isDevToolsUser: true,
      actionVisible: true,
      actionEnabled: true,
    },
    {
      description: "Test for another devtools-toolbox page",
      page: "about:devtools-toolbox",
      isDevToolsUser: true,
      actionVisible: true,
      actionEnabled: false,
    },
    {
      description: "Test for web content",
      page: "https://example.com",
      isDevToolsUser: true,
      actionVisible: true,
      actionEnabled: true,
    },
    {
      description: "Test for disabled DevTools",
      page: "https://example.com",
      prefs: [["devtools.policy.disabled", true]],
      isDevToolsUser: true,
      actionVisible: true,
      actionEnabled: false,
    },
    {
      description: "Test for not DevTools user",
      page: "https://example.com",
      isDevToolsUser: false,
      actionVisible: true,
      actionEnabled: false,
    },
    {
      description: "Test for fully disabled",
      page: "https://example.com",
      prefs: [["devtools.policy.disabled", true]],
      isDevToolsUser: false,
      actionVisible: false,
    },
  ];

  const tab = await BrowserTestUtils.openNewForegroundTab(gBrowser);

  for (const {
    description,
    page,
    prefs = [],
    isDevToolsUser,
    actionEnabled,
    actionVisible,
  } of testData) {
    info(description);

    info("Set preferences");
    await SpecialPowers.pushPrefEnv({
      set: [...prefs, ["devtools.selfxss.count", isDevToolsUser ? 5 : 0]],
    });

    info("Check the button status");
    const onLoad = BrowserTestUtils.browserLoaded(gBrowser.selectedBrowser);
    BrowserTestUtils.startLoadingURIString(gBrowser.selectedBrowser, page);
    await onLoad;
    await UrlbarTestUtils.promiseAutocompleteResultPopup({
      window,
      value: "inspector",
    });

    if (actionVisible && actionEnabled) {
      await assertActionButtonStatus(
        "inspect",
        true,
        "The status of action button is correct"
      );
    } else {
      Assert.equal(
        hasQuickActions(window),
        false,
        "Result for quick actions is not shown since the inspector tool is disabled"
      );
    }

    await SpecialPowers.popPrefEnv();

    if (!actionVisible || !actionEnabled) {
      continue;
    }

    info("Do inspect action");
    EventUtils.synthesizeKey("KEY_Tab", {}, window);
    EventUtils.synthesizeKey("KEY_Enter", {}, window);
    await TestUtils.waitForCondition(
      () => DevToolsShim.hasToolboxForTab(gBrowser.selectedTab),
      "Wait for opening inspector for current selected tab"
    );
    const toolbox = DevToolsShim.getToolboxForTab(gBrowser.selectedTab);
    info("Wait for the toolbox to be initialized");
    await toolbox.isOpen;
    await TestUtils.waitForCondition(
      () => toolbox.getPanel("inspector"),
      "Wait until the inspector is ready"
    );

    info("Do inspect action again in the same page during opening inspector");
    await UrlbarTestUtils.promiseAutocompleteResultPopup({
      window,
      value: "inspector",
    });
    Assert.equal(
      hasQuickActions(window),
      false,
      "Result for quick actions is not shown since the inspector is already opening"
    );

    info(
      "Select another tool to check whether the inspector will be selected in next test even if the previous tool is not inspector"
    );
    await toolbox.selectTool("options");
    await toolbox.destroy();
  }

  BrowserTestUtils.removeTab(tab);
});

add_task(async function test_colorpicker() {
  // Non-DevTools-user, to confirm the quickaction is available to everyone.
  await SpecialPowers.pushPrefEnv({
    set: [["devtools.selfxss.count", 0]],
  });

  const tab = await BrowserTestUtils.openNewForegroundTab(
    gBrowser,
    "https://example.com"
  );

  const onPickerCommandHandled = TestUtils.topicObserved(
    "color-picker-command-handled"
  );

  await UrlbarTestUtils.promiseAutocompleteResultPopup({
    window,
    value: "color picker",
  });
  await assertActionButtonStatus(
    "colorpicker",
    true,
    "The colorpicker action button is enabled"
  );

  info("Trigger the colorpicker action");
  EventUtils.synthesizeKey("KEY_Tab", {}, window);
  EventUtils.synthesizeKey("KEY_Enter", {}, window);

  const [subject] = await onPickerCommandHandled;
  const targetFront = subject.wrappedJSObject;
  Assert.ok(targetFront, "Color picker was triggered");
  Assert.ok(
    !DevToolsShim.hasToolboxForTab(gBrowser.selectedTab),
    "No toolbox was opened for the tab"
  );

  // The eyedropper's screenshot capture may still be in-flight when we tear
  // down the tab, surfacing as a rejected request in the protocol Front.
  PromiseTestUtils.expectUncaughtRejection(/front '.*' is already destroyed/);

  BrowserTestUtils.removeTab(tab);
  await TestUtils.waitForCondition(() => targetFront.isDestroyed());

  await SpecialPowers.popPrefEnv();
});