Changeset 207444 in webkit

Timestamp:

Oct 17, 2016 5:36:12 PM (8 years ago)

Author:

Joseph Pecoraro

Message:

Web Inspector: Add toggles for debugger pauses at console.assert failures
​https://bugs.webkit.org/show_bug.cgi?id=139542
<rdar://problem/19281600>

Reviewed by Timothy Hatcher.

Source/JavaScriptCore:

• inspector/agents/InspectorDebuggerAgent.h:
• inspector/agents/InspectorDebuggerAgent.cpp:

(Inspector::InspectorDebuggerAgent::disable):
(Inspector::InspectorDebuggerAgent::setPauseOnAssertions):
Toggle pause on assertions state. Default is disabled,
and disable it when frontends disconnect.

(Inspector::InspectorDebuggerAgent::handleConsoleAssert):
Instead of using the PauseOnAllExceptions state, use this
new state specific to assertions.

• inspector/protocol/Debugger.json:

New protocol method to toggle pausing on assertions.

Source/WebInspectorUI:

• UserInterface/Controllers/DebuggerManager.js:

(WebInspector.DebuggerManager.prototype.get assertionsBreakpoint):
(WebInspector.DebuggerManager.prototype.isBreakpointRemovable):
(WebInspector.DebuggerManager.prototype._breakpointDisabledStateDidChange):
New breakpoint and toggling behavior.

• Localizations/en.lproj/localizedStrings.js:
• UserInterface/Views/DebuggerSidebarPanel.js:

(WebInspector.DebuggerSidebarPanel):
(WebInspector.DebuggerSidebarPanel.prototype._breakpointTreeOutlineDeleteTreeElement):
(WebInspector.DebuggerSidebarPanel.prototype._compareTopLevelTreeElements.isSpecialBreakpoint):
(WebInspector.DebuggerSidebarPanel.prototype._compareTopLevelTreeElements):
New breakpoint tree element behavior.

(WebInspector.DebuggerSidebarPanel.prototype.saveStateToCookie):
(WebInspector.DebuggerSidebarPanel.prototype.restoreStateFromCookie):
Sidebar restoration if it was selected.

• UserInterface/Images/Assertion.svg: Added.
• UserInterface/Images/gtk/Assertion.svg: Added.
• UserInterface/Views/BreakpointTreeElement.css:

(.breakpoint-assertion-icon .icon):
New sidebar icon for the global breakpoint.

LayoutTests:

• inspector/debugger/pause-on-assert.html:
• inspector/debugger/pause-reason.html:

These tests need to enable pause on assertions.

• inspector/debugger/setPauseOnAssertions-expected.txt: Added.
• inspector/debugger/setPauseOnAssertions.html: Added.

Specific tests for the new protocol method.

Location:

trunk

Files:

• LayoutTests/ChangeLog (modified) (1 diff)
• LayoutTests/inspector/debugger/pause-on-assert.html (modified) (1 diff)
• LayoutTests/inspector/debugger/pause-reason.html (modified) (1 diff)
• LayoutTests/inspector/debugger/setPauseOnAssertions-expected.txt (added)
• LayoutTests/inspector/debugger/setPauseOnAssertions.html (added)
• Source/JavaScriptCore/ChangeLog (modified) (1 diff)
• Source/JavaScriptCore/inspector/agents/InspectorDebuggerAgent.cpp (modified) (3 diffs)
• Source/JavaScriptCore/inspector/agents/InspectorDebuggerAgent.h (modified) (2 diffs)
• Source/JavaScriptCore/inspector/protocol/Debugger.json (modified) (1 diff)
• Source/WebInspectorUI/ChangeLog (modified) (1 diff)
• Source/WebInspectorUI/Localizations/en.lproj/localizedStrings.js (modified) (3 diffs)
• Source/WebInspectorUI/UserInterface/Controllers/DebuggerManager.js (modified) (6 diffs)
• Source/WebInspectorUI/UserInterface/Images/Assertion.svg (added)
• Source/WebInspectorUI/UserInterface/Images/gtk/Assertion.svg (added)
• Source/WebInspectorUI/UserInterface/Views/BreakpointTreeElement.css (modified) (1 diff)
• Source/WebInspectorUI/UserInterface/Views/DebuggerSidebarPanel.js (modified) (7 diffs)

trunk/LayoutTests/ChangeLog

