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

"use strict";

// Test whether a visit information is annotated correctly when searching on searchbar.

ChromeUtils.defineESModuleGetters(this, {
  PlacesTestUtils: "resource://testing-common/PlacesTestUtils.sys.mjs",
});

const FRECENCY = {
  SEARCHED: PlacesUtils.history.pageFrecencyThreshold(0, 1, false),
  BOOKMARKED: PlacesUtils.history.pageFrecencyThreshold(0, 1, true),
};

const { VISIT_SOURCE_BOOKMARKED, VISIT_SOURCE_SEARCHED } = PlacesUtils.history;

async function assertDatabase({ targetURL, expected }) {
  const frecency = await PlacesTestUtils.getDatabaseValue(
    "moz_places",
    "frecency",
    { url: targetURL }
  );
  Assert.equal(frecency, expected.frecency, "Frecency is correct");

  const placesId = await PlacesTestUtils.getDatabaseValue("moz_places", "id", {
    url: targetURL,
  });
  const db = await PlacesUtils.promiseDBConnection();
  const rows = await db.execute(
    "SELECT source, triggeringPlaceId FROM moz_historyvisits WHERE place_id = :place_id AND source = :source",
    {
      place_id: placesId,
      source: expected.source,
    }
  );
  Assert.equal(rows.length, 1);
  Assert.equal(
    rows[0].getResultByName("triggeringPlaceId"),
    null,
    `The triggeringPlaceId in database is correct for ${targetURL}`
  );
}

add_setup(async function () {
  await PlacesUtils.history.clear();
  await PlacesUtils.bookmarks.eraseEverything();

  await gCUITestUtils.addSearchBar();
  await SearchTestUtils.installSearchExtension(
    {
      name: "Example",
      keyword: "@test",
    },
    { setAsDefault: true }
  );

  registerCleanupFunction(async function () {
    gCUITestUtils.removeSearchBar();
  });
});

add_task(async function basic() {
  const testData = [
    {
      description: "Normal search",
      input: "abc",
      resultURL: "https://example.com/?q=abc",
      expected: {
        source: VISIT_SOURCE_SEARCHED,
        frecency: FRECENCY.SEARCHED,
      },
    },
    {
      description: "Search but the url is bookmarked",
      input: "abc",
      resultURL: "https://example.com/?q=abc",
      bookmarks: [
        {
          parentGuid: PlacesUtils.bookmarks.toolbarGuid,
          url: Services.io.newURI("https://example.com/?q=abc"),
          title: "test bookmark",
        },
      ],
      expected: {
        source: VISIT_SOURCE_BOOKMARKED,
        frecency: FRECENCY.BOOKMARKED,
      },
    },
  ];

  for (const {
    description,
    input,
    resultURL,
    bookmarks,
    expected,
  } of testData) {
    info(description);

    for (const bookmark of bookmarks || []) {
      await PlacesUtils.bookmarks.insert(bookmark);
    }

    const onLoad = BrowserTestUtils.browserLoaded(
      gBrowser.selectedBrowser,
      false,
      resultURL
    );
    await searchInSearchbar(input);
    let promiseVisited = PlacesTestUtils.waitForNotification(
      "page-visited",
      events => events.some(e => e.url == resultURL)
    );
    EventUtils.synthesizeKey("KEY_Enter");
    await onLoad;
    await promiseVisited;
    await assertDatabase({ targetURL: resultURL, expected });

    await PlacesUtils.history.clear();
    await PlacesUtils.bookmarks.eraseEverything();
  }
});

add_task(async function contextmenu() {
  await BrowserTestUtils.withNewTab(
    "https://example.com/browser/browser/components/search/test/browser/test_search.html",
    async () => {
      // Select html content.
      await SpecialPowers.spawn(gBrowser.selectedBrowser, [], async () => {
        await new Promise(resolve => {
          content.document.addEventListener("selectionchange", resolve, {
            once: true,
          });
          content.document
            .getSelection()
            .selectAllChildren(content.document.body);
        });
      });

      const onPopup = BrowserTestUtils.waitForEvent(document, "popupshown");
      await BrowserTestUtils.synthesizeMouseAtCenter(
        "#id",
        { type: "contextmenu" },
        gBrowser.selectedBrowser
      );
      await onPopup;

      const targetURL = "https://example.com/?q=test%2520search";
      const onLoad = BrowserTestUtils.waitForNewTab(gBrowser, targetURL, true);
      const contextMenu = document.getElementById("contentAreaContextMenu");
      const openLinkMenuItem = contextMenu.querySelector(
        "#context-searchselect"
      );
      let promiseVisited = PlacesTestUtils.waitForNotification(
        "page-visited",
        events => events.some(e => e.url == targetURL)
      );
      contextMenu.activateItem(openLinkMenuItem);
      const tab = await onLoad;
      await promiseVisited;
      await assertDatabase({
        targetURL,
        expected: {
          source: VISIT_SOURCE_SEARCHED,
          frecency: FRECENCY.SEARCHED,
        },
      });

      BrowserTestUtils.removeTab(tab);
      await PlacesUtils.history.clear();
      await PlacesUtils.bookmarks.eraseEverything();
    }
  );
});
