1834842 - Replace hardcoded SERP Telemetry parameters with new config data by integrating with Remote Services helper class

Status: VERIFIED FIXED

(Firefox for Android :: Search, task)

Description

[[:skhan]]

Steps to reproduce ( in order to match with the remote config )

1. Remove the existing validCodeSet https://searchfox.org/mozilla-mobile/rev/7562b185670145d7d36674fbaaf792bfc2ad3c63/firefox-android/android-components/components/feature/search/src/main/java/mozilla/components/feature/search/telemetry/Utils.kt#14-24 , replace codePrefixes with taggedCodes and use exact matching.
2. Add handling of expectedOrganicCodes which will classify some partner codes as purely organic rather than tagged:other.
3. Add organicCodes param to SearchProviderModel, https://searchfox.org/mozilla-mobile/rev/7562b185670145d7d36674fbaaf792bfc2ad3c63/firefox-android/android-components/components/feature/search/src/main/java/mozilla/components/feature/search/telemetry/BaseSearchTelemetry.kt#74-134
4. Add altogether a new SearchProviderModel called Ecosia which desktop added for version 110.0a1 and after.

Comment 1

[BMO Github Automation]

Attachment: [mozilla-mobile/firefox-android] Bug 1834842 - Replace Hardcoded SERP Telemetry (#3104)

Comment 2

[Joe M [:jmahon]]

Per Sarah in the PR description:

As of the task related to this PR, everything is ready to be reviewed but is dependent on the task mentioned before [Bug 1834820] hence not ready to be landed.

Comment 3

[[:skhan]]

Changes needed to be added to focus and fenix both as well since the functions in the Android-components changed slightly.

Comment 4

[BMO Github Automation]

Authored by https://github.com/sarah541
https://github.com/mozilla-mobile/firefox-android/commit/87147d06bbd18c507e52105bbea7073aa6fa42e4
[main] Bug 1834842 - Replace Hardcoded SERP Telemetry

Authored by https://github.com/sarah541
https://github.com/mozilla-mobile/firefox-android/commit/3d6b3372a85d8478ab32e13ccfe0fe59e7f2b261
[main] Bug 1834842 - integrate updated SERP telemetry with Remote Settings Client

Comment 5

[Mira Lobontiu (Android QA)]

Hello!
Sarah, could you please provide us some STR, or some scenarios in order for the QA to verify this ticket.
Thank you!

Comment 6

[Mark Banner (:standard8)]

(In reply to miralobontiu from comment #5)

Hello!
Sarah, could you please provide us some STR, or some scenarios in order for the QA to verify this ticket.
Thank you!

Desktop QA has some test cases for SERP telemetry, that might be able to help with this.

Comment 7

[[:skhan]]

(In reply to miralobontiu from comment #5)

Hello!
Sarah, could you please provide us some STR, or some scenarios in order for the QA to verify this ticket.
Thank you!

Hello! Since this is an old feature (https://github.com/mozilla-mobile/focus-android/issues/4967#issuecomment-893411693) which got some new updates (same as desktop SERP telemetry), we can for use Desktop QA test cases as Mark has mentioned in comment #6.

We have,
InContentTelemetry : Telemetry for knowing of in-web-content searches (including follow-on searches) and the provider used.
For example, if we search something on the urlbar with Google as the search engine, we should record InContentTelemtry specifically IN_CONTENT_SEARCH recorded with the Google as the provider-name and the right type and code
Documentation : https://searchfox.org/mozilla-central/source/browser/components/search/schema/search-telemetry-schema.json#56
Metrics recorded : https://dictionary.telemetry.mozilla.org/apps/fenix/metrics/browser_search_in_content

AdsTelemetry (Telemetry for knowing how often users see/click ads in search and from which provider.)

1. For example, if we search "photo" with DuckDuckGo as the search engine, we should record InContentTelemetry as well as AdsTelemetry because the results contain ads as well, specifically SERP_AD_SHOWN
   Metrics recorded : https://dictionary.telemetry.mozilla.org/apps/fenix/metrics/browser_search_with_ads

2. In case we click the above ad, we should record AdsTelemetry again, specifically SERP_AD_ClICKED
   Metrics recorded : https://dictionary.telemetry.mozilla.org/apps/fenix/metrics/browser_search_ad_clicks

[:standard8], would you able to provide test cases or perhaps a link to the desktop test cases?

Comment 8

[Mira Lobontiu (Android QA)]

Thank you, Sarah!
I already have access to the desktop test cases.

Comment 9

[Mira Lobontiu (Android QA)]

Verified on the latest Fenix Nightly builds from 2/7, and 2/8, with the following: Google Pixel 8 (Android 14), Google Pixel 6 (Android 14), and Oppo Find X3 Lite (Android 11).
Here are my findings:

• on region US, the browser.search.with_ads, bowser.search.in_content, and the browser.search.ad_clicks metrics were successfully generated on all three default search engines: Google, DuckDuckGo, and Bing,
• on DE, the browser.search.with_ads, bowser.search.in_content, and the browser.search.ad_clicks metrics were successfully generated on all three default search engines: Google, DuckDuckGo, and Bing,
• on DE, setting the Ecosia search engine as the default one, dowsn't trigger any of the above mentioned metrics - Glean dashboard - even though the devices was set to German, the browser.search.region from about:config was set to DE, and the VPN was set to Germany. I filed Bug 1879135 for this issue.