855928 - Story - Add telemetry probe for whether Firefox is the default browser

Status: VERIFIED FIXED

(Firefox :: General, defect, P1)

Description

[Tim Abraldes [:TimAbraldes] [:tabraldes]]

See bug 828562 comment 3.

We will want to implement this in both desktop Firefox and immersive/Metro Firefox.

Comment 1

[Brian R. Bondy [:bbondy]]

First add a telemetry ID and type of histogram here, example see UPDATER_HAS_PERMISSIONS for a boolean one:
"mozilla-central\toolkit\components\telemetry\Histograms.json"

Telemetry:
> let h = Services.telemetry.getHistogramById("UPDATER_HAS_PERMISSIONS");
> h.add(val);


Here's how you check if we're the default browser:
> shell = Components.classes["@mozilla.org/browser/shell-service;1"].
>         getService(Components.interfaces.nsIShellService);
> shell.isDefaultBrowser(true, false)


  /**
   * Determines whether or not Firefox is the "Default Browser."
   * This is simply whether or not Firefox is registered to handle
   * http links.
   *
   * @param aStartupCheck true if this is the check being performed
   *                      by the first browser window at startup,
   *                      false otherwise.
   * @param aForAllTypes  true if the check should be made for HTTP and HTML.
   *                      false if the check should be made for HTTP only.
   *                      This parameter may be ignored on some platforms.
   */
  boolean isDefaultBrowser(in boolean aStartupCheck,
                           [optional] in boolean aForAllTypes);

Comment 2

[Marco Mucci [:MarcoM]]

Hi Asa, Jim's nomination to elevate Bug 855928 (Add telemetry probe for whether
Firefox is the default browser) to P1 and get it landed on mc.  See this for reference:  https://bugzilla.mozilla.org/show_bug.cgi?id=872712

Comment 3

[Jim Mathies [:jimm]]

Attachment: add default browser probe

Comment 4

[Jim Mathies [:jimm]]

Comment on attachment 754794 [details] [diff] [review]
add default browser probe

It's possible this might show up in startup talos, since we disable this check in prefs for those tests. It will be interesting to see if it does. If so, I think that's ok, since this check is part of our normal startup, and hence should be included in startup perf measurements.

Comment 5

[Jim Mathies [:jimm]]

Comment on attachment 754794 [details] [diff] [review]
add default browser probe

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

