1091260 - Browser Toolbox OSX dock item should have a different name and maybe icon

Status: RESOLVED FIXED

(DevTools :: Framework, defect)

Description

[Brian Grinstead [:bgrins]]

When the Browser Toolbox is opened it gets added to the dock with the same name and icon as the process it's debugging, so it's a bit hard to tell the difference from a glance.

It'd be cool if there was a little badge around the icon and if the title was 'Browser Toolbox - brandShortName' or similar.

Or it could follow Linux/Windows where the window seems grouped with the main process and is titled as - "Debugger - chrome://browser/content/browser.xul".

Comment 1

[Matthew N. [:MattN]]

Attachment: v.1 Use nsIMacDockSupport.badgeText

Here is a quick hack to solve the problem. I realize it may not be ideal but since this is only for users of the Browser Toolbox, I think this is good enough for a first step. We can have a follow-up to use [NSApp setApplicationIconImage:] in the future if we want.

https://developer.apple.com/library/mac/documentation/Carbon/Conceptual/customizing_docktile/docktasks_cocoa/docktasks_cocoa.html#//apple_ref/doc/uid/TP30000986-CH3-SW2

Comment 2

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

Comment on attachment 8514557 [details] [diff] [review]
v.1 Use nsIMacDockSupport.badgeText

Review of attachment 8514557 [details] [diff] [review]:
-----------------------------------------------------------------

Clever idea, that does distinguish the icon...  Though mostly just because of the red bubble that the icon is inside, as I can barely tell what the icon is here.  (I am on 10.9, maybe it looks different in 10.10.)

The code seems fine to me.  I don't really feel strongly about the approach taken here.  If Brian likes this solution, then it seems fine to me!

Comment 3

[Brian Grinstead [:bgrins]]

