1382603 - Fix 7 tests failures on devtools/client/performance due the EventEmitter refactoring

Status: RESOLVED FIXED

(DevTools :: Performance Tools (Profiler/Timeline), enhancement, P2)

Description

[Matteo Ferretti [:zer0] [:matteo]]

Failing tests:

devtools/client/performance/test/browser_perf-button-states.js
devtools/client/performance/test/browser_perf-calltree-js-categories.js
devtools/client/performance/test/browser_perf-calltree-js-columns.js
devtools/client/performance/test/browser_perf-calltree-js-events.js
devtools/client/performance/test/browser_perf-calltree-memory-columns.js
devtools/client/performance/test/browser_perf-console-record-01.js
devtools/client/performance/test/browser_perf-console-record-02.js

The refactoring is currently only on:

https://github.com/zer0/gecko/tree/event-emitter-1381542

We need to address the test failures before land this patch in m-c.

Comment 1

[Matteo Ferretti [:zer0] [:matteo]]

Here the original try build with the failures:

https://treeherder.mozilla.org/#/jobs?repo=try&revision=bba13e27a2371fa8aad68b9b227534b31829cb0d

Those failures are most likely due the breaking change in how the `EventEmitter` emits event.

Previously, the first argument was the type event:

  myEmitter.on("custom-event", (eventType, message) => { ... });

Now the first argument is the message:

  myEmitter.on("custom-event", (message) => { ... });

In the majority of the scenario the `eventType` is ignored by our code, so we should just remove it from the function's signature.

For more details, see: https://github.com/devtools-html/snippets-for-removing-the-sdk/#events

Comment 2

[Nicolas Chevobbe [:nchevobbe]]

Attachment: Bug 1382603 - Remove old-event-emitter usage from performance panel; .

Review commit: https://reviewboard.mozilla.org/r/230152/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/230152/

Comment 3

[Nicolas Chevobbe [:nchevobbe]]

Attachment: Bug 1382603 - Adapt performance panel tests to the new EventEmitter; .

Review commit: https://reviewboard.mozilla.org/r/230154/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/230154/

Comment 4

[Code Review Bot [:reviewbot]]

Comment on attachment 8961378 [details]
Bug 1382603 - Adapt performance panel tests to the new EventEmitter; .

https://reviewboard.mozilla.org/r/230154/#review235800


Code analysis found 3 defects in this patch:
 - 3 defects found by mozlint

You can run this analysis locally with:
 - `./mach lint path/to/file` (JS/Python)


If you see a problem in this automated review, please report it here: http://bit.ly/2y9N9Vx


::: devtools/client/performance/test/browser_perf-console-record-06.js:39
(Diff revision 1)
>    is(getSelectedRecording(panel), recordings[0],
>      "The first console recording should be selected.");
>  
>    // Ensure overview is still rendering.
>    await times(OverviewView, EVENTS.UI_OVERVIEW_RENDERED, 3, {
> -    expectedArgs: { "1": Constants.FRAMERATE_GRAPH_LOW_RES_INTERVAL }
> +    expectedArgs:[Constants.FRAMERATE_GRAPH_LOW_RES_INTERVAL]

Error: Missing space before value for key 'expectedargs'. [eslint: key-spacing]

::: devtools/client/performance/test/browser_perf-loading-02.js:36
(Diff revision 1)
>  
>    is(detailsContainer.selectedPanel, recordingNotice,
>      "The recording-notice is shown while recording.");
>  
>    let recordingStopping = once(PerformanceController, EVENTS.RECORDING_STATE_CHANGE, {
> -    expectedArgs: { "1": "recording-stopping" }
> +    expectedArgs:["recording-stopping"]

Error: Missing space before value for key 'expectedargs'. [eslint: key-spacing]

::: devtools/client/performance/test/browser_perf-loading-02.js:39
(Diff revision 1)
>  
>    let recordingStopping = once(PerformanceController, EVENTS.RECORDING_STATE_CHANGE, {
> -    expectedArgs: { "1": "recording-stopping" }
> +    expectedArgs:["recording-stopping"]
>    });
>    let recordingStopped = once(PerformanceController, EVENTS.RECORDING_STATE_CHANGE, {
> -    expectedArgs: { "1": "recording-stopped" }
> +    expectedArgs:["recording-stopped"]

Error: Missing space before value for key 'expectedargs'. [eslint: key-spacing]

Comment 5

[Nicolas Chevobbe [:nchevobbe]]

Comment on attachment 8961378 [details]
Bug 1382603 - Adapt performance panel tests to the new EventEmitter; .

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/230154/diff/1-2/

Comment 6

[Greg Tatum [:gregtatum] (REO Fx132)]

Comment on attachment 8961377 [details]
Bug 1382603 - Remove old-event-emitter usage from performance panel; .

https://reviewboard.mozilla.org/r/230152/#review236644

All the changes look pretty reasonable here. Thanks for the cleanup!

Comment 7

[Greg Tatum [:gregtatum] (REO Fx132)]

Comment on attachment 8961378 [details]
Bug 1382603 - Adapt performance panel tests to the new EventEmitter; .

https://reviewboard.mozilla.org/r/230154/#review236650

LGTM! Thanks for all the cleanup.

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/e7a33821496d
Remove old-event-emitter usage from performance panel; r=gregtatum.
https://hg.mozilla.org/integration/autoland/rev/f060b453b368
Adapt performance panel tests to the new EventEmitter; r=gregtatum.

Comment 9

[Bogdan Tara[:bogdan_tara | bogdant]]

https://hg.mozilla.org/mozilla-central/rev/e7a33821496d
https://hg.mozilla.org/mozilla-central/rev/f060b453b368