Debug log: turn always on, replace setting with link, note in changelog

Author: UweTrottmann

CHANGELOG.md

@@ -10,6 +10,10 @@ Releases marked with 🧪 (or previously with the "beta" suffix) were released o
 
 ## Version 2025.3
 
+### Next release
+
+* 🔧 Debug log: change to always on, keep messages on app restarts and up to 3 days.
+
 ### 2025.3.2 - 2025-11-06 🧪
 
 * 🔧 If the screen is wide enough, display a more compact bottom navigation bar.

app/src/main/java/com/battlelancer/seriesguide/SgApp.kt

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: Apache-2.0
-// Copyright 2011-2025 Uwe Trottmann
-// Copyright 2013 Andrew Neal
+// SPDX-FileCopyrightText: Copyright © 2011 Uwe Trottmann <[email protected]>
+// SPDX-FileCopyrightText: Copyright © 2013 Andrew Neal
 
 package com.battlelancer.seriesguide
 
@@ -193,10 +193,8 @@ class SgApp : Application() {
             // logcat logging
             Timber.plant(Timber.DebugTree())
         }
-        if (AppSettings.isUserDebugModeEnabled(this)) {
-            // debug log
-            appContainer.debugLogBuffer.enable()
-        }
+        // Enable persistent debug log
+        appContainer.debugLogBuffer.enable()
 
         // Note: Firebase Crashlytics is automatically initialized through its content provider.
         // Pass current enabled state to Crashlytics (e.g. in case app was restored from backup).

app/src/main/java/com/battlelancer/seriesguide/preferences/MoreOptionsActivity.kt

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// Copyright 2020-2025 Uwe Trottmann
+// SPDX-FileCopyrightText: Copyright © 2020 Uwe Trottmann <[email protected]>
 
 package com.battlelancer.seriesguide.preferences
 
@@ -19,8 +19,6 @@ import com.battlelancer.seriesguide.billing.BillingTools
 import com.battlelancer.seriesguide.databinding.ActivityMoreOptionsBinding
 import com.battlelancer.seriesguide.dataliberation.BackupSettings
 import com.battlelancer.seriesguide.dataliberation.DataLiberationActivity
-import com.battlelancer.seriesguide.diagnostics.DebugLogActivity
-import com.battlelancer.seriesguide.settings.AppSettings
 import com.battlelancer.seriesguide.sync.SyncProgress
 import com.battlelancer.seriesguide.traktapi.ConnectTraktActivity
 import com.battlelancer.seriesguide.traktapi.TraktCredentials
@@ -91,9 +89,6 @@ class MoreOptionsActivity : BaseTopActivity() {
             startActivity(getFeedbackEmailIntent(this))
         }
         binding.buttonTranslations.openUriOnClick(getString(R.string.url_translations))
-        binding.buttonDebugLog.setOnClickListener {
-            startActivity(DebugLogActivity.intent(this))
-        }
         binding.buttonDebugView.apply {
             setOnClickListener {
                 DebugViewFragment().safeShow(supportFragmentManager, "debugViewDialog")
@@ -134,9 +129,6 @@ class MoreOptionsActivity : BaseTopActivity() {
 
         // Update supporter status.
         binding.textViewThankYouSupporters.isGone = !BillingTools.hasAccessToPaidFeatures()
-
-        // Show debug log button if debug mode is on.
-        binding.buttonDebugLog.isGone = !AppSettings.isUserDebugModeEnabled(this)
     }
 
 

app/src/main/java/com/battlelancer/seriesguide/preferences/SgPreferencesFragment.kt

@@ -23,11 +23,10 @@ import androidx.preference.ListPreference
 import androidx.preference.Preference
 import androidx.preference.PreferenceManager
 import androidx.preference.SwitchPreferenceCompat
-import com.battlelancer.seriesguide.BuildConfig
 import com.battlelancer.seriesguide.R
 import com.battlelancer.seriesguide.appwidget.ListWidgetProvider
 import com.battlelancer.seriesguide.billing.BillingTools
-import com.battlelancer.seriesguide.getSgAppContainer
+import com.battlelancer.seriesguide.diagnostics.DebugLogActivity
 import com.battlelancer.seriesguide.notifications.NotificationService
 import com.battlelancer.seriesguide.provider.SgRoomDatabase
 import com.battlelancer.seriesguide.settings.AppSettings
@@ -101,11 +100,9 @@ class SgPreferencesFragment : BasePreferencesFragment(),
             }
         }
 
-        if (BuildConfig.DEBUG) {
-            findPreference<SwitchPreferenceCompat>(AppSettings.KEY_USER_DEBUG_MODE_ENABLED)!!.apply {
-                isEnabled = false
-                isChecked = true
-            }
+        findPreference<Preference>(KEY_LINK_DEBUG_LOG)!!.setOnPreferenceClickListener {
+            startActivity(DebugLogActivity.intent(requireActivity()))
+            true
         }
     }
 
@@ -445,17 +442,6 @@ class SgPreferencesFragment : BasePreferencesFragment(),
                 val switchPref = pref as SwitchPreferenceCompat
                 AppSettings.setSendErrorReports(switchPref.context, switchPref.isChecked, false)
             }
-
-            // Enable or disable debug log
-            if (AppSettings.KEY_USER_DEBUG_MODE_ENABLED == key) {
-                val switchPref = pref as SwitchPreferenceCompat
-                val debugLogBuffer = requireActivity().getSgAppContainer().debugLogBuffer
-                if (switchPref.isChecked) {
-                    debugLogBuffer.enable()
-                } else {
-                    debugLogBuffer.disable()
-                }
-            }
         }
 
         // pref changes that require the notification service to be reset
