Bug 395739 - adaptive learning (match entered text to selected item) in url bar autocomplete. r=dietrich, b-ff3=beltzner, a1.9=beltzner, a1.9b4=beltzner
authoredward.lee@engineering.uiuc.edu
Thu, 28 Feb 2008 08:04:13 -0800
changeset 12341 163ef2f91d48
parent 12340 a84b71704e8a
child 12342 5d847de00e56
push id1
push userjst@mozilla.com
push dateSat, 05 Apr 2008 21:05:47 +0000
reviewersdietrich
bugs395739
milestone1.9b4pre
Bug 395739 - adaptive learning (match entered text to selected item) in url bar autocomplete. r=dietrich, b-ff3=beltzner, a1.9=beltzner, a1.9b4=beltzner
toolkit/components/places/src/nsNavHistory.h
toolkit/components/places/src/nsNavHistoryAutoComplete.cpp
toolkit/components/places/tests/unit/test_adaptive.js
--- a/toolkit/components/places/src/nsNavHistory.h
+++ b/toolkit/components/places/src/nsNavHistory.h
@@ -16,16 +16,17 @@
  *
  * The Initial Developer of the Original Code is
  * Google Inc.
  * Portions created by the Initial Developer are Copyright (C) 2005
  * the Initial Developer. All Rights Reserved.
  *
  * Contributor(s):
  *   Brett Wilson <brettw@gmail.com> (original author)
+ *   Edward Lee <edward.lee@engineering.uiuc.edu>
  *
  * Alternatively, the contents of this file may be used under the terms of
  * either the GNU General Public License Version 2 or later (the "GPL"), or
  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  * in which case the provisions of the GPL or the LGPL are applicable instead
  * of those above. If you wish to allow use of your version of this file only
  * under the terms of either the GPL or the LGPL, and not to allow others to
  * use your version of this file under the terms of the MPL, indicate your
@@ -644,16 +645,17 @@ protected:
   //
   static const PRInt32 kAutoCompleteIndex_URL;
   static const PRInt32 kAutoCompleteIndex_Title;
   static const PRInt32 kAutoCompleteIndex_FaviconURL;
   static const PRInt32 kAutoCompleteIndex_ParentId;
   static const PRInt32 kAutoCompleteIndex_BookmarkTitle;
   static const PRInt32 kAutoCompleteIndex_Tags;
   nsCOMPtr<mozIStorageStatement> mDBAutoCompleteQuery; //  kAutoCompleteIndex_* results
+  nsCOMPtr<mozIStorageStatement> mDBAdaptiveQuery; //  kAutoCompleteIndex_* results
   nsCOMPtr<mozIStorageStatement> mDBFeedbackIncrease;
 
   nsresult InitAutoComplete();
   nsresult CreateAutoCompleteQueries();
   PRBool mAutoCompleteOnlyTyped;
   PRBool mAutoCompleteFilterJavascript;
   PRInt32 mAutoCompleteMaxResults;
   PRInt32 mAutoCompleteSearchChunkSize;
@@ -676,22 +678,24 @@ protected:
 
   nsDataHashtable<nsStringHashKey, PRBool> mCurrentResultURLs;
   PRInt32 mCurrentChunkOffset;
 
   nsDataHashtable<nsTrimInt64HashKey, PRBool> mLivemarkFeedItemIds;
   nsDataHashtable<nsStringHashKey, PRBool> mLivemarkFeedURIs;
 
   nsresult AutoCompleteFullHistorySearch(PRBool* aHasMoreResults);
+  nsresult AutoCompleteAdaptiveSearch();
 
   /**
    * Query type passed to AutoCompleteProcessSearch to determine what style to
    * use and if results should be filtered
    */
   enum QueryType {
+    QUERY_ADAPTIVE,
     QUERY_FULL
   };
   nsresult AutoCompleteProcessSearch(mozIStorageStatement* aQuery,
                                      const QueryType aType,
                                      PRBool *aHasMoreResults = nsnull);
   PRBool AutoCompleteHasEnoughResults();
 
   nsresult PerformAutoComplete();