@@ +1 @@
+2016-10-17  Joseph Pecoraro  <pecoraro@apple.com>
+
+        Web Inspector: Add toggles for debugger pauses at console.assert failures
+        https://bugs.webkit.org/show_bug.cgi?id=139542
+        <rdar://problem/19281600>
+
+        Reviewed by Timothy Hatcher.
+
+        * inspector/debugger/pause-on-assert.html:
+        * inspector/debugger/pause-reason.html:
+        These tests need to enable pause on assertions.
+
+        * inspector/debugger/setPauseOnAssertions-expected.txt: Added.
+        * inspector/debugger/setPauseOnAssertions.html: Added.
+        Specific tests for the new protocol method.
+
 2016-10-17  Ryan Haddad  <ryanhaddad@apple.com>
 

trunk/LayoutTests/inspector/debugger/pause-on-assert.html

@@ -9 +9 @@
     InspectorProtocol.sendCommand("Debugger.setBreakpointsActive", {active: true});
     InspectorProtocol.sendCommand("Debugger.setPauseOnExceptions", {state: "all"}, InspectorProtocol.checkForError);
+    InspectorProtocol.sendCommand("Debugger.setPauseOnAssertions", {enabled: true}, InspectorProtocol.checkForError);
 
     var step = null;

trunk/LayoutTests/inspector/debugger/pause-reason.html

@@ -48 +48 @@
 
     WebInspector.debuggerManager.allExceptionsBreakpoint.disabled = false;
+    WebInspector.debuggerManager.assertionsBreakpoint.disabled = false;
 
     WebInspector.debuggerManager.addEventListener(WebInspector.DebuggerManager.Event.ScriptAdded, function(event) {

trunk/Source/JavaScriptCore/ChangeLog

@@ +1 @@
+2016-10-17  Joseph Pecoraro  <pecoraro@apple.com>
+
+        Web Inspector: Add toggles for debugger pauses at console.assert failures
+        https://bugs.webkit.org/show_bug.cgi?id=139542
+        <rdar://problem/19281600>
+
+        Reviewed by Timothy Hatcher.
+
+        * inspector/agents/InspectorDebuggerAgent.h:
+        * inspector/agents/InspectorDebuggerAgent.cpp:
+        (Inspector::InspectorDebuggerAgent::disable):
+        (Inspector::InspectorDebuggerAgent::setPauseOnAssertions):
+        Toggle pause on assertions state. Default is disabled,
+        and disable it when frontends disconnect.
+
+        (Inspector::InspectorDebuggerAgent::handleConsoleAssert):
+        Instead of using the PauseOnAllExceptions state, use this
+        new state specific to assertions.
+
+        * inspector/protocol/Debugger.json:
+        New protocol method to toggle pausing on assertions.
+
 2016-10-17  Yusuke Suzuki  <utatane.tea@gmail.com>
 

trunk/Source/JavaScriptCore/inspector/agents/InspectorDebuggerAgent.cpp

@@ -114 +114 @@
         m_listener->debuggerWasDisabled();
 
+    m_pauseOnAssertionFailures = false;
+
     m_enabled = false;
 }
@@ -194 +196 @@
 void InspectorDebuggerAgent::handleConsoleAssert(const String& message)
 {
-    if (m_scriptDebugServer.pauseOnExceptionsState() != JSC::Debugger::DontPauseOnExceptions)
+    if (m_pauseOnAssertionFailures)
         breakProgram(DebuggerFrontendDispatcher::Reason::Assert, buildAssertPauseReason(message));
 }
@@ -627 +629 @@
     if (m_scriptDebugServer.pauseOnExceptionsState() != pauseState)
         errorString = ASCIILiteral("Internal error. Could not change pause on exceptions state");
+}
+
+void InspectorDebuggerAgent::setPauseOnAssertions(ErrorString&, bool enabled)
+{
+    m_pauseOnAssertionFailures = enabled;
 }
 

trunk/Source/JavaScriptCore/inspector/agents/InspectorDebuggerAgent.h

@@ -78 +78 @@
     void stepOut(ErrorString&) final;
     void setPauseOnExceptions(ErrorString&, const String& pauseState) final;