@@ -564,6 +550,7 @@ class SgPreferencesFragment : BasePreferencesFragment(),
 
         // Keys that are not actual preferences, but links
         private const val KEY_LINK_CLEAR_CACHE = "seriesguide.settings.link.clearcache"
+        private const val KEY_LINK_DEBUG_LOG = "seriesguide.settings.link.debuglog"
         private const val KEY_LINK_NOTIFICATION_SETTINGS =
             "seriesguide.settings.link.notifications"
         private const val KEY_LINK_BATTERY_SETTINGS =

app/src/main/java/com/battlelancer/seriesguide/settings/AppSettings.kt

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// Copyright 2013-2025 Uwe Trottmann
+// SPDX-FileCopyrightText: Copyright © 2013 Uwe Trottmann <[email protected]>
 
 package com.battlelancer.seriesguide.settings
 
@@ -17,16 +17,15 @@ object AppSettings {
 
     const val KEY_VERSION = "oldversioncode"
 
-    @Deprecated("")
-    const val KEY_GOOGLEANALYTICS = "enableGAnalytics"
-
-    @Deprecated("")
-    const val KEY_HAS_SEEN_NAV_DRAWER = "hasSeenNavDrawer"
     const val KEY_ASKED_FOR_FEEDBACK = "askedForFeedback"
     const val KEY_SEND_ERROR_REPORTS = "com.battlelancer.seriesguide.sendErrorReports"
-    const val KEY_USER_DEBUG_MODE_ENABLED = "com.battlelancer.seriesguide.userDebugModeEnabled"
     const val KEY_DEMO_MODE_ENABLED = "com.uwetrottmann.seriesguide.demoMode"
 
+    // Previously used keys, don't use them as preferences file might contain values for them
+//    const val KEY_GOOGLEANALYTICS = "enableGAnalytics"
+//    const val KEY_HAS_SEEN_NAV_DRAWER = "hasSeenNavDrawer"
+//    const val KEY_USER_DEBUG_MODE_ENABLED = "com.battlelancer.seriesguide.userDebugModeEnabled"
+
     /**
      * Returns the version code of the previously installed version. Is the current version on fresh
      * installs.
@@ -87,14 +86,15 @@ object AppSettings {
         Errors.getReporter()?.setCrashlyticsCollectionEnabled(isEnabled)
     }
 
+    // Currently not used, but leaving this here for future use.
     /**
      * Returns if debug components for users, which might have a performance impact, should be
      * enabled (for ex. debug log). Always true for debug builds.
      */
-    fun isUserDebugModeEnabled(context: Context): Boolean {
-        return BuildConfig.DEBUG || PreferenceManager.getDefaultSharedPreferences(context)
-            .getBoolean(KEY_USER_DEBUG_MODE_ENABLED, false)
-    }
+//    fun isUserDebugModeEnabled(context: Context): Boolean {
+//        return BuildConfig.DEBUG || PreferenceManager.getDefaultSharedPreferences(context)
+//            .getBoolean(KEY_USER_DEBUG_MODE_ENABLED, false)
+//    }
 
     fun setDemoModeState(context: Context, isEnabled: Boolean) {
         if (!BuildConfig.DEBUG) {

app/src/main/res/layout/activity_more_options.xml

@@ -238,18 +238,6 @@
                     app:layout_constraintStart_toStartOf="parent"
                     app:layout_constraintTop_toBottomOf="@+id/buttonFeedback" />
 
-                <Button
-                    android:id="@+id/buttonDebugLog"
-                    style="@style/Widget.SeriesGuide.Button.Borderless.Sheet"
-                    android:layout_width="0dp"
-                    android:layout_height="48dp"
-                    android:text="@string/title_debug_log"
-                    app:icon="@drawable/ic_extension_black_24dp"
-                    app:iconGravity="start"
-                    app:layout_constraintEnd_toEndOf="parent"
-                    app:layout_constraintStart_toStartOf="parent"
-                    app:layout_constraintTop_toBottomOf="@+id/buttonTranslations" />
-
                 <Button
                     android:id="@+id/buttonDebugView"
                     style="@style/Widget.SeriesGuide.Button.Borderless.Sheet"
@@ -260,7 +248,7 @@
                     app:iconGravity="start"
                     app:layout_constraintEnd_toEndOf="parent"
                     app:layout_constraintStart_toStartOf="parent"
-                    app:layout_constraintTop_toBottomOf="@+id/buttonDebugLog" />
+                    app:layout_constraintTop_toBottomOf="@+id/buttonTranslations" />
 
                 <Button
                     android:id="@+id/buttonMoreWhatsNew"

app/src/main/res/xml/settings_root.xml

@@ -72,11 +72,9 @@
             app:key="com.battlelancer.seriesguide.sendErrorReports"
             app:title="@string/pref_error_reports" />
 
-        <!-- AppSettings -->
-        <SwitchPreferenceCompat
-            app:defaultValue="False"
+        <Preference
             app:iconSpaceReserved="false"
-            app:key="com.battlelancer.seriesguide.userDebugModeEnabled"
+            app:key="seriesguide.settings.link.debuglog"
             app:title="@string/title_debug_log" />
 
     </PreferenceCategory>