1794626 - Add telemetry to capture invert colors usage on mac

Status: RESOLVED FIXED

(Core :: Disability Access APIs, task)

Description

[Morgan Reschenberg [:morgan]]

We have some bugs on file that occur only when a user has enabled invert colors. In order to assess how impactful these bugs are, we should gather some data on how many users use invert colors. I think there is a setting for windows as well, but I'm on mac right now so filing a mac specific thing :)

Comment 1

[Morgan Reschenberg [:morgan]]

It was suggested on matrix that we override this method and add this telemetry there.

Comment 2

[Morgan Reschenberg [:morgan]]

Request for data collection review form

1. What questions will you answer with this data?

• Do we have clients running with Invert Colors enabled on macOS?
• What percentage of overall clients are running with this setting enabled on mac?

2. Why does Mozilla need to answer these questions? Are there benefits for users? Do we need this information to address product or business requirements?
   To answer: How should we prioritize bugs filed against Firefox concerning Invert Colors?

3. What alternative methods did you consider to answer these questions? Why were they not sufficient?
   I'm not aware of any existing instrumentation that covers this setting.

4. Can current instrumentation answer these questions?
   No

5. List all proposed measurements and indicate the category of data collection for each measurement, using the Firefox data collection categories found on the Mozilla wiki.

<table>
<tr>
<td>Measurement Description</td>
<td>Data Collection Category</td>
<td>Tracking Bug #</td>
</tr>
<tr>
<td>Boolean logging whether this client had invert colors enabled when the browser was started.</td>
<td>Category 1</td>
<td>this one I guess? not sure 1794626</td>
</tr>
</table>

6. Please provide a link to the documentation for this data collection which describes the ultimate data set in a public, complete, and accurate way.
   This collection is documented in its definitions files Histograms.json, Scalars.yaml, and/or Events.yaml and in the Probe Dictionary at https://probes.telemetry.mozilla.org.

7. How long will this data be collected? Choose one of the following:

• I want to permanently monitor this data. (Morgan Rae Reschenberg)

8. What populations will you measure?
   All release channels on firefox, on Mac. In the future we may expand this probe to windows but that's not in the scope now.

9. If this data collection is default on, what is the opt-out mechanism for users?
   Normal telemetry opt out

10. Please provide a general description of how you will analyze this data.
    Compare num clients with invert colors enabled to num total mac clients. Compare this percentage to percentage of other known a11y audiences (HCM, Increase Contrast, etc.) to determine resourcing.

11. Where do you intend to share the results of your analysis?
    a11y team channel

12. Is there a third-party tool (i.e. not Glean or Telemetry) that you are proposing to use for this data collection? If so:
    No

Comment 3

[Morgan Reschenberg [:morgan]]

Attachment: Bug 1794626: Create invert_colors telemetry probe and maintain its value via LookAndFeel r?eeejay,mstange

Comment 4

[Morgan Reschenberg [:morgan]]

Attachment: request.txt

Comment 5

[Jared Hirsch [:jhirsch] (he/him) (Needinfo please)]

Comment on attachment 9298475 [details]
request.txt

data-review+

---

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, the data collected will be added to the existing Firefox Telemetry documentation.

2. 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.

Yes, users can opt out of this data collection using the existing Firefox telemetry opt-out controls.

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

Yes, [e-mail] will monitor the data.

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

Category 1, technical 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 (whether anonymous or otherwise; e.g., username, random IDs, etc. See the appendix for more details)?

No.

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.

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/28669f5f93e7
Create invert_colors telemetry probe and maintain its value via LookAndFeel r=mstange

Comment 7

[Natalia Csoregi [:nataliaCs]]

Backed out for bustage on nsLookAndFeel.mm

• backout: https://hg.mozilla.org/integration/autoland/rev/ba81f7074b55729612ad290959f321cade75c5db
• push: https://treeherder.mozilla.org/jobs?repo=autoland&group_state=expanded&selectedTaskRun=atPvHeSGSiWbrzxttCQ4hg.0&revision=28669f5f93e7a97d7811c51a92f3dd508e2a0954
• failure log: https://treeherder.mozilla.org/logviewer?job_id=395615000&repo=autoland&lineNumber=204933

[task 2022-11-04T22:55:08.426Z] 22:55:08     INFO -  In file included from Unified_mm_widget_cocoa1.mm:65:
[task 2022-11-04T22:55:08.427Z] 22:55:08    ERROR -  /builds/worker/checkouts/gecko/widget/cocoa/nsLookAndFeel.mm:581:3: error: call to 'ScalarSet' is ambiguous
[task 2022-11-04T22:55:08.427Z] 22:55:08     INFO -    Telemetry::ScalarSet(Telemetry::ScalarID::A11Y_INVERT_COLORS,
[task 2022-11-04T22:55:08.427Z] 22:55:08     INFO -    ^~~~~~~~~~~~~~~~~~~~
[task 2022-11-04T22:55:08.428Z] 22:55:08     INFO -  /builds/worker/workspace/obj-build/dist/include/mozilla/Telemetry.h:457:6: note: candidate function
[task 2022-11-04T22:55:08.428Z] 22:55:08     INFO -  void ScalarSet(mozilla::Telemetry::ScalarID aId, uint32_t aValue);
[task 2022-11-04T22:55:08.428Z] 22:55:08     INFO -       ^
[task 2022-11-04T22:55:08.428Z] 22:55:08     INFO -  /builds/worker/workspace/obj-build/dist/include/mozilla/Telemetry.h:465:6: note: candidate function
[task 2022-11-04T22:55:08.428Z] 22:55:08     INFO -  void ScalarSet(mozilla::Telemetry::ScalarID aId, bool aValue);
[task 2022-11-04T22:55:08.429Z] 22:55:08     INFO -       ^
[task 2022-11-04T22:55:08.429Z] 22:55:08     INFO -  2 warnings and 1 error generated.

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/1bce695e4191
Create invert_colors telemetry probe and maintain its value via LookAndFeel r=mstange

Comment 9

[Sandor Molnar[:smolnar]]

https://hg.mozilla.org/mozilla-central/rev/1bce695e4191