MarcoBuster/Gadgetbridge
1
0
Fork 0
mirror of https://codeberg.org/Freeyourgadget/Gadgetbridge synced 2024-12-27 02:55:50 +01:00
Code Releases Wiki Activity

Show notification on crash for debug builds

Browse Source
This commit is contained in:
José Rebelo 2024-09-29 13:44:40 +01:00
parent d4a451e8c8
commit 19f04e1867
5 changed files with 136 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
app/src/main/java/nodomain/freeyourgadget/gadgetbridge/GBApplication.java
View File

@ -127,7 +127,7 @@ public class GBApplication extends Application {
private static SharedPreferences sharedPrefs;
private static final String PREFS_VERSION = "shared_preferences_version";
//if preferences have to be migrated, increment the following and add the migration logic in migratePrefs below; see http://stackoverflow.com/questions/16397848/how-can-i-migrate-android-preferences-with-a-new-version
private static final int CURRENT_PREFS_VERSION = 41;
private static final int CURRENT_PREFS_VERSION = 42;
private static final LimitedQueue<Integer, String> mIDSenderLookup = new LimitedQueue<>(16);
private static GBPrefs prefs;
@ -245,7 +245,7 @@ public class GBApplication extends Application {
// the devicetype.json file
//migrateDeviceTypes();
setupExceptionHandler();
setupExceptionHandler(prefs.getBoolean("crash_notification", isDebug()));
Weather.getInstance().setCacheFile(getCacheDir(), prefs.getBoolean("cache_weather", true));
@ -275,7 +275,7 @@ public class GBApplication extends Application {
}
GB.notify(NOTIFICATION_ID_ERROR,
new NotificationCompat.Builder(this, NOTIFICATION_CHANNEL_HIGH_PRIORITY_ID)
.setSmallIcon(R.drawable.gadgetbridge_img)
.setSmallIcon(R.drawable.ic_notification)
.setContentTitle(getString(R.string.error_background_service))
.setContentText(getString(R.string.error_background_service_reason_truncated))
.setStyle(new NotificationCompat.BigTextStyle()
@ -319,8 +319,8 @@ public class GBApplication extends Application {
return logging.getLogPath();
}
private void setupExceptionHandler() {
LoggingExceptionHandler handler = new LoggingExceptionHandler(Thread.getDefaultUncaughtExceptionHandler());
private void setupExceptionHandler(final boolean notifyOnCrash) {
final GBExceptionHandler handler = new GBExceptionHandler(Thread.getDefaultUncaughtExceptionHandler(), notifyOnCrash);
Thread.setDefaultUncaughtExceptionHandler(handler);
}
@ -1831,6 +1831,13 @@ public class GBApplication extends Application {
}
}
if (oldVersion < 42) {
// Enable crash notification by default on debug builds
if (!prefs.contains("crash_notification")) {
editor.putBoolean("crash_notification", isDebug());
}
}
editor.putString(PREFS_VERSION, Integer.toString(CURRENT_PREFS_VERSION));
editor.apply();
}
@ -1953,6 +1960,7 @@ public class GBApplication extends Application {
}
public static boolean isNightly() {
//noinspection ConstantValue - false positive
return BuildConfig.APPLICATION_ID.contains("nightly");
}

103
app/src/main/java/nodomain/freeyourgadget/gadgetbridge/GBExceptionHandler.java Normal file
View File

@ -0,0 +1,103 @@
/* Copyright (C) 2015-2024 Carsten Pfeiffer, José Rebelo
This file is part of Gadgetbridge.
Gadgetbridge is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Gadgetbridge is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>. */
package nodomain.freeyourgadget.gadgetbridge;
import static nodomain.freeyourgadget.gadgetbridge.util.GB.NOTIFICATION_CHANNEL_HIGH_PRIORITY_ID;
import static nodomain.freeyourgadget.gadgetbridge.util.GB.NOTIFICATION_ID_ERROR;
import android.app.Notification;
import android.app.PendingIntent;
import android.content.Context;
import android.content.Intent;
import android.util.Log;
import androidx.annotation.NonNull;
import androidx.core.app.NotificationCompat;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.Random;
import ch.qos.logback.classic.LoggerContext;
import nodomain.freeyourgadget.gadgetbridge.util.GB;
import nodomain.freeyourgadget.gadgetbridge.util.PendingIntentUtils;
/**
* Catches otherwise uncaught exceptions, logs them and terminates the app.
*/
public class GBExceptionHandler implements Thread.UncaughtExceptionHandler {
private static final Logger LOG = LoggerFactory.getLogger(GBExceptionHandler.class);
private final Thread.UncaughtExceptionHandler mDelegate;
private final boolean mNotifyOnCrash;
public GBExceptionHandler(Thread.UncaughtExceptionHandler delegate, final boolean notifyOnCrash) {
mDelegate = delegate;
mNotifyOnCrash = notifyOnCrash;
}
@Override
public void uncaughtException(@NonNull Thread thread, @NonNull Throwable ex) {
LOG.error("Uncaught exception", ex);
// flush the log buffers and stop logging
LoggerContext loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory();
loggerContext.stop();
if (mNotifyOnCrash) {
showNotification(ex);
}
if (mDelegate != null) {
mDelegate.uncaughtException(thread, ex);
} else {
System.exit(1);
}
}
private void showNotification(final Throwable e) {
final Context context = GBApplication.getContext();
final Intent shareIntent = new Intent();
shareIntent.setAction(Intent.ACTION_SEND);
shareIntent.putExtra(Intent.EXTRA_TEXT, Log.getStackTraceString(e));
shareIntent.setType("text/plain");
final PendingIntent pendingShareIntent = PendingIntentUtils.getActivity(
context,
0,
Intent.createChooser(shareIntent, context.getString(R.string.app_crash_share_stacktrace)),
PendingIntent.FLAG_UPDATE_CURRENT,
false
);
final NotificationCompat.Action shareAction = new NotificationCompat.Action.Builder(android.R.drawable.ic_menu_share, context.getString(R.string.share), pendingShareIntent).build();
final Notification notification = new NotificationCompat.Builder(context, NOTIFICATION_CHANNEL_HIGH_PRIORITY_ID)
.setSmallIcon(R.drawable.ic_notification)
.setContentTitle(context.getString(
R.string.app_crash_notification_title,
context.getString(R.string.app_name)
))
.setContentText(e.getLocalizedMessage())
.setPriority(NotificationCompat.PRIORITY_DEFAULT)
.addAction(shareAction)
.build();
GB.notify(NOTIFICATION_ID_ERROR, notification, context);
}
}

49
app/src/main/java/nodomain/freeyourgadget/gadgetbridge/LoggingExceptionHandler.java
View File

@ -1,49 +0,0 @@
/* Copyright (C) 2015-2024 Carsten Pfeiffer
This file is part of Gadgetbridge.
Gadgetbridge is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Gadgetbridge is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>. */
package nodomain.freeyourgadget.gadgetbridge;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ch.qos.logback.classic.LoggerContext;
/**
* Catches otherwise uncaught exceptions, logs them and terminates the app.
*/
public class LoggingExceptionHandler implements Thread.UncaughtExceptionHandler {
private static final Logger LOG = LoggerFactory.getLogger(LoggingExceptionHandler.class);
private final Thread.UncaughtExceptionHandler mDelegate;
public LoggingExceptionHandler(Thread.UncaughtExceptionHandler delegate) {
mDelegate = delegate;
}
@Override
public void uncaughtException(Thread thread, Throwable ex) {
LOG.error("Uncaught exception: " + ex.getMessage(), ex);
// flush the log buffers and stop logging
LoggerContext loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory();
loggerContext.stop();
if (mDelegate != null) {
mDelegate.uncaughtException(thread, ex);
} else {
System.exit(1);
}
}
}

4
app/src/main/res/values/strings.xml
View File

@ -2113,6 +2113,10 @@
<string name="error_background_service">Failed to start background service</string>
<string name="error_background_service_reason_truncated">Starting the background service failed because…</string>
<string name="pref_crash_notification_title">Notify on crash</string>
<string name="pref_crash_notification_summary">When the app crashes, display a notification with the error</string>
<string name="app_crash_notification_title">%1s has crashed</string>
<string name="app_crash_share_stacktrace">Share error</string>
<string name="device_is_currently_bonded">ALREADY BONDED</string>
<string name="device_requires_key">KEY REQUIRED, LONG PRESS TO ENTER</string>
<string name="device_unsupported">UNSUPPORTED</string>

7
app/src/main/res/xml/preferences.xml
View File

@ -364,6 +364,13 @@
android:layout="@layout/preference_checkbox"
android:title="@string/pref_write_logfiles"
app:iconSpaceReserved="false" />
<SwitchPreferenceCompat
android:defaultValue="false"
android:key="crash_notification"
android:layout="@layout/preference_checkbox"
android:summary="@string/pref_crash_notification_summary"
android:title="@string/pref_crash_notification_title"
app:iconSpaceReserved="false" />
<SwitchPreferenceCompat
android:defaultValue="true"
android:key="permission_pestering"