+    void setPauseOnAssertions(ErrorString&, bool enabled) final;
     void evaluateOnCallFrame(ErrorString&, const String& callFrameId, const String& expression, const String* objectGroup, const bool* includeCommandLineAPI, const bool* doNotPauseOnExceptionsAndMuteConsole, const bool* returnByValue, const bool* generatePreview, const bool* saveResult, RefPtr<Inspector::Protocol::Runtime::RemoteObject>& result, Inspector::Protocol::OptOutput<bool>* wasThrown, Inspector::Protocol::OptOutput<int>* savedResultIndex) final;
     void setOverlayMessage(ErrorString&, const String*) override;
@@ -169 +170 @@
     bool m_hasExceptionValue { false };
     bool m_didPauseStopwatch { false };
+    bool m_pauseOnAssertionFailures { false };
 };
 

trunk/Source/JavaScriptCore/inspector/protocol/Debugger.json

@@ -238 +238 @@
         {
             "name": "setPauseOnExceptions",
+            "description": "Defines pause on exceptions state. Can be set to stop on all exceptions, uncaught exceptions or no exceptions. Initial pause on exceptions state is <code>none</code>.",
             "parameters": [
                 { "name": "state", "type": "string", "enum": ["none", "uncaught", "all"], "description": "Pause on exceptions mode." }
-            ],
-            "description": "Defines pause on exceptions state. Can be set to stop on all exceptions, uncaught exceptions or no exceptions. Initial pause on exceptions state is <code>none</code>."
+            ]
+        },
+        {
+            "name": "setPauseOnAssertions",
+            "description": "Set pause on assertions state. Assertions are console.assert assertions.",
+            "parameters": [
+                { "name": "enabled", "type": "boolean" }
+            ]
         },
         {

trunk/Source/WebInspectorUI/ChangeLog

@@ +1 @@
+2016-10-17  Joseph Pecoraro  <pecoraro@apple.com>
+
+        Web Inspector: Add toggles for debugger pauses at console.assert failures
+        https://bugs.webkit.org/show_bug.cgi?id=139542
+        <rdar://problem/19281600>
+
+        Reviewed by Timothy Hatcher.
+
+        * UserInterface/Controllers/DebuggerManager.js:
+        (WebInspector.DebuggerManager.prototype.get assertionsBreakpoint):
+        (WebInspector.DebuggerManager.prototype.isBreakpointRemovable):
+        (WebInspector.DebuggerManager.prototype._breakpointDisabledStateDidChange):
+        New breakpoint and toggling behavior.
+
+        * Localizations/en.lproj/localizedStrings.js:
+        * UserInterface/Views/DebuggerSidebarPanel.js:
+        (WebInspector.DebuggerSidebarPanel):
+        (WebInspector.DebuggerSidebarPanel.prototype._breakpointTreeOutlineDeleteTreeElement):
+        (WebInspector.DebuggerSidebarPanel.prototype._compareTopLevelTreeElements.isSpecialBreakpoint):
+        (WebInspector.DebuggerSidebarPanel.prototype._compareTopLevelTreeElements):
+        New breakpoint tree element behavior.
+
+        (WebInspector.DebuggerSidebarPanel.prototype.saveStateToCookie):
+        (WebInspector.DebuggerSidebarPanel.prototype.restoreStateFromCookie):
+        Sidebar restoration if it was selected.
+
+        * UserInterface/Images/Assertion.svg: Added.
+        * UserInterface/Images/gtk/Assertion.svg: Added.
+        * UserInterface/Views/BreakpointTreeElement.css:
+        (.breakpoint-assertion-icon .icon):
+        New sidebar icon for the global breakpoint.
+
 2016-10-15  Joseph Pecoraro  <pecoraro@apple.com>
 

trunk/Source/WebInspectorUI/Localizations/en.lproj/localizedStrings.js

@@ -70 +70 @@
 localizedStrings["All Resources"] = "All Resources";
 localizedStrings["All Storage"] = "All Storage";
-localizedStrings["All Uncaught Exceptions"] = "All Uncaught Exceptions";
 localizedStrings["Alternates"] = "Alternates";
 localizedStrings["An error occurred trying to load the resource."] = "An error occurred trying to load the resource.";
@@ -92 +91 @@
 localizedStrings["Assertion Failed"] = "Assertion Failed";
 localizedStrings["Assertion Failed: %s"] = "Assertion Failed: %s";
+localizedStrings["Assertion Failures"] = "Assertion Failures";
 localizedStrings["Assertion with message: %s"] = "Assertion with message: %s";
 localizedStrings["Assertive"] = "Assertive";
@@ -785 +785 @@
 localizedStrings["Type information for variable: %s"] = "Type information for variable: %s";
 localizedStrings["Unable to determine path to property from root"] = "Unable to determine path to property from root";
+localizedStrings["Uncaught Exceptions"] = "Uncaught Exceptions";
 localizedStrings["Unchanged"] = "Unchanged";
 localizedStrings["Uncomment All Properties"] = "Uncomment All Properties";

trunk/Source/WebInspectorUI/UserInterface/Controllers/DebuggerManager.js

@@ -48 +48 @@
         this._allExceptionsBreakpointEnabledSetting = new WebInspector.Setting("break-on-all-exceptions", false);
         this._allUncaughtExceptionsBreakpointEnabledSetting = new WebInspector.Setting("break-on-all-uncaught-exceptions", false);
+        this._assertionsBreakpointEnabledSetting = new WebInspector.Setting("break-on-assertions", false);
 
         let specialBreakpointLocation = new WebInspector.SourceCodeLocation(null, Infinity, Infinity);
@@ -55 +56 @@
 
         this._allUncaughtExceptionsBreakpoint = new WebInspector.Breakpoint(specialBreakpointLocation, !this._allUncaughtExceptionsBreakpointEnabledSetting.value);
+        
+        this._assertionsBreakpoint = new WebInspector.Breakpoint(specialBreakpointLocation, !this._assertionsBreakpointEnabledSetting.value);
+        this._assertionsBreakpoint.resolved = true;
 
         this._breakpoints = [];
@@ -86 +90 @@
         this._updateBreakOnExceptionsState();
 
+        // COMPATIBILITY (iOS 10): DebuggerAgent.setPauseOnAssertions did not exist yet.
+        if (DebuggerAgent.setPauseOnAssertions)
+            DebuggerAgent.setPauseOnAssertions(this._assertionsBreakpointEnabledSetting.value);
+
         this._ignoreBreakpointDisplayLocationDidChangeEvent = false;
 
@@ -145 +153 @@
     {
         return this._allUncaughtExceptionsBreakpoint;
+    }
+
+    get assertionsBreakpoint()
+    {
+        return this._assertionsBreakpoint;
     }
 
@@ -187 +200 @@
     isBreakpointRemovable(breakpoint)
     {
-        return breakpoint !== this._allExceptionsBreakpoint && breakpoint !== this._allUncaughtExceptionsBreakpoint;
+        return breakpoint !== this._allExceptionsBreakpoint
+            && breakpoint !== this._allUncaughtExceptionsBreakpoint
+            && breakpoint !== this._assertionsBreakpoint;
     }
 
@@ -850 +865 @@
         }
 
