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

"use strict";

// Verifies the aboutaddons-themes-picker component behaviour in about:addons.

const { AddonTestUtils } = ChromeUtils.importESModule(
  "resource://testing-common/AddonTestUtils.sys.mjs"
);

const { getThemesList } = ChromeUtils.importESModule(
  "moz-src:///browser/themes/ThemesList.sys.mjs"
);

const { getL10nIdForThemeProp, themeIdPrefix } = ChromeUtils.importESModule(
  "resource://gre/modules/addons/ThemesBundledLocalization.sys.mjs"
);

AddonTestUtils.initMochitest(this);

const PREF_NOVA_ENABLED = "browser.nova.enabled";
const PREF_NOVA_THEMES_PICKER = "browser.aboutaddons.novaThemesPickerEnabled";
const PREF_ACTIVE_THEME_ID = "extensions.activeThemeID";

const DEFAULT_THEME_ID = "default-theme@mozilla.org";
const NOVA_SUN_ID = "nova-sun@mozilla.org";
const DEFAULT_THEME_ID_PREFIX = "default-theme";
const NOVA_SUN_ID_PREFIX = "nova-sun";

const DEFAULT_THEME_PREVIEW_URL =
  "chrome://mozapps/content/extensions/default-theme/preview.svg";
const DEFAULT_THEME_PREVIEW_NOVA_URL =
  "chrome://mozapps/content/extensions/default-theme/preview-nova.svg";

let ALL_THEME_IDS;

add_setup(async function () {
  const themesListManager = await getThemesList({
    installSource: "about:addons",
  });
  ALL_THEME_IDS = themesListManager
    .getThemesInfo()
    .map(themeInfo => themeInfo.id);
});

const getThemesPicker = doc => doc.querySelector("aboutaddons-themes-picker");

function getThemeCard(picker, idPrefix) {
  return [...picker.themeCards].find(card => card.dataset.theme === idPrefix);
}

function getThemeButton(card) {
  return card.querySelector(".theme-card-footer moz-button");
}

async function getThemePreviewSrc(card) {
  const themePreview = card.querySelector("theme-preview");
  await themePreview.updateComplete;
  return card.querySelector(".card-heading-image")?.src;
}

async function waitForThemesPickerReady(picker) {
  await TestUtils.waitForCondition(
    () => picker.themeCards.length,
    "Waiting for the themes picker to finish loading its theme list"
  );
  await picker.updateComplete;
}

function createNovaThemeXPI(themeId, themeName) {
  const mockNovaThemeXPI = AddonTestUtils.createTempWebExtensionFile({
    manifest: {
      name: themeName,
      version: "1.0",
      theme: {},
      browser_specific_settings: { gecko: { id: themeId } },
    },
  });
  // Make sure to uninstall the mock nova theme if still installed when this
  // test file is exiting.
  registerCleanupFunction(async function cleanupInstalledMockNovaTheme() {
    const mockNovaTheme = await AddonManager.getAddonByID(themeId);
    await mockNovaTheme?.uninstall();
  });
  return mockNovaThemeXPI;
}

// Mocks the AddonRepository "get addons" endpoint so that
// ThemesList.updateThemeState's install-via-AddonRepository path (used by
// the picker's Install button) resolves to a local XPI instead of the real
// AMO service. Omit `xpi` to simulate a broken/unreachable theme download
// instead (the resolved XPI url will 404).
function setupAddonRepoServer(themeId, themeName, xpi) {
  const server = AddonTestUtils.createHttpServer({ hosts: ["example.com"] });
  if (xpi) {
    server.registerFile("/theme.xpi", xpi);
  }
  AddonTestUtils.registerJSON(server, "/addons.json", {
    page_size: 1,
    page_count: 1,
    count: 1,
    next: null,
    previous: null,
    results: [
      {
        guid: themeId,
        name: themeName,
        type: "statictheme",
        current_version: {
          version: "1.0",
          // eslint-disable-next-line sdl/no-insecure-url
          files: [{ platform: "all", url: "http://example.com/theme.xpi" }],
        },
      },
    ],
  });

  Services.prefs.setCharPref(
    "extensions.getAddons.get.url",
    // eslint-disable-next-line sdl/no-insecure-url
    "http://example.com/addons.json"
  );

  function cleanupAddonRepoServer() {
    Services.prefs.clearUserPref("extensions.getAddons.get.url");
  }
  registerCleanupFunction(cleanupAddonRepoServer);
  return cleanupAddonRepoServer;
}

