For #3709: Add save to PDF UI. #27257

Amejia481 · 2022-10-03T19:49:24Z

https://www.figma.com/file/4TFvx6UlVO127bubv1WZKZ/Print-to-PDF-%2F-Share-Sheet?node-id=438%3A19971

We still need to land https://bugzilla.mozilla.org/show_bug.cgi?id=1784554 for improving the long time when the PDF is requested.

Pull Request checklist

Tests: This PR includes thorough tests or an explanation of why it does not
Screenshots: This PR includes screenshots or GIFs of the changes made or an explanation of why it does not
Accessibility: The code in this PR follows accessibility best practices or does not include any user facing features. In addition, it includes a screenshot of a successful accessibility scan to ensure no new defects are added to the product.

QA

[] QA Needed

To download an APK when reviewing a PR (after all CI tasks finished running):

Click on Checks at the top of the PR page.
Click on the firefoxci-taskcluster group on the left to expand all tasks.
Click on the build-debug task.
Click on View task in Taskcluster in the new DETAILS section.
The APK links should be on the right side of the screen, named for each CPU architecture.

GitHub Automation

Fixes #3709

Amejia481 · 2022-10-03T19:57:30Z

Request for data collection review

What questions will you answer with this data?
This data will provide statistics regarding the usage of the save to PDF feature.
Why does Mozilla need to answer these questions? Are there benefits for users? Do we need this information to address product or business requirements?
This will give us an understanding of the usage of the save to PDF functionality, we will use the info for improving the user experience.
What alternative methods did you consider to answer these questions? Why were they not sufficient?
No alternative is available to answer this question.
Can current instrumentation answer these questions?
No.
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.

Measurement Description	Data Collection Category	Tracking Bug #
Save to PDF button clicks	category 2 - Interaction data	#3709

Please provide a link to the documentation for this data collection which describes the ultimate data set in a public, complete, and accurate way.
https://dictionary.telemetry.mozilla.org/apps/fenix 
How long will this data be collected? Choose one of the following:
Up until version 122, with the option to renew at that point. 
What populations will you measure?
No filters - all locales, channels, etc. Currently, the button is visible only in Nightly.
If this data collection is default on, what is the opt-out mechanism for users?
Default Glean SDK opt-out mechanism.
Please provide a general description of how you will analyze this data.
Glean / Amplitude
Where do you intend to share the results of your analysis?
Only on Glean, Amplitude and with mobile teams.
Is there a third-party tool (i.e. not Telemetry) that you are proposing to use for this data collection?
No third-party tool will use this data.

app/src/main/java/org/mozilla/fenix/share/SaveToPDFItem.kt

app/src/test/java/org/mozilla/fenix/share/ShareControllerTest.kt

app/src/test/java/org/mozilla/fenix/share/ShareInteractorTest.kt

app/src/main/res/layout/fragment_share.xml

jonalmeida

Mostly nits and few design fixes, but once they are fixed along with Matt's comments addressed, I think this looks good to land. Happy to re-review if needed. 🙂

app/metrics.yaml

jonalmeida · 2022-10-03T23:21:00Z

app/metrics.yaml

+    expires: 122
+    metadata:
+      tags:
+        - ContextMenu


The ContextMenu is the tag for the press-and-hold menu that shows up in web content. See feature-contextmenu.

Suggested change

- ContextMenu

- Sharing

app/src/main/res/navigation/nav_graph.xml

app/src/main/java/org/mozilla/fenix/share/SaveToPDFItem.kt

app/src/main/java/org/mozilla/fenix/share/ShareFragment.kt

app/src/main/java/org/mozilla/fenix/share/ShareSaveToPDFInteractor.kt

app/src/main/java/org/mozilla/fenix/share/ShareInteractor.kt

app/src/main/res/layout/fragment_share.xml

app/src/main/res/values/strings.xml

app/src/main/java/org/mozilla/fenix/share/SaveToPDFItem.kt

app/src/main/java/org/mozilla/fenix/share/ShareFragment.kt

Amejia481 · 2022-10-05T15:39:01Z

Thanks all for all the feedback, I address the comment and updated the PR, when you have a moment please take a look :)

mcarare · 2022-10-05T16:08:33Z

app/src/main/java/org/mozilla/fenix/share/ShareFragment.kt

