1869171 - alarms.create is not declared as an async function

Status: RESOLVED FIXED

(WebExtensions :: General, defect, P3)

Description

[Rob Wu [:robwu]]

The alarms.create method is not declared as an async function. Consequently, it is not possible for extension callers to await the registration of an alarm.

Moreover, it is not possible to raise async errors. The current implementation doesn't raise such errors, but there is precedent in other browsers to do so, e.g. in Chrome creating 500+ timers results in an error (e.g. seen at https://github.com/w3c/webextensions/issues/422 and tracked at bug 1844605).

This mistake was likely inherit from when the alarms API definition was imported from Chromium. This issue (lack of async callback) was fixed in Chrome 111 by https://chromium.googlesource.com/chromium/src/+/cf0de9610438fb89556cc6a4f9405bfb20cc42ee

Comment 1

[Rob Wu [:robwu]]

The fix would be simple: add "async": "callback" + append an optional function parameter, to https://searchfox.org/mozilla-central/rev/cb8fc16f6b1455d1237853dbad21c62870eaaba9/toolkit/components/extensions/schemas/alarms.json#32-35,64

Comment 2

[arunavdutta27]

Hey, I would lke to work on this issue and solve it. Kindly can i be assigned for this work as this will be my first PR

Comment 3

[Rob Wu [:robwu]]

(In reply to arunavdutta27 from comment #2)

Hey, I would lke to work on this issue and solve it. Kindly can i be assigned for this work as this will be my first PR

The bug will automatically assigned when a patch is submitted to Phabricator. Since this is your first contribution, check out the tutorial at https://wiki.mozilla.org/WebExtensions/Contribution_Onramp

Comment 4

[erosman [:erosman]]

Attachment: Bug 1869171 - Declare alarms.create as an async function

Comment 5

[erosman [:erosman]]

Attachment: Bug 1869171 - Declare alarms.create as an async function

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/cff7f1d25b36
Declare alarms.create as an async function r=robwu,webidl,emilio

Comment 7

[Cosmin Sabou [:CosminS]]

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

Comment 8

[rbloor]

Documentation updates in Bug-1869171 alarms.create now async function #38834