InstantExtended: local omnibox popup fixes.

chrome/browser/resources/local_omnibox_popup/local_omnibox_popup.js

 // Copyright 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 /**
  * @fileoverview Support for omnibox behavior in offline mode or when API
  * features are not supported on the server.
  */
 
 // ==========================================================
@@ skipping 21 matching lines @@
 // =============================================================================
 
 /**
  * The maximum number of suggestions to show.
  * @type {number}
  * @const
  */
 var MAX_SUGGESTIONS_TO_SHOW = 5;
 
 /**
+ * Assume any native suggestion with a score higher than this value has been
+ * inlined by the browser.
+ * @type {number}
+ * @const
+ */
+var INLINE_SUGGESTION_THRESHOLD = 1200;
+
+/**
+ * Suggestion provider type corresponding to a verbatim URL suggestion.
+ * @type {string}
+ * @const
+ */
+var VERBATIM_URL_TYPE = 'url-what-you-typed';
+
+/**
  * The omnibox input value during the last onnativesuggestions event.
  * @type {string}
  */
 var lastInputValue = '';
 
 /**
  * The ordered restricted ids of the currently displayed suggestions.  Since the
  * suggestions contain the user's personal data (browser history) the searchBox
  * API embeds the content of the suggestion in a shadow dom, and assigns a
  * random restricted id to each suggestion which is accessible to the JS.
@@ skipping 47 matching lines @@
  * Renders the input suggestions.
  * @param {Array} nativeSuggestions An array of native suggestions to render.
  */
 function renderSuggestions(nativeSuggestions) {
   var box = document.createElement('div');
   box.id = 'suggestionsBox';
   $('suggestions-box-container').appendChild(box);
 
   for (var i = 0, length = nativeSuggestions.length;
        i < Math.min(MAX_SUGGESTIONS_TO_SHOW, length); ++i) {
-    // Select the first suggestion.
-    addSuggestionToBox(nativeSuggestions[i], box, i == 0);
+    addSuggestionToBox(nativeSuggestions[i], box, i == selectedIndex);
   }
 }
 
 /**
  * Clears the suggestions being displayed.
  */
 function clearSuggestions() {
   $('suggestions-box-container').innerHTML = '';
   restrictedIds = [];
   selectedIndex = -1;
 }
 
 /**
  * @return {integer} The height of the dropdown.
  */
 function getDropdownHeight() {
   return $('suggestions-box-container').offsetHeight;
 }
 
 /**
+ * @param {Object} suggestion A suggestion.
+ * @param {boolean} inVerbatimMode Are we in verbatim mode?
+ * @return {boolean} True if the suggestion should be selected.
+ */
+function shouldSelectSuggestion(suggestion, inVerbatimMode) {
+  var isVerbatimUrl = suggestion.type == VERBATIM_URL_TYPE;
+  var inlinableSuggestion = suggestion.rankingData.relevance >
+      INLINE_SUGGESTION_THRESHOLD;
+  // Verbatim URLs should always be selected. Otherwise, select suggestions
+  // with a high enough score unless we are in verbatim mode (e.g. backspacing
+  // away).
+  return isVerbatimUrl || (!inVerbatimMode && inlinableSuggestion);
+}
+
+/**
  * Updates selectedIndex, bounding it between -1 and the total number of
  * of suggestions - 1 (looping as necessary), and selects the corresponding
  * suggestion.
  * @param {boolean} increment True to increment the selected suggestion, false
  *     to decrement.
  */
 function updateSelectedSuggestion(increment) {
   var numSuggestions = restrictedIds.length;
   if (!numSuggestions)
     return;
@@ skipping 30 matching lines @@
   if (window.navigator && window.navigator.embeddedSearch &&
       window.navigator.embeddedSearch.searchBox)
     return window.navigator.embeddedSearch.searchBox;
   if (window.chrome && window.chrome.embeddedSearch &&
       window.chrome.embeddedSearch.searchBox)
     return window.chrome.embeddedSearch.searchBox;
   return null;
 }
 
 /**
- * chrome.searchBox.onnativesuggestions implementation.
+ * Updates suggestions in response to a onchange or onnativesuggestions call.
  */
-function handleNativeSuggestions() {
+function updateSuggestions() {
   var apiHandle = getApiObjectHandle();
-
-  // Used to workaround repeated undesired asynchronous onnativesuggestions

[Jered, 2013/03/15 17:05:06]

Is it ok to remove this now?

[samarth, 2013/03/15 21:58:27]

Talked to Jeremy who wrote this and this was just a workaround for the clicking
on suggestions bug which you just fixed.

-  // events and the fact that when a suggestion is clicked, the omnibox unfocus
-  // can cause onnativesuggestions to fire, preventing the suggestion onclick
-  // from registering.
-  if (lastInputValue == apiHandle.value && $('suggestionsBox')) {
-    return;
-  }
   lastInputValue = apiHandle.value;
 
   clearSuggestions();
   var nativeSuggestions = apiHandle.nativeSuggestions;
   if (nativeSuggestions.length) {
     nativeSuggestions.sort(function(a, b) {
       return b.rankingData.relevance - a.rankingData.relevance;
     });
+    if (shouldSelectSuggestion(nativeSuggestions[0], apiHandle.verbatim)) {

[Jered, 2013/03/15 17:05:06]

Reset the selectedIndex to -1 otherwise.

[samarth, 2013/03/15 21:58:27]

Already being done in clearSuggestions above. Would you prefer to do it
explicitly here?

[Jered, 2013/03/15 22:04:09]

Oh, I missed that. This way is fine.

+      selectedIndex = 0;
+      apiHandle.setRestrictedAutocompleteText(
+          nativeSuggestions[selectedIndex].rid);
+    }
     renderSuggestions(nativeSuggestions);
-    selectedIndex = 0;
-    apiHandle.setRestrictedAutocompleteText(
-        nativeSuggestions[selectedIndex].rid);
   }
 
   var height = getDropdownHeight();
   // TODO(jered): Remove deprecated "reason" argument.
   apiHandle.showOverlay(2, height);
 }
 
 /**
  * Appends a style node for suggestion properties that depend on apiHandle.
  */
@@ skipping 54 matching lines @@
  * chrome.searchBox.embeddedSearch.onsubmit implementation.
  */
 function onSubmit() {
 }
 
 /**
  * Sets up the searchBox API.
  */
 function setUpApi() {
   var apiHandle = getApiObjectHandle();
-  apiHandle.onnativesuggestions = handleNativeSuggestions;
+  apiHandle.onnativesuggestions = updateSuggestions;
+  apiHandle.onchange = updateSuggestions;

[Jered, 2013/03/15 17:05:06]

Why does this also need to happen onchange?

[samarth, 2013/03/15 21:58:27]

AFAICT, hitting backspace does not trigger onnativesuggestions, only an
onchange.

   apiHandle.onkeypress = handleKeyPress;
   apiHandle.onsubmit = onSubmit;
   appendSuggestionStyles();
 
   if (apiHandle.nativeSuggestions.length)
     handleNativeSuggestions();
 }
 
 document.addEventListener('DOMContentLoaded', setUpApi);