(In reply to J. Ryan Stinnett [:jryans] (on PTO Oct. 31) from comment #2)
> Comment on attachment 8514557 [details] [diff] [review]
> v.1 Use nsIMacDockSupport.badgeText
> 
> Review of attachment 8514557 [details] [diff] [review]:
> -----------------------------------------------------------------
> 
> Clever idea, that does distinguish the icon...  Though mostly just because
> of the red bubble that the icon is inside, as I can barely tell what the
> icon is here.  (I am on 10.9, maybe it looks different in 10.10.)
> 
> The code seems fine to me.  I don't really feel strongly about the approach
> taken here.  If Brian likes this solution, then it seems fine to me!

Do you know if there is a particular reason why the BT shows up as a separate dock icon on OSX but remains grouped with the main process in windows/linux task bars?  Is that just how these things work, or is there specific code causing it to be so?

Comment 4

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

(In reply to Brian Grinstead [:bgrins] from comment #3)
> Do you know if there is a particular reason why the BT shows up as a
> separate dock icon on OSX but remains grouped with the main process in
> windows/linux task bars?  Is that just how these things work, or is there
> specific code causing it to be so?

I am not aware of any Firefox code specifically trying to keep it separate.

My guess was that Linux / Windows are grouping by process name, while OS X chooses to present as two icons since they are separate apps, but I don't know for sure.

Matt, do you know how this works?

Comment 5

[Matthew N. [:MattN]]

I had the same assumption. Sometimes it can also matter what the process tree looks like. It could work on other OSs since the new Firefox process is launched as a child of the original.

I quickly looked for APIs to tell OS X to treat them as one dock icon but I didn't see answers for that.

Comment 6

[Brian Grinstead [:bgrins]]

Comment on attachment 8514557 [details] [diff] [review]
v.1 Use nsIMacDockSupport.badgeText

Review of attachment 8514557 [details] [diff] [review]:
-----------------------------------------------------------------

I love the idea and the fact that it's 2 lines of code.  My only concern is that the badge may be confusing and look like the window is asking for attention since it's usually used for notifications.  And the icon isn't very readable - I think it's because of that ugly red gradient background.  However, the browser toolbox is used by a pretty small group of people who will let us know if that's a problem.

Regarding the icon readability, I've tried a variety of other unicode 'tool' symbols and nothing is really easy to read.  Using text like "Tools" looks better, but then we have localization issues.  The only other things I thought of is ">>" sort of like the webconsole input symbol, or ▶ like the debugger play button.

Screenshot with the hammer: https://www.dropbox.com/s/h3f7qa30jtfj27p/Screenshot%202014-11-01%2008.15.06.png?dl=0
Screenshot with >>: https://www.dropbox.com/s/yrstk4auum2porf/Screenshot%202014-11-01%2008.32.15.png?dl=0
Screenshot with ▶: https://www.dropbox.com/s/tmdxe86p0jh7wtt/Screenshot%202014-11-02%2009.24.41.png?dl=0

I like ▶ personally just because it's so much easier to see.  Matt / Ryan, any preference?  My instinct is let's land it like that and send something out to the mailing list.  If we come up with some better way in the future we can change it then.  From what I understand actually swapping the icon would be possible, but a lot more work.

Comment 7

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

Yeah, ▶ looks the best of the 3 options there.

I agree it seems fine to try this for now, and tweak down the road.

Comment 8

[Matthew N. [:MattN]]

Attachment: MozReview Request: bz://1091260/MattN

Comment 9

[Matthew N. [:MattN]]

/r/167 - Bug 1091260 - Badge the Browser Toolbox dock icon on OS X to differentiate it from the main process. r=jryans,fitzgen

Pull down this commit:

hg pull review -r 3ea5114858053c862564a1efea2004406e0863d9

Comment 10

[Matthew N. [:MattN]]

Comment on attachment 8514557 [details] [diff] [review]
v.1 Use nsIMacDockSupport.badgeText

After further discussion with bgrinstead, I decided to implement both the paused and play states since I thought that always showing the play icon could be confusing.

Comment 11

[Tomasz Kołodziejski [:tomasz]]

Attachment: yosemite.png

Demo in mac yosemite.

Comment 12

[Matthew N. [:MattN]]

https://hg.mozilla.org/integration/fx-team/rev/ec34b5a1552c

Comment 13

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

Backed out in https://hg.mozilla.org/integration/fx-team/rev/8047f8b92715 for bc1 orange on at least linux and windows: https://treeherder.mozilla.org/ui/logviewer.html#?job_id=1094650&repo=fx-team

Comment 14

[Matthew N. [:MattN]]

/r/167 - Bug 1091260 - Badge the Browser Toolbox dock icon on OS X to differentiate it from the main process. r=jryans,fitzgen

Pull down this commit:

hg pull review -r 0d40e4e830e38bbcc8753945efc0c2098c06af9b

Comment 15

[Matthew N. [:MattN]]

/r/167 - Bug 1091260 - Badge the Browser Toolbox dock icon on OS X to differentiate it from the main process. r=jryans,fitzgen

Pull down this commit:

hg pull review -r 0d40e4e830e38bbcc8753945efc0c2098c06af9b

Comment 16

[Matthew N. [:MattN]]

/r/167 - Bug 1091260 - Badge the Browser Toolbox dock icon on OS X to differentiate it from the main process. r=jryans,fitzgen

Pull down this commit:

hg pull review -r 0d40e4e830e38bbcc8753945efc0c2098c06af9b

Comment 17

[Matthew N. [:MattN]]

Flagging jwalker for the browser/devtools/framework/moz.build change to fix comment 13.

Comment 18

[Matthew N. [:MattN]]

/r/167 - Bug 1091260 - Badge the Browser Toolbox dock icon on OS X to differentiate it from the main process. r=jryans,fitzgen

Pull down this commit:

hg pull review -r e3d0574ddb29fc288fbe9848fd69c02459c73299

Comment 19

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

https://reviewboard.mozilla.org/r/165/#review83

Ship It!

Comment 20

[Matthew N. [:MattN]]

https://hg.mozilla.org/integration/fx-team/rev/ff1606d46388

Comment 21

[Carsten Book [:Tomcat]]

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

Comment 23

[Matthew N. [:MattN]]

Attachment: MozReview Request: Bug 1091260 - Badge the Browser Toolbox dock icon on OS X to differentiate it from the main process. r=jryans,fitzgen