<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[184508] trunk/Source/WebInspectorUI</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/184508">184508</a></dd>
<dt>Author</dt> <dd>commit-queue@webkit.org</dd>
<dt>Date</dt> <dd>2015-05-18 12:53:28 -0700 (Mon, 18 May 2015)</dd>
</dl>
<h3>Log Message</h3>
<pre>Web Inspector: Tab Restoration incorrectly makes ContentViews "shown" in background tabs
https://bugs.webkit.org/show_bug.cgi?id=145080
Patch by Joseph Pecoraro <pecoraro@apple.com> on 2015-05-18
Reviewed by Timothy Hatcher.
Many tabs have their own content browser / navigation sidebar. During
state restoration, each tab would immediately try to restore an
appropriate ContentView after the load / navigation. However, in doing
so, we weren't respecting whether or not the Tab the ContentBrowser
was in was hidden or not, so ContentViews in background tags were
still being treated as shown/visible.
This patch changes state restoration to only affect the foreground
tab, and be delayed on all background tabs until that tab is shown.
This reduces the amount of work on load and navigation to just a
single tab instead of all tabs. Most importantly, it avoids having
performing work on ContentBrowsers that are non-visible, so state
restoration only happens for visible ContentBrowsers.
For simplicity, in the case of a delayed tab restoration triggered
by the user switching tabs, we don't try twice (like we occasionally
do on load/reload). We could add back some hueristic here if needed.
* UserInterface/Base/Main.js:
(WebInspector.contentLoaded):
(WebInspector.activateExtraDomains):
(WebInspector._mainResourceDidChange):
(WebInspector._restoreCookieForOpenTabs):
* UserInterface/Views/NavigationSidebarPanel.js:
* UserInterface/Views/TabContentView.js:
(WebInspector.TabContentView.prototype.shown):
(WebInspector.TabContentView.prototype.restoreStateFromCookie):
(WebInspector.TabContentView.prototype.saveStateToCookie):
When asked to restore state, save that logic until the next time the tab is shown.
* UserInterface/Views/TextEditor.js:
(WebInspector.TextEditor.prototype.get visible):
* UserInterface/Views/SourceCodeTextEditor.js:
(WebInspector.SourceCodeTextEditor.prototype.editingControllerDidStartEditing):
(WebInspector.SourceCodeTextEditor.prototype._setTypeTokenAnnotatorEnabledState): Deleted.
Although this didn't actually catch the issue, it could potentially
catch other issues in the future. We don't want to enable the annotators
in a non-visible text editor, as it could be a performance issue.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebInspectorUIChangeLog">trunk/Source/WebInspectorUI/ChangeLog</a></li>
<li><a href="#trunkSourceWebInspectorUIUserInterfaceBaseMainjs">trunk/Source/WebInspectorUI/UserInterface/Base/Main.js</a></li>
<li><a href="#trunkSourceWebInspectorUIUserInterfaceViewsNavigationSidebarPaneljs">trunk/Source/WebInspectorUI/UserInterface/Views/NavigationSidebarPanel.js</a></li>
<li><a href="#trunkSourceWebInspectorUIUserInterfaceViewsSourceCodeTextEditorjs">trunk/Source/WebInspectorUI/UserInterface/Views/SourceCodeTextEditor.js</a></li>
<li><a href="#trunkSourceWebInspectorUIUserInterfaceViewsTabContentViewjs">trunk/Source/WebInspectorUI/UserInterface/Views/TabContentView.js</a></li>
<li><a href="#trunkSourceWebInspectorUIUserInterfaceViewsTextEditorjs">trunk/Source/WebInspectorUI/UserInterface/Views/TextEditor.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebInspectorUIChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebInspectorUI/ChangeLog (184507 => 184508)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebInspectorUI/ChangeLog 2015-05-18 19:35:03 UTC (rev 184507)
+++ trunk/Source/WebInspectorUI/ChangeLog 2015-05-18 19:53:28 UTC (rev 184508)
</span><span class="lines">@@ -1,3 +1,50 @@
</span><ins>+2015-05-18 Joseph Pecoraro <pecoraro@apple.com>
+
+ Web Inspector: Tab Restoration incorrectly makes ContentViews "shown" in background tabs
+ https://bugs.webkit.org/show_bug.cgi?id=145080
+
+ Reviewed by Timothy Hatcher.
+
+ Many tabs have their own content browser / navigation sidebar. During
+ state restoration, each tab would immediately try to restore an
+ appropriate ContentView after the load / navigation. However, in doing
+ so, we weren't respecting whether or not the Tab the ContentBrowser
+ was in was hidden or not, so ContentViews in background tags were
+ still being treated as shown/visible.
+
+ This patch changes state restoration to only affect the foreground
+ tab, and be delayed on all background tabs until that tab is shown.
+ This reduces the amount of work on load and navigation to just a
+ single tab instead of all tabs. Most importantly, it avoids having
+ performing work on ContentBrowsers that are non-visible, so state
+ restoration only happens for visible ContentBrowsers.
+
+ For simplicity, in the case of a delayed tab restoration triggered
+ by the user switching tabs, we don't try twice (like we occasionally
+ do on load/reload). We could add back some hueristic here if needed.
+
+ * UserInterface/Base/Main.js:
+ (WebInspector.contentLoaded):
+ (WebInspector.activateExtraDomains):
+ (WebInspector._mainResourceDidChange):
+ (WebInspector._restoreCookieForOpenTabs):
+ * UserInterface/Views/NavigationSidebarPanel.js:
+
+ * UserInterface/Views/TabContentView.js:
+ (WebInspector.TabContentView.prototype.shown):
+ (WebInspector.TabContentView.prototype.restoreStateFromCookie):
+ (WebInspector.TabContentView.prototype.saveStateToCookie):
+ When asked to restore state, save that logic until the next time the tab is shown.
+
+ * UserInterface/Views/TextEditor.js:
+ (WebInspector.TextEditor.prototype.get visible):
+ * UserInterface/Views/SourceCodeTextEditor.js:
+ (WebInspector.SourceCodeTextEditor.prototype.editingControllerDidStartEditing):
+ (WebInspector.SourceCodeTextEditor.prototype._setTypeTokenAnnotatorEnabledState): Deleted.
+ Although this didn't actually catch the issue, it could potentially
+ catch other issues in the future. We don't want to enable the annotators
+ in a non-visible text editor, as it could be a performance issue.
+
</ins><span class="cx"> 2015-05-15 Matt Baker <mattbaker@apple.com>
</span><span class="cx">
</span><span class="cx"> Web Inspector: empty timeline should not use previous timeline's zoom interval
</span></span></pre></div>
<a id="trunkSourceWebInspectorUIUserInterfaceBaseMainjs"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebInspectorUI/UserInterface/Base/Main.js (184507 => 184508)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebInspectorUI/UserInterface/Base/Main.js 2015-05-18 19:35:03 UTC (rev 184507)
+++ trunk/Source/WebInspectorUI/UserInterface/Base/Main.js 2015-05-18 19:53:28 UTC (rev 184508)
</span><span class="lines">@@ -41,6 +41,12 @@
</span><span class="cx"> WebInspector.SelectedSidebarPanelCookieKey = "selected-sidebar-panel";
</span><span class="cx"> WebInspector.TypeIdentifierCookieKey = "represented-object-type";
</span><span class="cx">
</span><ins>+WebInspector.StateRestorationType = {
+ Load: "state-restoration-load",
+ Navigation: "state-restoration-navigation",
+ Delayed: "state-restoration-delayed",
+};
+
</ins><span class="cx"> WebInspector.loaded = function()
</span><span class="cx"> {
</span><span class="cx"> // Initialize WebSocket to communication.
</span><span class="lines">@@ -343,7 +349,7 @@
</span><span class="cx"> this.tabBrowser.addTabForContentView(tabContentView, true);
</span><span class="cx"> }
</span><span class="cx">
</span><del>- this._restoreCookieForOpenTabs();
</del><ins>+ this._restoreCookieForOpenTabs(WebInspector.StateRestorationType.Load);
</ins><span class="cx">
</span><span class="cx"> this.tabBar.selectedTabBarItem = this._selectedTabIndexSetting.value;
</span><span class="cx">
</span><span class="lines">@@ -508,7 +514,7 @@
</span><span class="cx">
</span><span class="cx"> this.tabBrowser.addTabForContentView(tabContentView, true);
</span><span class="cx">
</span><del>- tabContentView.restoreStateFromCookie();
</del><ins>+ tabContentView.restoreStateFromCookie(WebInspector.StateRestorationType.Load);
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> this._pendingOpenTabTypes = stillPendingOpenTabTypes;
</span><span class="lines">@@ -1129,7 +1135,7 @@
</span><span class="cx">
</span><span class="cx"> // Run cookie restoration after we are sure all of the Tabs and NavigationSidebarPanels
</span><span class="cx"> // have updated with respect to the main resource change.
</span><del>- setTimeout(this._restoreCookieForOpenTabs.bind(this, true));
</del><ins>+ setTimeout(this._restoreCookieForOpenTabs.bind(this, WebInspector.StateRestorationType.Navigation));
</ins><span class="cx">
</span><span class="cx"> this._updateDownloadToolbarButton();
</span><span class="cx">
</span><span class="lines">@@ -1146,13 +1152,13 @@
</span><span class="cx"> this._inProvisionalLoad = true;
</span><span class="cx"> };
</span><span class="cx">
</span><del>-WebInspector._restoreCookieForOpenTabs = function(causedByNavigation)
</del><ins>+WebInspector._restoreCookieForOpenTabs = function(restorationType)
</ins><span class="cx"> {
</span><span class="cx"> for (var tabBarItem of this.tabBar.tabBarItems) {
</span><span class="cx"> var tabContentView = tabBarItem.representedObject;
</span><span class="cx"> if (!(tabContentView instanceof WebInspector.TabContentView))
</span><span class="cx"> continue;
</span><del>- tabContentView.restoreStateFromCookie(causedByNavigation);
</del><ins>+ tabContentView.restoreStateFromCookie(restorationType);
</ins><span class="cx"> }
</span><span class="cx"> };
</span><span class="cx">
</span></span></pre></div>
<a id="trunkSourceWebInspectorUIUserInterfaceViewsNavigationSidebarPaneljs"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebInspectorUI/UserInterface/Views/NavigationSidebarPanel.js (184507 => 184508)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebInspectorUI/UserInterface/Views/NavigationSidebarPanel.js 2015-05-18 19:35:03 UTC (rev 184507)
+++ trunk/Source/WebInspectorUI/UserInterface/Views/NavigationSidebarPanel.js 2015-05-18 19:53:28 UTC (rev 184508)
</span><span class="lines">@@ -235,6 +235,9 @@
</span><span class="cx"> if (this._finalAttemptToRestoreViewStateTimeout)
</span><span class="cx"> clearTimeout(this._finalAttemptToRestoreViewStateTimeout);
</span><span class="cx">
</span><ins>+ if (relaxedMatchDelay === 0)
+ return;
+
</ins><span class="cx"> function finalAttemptToRestoreViewStateFromCookie()
</span><span class="cx"> {
</span><span class="cx"> delete this._finalAttemptToRestoreViewStateTimeout;
</span></span></pre></div>
<a id="trunkSourceWebInspectorUIUserInterfaceViewsSourceCodeTextEditorjs"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebInspectorUI/UserInterface/Views/SourceCodeTextEditor.js (184507 => 184508)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebInspectorUI/UserInterface/Views/SourceCodeTextEditor.js 2015-05-18 19:35:03 UTC (rev 184507)
+++ trunk/Source/WebInspectorUI/UserInterface/Views/SourceCodeTextEditor.js 2015-05-18 19:53:28 UTC (rev 184508)
</span><span class="lines">@@ -1648,6 +1648,8 @@
</span><span class="cx"> return;
</span><span class="cx">
</span><span class="cx"> if (shouldActivate) {
</span><ins>+ console.assert(this.visible, "Annotators should not be enabled if the TextEditor is not visible");
+
</ins><span class="cx"> RuntimeAgent.enableTypeProfiler();
</span><span class="cx">
</span><span class="cx"> this._typeTokenAnnotator.reset();
</span></span></pre></div>
<a id="trunkSourceWebInspectorUIUserInterfaceViewsTabContentViewjs"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebInspectorUI/UserInterface/Views/TabContentView.js (184507 => 184508)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebInspectorUI/UserInterface/Views/TabContentView.js 2015-05-18 19:35:03 UTC (rev 184507)
+++ trunk/Source/WebInspectorUI/UserInterface/Views/TabContentView.js 2015-05-18 19:53:28 UTC (rev 184508)
</span><span class="lines">@@ -107,15 +107,30 @@
</span><span class="cx"> return false;
</span><span class="cx"> },
</span><span class="cx">
</span><del>- restoreStateFromCookie: function(causedByNavigation)
</del><ins>+ shown: function()
</ins><span class="cx"> {
</span><ins>+ if (this._shouldRestoreStateWhenShown)
+ this.restoreStateFromCookie(WebInspector.StateRestorationType.Delayed);
+ },
+
+ restoreStateFromCookie: function(restorationType)
+ {
</ins><span class="cx"> if (!this.navigationSidebarPanel)
</span><span class="cx"> return;
</span><span class="cx">
</span><del>- var matchTypeOnlyDelayForNavigation = 2000;
- var matchTypeOnlyDelayForReopen = 1000;
</del><ins>+ if (!this.visible) {
+ this._shouldRestoreStateWhenShown = true;
+ return;
+ }
</ins><span class="cx">
</span><del>- var relaxMatchDelay = causedByNavigation ? matchTypeOnlyDelayForNavigation : matchTypeOnlyDelayForReopen;
</del><ins>+ this._shouldRestoreStateWhenShown = false;
+
+ var relaxMatchDelay = 0;
+ if (restorationType === WebInspector.StateRestorationType.Load)
+ relaxMatchDelay = 1000;
+ else if (restorationType === WebInspector.StateRestorationType.Navigation)
+ relaxMatchDelay = 2000;
+
</ins><span class="cx"> this.navigationSidebarPanel.restoreStateFromCookie(this._cookieSetting.value || {}, relaxMatchDelay);
</span><span class="cx"> },
</span><span class="cx">
</span><span class="lines">@@ -124,6 +139,9 @@
</span><span class="cx"> if (!this.navigationSidebarPanel)
</span><span class="cx"> return;
</span><span class="cx">
</span><ins>+ if (this._shouldRestoreStateWhenShown)
+ return;
+
</ins><span class="cx"> var cookie = {};
</span><span class="cx"> this.navigationSidebarPanel.saveStateToCookie(cookie);
</span><span class="cx"> this._cookieSetting.value = cookie;
</span></span></pre></div>
<a id="trunkSourceWebInspectorUIUserInterfaceViewsTextEditorjs"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebInspectorUI/UserInterface/Views/TextEditor.js (184507 => 184508)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebInspectorUI/UserInterface/Views/TextEditor.js 2015-05-18 19:35:03 UTC (rev 184507)
+++ trunk/Source/WebInspectorUI/UserInterface/Views/TextEditor.js 2015-05-18 19:53:28 UTC (rev 184508)
</span><span class="lines">@@ -76,6 +76,11 @@
</span><span class="cx"> return this._element;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ get visible()
+ {
+ return this._visible;
+ }
+
</ins><span class="cx"> get string()
</span><span class="cx"> {
</span><span class="cx"> return this._codeMirror.getValue();
</span></span></pre>
</div>
</div>
</body>
</html>