Bug 174738

Summary: Web Inspector: Refactoring: extract async stack trace logic from InspectorInstrumentation
Product: WebKit Reporter: Matt Baker <mattbaker>
Component: Web InspectorAssignee: Matt Baker <mattbaker>
Status: RESOLVED FIXED    
Severity: Normal CC: bburg, buildbot, cdumez, commit-queue, dbates, esprehn+autocc, inspector-bugzilla-changes, joepeck, kangil.han, keith_miller, mark.lam, msaboff, saam
Priority: P2    
Version: WebKit Nightly Build   
Hardware: All   
OS: All   
Bug Depends on:    
Bug Blocks: 174742, 167084, 174739    
Attachments:
Description Flags
Patch
none
Patch
none
Patch none

Description Matt Baker 2017-07-21 18:24:36 PDT
Notifying the debugger agent of events in the lifecycle of an asynchronous operation should be done by the relevant agent. Currently this is the job of InspectorInstrumenation, which handles timers and rAF. When support is added for XHR.send, postMessage, addEventListener, etc, the layering violation will get worse.

Move the AsynchronousCallType enum to its own file, and other code specific to async stacks to the relevant agent.
Comment 1 Matt Baker 2017-07-21 18:46:23 PDT
Created attachment 316157 [details]
Patch
Comment 2 BJ Burg 2017-07-24 10:21:54 PDT
Comment on attachment 316157 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=316157&action=review

r- unless everyone else disagrees on the enum vs int signature issue. I wasn't paying attention when this code originally landed.

> Source/WebCore/inspector/InspectorAsynchronousCallType.h:28
> +namespace WebCore {

Please, use namespace Inspector unless it's really not possible.

> Source/WebCore/inspector/InspectorAsynchronousCallType.h:31
> +    AnimationFrame = 1,

Nit: RequestAnimationFrame

> Source/WebCore/inspector/InspectorAsynchronousCallType.h:32
> +    Timer,

Nit: can we call this DOMTimer to be consistent with the relevant C++ class?

> Source/WebCore/inspector/InspectorInstrumentation.cpp:349
> +        debuggerAgent->didCancelAsyncCall(static_cast<int>(AsynchronousCallType::Timer), timerId);

Nooo stop it :(

EDIT: I see that we did this to avoid mentioning Web-specific concepts in JSC / Debugger.json. I have no such aversion. This code should be in Inspector namespace anyway. Passing around ints is worse than some optional enum values having no meaning in JavaScriptCore proper.

> Source/WebCore/inspector/PageDebuggerAgent.cpp:160
> +    JSC::ExecState* scriptState = document->execState();

The dereference of document needs a null check, or passed to here by reference.
Comment 3 Joseph Pecoraro 2017-07-24 11:48:02 PDT
Comment on attachment 316157 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=316157&action=review

> Source/WebCore/ChangeLog:3
> +        Web Inspector: Refactoring: remove async stack trace logic from InspectorInstrumentation

I'd prefer "extract" over "remove".
Comment 4 Matt Baker 2017-07-24 18:55:37 PDT
Created attachment 316338 [details]
Patch
Comment 5 BJ Burg 2017-07-25 14:01:30 PDT
Comment on attachment 316338 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=316338&action=review

r=me

> Source/JavaScriptCore/ChangeLog:8
> +        Move AsyncCallType enum to InspectoprDebuggerAgent, which manages async

Nit: InspectorDebuggerAgent
Comment 6 Matt Baker 2017-07-25 14:05:32 PDT
Created attachment 316389 [details]
Patch
Comment 7 WebKit Commit Bot 2017-07-25 14:46:45 PDT
Comment on attachment 316389 [details]
Patch

Clearing flags on attachment: 316389

Committed r219889: <http://trac.webkit.org/changeset/219889>
Comment 8 WebKit Commit Bot 2017-07-25 14:46:47 PDT
All reviewed patches have been landed.  Closing bug.