Search with Favorites widget #1321

cmonfortep · 2021-07-19T14:38:56Z

Task/Issue URL: https://app.asana.com/0/488551667048375/1200651343654716/f
Tech Design URL:
CC:

Description:

This PR introduces a new widget for Android. The new widget will show user's favorites and the search bar.
The widget empty case includes a CTA to take the user through a small onboarding about how to add favorites.

We've also updated the UI for the existing widgets.

Steps to test this PR:

Test 1: onboarding

Fresh install
Navigate through the onboarding until you see the widget CTA (visit a site, open a new tab, visit another site, open another tab)
Click on "Add Wiget" and then "Add automatically"
press home and go to your homescreen
Ensure widget was added
Widget should a CTA saying "No Favorites added yet" - "Add Favorite"
Click on "Add Favorite"
Ensure pixel "m_sfew_l" sent
Ensure Dax CTA appears "Visit your favorite sites in a flash! ..."
Ensure pixel "m_fo_s" sent
Visit a Site
Ensure overflow menu is highlighted
Open the menu
Ensure "Add Favorite" is highlighted
Click on that option
Ensure pixel "m_nav_af_p" sent with "fmi=true"
Visit another site
Add the new site as favorite
Ensure pixel "m_nav_af_p" sent with "fmi=false"
Press home
Ensure new favorites sites are shown in the widget
Now click on the widget "search bar"
Ensure you go to SystemSearch screen
Ensure Pixel "m_sfbw_l" sent

Test 2: interact with favorites

click on any favorite from the widget
Ensure pixel "m_sfiw_l" sent
Focus the URL bar
Quick access grid should appear, visit a favorite from there
Ensure pixel "m_fav_o" sent
Now open a new tab
Ensure pixel "m_fav_ht" sent
Go to bookmarks screen
Click on a favorite
ensure pixel "m_fav_b" sent
Remove one of your favorites
Go to your homescreen
Ensure the widget doesn't show the favorite you removed

Test 3: Add widget manually

Add the favorites widget manually on your home screen (no need to remove the previous one)
When the widget is placed on your homescreen, the configuration screen should appear
Ensure pixel "m_sfw_cs" is sent
Select "system default" theme and "add widget"
Ensure pixel "m_sfw_sd" sent
Change the theme of your device
Widget should also change to honor system theme

Test 4: Resize the widget

You should be able to resize the widget (width or height)
Reduce the widget width to only show 2 columns
Ensure search bar hint is not visible
If widget has not favorites, empty CTA will not appear when widget has 2 columns

Internal references:

Software Engineering Expectations
Technical Design Template

- widget manifest - configuration activity - widget class

- search bar with clickable intent - grid of items for favorites (using WidgetService)

…are the same values

…ixes bug of widget using wrong adapter)

aitorvs · 2021-07-21T09:45:54Z

