Add last breadcrumb id to native report attributes (#98)

Author: konraddysput

backtrace-library/src/androidTest/java/backtraceio/library/BacktraceClientBreadcrumbsTest.java

@@ -1,12 +1,14 @@
 package backtraceio.library;
 
+import static junit.framework.TestCase.assertTrue;
 import static junit.framework.TestCase.fail;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotEquals;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertNull;
 
 import android.content.Context;
+
 import androidx.test.platform.app.InstrumentationRegistry;
 import androidx.test.ext.junit.runners.AndroidJUnit4;
 
@@ -30,6 +32,7 @@
 import backtraceio.library.breadcrumbs.BacktraceBreadcrumbs;
 import backtraceio.library.events.OnServerResponseEventListener;
 import backtraceio.library.events.RequestHandler;
+import backtraceio.library.interfaces.Breadcrumbs;
 import backtraceio.library.models.BacktraceData;
 import backtraceio.library.models.BacktraceResult;
 import backtraceio.library.models.types.BacktraceResultStatus;
@@ -308,6 +311,19 @@ public void onEvent(BacktraceResult backtraceResult) {
         }
     }
 
+    @Test
+    public void verifyBreadcrumbCallbackInvocation() {
+        backtraceClient.enableBreadcrumbs(context);
+        Breadcrumbs breadcrumbs = backtraceClient.database.getBreadcrumbs();
+
+        breadcrumbs.setOnSuccessfulBreadcrumbAddEventListener(breadcrumbId -> {
+            assertEquals(breadcrumbs.getCurrentBreadcrumbId(), breadcrumbId);
+            return;
+        });
+
+        breadcrumbs.addBreadcrumb("test");
+    }
+
     public List<String> readBreadcrumbLogFile() throws IOException {
         BacktraceBreadcrumbs breadcrumbs = new BacktraceBreadcrumbs(context.getFilesDir().getAbsolutePath());
         File breadcrumbLogFile = new File(breadcrumbs.getBreadcrumbLogPath());

backtrace-library/src/main/java/backtraceio/library/BacktraceDatabase.java

@@ -213,6 +213,12 @@ public Boolean setupNativeIntegration(BacktraceBase client, BacktraceCredentials
                 enableClientSideUnwinding,
                 unwindingMode
         );
+
+        if (initialized && this.breadcrumbs.isEnabled()) {
+            this.breadcrumbs.setOnSuccessfulBreadcrumbAddEventListener(breadcrumbId -> {
+                this.addAttribute("breadcrumbs.lastId", Long.toString((breadcrumbId)));
+            });
+        }
         return initialized;
     }
 

backtrace-library/src/main/java/backtraceio/library/breadcrumbs/BacktraceBreadcrumbs.java

@@ -9,6 +9,7 @@
 
 import backtraceio.library.enums.BacktraceBreadcrumbLevel;
 import backtraceio.library.enums.BacktraceBreadcrumbType;
+import backtraceio.library.events.OnSuccessfulBreadcrumbAddEventListener;
 import backtraceio.library.interfaces.Breadcrumbs;
 import backtraceio.library.logger.BacktraceLogger;
 import backtraceio.library.models.json.BacktraceReport;
