For #7249 Create a search widget #7474

iorgamgabriel · 2022-08-09T09:49:01Z

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:

click on Show All Checks,
click Details next to build-focus-debug or build-klar-debug for changes targeting Klar,
click View task in Taskcluster,
click the Artifacts row,
click to download any of the apks listed here which use an appropriate name for each CPU architecture.

GitHub Automation

Fixes #7249

Mugurell

Some small nits but this LGTM.
If you have time to add some tests for the new code would be great!
r+ for the code.

app/src/main/java/org/mozilla/gecko/search/SearchWidgetProvider.kt

app/src/main/java/org/mozilla/focus/FocusApplication.kt

iorgamgabriel · 2022-08-11T13:37:52Z

Request for data collection review form

All questions are mandatory. You must receive review from a data steward peer on your responses to these questions before shipping new data collection.

What questions will you answer with this data?

search_widget_installed - If the user has the search widget added on the home screen
new_tab_button - When the user has pressed anywhere from the Focus logo until the start of the microphone icon, opening a new tab search screen.
voice_button - When the user pressed the microphone icon, opening a new voice search screen.

Why does Mozilla need to answer these questions? Are there benefits for users? Do we need this information to address product or business requirements?

We are adding new features in history to make users' interactions more efficient.

What alternative methods did you consider to answer these questions? Why were they not sufficient?

There are no other alternatives.

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. 
Note that the data steward reviewing your request will characterize your data collection based on the highest (and most sensitive) category.

Measurement Description	Data Collection Category	Tracking Bug #
Search Widget Installed: If the user has the search widget added on the home screen.	Category 2 - interaction data	#7249
Search Widget New Tab Button: When the user has pressed anywhere from the Focus logo until the start of the microphone icon, opening a new tab search screen.	Category 2 - interaction data	#7249
Search Widget Voice Button: When the user pressed the microphone icon, opening a new voice search screen.	Category 2 - interaction data	#7249

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/focus_android

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

Up until version 119, with the option to renew at that point.

What populations will you measure?

All channels, all locales, all countries

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.

GlAM.

Where do you intend to share the results of your analysis?

 Only on Glean, Glam, 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 tools.

rocketsroger · 2022-08-16T14:33:26Z

Please make sure you answer question 5 for the data review request. Thanks

iorgamgabriel · 2022-08-16T15:11:28Z

Done @rocketsroger

rocketsroger · 2022-08-17T14:11:39Z

Request for data collection review form

All questions are mandatory. You must receive review from a data steward peer on your responses to these questions before shipping new data collection.

1. What questions will you answer with this data?


* search_widget_installed - If the user has the search widget added on the home screen

* new_tab_button - When the user has pressed anywhere from the Focus logo until the start of the microphone icon, opening a new tab search screen.

* voice_button - When the user pressed the microphone icon, opening a new voice search screen.


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?


* We are adding new features in history to make users' interactions more efficient.


3. What alternative methods did you consider to answer these questions? Why were they not sufficient?


* There are no other alternatives.


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.    
   Note that the data steward reviewing your request will characterize your data collection based on the highest (and most sensitive) category.

Measurement Description Data Collection Category Tracking Bug #
Search Widget Installed: If the user has the search widget added on the home screen. Category 2 - interaction data #7249
Search Widget New Tab Button: When the user has pressed anywhere from the Focus logo until the start of the microphone icon, opening a new tab search screen. Category 2 - interaction data #7249
Search Widget Voice Button: When the user pressed the microphone icon, opening a new voice search screen. Category 2 - interaction data #7249

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/focus_android


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


* Up until version 119, with the option to renew at that point.


8. What populations will you measure?


* All channels, all locales, all countries


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.


* GlAM.


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


* Only on Glean, Glam, 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 tools.

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 119

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+

Mugurell

Looks and functions nicely 👍 ✨

Mugurell · 2022-08-19T09:28:39Z

app/src/main/AndroidManifest.xml

+        <activity
+            android:name=".searchwidget.VoiceSearchActivity"
+            android:theme="@style/Theme.AppCompat.Translucent" />
+


The previous version of the patch contained an important bug fix related to the search activity which was implemented in https://github.com/mozilla-mobile/fenix/pull/24296/files. Do we need that back?

Suggested change

<activity

android:name=".searchwidget.VoiceSearchActivity"

android:theme="@style/Theme.AppCompat.Translucent" />

<activity

android:name=".searchwidget.VoiceSearchActivity"

android:excludeFromRecents="true"

android:taskAffinity=""

android:theme="@style/Theme.AppCompat.Translucent" />

Mugurell · 2022-08-19T09:35:14Z

app/src/main/java/org/mozilla/focus/activity/IntentReceiverActivity.kt

        startActivity(intent)
    }