app/src/main/java/com/duckduckgo/app/bookmarks/model/FavoritesRepository.kt

    private val favoritesDao: FavoritesDao,
    private val faviconManager: Lazy<FaviconManager>,
 ) : FavoritesRepository {
+


nit: remove this change

aitorvs · 2021-07-21T09:52:40Z

app/src/main/java/com/duckduckgo/app/di/AppComponent.kt

+    fun inject(searchAndFavsWidget: SearchAndFavoritesWidget)
+
+    fun inject(favoritesWidgetItemFactory: FavoritesWidgetService.FavoritesWidgetItemFactory)
+
+    fun inject(emptyFavoritesWidgetItemFactory: EmptyFavoritesWidgetService.EmptyFavoritesWidgetItemFactory)
+


Why do we need these? For instance for the SearchAndFavoritesWidget why can't we do the injection in onReceive?

BTW I think we also don't need the fun inject(searchWidget: SearchWidget)

@aitorvs and I talked about this, and try directly using AndroidInjector, however it will not work without providing an AndroidInjector.Factory in the same way we do for each Activity. We decided to keep it as it is since we will remove dagger-android soon.

cmonfortep · 2021-07-22T09:49:45Z

app/src/main/java/com/duckduckgo/app/widget/FavoritesObserver.kt

+
+    @OnLifecycleEvent(Lifecycle.Event.ON_START)
+    fun notifyWidgets() {
+        GlobalScope.launch {


Remove GlobalScope

CDRussell

This is looking awesome! 🎉

CDRussell · 2021-07-22T11:03:21Z

app/src/main/java/com/duckduckgo/app/browser/favicon/FaviconManager.kt

        } else null
    }

+    override suspend fun loadFromDiskWithParams(tabId: String?, url: String, radius: Int, width: Int, height: Int): Bitmap? {


Suggested change

override suspend fun loadFromDiskWithParams(tabId: String?, url: String, radius: Int, width: Int, height: Int): Bitmap? {

override suspend fun loadFromDiskWithParams(tabId: String?, url: String, cornerRadius: Int, width: Int, height: Int): Bitmap? {

CDRussell · 2021-07-22T11:05:51Z

app/src/main/java/com/duckduckgo/app/systemsearch/SystemSearchActivity.kt

    }

+    private fun launchedFromSearchWithFavsWidget(intent: Intent): Boolean {
+        return intent.getBooleanExtra(WIDGET_SEARCH_WITH_FAVS_EXTRA, false)


Add a pixel

CDRussell · 2021-07-22T11:07:20Z

app/src/main/java/com/duckduckgo/widget/EmptyFavoritesWidgetService.kt

+        return EmptyFavoritesWidgetItemFactory(this.applicationContext, intent)
+    }
+
+    class EmptyFavoritesWidgetItemFactory(val context: Context, intent: Intent) : RemoteViewsFactory {


Maybe add a comment around why this is needed

CDRussell · 2021-07-22T11:11:24Z

app/src/main/java/com/duckduckgo/widget/SearchAndFavoritesWidget.kt

+        super.onDeleted(context, appWidgetIds)
+    }
+
+    private fun updateWidget(context: Context, appWidgetManager: AppWidgetManager, appWidgetId: Int, newOptions: Bundle?) {


can we pull out smaller functions from this?

CDRussell · 2021-07-22T11:12:33Z

app/src/main/java/com/duckduckgo/widget/SearchAndFavoritesWidget.kt

+        var columns = calculateColumns(context, width)
+        var rows = calculateRows(context, height)
+
+        columns = if (columns < 2) 2 else columns


maybe use coerce here too for consistency with rows

CDRussell · 2021-07-22T11:14:50Z

app/src/main/java/com/duckduckgo/widget/SearchAndFavoritesWidget.kt

+        return Pair(columns, rows)
+    }
+
+    private fun calculateColumns(context: Context, width: Int): Int {


We could likely extract calculateColumns and calculateRows to a utility class which could be unit tested

CDRussell · 2021-07-22T11:18:51Z

app/src/main/res/values/string-untranslated.xml

+    <string name="widgetConfigurationAddWidgetOption">Add widget</string>
+    <string name="searchWidgetEmtpyFavoritesHint">No favorites added yet</string>
+    <string name="searchWidgetEmtpyFavoritesCta">Add Favorite</string>
+    <string name="daxFavoritesOnboardingCtaText"><![CDATA[Visit your favorite sites in a flash!<br/><br/>Go to a site you love. Then tap the \"⋯\" icon and select Add Favorite.]]></string>


try the unicode character for the overflow (will also requiring manually setting the accessibility text)

CDRussell · 2021-07-22T11:20:25Z

common-ui/src/main/res/values/dimens.xml

+    <dimen name="searchWidgetSearchBarSideMargin">16dp</dimen>
+    <dimen name="searchWidgetFavoriteItemContainerWidth">64dp</dimen>
+    <dimen name="searchWidgetFavoriteItemContainerHeight">78dp</dimen>
+    <dimen name="searchWidget4colWidth">280dp</dimen>


4col probably not still valid

…s values on favorites grid

… picker

# Conflicts: # app/src/main/java/com/duckduckgo/app/browser/BrowserActivity.kt

CDRussell

Changes looking good! added some tiny optional suggestions but don't mind about any of them

CDRussell · 2021-08-02T09:33:13Z

app/src/main/java/com/duckduckgo/app/cta/ui/Cta.kt

+                        info.text = v?.context?.getString(R.string.daxFavoritesOnboardingCtaContentDescription)
+                    }
+                }
+            // Using braille unicode inside textview, override description for accessibility


Maybe worth clarifying why we are doing that... e.g., using it to show something that looks like the overflow icon

CDRussell · 2021-08-02T09:34:03Z

app/src/main/java/com/duckduckgo/app/widget/FavoritesObserver.kt

    @OnLifecycleEvent(Lifecycle.Event.ON_START)
    fun notifyWidgets() {
-        GlobalScope.launch {
+        appCoroutineScope.launch() {


haven't checked in an IDE, but could probably remove the () i think?

CDRussell · 2021-08-02T09:35:50Z

app/src/main/java/com/duckduckgo/widget/SearchAndFavoritesGridCalculator.kt

+        rows = 1.coerceAtLeast(rows)
+        rows = 4.coerceAtMost(rows)


1 and 4 might read slightly better if they had constants explaining what they were (reads like magic numbers currently)

- replace magic numbers with constant values

bmx666 · 2022-04-03T20:13:28Z

app/src/main/java/com/duckduckgo/widget/SearchWidget.kt

+        var portraitWidth = appWidgetOptions.getInt(AppWidgetManager.OPTION_APPWIDGET_MIN_WIDTH)
+
+        if (newOptions != null) {
+            portraitWidth = appWidgetOptions.getInt(AppWidgetManager.OPTION_APPWIDGET_MIN_WIDTH)


Is it bug? Check newOptions is null and set same value for portraitWidth

bmx666 · 2022-04-03T20:14:39Z

app/src/main/java/com/duckduckgo/widget/SearchAndFavoritesWidget.kt

+            portraitWidth = appWidgetOptions.getInt(AppWidgetManager.OPTION_APPWIDGET_MIN_WIDTH)
+            landsWidth = appWidgetOptions.getInt(AppWidgetManager.OPTION_APPWIDGET_MAX_WIDTH)
+            landsHeight = appWidgetOptions.getInt(AppWidgetManager.OPTION_APPWIDGET_MIN_HEIGHT)
+            portraitHeight = appWidgetOptions.getInt(AppWidgetManager.OPTION_APPWIDGET_MAX_HEIGHT)


Is it bug? Check newOptions is null and set same value for variables?

cmonfortep added 30 commits June 3, 2021 23:30

initial configuration:

4316139

- widget manifest - configuration activity - widget class

Favorites widget created:

ca76749

- search bar with clickable intent - grid of items for favorites (using WidgetService)

Configuration screen layout

5bfdb41

sync methods to obtain favorites from database

0fade54

adapt ui when widget resized: calculate columns and change layout

d83c7c4

update widgets layout to keep consistency between them

d97d54d

Showing empty view when no favorites

5342369

day-night colors declaration

22ede94

widget favorite items layout (light/dark/system)

a5c4aa8

widget theme prefs datastore

d3edaeb

widget configuration screen stores selected theme + ui updated

3a2c027

widget grid adapter using new layouts

9fe7ef5

Favorites items on widget themed

f0a486f

added all layouts to cover all themes and sizes

0904e53

widget search bar background color updated

843e1f3

disable scrollbars from favorites in widget

c69b400

Using dimens instead of harcoded values so logic in widget and xml sh…

53be0fb

…are the same values

fix loading item not honouring theme

5d5664e

restrict max size for col4 layout

6a951ef

calculate rows using dimens (tweaks to make widget fit in pixel 2)

2d9140d

update widget ui when theme selected

ec252be

remove empty favorites hint and reduce margins for col2 layouts

f1ae016

add min spacing between favorites in widgets

3f7e193

temp: notify when widget changes

2907347

Dirty: show favicons on widget

f58cc78

fixes a bug when accessing list with less elements than columns to show

a47b7c7

Store widget size in shared prefs to avoid sending args via Intent (f…

3eb265f

…ixes bug of widget using wrong adapter)

inject only when class was not initialized

41547b8

notify widget when favorite database changes from global observer

84a7377

apply code style

0dcb708

aitorvs reviewed Jul 21, 2021

View reviewed changes

cmonfortep added 3 commits July 21, 2021 15:46

fixes: wrong pixel when search bar clicked

65b09ed

Widget inject onReceive

617ee70

add small margins to avoid shadow being cut

b8cc075

CDRussell self-assigned this Jul 22, 2021

cmonfortep marked this pull request as ready for review July 22, 2021 09:22

cmonfortep commented Jul 22, 2021

View reviewed changes

CDRussell approved these changes Jul 22, 2021

View reviewed changes

cmonfortep added 15 commits July 23, 2021 14:56

Fixes Samsung widget issues: Use multiple layouts to change numColumn…

15bc5d5

…s values on favorites grid

Use label to affect the order how widgets appear on the system widget…

3b74a53

… picker

Use appCoroutineScope instead of GlobalScope

0a90ee1

user cornerRadius instead of radius

6b4ed0d

remove unused dimen

9fc22ec

send pixel if favorite clicked from SystemSearchActivity

9074b34

comment to explain how it's used EmptyFavoritesWidgetService

ee8a0c6

user coerceAtLeast for consistency

9a02c36

move widget render logic into smaller methods

3d9f68a

add imports

2dafff9

Use unicode for browser menu icon and override contentdescription

c141e71

extract methods into utility class and provide test cases

7b59957

code style

7333c25

Merge branch 'develop' into feature/cristian/favorites_widget

b0cc6f0

# Conflicts: # app/src/main/java/com/duckduckgo/app/browser/BrowserActivity.kt

use new loupe icon compatible with api < 23

d001842

CDRussell approved these changes Aug 2, 2021

View reviewed changes

cmonfortep added 2 commits August 2, 2021 14:55

- improve comment

0ab1d06

- replace magic numbers with constant values

Merge branch 'develop' into feature/cristian/favorites_widget

13f32ff

cmonfortep merged commit b85f29e into develop Aug 2, 2021

cmonfortep deleted the feature/cristian/favorites_widget branch August 2, 2021 13:21

bmx666 reviewed Apr 3, 2022

View reviewed changes

	override suspend fun loadFromDiskWithParams(tabId: String?, url: String, radius: Int, width: Int, height: Int): Bitmap? {
	override suspend fun loadFromDiskWithParams(tabId: String?, url: String, cornerRadius: Int, width: Int, height: Int): Bitmap? {

Search with Favorites widget #1321

Search with Favorites widget #1321

Uh oh!

Conversation

cmonfortep commented Jul 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Internal references:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CDRussell left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CDRussell left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CDRussell Aug 2, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

cmonfortep commented Jul 19, 2021 •

edited

Loading

CDRussell Aug 2, 2021 •

edited

Loading