michael@0: /* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
michael@0: /* vim:set ts=2 sw=2 sts=2 et: */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: const bmsvc = PlacesUtils.bookmarks;
michael@0: const histsvc = PlacesUtils.history;
michael@0: 
michael@0: const NOW = Date.now() * 1000;
michael@0: const TEST_URL = "http://example.com/";
michael@0: const TEST_URI = uri(TEST_URL);
michael@0: const PLACE_URL = "place:queryType=0&sort=8&maxResults=10";
michael@0: const PLACE_URI = uri(PLACE_URL);
michael@0: 
michael@0: var tests = [
michael@0:   {
michael@0:     desc: "Remove some visits outside valid timeframe from an unbookmarked URI",
michael@0:     run:   function () {
michael@0:       print("Add 10 visits for the URI from way in the past.");
michael@0:       let visits = [];
michael@0:       for (let i = 0; i < 10; i++) {
michael@0:         visits.push({ uri: TEST_URI, visitDate: NOW - 1000 - i });
michael@0:       }
michael@0:       promiseAddVisits(visits).then(this.continue_run.bind(this));
michael@0:     },
michael@0:     continue_run: function () {
michael@0:       print("Remove visits using timerange outside the URI's visits.");
michael@0:       histsvc.QueryInterface(Ci.nsIBrowserHistory).
michael@0:         removeVisitsByTimeframe(NOW - 10, NOW);
michael@0: 
michael@0:       print("URI should still exist in moz_places.");
michael@0:       do_check_true(page_in_database(TEST_URL));
michael@0: 
michael@0:       print("Run a history query and check that all visits still exist.");
michael@0:       var query = histsvc.getNewQuery();
michael@0:       var opts = histsvc.getNewQueryOptions();
michael@0:       opts.resultType = opts.RESULTS_AS_VISIT;
michael@0:       opts.sortingMode = opts.SORT_BY_DATE_DESCENDING;
michael@0:       var resultRoot = histsvc.executeQuery(query, opts).root;
michael@0:       resultRoot.containerOpen = true;
michael@0:       do_check_eq(resultRoot.childCount, 10);
michael@0:       for (let i = 0; i < resultRoot.childCount; i++) {
michael@0:         var visitTime = resultRoot.getChild(i).time;
michael@0:         do_check_eq(visitTime, NOW - 1000 - i);
michael@0:       }
michael@0:       resultRoot.containerOpen = false;
michael@0: 
michael@0:       print("asyncHistory.isURIVisited should return true.");
michael@0:       PlacesUtils.asyncHistory.isURIVisited(TEST_URI, function(aURI, aIsVisited) {
michael@0:         do_check_true(aIsVisited);
michael@0: 
michael@0:         promiseAsyncUpdates().then(function () {
michael@0:           print("Frecency should be positive.")
michael@0:           do_check_true(frecencyForUrl(TEST_URI) > 0);
michael@0:           run_next_test();
michael@0:         });
michael@0:       });
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   {
michael@0:     desc: "Remove some visits outside valid timeframe from a bookmarked URI",
michael@0:     run:   function () {
michael@0:       print("Add 10 visits for the URI from way in the past.");
michael@0:       let visits = [];
michael@0:       for (let i = 0; i < 10; i++) {
michael@0:         visits.push({ uri: TEST_URI, visitDate: NOW - 1000 - i });
michael@0:       }
michael@0:       promiseAddVisits(visits).then(function () {
michael@0:         print("Bookmark the URI.");
michael@0:         bmsvc.insertBookmark(bmsvc.unfiledBookmarksFolder,
michael@0:                              TEST_URI,
michael@0:                              bmsvc.DEFAULT_INDEX,
michael@0:                              "bookmark title");
michael@0: 
michael@0:         promiseAsyncUpdates().then(this.continue_run.bind(this));
michael@0:       }.bind(this));
michael@0:     },
michael@0:     continue_run: function () {
michael@0:       print("Remove visits using timerange outside the URI's visits.");
michael@0:       histsvc.QueryInterface(Ci.nsIBrowserHistory).
michael@0:         removeVisitsByTimeframe(NOW - 10, NOW);
michael@0: 
michael@0:       print("URI should still exist in moz_places.");
michael@0:       do_check_true(page_in_database(TEST_URL));
michael@0: 
michael@0:       print("Run a history query and check that all visits still exist.");
michael@0:       var query = histsvc.getNewQuery();
michael@0:       var opts = histsvc.getNewQueryOptions();
michael@0:       opts.resultType = opts.RESULTS_AS_VISIT;
michael@0:       opts.sortingMode = opts.SORT_BY_DATE_DESCENDING;
michael@0:       var resultRoot = histsvc.executeQuery(query, opts).root;
michael@0:       resultRoot.containerOpen = true;
michael@0:       do_check_eq(resultRoot.childCount, 10);
michael@0:       for (let i = 0; i < resultRoot.childCount; i++) {
michael@0:         var visitTime = resultRoot.getChild(i).time;
michael@0:         do_check_eq(visitTime, NOW - 1000 - i);
michael@0:       }
michael@0:       resultRoot.containerOpen = false;
michael@0: 
michael@0:       print("asyncHistory.isURIVisited should return true.");
michael@0:       PlacesUtils.asyncHistory.isURIVisited(TEST_URI, function(aURI, aIsVisited) {
michael@0:         do_check_true(aIsVisited);
michael@0: 
michael@0:         promiseAsyncUpdates().then(function () {
michael@0:           print("Frecency should be positive.")
michael@0:           do_check_true(frecencyForUrl(TEST_URI) > 0);
michael@0:           run_next_test();
michael@0:         });
michael@0:       });
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   {
michael@0:     desc: "Remove some visits from an unbookmarked URI",
michael@0:     run:   function () {
michael@0:       print("Add 10 visits for the URI from now to 9 usecs in the past.");
michael@0:       let visits = [];
michael@0:       for (let i = 0; i < 10; i++) {
michael@0:         visits.push({ uri: TEST_URI, visitDate: NOW - i });
michael@0:       }
michael@0:       promiseAddVisits(visits).then(this.continue_run.bind(this));
michael@0:     },
michael@0:     continue_run: function () {
michael@0:       print("Remove the 5 most recent visits.");
michael@0:       histsvc.QueryInterface(Ci.nsIBrowserHistory).
michael@0:         removeVisitsByTimeframe(NOW - 4, NOW);
michael@0: 
michael@0:       print("URI should still exist in moz_places.");
michael@0:       do_check_true(page_in_database(TEST_URL));
michael@0: 
michael@0:       print("Run a history query and check that only the older 5 visits " +
michael@0:             "still exist.");
michael@0:       var query = histsvc.getNewQuery();
michael@0:       var opts = histsvc.getNewQueryOptions();
michael@0:       opts.resultType = opts.RESULTS_AS_VISIT;
michael@0:       opts.sortingMode = opts.SORT_BY_DATE_DESCENDING;
michael@0:       var resultRoot = histsvc.executeQuery(query, opts).root;
michael@0:       resultRoot.containerOpen = true;
michael@0:       do_check_eq(resultRoot.childCount, 5);
michael@0:       for (let i = 0; i < resultRoot.childCount; i++) {
michael@0:         var visitTime = resultRoot.getChild(i).time;
michael@0:         do_check_eq(visitTime, NOW - i - 5);
michael@0:       }
michael@0:       resultRoot.containerOpen = false;
michael@0: 
michael@0:       print("asyncHistory.isURIVisited should return true.");
michael@0:       PlacesUtils.asyncHistory.isURIVisited(TEST_URI, function(aURI, aIsVisited) {
michael@0:         do_check_true(aIsVisited);
michael@0: 
michael@0:         promiseAsyncUpdates().then(function () {
michael@0:           print("Frecency should be positive.")
michael@0:           do_check_true(frecencyForUrl(TEST_URI) > 0);
michael@0:           run_next_test();
michael@0:         });
michael@0:       });
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   {
michael@0:     desc: "Remove some visits from a bookmarked URI",
michael@0:     run:   function () {
michael@0:       print("Add 10 visits for the URI from now to 9 usecs in the past.");
michael@0:       let visits = [];
michael@0:       for (let i = 0; i < 10; i++) {
michael@0:         visits.push({ uri: TEST_URI, visitDate: NOW - i });
michael@0:       }
michael@0:       promiseAddVisits(visits).then(function () {
michael@0:         print("Bookmark the URI.");
michael@0:         bmsvc.insertBookmark(bmsvc.unfiledBookmarksFolder,
michael@0:                              TEST_URI,
michael@0:                              bmsvc.DEFAULT_INDEX,
michael@0:                              "bookmark title");
michael@0:         promiseAsyncUpdates().then(this.continue_run.bind(this));
michael@0:       }.bind(this));
michael@0:     },
michael@0:     continue_run: function () {
michael@0:       print("Remove the 5 most recent visits.");
michael@0:       histsvc.QueryInterface(Ci.nsIBrowserHistory).
michael@0:         removeVisitsByTimeframe(NOW - 4, NOW);
michael@0: 
michael@0:       print("URI should still exist in moz_places.");
michael@0:       do_check_true(page_in_database(TEST_URL));
michael@0: 
michael@0:       print("Run a history query and check that only the older 5 visits " +
michael@0:             "still exist.");
michael@0:       var query = histsvc.getNewQuery();
michael@0:       var opts = histsvc.getNewQueryOptions();
michael@0:       opts.resultType = opts.RESULTS_AS_VISIT;
michael@0:       opts.sortingMode = opts.SORT_BY_DATE_DESCENDING;
michael@0:       var resultRoot = histsvc.executeQuery(query, opts).root;
michael@0:       resultRoot.containerOpen = true;
michael@0:       do_check_eq(resultRoot.childCount, 5);
michael@0:       for (let i = 0; i < resultRoot.childCount; i++) {
michael@0:         var visitTime = resultRoot.getChild(i).time;
michael@0:         do_check_eq(visitTime, NOW - i - 5);
michael@0:       }
michael@0:       resultRoot.containerOpen = false;
michael@0: 
michael@0:       print("asyncHistory.isURIVisited should return true.");
michael@0:       PlacesUtils.asyncHistory.isURIVisited(TEST_URI, function(aURI, aIsVisited) {
michael@0:         do_check_true(aIsVisited);
michael@0: 
michael@0:         promiseAsyncUpdates().then(function () {
michael@0:           print("Frecency should be positive.")
michael@0:           do_check_true(frecencyForUrl(TEST_URI) > 0);
michael@0:           run_next_test();
michael@0:         });
michael@0:       });
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   {
michael@0:     desc: "Remove all visits from an unbookmarked URI",
michael@0:     run:   function () {
michael@0:       print("Add some visits for the URI.");
michael@0:       let visits = [];
michael@0:       for (let i = 0; i < 10; i++) {
michael@0:         visits.push({ uri: TEST_URI, visitDate: NOW - i });
michael@0:       }
michael@0:       promiseAddVisits(visits).then(this.continue_run.bind(this));
michael@0:     },
michael@0:     continue_run: function () {
michael@0:       print("Remove all visits.");
michael@0:       histsvc.QueryInterface(Ci.nsIBrowserHistory).
michael@0:         removeVisitsByTimeframe(NOW - 10, NOW);
michael@0: 
michael@0:       print("URI should no longer exist in moz_places.");
michael@0:       do_check_false(page_in_database(TEST_URL));
michael@0: 
michael@0:       print("Run a history query and check that no visits exist.");
michael@0:       var query = histsvc.getNewQuery();
michael@0:       var opts = histsvc.getNewQueryOptions();
michael@0:       opts.resultType = opts.RESULTS_AS_VISIT;
michael@0:       opts.sortingMode = opts.SORT_BY_DATE_DESCENDING;
michael@0:       var resultRoot = histsvc.executeQuery(query, opts).root;
michael@0:       resultRoot.containerOpen = true;
michael@0:       do_check_eq(resultRoot.childCount, 0);
michael@0:       resultRoot.containerOpen = false;
michael@0: 
michael@0:       print("asyncHistory.isURIVisited should return false.");
michael@0:       PlacesUtils.asyncHistory.isURIVisited(TEST_URI, function(aURI, aIsVisited) {
michael@0:         do_check_false(aIsVisited);
michael@0:         run_next_test();
michael@0:       });
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   {
michael@0:     desc: "Remove all visits from an unbookmarked place: URI",
michael@0:     run:   function () {
michael@0:       print("Add some visits for the URI.");
michael@0:       let visits = [];
michael@0:       for (let i = 0; i < 10; i++) {
michael@0:         visits.push({ uri: PLACE_URI, visitDate: NOW - i });
michael@0:       }
michael@0:       promiseAddVisits(visits).then(this.continue_run.bind(this));
michael@0:     },
michael@0:     continue_run: function () {
michael@0:       print("Remove all visits.");
michael@0:       histsvc.QueryInterface(Ci.nsIBrowserHistory).
michael@0:         removeVisitsByTimeframe(NOW - 10, NOW);
michael@0: 
michael@0:       print("URI should still exist in moz_places.");
michael@0:       do_check_true(page_in_database(PLACE_URL));
michael@0: 
michael@0:       print("Run a history query and check that no visits exist.");
michael@0:       var query = histsvc.getNewQuery();
michael@0:       var opts = histsvc.getNewQueryOptions();
michael@0:       opts.resultType = opts.RESULTS_AS_VISIT;
michael@0:       opts.sortingMode = opts.SORT_BY_DATE_DESCENDING;
michael@0:       var resultRoot = histsvc.executeQuery(query, opts).root;
michael@0:       resultRoot.containerOpen = true;
michael@0:       do_check_eq(resultRoot.childCount, 0);
michael@0:       resultRoot.containerOpen = false;
michael@0: 
michael@0:       print("asyncHistory.isURIVisited should return false.");
michael@0:       PlacesUtils.asyncHistory.isURIVisited(PLACE_URI, function(aURI, aIsVisited) {
michael@0:         do_check_false(aIsVisited);
michael@0: 
michael@0:         promiseAsyncUpdates().then(function () {
michael@0:           print("Frecency should be zero.")
michael@0:           do_check_eq(frecencyForUrl(PLACE_URL), 0);
michael@0:           run_next_test();
michael@0:         });
michael@0:       });
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   {
michael@0:     desc: "Remove all visits from a bookmarked URI",
michael@0:     run:   function () {
michael@0:       print("Add some visits for the URI.");
michael@0:       let visits = [];
michael@0:       for (let i = 0; i < 10; i++) {
michael@0:         visits.push({ uri: TEST_URI, visitDate: NOW - i });
michael@0:       }
michael@0:       promiseAddVisits(visits).then(function () {
michael@0:         print("Bookmark the URI.");
michael@0:         bmsvc.insertBookmark(bmsvc.unfiledBookmarksFolder,
michael@0:                              TEST_URI,
michael@0:                              bmsvc.DEFAULT_INDEX,
michael@0:                              "bookmark title");
michael@0:         promiseAsyncUpdates().then(this.continue_run.bind(this));
michael@0:       }.bind(this));
michael@0:     },
michael@0:     continue_run: function () {
michael@0:       print("Remove all visits.");
michael@0:       histsvc.QueryInterface(Ci.nsIBrowserHistory).
michael@0:         removeVisitsByTimeframe(NOW - 10, NOW);
michael@0: 
michael@0:       print("URI should still exist in moz_places.");
michael@0:       do_check_true(page_in_database(TEST_URL));
michael@0: 
michael@0:       print("Run a history query and check that no visits exist.");
michael@0:       var query = histsvc.getNewQuery();
michael@0:       var opts = histsvc.getNewQueryOptions();
michael@0:       opts.resultType = opts.RESULTS_AS_VISIT;
michael@0:       opts.sortingMode = opts.SORT_BY_DATE_DESCENDING;
michael@0:       var resultRoot = histsvc.executeQuery(query, opts).root;
michael@0:       resultRoot.containerOpen = true;
michael@0:       do_check_eq(resultRoot.childCount, 0);
michael@0:       resultRoot.containerOpen = false;
michael@0: 
michael@0:       print("asyncHistory.isURIVisited should return false.");
michael@0:       PlacesUtils.asyncHistory.isURIVisited(TEST_URI, function(aURI, aIsVisited) {
michael@0:         do_check_false(aIsVisited);
michael@0: 
michael@0:         print("nsINavBookmarksService.isBookmarked should return true.");
michael@0:         do_check_true(bmsvc.isBookmarked(TEST_URI));
michael@0: 
michael@0:         promiseAsyncUpdates().then(function () {
michael@0:           print("Frecency should be negative.")
michael@0:           do_check_true(frecencyForUrl(TEST_URI) < 0);
michael@0:           run_next_test();
michael@0:         });
michael@0:       });
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   {
michael@0:     desc: "Remove some visits from a zero frecency URI retains zero frecency",
michael@0:     run: function () {
michael@0:       do_log_info("Add some visits for the URI.");
michael@0:       promiseAddVisits([{ uri: TEST_URI, transition: TRANSITION_FRAMED_LINK,
michael@0:                           visitDate: (NOW - 86400000000) },
michael@0:                         { uri: TEST_URI, transition: TRANSITION_FRAMED_LINK,
michael@0:                           visitDate: NOW }]).then(
michael@0:                        this.continue_run.bind(this));
michael@0:     },
michael@0:     continue_run: function () {
michael@0:       do_log_info("Remove newer visit.");
michael@0:       histsvc.QueryInterface(Ci.nsIBrowserHistory).
michael@0:         removeVisitsByTimeframe(NOW - 10, NOW);
michael@0: 
michael@0:       promiseAsyncUpdates().then(function() {
michael@0:         do_log_info("URI should still exist in moz_places.");
michael@0:         do_check_true(page_in_database(TEST_URL));
michael@0:         do_log_info("Frecency should be zero.")
michael@0:         do_check_eq(frecencyForUrl(TEST_URI), 0);
michael@0:         run_next_test();
michael@0:       });
michael@0:     }
michael@0:   }
michael@0: ];
michael@0: 
michael@0: ///////////////////////////////////////////////////////////////////////////////
michael@0: 
michael@0: function run_test()
michael@0: {
michael@0:   do_test_pending();
michael@0:   run_next_test();
michael@0: }
michael@0: 
michael@0: function run_next_test() {
michael@0:   if (tests.length) {
michael@0:     let test = tests.shift();
michael@0:     print("\n ***Test: " + test.desc);
michael@0:     promiseClearHistory().then(function() {
michael@0:       remove_all_bookmarks();
michael@0:       DBConn().executeSimpleSQL("DELETE FROM moz_places");
michael@0:       test.run.call(test);
michael@0:     });
michael@0:   }
michael@0:   else {
michael@0:     do_test_finished();
michael@0:   }
michael@0: }