828540 - Firefox Health Report provider to record search counts

Status: RESOLVED FIXED

(Firefox Health Report Graveyard :: Client: Desktop, defect)

Description

[Gregory Szorc [:gps]]

There are a set of P2 probes for Firefox Health Report to record search counts.

Essentially, for every search performed, we need to record the origin of the search and the search engine it was made to. We only count searches for search engines where Mozilla has a formal relationship. That list current being {Google, Bing, Yahoo, Amazon.com}. Search to other search engines should be counted under an "other" bucket.

We need to record whether the search was initiated from {search bar, about:home, url bar, context menu}.

Gavin pointed me to bug 587780. If we could hook onto this, it seems it would make the implementation much less hacky.

Comment 1

[Richard Newman [:rnewman]]

Attachment: Greg's WIP. v1

Comment 2

[Gregory Szorc [:gps]]

Attachment: SearchesProvider, v1

Pretty basic.

Note that no buffering API is provided in the provider itself (yet).

Comment 3

[Gregory Szorc [:gps]]

Attachment: SearchesProvider, v2

Comment 4

[Gregory Szorc [:gps]]

Attachment: Part 2: Add getProvider() API, v1

I'm too lazy to create a new bug for this. It will be needed for search call sites to obtain a reference to the provider so they can call recordSearch().

Comment 5

[Gregory Szorc [:gps]]

https://hg.mozilla.org/integration/mozilla-inbound/rev/168ec5716059
https://hg.mozilla.org/integration/mozilla-inbound/rev/e663ebce39a6

Comment 6

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/mozilla-central/rev/168ec5716059
https://hg.mozilla.org/mozilla-central/rev/e663ebce39a6

Comment 7

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

Comment on attachment 713045 [details] [diff] [review]
SearchesProvider, v2

>diff --git a/services/healthreport/providers.jsm b/services/healthreport/providers.jsm

>+  PARTNER_ENGINES: [
>+    "amazon.com",
>+    "bing",
>+    "google",
>+    "yahoo",

It's probably a good idea to put a reference to this hardcoded list in http://mxr.mozilla.org/mozilla-central/source/browser/locales/en-US/searchplugins/list.txt (and vice-versa?).

Comment 8

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

The hardcoded list also doesn't take into account that in other locales the search engine names for engine for which we do have a partnership don't necessarily match those in en-US. But there may no longer be any such cases, so perhaps that doesn't matter in practice anymore.

Comment 9

[Gregory Szorc [:gps]]

(In reply to :Gavin Sharp (use [e-mail] for email) from comment #8)
> The hardcoded list also doesn't take into account that in other locales the
> search engine names for engine for which we do have a partnership don't
> necessarily match those in en-US. But there may no longer be any such cases,
> so perhaps that doesn't matter in practice anymore.

This could be problematic.

We may need to code a locale-independent search engine "id" into the XML files and nsISearchEngine. I'll file a follow-up bug to investigate the impact of non en-US locales on nsISearchEngine.name.