+        if (breakpoint === this._assertionsBreakpoint) {
+            if (!breakpoint.disabled && !this.breakpointsDisabledTemporarily)
+                this.breakpointsEnabled = true;
+            this._assertionsBreakpointEnabledSetting.value = !breakpoint.disabled;
+            DebuggerAgent.setPauseOnAssertions(this._assertionsBreakpointEnabledSetting.value);
+            return;
+        }
+
         if (breakpoint.disabled)
             this._removeBreakpoint(breakpoint);

trunk/Source/WebInspectorUI/UserInterface/Views/BreakpointTreeElement.css

@@ -51 +51 @@
 }
 
+.breakpoint-assertion-icon .icon {
+    content: url(../Images/Assertion.svg);
+}
+
 .breakpoint-paused-icon .icon {
     content: url(../Images/PausedBreakpoint.svg);

trunk/Source/WebInspectorUI/UserInterface/Views/DebuggerSidebarPanel.js

@@ -108 +108 @@
 
         this._allExceptionsBreakpointTreeElement = new WebInspector.BreakpointTreeElement(WebInspector.debuggerManager.allExceptionsBreakpoint, WebInspector.DebuggerSidebarPanel.ExceptionIconStyleClassName, WebInspector.UIString("All Exceptions"));
-        this._allUncaughtExceptionsBreakpointTreeElement = new WebInspector.BreakpointTreeElement(WebInspector.debuggerManager.allUncaughtExceptionsBreakpoint, WebInspector.DebuggerSidebarPanel.ExceptionIconStyleClassName, WebInspector.UIString("All Uncaught Exceptions"));
-        this.suppressFilteringOnTreeElements([this._allExceptionsBreakpointTreeElement, this._allUncaughtExceptionsBreakpointTreeElement]);
+        this._allUncaughtExceptionsBreakpointTreeElement = new WebInspector.BreakpointTreeElement(WebInspector.debuggerManager.allUncaughtExceptionsBreakpoint, WebInspector.DebuggerSidebarPanel.ExceptionIconStyleClassName, WebInspector.UIString("Uncaught Exceptions"));
+        this._assertionsBreakpointTreeElement = new WebInspector.BreakpointTreeElement(WebInspector.debuggerManager.assertionsBreakpoint, WebInspector.DebuggerSidebarPanel.AssertionIconStyleClassName, WebInspector.UIString("Assertion Failures"));
+
+        this.suppressFilteringOnTreeElements([this._allExceptionsBreakpointTreeElement, this._allUncaughtExceptionsBreakpointTreeElement, this._assertionsBreakpointTreeElement]);
 
         this.filterBar.placeholder = WebInspector.UIString("Filter List");
@@ -151 +153 @@
         this._breakpointsContentTreeOutline.appendChild(this._allUncaughtExceptionsBreakpointTreeElement);
 
+        // COMPATIBILITY (iOS 10): DebuggerAgent.setPauseOnAssertions did not exist yet.
+        if (DebuggerAgent.setPauseOnAssertions)
+            this._breakpointsContentTreeOutline.appendChild(this._assertionsBreakpointTreeElement);
+
         this._scriptsContentTreeOutline = this.createContentTreeOutline(true);
         this._scriptsContentTreeOutline.addEventListener(WebInspector.TreeOutline.Event.SelectionDidChange, this._treeSelectionDidChange, this);
@@ -282 +288 @@
         }
 
