1637689 - enableAppmenuButton test fails

Status: RESOLVED FIXED

(Firefox :: Messaging System, defect)

Description

[Scott [:thecount] Downe]

Pretty sure there is a race condition in the tests for enableAppmenuButton.

It does these calls in "should registerCallback on enableAppmenuButton() if there are messages"

      await instance.init(waitForInitializedStub, {
        getMessages: sandbox.stub().resolves([{}, {}]),
      });
      // init calls `enableAppmenuButton`
      everyWindowStub.registerCallback.resetHistory();

      await instance.enableAppmenuButton();

      assert.calledOnce(everyWindowStub.registerCallback);

In init, it's calling enableAppmenuButton, then it resets it, then calls it directly. Expecting it to only be called once.

However, the enableAppmenuButton call in init isn't await, and probably should be.

What I think that means is the call to enableAppmenuButton in init can finish after resetHistory, causing the test to fail with two calls.

I think.

If I add await to the call in init, the test fails go away.

I can make a patch.

Comment 1

[Scott [:thecount] Downe]

Attachment: Bug 1637689 - Await for enableAppmenuButton in init in ToolbarPanelHub.jsm

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/ff83ad726427
Await for enableAppmenuButton in init in ToolbarPanelHub.jsm r=emcminn

Comment 3

[Narcis Beleuzu [:NarcisB]]

https://hg.mozilla.org/mozilla-central/rev/ff83ad726427