// Verifies that the Nova themes picker can be opt-ed out through
// the "browser.aboutaddons.novaThemesPickerEnabled" pref independently
// from Nova (in case other apps built on top of Gecko, e.g. Thunderbird,
// would like to adopt Nova restyle without inheriting the Nova themes
// picker).
add_task(async function test_picker_hidden_when_pref_disabled() {
  await SpecialPowers.pushPrefEnv({
    set: [
      [PREF_NOVA_ENABLED, true],
      [PREF_NOVA_THEMES_PICKER, false],
    ],
  });

  const win = await loadInitialView("theme");
  const picker = getThemesPicker(win.document);
  Assert.ok(picker, "aboutaddons-themes-picker element exists in the DOM");
  await picker.updateComplete;
  Assert.ok(
    !picker.pickerCard,
    "Themes grid should not be rendered when novaThemesPickerEnabled is false"
  );

  await closeView(win);
  await SpecialPowers.popPrefEnv();
});

// Verifies that on builds where Nova isn't enabled yet the Nova themes picker
// stays hidden, and the default theme falls back to its non-Nova preview
// image in the regular themes list.
add_task(async function test_picker_hidden_when_nova_disabled() {
  await SpecialPowers.pushPrefEnv({
    set: [
      [PREF_NOVA_ENABLED, false],
      [PREF_NOVA_THEMES_PICKER, true],
    ],
  });

  const win = await loadInitialView("theme");
  const picker = getThemesPicker(win.document);
  Assert.ok(
    !BrowserTestUtils.isVisible(picker),
    "Themes grid should be hidden when browser.nova.enabled is false"
  );

  const defaultAddonCard = getAddonCard(win, DEFAULT_THEME_ID);
  Assert.equal(
    await getThemePreviewSrc(defaultAddonCard),
    DEFAULT_THEME_PREVIEW_URL,
    "default theme uses the non-Nova preview image when browser.nova.enabled is false"
  );

  await closeView(win);
  await SpecialPowers.popPrefEnv();
});

// Verifies that all the Nova themes are shown in the Nova Themes grid
// moz-card, they are all localized as expected, and the theme preview
// svg images bundled into the Firefox build are being used for all
// the AMO-hosted Nova themes shown in the grid.
add_task(async function test_picker_renders_all_known_themes() {
  await SpecialPowers.pushPrefEnv({
    set: [
      [PREF_NOVA_ENABLED, true],
      [PREF_NOVA_THEMES_PICKER, true],
    ],
  });

  // Make sure the default theme is the active theme.
  const defaultAddon = await AddonManager.getAddonByID(DEFAULT_THEME_ID);
  await defaultAddon.enable();

  const win = await loadInitialView("theme");
  const picker = getThemesPicker(win.document);
  await waitForThemesPickerReady(picker);

  // Expand the grid to see every theme card. The expand/collapse
  // behaviour is covered by test_picker_show_more_show_less below.
  picker.expandToggle.click();
  await picker.updateComplete;

  for (const themeId of ALL_THEME_IDS) {
    const idPrefix = themeIdPrefix(themeId);
    const card = getThemeCard(picker, idPrefix);
    Assert.ok(card, `theme card for "${idPrefix}" is rendered`);
    Assert.equal(
      card.querySelector(".theme-name").getAttribute("data-l10n-id"),
      getL10nIdForThemeProp(themeId, "name"),
      `"${idPrefix}" card has the expected name l10n-id`
    );

    const expectedPreviewSrc =
      themeId === DEFAULT_THEME_ID
        ? DEFAULT_THEME_PREVIEW_NOVA_URL
        : `resource://extra-themes-previews/${themeId}-preview.svg`;
    Assert.equal(
      await getThemePreviewSrc(card),
      expectedPreviewSrc,
      `"${idPrefix}" card shows the expected bundled preview image`
    );
  }
  Assert.equal(
    picker.themeCards.length,
    ALL_THEME_IDS.length,
    "Expect no unexpected Nova theme cards"
  );

  // The default theme is currently active: its preview image in the picker
  // grid should be the exact same image shown on its addon-card in the
  // regular themes list.
  const defaultPickerCard = getThemeCard(picker, DEFAULT_THEME_ID_PREFIX);
  const defaultAddonCard = AboutAddonsTestUtils.getAddonCard(
    win,
    DEFAULT_THEME_ID
  );
  Assert.equal(
    await getThemePreviewSrc(defaultPickerCard),
    await getThemePreviewSrc(defaultAddonCard),
    "addon-card should be using the same preview image as the themes picker card"
  );

  await closeView(win);
  await SpecialPowers.popPrefEnv();
});

