1754622 - Add a match type property to the quick suggest contextual services pings

Status: VERIFIED FIXED

(Firefox :: Address Bar, task, P1)

Description

[Drew Willcoxon :adw]

We need to add a match type property to the quick suggest impression and click pings. Right now we will use it to distinguish between best matches and non-best matches, but we may have other types in the future. Nan suggested "best-match" and "firefox-suggest" as possible values. I'm not sure the latter is a great name since best matches are Firefox Suggest too, but it's not a big deal.

Notes:

• The pings are implemented here
• We'll need to update browser_quicksuggest_telemetry.js
• Also need to update the telemetry doc

Comment 1

[Nan Jiang [:nanj]]

I will write a PR (for backend) to add this field to the data schema.

Nan suggested "best-match" and "firefox-suggest" as possible values. I'm not sure the latter is a great name since best matches are Firefox Suggest too, but it's not a big deal.

That was just an example, feel free to use anything that makes sense :)

Comment 2

[Nan Jiang [:nanj]]

Looking to add this field to the Firefox Suggest ping schema (to both impressions and clicks), here is the proposal:

"match_type": {
  "type": "string",
  "description": "The match type of the suggestion",
  "enum": ["best-match", "firefox-suggest"]
}

Comment 3

[Rebecca BurWei]

We want the data to reflect the reality that a suggestion can be both a firefox-sugest and a best-match. Nan, does your proposal allow for that?

Comment 4

[Nan Jiang [:nanj]]

We want the data to reflect the reality that a suggestion can be both a firefox-sugest and a best-match. Nan, does your proposal allow for that?

I think so. Being a "best-match" suggestion basically means it's already a "firefox-suggest". Does that make sense?

Comment 5

[GitHub Bugzilla PR Linker]

Attachment: Link to GitHub pull-request: https://github.com/mozilla-services/mozilla-pipeline-schemas/pull/726

Comment 6

[Jeff Klukas [:klukas] (UTC-4)]

Opened change control ticket for this: https://mozilla-hub.atlassian.net/browse/DSRE-551

Do we need data review for this?

Comment 7

[Nan Jiang [:nanj]]

Yep, I think we will do a data review once the client patch & doc are ready.

Comment 8

[Drew Willcoxon :adw]

Attachment: Bug 1754622 - Add a match type property to the quick suggest contextual services pings.

• Add match_type to the impression and click pings
• Clean up the ping code a little while I'm here
• Add a test task
• Improve the test code that checks the pings: Make sure pings don't have extra
  unexpected properties and make the code a little nicer. Update existing tasks
  as necessary
• Update the telemetry doc

Comment 9

[Drew Willcoxon :adw]

Attachment: data-request.md

Data review request for the addition of a new "match_type" field to two custom contextual services pings

Comment 10

[Megan McCorquodale]

Comment on attachment 9265202 [details]
data-request.md

1. Is there or will there be documentation that describes the schema for the ultimate data set in a public, complete, and accurate way?
   Yes, this will be documented in the probe dictionary.

2. Is there a control mechanism that allows the user to turn the data collection on and off?
   Yes, users can opt out of telemetry collection.

3. If the request is for permanent data collection, is there someone who will monitor the data over time?
   Drew Willcoxon will monitor.

4. Using the category system of data types on the Mozilla wiki, what collection type of data do the requested measurements fall under?
   Category 2, interaction data.

5. Is the data collection request for default-on or default-off?
   Default on.

6. Does the instrumentation include the addition of any new identifiers?
   No new identifiers.

7. Is the data collection covered by the existing Firefox privacy notice?
   Yes.

8. Does the data collection use a third-party collection tool?
   No.

---

data-review +

Comment 11

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/45fb883b4e47
Add a match type property to the quick suggest contextual services pings. r=nanj

Comment 12

[Drew Willcoxon :adw]

STR for QA:

1. Enable Firefox Suggest and best match (browser.urlbar.bestMatch.enabled)
2. Set browser.ping-centre.log to enable PingCentre logging
3. Type amazon and verify the Amazon suggestion appears as a usual Suggest suggestion, not a best match
4. Click the suggestion
5. Open the browser console and verify two pings are logged. The important things to verify for each are:
   • First ping:
     • "is_clicked":true appears
     • "match_type":"firefox-suggest" appears
   • Second ping:
     • "is_clicked":true does not appear
     • "match_type":"firefox-suggest" appears
6. Type betty and verify the Betty White Wikipedia best match appears
7. Click the suggestion
8. Verify two more pings are logged. Important things to verify:
   • First ping:
     • "is_clicked":true appears
     • "match_type":"best-match" appears
   • Second ping:
     • "is_clicked":true does not appear
     • "match_type":"best-match" appears

Comment 13

[Marian-Vasile Laza]

https://hg.mozilla.org/mozilla-central/rev/45fb883b4e47

Comment 14

[Carmen Fat [:cfat] - Ecosystem QA]

I have verified this issue on the latest Nightly 99.0a1 (Build ID: 20220304094153) on Windows 10 x64, macOS 10.15.7 and Linux Ubuntu 20.04 x64.

1. In order to verify this issue we have used the STR from comment 12.
2. Two pings are triggered when clicking either a Suggest result or a best match one.
3. The is_clicked : true parameter is displayed only in one ping out of the two ones.
4. The match_type parameter is displayed in both pings as it follows:

• match_type : "firefox-suggest" is displayed for the Suggest suggestions;
• match_type : "best-match" is displayed for the best match suggestions.