-
-
Notifications
You must be signed in to change notification settings - Fork 4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement crash handler and reporting
Now whenever the Termux app crashes, the crash report (stacktrace, app and device info) will be logged to ~/crash_log.md file. When the user will reopen the app, a notification will be shown which when clicked will show the crash report content in the ReportActivity. The activity will have important links like email, reddit, github issues of termux app and packages at which the user can optionally report an issue if necessary after copying the crash report text. The ~/crash_log.md file will be moved to ~/crash_log-backup.md so that a notification is not shown again on next startup and can be viewed again via SAF, etc. This will allow reports for bugs that are submitted to have complete and useful info, specially in markdown format, making lives of devs a tad bit easier. Also more bugs that are rare might be submitted since users will have the info to report with and know where to report at. ToDo: - The TermuxConstants.TERMUX_SUPPORT_EMAIL_URL needs to be updated with a valid support email once its set up. The TermuxUtils.getReportIssueMarkdownString() function currently also has "email" lines commented out which will need to be uncommented. - Currently, crashes will only be handled for the main app thread, other threads will have to manually hooked into where necessary.
- Loading branch information
1 parent
07e6ecd
commit 69e4b57
Showing
12 changed files
with
329 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| package com.termux.app.crash; | ||
|
|
||
| import android.content.Context; | ||
|
|
||
| import androidx.annotation.NonNull; | ||
|
|
||
| /** | ||
| * Catches uncaught exceptions and logs them. | ||
| */ | ||
| public class CrashHandler implements Thread.UncaughtExceptionHandler { | ||
|
|
||
| private final Context context; | ||
| private final Thread.UncaughtExceptionHandler defaultUEH; | ||
|
|
||
| private CrashHandler(final Context context) { | ||
| this.context = context; | ||
| this.defaultUEH = Thread.getDefaultUncaughtExceptionHandler(); | ||
| } | ||
|
|
||
| public void uncaughtException(@NonNull Thread thread, @NonNull Throwable throwable) { | ||
| CrashUtils.logCrash(context,thread, throwable); | ||
| defaultUEH.uncaughtException(thread, throwable); | ||
| } | ||
|
|
||
| /** | ||
| * Set default uncaught crash handler of current thread to {@link CrashHandler}. | ||
| */ | ||
| public static void setCrashHandler(final Context context) { | ||
| if(!(Thread.getDefaultUncaughtExceptionHandler() instanceof CrashHandler)) { | ||
| Thread.setDefaultUncaughtExceptionHandler(new CrashHandler(context)); | ||
| } | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,189 @@ | ||
| package com.termux.app.crash; | ||
|
|
||
| import android.app.Notification; | ||
| import android.app.NotificationManager; | ||
| import android.app.PendingIntent; | ||
| import android.content.Context; | ||
| import android.content.Intent; | ||
|
|
||
| import androidx.annotation.Nullable; | ||
|
|
||
| import com.termux.R; | ||
| import com.termux.app.activities.ReportActivity; | ||
| import com.termux.app.file.FileUtils; | ||
| import com.termux.app.models.ReportInfo; | ||
| import com.termux.app.models.UserAction; | ||
| import com.termux.app.settings.preferences.TermuxAppSharedPreferences; | ||
| import com.termux.app.settings.preferences.TermuxPreferenceConstants; | ||
| import com.termux.app.utils.DataUtils; | ||
| import com.termux.app.utils.Logger; | ||
| import com.termux.app.utils.MarkdownUtils; | ||
| import com.termux.app.utils.NotificationUtils; | ||
| import com.termux.app.utils.TermuxUtils; | ||
|
|
||
| import com.termux.app.TermuxConstants; | ||
|
|
||
| import java.nio.charset.Charset; | ||
|
|
||
| public class CrashUtils { | ||
|
|
||
| private static final String NOTIFICATION_CHANNEL_ID_CRASH_REPORT_ERRORS = "termux_crash_reports_notification_channel"; | ||
| private static final String NOTIFICATION_CHANNEL_NAME_CRASH_REPORT_ERRORS = TermuxConstants.TERMUX_APP_NAME + " Crash Reports"; | ||
|
|
||
| private static final String LOG_TAG = "CrashUtils"; | ||
|
|
||
| /** | ||
| * Log a crash in the crash log file at | ||
| * {@link TermuxConstants#TERMUX_CRASH_LOG_FILE_PATH}. | ||
| * | ||
| * @param context The {@link Context} for operations. | ||
| * @param thread The {@link Thread} in which the crash happened. | ||
| * @param thread The {@link Throwable} thrown for the crash. | ||
| */ | ||
| public static void logCrash(final Context context, final Thread thread, final Throwable throwable) { | ||
|
|
||
| StringBuilder reportString = new StringBuilder(); | ||
|
|
||
| reportString.append("## Crash Details\n"); | ||
| reportString.append("\n").append(MarkdownUtils.getSingleLineMarkdownStringEntry("Crash Thread", thread.toString(), "-")); | ||
| reportString.append("\n").append(MarkdownUtils.getSingleLineMarkdownStringEntry("Crash Timestamp", TermuxUtils.getCurrentTimeStamp(), "-")); | ||
|
|
||
| reportString.append("\n\n").append(Logger.getStackTracesMarkdownString("Stacktrace", Logger.getStackTraceStringArray(throwable))); | ||
| reportString.append("\n\n").append(TermuxUtils.getAppInfoMarkdownString(context, true)); | ||
| reportString.append("\n\n").append(TermuxUtils.getDeviceInfoMarkdownString(context)); | ||
|
|
||
| // Log report string to logcat | ||
| Logger.logError(reportString.toString()); | ||
|
|
||
| // Write report string to crash log file | ||
| String errmsg = FileUtils.writeStringToFile(context, "crash log", TermuxConstants.TERMUX_CRASH_LOG_FILE_PATH, Charset.defaultCharset(), reportString.toString(), false); | ||
| if(errmsg != null) { | ||
| Logger.logError(LOG_TAG, errmsg); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Notify the user of a previous app crash by reading the crash info from the crash log file at | ||
| * {@link TermuxConstants#TERMUX_CRASH_LOG_FILE_PATH}. | ||
| * | ||
| * If the crash log file exists and is not empty and | ||
| * {@link TermuxPreferenceConstants.TERMUX_APP#KEY_CRASH_REPORT_NOTIFICATIONS_ENABLED} is | ||
| * enabled, then a notification will be shown for the crash on the | ||
| * {@link #NOTIFICATION_CHANNEL_NAME_CRASH_REPORT_ERRORS} channel, otherwise nothing will be done. | ||
| * | ||
| * After reading from the crash log file, it will be moved to {@link TermuxConstants#TERMUX_CRASH_LOG_BACKUP_FILE_PATH}. | ||
| * | ||
| * @param context The {@link Context} for operations. | ||
| * @param logTagParam The log tag to use for logging. | ||
| */ | ||
| public static void notifyCrash(final Context context, final String logTagParam) { | ||
| if(context == null) return; | ||
|
|
||
|
|
||
| TermuxAppSharedPreferences preferences = new TermuxAppSharedPreferences(context); | ||
| // If user has disabled notifications for crashes | ||
| if (!preferences.getCrashReportNotificationsEnabled()) | ||
| return; | ||
|
|
||
| new Thread() { | ||
| @Override | ||
| public void run() { | ||
| String logTag = DataUtils.getDefaultIfNull(logTagParam, LOG_TAG); | ||
|
|
||
| if(!FileUtils.regularFileExists(TermuxConstants.TERMUX_CRASH_LOG_FILE_PATH, false)) | ||
| return; | ||
|
|
||
| String errmsg; | ||
| StringBuilder reportStringBuilder = new StringBuilder(); | ||
|
|
||
| // Read report string from crash log file | ||
| errmsg = FileUtils.readStringFromFile(context, "crash log", TermuxConstants.TERMUX_CRASH_LOG_FILE_PATH, Charset.defaultCharset(), reportStringBuilder, false); | ||
| if(errmsg != null) { | ||
| Logger.logError(logTag, errmsg); | ||
| return; | ||
| } | ||
|
|
||
| // Move crash log file to backup location if it exists | ||
| FileUtils.moveRegularFile(context, "crash log", TermuxConstants.TERMUX_CRASH_LOG_FILE_PATH, TermuxConstants.TERMUX_CRASH_LOG_BACKUP_FILE_PATH, true); | ||
| if(errmsg != null) { | ||
| Logger.logError(logTag, errmsg); | ||
| } | ||
|
|
||
| String reportString = reportStringBuilder.toString(); | ||
|
|
||
| if(reportString == null || reportString.isEmpty()) | ||
| return; | ||
|
|
||
| // Send a notification to show the crash log which when clicked will open the {@link ReportActivity} | ||
| // to show the details of the crash | ||
| String title = TermuxConstants.TERMUX_APP_NAME + " Crash Report"; | ||
|
|
||
| Logger.logDebug(logTag, "The crash log file at \"" + TermuxConstants.TERMUX_CRASH_LOG_FILE_PATH + "\" found. Sending \"" + title + "\" notification."); | ||
|
|
||
| Intent notificationIntent = ReportActivity.newInstance(context, new ReportInfo(UserAction.CRASH_REPORT, logTag, title, null, reportString, "\n\n" + TermuxUtils.getReportIssueMarkdownString(context), true)); | ||
| PendingIntent pendingIntent = PendingIntent.getActivity(context, 0, notificationIntent, PendingIntent.FLAG_UPDATE_CURRENT); | ||
|
|
||
| // Setup the notification channel if not already set up | ||
| setupCrashReportsNotificationChannel(context); | ||
|
|
||
| // Build the notification | ||
| Notification.Builder builder = getCrashReportsNotificationBuilder(context, title, null, null, pendingIntent, NotificationUtils.NOTIFICATION_MODE_VIBRATE); | ||
| if(builder == null) return; | ||
|
|
||
| // Send the notification | ||
| int nextNotificationId = NotificationUtils.getNextNotificationId(context); | ||
| NotificationManager notificationManager = NotificationUtils.getNotificationManager(context); | ||
| if(notificationManager != null) | ||
| notificationManager.notify(nextNotificationId, builder.build()); | ||
| } | ||
| }.start(); | ||
| } | ||
|
|
||
| /** | ||
| * Get {@link Notification.Builder} for {@link #NOTIFICATION_CHANNEL_ID_CRASH_REPORT_ERRORS} | ||
| * and {@link #NOTIFICATION_CHANNEL_NAME_CRASH_REPORT_ERRORS}. | ||
| * | ||
| * @param context The {@link Context} for operations. | ||
| * @param title The title for the notification. | ||
| * @param notifiationText The second line text of the notification. | ||
| * @param notificationBigText The full text of the notification that may optionally be styled. | ||
| * @param pendingIntent The {@link PendingIntent} which should be sent when notification is clicked. | ||
| * @param notificationMode The notification mode. It must be one of {@code NotificationUtils.NOTIFICATION_MODE_*}. | ||
| * @return Returns the {@link Notification.Builder}. | ||
| */ | ||
| @Nullable | ||
| public static Notification.Builder getCrashReportsNotificationBuilder(final Context context, final CharSequence title, final CharSequence notifiationText, final CharSequence notificationBigText, final PendingIntent pendingIntent, final int notificationMode) { | ||
|
|
||
| Notification.Builder builder = NotificationUtils.geNotificationBuilder(context, | ||
| NOTIFICATION_CHANNEL_ID_CRASH_REPORT_ERRORS, Notification.PRIORITY_HIGH, | ||
| title, notifiationText, notificationBigText, pendingIntent, notificationMode); | ||
|
|
||
| if(builder == null) return null; | ||
|
|
||
| // Enable timestamp | ||
| builder.setShowWhen(true); | ||
|
|
||
| // Set notification icon | ||
| builder.setSmallIcon(R.drawable.ic_error_notification); | ||
|
|
||
| // Set background color for small notification icon | ||
| builder.setColor(0xFF607D8B); | ||
|
|
||
| // Dismiss on click | ||
| builder.setAutoCancel(true); | ||
|
|
||
| return builder; | ||
| } | ||
|
|
||
| /** | ||
| * Setup the notification channel for {@link #NOTIFICATION_CHANNEL_ID_CRASH_REPORT_ERRORS} and | ||
| * {@link #NOTIFICATION_CHANNEL_NAME_CRASH_REPORT_ERRORS}. | ||
| * | ||
| * @param context The {@link Context} for operations. | ||
| */ | ||
| public static void setupCrashReportsNotificationChannel(final Context context) { | ||
| NotificationUtils.setupNotificationChannel(context, NOTIFICATION_CHANNEL_ID_CRASH_REPORT_ERRORS, | ||
| NOTIFICATION_CHANNEL_NAME_CRASH_REPORT_ERRORS, NotificationManager.IMPORTANCE_HIGH); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.