Merge pull request #2260 from OneSignal/player-model-log-listener

Player model - Add log listener debug feature

Author: jkasten2

Examples/OneSignalDemo/app/src/main/java/com/onesignal/sdktest/application/MainApplication.java

@@ -8,6 +8,8 @@
 import com.onesignal.OSNotification;
 import com.onesignal.OSInAppMessageLifecycleHandler;
 import com.onesignal.OneSignal;
+import com.onesignal.debug.OneSignalLogEvent;
+import com.onesignal.debug.OneSignalLogListener;
 import com.onesignal.sdktest.R;
 import com.onesignal.sdktest.constant.Tag;
 import com.onesignal.sdktest.constant.Text;
@@ -74,4 +76,19 @@ public void onDidDismissInAppMessage(OSInAppMessage message) {
         Log.d(Tag.DEBUG, Text.ONESIGNAL_SDK_INIT);
     }
 
+    private void setupLogListener() {
+        OneSignalLogListener logListener = new OneSignalLogListener() {
+            @Override
+            public void onLogEvent(OneSignalLogEvent event) {
+                // App developer can send these logs to their backend, the
+                // println code here is just to show it works.
+                System.out.println(event.getEntry());
+            }
+        };
+
+        OneSignal.addLogListener(logListener);
+        // Remove can be called if you need to stop collecting logs.
+        // OneSignal.removeLogListener(logListener);
+    }
+
 }

OneSignalSDK/onesignal/src/main/java/com/onesignal/OneSignal.java

@@ -45,6 +45,8 @@
 import androidx.annotation.WorkerThread;
 import androidx.core.app.NotificationCompat;
 
+import com.onesignal.debug.OneSignalLogEvent;
+import com.onesignal.debug.OneSignalLogListener;
 import com.onesignal.influence.data.OSTrackerFactory;
 import com.onesignal.influence.domain.OSInfluence;
 import com.onesignal.language.LanguageContext;
@@ -1332,6 +1334,28 @@ public void run() {
             Log.e(TAG, "Error showing logging message.", t);
          }
       }
+
+      callLogListeners(level, message, throwable);
+   }
+
+   private static void callLogListeners(@NonNull final LOG_LEVEL level, @NonNull String message, @Nullable Throwable throwable) {
+      String logEntry = message;
+      if (throwable != null) {
+         logEntry += "\n" + Log.getStackTraceString(throwable);
+      }
+      for (OneSignalLogListener listener : logListeners) {
+         listener.onLogEvent(new OneSignalLogEvent(level, logEntry));
+      }
+   }
+
+   private static final List<OneSignalLogListener> logListeners = new ArrayList<>();
+
+   public static void addLogListener(@NonNull OneSignalLogListener listener) {
+      logListeners.add(listener);
+   }
+
+   public static void removeLogListener(@NonNull OneSignalLogListener listener) {
+      logListeners.remove(listener);
    }
 
    static void logHttpError(String errorString, int statusCode, Throwable throwable, String errorResponse) {

OneSignalSDK/onesignal/src/main/java/com/onesignal/debug/OneSignalLogEvent.kt

@@ -0,0 +1,8 @@
+package com.onesignal.debug
+
+import com.onesignal.OneSignal
+
+data class OneSignalLogEvent(
+    val level: OneSignal.LOG_LEVEL,
+    val entry: String,
+)

OneSignalSDK/onesignal/src/main/java/com/onesignal/debug/OneSignalLogListener.kt

@@ -0,0 +1,5 @@
+package com.onesignal.debug
+
+interface OneSignalLogListener {
+    fun onLogEvent(event: OneSignalLogEvent)
+}