1575542 - Add counter and warnings for deprecated MathML lengths

Status: RESOLVED FIXED

(Core :: MathML, task)

Description

[Frédéric Wang (:fredw)]

Follow-up of bugs 1574750, 1548527, 1548529
These mathml lengths are disabled in nightly but we would need warning / counters for them. We can maybe disable them in beta too? (not sure what's the policy)

Comment 1

[Frédéric Wang (:fredw)]

Attachment: Bug 1575542 - Add counter and warnings for deprecated MathML lengths. r=emilio

This commit introduces new counters and deprecation warnings for the following
MathML features:

• mathspace names (bug 1575542)
• mathsize names (bug 1548527)
• linethickness names (bug 1548529)

Note: helper parsing functions for mfrac and mpadded are changed to non-static
in order to pass the document parameter needed to log warnings to the console
(and while doing that, it is made private for mfrac).

Change manually tested with
<math>
<mspace width="thinmathspace"></mspace>
<mpadded width="2thickmathspace"></mpadded>
<mfrac linethickness="thin"><mn>1</mn><mn>2</mn></mfrac>
<mtext mathsize="big">3</mtext>
</math>

Comment 2

[Frédéric Wang (:fredw)]

Attachment: Bug 1575542 - Add counter and warnings for deprecated MathML lengths. r=emilio

This commit introduces new counters and deprecation warnings for the following
MathML features:

• mathspace names (bug 1575542)
• mathsize names (bug 1548527)
• linethickness names (bug 1548529)

Note: helper parsing functions for mfrac and mpadded are changed to non-static
in order to pass the document parameter needed to log warnings to the console
(and while doing that, it is made private for mfrac).

Change manually tested with
<math>
<mspace width="thinmathspace"></mspace>
<mpadded width="2thickmathspace"></mpadded>
<mfrac linethickness="thin"><mn>1</mn><mn>2</mn></mfrac>
<mtext mathsize="big">3</mtext>
</math>

Comment 3

[Frédéric Wang (:fredw)]

Attachment: data-collection-mathml-keyword-lengths.txt

Comment 4

[Frédéric Wang (:fredw)]

Like in bug 1538985 ( https://phabricator.services.mozilla.com/D24812 ) I expect the release_channel_collection to be "opt-out" in order to make it comparable to the number of documents with MathML content. Do I need to send a patch to toolkit/components/telemetry/Scalars.yaml too?

Comment 5

[Frédéric Wang (:fredw)]

(In reply to Frédéric Wang (:fredw) from comment #4)

Like in bug 1538985 ( https://phabricator.services.mozilla.com/D24812 ) I expect the release_channel_collection to be "opt-out" in order to make it comparable to the number of documents with MathML content. Do I need to send a patch to toolkit/components/telemetry/Scalars.yaml too?

Checking https://searchfox.org/mozilla-central/source/toolkit/components/telemetry/build_scripts/mozparsers/parse_histograms.py#709 I assume I don't. Reply to 6) seems to be "never" and there are actually two counters for each of the three features.

Comment 6

[Frédéric Wang (:fredw)]

@chutten: I'm not really familiar with telemetry, so I'd like to ask a question about "7) What populations will you measure?". IIUC, in bug 1538985 we made the probe "opt-out". What does that mean exactly? I understand the users still need to explicitly check "Allow Firefox to send technical and interaction data to Mozilla" in their privacy preference in order to share the data. And I expect the same for these new probes. Is that correct?

Comment 7

[Chris H-C :chutten|PTO (back Jan 5)]

Unfortunately, due to history, this is all convoluted and none of the words mean what they say. In short:

• "opt-out" means that the metric is being collected in all channels.
• "opt-in" means that the metric is being collected in pre-release channels only.

Use counters (including yours and all new ones) will be "opt-out" so that they can be collected on all channels, you're right.

Comment 8

[Frédéric Wang (:fredw)]

OK, I see thanks!

Comment 9

[Ben Miroglio [:bmiroglio]]

Comment on attachment 9087189 [details]
data-collection-mathml-keyword-lengths.txt

# Data Review Form 

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 in the probe dictionary: https://telemetry.mozilla.org/probe-dictionary/?search=mathml

2) Is there a control mechanism that allows the user to turn the data collection on and off? 

Yes, this can turned off by disabling Telemetry in the Firefox preferences.

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

This is not permanent, there is the potential for renewing. I suggest we set this to expire in Firefox 74 (currently Nightly is 70), and revisit the probe once Nightly hits 73 in case we do want to renew it.

4) Using the **[category system of data types](https://wiki.mozilla.org/Firefox/Data_Collection)** 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 there need to be a check-in in the future to determine whether to renew the data?

Yes, revisit when Nightly hits 73.

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

No

data-review r+

Comment 10

[Frédéric Wang (:fredw)]

Thanks for the review!

Comment 11

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/bafc32833308
Add counter and warnings for deprecated MathML lengths. r=emilio

Comment 12

[Natalia Csoregi [:nataliaCs]]

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

Comment 13

[Kohei Yoshino [:kohei]]

Posted site compatibility note: https://www.fxsitecompat.dev/en-CA/docs/2019/various-legacy-mathml-features-have-been-deprecated-or-removed/