From 74862f990b7fc3fe884366b422bcde01aea726fd Mon Sep 17 00:00:00 2001 From: Shamali P Date: Wed, 31 Jul 2024 21:08:09 +0000 Subject: [PATCH] Fix the getWidgetsByPackageItem method to return a copy Bug: 356545910 Fix: 356545910 Test: Unit test Flag: EXEMPT BUGFIX Change-Id: I90429983733eb5f2bb2d6df00799d2445eaeea31 --- .../android/launcher3/model/WidgetsModel.java | 2 +- .../launcher3/model/WidgetsModelTest.kt | 29 +++++++++++++++++++ 2 files changed, 30 insertions(+), 1 deletion(-) diff --git a/src/com/android/launcher3/model/WidgetsModel.java b/src/com/android/launcher3/model/WidgetsModel.java index 35064cf094..c949ce66b6 100644 --- a/src/com/android/launcher3/model/WidgetsModel.java +++ b/src/com/android/launcher3/model/WidgetsModel.java @@ -89,7 +89,7 @@ public class WidgetsModel { if (!WIDGETS_ENABLED) { return Collections.emptyMap(); } - return mWidgetsByPackageItem; + return new HashMap<>(mWidgetsByPackageItem); } /** diff --git a/tests/multivalentTests/src/com/android/launcher3/model/WidgetsModelTest.kt b/tests/multivalentTests/src/com/android/launcher3/model/WidgetsModelTest.kt index 71f7d473b4..ff545fe6ce 100644 --- a/tests/multivalentTests/src/com/android/launcher3/model/WidgetsModelTest.kt +++ b/tests/multivalentTests/src/com/android/launcher3/model/WidgetsModelTest.kt @@ -186,6 +186,35 @@ class WidgetsModelTest { assertThat(underTest.widgetsByComponentKey).isEmpty() } + @Test + fun getWidgetsByPackageItem_returnsACopyOfMap() { + loadWidgets() + + val latch = CountDownLatch(1) + Executors.MODEL_EXECUTOR.execute { + var update = true + + // each "widgetsByPackageItem" read returns a different copy of the map held internally. + // Modifying one shouldn't impact another. + for ((_, _) in underTest.widgetsByPackageItem.entries) { + underTest.widgetsByPackageItem.clear() + if (update) { // trigger update + update = false + // Similarly, model could update its code independently while a client is + // iterating on the list. + underTest.update(app, /* packageUser= */ null) + } + } + + latch.countDown() + } + if (!latch.await(LOAD_WIDGETS_TIMEOUT_SECONDS, TimeUnit.SECONDS)) { + fail("Timed out waiting for test") + } + + // No exception + } + private fun loadWidgets() { val latch = CountDownLatch(1) Executors.MODEL_EXECUTOR.execute {