1398734 - Support devtools.panels.elements sidebar.setPage API method

Status: RESOLVED FIXED

(WebExtensions :: Developer Tools, enhancement, P2)

Description

[Luca Greco [:rpl] [:luca] [:lgreco]]

As a follow up to Bug 1341305, which has introduced the devtools.panels.elements.createSidebarPane and an initial subset of the APIs provided by the resolved sidebar API object (sidebar.onShown/onHidden and sidebar.setObject), the goal of this issue is to provide the sidebar.setPage API method, which is used to embed an extension page (similar to the devtools panel) inside the DevTools Inspector sidebar.

Comment 1

[Luca Greco [:rpl] [:luca] [:lgreco]]

Attachment: Bug 1398734 - Implement devtools inspector extension page sidebar container component.

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

Comment 2

[Luca Greco [:rpl] [:luca] [:lgreco]]

Attachment: Bug 1398734 - Support devtools.panels.elements sidebar.setPage API method.

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

Comment 3

[Luca Greco [:rpl] [:luca] [:lgreco]]

Comment on attachment 8906577 [details]
Bug 1398734 - Implement devtools inspector extension page sidebar container component.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/178322/diff/1-2/

Comment 4

[Luca Greco [:rpl] [:luca] [:lgreco]]

Comment on attachment 8906578 [details]
Bug 1398734 - Support devtools.panels.elements sidebar.setPage API method.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/178324/diff/1-2/

Comment 5

[GDE]

nice, tried porting an viewmodel inspector for a js framework and this would complete the task.

Comment 6

[Dan]

Hi,

Given that you have already written the implementation, what's the hold up in getting this implemented?

Thanks,
Dan

Comment 7

[Luca Greco [:rpl] [:luca] [:lgreco]]

I'm sorry for the late response, at the time I've been deferring its submission for review because of other conflicting changes that were happening at the same time.

Right now, it is definitely only blocked on me (I need to rebase the patch first, because it is currently on top of a very old mozilla-central tip, then move it into the review stage).

I'll try to put it back in my queue as soon as I can.

Comment 8

[Dan]

Hi Luca, 

Likewise, sorry for the slow reply...

I would really appreciate you getting this released as I want to migrate an old XPI extension and need a custom sidebar UI.

Thanks in advance,

Dan

Comment 9

[Tom Brunet]

I hate to add a 'me too', but when Firefox flipped to multi-process, we didn't have everything we needed in Firefox, but we were able to port our extension to Chrome. We get prodded regularly on when we'll have a Firefox extension again. Recent FF updates load a lot more of our extension than the first time we tried, but at the moment, we have no UI since this setPage method does not exist to allow us to populate our UI in the sub-panel.

Comment 10

[Luca Greco [:rpl] [:luca] [:lgreco]]

Attachment: Bug 1398734 - Implement devtools inspector extension page sidebar container component. r?gl!

Comment 11

[Luca Greco [:rpl] [:luca] [:lgreco]]

Attachment: Bug 1398734 - Support devtools.panels.elements sidebar.setPage API method. r?mixedpuppy!

Depends on D5420

Comment 12

[Luca Greco [:rpl] [:luca] [:lgreco]]

Attachment: Bug 1398734 - Fix devtools toolbox issues while removing extension sidebar panels. r?jdescottes!

Depends on D5421

Comment 13

[Luca Greco [:rpl] [:luca] [:lgreco]]

Comment on attachment 8906577 [details]
Bug 1398734 - Implement devtools inspector extension page sidebar container component.

Marking as obsolete in favor of the new version of the patch submitted on Phabricator.

Comment 14

[Luca Greco [:rpl] [:luca] [:lgreco]]

Comment on attachment 8906578 [details]
Bug 1398734 - Support devtools.panels.elements sidebar.setPage API method.

Marking as obsolete in favor of the new version of the patch submitted on Phabricator.

Comment 15

[Luca Greco [:rpl] [:luca] [:lgreco]]

This devtools API is also needed by a Mozilla project, FathomFox (https://github.com/mozilla/fathom-fox).

I've added as see also the upstream issue: https://github.com/mozilla/fathom-fox/issues/14

Comment 16

[Gabriel Luong [:gl] (ΦωΦ)]

Comment on attachment 9007757 [details]
Bug 1398734 - Implement devtools inspector extension page sidebar container component. r?gl!

Gabriel [:gl] (ΦωΦ) has approved the revision.

Comment 17

[Julian Descottes [:jdescottes]]

Comment on attachment 9007759 [details]
Bug 1398734 - Fix devtools toolbox issues while removing extension sidebar panels. r?jdescottes!

Julian Descottes [:jdescottes][:julian] has approved the revision.

Comment 18

[Shane Caraveo (:mixedpuppy)]

Comment on attachment 9007758 [details]
Bug 1398734 - Support devtools.panels.elements sidebar.setPage API method. r?mixedpuppy!

Shane Caraveo (:mixedpuppy) has approved the revision.

Comment 19

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/8a41d62efdd4
Implement devtools inspector extension page sidebar container component. r=gl
https://hg.mozilla.org/integration/autoland/rev/7fd8b7194516
Support devtools.panels.elements sidebar.setPage API method. r=mixedpuppy
https://hg.mozilla.org/integration/autoland/rev/337e8c37a0c9
Fix devtools toolbox issues while removing extension sidebar panels. r=jdescottes

Comment 20

[Noemi Erli[:noemi_erli]]

https://hg.mozilla.org/mozilla-central/rev/8a41d62efdd4
https://hg.mozilla.org/mozilla-central/rev/7fd8b7194516
https://hg.mozilla.org/mozilla-central/rev/337e8c37a0c9

Comment 21

[Erik Rose [:erik][:erikrose]]

Thanks, Luca and reviewers! Now we can make the experience of labeling datasets for Fathom much more ergonomic: https://github.com/mozilla/fathom-fox/issues/14.

Comment 22

[Vlad Jiman]

Should manual testing be performed on this bug? if it is required please help by specifying a few steps to correctly validate otherwise set the 'qe-validate-' flag, thanks

Comment 23

[Chris Mills [:cmills]]

Note to docs team:

I've added a note to the Fx 64 rel notes about this change:
https://developer.mozilla.org/en-US/docs/Mozilla/Firefox/Releases/64#Changes_for_add-on_developers

I'm not sure if it is correct; feel free to update it when you do the rest of the docs work, if it is not correct.

Comment 24

[Irene Smith]

I have added setPage to ExtensionSidebarPane and created the documentation page: setPage

The item is already in the release notes, see Comment 23 above.