1382577 - Fix 8 tests failures on devtools/client/canvasdebugger due the EventEmitter refactoring

Status: RESOLVED FIXED

(DevTools Graveyard :: Canvas Debugger, enhancement, P2)

Description

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

Failing tests:

devtools/client/canvasdebugger/test/browser_canvas-frontend-call-stack-01.js
devtools/client/canvasdebugger/test/browser_canvas-frontend-call-stack-02.js
devtools/client/canvasdebugger/test/browser_canvas-frontend-img-thumbnails-02.js
devtools/client/canvasdebugger/test/browser_canvas-frontend-record-01.js
devtools/client/canvasdebugger/test/browser_canvas-frontend-record-02.js
devtools/client/canvasdebugger/test/browser_canvas-frontend-reload-01.js
devtools/client/canvasdebugger/test/browser_canvas-frontend-reload-02.js
devtools/client/canvasdebugger/test/browser_canvas-frontend-snapshot-select-01.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 event type:

  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 and edge cases, see: https://github.com/devtools-html/snippets-for-removing-the-sdk/#events

Comment 2

[Nicolas Chevobbe [:nchevobbe]]

Attachment: Bug 1382577 - Remove old-event-emitter usage from canvasdebugger; .

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

Comment 3

[Nicolas Chevobbe [:nchevobbe]]

No tests failing after switching to the new event emitter. I guess the test failure were seen when using the new EventEmitter on a global toolbox object (target ?)

Comment 4

[Soledad Penades [:sole] [:spenades]]

Comment on attachment 8955418 [details]
Bug 1382577 - Remove old-event-emitter usage from canvasdebugger; .

https://reviewboard.mozilla.org/r/224602/#review230642

There are some failures on the try run, but I don't think they're related to your patch (I wonder if maybe you should run a more limited set of tests since you're not changing code in Firefox?).

I applied the patch locally and run the canvas debugger tests, which passed. It works nicely as well, as I tried capturing a stack and using it normally and I couldn't see any weirdness.

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/8d70045ab416
Remove old-event-emitter usage from canvasdebugger; r=sole.

Comment 6

[Andreea Pavel [:apavel]]

https://hg.mozilla.org/mozilla-central/rev/8d70045ab416