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: /**
michael@0:  * Test for bug 406358 to make sure frecency works for empty input/search, but
michael@0:  * this also tests for non-empty inputs as well. Because the interactions among
michael@0:  * *DIFFERENT* visit counts and visit dates is not well defined, this test
michael@0:  * holds one of the two values constant when modifying the other.
michael@0:  *
michael@0:  * Also test bug 419068 to make sure tagged pages don't necessarily have to be
michael@0:  * first in the results.
michael@0:  *
michael@0:  * Also test bug 426166 to make sure that the results of autocomplete searches
michael@0:  * are stable.  Note that failures of this test will be intermittent by nature
michael@0:  * since we are testing to make sure that the unstable sort algorithm used
michael@0:  * by SQLite is not changing the order of the results on us.
michael@0:  */
michael@0: 
michael@0: function AutoCompleteInput(aSearches) {
michael@0:   this.searches = aSearches;
michael@0: }
michael@0: AutoCompleteInput.prototype = {
michael@0:   constructor: AutoCompleteInput,
michael@0: 
michael@0:   searches: null,
michael@0: 
michael@0:   minResultsForPopup: 0,
michael@0:   timeout: 10,
michael@0:   searchParam: "",
michael@0:   textValue: "",
michael@0:   disableAutoComplete: false,
michael@0:   completeDefaultIndex: false,
michael@0: 
michael@0:   get searchCount() {
michael@0:     return this.searches.length;
michael@0:   },
michael@0: 
michael@0:   getSearchAt: function(aIndex) {
michael@0:     return this.searches[aIndex];
michael@0:   },
michael@0: 
michael@0:   onSearchBegin: function() {},
michael@0:   onSearchComplete: function() {},
michael@0: 
michael@0:   popupOpen: false,
michael@0: 
michael@0:   popup: {
michael@0:     setSelectedIndex: function(aIndex) {},
michael@0:     invalidate: function() {},
michael@0: 
michael@0:     // nsISupports implementation
michael@0:     QueryInterface: function(iid) {
michael@0:       if (iid.equals(Ci.nsISupports) ||
michael@0:           iid.equals(Ci.nsIAutoCompletePopup))
michael@0:         return this;
michael@0: 
michael@0:       throw Components.results.NS_ERROR_NO_INTERFACE;
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   // nsISupports implementation
michael@0:   QueryInterface: function(iid) {
michael@0:     if (iid.equals(Ci.nsISupports) ||
michael@0:         iid.equals(Ci.nsIAutoCompleteInput))
michael@0:       return this;
michael@0: 
michael@0:     throw Components.results.NS_ERROR_NO_INTERFACE;
michael@0:   }
michael@0: }
michael@0: 
michael@0: function ensure_results(uris, searchTerm)
michael@0: {
michael@0:   promiseAsyncUpdates().then(function () ensure_results_internal(uris,
michael@0:                                                                  searchTerm));
michael@0: }
michael@0: 
michael@0: function ensure_results_internal(uris, searchTerm)
michael@0: {
michael@0:   var controller = Components.classes["@mozilla.org/autocomplete/controller;1"].
michael@0:                    getService(Components.interfaces.nsIAutoCompleteController);
michael@0: 
michael@0:   // Make an AutoCompleteInput that uses our searches
michael@0:   // and confirms results on search complete
michael@0:   var input = new AutoCompleteInput(["history"]);
michael@0: 
michael@0:   controller.input = input;
michael@0: 
michael@0:   var numSearchesStarted = 0;
michael@0:   input.onSearchBegin = function() {
michael@0:     numSearchesStarted++;
michael@0:     do_check_eq(numSearchesStarted, 1);
michael@0:   };
michael@0: 
michael@0:   input.onSearchComplete = function() {
michael@0:     do_check_eq(numSearchesStarted, 1);
michael@0:     do_check_eq(controller.searchStatus,
michael@0:                 Ci.nsIAutoCompleteController.STATUS_COMPLETE_MATCH);
michael@0:     do_check_eq(controller.matchCount, uris.length);
michael@0:     for (var i=0; i<controller.matchCount; i++) {
michael@0:       do_check_eq(controller.getValueAt(i), uris[i].spec);
michael@0:     }
michael@0: 
michael@0:     deferEnsureResults.resolve();
michael@0:   };
michael@0: 
michael@0:   controller.startSearch(searchTerm);
michael@0: }
michael@0: 
michael@0: // Get history service
michael@0: try {
michael@0:   var histsvc = Cc["@mozilla.org/browser/nav-history-service;1"].
michael@0:                 getService(Ci.nsINavHistoryService);
michael@0:   var bhist = histsvc.QueryInterface(Ci.nsIBrowserHistory);
michael@0:   var tagssvc = Cc["@mozilla.org/browser/tagging-service;1"].
michael@0:                 getService(Ci.nsITaggingService);
michael@0:   var bmksvc = Cc["@mozilla.org/browser/nav-bookmarks-service;1"].
michael@0:                 getService(Ci.nsINavBookmarksService);
michael@0: } catch(ex) {
michael@0:   do_throw("Could not get history service\n");
michael@0: } 
michael@0: 
michael@0: function task_setCountDate(aURI, aCount, aDate)
michael@0: {
michael@0:   // We need visits so that frecency can be computed over multiple visits
michael@0:   let visits = [];
michael@0:   for (let i = 0; i < aCount; i++) {
michael@0:     visits.push({ uri: aURI, visitDate: aDate, transition: TRANSITION_TYPED });
michael@0:   }
michael@0:   yield promiseAddVisits(visits);
michael@0: }
michael@0: 
michael@0: function setBookmark(aURI)
michael@0: {
michael@0:   bmksvc.insertBookmark(bmksvc.bookmarksMenuFolder, aURI, -1, "bleh");
michael@0: }
michael@0: 
michael@0: function tagURI(aURI, aTags) {
michael@0:   bmksvc.insertBookmark(bmksvc.unfiledBookmarksFolder, aURI,
michael@0:                         bmksvc.DEFAULT_INDEX, "bleh");
michael@0:   tagssvc.tagURI(aURI, aTags);
michael@0: }
michael@0: 
michael@0: var uri1 = uri("http://site.tld/1");
michael@0: var uri2 = uri("http://site.tld/2");
michael@0: var uri3 = uri("http://aaaaaaaaaa/1");
michael@0: var uri4 = uri("http://aaaaaaaaaa/2");
michael@0: 
michael@0: // d1 is younger (should show up higher) than d2 (PRTime is in usecs not msec)
michael@0: // Make sure the dates fall into different frecency buckets
michael@0: var d1 = new Date(Date.now() - 1000 * 60 * 60) * 1000;
michael@0: var d2 = new Date(Date.now() - 1000 * 60 * 60 * 24 * 10) * 1000;
michael@0: // c1 is larger (should show up higher) than c2
michael@0: var c1 = 10;
michael@0: var c2 = 1;
michael@0: 
michael@0: var tests = [
michael@0: // test things without a search term
michael@0: function() {
michael@0:   print("TEST-INFO | Test 0: same count, different date");
michael@0:   yield task_setCountDate(uri1, c1, d1);
michael@0:   yield task_setCountDate(uri2, c1, d2);
michael@0:   tagURI(uri1, ["site"]);
michael@0:   ensure_results([uri1, uri2], "");
michael@0: },
michael@0: function() {
michael@0:   print("TEST-INFO | Test 1: same count, different date");
michael@0:   yield task_setCountDate(uri1, c1, d2);
michael@0:   yield task_setCountDate(uri2, c1, d1);
michael@0:   tagURI(uri1, ["site"]);
michael@0:   ensure_results([uri2, uri1], "");
michael@0: },
michael@0: function() {
michael@0:   print("TEST-INFO | Test 2: different count, same date");
michael@0:   yield task_setCountDate(uri1, c1, d1);
michael@0:   yield task_setCountDate(uri2, c2, d1);
michael@0:   tagURI(uri1, ["site"]);
michael@0:   ensure_results([uri1, uri2], "");
michael@0: },
michael@0: function() {
michael@0:   print("TEST-INFO | Test 3: different count, same date");
michael@0:   yield task_setCountDate(uri1, c2, d1);
michael@0:   yield task_setCountDate(uri2, c1, d1);
michael@0:   tagURI(uri1, ["site"]);
michael@0:   ensure_results([uri2, uri1], "");
michael@0: },
michael@0: 
michael@0: // test things with a search term
michael@0: function() {
michael@0:   print("TEST-INFO | Test 4: same count, different date");
michael@0:   yield task_setCountDate(uri1, c1, d1);
michael@0:   yield task_setCountDate(uri2, c1, d2);
michael@0:   tagURI(uri1, ["site"]);
michael@0:   ensure_results([uri1, uri2], "site");
michael@0: },
michael@0: function() {
michael@0:   print("TEST-INFO | Test 5: same count, different date");
michael@0:   yield task_setCountDate(uri1, c1, d2);
michael@0:   yield task_setCountDate(uri2, c1, d1);
michael@0:   tagURI(uri1, ["site"]);
michael@0:   ensure_results([uri2, uri1], "site");
michael@0: },
michael@0: function() {
michael@0:   print("TEST-INFO | Test 6: different count, same date");
michael@0:   yield task_setCountDate(uri1, c1, d1);
michael@0:   yield task_setCountDate(uri2, c2, d1);
michael@0:   tagURI(uri1, ["site"]);
michael@0:   ensure_results([uri1, uri2], "site");
michael@0: },
michael@0: function() {
michael@0:   print("TEST-INFO | Test 7: different count, same date");
michael@0:   yield task_setCountDate(uri1, c2, d1);
michael@0:   yield task_setCountDate(uri2, c1, d1);
michael@0:   tagURI(uri1, ["site"]);
michael@0:   ensure_results([uri2, uri1], "site");
michael@0: },
michael@0: // There are multiple tests for 8, hence the multiple functions
michael@0: // Bug 426166 section
michael@0: function() {
michael@0:   print("TEST-INFO | Test 8.1a: same count, same date");
michael@0:   setBookmark(uri3);
michael@0:   setBookmark(uri4);
michael@0:   ensure_results([uri4, uri3], "a");
michael@0: },
michael@0: function() {
michael@0:   print("TEST-INFO | Test 8.1b: same count, same date");
michael@0:   setBookmark(uri3);
michael@0:   setBookmark(uri4);
michael@0:   ensure_results([uri4, uri3], "aa");
michael@0: },
michael@0: function() {
michael@0:   print("TEST-INFO | Test 8.2: same count, same date");
michael@0:   setBookmark(uri3);
michael@0:   setBookmark(uri4);
michael@0:   ensure_results([uri4, uri3], "aaa");
michael@0: },
michael@0: function() {
michael@0:   print("TEST-INFO | Test 8.3: same count, same date");
michael@0:   setBookmark(uri3);
michael@0:   setBookmark(uri4);
michael@0:   ensure_results([uri4, uri3], "aaaa");
michael@0: },
michael@0: function() {
michael@0:   print("TEST-INFO | Test 8.4: same count, same date");
michael@0:   setBookmark(uri3);
michael@0:   setBookmark(uri4);
michael@0:   ensure_results([uri4, uri3], "aaa");
michael@0: },
michael@0: function() {
michael@0:   print("TEST-INFO | Test 8.5: same count, same date");
michael@0:   setBookmark(uri3);
michael@0:   setBookmark(uri4);
michael@0:   ensure_results([uri4, uri3], "aa");
michael@0: },
michael@0: function() {
michael@0:   print("TEST-INFO | Test 8.6: same count, same date");
michael@0:   setBookmark(uri3);
michael@0:   setBookmark(uri4);
michael@0:   ensure_results([uri4, uri3], "a");
michael@0: }
michael@0: ];
michael@0: 
michael@0: /**
michael@0:  * This deferred object contains a promise that is resolved when the
michael@0:  * ensure_results_internal function has finished its execution.
michael@0:  */
michael@0: let deferEnsureResults;
michael@0: 
michael@0: /**
michael@0:  * Test adaptive autocomplete
michael@0:  */
michael@0: function run_test()
michael@0: {
michael@0:   run_next_test();
michael@0: }
michael@0: 
michael@0: add_task(function test_frecency()
michael@0: {
michael@0:   // always search in history + bookmarks, no matter what the default is
michael@0:   var prefs = Cc["@mozilla.org/preferences-service;1"].
michael@0:               getService(Ci.nsIPrefBranch);
michael@0:   prefs.setIntPref("browser.urlbar.search.sources", 3);
michael@0:   prefs.setIntPref("browser.urlbar.default.behavior", 0);
michael@0:   for (let [, test] in Iterator(tests)) {
michael@0:     remove_all_bookmarks();
michael@0:     yield promiseClearHistory();
michael@0: 
michael@0:     deferEnsureResults = Promise.defer();
michael@0:     yield test();
michael@0:     yield deferEnsureResults.promise;
michael@0:   }
michael@0: });