DevTools: fix stick to bottom in console viewport

third_party/WebKit/Source/devtools/front_end/console/ConsoleView.js

 /*
  * Copyright (C) 2007, 2008 Apple Inc.  All rights reserved.
  * Copyright (C) 2009 Joseph Pecoraro
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1.  Redistributions of source code must retain the above copyright
  *     notice, this list of conditions and the following disclaimer.
@@ skipping 118 matching lines @@
     /** @type {!Array.<!WebInspector.ConsoleViewMessage>} */
     this._consoleMessages = [];
     this._viewMessageSymbol = Symbol("viewMessage");
 
     this._prompt = new WebInspector.TextPromptWithHistory(WebInspector.ExecutionContextSelector.completionsForTextPromptInCurrentContext);
     this._prompt.setSuggestBoxEnabled(true);
     this._prompt.setAutocompletionTimeout(0);
     this._prompt.renderAsBlock();
     var proxyElement = this._prompt.attach(this._promptElement);
     proxyElement.addEventListener("keydown", this._promptKeyDown.bind(this), false);
+    proxyElement.addEventListener("input", this._promptInput.bind(this), false);
 
     this._consoleHistorySetting = WebInspector.settings.createLocalSetting("consoleHistory", []);
     var historyData = this._consoleHistorySetting.get();
     this._prompt.setHistoryData(historyData);
 
     this._consoleHistoryAutocompleteSetting = WebInspector.moduleSetting("consoleHistoryAutocomplete");
     this._consoleHistoryAutocompleteSetting.addChangeListener(this._consoleHistoryAutocompleteChanged, this);
     this._consoleHistoryAutocompleteChanged();
 
     this._updateFilterStatus();
     WebInspector.moduleSetting("consoleTimestampsEnabled").addChangeListener(this._consoleTimestampsSettingChanged, this);
 
     this._registerWithMessageSink();
     WebInspector.targetManager.observeTargets(this);
 
     this._initConsoleMessages();
 
     WebInspector.context.addFlavorChangeListener(WebInspector.ExecutionContext, this._executionContextChanged, this);
+
+    this._messagesElement.addEventListener("mousedown", this._updateStickToBottomOnMouseDown.bind(this), false);
+    this._messagesElement.addEventListener("mousewheel", this._updateStickToBottomOnMouseWheel.bind(this), false);
+    this._messagesElement.addEventListener("mouseup", this._updateStickToBottomOnMouseUp.bind(this), false);
+    this._messagesElement.addEventListener("mouseleave", this._updateStickToBottomOnMouseUp.bind(this), false);
+    this._messagesElement.addEventListener("keydown", this._updateStickToBottomOnKeyDown.bind(this), true);

[dgozman, 2016/08/05 17:36:42]

false

[luoe, 2016/08/05 19:43:57]

