1453355 - add sidebar.toggle api

Status: RESOLVED FIXED

(WebExtensions :: Frontend, enhancement, P3)

Description

[Shane Caraveo (:mixedpuppy)]

sidebar.isOpen is asynchronous and makes it difficult for an extension to create a toggle function.  We should just add toggle to the api.

Comment 1

[Mike Conca [:mconca]]

I fully support this feature request.  Bumping it to P3 so that we can prioritize it into the team backlog.

Comment 2

[ariasuni]

Any news on this? I managed to make this working flawlessly in Tab Center Reborn, but I had to make my sidebar scripts connect to my background script with browser.runtime.connect() in order to be able to do that. That’s way to hard and convoluted for something that should be easy to do and takes time away from developing the main features of the extension.

Comment 3

[ariasuni]

Attachment: Bug 1453355 - Add sidebarAction.toggle() to WebExtensions API

Comment 4

[BugBot [:suhaib / :marco/ :calixte]]

There's a r+ patch which didn't land and no activity in this bug for 2 weeks.
:perso, could you have a look please?
For more information, please visit auto_nag documentation.

Comment 5

[ariasuni]

I’m not sure why the bot is mentioning me since I didn’t get asked to change anything in my patch after my last revision.

Comment 6

[Oriol Brufau [:Oriol]]

If you want to land your patch, I think the current way to request it is in https://phabricator.services.mozilla.com/D54005 you choose "Change Project Tags" and write "Check-in Needed".

Comment 7

[ariasuni]

OK, I’m not sure how I should’ve known, since I didn’t need to do that the other times, but it’s done.

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/25027937890b
Add sidebarAction.toggle() to WebExtensions API r=mixedpuppy

Comment 9

[Narcis Beleuzu [:NarcisB]]

https://hg.mozilla.org/mozilla-central/rev/25027937890b

Comment 10

[Alex Cornestean]

Hello,

Will this fix require manual validation? If yes, please provide some steps to reproduce in order to correctly test it and also, please set the "qe-verify+" flag. Otherwise, could the "qe-verify-" flag be added? Thanks!

Comment 11

[ariasuni]

Well it’s covered by unit tests, and I just checked that it worked for real with the latest nightly and a slightly modified version of one of my extensions. I can provide a sample extension if necessary.

Comment 12

[Alex Cornestean]

Hello,

If you consider that the unit tests are sufficient to cover the fix, then there is no need. In this case, could you please set the “qe-verify-” flag?

If you would like to also have manual testing coverage, then I’ll gladly do it, in which case, please attach the test extension and provide some STR.

Thanks!

Comment 13

[Richard Bloor]

Compatibility data changes have been submitted (Add toggle to the sidebarAction API), function added to the sidebarAction API page and sidebarAction.toggle() page created, and details added to the release notes. Please let me know if any changes are needed or anything is missing.

Comment 14

[Shane Caraveo (:mixedpuppy)]

Thanks. Why does the link on the sidebarAction page say the docs not writting yet? https://wiki.developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/sidebarAction

Comment 15

[Richard Bloor]

As I understand it the backend system will eventually catch up and correct this. You will also notice that is missing from the sidebar menu, similarly, that will be automatically added later.

Comment 16

[Chris Mills [:cmills]]

API documented:

https://wiki.developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/sidebarAction/toggle

compat data also submitted:

https://github.com/mdn/browser-compat-data/pull/5474

So I'm setting this one to DDC.

Comment 17

[ariasuni]

I (In reply to Alex Cornestean from comment #12)

Hello,

If you consider that the unit tests are sufficient to cover the fix, then there is no need. In this case, could you please set the “qe-verify-” flag?

If you would like to also have manual testing coverage, then I’ll gladly do it, in which case, please attach the test extension and provide some STR.

Thanks!

Sorry I forgot about it; I can’t set the “qe-verify” flag. But maybe everything that needed to be done has been, now?

Comment 18

[ariasuni]

I’m not sure how it works, but another contribution of mine was listed on Add-ons/Contribute/Recognition. Maybe this one could be added to the December 2019 section that looks quite empty right now.