Create a separate class for widget related methods from popup provider (9e7d288f) · Commits · e / os / BlissLauncher3

src/com/android/launcher3/widget/picker/WidgetRecommendationCategory.java

+6 −0

Original line number	Diff line number	Diff line
		@@ -19,6 +19,8 @@ package com.android.launcher3.widget.picker;
		import androidx.annotation.Nullable;
		import androidx.annotation.StringRes;

		import com.android.launcher3.R;

		import java.util.Objects;

		/**
		@@ -26,6 +28,10 @@ import java.util.Objects;
		* option in the pop-up opened on long press of launcher workspace).
		*/
		public class WidgetRecommendationCategory implements Comparable<WidgetRecommendationCategory> {
		public static WidgetRecommendationCategory DEFAULT_WIDGET_RECOMMENDATION_CATEGORY =
		new WidgetRecommendationCategory(
		R.string.others_widget_recommendation_category_label, /order=/0);

		/** Resource id that holds the user friendly label for the category. */
		@StringRes
		public final int categoryTitleRes;

src/com/android/launcher3/widget/picker/model/WidgetPickerDataProvider.kt

0 → 100644

+84 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2024 The Android Open Source Project
		*
		* Licensed under the Apache License, Version 2.0 (the "License");
		* you may not use this file except in compliance with the License.
		* You may obtain a copy of the License at
		*
		* http://www.apache.org/licenses/LICENSE-2.0
		*
		* Unless required by applicable law or agreed to in writing, software
		* distributed under the License is distributed on an "AS IS" BASIS,
		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
		* See the License for the specific language governing permissions and
		* limitations under the License.
		*/

		package com.android.launcher3.widget.picker.model

		import com.android.launcher3.model.data.ItemInfo
		import com.android.launcher3.widget.model.WidgetsListBaseEntry
		import com.android.launcher3.widget.picker.model.data.WidgetPickerData
		import com.android.launcher3.widget.picker.model.data.WidgetPickerDataUtils.withRecommendedWidgets
		import com.android.launcher3.widget.picker.model.data.WidgetPickerDataUtils.withWidgets
		import java.io.PrintWriter

		/**
		* Provides [WidgetPickerData] to various views such as widget picker, app-specific widget picker,
		* widgets shortcut.
		*/
		class WidgetPickerDataProvider {
		/** All the widgets data provided for the views */
		private var mWidgetPickerData: WidgetPickerData = WidgetPickerData()

		private var changeListener: WidgetPickerDataChangeListener? = null

		/** Sets a listener to be called back when widget data is updated. */
		fun setChangeListener(changeListener: WidgetPickerDataChangeListener?) {
		this.changeListener = changeListener
		}

		/** Returns the current snapshot of [WidgetPickerData]. */
		fun get(): WidgetPickerData {
		return mWidgetPickerData
		}

		/**
		* Updates the widgets available to the widget picker.
		*
		* Generally called when the widgets model has new data.
		*/
		@JvmOverloads
		fun setWidgets(
		allWidgets: List<WidgetsListBaseEntry>,
		defaultWidgets: List<WidgetsListBaseEntry> = listOf()
		) {
		mWidgetPickerData =
		mWidgetPickerData.withWidgets(allWidgets = allWidgets, defaultWidgets = defaultWidgets)
		changeListener?.onWidgetsBound()
		}

		/**
		* Makes the widget recommendations available to the widget picker
		*
		* Generally called when new widget predictions are available.
		*/
		fun setWidgetRecommendations(recommendations: List<ItemInfo>) {
		mWidgetPickerData = mWidgetPickerData.withRecommendedWidgets(recommendations)
		changeListener?.onRecommendedWidgetsBound()
		}

		/** Writes the current state to the provided writer. */
		fun dump(prefix: String, writer: PrintWriter) {
		writer.println(prefix + "WidgetPickerDataProvider:")
		writer.println("$prefix\twidgetPickerData:$mWidgetPickerData")
		}

		interface WidgetPickerDataChangeListener {
		/** A callback to get notified when widgets are bound. */
		fun onWidgetsBound()

		/** A callback to get notified when recommended widgets are bound. */
		fun onRecommendedWidgetsBound()
		}
		}

src/com/android/launcher3/widget/picker/model/data/WidgetPickerData.kt

0 → 100644

+110 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2024 The Android Open Source Project
		*
		* Licensed under the Apache License, Version 2.0 (the "License");
		* you may not use this file except in compliance with the License.
		* You may obtain a copy of the License at
		*
		* http://www.apache.org/licenses/LICENSE-2.0
		*
		* Unless required by applicable law or agreed to in writing, software
		* distributed under the License is distributed on an "AS IS" BASIS,
		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
		* See the License for the specific language governing permissions and
		* limitations under the License.
		*/

		package com.android.launcher3.widget.picker.model.data

		import com.android.launcher3.model.WidgetItem
		import com.android.launcher3.model.data.ItemInfo
		import com.android.launcher3.util.ComponentKey
		import com.android.launcher3.util.PackageUserKey
		import com.android.launcher3.widget.PendingAddWidgetInfo
		import com.android.launcher3.widget.model.WidgetsListBaseEntry
		import com.android.launcher3.widget.model.WidgetsListContentEntry
		import com.android.launcher3.widget.picker.WidgetRecommendationCategory
		import com.android.launcher3.widget.picker.WidgetRecommendationCategory.DEFAULT_WIDGET_RECOMMENDATION_CATEGORY

		// This file contains WidgetPickerData and utility functions to operate on it.

		/** Widget data for display in the widget picker. */
		data class WidgetPickerData(
		val allWidgets: List<WidgetsListBaseEntry> = listOf(),
		val defaultWidgets: List<WidgetsListBaseEntry> = listOf(),
		val recommendations: Map<WidgetRecommendationCategory, List<WidgetItem>> = mapOf(),
		)

		/** Provides utility methods to work with a [WidgetPickerData] object. */
		object WidgetPickerDataUtils {
		/**
		* Returns a [WidgetPickerData] with the provided widgets.
		*
		* When [defaultWidgets] is not passed, defaults from previous object are not copied over.
		* Defaults (if supported) should be updated when all widgets are updated.
		*/
		fun WidgetPickerData.withWidgets(
		allWidgets: List<WidgetsListBaseEntry>,
		defaultWidgets: List<WidgetsListBaseEntry> = listOf()
		): WidgetPickerData {
		return copy(allWidgets = allWidgets, defaultWidgets = defaultWidgets)
		}

		/** Returns a [WidgetPickerData] with the given recommendations set. */
		fun WidgetPickerData.withRecommendedWidgets(recommendations: List<ItemInfo>): WidgetPickerData {
		val allWidgetsMap: Map<ComponentKey, WidgetItem> =
		allWidgets
		.filterIsInstance<WidgetsListContentEntry>()
		.flatMap { it.mWidgets }
		.filterNotNull()
		.distinct()
		.associateBy { it } // as ComponentKey

		val categoriesMap =
		recommendations
		.filterIsInstance<PendingAddWidgetInfo>()
		.filter { allWidgetsMap.containsKey(ComponentKey(it.targetComponent, it.user)) }
		.groupBy { it.recommendationCategory ?: DEFAULT_WIDGET_RECOMMENDATION_CATEGORY }
		.mapValues { (_, pendingAddWidgetInfos) ->
		pendingAddWidgetInfos.map {
		allWidgetsMap[ComponentKey(it.targetComponent, it.user)] as WidgetItem
		}
		}

		return copy(recommendations = categoriesMap)
		}

		/** Finds all [WidgetItem]s available for the provided package user. */
		@JvmStatic
		fun findAllWidgetsForPackageUser(
		widgetPickerData: WidgetPickerData,
		packageUserKey: PackageUserKey
		): List<WidgetItem> {
		return findContentEntryForPackageUser(widgetPickerData, packageUserKey)?.mWidgets
		?: emptyList()
		}

		/**
		* Finds and returns the [WidgetsListContentEntry] for the given package user.
		*
		* Set [fromDefaultWidgets] to true to limit the content entry to default widgets.
		*/
		@JvmOverloads
		@JvmStatic
		fun findContentEntryForPackageUser(
		widgetPickerData: WidgetPickerData,
		packageUserKey: PackageUserKey,
		fromDefaultWidgets: Boolean = false
		): WidgetsListContentEntry? {
		val widgetsListBaseEntries =
		if (fromDefaultWidgets) {
		widgetPickerData.defaultWidgets
		} else {
		widgetPickerData.allWidgets
		}

		return widgetsListBaseEntries.filterIsInstance<WidgetsListContentEntry>().firstOrNull {
		PackageUserKey.fromPackageItemInfo(it.mPkgItem) == packageUserKey
		}
		}
		}

tests/multivalentTests/src/com/android/launcher3/widget/picker/model/WidgetPickerDataProviderTest.kt

0 → 100644

+170 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2024 The Android Open Source Project
		*
		* Licensed under the Apache License, Version 2.0 (the "License");
		* you may not use this file except in compliance with the License.
		* You may obtain a copy of the License at
		*
		* http://www.apache.org/licenses/LICENSE-2.0
		*
		* Unless required by applicable law or agreed to in writing, software
		* distributed under the License is distributed on an "AS IS" BASIS,
		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
		* See the License for the specific language governing permissions and
		* limitations under the License.
		*/

		package com.android.launcher3.widget.picker.model

		import android.content.ComponentName
		import android.content.Context
		import android.os.UserHandle
		import android.platform.test.rule.AllowedDevices
		import android.platform.test.rule.DeviceProduct
		import android.platform.test.rule.LimitDevicesRule
		import androidx.test.core.app.ApplicationProvider
		import androidx.test.ext.junit.runners.AndroidJUnit4
		import com.android.launcher3.InvariantDeviceProfile
		import com.android.launcher3.LauncherAppState
		import com.android.launcher3.LauncherSettings
		import com.android.launcher3.icons.ComponentWithLabel
		import com.android.launcher3.icons.IconCache
		import com.android.launcher3.model.WidgetItem
		import com.android.launcher3.model.data.PackageItemInfo
		import com.android.launcher3.util.ActivityContextWrapper
		import com.android.launcher3.util.WidgetUtils
		import com.android.launcher3.widget.LauncherAppWidgetProviderInfo
		import com.android.launcher3.widget.PendingAddWidgetInfo
		import com.android.launcher3.widget.model.WidgetsListBaseEntry
		import com.android.launcher3.widget.model.WidgetsListContentEntry
		import com.android.launcher3.widget.model.WidgetsListHeaderEntry
		import com.android.launcher3.widget.picker.model.WidgetPickerDataProvider.WidgetPickerDataChangeListener
		import com.google.common.truth.Truth.assertThat
		import org.junit.Before
		import org.junit.Rule
		import org.junit.Test
		import org.junit.runner.RunWith
		import org.mockito.Mock
		import org.mockito.invocation.InvocationOnMock
		import org.mockito.junit.MockitoJUnit
		import org.mockito.junit.MockitoRule
		import org.mockito.kotlin.any
		import org.mockito.kotlin.doAnswer
		import org.mockito.kotlin.times
		import org.mockito.kotlin.verify
		import org.mockito.kotlin.verifyNoMoreInteractions

		// Tests for the WidgetPickerDataProvider class

		@RunWith(AndroidJUnit4::class)
		@AllowedDevices(allowed = [DeviceProduct.ROBOLECTRIC])
		class WidgetPickerDataProviderTest {
		@Rule @JvmField val limitDevicesRule = LimitDevicesRule()
		@Rule @JvmField val mockitoRule: MockitoRule = MockitoJUnit.rule()

		@Mock private lateinit var changeListener: WidgetPickerDataChangeListener

		@Mock private lateinit var iconCache: IconCache

		private lateinit var userHandle: UserHandle
		private lateinit var context: Context
		private lateinit var testInvariantProfile: InvariantDeviceProfile

		private lateinit var appWidgetItem: WidgetItem

		private var underTest = WidgetPickerDataProvider()

		@Before
		fun setUp() {
		userHandle = UserHandle.CURRENT
		context = ActivityContextWrapper(ApplicationProvider.getApplicationContext())
		testInvariantProfile = LauncherAppState.getIDP(context)

		doAnswer { invocation: InvocationOnMock ->
		val componentWithLabel = invocation.getArgument<Any>(0) as ComponentWithLabel
		componentWithLabel.getComponent().shortClassName
		}
		.`when`(iconCache)
		.getTitleNoCache(any<ComponentWithLabel>())

		appWidgetItem = createWidgetItem()
		}

		@Test
		fun setWidgets_invokesTheListener_andUpdatedWidgetsAvailable() {
		assertThat(underTest.get().allWidgets).isEmpty()

		underTest.setChangeListener(changeListener)
		val allWidgets = appWidgetListBaseEntries()
		underTest.setWidgets(allWidgets = allWidgets)

		assertThat(underTest.get().allWidgets).containsExactlyElementsIn(allWidgets)
		verify(changeListener, times(1)).onWidgetsBound()
		verifyNoMoreInteractions(changeListener)
		}

		@Test
		fun setWidgetRecommendations_callsBackTheListener_andUpdatedRecommendationsAvailable() {
		underTest.setWidgets(allWidgets = appWidgetListBaseEntries())
		assertThat(underTest.get().recommendations).isEmpty()

		underTest.setChangeListener(changeListener)
		val recommendations =
		listOf(
		PendingAddWidgetInfo(
		appWidgetItem.widgetInfo,
		LauncherSettings.Favorites.CONTAINER_WIDGETS_PREDICTION
		),
		)
		underTest.setWidgetRecommendations(recommendations)

		assertThat(underTest.get().recommendations).hasSize(1)
		verify(changeListener, times(1)).onRecommendedWidgetsBound()
		verifyNoMoreInteractions(changeListener)
		}

		@Test
		fun setChangeListener_null_noCallback() {
		underTest.setChangeListener(changeListener)
		underTest.setChangeListener(null) // reset

		underTest.setWidgets(allWidgets = appWidgetListBaseEntries())
		val recommendations =
		listOf(
		PendingAddWidgetInfo(
		appWidgetItem.widgetInfo,
		LauncherSettings.Favorites.CONTAINER_WIDGETS_PREDICTION
		),
		)
		underTest.setWidgetRecommendations(recommendations)

		verifyNoMoreInteractions(changeListener)
		}

		private fun createWidgetItem(): WidgetItem {
		val providerInfo =
		WidgetUtils.createAppWidgetProviderInfo(
		ComponentName.createRelative(APP_PACKAGE_NAME, APP_PROVIDER_1_CLASS_NAME)
		)
		val widgetInfo = LauncherAppWidgetProviderInfo.fromProviderInfo(context, providerInfo)
		return WidgetItem(widgetInfo, testInvariantProfile, iconCache, context)
		}

		private fun appWidgetListBaseEntries(): List<WidgetsListBaseEntry> {
		val packageItemInfo = PackageItemInfo(APP_PACKAGE_NAME, userHandle)
		packageItemInfo.title = APP_PACKAGE_TITLE
		val widgets = listOf(appWidgetItem)

		return buildList {
		add(WidgetsListHeaderEntry.create(packageItemInfo, APP_SECTION_NAME, widgets))
		add(WidgetsListContentEntry(packageItemInfo, APP_SECTION_NAME, widgets))
		}
		}

		companion object {
		const val APP_PACKAGE_NAME = "com.example.app"
		const val APP_PACKAGE_TITLE = "SomeApp"
		const val APP_SECTION_NAME = "S" // for fast popup
		const val APP_PROVIDER_1_CLASS_NAME = "appProvider1"
		}
		}

tests/multivalentTests/src/com/android/launcher3/widget/picker/model/data/WidgetPickerDataTest.kt

0 → 100644

+379 −0

File added.

Preview size limit exceeded, changes collapsed.