Done.

 }
 
 WebInspector.ConsoleView.persistedHistorySize = 300;
 
 WebInspector.ConsoleView.prototype = {
     /**
      * @return {!WebInspector.SearchableView}
      */
     searchableView: function()
     {
@@ skipping 179 matching lines @@
         if (this._promptElement === WebInspector.currentFocusElement())
             return;
         // Set caret position before setting focus in order to avoid scrolling
         // by focus().
         this._prompt.moveCaretToEndOfPrompt();
         WebInspector.setCurrentFocusElement(this._promptElement);
     },
 
     restoreScrollPositions: function()
     {
-        if (this._viewport.scrolledToBottom())
+        if (this._viewport.stickToBottom())
             this._immediatelyScrollToBottom();
         else
             WebInspector.Widget.prototype.restoreScrollPositions.call(this);
     },
 
     onResize: function()
     {
         this._scheduleViewportRefresh();
         this._hidePromptSuggestBox();
-        if (this._viewport.scrolledToBottom())
+        if (this._viewport.stickToBottom())
             this._immediatelyScrollToBottom();
         for (var i = 0; i < this._visibleViewMessages.length; ++i)
             this._visibleViewMessages[i].onResize();
     },
 
     _hidePromptSuggestBox: function()
     {
         this._prompt.hideSuggestBox();
         this._prompt.clearAutoComplete(true);
     },
 
     _scheduleViewportRefresh: function()
     {
         /**
          * @this {WebInspector.ConsoleView}
          * @return {!Promise.<undefined>}
          */
         function invalidateViewport()
         {
+            if (this._muteViewportUpdates)
+                return Promise.resolve();
             if (this._needsFullUpdate) {
                 this._updateMessageList();
                 delete this._needsFullUpdate;
             } else {
                 this._viewport.invalidate();
             }
             return Promise.resolve();
         }
+        if (this._muteViewportUpdates)
+            return;
         this._viewportThrottler.schedule(invalidateViewport.bind(this));
     },
 
     _immediatelyScrollToBottom: function()
     {
         // This will scroll viewport and trigger its refresh.
+        this._viewport.setStickToBottom(true);
         this._promptElement.scrollIntoView(true);
     },
 
     _updateFilterStatus: function()
     {
         this._filterStatusTextElement.textContent = WebInspector.UIString(this._hiddenByFilterCount === 1 ? "%d message is hidden by filters." : "%d messages are hidden by filters.", this._hiddenByFilterCount);
         this._filterStatusMessageElement.style.display = this._hiddenByFilterCount ? "" : "none";
     },
 
     /**
@@ skipping 587 matching lines @@
         this._currentMatchRangeIndex = index;
         this._searchableView.updateCurrentMatchIndex(index);
         matchRange = this._regexMatchRanges[index];
         var message = this._visibleViewMessages[matchRange.messageIndex];
         var highlightNode = message.searchHighlightNode(matchRange.matchIndex);
         highlightNode.classList.add(WebInspector.highlightedCurrentSearchResultClassName);
         this._viewport.scrollItemIntoView(matchRange.messageIndex);
         highlightNode.scrollIntoViewIfNeeded();
     },
 
+    _updateStickToBottomOnMouseDown: function()
+    {
+        this._muteViewportUpdates = true;
+        this._viewport.setStickToBottom(false);
+        this._wasScrolledToBottom = this._messagesElement.isScrolledToBottom();

[dgozman, 2016/08/05 17:36:41]

This we can remove.

[luoe, 2016/08/05 19:43:57]

Done.

+    },
+
+    _updateStickToBottomOnMouseUp: function()
+    {
+        if (!this._muteViewportUpdates)
+            return;
+
+        this._muteViewportUpdates = false;

[dgozman, 2016/08/05 17:36:41]

This goes to updateViewportState, together with scheduleUpdate.

[luoe, 2016/08/05 19:43:57]

Done.

+        if (this._wasScrolledToBottom) {
+            // Clicking the scrollbar may trigger events in the order:
+            // mousedown > mouseup > scroll. Delay querying isScrolledToBottom
+            // to give time for smooth scroll events to arrive. The value for
+            // the longest timeout duration is retrieved from crbug.com/575409.
+            setTimeout(updateViewportState.bind(this), 200);
+        } else {
+            // In another case, when users drag the scroll thumb to the bottom,
+            // the viewport should stick. Checking whether the mouse is released
+            // at the bottom of the viewport is not verifiable after an async
+            // timeout, so we do it immediately.
+            updateViewportState.call(this);
+        }
+        delete this._wasScrolledToBottom;
+
+        /**
+         * @this {!WebInspector.ConsoleView}
+         */
+        function updateViewportState()
+        {
+            this._viewport.setStickToBottom(this._messagesElement.isScrolledToBottom());
+            this._updateViewportStickinessForTest();
+        }
+    },
+
+    _updateViewportStickinessForTest: function()
+    {
+        // This method is sniffed in tests.
+    },
+
+    _updateStickToBottomOnMouseWheel: function()

[dgozman, 2016/08/05 17:10:01]

Do we handle touchpad here? Are there any other types of input to handle?
Could it be that scroll/input api already has a mechanism to handle this?

[luoe, 2016/08/05 19:43:57]

Good catch, switched from 'mousewheel' to 'wheel'.  Tested on Mac, touchpad
scrolls & flings fire wheel event.  According to MDN, 'wheel' can be generated
by an actual mouse or touch event.

+    {
+        this._updateStickToBottomOnMouseDown();
+        this._updateStickToBottomOnMouseUp();
+    },
+
+    _promptInput: function(event)
+    {
+        this._viewport.setStickToBottom(true);
+    },
+
+    _updateStickToBottomOnKeyDown: function(event)
+    {
+        if (!this._prompt.isCaretInsidePrompt())
+            return;
+
+        // Check for keys that should focus on prompt but do not change input.
+        var isHomeEnd = event.key === "Home" || event.key === "End";
+        var isArrowKey = event.key === "ArrowUp" || event.key === "ArrowRight" || event.key === "ArrowDown" || event.key === "ArrowLeft";
+
+        if (isHomeEnd || isArrowKey || event.key === "PageDown")
+            this._viewport.setStickToBottom(true);
+        else if (event.key === "PageUp")

[dgozman, 2016/08/05 17:10:01]

PageUp/PageDown are handled by multiline prompt - it moves the caret.
Can we avoid listening to the keyboard at all? As I understand it, we want to
stick to bottom when prompt gets attention (either input or selection changed).

[luoe, 2016/08/05 19:43:57]

We can actually move this logic into promptKeyDown(), which should fire when the
prompt is focused.

+            this._updateStickToBottomOnMouseWheel();

[dgozman, 2016/08/05 17:36:41]

We call this for all the keys listed above.

[luoe, 2016/08/05 19:43:57]

After manual testing, it looks like the rest of these don't need to call
updateStickToBottomOnMouseWheel.  Native behavior handles them fine

+    },
+
     __proto__: WebInspector.VBox.prototype
 }
 
 /**
  * @constructor
  * @extends {WebInspector.Object}
  * @param {!WebInspector.ConsoleView} view
  */
 WebInspector.ConsoleViewFilter = function(view)
 {
@@ skipping 322 matching lines @@
             return true;
         }
         return false;
     }
 }
 
 /**
 * @typedef {{messageIndex: number, matchIndex: number}}
 */
 WebInspector.ConsoleView.RegexMatchRange;