1747348 - compose.sendMessage(tabId) fails when `options` is omitted

Status: RESOLVED FIXED

(Thunderbird :: Add-Ons: Extensions API, defect)

Description

[siefkenj]

User Agent: Mozilla/5.0 (X11; Linux x86_64; rv:95.0) Gecko/20100101 Firefox/95.0

Steps to reproduce:

In an extension with compose.send permissions, call await browser.compose.sendMessage(tabId) omitting the "optional" options argument.

Actual results:

The call fails with

Error: An unexpected error occurred
    apply self-hosted:2736
    applySafeWithoutClone resource://gre/modules/ExtensionCommon.jsm:626
    wrapPromise resource://gre/modules/ExtensionCommon.jsm:901

Expected results:

options is indicated as an optional parameter in the documentation here: https://webextension-api.thunderbird.net/en/91/compose.html
Calling browser.compose.sendMessage(tabId) should be the same as browser.compose.sendMessage(tabId, {mode: "default"}).

Comment 1

[John Bieling (:TbSync)]

Attachment: Bug 1747348 - Fix compose.sendMessage() failing, if options are not provided. r=mkmelin

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/comm-central/rev/0ef7910e76e2
Fix compose.sendMessage() failing, if options are not provided. r=mkmelin

Comment 3

[John Bieling (:TbSync)]

Comment on attachment 9256687 [details]
Bug 1747348 - Fix compose.sendMessage() failing, if options are not provided. r=mkmelin

[Approval Request Comment]
Regression caused by (bug #):
User impact if declined:
API does not behave as described in the documentation

Testing completed (on c-c, etc.):
Landed 14 days ago on daily/beta

Risk to taking this patch (and alternatives if risky):
I do not see any, but it could cause test failures, if I missed something. The actual code change is minimal.

Comment 4

[Wayne Mery (:wsmwk)]

Comment on attachment 9256687 [details]
Bug 1747348 - Fix compose.sendMessage() failing, if options are not provided. r=mkmelin

[Triage Comment]
Approved for esr91

Comment 5

[Rob Lemley [:rjl]]

Thunderbird 91.6.0:
https://hg.mozilla.org/releases/comm-esr91/rev/4fcb88a1b4a5