Add experimental method to trace requests (#1320)

* add experimental method to trace requests

* Update CustomBranchApp.java

* Update ServerRequestQueue.java

* Update gradle.properties

* add request url

* only invoke trace callback for open and install

* clean up

* Update CustomBranchApp.java

* Update CustomBranchApp.java

Author: gdeluna-branch

Branch-SDK-TestBed/src/main/java/io/branch/branchandroidtestbed/CustomBranchApp.java

@@ -7,14 +7,15 @@
 
 import androidx.browser.customtabs.CustomTabsIntent;
 
+import org.json.JSONObject;
+
 import java.io.File;
 import java.io.FileOutputStream;
 import java.io.OutputStreamWriter;
 
-import io.branch.interfaces.IBranchLoggingCallbacks;
 import io.branch.referral.Branch;
 import io.branch.referral.BranchLogger;
-import io.branch.referral.Defines;
+import io.branch.referral.IBranchRequestTracingCallback;
 
 public final class CustomBranchApp extends Application {
     @Override
@@ -32,6 +33,18 @@ public void onCreate() {
                 .setColorScheme(COLOR_SCHEME_DARK)
                 .build();
         Branch.getInstance().setCustomTabsIntent(customTabsIntent);
+        Branch.setCallbackForTracingRequests(new IBranchRequestTracingCallback() {
+            @Override
+            public void onRequestCompleted(String uri, JSONObject request, JSONObject response, String error, String requestUrl) {
+                Log.d("Shortlink_Session_Test",
+                        "URI Sent to Branch: " + uri
+                        + "\nRequest: " + request
+                        + "\nResponse: " + response
+                        + "\nError Message: " + error
+                        + "\nRequest Url: " + requestUrl
+                );
+            }
+        });
     }
 
     private void saveLogToFile(String logMessage) {

Branch-SDK/src/main/java/io/branch/referral/Branch.java

@@ -309,6 +309,8 @@ enum INTENT_STATE {
     private Uri deferredUri;
     private InitSessionBuilder deferredSessionBuilder;
 
+    private static IBranchRequestTracingCallback _iBranchRequestTracingCallback;
+
     /**
      * <p>The main constructor of the Branch class is private because the class uses the Singleton
      * pattern.</p>
@@ -2821,4 +2823,12 @@ private void launchExternalBrowser(String url) {
             BranchLogger.e("launchExternalBrowser caught exception: " + ex);
         }
     }
+
+    public static void setCallbackForTracingRequests(IBranchRequestTracingCallback iBranchRequestTracingCallback){
+        _iBranchRequestTracingCallback = iBranchRequestTracingCallback;
+    }
+
+    public static IBranchRequestTracingCallback getCallbackForTracingRequests(){
+        return _iBranchRequestTracingCallback;
+    }
 }

Branch-SDK/src/main/java/io/branch/referral/IBranchRequestTracingCallback.java

@@ -0,0 +1,7 @@
+package io.branch.referral;
+
+import org.json.JSONObject;
+
+public interface IBranchRequestTracingCallback {
+    void onRequestCompleted(String uri, JSONObject request, JSONObject response, String error, String requestUrl);
+}

Branch-SDK/src/main/java/io/branch/referral/ServerRequestQueue.java

@@ -578,7 +578,32 @@ protected void onPostExecute(ServerResponse serverResponse) {
         }
 
         void onPostExecuteInner(ServerResponse serverResponse) {
-            BranchLogger.v("onPostExecuteInner " + this + " " + serverResponse);
+            try {
+                // For the time being, execute the callback only for init requests
+                BranchLogger.v("onPostExecuteInner " + thisReq_);
+                if (Branch.getCallbackForTracingRequests() != null && (thisReq_ instanceof ServerRequestInitSession)) {
+                    String uri = "";
+
+                    if(thisReq_.getPost().has(Defines.Jsonkey.External_Intent_URI.getKey())){
+                        uri = thisReq_.getPost().getString(Defines.Jsonkey.External_Intent_URI.getKey());
+                    }
+
+                    JSONObject requestJson = thisReq_.getPost();
+                    JSONObject requestResponse = serverResponse.getObject();
+
+                    String error = "";
+
+                    if (serverResponse.getStatusCode() != 200) {
+                        error = (new BranchError(serverResponse.getMessage(), serverResponse.getStatusCode())).toString();
+                    }
+
+                    Branch.getCallbackForTracingRequests().onRequestCompleted(uri, requestJson, requestResponse, error, thisReq_.getRequestUrl());
+                }
+            }
+            catch (Exception exception){
+                BranchLogger.e("Failed to invoke tracing request callback:" + exception.getMessage());
+            }
+
             if (latch_ != null) {
                 latch_.countDown();
             }