1478273 - When clicked on the side bar pane, it disappears

Status: VERIFIED FIXED

(DevTools :: Inspector, defect, P1)

Description

[Azra Dhalayat]

What did you do?
================
1. Developed an Add-On to create side bar pane  
2. Utilized the Javascript API devtools.Panel
3. Launched in the Add-on

What happened?
==============
The side bar has been created and successfully able to call the user defined function to show the object, When i try to click the element to copy, the entire side bar disappears

What should have happened?
==========================
Ideally the Side bar should still remain to enable copying or selection

Is there anything else we should know?
======================================
Also, the execCommand("copy") is denied in-spite of having the permissions provided in the manifest.json

Comment 1

[Azra Dhalayat]

Attachment: FireFox-61.0.1-SideBarPane-Click-Issue.mp4

Attached is the error that i am facing, here is the snippet..

function onCreated(sidebarPane) {
	browser.devtools.panels.elements.onSelectionChanged.addListener(() => {
		sidebarPane.setExpression("(" + page_getProperties.toString() + ")()", "Xpath");
	});

	sidebarPane.onShown.addListener(() => {
		console.log("~~~~Side Bar Shown~~~~");
	});

	sidebarPane.onHidden.addListener(() => {
		console.log("~~~~~Hidden~~~~~~");
	});
}

browser.devtools.panels.elements.createSidebarPane("Object Capture").then(onCreated);

Comment 2

[Azra Dhalayat]

Facing problem in Firefox 61.0.1

Comment 3

[David Olah]

Hi Azra!

It would help a lot if you could create a reduced test case for this issue.

Meanwhile, I am not that familiar with these kind of issues so I am setting the Devtools::Inspector Component, maybe someone from it can help.

Comment 4

[Azra Dhalayat]

Hi David,

I am unable to understand what reduced test case means in this context. Can you please elaborate.

Thanks,
Azra

Comment 5

[David Olah]

Of course. I meant that I would need an example of an Add-On version (not necessarily the full version, in case it is not ok to share it as it is)  that you developed. Without it, I will not be able to reproduce the issue.

Comment 6

[Azra Dhalayat]

Attachment: Sample-Create-Sidebar.zip

Here is the sample code, I have only included the required part where i am still able to replicate the issue.

Comment 7

[David Olah]

Thank you Azra for the reply!

I managed to reproduce the issue on Windows 10 on Firefox 62.0b12, Firefox 61.0.1 and Nightly 63.0a1 (2018-07-29) with the help of the Add-On.

I am marking the issue as New.

Comment 8

[Azra Dhalayat]

Thanks David! Do let me know if anything required in the analysis or if there is a work around.

Comment 9

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

Hey Mike, can you take a look at this? It is caused by your event telemetry in https://searchfox.org/mozilla-central/source/devtools/client/inspector/toolsidebar.js#338, and will break any addon that is added to the inspector sidebar when selected. 

Error: "The property "newpanel" was added to a telemetry event with the signature devtools.main,sidepanel_changed,inspector,null but it's value "devtools-inspector-sidebar-c082d2be68df4d64a8e70d6ad6659ed0197a435e_temporary-addon-392-0" is longer than the maximum allowed length of 80 characters
CALLER: resource://devtools/client/inspector/toolsidebar.js:338:7"

Comment 10

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

Attachment: Bug 1478273 - When clicked on the side bar pane, it disappears r?gl

Comment 11

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

https://treeherder.mozilla.org/#/jobs?repo=try&revision=ab8966bbccd9f26c9530c615d206902057a7b489

Comment 12

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

Comment on attachment 9001590 [details]
Bug 1478273 - When clicked on the side bar pane, it disappears r?gl

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

Comment 13

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

https://treeherder.mozilla.org/#/jobs?repo=try&revision=efcf7e058a5168035928931536442662a9ee9199

Comment 14

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

https://treeherder.mozilla.org/#/jobs?repo=try&revision=6d2c383c8426b4549bc0481aeaf95e51fae6fc15

Comment 15

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

https://treeherder.mozilla.org/#/jobs?repo=try&revision=c5b8491e115d4f7f79323bd936b2786b35999d22

Comment 16

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/ee51ad97d401
When clicked on the side bar pane, it disappears r=gl

Comment 17

[Cristian Brindusan [:cbrindusan]]

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

Comment 18

[Ryan VanderMeulen [:RyanVM]]

How was this caused by bug 1463083 if 61 is also affected?

Comment 19

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

(In reply to Ryan VanderMeulen [:RyanVM] from comment #18)
> How was this caused by bug 1463083 if 61 is also affected?

No, the bug originates in 62.

Event telemetry limit certain fields to a specified list of strings and also has limits on the number of characters allowed inside property names and values.

Sadly, when a custom panel is registered with devtools the panel id can break these rules and throw an error.

Comment 20

[Ryan VanderMeulen [:RyanVM]]

Is this something we should consider backporting or can it ride the 63 train?

Comment 21

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

I don't think we need to backport.

Comment 22

[Ciprian Georgiu, Desktop QA]

Reproduced this bug using the add-on from comment 6, on an affected Nightly build (2018-07-25).

I can no longer see this issue with latest Beta 63.0b11 (20181001131022) under Windows 10 x64, macOS 10.13 and Ubuntu 16.04 x64.