Added: Add support to send crash notifications if exceptions are caught in TermuxApiReceiver and ResultReturner

agnostic-apollo · agnostic-apollo · commit 6112bf67ba07 · 2022-03-21T22:37:35.000+05:00
This will allow users to know if an exception caused an API command to fail instead of having to check `logcat`. Currently, `Termux:API` app is broken a lot and crash reports from users for edge case exceptions or device specific exceptions will help solve such issues. In future, likely `stderr` will be used instead, once support is added.
diff --git a/app/src/main/java/com/termux/api/TermuxAPIApplication.java b/app/src/main/java/com/termux/api/TermuxAPIApplication.java
@@ -3,6 +3,7 @@
 import android.app.Application;
 import android.content.Context;
 
+import com.termux.api.util.ResultReturner;
 import com.termux.shared.logger.Logger;
 import com.termux.shared.termux.TermuxConstants;
 import com.termux.shared.termux.crash.TermuxCrashUtils;
@@ -16,6 +17,7 @@ public void onCreate() {
 
         // Set crash handler for the app
         TermuxCrashUtils.setCrashHandler(this);
+        ResultReturner.setContext(this);
 
         // Set log config for the app
         setLogConfig(getApplicationContext(), true);
diff --git a/app/src/main/java/com/termux/api/TermuxApiReceiver.java b/app/src/main/java/com/termux/api/TermuxApiReceiver.java
@@ -48,6 +48,8 @@
 import com.termux.api.activities.TermuxApiPermissionActivity;
 import com.termux.shared.data.IntentUtils;
 import com.termux.shared.logger.Logger;
+import com.termux.shared.termux.TermuxConstants;
+import com.termux.shared.termux.crash.TermuxCrashUtils;
 
 public class TermuxApiReceiver extends BroadcastReceiver {
 
@@ -61,9 +63,13 @@ public void onReceive(Context context, Intent intent) {
         try {
             doWork(context, intent);
         } catch (Exception e) {
+            String message = "Error in " + LOG_TAG;
             // Make sure never to throw exception from BroadCastReceiver to avoid "process is bad"
             // behaviour from the Android system.
-            Logger.logStackTraceWithMessage(LOG_TAG, "Error in TermuxApiReceiver", e);
+            Logger.logStackTraceWithMessage(LOG_TAG, message, e);
+
+            TermuxCrashUtils.sendPluginCrashReportNotification(context, LOG_TAG,
+                    TermuxConstants.TERMUX_API_APP_NAME + " Error", message, e);
         }
     }
 
diff --git a/app/src/main/java/com/termux/api/util/ResultReturner.java b/app/src/main/java/com/termux/api/util/ResultReturner.java
@@ -1,16 +1,20 @@
 package com.termux.api.util;
 
+import android.annotation.SuppressLint;
 import android.app.Activity;
 import android.app.IntentService;
 import android.content.BroadcastReceiver;
 import android.content.BroadcastReceiver.PendingResult;
+import android.content.Context;
 import android.content.Intent;
 import android.net.LocalSocket;
 import android.net.LocalSocketAddress;
 import android.os.ParcelFileDescriptor;
 import android.util.JsonWriter;
 
 import com.termux.shared.logger.Logger;
+import com.termux.shared.termux.TermuxConstants;
+import com.termux.shared.termux.crash.TermuxCrashUtils;
 
 import java.io.ByteArrayOutputStream;
 import java.io.FileDescriptor;
@@ -21,6 +25,9 @@
 
 public abstract class ResultReturner {
 
+    @SuppressLint("StaticFieldLeak")
+    private static Context context;
+
     private static final String LOG_TAG = "ResultReturner";
 
     /**
@@ -183,7 +190,12 @@ public static void returnData(Object context, final Intent intent, final ResultW
                     activity.setResult(0);
                 }
             } catch (Exception e) {
-                Logger.logStackTraceWithMessage(LOG_TAG, "Error in ResultReturner", e);
+                String message = "Error in " + LOG_TAG;
+                Logger.logStackTraceWithMessage(LOG_TAG, message, e);
+
+                TermuxCrashUtils.sendPluginCrashReportNotification(ResultReturner.context, LOG_TAG,
+                        TermuxConstants.TERMUX_API_APP_NAME + " Error", message, e);
+
                 if (asyncResult != null) {
                     asyncResult.setResultCode(1);
                 } else if (activity != null) {
@@ -209,4 +221,8 @@ public static void returnData(Object context, final Intent intent, final ResultW
         }
     }
 
+    public static void setContext(Context context) {
+        ResultReturner.context = context.getApplicationContext();
+    }
+
 }