+                setContent {
+                    FirefoxTheme {
+                        SaveToPDFItem {
+                            shareInteractor.onSaveToPDF(tabId = args.sessionId)


nit: maybe it's just me, but it looks strange having the lambda out of the parenthesis, in a "tree" of composables content. 😅 .
Maybe you could leave it on the same row as SaveToPDFItem so it looks more like a method call rather than an "inside" composable.

mcarare

LGTM!

app/src/main/java/org/mozilla/fenix/share/Interactor.kt

rocketsroger · 2022-10-05T19:32:23Z

Request for data collection review

1. What questions will you answer with this data?
   This data will provide statistics regarding the usage of the save to PDF feature.

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?
   This will give us an understanding of the usage of the save to PDF functionality, we will use the info for improving the user experience.

3. What alternative methods did you consider to answer these questions? Why were they not sufficient?
   No alternative is available to answer this question.

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.

Measurement Description Data Collection Category Tracking Bug #
Save to PDF button clicks category 2 - Interaction data #3709

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.
   [https://dictionary.telemetry.mozilla.org/apps/fenix    ](https://dictionary.telemetry.mozilla.org/apps/fenix%E2%80%A8)

7. How long will this data be collected? Choose one of the following:
   Up until version 122, with the option to renew at that point.

8. What populations will you measure?
   No filters - all locales, channels, etc. Currently, the button is visible only in Nightly.

9. If this data collection is default on, what is the opt-out mechanism for users?
   Default Glean SDK opt-out mechanism.

10. Please provide a general description of how you will analyze this data.
    Glean / Amplitude

11. Where do you intend to share the results of your analysis?
    Only on Glean, Amplitude and with mobile teams.

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

Data Review

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

Yes, through the metrics.yaml file and the Glean Dictionary

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

Yes, through the "Send Usage Data" preference in the application settings

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

N/A, collection set to end or be renewed by version 122

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-on

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

data-review+

Amejia481 requested review from a team as code owners October 3, 2022 19:49

Amejia481 requested review from jonalmeida and removed request for a team October 3, 2022 19:51

Amejia481 added the needs:review PRs that need to be reviewed label Oct 3, 2022

Amejia481 force-pushed the for-3709 branch from 983140d to a1d20ae Compare October 3, 2022 19:54

Amejia481 requested a review from rocketsroger October 3, 2022 19:57

MatthewTighe reviewed Oct 3, 2022

View reviewed changes

app/src/main/java/org/mozilla/fenix/share/SaveToPDFItem.kt Outdated Show resolved Hide resolved

MatthewTighe reviewed Oct 3, 2022

View reviewed changes

app/src/test/java/org/mozilla/fenix/share/ShareControllerTest.kt Outdated Show resolved Hide resolved

app/src/test/java/org/mozilla/fenix/share/ShareInteractorTest.kt Outdated Show resolved Hide resolved

app/src/main/res/layout/fragment_share.xml Outdated Show resolved Hide resolved

Amejia481 force-pushed the for-3709 branch from a1d20ae to 8692abe Compare October 3, 2022 20:59

Amejia481 closed this Oct 3, 2022

Amejia481 reopened this Oct 3, 2022

jonalmeida approved these changes Oct 4, 2022

View reviewed changes

jonalmeida reviewed Oct 4, 2022

View reviewed changes

app/src/main/res/values/strings.xml Outdated Show resolved Hide resolved

MozillaNoah reviewed Oct 4, 2022

View reviewed changes

app/src/main/java/org/mozilla/fenix/share/SaveToPDFItem.kt Outdated Show resolved Hide resolved

gabrielluong reviewed Oct 5, 2022

View reviewed changes

app/src/main/java/org/mozilla/fenix/share/SaveToPDFItem.kt Outdated Show resolved Hide resolved

gabrielluong reviewed Oct 5, 2022

View reviewed changes

app/src/main/java/org/mozilla/fenix/share/ShareFragment.kt Outdated Show resolved Hide resolved

Amejia481 force-pushed the for-3709 branch 2 times, most recently from 1fac60a to 880ef09 Compare October 5, 2022 15:32

Amejia481 requested review from gabrielluong, MatthewTighe, mcarare and MozillaNoah October 5, 2022 15:32

mcarare reviewed Oct 5, 2022

View reviewed changes

mcarare approved these changes Oct 5, 2022

View reviewed changes

jonalmeida added needs:data-review PR is awaiting a data review and removed needs:review PRs that need to be reviewed labels Oct 5, 2022

jonalmeida added the pr:approved PR that has been approved label Oct 5, 2022

gabrielluong reviewed Oct 5, 2022

View reviewed changes

app/src/main/java/org/mozilla/fenix/share/Interactor.kt Outdated Show resolved Hide resolved

Amejia481 force-pushed the for-3709 branch 3 times, most recently from a00c206 to 636342c Compare October 5, 2022 17:54

For mozilla-mobile#3709: Add save to PDF UI.

bfa2d21

Amejia481 force-pushed the for-3709 branch from 636342c to bfa2d21 Compare October 5, 2022 17:56

rocketsroger removed the needs:data-review PR is awaiting a data review label Oct 5, 2022

Amejia481 merged commit 5cce4b5 into mozilla-mobile:main Oct 5, 2022

akliuxingyuan mentioned this pull request Mar 7, 2023

Request for Save as PDF fork-maintainers/iceraven-browser#176

Closed

rocketsroger mentioned this pull request Oct 11, 2023

Bug 1858440 - Renew all telemetry to never expires mozilla-mobile/firefox-android#4039

Merged

4 tasks

akliuxingyuan mentioned this pull request Nov 25, 2023

Features request fork-maintainers/iceraven-browser#354

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

For #3709: Add save to PDF UI. #27257

For #3709: Add save to PDF UI. #27257

Amejia481 commented Oct 3, 2022 •

edited by github-actions bot

Amejia481 commented Oct 3, 2022 •

edited

jonalmeida left a comment

jonalmeida Oct 3, 2022

Amejia481 commented Oct 5, 2022

mcarare Oct 5, 2022

mcarare left a comment

rocketsroger commented Oct 5, 2022

Request for data collection review

For #3709: Add save to PDF UI. #27257

For #3709: Add save to PDF UI. #27257

Conversation

Amejia481 commented Oct 3, 2022 • edited by github-actions bot

Pull Request checklist

QA

To download an APK when reviewing a PR (after all CI tasks finished running):

GitHub Automation

Amejia481 commented Oct 3, 2022 • edited

Request for data collection review

jonalmeida left a comment

Choose a reason for hiding this comment

jonalmeida Oct 3, 2022

Choose a reason for hiding this comment

Amejia481 commented Oct 5, 2022

mcarare Oct 5, 2022

Choose a reason for hiding this comment

mcarare left a comment

Choose a reason for hiding this comment

rocketsroger commented Oct 5, 2022

Request for data collection review

Data Review

Result

Amejia481 commented Oct 3, 2022 •

edited by github-actions bot

Amejia481 commented Oct 3, 2022 •

edited