1865256 - Collect usage data of `TSFTextStore::InsertTextAtSelectionInternal` with CRLFs

Status: RESOLVED FIXED

(Core :: DOM: UI Events & Focus Handling, enhancement, P2)

Description

[Masayuki Nakano [:masayuki] (he/him)(JST, +0900)(sickish, maybe slower respose)]

Typically, IME should emulate Enter key press instead of inserting CRLFs directly because of "insert paragraph" vs. "insert line break" difference. However, some may still use them (IIRC, it was used by Handwriting mode of MS-IME for Tablet at WinXP era). Therefore, we should collect the usage and the active TIP information which inserted CRLFs.

Comment 1

[Masayuki Nakano [:masayuki] (he/him)(JST, +0900)(sickish, maybe slower respose)]

Attachment: Data review request

Comment 2

[Masayuki Nakano [:masayuki] (he/him)(JST, +0900)(sickish, maybe slower respose)]

Attachment: Bug 1865256 - Add a telemetry probe to collect IME names which inserted CRLFs on Windows r=chutten!,m_kato!

It'll be notify IMEs on Windows of text/selection with only LFs instead of
CRLFs because the conversion cost from LFs to CRLFs is serious for DOM tree
change performance and Chrome also uses only LFs too.

However, we know some old TIPs inserted CRLFs. TIPs should use emulating
Enter key press instead for the issue, "insert paragraph" vs.
"insert line break" in rich text editors, some IMEs may still insert CRLFs
directly. However, nobody knows whether there is such TIPs.

Therefore, let's collect the IME names which inserted CRLFs via TSF directly.

Comment 3

[Chris H-C :chutten]

Comment on attachment 9364081 [details]
Data review request

PRELIMINARY NOTES:

Please confirm that the "IME (TIP) name" is something we are reasonably sure will not contain personal information (like user names on the host (which can be in paths), or other stuff like that). This review's acceptance is conditional on this being true.

Also, in the answer to Q6: YAML in a source tree doesn't meet the criteria for being documentation for the public. Instead, for Legacy Telemetry the probe dictionary serves the function of documenting scalars: https://probes.telemetry.mozilla.org/

DATA COLLECTION REVIEW RESPONSE:

Is there or will there be documentation that describes the schema for the ultimate data set available publicly, complete and accurate?

Yes.

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

Yes. This collection can be controlled through Firefox's Preferences.

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

Yes, Masayuki Nakano is responsible.

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.

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

Default on for all channels.

Does the instrumentation include the addition of any new identifiers?

No.

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

Yes.

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

No.

---

Result: datareview+

Comment 4

[Masayuki Nakano [:masayuki] (he/him)(JST, +0900)(sickish, maybe slower respose)]

(In reply to Chris H-C :chutten|PTO (back November 29) from comment #3)

PRELIMINARY NOTES:

Please confirm that the "IME (TIP) name" is something we are reasonably sure will not contain personal information (like user names on the host (which can be in paths), or other stuff like that). This review's acceptance is conditional on this being true.

Yes, IME name is provided by OS as a product name (could be with version string). In strictly speaking, user may create an IME and use it, but it's not reasonable due to too complicated middle-ware to create it only for themselves. When I checked sometimes to check IME share in our users, I've never seen such users, of course.

Also, in the answer to Q6: YAML in a source tree doesn't meet the criteria for being documentation for the public. Instead, for Legacy Telemetry the probe dictionary serves the function of documenting scalars: https://probes.telemetry.mozilla.org/

Oh, thank you for the information!

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/d7fd417affa6
Add a telemetry probe to collect IME names which inserted CRLFs on Windows r=chutten,m_kato,win-reviewers,mhowell

Comment 6

[Cosmin Sabou [:CosminS]]

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