// Verifies that the Nova themes picker can be expanded and collapsed as
// expected.
add_task(async function test_picker_show_more_show_less() {
  await SpecialPowers.pushPrefEnv({
    set: [
      [PREF_NOVA_ENABLED, true],
      [PREF_NOVA_THEMES_PICKER, true],
    ],
  });

  const win = await loadInitialView("theme");
  const picker = getThemesPicker(win.document);
  await waitForThemesPickerReady(picker);

  Assert.equal(
    picker.visibleRows,
    3,
    "Expect the themes picker grid to have 3 visible rows in collapsed mode"
  );
  const expectedCollapsedCount = picker.visibleRows * 2;
  Assert.equal(
    picker.themeCards.length,
    expectedCollapsedCount,
    `only the first ${expectedCollapsedCount} theme cards are shown initially`
  );

  Assert.ok(
    BrowserTestUtils.isVisible(picker.expandToggle),
    "'Show More'/'Show Less' toggle button is shown"
  );
  Assert.equal(
    picker.expandToggle.getAttribute("data-l10n-id"),
    "aboutaddons-themes-picker-see-more",
    "While collapsed, toggle button should show the 'Show More' localized string"
  );

  picker.expandToggle.click();
  await picker.updateComplete;

  Assert.equal(
    picker.themeCards.length,
    ALL_THEME_IDS.length,
    "All theme cards are shown after expanding"
  );
  Assert.equal(
    picker.expandToggle.getAttribute("data-l10n-id"),
    "aboutaddons-themes-picker-see-less",
    "While expanded, toggle button should show the 'Show Less' localized string"
  );

  picker.expandToggle.click();
  await picker.updateComplete;

  Assert.equal(
    picker.themeCards.length,
    expectedCollapsedCount,
    "Themes picker collapses back to the initial theme card count"
  );

  await closeView(win);
  await SpecialPowers.popPrefEnv();
});