+        if (representedObject === WebInspector.debuggerManager.assertionsBreakpoint) {
+            cookie[WebInspector.DebuggerSidebarPanel.SelectedAssertionsCookieKey] = true;
+            return;
+        }
+
         super.saveStateToCookie(cookie);
     }
@@ -294 +305 @@
         else if (cookie[WebInspector.DebuggerSidebarPanel.SelectedAllUncaughtExceptionsCookieKey])
             this._allUncaughtExceptionsBreakpointTreeElement.revealAndSelect();
+        else if (cookie[WebInspector.DebuggerSidebarPanel.SelectedAssertionsCookieKey])
+            this._assertionsBreakpointTreeElement.revealAndSelect();
         else
             super.restoreStateFromCookie(cookie, relaxedMatchDelay);
@@ -692 +705 @@
             return false;
 
-        var wasTopResourceTreeElement = treeElement.previousSibling === this._allUncaughtExceptionsBreakpointTreeElement;
+        var wasTopResourceTreeElement = treeElement.previousSibling === this._assertionsBreakpointTreeElement || treeElement.previousSibling === this._allUncaughtExceptionsBreakpointTreeElement;
         var nextSibling = treeElement.nextSibling;
 
@@ -775 +788 @@
         function isSpecialBreakpoint(treeElement)
         {
-            return treeElement.representedObject === WebInspector.debuggerManager.allExceptionsBreakpoint || treeElement.representedObject === WebInspector.debuggerManager.allUncaughtExceptionsBreakpoint;
+            return treeElement.representedObject === WebInspector.debuggerManager.allExceptionsBreakpoint
+                || treeElement.representedObject === WebInspector.debuggerManager.allUncaughtExceptionsBreakpoint
+                || treeElement.representedObject === WebInspector.debuggerManager.assertionsBreakpoint;
         }
 
@@ -956 +971 @@
 WebInspector.DebuggerSidebarPanel.DebuggerPausedStyleClassName = "paused";
 WebInspector.DebuggerSidebarPanel.ExceptionIconStyleClassName = "breakpoint-exception-icon";
+WebInspector.DebuggerSidebarPanel.AssertionIconStyleClassName = "breakpoint-assertion-icon";
 WebInspector.DebuggerSidebarPanel.PausedBreakpointIconStyleClassName = "breakpoint-paused-icon";
 
 WebInspector.DebuggerSidebarPanel.SelectedAllExceptionsCookieKey = "debugger-sidebar-panel-all-exceptions-breakpoint";
 WebInspector.DebuggerSidebarPanel.SelectedAllUncaughtExceptionsCookieKey = "debugger-sidebar-panel-all-uncaught-exceptions-breakpoint";
+WebInspector.DebuggerSidebarPanel.SelectedAssertionsCookieKey = "debugger-sidebar-panel-assertions-breakpoint";