1689365 - Create new telemetry ping for QuickSuggest

Status: VERIFIED FIXED

(Firefox :: Address Bar, task, P1)

Description

[Rachel Tublitz [:rachel]]

Description

Part of some of the upcoming QuickSuggest changes.

Some outstanding TODOs here:

1. Agree on schema.
2. Determine if we need/want a client id (or can use some other identifier).

Timeline

We are targeting FX 87 for all of this work(QS Phase1), so this piece needs to land fairly quickly if possible.

Comment 2

[Nan Jiang [:nanj]]

We'd like to collect the following pings for QuickSuggest.

• Impressions - This ping is only sent on the following conditions

  • A user completes the search session in the URL bar, i.e. he or she navigates away from the search bar
  • A QuickSuggest link was shown in the URL bar at the end of the search session. This means that any QuickSuggest link(s) that was displayed while the user was still typing would not trigger this impression ping. The impression ping would only count the last QuickSuggest link if any when the search input finishes

• Clicks - This ping is sent when the user clicks on the QuickSuggest link

The detailed data schema is still under review, will update this once that gets finalized.

Comment 3

[Drew Willcoxon :adw]

Reverting the summary -- thanks for explaining today Nan, and sorry for hijacking this! I'll file another bug for the keyed-scalar telemetry specifically.

Comment 4

[Nan Jiang [:nanj]]

[Tracking Requested - why for this release]:

We need this telemetry for the feature experiment in 87.

Comment 5

[Nan Jiang [:nanj]]

Attachment: Bug 1689365 - Add custom impression and click for QuickSuggest

Comment 6

[Nan Jiang [:nanj]]

STR for QA:

• Toggle browser.urlbar.quicksuggest.enabled to enable QS
• Toggle browser.ping-centre.log to enable PingCentre logging
• Install RemoteSettings Devtools
• Use RS devtools to switch to the "Stage" environment, clear the local data, and then force sync
• Open a newtab and focus on Urlbar
• Type in "sam" in Urlbar. Click on any result in Urlbar should trigger the impression for QS; Click on the QS should trigger both the impression and the click for that QS
• The ping(s) should be logged in the "browser console"

Test points:

Impression

Send Case

The impression will be sent when all of the following conditions hold:

• The user needs to pick a result (mouse click or enter key) from the Urlbar
• There must be one QuickSuggest link shown when the user picks the result (what link he or she picks doesn't matter)

You should be able to see the impression ping in the browser console as follows:

TELEMETRY PING (contextual-services): {"experiments":{},"locale":"en-US","version":"88.0a1","release_channel":"default","search_query":"sam","matched_keywords":"sam","advertiser":"samsung","block_id":31,"position":10,"reporting_url":"null","is_clicked":true,"context_id":"{19aff7f0-2caa-984b-a62a-19109a083fdd}"}

Notes:

• The search_query could be different depends on your input
• The context_id will be different
• The reporting_url is now set as "null" on stage

Shold Not Send Case

Make sure we don't send the impression for those QuickSuggest links displayed during the typing, we only send the impression as described in the above section

Click

The click ping is sent when you click on the QuickSuggest link. You should be able to see the click ping in the browser console as follows:

TELEMETRY PING (contextual-services): {"experiments":{},"locale":"en-US","version":"88.0a1","release_channel":"default","advertiser":"samsung","block_id":31,"position":10,"reporting_url":"https://mozillacla.ampxdirect.com/samsung?sub1=samsung&sub2=us&custom-data=31&ctag=318361105US312021022510","context_id":"{19aff7f0-2caa-984b-a62a-19109a083fdd}"}

Comment 7

[Nan Jiang [:nanj]]

For the record, the data review for this collection is done in bug 1694693

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/b29eedd7bbe7
Add custom impression and click for QuickSuggest r=adw,daleharvey

Comment 9

[Bogdan Tara[:bogdan_tara | bogdant]]

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

Comment 10

[Cosmin Muntean [:cmuntean], Ecosystem QA]

I have verified this bug on the latest Nightly 88.0a1 build (Build ID: 20210226094123) on Windows 10 x64, macOS 10.15.7 and Ubuntu 20.04. In order to verify this issue, I have used the testing instructions provided in comment 6.

• The "impressions" and "click" pings are correctly registered in the browser console.

Comment 11

[Nan Jiang [:nanj]]

Comment on attachment 9205454 [details]
Bug 1689365 - Add custom impression and click for QuickSuggest

Beta/Release Uplift Approval Request

• User impact if declined: We need this for the Contextual Services/QuickSuggest experiment in 87.
• Is this code covered by automated tests?: Yes
• Has the fix been verified in Nightly?: Yes
• Needs manual test from QE?: No
• If yes, steps to reproduce:
• List of other uplifts needed: None
• Risk to taking this patch: Low
• Why is the change risky/not risky? (and alternatives if risky): This is a telemetry patch, doesn't change the user-facing code.
• String changes made/needed: None

Comment 12

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/releases/mozilla-beta/rev/0e7b4b9834f4

Comment 13

[Ryan VanderMeulen [:RyanVM]]

Comment on attachment 9205454 [details]
Bug 1689365 - Add custom impression and click for QuickSuggest

Approved for 87.0b4.

Comment 14

[Cosmin Muntean [:cmuntean], Ecosystem QA]

I have verified this bug on the latest Nightly 87.0b4 build (Build ID: 20210228185859) on Windows 10 x64, macOS 10.15.7 and Linux Mint 20 x64. In order to verify this issue, I have used the testing instructions provided in comment 6.

• The "impressions" and "click" pings are correctly registered in the browser console.