--- a/toolkit/components/places/src/nsNavHistoryAutoComplete.cpp
+++ b/toolkit/components/places/src/nsNavHistoryAutoComplete.cpp
@@ -20,16 +20,17 @@
  * the Initial Developer. All Rights Reserved.
  *
  * Contributor(s):
  *   Brett Wilson <brettw@gmail.com>
  *   Joe Hewitt <hewitt@netscape.com>
  *   Blake Ross <blaker@netscape.com>
  *   Seth Spitzer <sspitzer@mozilla.org>
  *   Dietrich Ayala <dietrich@mozilla.com>
+ *   Edward Lee <edward.lee@engineering.uiuc.edu>
  *
  * Alternatively, the contents of this file may be used under the terms of
  * either the GNU General Public License Version 2 or later (the "GPL"), or
  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  * in which case the provisions of the GPL or the LGPL are applicable instead
  * of those above. If you wish to allow use of your version of this file only
  * under the terms of either the GPL or the LGPL, and not to allow others to
  * use your version of this file under the terms of the MPL, indicate your
@@ -145,16 +146,28 @@ nsNavHistory::CreateAutoCompleteQueries(
   sql += NS_LITERAL_CSTRING(
     "ORDER BY h.frecency DESC LIMIT ?2 OFFSET ?3");
 
   nsresult rv = mDBConn->CreateStatement(sql, 
     getter_AddRefs(mDBAutoCompleteQuery));
   NS_ENSURE_SUCCESS(rv, rv);
 
   sql = NS_LITERAL_CSTRING(
+    "SELECT h.url, h.title, f.url, ") + bookTag + NS_LITERAL_CSTRING(
+      "ROUND(MAX(((i.input = ?2) + (SUBSTR(i.input, 1, LENGTH(?2)) = ?2)) * "
+                "i.use_count), 1) rank "
+    "FROM moz_inputhistory i "
+    "JOIN moz_places h ON h.id = i.place_id "
+    "LEFT OUTER JOIN moz_favicons f ON f.id = h.favicon_id "
+    "GROUP BY i.place_id HAVING rank > 0 "
+    "ORDER BY rank DESC, h.frecency DESC");
+  rv = mDBConn->CreateStatement(sql, getter_AddRefs(mDBAdaptiveQuery));
+  NS_ENSURE_SUCCESS(rv, rv);
+
+  sql = NS_LITERAL_CSTRING(
     // Leverage the PRIMARY KEY (place_id, input) to insert/update entries
     "INSERT OR REPLACE INTO moz_inputhistory "
     // use_count will asymptotically approach the max of 10
     "SELECT h.id, IFNULL(i.input, ?1), IFNULL(i.use_count, 0) * .9 + 1 "
     "FROM moz_places h "
     "LEFT OUTER JOIN moz_inputhistory i ON i.place_id = h.id AND i.input = ?1 "
     "WHERE h.url = ?2");
   rv = mDBConn->CreateStatement(sql, getter_AddRefs(mDBFeedbackIncrease));
@@ -198,16 +211,19 @@ nsNavHistory::PerformAutoComplete()
   if (!mCurrentListener)
     return NS_OK;
 
   mCurrentResult->SetSearchString(mCurrentSearchString);
 
   nsresult rv;
   // Only do some extra searches on the first chunk
   if (!mCurrentChunkOffset) {
+    // Get adaptive results first
+    rv = AutoCompleteAdaptiveSearch();
+    NS_ENSURE_SUCCESS(rv, rv);
   }
 
   PRBool moreChunksToSearch = PR_FALSE;
   rv = AutoCompleteFullHistorySearch(&moreChunksToSearch);
   NS_ENSURE_SUCCESS(rv, rv);
 
   // Only search more chunks if there are more and we need more results
   moreChunksToSearch &= !AutoCompleteHasEnoughResults();
@@ -357,16 +373,33 @@ nsNavHistory::GenerateSearchTokens()
 inline void
 nsNavHistory::AddSearchToken(nsAutoString &aToken)
 {
   aToken.Trim("\r\n\t\b");
   if (!aToken.IsEmpty())
     mCurrentSearchTokens.AppendString(aToken);
 }
 
+nsresult
+nsNavHistory::AutoCompleteAdaptiveSearch()
+{
+  mozStorageStatementScoper scope(mDBAdaptiveQuery);
+
+  nsresult rv = mDBAdaptiveQuery->BindInt32Parameter(0, GetTagsFolder());
+  NS_ENSURE_SUCCESS(rv, rv);
+
+  rv = mDBAdaptiveQuery->BindStringParameter(1, mCurrentSearchString);
+  NS_ENSURE_SUCCESS(rv, rv);
+
+  rv = AutoCompleteProcessSearch(mDBAdaptiveQuery, QUERY_ADAPTIVE);
+  NS_ENSURE_SUCCESS(rv, rv);
+
+  return NS_OK;
+}
+
 // nsNavHistory::AutoCompleteFullHistorySearch
 //
 // Search for places that have a title, url, 
 // or bookmark title(s) that contains mCurrentSearchString
 // and are within our current chunk of "frecency".
 //
 // @param aHasMoreResults is false if the query found no matching items
 //
new file mode 100644
--- /dev/null
+++ b/toolkit/components/places/tests/unit/test_adaptive.js
@@ -0,0 +1,241 @@
+/* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim:set ts=2 sw=2 sts=2 et: */
+/* ***** BEGIN LICENSE BLOCK *****
+ * Version: MPL 1.1/GPL 2.0/LGPL 2.1
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ * http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * The Original Code is Bug 378079 unit test code.
+ *
+ * The Initial Developer of the Original Code is POTI Inc.
+ * Portions created by the Initial Developer are Copyright (C) 2007
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ *   Matt Crocker <matt@songbirdnest.com>
+ *   Seth Spitzer <sspitzer@mozilla.org>
+ *   Edward Lee <edward.lee@engineering.uiuc.edu>
+ *
+ * Alternatively, the contents of this file may be used under the terms of
+ * either the GNU General Public License Version 2 or later (the "GPL"), or
+ * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
+ * in which case the provisions of the GPL or the LGPL are applicable instead
+ * of those above. If you wish to allow use of your version of this file only
+ * under the terms of either the GPL or the LGPL, and not to allow others to
+ * use your version of this file under the terms of the MPL, indicate your
+ * decision by deleting the provisions above and replace them with the notice
+ * and other provisions required by the GPL or the LGPL. If you do not delete
+ * the provisions above, a recipient may use your version of this file under
+ * the terms of any one of the MPL, the GPL or the LGPL.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+/**
+ * Test for bug 395739 to make sure the feedback to the search results in those
+ * entries getting better ranks. Additionally, exact matches should be ranked
+ * higher. Because the interactions among adaptive rank and visit counts is not
+ * well defined, this test holds one of the two values constant when modifying
+ * the other.
+ *
+ * This also tests bug 395735 for the instrumentation feedback mechanism.
+ */
+
+Components.utils.import("resource://gre/modules/XPCOMUtils.jsm");
+let current_test = 0;
+
+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];
+  },
+
+  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 ensure_results(uris, searchTerm)
+{
+  let 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
+  let input = new AutoCompleteInput(["history"]);
+
+  controller.input = input;
+
+  // Search is asynchronous, so don't let the test finish immediately
+  do_test_pending();
+
+  input.onSearchComplete = function() {
+    do_check_eq(controller.searchStatus,
+                Ci.nsIAutoCompleteController.STATUS_COMPLETE_MATCH);
+    do_check_eq(controller.matchCount, uris.length);
+    for (let i = 0; i < controller.matchCount; i++) {
+      do_check_eq(controller.getValueAt(i), uris[i].spec);
+    }
+
+    if (current_test < (tests.length - 1)) {
+      current_test++;
+      tests[current_test]();
+    }
+
+    do_test_finished();
+  };
+
+  controller.startSearch(searchTerm);
+}
+
+// Get history service
+try {
+  var histsvc = Cc["@mozilla.org/browser/nav-history-service;1"].getService(Ci.nsINavHistoryService);
+  var bhist = histsvc.QueryInterface(Ci.nsIBrowserHistory);
+  var obs = Cc["@mozilla.org/observer-service;1"].getService(Ci.nsIObserverService);
+} catch(ex) {
+  do_throw("Could not get history service\n");
+} 
+
+function setCountRank(aURI, aCount, aRank, aSearch)
+{
+  // Set the visit count and date for a uri
+  histsvc.setPageDetails(aURI, aURI, aCount, false, true);
+
+  // Bump up the visit count for the uri
+  for (let i = 0; i < aCount; i++)
+    histsvc.addVisit(aURI, d1, null, histsvc.TRANSITION_TYPED, false, 0);
+
+  // Make a nsIAutoCompleteController and friends for instrumentation feedback
+  let thing = {
+    QueryInterface: XPCOMUtils.generateQI([Ci.nsIAutoCompleteInput,
+                                           Ci.nsIAutoCompletePopup,
+                                           Ci.nsIAutoCompleteController]),
+    get popup() { return thing; },
+    get controller() { return thing; },
+    popupOpen: true,
+    selectedIndex: 0,
+    getValueAt: function() aURI.spec,
+    searchString: aSearch
+  };
+
+  // Bump up the instrumentation feedback
+  for (let i = 0; i < aRank; i++)
+    obs.notifyObservers(thing, "autocomplete-will-enter-text", null);
+}
+
+let uri1 = uri("http://site.tld/1");
+let uri2 = uri("http://site.tld/2");
+
+// d1 is some date for the page visit
+let d1 = new Date(Date.now() - 1000 * 60 * 60) * 1000;
+// c1 is larger (should show up higher) than c2
+let c1 = 10;
+let c2 = 1;
+// s1 is a partial match of s2
+let s0 = "";
+let s1 = "si";
+let s2 = "site";
+
+function prepTest(name) {
+  print("Test " + name);
+  bhist.removeAllPages();
+}
+
+let tests = [
+// Test things with a search term (exact match one, partial other)
+function() {
+  prepTest("4 same count, same rank, diff term; one exact/one partial search");
+  setCountRank(uri1, c1, c1, s1);
+  setCountRank(uri2, c1, c1, s2);
+  ensure_results([uri1, uri2], s1);
+},
+function() {
+  prepTest("5 same count, same rank, diff term; one exact/one partial search");
+  setCountRank(uri1, c1, c1, s2);
+  setCountRank(uri2, c1, c1, s1);
+  ensure_results([uri2, uri1], s1);
+},
+
+// Test things with a search term (exact match both)
+function() {
+  prepTest("6 same count, diff rank, same term; both exact search");
+  setCountRank(uri1, c1, c1, s1);
+  setCountRank(uri2, c1, c2, s1);
+  ensure_results([uri1, uri2], s1);
+},
+function() {
+  prepTest("7 same count, diff rank, same term; both exact search");
+  setCountRank(uri1, c1, c2, s1);
+  setCountRank(uri2, c1, c1, s1);
+  ensure_results([uri2, uri1], s1);
+},
+
+// Test things with a search term (partial match both)
+function() {
+  prepTest("8 same count, diff rank, same term; both partial search");
+  setCountRank(uri1, c1, c1, s2);
+  setCountRank(uri2, c1, c2, s2);
+  ensure_results([uri1, uri2], s1);
+},
+function() {
+  prepTest("9 same count, diff rank, same term; both partial search");
+  setCountRank(uri1, c1, c2, s2);
+  setCountRank(uri2, c1, c1, s2);
+  ensure_results([uri2, uri1], s1);
+},
+];
+
+/**
+ * Test history autocomplete
+ */
+function run_test() {
+  tests[0]();
+}