The Tor Browser: toolkit/components/places/tests/unit/test_000_frecency.js@6474c204b198 (annotated)

toolkit/components/places/tests/unit/test_000_frecency.js@6474c204b198 (annotated)

toolkit/components/places/tests/unit/test_000_frecency.js

Wed, 31 Dec 2014 06:09:35 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Wed, 31 Dec 2014 06:09:35 +0100
changeset 0: 6474c204b198
permissions: -rw-r--r--

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

 /* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 /* vim:set ts=2 sw=2 sts=2 et: */
 /* 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/. */
 /*
 Autocomplete Frecency Tests
 - add a visit for each score permutation
 - search
 - test number of matches
 - test each item's location in results
 */
 try {
   var histsvc = Cc["@mozilla.org/browser/nav-history-service;1"].
                 getService(Ci.nsINavHistoryService);
   var bmsvc = Cc["@mozilla.org/browser/nav-bookmarks-service;1"].
               getService(Ci.nsINavBookmarksService);
   var prefs = Cc["@mozilla.org/preferences-service;1"].
               getService(Ci.nsIPrefBranch);
 } catch(ex) {
   do_throw("Could not get services\n");
 }
 var bucketPrefs = [
   [ "firstBucketCutoff", "firstBucketWeight"],
   [ "secondBucketCutoff", "secondBucketWeight"],
   [ "thirdBucketCutoff", "thirdBucketWeight"],
   [ "fourthBucketCutoff", "fourthBucketWeight"],
   [ null, "defaultBucketWeight"]
 ];
 var bonusPrefs = {
   embedVisitBonus: Ci.nsINavHistoryService.TRANSITION_EMBED,
   framedLinkVisitBonus: Ci.nsINavHistoryService.TRANSITION_FRAMED_LINK,
   linkVisitBonus: Ci.nsINavHistoryService.TRANSITION_LINK,
   typedVisitBonus: Ci.nsINavHistoryService.TRANSITION_TYPED,
   bookmarkVisitBonus: Ci.nsINavHistoryService.TRANSITION_BOOKMARK,
   downloadVisitBonus: Ci.nsINavHistoryService.TRANSITION_DOWNLOAD,
   permRedirectVisitBonus: Ci.nsINavHistoryService.TRANSITION_REDIRECT_PERMANENT,
   tempRedirectVisitBonus: Ci.nsINavHistoryService.TRANSITION_REDIRECT_TEMPORARY,
 };
 // create test data
 var searchTerm = "frecency";
 var results = [];
 var matchCount = 0;
 var now = Date.now();
 var prefPrefix = "places.frecency.";
 function task_initializeBucket(bucket) {
   let [cutoffName, weightName] = bucket;
   // get pref values
   var weight = 0, cutoff = 0, bonus = 0;
   try {
     weight = prefs.getIntPref(prefPrefix + weightName);
   } catch(ex) {}
   try {
     cutoff = prefs.getIntPref(prefPrefix + cutoffName);
   } catch(ex) {}
   if (cutoff < 1)
     return;
   // generate a date within the cutoff period
   var dateInPeriod = (now - ((cutoff - 1) * 86400 * 1000)) * 1000;
   for (let [bonusName, visitType] in Iterator(bonusPrefs)) {
     var frecency = -1;
     var calculatedURI = null;
     var matchTitle = "";
     var bonusValue = prefs.getIntPref(prefPrefix + bonusName);
     // unvisited (only for first cutoff date bucket)
     if (bonusName == "unvisitedBookmarkBonus" || bonusName == "unvisitedTypedBonus") {
       if (cutoffName == "firstBucketCutoff") {
         var points = Math.ceil(bonusValue / parseFloat(100.0) * weight);
         var visitCount = 1; //bonusName == "unvisitedBookmarkBonus" ? 1 : 0;
         frecency = Math.ceil(visitCount * points);
         calculatedURI = uri("http://" + searchTerm + ".com/" +
           bonusName + ":" + bonusValue + "/cutoff:" + cutoff +
           "/weight:" + weight + "/frecency:" + frecency);
         if (bonusName == "unvisitedBookmarkBonus") {
           matchTitle = searchTerm + "UnvisitedBookmark";
           bmsvc.insertBookmark(bmsvc.unfiledBookmarksFolder, calculatedURI, bmsvc.DEFAULT_INDEX, matchTitle);
         }
         else {
           matchTitle = searchTerm + "UnvisitedTyped";
           yield promiseAddVisits({
             uri: calculatedURI,
             title: matchTitle,
             transition: visitType,
             visitDate: now
           });
           histsvc.markPageAsTyped(calculatedURI);
         }
       }
     }
     else {
       // visited
       // visited bookmarks get the visited bookmark bonus twice
       if (visitType == Ci.nsINavHistoryService.TRANSITION_BOOKMARK)
         bonusValue = bonusValue * 2;
       var points = Math.ceil(1 * ((bonusValue / parseFloat(100.000000)).toFixed(6) * weight) / 1);
       if (!points) {
         if (visitType == Ci.nsINavHistoryService.TRANSITION_EMBED ||
             visitType == Ci.nsINavHistoryService.TRANSITION_FRAMED_LINK ||
             visitType == Ci.nsINavHistoryService.TRANSITION_DOWNLOAD ||
             bonusName == "defaultVisitBonus")
           frecency = 0;
         else
           frecency = -1;
       }
       else
         frecency = points;
       calculatedURI = uri("http://" + searchTerm + ".com/" +
         bonusName + ":" + bonusValue + "/cutoff:" + cutoff +
         "/weight:" + weight + "/frecency:" + frecency);
       if (visitType == Ci.nsINavHistoryService.TRANSITION_BOOKMARK) {
         matchTitle = searchTerm + "Bookmarked";
         bmsvc.insertBookmark(bmsvc.unfiledBookmarksFolder, calculatedURI, bmsvc.DEFAULT_INDEX, matchTitle);
       }
       else
         matchTitle = calculatedURI.spec.substr(calculatedURI.spec.lastIndexOf("/")+1);
       yield promiseAddVisits({
         uri: calculatedURI,
         transition: visitType,
         visitDate: dateInPeriod
       });
     }
     if (calculatedURI && frecency) {
       results.push([calculatedURI, frecency, matchTitle]);
       yield promiseAddVisits({
         uri: calculatedURI,
         title: matchTitle,
         transition: visitType,
         visitDate: dateInPeriod
       });
     }
   }
 }
 function AutoCompleteInput(aSearches) {
   this.searches = aSearches;
 }
 AutoCompleteInput.prototype = {
   constructor: AutoCompleteInput,
   searches: null,
   minResultsForPopup: 0,
   timeout: 10,
   searchParam: "",
   textValue: "",
   disableAutoComplete: false,
   completeDefaultIndex: false,
   get searchCount() {
     return this.searches.length;
   },
   getSearchAt: function(aIndex) {
     return this.searches[aIndex];
   },
   onSearchBegin: function() {},
   onSearchComplete: function() {},
   popupOpen: false,
   popup: {
     setSelectedIndex: function(aIndex) {},
     invalidate: function() {},
     // nsISupports implementation
     QueryInterface: function(iid) {
       if (iid.equals(Ci.nsISupports) ||
           iid.equals(Ci.nsIAutoCompletePopup))
         return this;
       throw Components.results.NS_ERROR_NO_INTERFACE;
     }
   },
   // nsISupports implementation
   QueryInterface: function(iid) {
     if (iid.equals(Ci.nsISupports) ||
         iid.equals(Ci.nsIAutoCompleteInput))
       return this;
     throw Components.results.NS_ERROR_NO_INTERFACE;
   }
 }
 function run_test()
 {
   run_next_test();
 }
 add_task(function test_frecency()
 {
   for (let [, bucket] in Iterator(bucketPrefs)) {
     yield task_initializeBucket(bucket);
   }
   // sort results by frecency
   results.sort(function(a,b) b[1] - a[1]);
   // Make sure there's enough results returned
   prefs.setIntPref("browser.urlbar.maxRichResults", results.length);
   // DEBUG
   //results.every(function(el) { dump("result: " + el[1] + ": " + el[0].spec + " (" + el[2] + ")\n"); return true; })
   yield promiseAsyncUpdates();
   var controller = Components.classes["@mozilla.org/autocomplete/controller;1"].
                    getService(Components.interfaces.nsIAutoCompleteController);
   // Make an AutoCompleteInput that uses our searches
   // and confirms results on search complete
   var input = new AutoCompleteInput(["history"]);
   controller.input = input;
   // always search in history + bookmarks, no matter what the default is
   prefs.setIntPref("browser.urlbar.search.sources", 3);
   prefs.setIntPref("browser.urlbar.default.behavior", 0);
   var numSearchesStarted = 0;
   input.onSearchBegin = function() {
     numSearchesStarted++;
     do_check_eq(numSearchesStarted, 1);
   };
   let deferred = Promise.defer();
   input.onSearchComplete = function() {
     do_check_eq(numSearchesStarted, 1);
     do_check_eq(controller.searchStatus,
                 Ci.nsIAutoCompleteController.STATUS_COMPLETE_MATCH);
     // test that all records with non-zero frecency were matched
     do_check_eq(controller.matchCount, results.length);
     // test that matches are sorted by frecency
     for (var i = 0; i < controller.matchCount; i++) {
       let searchURL = controller.getValueAt(i);
       let expectURL = results[i][0].spec;
       if (searchURL == expectURL) {
         do_check_eq(controller.getValueAt(i), results[i][0].spec);
         do_check_eq(controller.getCommentAt(i), results[i][2]);
       } else {
         // If the results didn't match exactly, perhaps it's still the right
         // frecency just in the wrong "order" (order of same frecency is
         // undefined), so check if frecency matches. This is okay because we
         // can still ensure the correct number of expected frecencies.
         let getFrecency = function(aURL) aURL.match(/frecency:(-?\d+)$/)[1];
         print("### checking for same frecency between '" + searchURL +
               "' and '" + expectURL + "'");
         do_check_eq(getFrecency(searchURL), getFrecency(expectURL));
       }
     }
     deferred.resolve();
   };
   controller.startSearch(searchTerm);
   yield deferred.promise;
 });