1914480 - Telemetry adjustments for add image flow in PDFs

Status: VERIFIED FIXED

(Firefox :: PDF Viewer, defect, P1)

Description

[Vanessa Sabino]

We need to review some of the keys that are being passed in telemetry related to the PDF add image flow.

• Event image_added:
  • the descriptions look reversed in the documentation
  • I'm not seeing alt_text_type in the data collected
  • the number of image added events for a client/day is sometimes higher than icon clicks, which needs to be investigated
• Metric alt_text_edit:
  • I'm not seeing ask_to_edit in the data collected.

Comment 1

[Calixte Denizet (:calixte)]

About having a number of image added events higher than icon clicks: it's possible to add an image in copying and pasting it.

Comment 2

[BMO Github Automation]

Attachment: [mozilla/pdf.js] [Editor] Add a missing parameter in the telemetry for the new alt text flow (bug 1914480) (#18650)

Comment 3

[Calixte Denizet (:calixte)]

Attachment: Bug 1914480 - Telemetry adjustments for add image flow in PDFs r=marco

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/b410ec24c6ae
Telemetry adjustments for add image flow in PDFs r=marco

Comment 5

[Vanessa Sabino]

I just realized that when you click the image icon the "+ Add image" dropdown stays on the screen even after the image is added, so I think that's the main reason for the lower number of icon clicks when people are adding multiple images.

Comment 6

[Vanessa Sabino]

A couple other events that seem to be firing inconsistently:

• pdfjs.image.alt_text.image_status_label_displayed: I'm seeing the event twice between clicking add image and image added, but if I click on the image later I don't see the event. I'd expect it to show only at the end of the image add flow and when the user clicks on image afterwards.
• pdfjs.image.alt_text.model_result: this is not firing every time the model runs. I saw it once but I'm not even sure what it was attached to.

And do we have any events for when the user enables or disables automatic generation? The UX changed a bit as I was writing the spec so I'm not sure what happened to those "settings" events. Since we have the toggle on the alt text modal we should have telemetry for it.

Comment 7

[Atila Butkovits]

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

Comment 8

[Calixte Denizet (:calixte)]

(In reply to Vanessa Sabino from comment #6)

A couple other events that seem to be firing inconsistently:

• pdfjs.image.alt_text.image_status_label_displayed: I'm seeing the event twice between clicking add image and image added, but if I click on the image later I don't see the event. I'd expect it to show only at the end of the image add flow and when the user clicks on image afterwards.

Ok I'll fix that.

• pdfjs.image.alt_text.model_result: this is not firing every time the model runs. I saw it once but I'm not even sure what it was attached to.

It's triggered every time a guess is done:
https://searchfox.org/mozilla-central/source/toolkit/components/pdfjs/content/PdfjsParent.sys.mjs#180-187

And do we have any events for when the user enables or disables automatic generation? The UX changed a bit as I was writing the spec so I'm not sure what happened to those "settings" events. Since we have the toggle on the alt text modal we should have telemetry for it.

We've "settings_ai_generation_check" which is used when the user changes the toggle in the settings UI.
But we haven't when it's changed from the alt-text dialog. Should we add a new event ?

Comment 9

[Calixte Denizet (:calixte)]

Attachment: Bug 1914480 - Telemetry adjustments for add image flow in PDFs

Original Revision: https://phabricator.services.mozilla.com/D220131

Depends on D220879

Comment 10

[Phabricator Automation]

release Uplift Approval Request

• User impact if declined: Low
• Code covered by automated testing: yes
• Fix verified in Nightly: no
• Needs manual QE test: yes
• Steps to reproduce for manual QE testing: Check that the metrics are present
• Risk associated with taking this patch: low
• Explanation of risk level: Self contained, small patch and only updates basic telemetry stuff
• String changes made/needed: No
• Is Android affected?: no

Comment 11

[Rares Doghi, Desktop QA]

Verified as fixed in our latest 131.0b4 (64-bit)

Comment 12

[Pulsebot]

https://hg.mozilla.org/releases/mozilla-release/rev/5560e3e95b35

Comment 13

[Pascal Chevrel:pascalc]

This fix will be included in our planned 130 dot release, thanks.

Comment 14

[Rares Doghi, Desktop QA]

This is verified as fixed in our latest Release 130.0.1 20240912074333