refactor: unread widget to resolve deprecations

Author: wmontwe

feature/widget/unread/build.gradle.kts

@@ -13,6 +13,7 @@ dependencies {
     implementation(libs.preferencex)
 
     testImplementation(libs.robolectric)
+    testImplementation(projects.core.logging.testing)
 }
 
 android {

feature/widget/unread/src/main/kotlin/app/k9mail/feature/widget/unread/BaseUnreadWidgetProvider.kt

@@ -12,10 +12,12 @@ import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.SupervisorJob
 import kotlinx.coroutines.launch
-import net.thunderbird.core.logging.legacy.Log
+import net.thunderbird.core.logging.Logger
 import org.koin.core.component.KoinComponent
 import org.koin.core.component.inject
 
+private const val TAG = "BaseUnreadWidgetProvider"
+
 /**
  * Unread widget provider that displays the number of unread messages on the user's home screen.
  *
@@ -48,6 +50,7 @@ import org.koin.core.component.inject
  */
 abstract class BaseUnreadWidgetProvider : AppWidgetProvider(), KoinComponent {
     private val repository: UnreadWidgetRepository by inject()
+    private val logger: Logger by inject()
     private val widgetScope = CoroutineScope(SupervisorJob() + Dispatchers.IO)
 
     override fun onUpdate(context: Context, appWidgetManager: AppWidgetManager, appWidgetIds: IntArray) {
@@ -81,10 +84,8 @@ abstract class BaseUnreadWidgetProvider : AppWidgetProvider(), KoinComponent {
         val remoteViews = RemoteViews(context.packageName, R.layout.unread_widget_layout)
 
         val appWidgetId = data.configuration.appWidgetId
-        var clickIntent: Intent? = null
 
-        try {
-            clickIntent = data.clickIntent
+        val clickIntent = try {
             val unreadCount = data.unreadCount
 
             if (unreadCount <= 0) {
@@ -98,17 +99,15 @@ abstract class BaseUnreadWidgetProvider : AppWidgetProvider(), KoinComponent {
             }
 
             remoteViews.setTextViewText(R.id.title, data.title)
-        } catch (e: Exception) {
-            Log.e(e, "Error getting widget configuration")
-        }
 
-        if (clickIntent == null) {
-            // If the widget configuration couldn't be loaded we open the configuration
-            // activity when the user clicks the widget.
-            clickIntent = Intent(context, UnreadWidgetConfigurationActivity::class.java)
-            clickIntent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId)
+            data.clickIntent
+        } catch (e: Exception) {
+            logger.error(TAG, e) { "Error getting widget configuration for widget ID $appWidgetId" }
+            null
+        } ?: Intent(context, UnreadWidgetConfigurationActivity::class.java).apply {
+            putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId)
+            addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
         }
-        clickIntent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
 
         val pendingIntent = PendingIntentCompat.getActivity(
             context,

feature/widget/unread/src/main/kotlin/app/k9mail/feature/widget/unread/KoinModule.kt

@@ -19,6 +19,7 @@ val unreadWidgetModule = module {
             folderRepository = get(),
             folderNameFormatter = get(),
             coreResourceProvider = get(),
+            logger = get(),
         )
     }
     single {
@@ -27,6 +28,11 @@ val unreadWidgetModule = module {
             config = get(),
         )
     }
-    single { UnreadWidgetUpdateListener(unreadWidgetUpdater = get()) }
+    single {
+        UnreadWidgetUpdateListener(
+            unreadWidgetUpdater = get(),
+            logger = get(),
+        )
+    }
     single { UnreadWidgetMigrations(accountRepository = get(), folderRepository = get()) }
 }

feature/widget/unread/src/main/kotlin/app/k9mail/feature/widget/unread/UnreadWidgetConfigurationActivity.kt

@@ -4,13 +4,18 @@ import android.appwidget.AppWidgetManager
 import android.os.Bundle
 import com.fsck.k9.ui.base.BaseActivity
 import com.fsck.k9.ui.base.extensions.fragmentTransaction
-import net.thunderbird.core.logging.legacy.Log
+import net.thunderbird.core.logging.Logger
+import org.koin.android.ext.android.inject
+
+private const val TAG = "UnreadWidgetConfigurationActivity"
 
 /**
  * Activity to select an account for the unread widget.
  */
 class UnreadWidgetConfigurationActivity : BaseActivity() {
 
+    private val logger: Logger by inject()
+
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         setLayout(R.layout.activity_unread_widget_configuration)
@@ -23,7 +28,7 @@ class UnreadWidgetConfigurationActivity : BaseActivity() {
         }
 
         if (appWidgetId == AppWidgetManager.INVALID_APPWIDGET_ID) {
-            Log.e("Received an invalid widget ID")
+            logger.error(TAG) { "Received an invalid widget ID" }
             finish()
             return
         }

feature/widget/unread/src/main/kotlin/app/k9mail/feature/widget/unread/UnreadWidgetConfigurationFragment.kt

@@ -7,9 +7,12 @@ import android.os.Bundle
 import android.view.Menu
 import android.view.MenuInflater
 import android.view.MenuItem
+import android.view.View
 import android.widget.Toast
 import androidx.activity.result.ActivityResultLauncher
 import androidx.core.os.bundleOf
+import androidx.core.view.MenuProvider
+import androidx.lifecycle.Lifecycle
 import androidx.preference.CheckBoxPreference
 import androidx.preference.Preference
 import com.fsck.k9.Preferences
@@ -49,7 +52,6 @@ class UnreadWidgetConfigurationFragment : PreferenceFragmentCompat() {
     private var selectedFolderDisplayName: String? = null
 
     override fun onCreatePreferencesFix(savedInstanceState: Bundle?, rootKey: String?) {
-        setHasOptionsMenu(true)
         setPreferencesFromResource(R.xml.unread_widget_configuration, rootKey)
 
         appWidgetId = arguments?.getInt(ARGUMENT_APP_WIDGET_ID) ?: error("Missing argument '$ARGUMENT_APP_WIDGET_ID'")
@@ -83,6 +85,36 @@ class UnreadWidgetConfigurationFragment : PreferenceFragmentCompat() {
         }
     }
 
+    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
+        super.onViewCreated(view, savedInstanceState)
+        configureMenuHost()
+    }
+
+    private fun configureMenuHost() {
+        val menuHost = requireActivity()
+        menuHost.addMenuProvider(
+            object : MenuProvider {
+                override fun onCreateMenu(menu: Menu, menuInflater: MenuInflater) {
+                    menuInflater.inflate(R.menu.unread_widget_option, menu)
+                }
+
+                override fun onMenuItemSelected(menuItem: MenuItem): Boolean {
+                    return when (menuItem.itemId) {
+                        R.id.done -> {
+                            if (validateWidget()) {
+                                updateWidgetAndExit()
+                            }
+                            true
+                        }
+                        else -> false
+                    }
+                }
+            },
+            viewLifecycleOwner,
+            Lifecycle.State.RESUMED,
+        )
+    }
+
     override fun onSaveInstanceState(outState: Bundle) {
         super.onSaveInstanceState(outState)
         outState.putString(STATE_SELECTED_ACCOUNT_UUID, selectedAccountUuid)
@@ -145,23 +177,6 @@ class UnreadWidgetConfigurationFragment : PreferenceFragmentCompat() {
         unreadFolder.summary = folderDisplayName
     }
 
-    override fun onCreateOptionsMenu(menu: Menu, inflater: MenuInflater) {
-        inflater.inflate(R.menu.unread_widget_option, menu)
-    }
-
-    override fun onOptionsItemSelected(item: MenuItem): Boolean {
-        return when (item.itemId) {
-            R.id.done -> {
-                if (validateWidget()) {
-                    updateWidgetAndExit()
-                }
-                true
-            }
-
-            else -> super.onOptionsItemSelected(item)
-        }
-    }
-
     private fun validateWidget(): Boolean {
         return if (selectedAccountUuid == null) {
             Toast.makeText(requireContext(), R.string.unread_widget_account_not_selected, Toast.LENGTH_LONG).show()

feature/widget/unread/src/main/kotlin/app/k9mail/feature/widget/unread/UnreadWidgetDataProvider.kt

@@ -11,10 +11,13 @@ import com.fsck.k9.activity.MainActivity
 import com.fsck.k9.ui.messagelist.DefaultFolderProvider
 import kotlinx.coroutines.runBlocking
 import net.thunderbird.core.android.account.LegacyAccountDto
-import net.thunderbird.core.logging.legacy.Log
+import net.thunderbird.core.logging.Logger
 import net.thunderbird.feature.search.legacy.LocalMessageSearch
 import net.thunderbird.feature.search.legacy.SearchAccount
 
+private const val TAG = "UnreadWidgetDataProvider"
+
+@Suppress("LongParameterList")
 class UnreadWidgetDataProvider(
     private val context: Context,
     private val preferences: Preferences,
@@ -23,6 +26,7 @@ class UnreadWidgetDataProvider(
     private val folderRepository: FolderRepository,
     private val folderNameFormatter: FolderNameFormatter,
     private val coreResourceProvider: CoreResourceProvider,
+    private val logger: Logger,
 ) {
     fun loadUnreadWidgetData(configuration: UnreadWidgetConfiguration): UnreadWidgetData? = with(configuration) {
         if (SearchAccount.UNIFIED_FOLDERS == accountUuid) {
@@ -87,7 +91,7 @@ class UnreadWidgetDataProvider(
         return if (folder != null) {
             folderNameFormatter.displayName(folder)
         } else {
-            Log.e("Error loading folder for account %s, folder ID: %d", account, folderId)
+            logger.error(TAG) { "Error loading folder for account ${account.id.asRaw()}, folder ID: $folderId" }
             ""
         }
     }

feature/widget/unread/src/main/kotlin/app/k9mail/feature/widget/unread/UnreadWidgetRepository.kt

@@ -2,6 +2,7 @@ package app.k9mail.feature.widget.unread
 
 import android.content.Context
 import android.content.SharedPreferences
+import androidx.core.content.edit
 
 internal class UnreadWidgetRepository(
     private val context: Context,
@@ -11,10 +12,10 @@ internal class UnreadWidgetRepository(
 
     fun saveWidgetConfiguration(configuration: UnreadWidgetConfiguration) {
         val appWidgetId = configuration.appWidgetId
-        val editor = context.getSharedPreferences(PREFS_NAME, Context.MODE_PRIVATE).edit()
-        editor.putString(PREF_PREFIX_KEY + appWidgetId, configuration.accountUuid)
-        editor.putString(PREF_PREFIX_KEY + appWidgetId + PREF_FOLDER_ID_SUFFIX_KEY, configuration.folderId?.toString())
-        editor.apply()
+        context.getSharedPreferences(PREFS_NAME, Context.MODE_PRIVATE).edit {
+            putString(PREF_PREFIX_KEY + appWidgetId, configuration.accountUuid)
+            putString(PREF_PREFIX_KEY + appWidgetId + PREF_FOLDER_ID_SUFFIX_KEY, configuration.folderId?.toString())
+        }
     }
 
     fun getWidgetData(appWidgetId: Int): UnreadWidgetData? {
@@ -42,10 +43,10 @@ internal class UnreadWidgetRepository(
     }
 
     fun deleteWidgetConfiguration(appWidgetId: Int) {
-        val editor = context.getSharedPreferences(PREFS_NAME, Context.MODE_PRIVATE).edit()
-        editor.remove(PREF_PREFIX_KEY + appWidgetId)
-        editor.remove(PREF_PREFIX_KEY + appWidgetId + PREF_FOLDER_ID_SUFFIX_KEY)
-        editor.apply()
+        context.getSharedPreferences(PREFS_NAME, Context.MODE_PRIVATE).edit {
+            remove(PREF_PREFIX_KEY + appWidgetId)
+            remove(PREF_PREFIX_KEY + appWidgetId + PREF_FOLDER_ID_SUFFIX_KEY)
+        }
     }
 
     companion object {

feature/widget/unread/src/main/kotlin/app/k9mail/feature/widget/unread/UnreadWidgetUpdateListener.kt

@@ -3,18 +3,21 @@ package app.k9mail.feature.widget.unread
 import app.k9mail.legacy.message.controller.SimpleMessagingListener
 import com.fsck.k9.mail.Message
 import net.thunderbird.core.android.account.LegacyAccountDto
-import net.thunderbird.core.logging.legacy.Log
+import net.thunderbird.core.logging.Logger
+
+private const val TAG = "UnreadWidgetUpdateListener"
 
 class UnreadWidgetUpdateListener(
     private val unreadWidgetUpdater: UnreadWidgetUpdater,
+    private val logger: Logger,
 ) : SimpleMessagingListener() {
 
     @Suppress("TooGenericExceptionCaught")
     private fun updateUnreadWidget() {
         try {
             unreadWidgetUpdater.updateAll()
         } catch (e: Exception) {
-            Log.e(e, "Error while updating unread widget(s)")
+            logger.error(TAG, e) { "Error while updating unread widget(s)" }
         }
     }
 

feature/widget/unread/src/test/kotlin/app/k9mail/feature/widget/unread/UnreadWidgetDataProviderTest.kt

@@ -13,6 +13,7 @@ import com.fsck.k9.Preferences
 import com.fsck.k9.ui.messagelist.DefaultFolderProvider
 import kotlinx.coroutines.flow.Flow
 import net.thunderbird.core.android.account.LegacyAccountDto
+import net.thunderbird.core.logging.testing.TestLogger
 import net.thunderbird.feature.mail.folder.api.Folder
 import net.thunderbird.feature.mail.folder.api.FolderType
 import net.thunderbird.feature.search.legacy.LocalMessageSearch
@@ -46,6 +47,7 @@ class UnreadWidgetDataProviderTest : AutoCloseKoinTest() {
         folderRepository,
         folderNameFormatter,
         coreResourceProvider,
+        logger = TestLogger(),
     )
 
     @Before