1806425 - Make value of "source" in Feature Callout and "page" in its telementry more consistent

Status: VERIFIED FIXED

(Firefox :: Messaging System, enhancement, P3)

Description

[Meg Viar [:mviar]]

An explicit call to the showFeatureCallout method on a Callout instance must be added on-train before messages can be delivered on that page. Currently we support Feature Callouts in Firefox View and the PDF reader. In the Feature Callout telemetry, the value of page is reported as about:firefoxview for the former and chrome://browser/content/browser.xhtml for the latter (this is the browser chrome's url). While neither case currently exposes the URL of non-Firefox pages the user visits, we want to ensure that remains the case moving forward. This is especially true if we expand the user of the Feature Callout in the browser chrome. We also want the page values to be meaningful (not currently the case with the one for PDF.js).

The value of page currently comes from the Feature Callout instance's source (see here and here). For page event actions, the value of page in telemetry is currently set to the documents location href (see here). These implementations should be unified to ensure we're reporting a consistent value for a given Callout instance.

We can use a token like "CHROME" for the source/page value when showing a Feature Callout in the browser chrome.

Comment 1

[Meg Viar [:mviar]]

Attachment: Bug 1806425 - Make value of source in Feature Callout and page in its telementry more consistent

Comment 2

[BugBot [:suhaib / :marco/ :calixte]]

There's a r+ patch which didn't land and no activity in this bug for 2 weeks.
:mviar, could you have a look please?
If you still have some work to do, you can add an action "Plan Changes" in Phabricator.
For more information, please visit auto_nag documentation.

Comment 3

[Meg Viar [:mviar]]

I've been OOO for the last two weeks, but just requested landing.

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/00d212a6a60f
Make value of source in Feature Callout and page in its telementry more consistent r=jprickett,aminomancer

Comment 5

[Cristian Tuns]

https://hg.mozilla.org/mozilla-central/rev/00d212a6a60f

Comment 6

[Marius Coman [:mcoman], Ecosystem QA]

I have verified this enhancement using the steps provided here and I can confirm the following:

• the "page" value for spotlights is: "spotlight"
• the "page" value for "Feature Callout for PDF.js" messages is: "chrome"
• the "page" value for "Feature Callout for about:firefoxview" messages is: "about:firefoxview"
• the "page" value for the "about:welcome" page is: "about:welcome".

Verified using the latest Firefox Nightly (111.0a1 Build ID - 20230131093335) installed on Windows 10 x64, macOS 12.6.1, and Ubuntu 22.04 x64.