// Verifies that the default theme card in the Nova themes grid
// has the Disable button hidden when the default theme is active
// (because the default theme can only be disabled by enabling
// a different theme).
add_task(async function test_picker_default_theme_button_state() {
  await SpecialPowers.pushPrefEnv({
    set: [
      [PREF_NOVA_ENABLED, true],
      [PREF_NOVA_THEMES_PICKER, true],
    ],
  });

  // Make sure the default theme has been enabled.
  const defaultAddon = await AddonManager.getAddonByID(DEFAULT_THEME_ID);
  await defaultAddon.enable();

  const win = await loadInitialView("theme");
  const picker = getThemesPicker(win.document);
  await waitForThemesPickerReady(picker);

  const defaultCard = getThemeCard(picker, DEFAULT_THEME_ID_PREFIX);
  Assert.ok(
    getThemeButton(defaultCard).hidden,
    "the default theme button is hidden while it is active"
  );

  let promiseActiveThemePrefChanged = TestUtils.waitForPrefChange(
    PREF_ACTIVE_THEME_ID,
    value => value === NOVA_SUN_ID
  );

  // Mock the theme XPI for one of the non-builtIn Nova theme.
  const xpi = createNovaThemeXPI(NOVA_SUN_ID, "Nova Sun");
  const sunAddon = await AddonManager.installTemporaryAddon(xpi);
  await sunAddon.enable();

  info("Waiting for extensions.activeThemeID to be set to the expected theme");
  await promiseActiveThemePrefChanged;
  await picker.updateComplete;

  Assert.ok(
    !getThemeButton(defaultCard).hidden,
    "Expect default theme button to become visible"
  );
  Assert.equal(
    getThemeButton(defaultCard).getAttribute("data-l10n-id"),
    "aboutaddons-themes-picker-enable-button",
    "default theme shows an Enable button once inactive"
  );

  const activeNovaThemeAddonCard = AboutAddonsTestUtils.getAddonCard(
    win,
    NOVA_SUN_ID
  );

  Assert.equal(
    await getThemePreviewSrc(activeNovaThemeAddonCard),
    `resource://extra-themes-previews/${NOVA_SUN_ID}-preview.svg`,
    `addon-card should shows the expected bundled preview image`
  );

  await sunAddon.uninstall();
  await closeView(win);
  await SpecialPowers.popPrefEnv();
});

// Verifies that for the Nova themes hosted on AMO the theme card
// button is localized as "Install" when the theme is not installed
// yet, and once it is installed the same button is localized as
// "Enable" and "Disable" based on the currently active theme.
add_task(async function test_picker_amo_hosted_themes_button() {
  await SpecialPowers.pushPrefEnv({
    set: [
      [PREF_NOVA_ENABLED, true],
      [PREF_NOVA_THEMES_PICKER, true],
    ],
  });

  Assert.ok(
    !(await AddonManager.getAddonByID(NOVA_SUN_ID)),
    "nova-sun is not installed at the start of this test"
  );

  // Nova AMO hosted theme not installed yet.
  {
    const win = await loadInitialView("theme");
    const picker = getThemesPicker(win.document);
    await waitForThemesPickerReady(picker);

    const sunCard = getThemeCard(picker, NOVA_SUN_ID_PREFIX);
    Assert.equal(
      getThemeButton(sunCard).getAttribute("data-l10n-id"),
      "aboutaddons-themes-picker-install-button",
      "not-yet-installed AMO-hosted theme shows an Install button"
    );

    await closeView(win);
  }

  const xpi = createNovaThemeXPI(NOVA_SUN_ID, "Nova Sun");
  const sunAddon = await AddonManager.installTemporaryAddon(xpi);
  await sunAddon.disable();

  // Nova AMO hosted theme already installed.
  {
    const win = await loadInitialView("theme");
    const picker = getThemesPicker(win.document);
    await waitForThemesPickerReady(picker);

    const sunCard = getThemeCard(picker, NOVA_SUN_ID_PREFIX);
    Assert.equal(
      getThemeButton(sunCard).getAttribute("data-l10n-id"),
      "aboutaddons-themes-picker-enable-button",
      "Installed but inactive theme expected to show an Enable button"
    );

    let promiseActiveThemePrefChanged = TestUtils.waitForPrefChange(
      PREF_ACTIVE_THEME_ID,
      value => value === NOVA_SUN_ID
    );

    await sunAddon.enable();

    info(
      "Waiting for extensions.activeThemeID to be set to the expected theme"
    );
    await promiseActiveThemePrefChanged;
    await picker.updateComplete;

    Assert.equal(
      getThemeButton(sunCard).getAttribute("data-l10n-id"),
      "aboutaddons-themes-picker-disable-button",
      "Theme card expected to show a Disable button"
    );

    await sunAddon.uninstall();
    await closeView(win);
  }
  await SpecialPowers.popPrefEnv();
});