::: toolkit/components/telemetry/Histograms.json
@@ +3313,5 @@
>      "description": "The time (in milliseconds) that it took a 'detach' request to go round trip."
> +  },
> +  "BROWSER_IS_USER_DEFAULT": {
> +    "kind": "boolean",
> +    "description": "The result of the startup default destop browser check."

nit - 'desktop' fixed locally

Comment 6

[:Gavin Sharp [email: [e-mail]]]

Comment on attachment 754794 [details] [diff] [review]
add default browser probe

>diff -r ca7f8131a8d4 browser/components/nsBrowserGlue.js

>+      // Get default browser status on startup and report the result to telemetry
>+      // so we can track whether we are the default.
>+      let isDefault = shell.isDefaultBrowser(true, false); // startup check, check all assoc
>+      let telemetry = Cc["@mozilla.org/base/telemetry;1"].getService(Ci.nsITelemetry);
>+      if (telemetry) {

getService never returns null in JS - it either succeeds and returns the service, or throws an exception. So the null check is unnecessary (we also don't need to worry about the telemetry service not existing, AFAIK).

>+        let histogram = telemetry.getHistogramById("BROWSER_IS_USER_DEFAULT");
>+        if (histogram) {

Same thing here - just remove the null check. You can just call getHistogramById().add(), to simplify.

>+      if (shouldCheck && isDefault && !willRecoverSession) {

Looks like you inverted the condition here - should be !isDefault. Was this tested? :)

Comment 7

[Jim Mathies [:jimm]]

Attachment: add default browser probe v.2

Sorry that was sloppy. Tested this time to be sure everything is working.

Comment 8

[:Gavin Sharp [email: [e-mail]]]

Comment on attachment 755900 [details] [diff] [review]
add default browser probe v.2

Actually I also remembered that you can just use Services.telemetry.getHistogramById (Services.jsm is already imported in this file).

r=me with that.

Seems like we should be moving this bug to Firefox::General, though? Or are you also going to patch metro here?

Comment 9

[Brian R. Bondy [:bbondy]]

Metro would simply always return that metro is the default since it can only be used when it is the default.

Comment 10

[Brian R. Bondy [:bbondy]]

* that Metro Fireofx is the default

Comment 11

[Jim Mathies [:jimm]]

http://hg.mozilla.org/integration/mozilla-inbound/rev/7dbcdd81bd1c

Landed, but it might have to bounce due to pushlog problems.

Comment 12

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/mozilla-central/rev/7dbcdd81bd1c

Comment 13

[Mihaela Velimiroviciu (:mihaelav)]

Mozilla/5.0 (Windows NT 6.2; rv:24.0) Gecko/20130610 Firefox/24.0
Mozilla/5.0 (Macintosh; Intel Mac OS X 10.8; rv:24.0) Gecko/20130611 Firefox/24.0
Mozilla/5.0 (X11; Linux i686; rv:24.0) Gecko/20130603 Firefox/24.0

The BROWSER_IS_USER_DEFAULT histogram was added to the about:telemetry page, but only for normal (non-Metro mode) and it only updates after browser restart. Is this expected?

Steps:
1. Make sure Firefox is not default browser
2. Open about:telemetry
3. Check BROWSER_IS_USER_DEFAULT chart under Histograms section -> it should show average = 0, sum = 0
4. Make Firefox default browser and refresh about:telemetry page
-> Actual result: the  BROWSER_IS_USER_DEFAULT chart didn't change the values
5. Restart Firefox and check again the about:telemetry page
-> Actual result: the  BROWSER_IS_USER_DEFAULT chart changed the values: average = 1, sum = 1

Comment 14

[Jim Mathies [:jimm]]

(In reply to Mihaela Velimiroviciu [QA] (:mihaelav) from comment #13)
> Mozilla/5.0 (Windows NT 6.2; rv:24.0) Gecko/20130610 Firefox/24.0
> Mozilla/5.0 (Macintosh; Intel Mac OS X 10.8; rv:24.0) Gecko/20130611
> Firefox/24.0
> Mozilla/5.0 (X11; Linux i686; rv:24.0) Gecko/20130603 Firefox/24.0
> 
> The BROWSER_IS_USER_DEFAULT histogram was added to the about:telemetry page,
> but only for normal (non-Metro mode) and it only updates after browser
> restart. Is this expected?

Yes. Metro can't launch unless it's the default, so there's no point in reporting from that browser, and the default startup check was the most convenient place to collect.

Comment 15

[Mihaela Velimiroviciu (:mihaelav)]

Thank you Jim. Marking verified based on comment #14.

Comment 16

[Jim Mathies [:jimm]]

verified for it8 using about:telemetry.

Comment 17

[Brian R. Bondy [:bbondy]]

Jim can you request to get this uplifted?

We may find for example that only 10% of users on Beta have Beta set as their default and hence there is no value in uplifting early.

Comment 18

[Kamil Jozwiak [:kjozwiak]]

Went through the following "Story" for iteration #9 testing without any issues. Used the following build:

http://ftp.mozilla.org/pub/mozilla.org/firefox/nightly/2013-07-06-03-12-13-mozilla-central/

- Went through the test case that has been added in comment 13 without any issues

Comment 19

[Samvedana (:Samvedana)]

User Agent: Mozilla/5.0 (Windows NT 6.2; WOW64; rv:26.0) Gecko/20100101 Firefox/26.0
Build ID: 20130819030205
Built from http://hg.mozilla.org/mozilla-central/rev/c8c9bd74cc40

WFM
Tested on windows 8 using latest nightly for iteration-12. Followed steps provided in comment13 and got expected result.