Fixed: Manually add stack trace of caller function that called ResultReturner.returnData() to exception messages as exceptions thrown inside Runnable lambda thread will not include it by default

agnostic-apollo · agnostic-apollo · commit 922f35858141 · 2025-05-22T17:03:22.000+05:00
For example, exceptions like following don't tell which API call failed and where.

```
Error in ResultReturner:
java.io.IOException: Connection refused
	at android.net.LocalSocketImpl.connectLocal(Native Method)
	at android.net.LocalSocketImpl.connect(LocalSocketImpl.java:259)
	at android.net.LocalSocket.connect(LocalSocket.java:162)
	at com.termux.api.util.ResultReturner.lambda$returnData$0(ResultReturner.java:244)
	at com.termux.api.util.ResultReturner$$ExternalSyntheticLambda0.run(D8$$SyntheticClass:0)
	at java.lang.Thread.run(Thread.java:1119)
```

Now it will be something like this

```
Error in ResultReturner:
java.io.IOException: Connection refused
	at android.net.LocalSocketImpl.connectLocal(Native Method)
	at android.net.LocalSocketImpl.connect(LocalSocketImpl.java:259)
	at android.net.LocalSocket.connect(LocalSocket.java:162)
	at com.termux.api.util.ResultReturner.lambda$returnData$0(ResultReturner.java:244)
	at com.termux.api.util.ResultReturner$$ExternalSyntheticLambda0.run(D8$$SyntheticClass:0)
	at java.lang.Thread.run(Thread.java:1119)
	Suppressed: java.lang.Exception: Called by:
		at com.termux.api.util.ResultReturner.returnData(ResultReturner.java:234)
		at com.termux.api.apis.BatteryStatusAPI.onReceive(BatteryStatusAPI.java:27)
		at com.termux.api.TermuxApiReceiver.doWork(TermuxApiReceiver.java:91)
		at com.termux.api.TermuxApiReceiver.onReceive(TermuxApiReceiver.java:65)
		at android.app.ActivityThread.handleReceiver(ActivityThread.java:5029)
		at android.app.ActivityThread.-$$Nest$mhandleReceiver(Unknown Source:0)
		at android.app.ActivityThread$H.handleMessage(ActivityThread.java:2577)
		at android.os.Handler.dispatchMessage(Handler.java:110)
		at android.os.Looper.loopOnce(Looper.java:248)
		at android.os.Looper.loop(Looper.java:338)
		at android.app.ActivityThread.main(ActivityThread.java:9067)
		at java.lang.reflect.Method.invoke(Native Method)
		at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:593)
		at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:932)
```
diff --git a/app/src/main/java/com/termux/api/util/ResultReturner.java b/app/src/main/java/com/termux/api/util/ResultReturner.java
@@ -223,6 +223,10 @@ public static LocalSocketAddress getApiLocalSocketAddress(@NonNull Context conte
         }
     }
 
+    public static boolean shouldRunThreadForResultRunnable(Object context) {
+        return !(context instanceof IntentService);
+    }
+
     /**
      * Run in a separate thread, unless the context is an IntentService.
      */
@@ -231,6 +235,10 @@ public static void returnData(Object context, final Intent intent, final ResultW
         final Activity activity = (Activity) ((context instanceof Activity) ? context : null);
         final PendingResult asyncResult = receiver != null ? receiver.goAsync() : null;
 
+        // Store caller function stack trace to add to exception messages thrown inside `Runnable`
+        // lambda in case its run in a thread as it will not be included by default.
+        final Throwable callerStackTrace = shouldRunThreadForResultRunnable(context) ? new Exception("Called by:") : null;
+
         final Runnable runnable = () -> {
             PrintWriter writer = null;
             LocalSocket outputSocket = null;
@@ -276,6 +284,8 @@ public static void returnData(Object context, final Intent intent, final ResultW
                 }
             } catch (Throwable t) {
                 String message = "Error in " + LOG_TAG;
+                if (callerStackTrace != null)
+                    t.addSuppressed(callerStackTrace);
                 Logger.logStackTraceWithMessage(LOG_TAG, message, t);
 
                 TermuxPluginUtils.sendPluginCommandErrorNotification(ResultReturner.context, LOG_TAG,
@@ -308,11 +318,11 @@ public static void returnData(Object context, final Intent intent, final ResultW
             }
         };
 
-        if (context instanceof IntentService) {
-            runnable.run();
-        } else {
+        if (shouldRunThreadForResultRunnable(context)) {
             new Thread(runnable).start();
-        }
+        } else {
+            runnable.run();
+       }
     }
 
     public static void setContext(Context context) {