// Verifies that when the "Enable/Disable" button is clicked, the currently
// active theme is changing as expected.
add_task(async function test_picker_button_click_updates_active_theme() {
  await SpecialPowers.pushPrefEnv({
    set: [
      [PREF_NOVA_ENABLED, true],
      [PREF_NOVA_THEMES_PICKER, true],
    ],
  });

  const xpi = createNovaThemeXPI(NOVA_SUN_ID, "Nova Sun");
  const sunAddon = await AddonManager.installTemporaryAddon(xpi);
  await sunAddon.disable();

  const win = await loadInitialView("theme");
  const picker = getThemesPicker(win.document);
  await waitForThemesPickerReady(picker);

  const sunCard = getThemeCard(picker, NOVA_SUN_ID_PREFIX);
  const defaultCard = getThemeCard(picker, DEFAULT_THEME_ID_PREFIX);

  let promiseActiveThemePrefChanged = TestUtils.waitForPrefChange(
    PREF_ACTIVE_THEME_ID,
    value => value === NOVA_SUN_ID
  );

  getThemeButton(sunCard).click();

  info(
    "Waiting for extensions.activeThemeID to be updated after clicking Enable"
  );
  await promiseActiveThemePrefChanged;

  await picker.updateComplete;
  Assert.equal(
    getThemeButton(sunCard).getAttribute("data-l10n-id"),
    "aboutaddons-themes-picker-disable-button",
    "Theme card expected to show a Disable button"
  );

  promiseActiveThemePrefChanged = TestUtils.waitForPrefChange(
    PREF_ACTIVE_THEME_ID,
    value => value === DEFAULT_THEME_ID
  );

  getThemeButton(sunCard).click();

  info(
    "Waiting for extensions.activeThemeID to be updated after clicking Disable"
  );
  await promiseActiveThemePrefChanged;

  await picker.updateComplete;
  Assert.equal(
    getThemeButton(sunCard).getAttribute("data-l10n-id"),
    "aboutaddons-themes-picker-enable-button",
    "Theme card expected to show an Enable button after being disabled"
  );
  Assert.equal(
    getThemeButton(defaultCard).hidden,
    true,
    "The default theme button should be hidden"
  );

  await sunAddon.uninstall();
  await closeView(win);
  await SpecialPowers.popPrefEnv();
});

// Verifies that the "Install" button download and actives the Nova themes
// hosted on AMO.
add_task(async function test_picker_install_button_downloads_and_activates() {
  await SpecialPowers.pushPrefEnv({
    set: [
      [PREF_NOVA_ENABLED, true],
      [PREF_NOVA_THEMES_PICKER, true],
    ],
  });

  const xpi = createNovaThemeXPI(NOVA_SUN_ID, "Nova Sun");
  const cleanupAddonRepoServer = setupAddonRepoServer(
    NOVA_SUN_ID,
    "Nova Sun",
    xpi
  );

  const win = await loadInitialView("theme");
  const picker = getThemesPicker(win.document);
  await waitForThemesPickerReady(picker);

  // Sanity check.
  const sunCard = getThemeCard(picker, NOVA_SUN_ID_PREFIX);
  Assert.equal(
    getThemeButton(sunCard).getAttribute("data-l10n-id"),
    "aboutaddons-themes-picker-install-button",
    "nova-sun theme should not be installed yet"
  );

  let promiseActiveThemePrefChanged = TestUtils.waitForPrefChange(
    PREF_ACTIVE_THEME_ID,
    value => value === NOVA_SUN_ID
  );

  getThemeButton(sunCard).click();
  await promiseActiveThemePrefChanged;

  await picker.updateComplete;

  Assert.equal(
    getThemeButton(sunCard).getAttribute("data-l10n-id"),
    "aboutaddons-themes-picker-disable-button",
    "Theme card expected to show a Disable button"
  );

  const sunAddon = await AddonManager.getAddonByID(NOVA_SUN_ID);
  Assert.equal(
    sunAddon?.isActive,
    true,
    "nova-sun theme expected to be installed and activated"
  );

  await sunAddon.uninstall();
  cleanupAddonRepoServer();
  await closeView(win);
  await SpecialPowers.popPrefEnv();
});

