/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

// Cache actual visit_count value, filled by add_visit, used by check_results
var visit_count = 0;

// Returns the Place ID corresponding to an added visit.
async function task_add_visit(aURI, aVisitType) {
  // Wait for a visits notification and get the visitId.
  let visitId;
  let visitsPromise = PlacesTestUtils.waitForNotification(
    "page-visited",
    visits => {
      visitId = visits[0].visitId;
      let { url } = visits[0];
      return url == aURI.spec;
    }
  );

  // Add visits.
  await PlacesTestUtils.addVisits([
    {
      uri: aURI,
      transition: aVisitType,
    },
  ]);

  if (aVisitType != TRANSITION_EMBED) {
    await visitsPromise;
  }

  // Increase visit_count if applicable
  if (
    aVisitType != 0 &&
    aVisitType != TRANSITION_EMBED &&
    aVisitType != TRANSITION_FRAMED_LINK &&
    aVisitType != TRANSITION_DOWNLOAD &&
    aVisitType != TRANSITION_RELOAD
  ) {
    visit_count++;
  }

  // Get the place id
  if (visitId > 0) {
    const placeId = await PlacesTestUtils.getDatabaseValue(
      "moz_historyvisits",
      "place_id",
      { id: visitId }
    );
    Assert.notStrictEqual(placeId, undefined, "Should have a result");
    Assert.greater(placeId, 0);
    return placeId;
  }
  return 0;
}

/**
 * Checks for results consistency, using visit_count as constraint
 *
 * @param {number} aExpectedCount
 *   Number of history results we are expecting (excluded hidden ones).
 * @param {number} aExpectedCountWithHidden
 *   Number of history results we are expecting (included hidden ones).
 */
function check_results(aExpectedCount, aExpectedCountWithHidden) {
  let query = PlacesUtils.history.getNewQuery();
  // used to check visit_count
  query.minVisits = visit_count;
  query.maxVisits = visit_count;
  let options = PlacesUtils.history.getNewQueryOptions();
  options.queryType = Ci.nsINavHistoryQueryOptions.QUERY_TYPE_HISTORY;
  let root = PlacesUtils.history.executeQuery(query, options).root;
  root.containerOpen = true;
  // Children without hidden ones
  Assert.equal(root.childCount, aExpectedCount);
  root.containerOpen = false;

  // Execute again with includeHidden = true
  // This will ensure visit_count is correct
  options.includeHidden = true;
  root = PlacesUtils.history.executeQuery(query, options).root;
  root.containerOpen = true;
  // Children with hidden ones
  Assert.equal(root.childCount, aExpectedCountWithHidden);
  root.containerOpen = false;
}

// main

add_task(async function test_execute() {
  const TEST_URI = uri("http://test.mozilla.org/");

  // Add a visit that force hidden
  await task_add_visit(TEST_URI, TRANSITION_EMBED);
  check_results(0, 0);

  let placeId = await task_add_visit(TEST_URI, TRANSITION_FRAMED_LINK);
  check_results(0, 1);

  // Add a visit that force unhide and check the place id.
  // - We expect that the place gets hidden = 0 while retaining the same
  //   place id and a correct visit_count.
  Assert.equal(await task_add_visit(TEST_URI, TRANSITION_TYPED), placeId);
  check_results(1, 1);

  // Add a visit that should not increase visit_count
  Assert.equal(await task_add_visit(TEST_URI, TRANSITION_RELOAD), placeId);
  check_results(1, 1);

  // Add a visit that should not increase visit_count
  Assert.equal(await task_add_visit(TEST_URI, TRANSITION_DOWNLOAD), placeId);
  check_results(1, 1);

  // Add a visit, check that hidden is not overwritten
  // - We expect that the place has still hidden = 0, while retaining
  //   correct visit_count.
  await task_add_visit(TEST_URI, TRANSITION_EMBED);
  check_results(1, 1);
});
