Bug 188672 – Web Inspector: Provide $event in the console when paused on an event listener

• Status: RESOLVED
• Resolution: FIXED
• Component: Web Inspector

[Devin Rousso]

* SUMMARY
When pausing on events, it's possible that the registered event listener might not have a parameter for the `event` object.

* TEST
    <script>
    document.body.addEventListnener("click", () => {
        debugger;
    });
    </script>

* STEPS TO REPRODUCE
1. Inspect test page
2. Add event breakpoint for "click"
3. Click anywhere within the page to pause
  => should be able to access the `event` value via `$event` even though there was no named parameter for it

[Nikita Vasilyev]

Sounds like a good idea.

    $event = "foo";
    document.body.addEventListnener("click", () => {
        debugger;
    });

`$event` is defined, we should preserve it. E.g. show "foo" and not the click event object.

[Devin Rousso]

Created attachment 347302 [details]
Patch

[Joseph Pecoraro]

Comment on attachment 347302 [details]
Patch

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

> Source/JavaScriptCore/inspector/InjectedScriptSource.js:1396
> +    this.$event = injectedScript._eventValue;

Given that events are a DOM concept, I don't think BasicCommandLineAPI will end up needing it. Since this is primarily for JSContext inspection (though it might make sense with ITMLKit inspection).

> Source/WebCore/inspector/CommandLineAPIModuleSource.js:50
> +    this.$event = injectedScript._eventValue;

I wonder if we can just make this something like:

    this.__defineGetter__("$event", () => inspectedWindow.event);

Is $event ever different from `window.event`? Yes it is possible for the page to have redefined the DOMWindow.prototype.event getter, so this isn't necessarily perfect but I don't think we need to be too concerned.

[Joseph Pecoraro]

(In reply to Nikita Vasilyev from comment #1)
> Sounds like a good idea.
> 
>     $event = "foo";
>     document.body.addEventListnener("click", () => {
>         debugger;
>     });
> 
> `$event` is defined, we should preserve it. E.g. show "foo" and not the
> click event object.

Yes, this should be the normal behavior of the CommandLineAPI. The CommandLineAPI functions (keys, values, $0, $n, $exception, $event, etc) are in the background, so if the page has defined their own thing with an equivalent identifier, the page's thing should win out.

[Devin Rousso]

Comment on attachment 347302 [details]
Patch

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

>> Source/WebCore/inspector/CommandLineAPIModuleSource.js:50
>> +    this.$event = injectedScript._eventValue;
> 
> I wonder if we can just make this something like:
> 
>     this.__defineGetter__("$event", () => inspectedWindow.event);
> 
> Is $event ever different from `window.event`? Yes it is possible for the page to have redefined the DOMWindow.prototype.event getter, so this isn't necessarily perfect but I don't think we need to be too concerned.

I just tried this, and since `window.event` is defined, I'm not even sure that we need this.  Typing just `event` will give you the same result as `$event`.  I think we should hold off on this until we have a better reason for differentiating between `$event` and `event`/`window.event`.

[Devin Rousso]

Comment on attachment 347302 [details]
Patch

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

>>> Source/WebCore/inspector/CommandLineAPIModuleSource.js:50
>>> +    this.$event = injectedScript._eventValue;
>> 
>> I wonder if we can just make this something like:
>> 
>>     this.__defineGetter__("$event", () => inspectedWindow.event);
>> 
>> Is $event ever different from `window.event`? Yes it is possible for the page to have redefined the DOMWindow.prototype.event getter, so this isn't necessarily perfect but I don't think we need to be too concerned.
> 
> I just tried this, and since `window.event` is defined, I'm not even sure that we need this.  Typing just `event` will give you the same result as `$event`.  I think we should hold off on this until we have a better reason for differentiating between `$event` and `event`/`window.event`.

Considering that `window.event` is non-standard, and is more likely to be overridden by the page's JavaScript than `$event`, I think we should consider adding this.

[Devin Rousso]

Created attachment 365110 [details]
Patch

[WebKit Commit Bot]

Comment on attachment 365110 [details]
Patch

Clearing flags on attachment: 365110

Committed r243161: <https://trac.webkit.org/changeset/243161>

[WebKit Commit Bot]

All reviewed patches have been landed.  Closing bug.

[Radar WebKit Bug Importer]

<rdar://problem/49030174>

[Truitt Savell]

The changes in https://trac.webkit.org/changeset/243161/webkit

has broken inspector/timeline/line-column.html

history:
http://webkit-test-results.webkit.org/dashboards/flakiness_dashboard.html#showAllRuns=true&tests=inspector%2Ftimeline%2Fline-column.html

I confirmed the test was working with the fix in 243155 and then broke in 243161 again.

[Devin Rousso]

(In reply to Truitt Savell from comment #11)
> The changes in https://trac.webkit.org/changeset/243161/webkit
> 
> has broken inspector/timeline/line-column.html
> 
> history:
> http://webkit-test-results.webkit.org/dashboards/flakiness_dashboard.
> html#showAllRuns=true&tests=inspector%2Ftimeline%2Fline-column.html
> 
> I confirmed the test was working with the fix in 243155 and then broke in
> 243161 again.
Fixed test in followup <https://trac.webkit.org/changeset/243234/webkit>.