@@ -17,6 +18,11 @@ public class BacktraceBreadcrumbs implements Breadcrumbs {
 
     private static final transient String LOG_TAG = BacktraceBreadcrumbs.class.getSimpleName();
 
+    /**
+     * Event which will be executed after storing successfully breadcurmbs
+     */
+    private OnSuccessfulBreadcrumbAddEventListener onSuccessfulBreadcrumbAddEventListener = null;
+
     /**
      * Which breadcrumb types are enabled?
      */
@@ -54,6 +60,15 @@ public BacktraceBreadcrumbs(String breadcrumbLogDirectory) {
         this.breadcrumbLogDirectory = breadcrumbLogDirectory;
     }
 
+    /**
+     * Set event executed after adding a breadcrumb to the file
+     *
+     * @param eventListener object with method which will be executed
+     */
+    public void setOnSuccessfulBreadcrumbAddEventListener(OnSuccessfulBreadcrumbAddEventListener eventListener) {
+        this.onSuccessfulBreadcrumbAddEventListener = eventListener;
+    }
+
     private void unregisterAutomaticBreadcrumbReceivers() {
         // Unregister old receivers
         if (backtraceBroadcastReceiver != null) {
@@ -272,10 +287,15 @@ public boolean addBreadcrumb(String message, Map<String, Object> attributes, Bac
      */
     @Override
     public boolean addBreadcrumb(String message, Map<String, Object> attributes, BacktraceBreadcrumbType type, BacktraceBreadcrumbLevel level) {
-        if (this.isBreadcrumbsEnabled() && backtraceBreadcrumbsLogManager != null) {
-            return backtraceBreadcrumbsLogManager.addBreadcrumb(message, attributes, type, level);
+        if (!this.isEnabled() || backtraceBreadcrumbsLogManager == null) {
+            return false;
+        }
+        boolean addResult = backtraceBreadcrumbsLogManager.addBreadcrumb(message, attributes, type, level);
+        if (addResult && this.onSuccessfulBreadcrumbAddEventListener != null) {
+            this.onSuccessfulBreadcrumbAddEventListener.onSuccessfulAdd(this.getCurrentBreadcrumbId());
         }
-        return false;
+
+        return addResult;
     }
 
     /**
@@ -285,7 +305,7 @@ public boolean addBreadcrumb(String message, Map<String, Object> attributes, Bac
      */
     @Override
     public void processReportBreadcrumbs(BacktraceReport backtraceReport) {
-        if (!this.isBreadcrumbsEnabled()) {
+        if (!this.isEnabled()) {
             return;
         }
 
@@ -325,7 +345,11 @@ private boolean addConfigurationBreadcrumb() {
                 BacktraceBreadcrumbLevel.INFO);
     }
 
-    private boolean isBreadcrumbsEnabled() {
+    /**
+     * Determinate if Breadcrumbs are enabled.
+     * @return true if breadcrumbs are enabled.
+     */
+    public boolean isEnabled() {
         return enabledBreadcrumbTypes != null && !enabledBreadcrumbTypes.isEmpty();
     }
 

backtrace-library/src/main/java/backtraceio/library/events/OnSuccessfulBreadcrumbAddEventListener.java

@@ -0,0 +1,13 @@
+package backtraceio.library.events;
+
+/**
+ * Interface definition for a callback to be invoked after successfully storing a new breadcrumb.
+ */
+public interface OnSuccessfulBreadcrumbAddEventListener {
+    /**
+     * Event which will be executed after successfully storing a new breadcrumb.
+     *
+     * @param breadcrumbId the new breadcrumb id.
+     */
+    void onSuccessfulAdd(long breadcrumbId);
+}

backtrace-library/src/main/java/backtraceio/library/interfaces/Breadcrumbs.java

@@ -7,6 +7,7 @@
 
 import backtraceio.library.enums.BacktraceBreadcrumbLevel;
 import backtraceio.library.enums.BacktraceBreadcrumbType;
+import backtraceio.library.events.OnSuccessfulBreadcrumbAddEventListener;
 import backtraceio.library.models.json.BacktraceReport;
 
 public interface Breadcrumbs {
@@ -163,4 +164,28 @@ boolean enableBreadcrumbs(Context context,
      * @param breadcrumbId Will force set the current breadcrumb ID
      */
     void setCurrentBreadcrumbId(long breadcrumbId);
+
+    /**
+     * Get the current breadcrumb ID (exclusive). This is useful when breadcrumbs are queued and
+     * posted to an API because in the meantime before the breadcrumbs are finally posted we might
+     * get more breadcrumbs which are not relevant (because they occur after queueing up the
+     * breadcrumb sender). Therefore it is useful to mark the breadcrumb sender with the most
+     * current breadcrumb ID at the time of queuing up the request to post the breadcrumbs.
+     *
+     * @return current breadcrumb ID (exclusive)
+     */
+    long getCurrentBreadcrumbId();
+
+    /**
+     * Determinate if Breadcrumbs are enabled.
+     * @return true if breadcrumbs are enabled.
+     */
+    boolean isEnabled();
+    
+    /**
+     * Set event executed after adding a breadcrumb to the breadcrumb storage.
+     *
+     * @param eventListener object with method which will be executed.
+     */
+    void setOnSuccessfulBreadcrumbAddEventListener(OnSuccessfulBreadcrumbAddEventListener eventListener);
 }