+
+    companion object {
+        const val SEARCH_WIDGET = "search_widget"


nit: It's not clear what this property represents and when to be used. Can you update the naming and/or add documentation?
I see other such properties in the app using the EXTRA prefix.

Mugurell · 2022-08-19T09:57:44Z

app/src/main/java/org/mozilla/focus/activity/IntentReceiverActivity.kt

+        if (intent.getBooleanExtra(SEARCH_WIDGET, false)) {
+            SearchWidget.newTabButton.record(NoExtras())
+        }


Can this be moved to MainActivity?
Just to have a better separation of responsabilities. This would be the first time IntentReceiverActivity records telemetry while MainActivity already does this, even for AppOpened events.

iorgamgabriel added the 🕵️‍♀️ needs review PRs that need to be reviewed label Aug 9, 2022

Mugurell approved these changes Aug 9, 2022

View reviewed changes

iorgamgabriel force-pushed the 7249 branch 6 times, most recently from ff375ed to 1a41f99 Compare August 11, 2022 13:25

iorgamgabriel requested a review from rocketsroger August 11, 2022 13:48

iorgamgabriel added the needs:data-review PR is awaiting a data review label Aug 11, 2022

iorgamgabriel force-pushed the 7249 branch from 1a41f99 to 429d294 Compare August 16, 2022 06:06

iorgamgabriel force-pushed the 7249 branch from 429d294 to 51c811f Compare August 17, 2022 07:05

rocketsroger removed 🕵️‍♀️ needs review PRs that need to be reviewed needs:data-review PR is awaiting a data review labels Aug 17, 2022

iorgamgabriel force-pushed the 7249 branch from 51c811f to ee40969 Compare August 19, 2022 08:20

Mugurell approved these changes Aug 19, 2022

View reviewed changes

iorgamgabriel force-pushed the 7249 branch 2 times, most recently from 11f0a0c to 4e1a431 Compare August 19, 2022 10:56

For mozilla-mobile#7249 Create a search widget

813b349

iorgamgabriel force-pushed the 7249 branch from 4e1a431 to 813b349 Compare August 19, 2022 11:05

iorgamgabriel added the 🛬 needs landing PRs that are ready to land label Aug 19, 2022

mergify bot merged commit 614aab5 into mozilla-mobile:main Aug 19, 2022

rocketsroger mentioned this pull request Aug 17, 2023

Bug 1849189 - Update Focus telemetry probes expiring in v120 mozilla-mobile/firefox-android#3320

Merged

4 tasks

rocketsroger mentioned this pull request Oct 11, 2023

Bug 1858448 - Renew all telemetry to never expires mozilla-mobile/firefox-android#4040

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

For #7249 Create a search widget #7474

For #7249 Create a search widget #7474

iorgamgabriel commented Aug 9, 2022 •

edited by github-actions bot

Loading

Mugurell left a comment •

edited

Loading

iorgamgabriel commented Aug 11, 2022 •

edited

Loading

rocketsroger commented Aug 16, 2022

iorgamgabriel commented Aug 16, 2022

rocketsroger commented Aug 17, 2022

Request for data collection review form

Mugurell left a comment

Mugurell Aug 19, 2022

iorgamgabriel Aug 19, 2022

Mugurell Aug 19, 2022

iorgamgabriel Aug 19, 2022

Mugurell Aug 19, 2022

iorgamgabriel Aug 19, 2022

For #7249 Create a search widget #7474

For #7249 Create a search widget #7474

Conversation

iorgamgabriel commented Aug 9, 2022 • edited by github-actions bot Loading

Pull Request checklist

QA

To download an APK when reviewing a PR:

GitHub Automation

Mugurell left a comment • edited Loading

Choose a reason for hiding this comment

iorgamgabriel commented Aug 11, 2022 • edited Loading

Request for data collection review form

rocketsroger commented Aug 16, 2022

iorgamgabriel commented Aug 16, 2022

rocketsroger commented Aug 17, 2022

Request for data collection review form

Data Review

Result

Mugurell left a comment

Choose a reason for hiding this comment

Mugurell Aug 19, 2022

Choose a reason for hiding this comment

iorgamgabriel Aug 19, 2022

Choose a reason for hiding this comment

Mugurell Aug 19, 2022

Choose a reason for hiding this comment

iorgamgabriel Aug 19, 2022

Choose a reason for hiding this comment

Mugurell Aug 19, 2022

Choose a reason for hiding this comment

iorgamgabriel Aug 19, 2022

Choose a reason for hiding this comment

iorgamgabriel commented Aug 9, 2022 •

edited by github-actions bot

Loading

Mugurell left a comment •

edited

Loading

iorgamgabriel commented Aug 11, 2022 •

edited

Loading