1644442 - Send current region and attribution source as headers in the tile usage request

Status: VERIFIED FIXED

(Firefox :: New Tab Page, task, P1)

Description

[Mike de Boer [:mikedeboer]]

For the Amazon tile experiment, we need to add the following headers to the background request:

X-Region: ${await Region.getHomeRegion()} and
X-Source: ${"newtab" || "awesomebar"}.

Comment 1

[Dão Gottwald [:dao]]

Attachment: Bug 1644442 - Send current region and attribution source as headers in the tile usage request. r=mikedeboer

Comment 2

[Dão Gottwald [:dao]]

Ben, this adds the source ("newtab" or "urlbar") as extra data to the telemetry event. I assume this needs no full data review, but I added you as a reviewer in phabricator. Is that the right way to go about this?

Comment 3

[Ben Miroglio [:bmiroglio]]

We actually do need a data review here, in the spirit of data transparency. We need to either make this bug public, or conduct that review in a separate, public bug.

Comment 4

[Mike de Boer [:mikedeboer]]

Attachment: Data review source field

Comment 5

[Ben Miroglio [:bmiroglio]]

Comment on attachment 9155719 [details]
Data review source field

# Data Review Form

    Is there or will there be documentation that describes the schema for the ultimate data set in a public, complete, and accurate way?

This will be documented in the [Events.yaml file[(https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/data/event-ping.html). Note this is data specific to an experiment at this moment in time.

    Is there a control mechanism that allows the user to turn the data collection on and off? (Note, for data collection not needed for security purposes, Mozilla provides such a control mechanism) Provide details as to the control mechanism available.

Users can disable this by opt-ing out of Telemetry in the Firefox preferences.

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

This is not permanent

    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

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

default-off, experiment only

    Does the instrumentation include the addition of any new identifiers (whether anonymous or otherwise; e.g., username, random IDs, etc. See the appendix for more details)?

No.

    Is the data collection covered by the existing Firefox privacy notice?

Yes.

    Does there need to be a check-in in the future to determine whether to renew the data? (Yes/No) (If yes, set a todo reminder or file a bug if appropriate)**

No.

    Does the data collection use a third-party collection tool?

No.

data-review: r+

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/bb9c483f02c5
Send current region and attribution source as headers in the tile usage request. r=mikedeboer

Comment 7

[Mike de Boer [:mikedeboer]]

Comment on attachment 9155303 [details]
Bug 1644442 - Send current region and attribution source as headers in the tile usage request. r=mikedeboer

Beta/Release Uplift Approval Request

• User impact if declined: This is important data for our analysis and success of the experiment. We're hoping to uplift this as soon as the patched merged to m-c, so that the Experimenter QA team can take a look and verify.
• Is this code covered by automated tests?: No
• Has the fix been verified in Nightly?: No
• 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): It's not risky, since it's doing two things 1) send two additional headers to our own server. 2) record the source parameter in telemetry, only during the experiment. The experiment will run for four to six weeks, after that everything will be re-evaluated.
• String changes made/needed: n/a

Comment 8

[Bogdan Tara[:bogdan_tara | bogdant]]

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

Comment 9

[Julien Cristau [:jcristau]]

Comment on attachment 9155303 [details]
Bug 1644442 - Send current region and attribution source as headers in the tile usage request. r=mikedeboer

approved for 78.0b6

Comment 10

[Julien Cristau [:jcristau]]

https://hg.mozilla.org/releases/mozilla-beta/rev/182aedad112c

Comment 11

[Marius Coman [:mcoman], Ecosystem QA]

I have verified that the "source": "newtab" attribution source was added to the telemetry pings from the "about:telemetry#events-tab" page.

Verified using the latest Firefox Beta (78.0b9 Build ID - 20200619002543) and the latest Firefox Nightly (79.0a1 Build ID - 20200621093846) installed on Windows 10 x64, Mac 10.15, and Ubuntu 18.04 x64.