// Verifies that the themes picker shows a dismissable error message bar
// when a Nova theme fails to download/install (Bug 2054548), and that the
// bar is cleared again on dismiss.
add_task(async function test_picker_shows_error_on_install_failure() {
  await SpecialPowers.pushPrefEnv({
    set: [
      [PREF_NOVA_ENABLED, true],
      [PREF_NOVA_THEMES_PICKER, true],
    ],
  });

  // No xpi passed: the resolved XPI url 404s, simulating a broken download.
  const cleanupAddonRepoServer = setupAddonRepoServer(NOVA_SUN_ID, "Nova Sun");

  const win = await loadInitialView("theme");
  const picker = getThemesPicker(win.document);
  await waitForThemesPickerReady(picker);

  Assert.ok(
    !picker.errorBar,
    "no error message bar shown before attempting to install"
  );

  const sunCard = getThemeCard(picker, NOVA_SUN_ID_PREFIX);
  getThemeButton(sunCard).click();

  info("Waiting for the error message bar to be shown");
  await TestUtils.waitForCondition(() => picker.errorBar);
  await picker.updateComplete;

  Assert.equal(
    picker.errorBar.getAttribute("data-l10n-id"),
    "aboutaddons-themes-picker-error-message",
    "error message bar shows the expected l10n id"
  );
  Assert.equal(
    getThemeButton(sunCard).getAttribute("data-l10n-id"),
    "aboutaddons-themes-picker-install-button",
    "theme card still shows the Install button after a failed install"
  );

  picker.errorBar.dismiss();
  await picker.updateComplete;
  Assert.ok(!picker.errorBar, "error message bar is dismissed");

  cleanupAddonRepoServer();
  await closeView(win);
  await SpecialPowers.popPrefEnv();
});

// Verifies that the theme picker is updating also when the themes
// are being updated externally (e.g. from a different about:addons
// tab).
add_task(async function test_picker_reflects_external_addon_install() {
  await SpecialPowers.pushPrefEnv({
    set: [
      [PREF_NOVA_ENABLED, true],
      [PREF_NOVA_THEMES_PICKER, true],
    ],
  });

  const win = await loadInitialView("theme");
  const picker = getThemesPicker(win.document);
  await waitForThemesPickerReady(picker);

  // Sanity check.
  const sunCard = getThemeCard(picker, NOVA_SUN_ID_PREFIX);
  Assert.equal(
    getThemeButton(sunCard).getAttribute("data-l10n-id"),
    "aboutaddons-themes-picker-install-button",
    "nova-sun starts out not installed"
  );

  let promiseActiveThemePrefChanged = TestUtils.waitForPrefChange(
    PREF_ACTIVE_THEME_ID,
    value => value === NOVA_SUN_ID
  );

  // Install directly through AddonManager, bypassing the picker's own
  // Install button, to verify the theme picker UI is reacting to the
  // AddonManager events.
  const xpi = createNovaThemeXPI(NOVA_SUN_ID, "Nova Sun");
  const sunAddon = await AddonManager.installTemporaryAddon(xpi);

  info("Waiting for the currently active theme to have been changed");
  await promiseActiveThemePrefChanged;

  Assert.equal(
    getThemeButton(sunCard).getAttribute("data-l10n-id"),
    "aboutaddons-themes-picker-disable-button",
    "Expect the related picker theme card button to have been updated accordingly"
  );

  await sunAddon.uninstall();
  await closeView(win);
  await SpecialPowers.popPrefEnv();
});