Merge pull request #641 from Instabug/update/support-graphQL

[MOB-6124] GraphQL Support

Author: Ali Abdelfattah

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## master
 
+* Adds GraphQL support for APM network traces with proper grouping
 * Adds APM.endAppLaunch API
 * Fixes an issue with iOS sourcemap upload that causes the build to fail
 

__tests__/apm.spec.js

@@ -4,7 +4,7 @@
  */
 
 import "react-native";
-import { NativeModules } from "react-native";
+import { NativeModules, Platform } from "react-native";
 import "../jest/mockAPM";
 import APM from "../modules/APM";
 import sinon from "sinon";
@@ -22,6 +22,8 @@ describe("APM Module", () => {
   const startUITrace = sinon.spy(NativeModules.IBGAPM, "startUITrace");
   const endUITrace = sinon.spy(NativeModules.IBGAPM, "endUITrace");
   const endAppLaunch = sinon.spy(NativeModules.IBGAPM, "endAppLaunch");
+  const setNetworkLoggingEnabled = sinon.spy(NativeModules.Instabug, "setNetworkLoggingEnabled");
+  const _ibgSleep = sinon.spy(NativeModules.IBGAPM, "ibgSleep");
 
   beforeEach(() => {
     IBGEventEmitter.removeAllListeners();
@@ -39,6 +41,13 @@ describe("APM Module", () => {
     expect(setAppLaunchEnabled.calledOnceWithExactly(true)).toBe(true);
   });
 
+  it("should call the native method setNetworkEnabledIOS", () => {
+    Platform.OS = 'ios';
+    APM.setNetworkEnabledIOS(true);
+
+    expect(setNetworkLoggingEnabled.calledOnceWithExactly(true)).toBe(true);
+  });
+
   it("should call the native method endAppLaunch", () => {
     APM.endAppLaunch();
 
@@ -56,27 +65,27 @@ describe("APM Module", () => {
 
     expect(setLogLevel.calledOnceWithExactly(APM.logLevel.verbose)).toBe(true);
   });
-  
+
   it("should call the native method startExecutionTrace", () => {
     APM.startExecutionTrace("trace");
-    
+
     expect(startExecutionTrace.calledOnceWith("trace")).toBe(true);
   });
-    
+
   it("should call the native method setExecutionTraceAttribute", () => {
     const trace = APM.startExecutionTrace("trace").then(() => {
       trace.setAttribute("key", "value");
       expect(setExecutionTraceAttribute.calledOnceWithExactly(expect.any(String), "key", "value")).toBe(true);
     });
   });
-    
+
   it("should call the native method endExecutionTrace", () => {
     const trace = APM.startExecutionTrace("trace").then(() => {
       trace.end();
       expect(endExecutionTrace.calledOnceWithExactly(expect.any(String))).toBe(true);
     });
   });
-    
+
   it("should call the native method startUITrace", () => {
     APM.startUITrace("uiTrace");
 
@@ -88,4 +97,10 @@ describe("APM Module", () => {
 
     expect(endUITrace.calledOnceWithExactly()).toBe(true);
   });
+
+  it("should call the native method _ibgSleep", () => {
+    APM._ibgSleep();
+
+    expect(_ibgSleep.calledOnceWithExactly()).toBe(true);
+  });
 });

__tests__/networkLogger.spec.js

@@ -19,6 +19,9 @@ jest.mock('NativeModules', () => {
             networkLog: jest.fn(),
             addListener: jest.fn()
         },
+        IBGAPM: {
+            networkLog: jest.fn(),
+        },
     };
 });
 
@@ -33,6 +36,8 @@ describe('NetworkLogger Module', () => {
     const enableInterception = sinon.spy(Interceptor, 'enableInterception');
     const disableInterception = sinon.spy(Interceptor, 'disableInterception');
     const networkLog = sinon.spy(NativeModules.Instabug, 'networkLog');
+    const apmNetworkLog = sinon.spy(NativeModules.IBGAPM, 'networkLog');
+    const apolloLinkRequestHandler = sinon.spy(NetworkLogger, 'apolloLinkRequestHandler')
 
     const network = {
         url: 'https://api.instabug.com',
@@ -53,6 +58,8 @@ describe('NetworkLogger Module', () => {
         networkLog.resetHistory();
         IBGEventEmitter.removeAllListeners();
         NetworkLogger.setNetworkDataObfuscationHandler(null);
+        apmNetworkLog.resetHistory();
+        apolloLinkRequestHandler.resetHistory();
     });
 
     it('should set onProgressCallback with callback', () => {
@@ -98,7 +105,7 @@ describe('NetworkLogger Module', () => {
         NetworkLogger.setEnabled(true);
 
         expect(networkLog.calledOnceWithExactly(JSON.stringify(network))).toBe(true);
-
+        expect(apmNetworkLog.calledOnceWithExactly(JSON.stringify(network))).toBe(true);
     });
 
     it('should send log network when setNetworkDataObfuscationHandler is set and Platform is ios', async () => {
@@ -137,6 +144,7 @@ describe('NetworkLogger Module', () => {
             const newData = clone(network);
             newData.requestHeaders['token'] = randomString;
             expect(networkLog.calledOnceWithExactly(JSON.stringify(newData))).toBe(true);
+            expect(apmNetworkLog.calledOnceWithExactly(JSON.stringify(newData))).toBe(true);
         });
 
     });
@@ -148,8 +156,27 @@ describe('NetworkLogger Module', () => {
         NetworkLogger.setEnabled(true);
 
         expect(networkLog.notCalled).toBe(true);
-
+        expect(apmNetworkLog.notCalled).toBe(true);
     });
 
+    it('should test that operationSetContext at apollo handler called', async () => {
+      const operation = {
+        setContext : (callback) => callback({ headers : {} }),
+        operationName : "operationName"
+      };
+      const forward = jest.fn();
+      const operationSetContextMock = sinon.spy(operation, 'setContext')
+      
+      NetworkLogger.apolloLinkRequestHandler(operation, forward);
+      expect(operationSetContextMock.calledOnce).toBe(true);
+    });
+  
+    it('should test that apollo handler called with catch error', async () => {
+      const operation = {};
+      const forward = jest.fn();
+  
+      NetworkLogger.apolloLinkRequestHandler(operation, forward);
+      expect(apolloLinkRequestHandler.calledOnce).toBe(true);
+    });
 
 });

__tests__/xhrNetworkInterceptor.spec.js

@@ -1,6 +1,7 @@
 import 'react-native';
 import sinon from 'sinon';
 import FakeRequest from '../jest/fakeNetworkRequest';
+import InstabugConstants from '../utils/InstabugConstants';
 
 global.XMLHttpRequest = sinon.useFakeXMLHttpRequest();
 
@@ -44,7 +45,7 @@ describe('Network Interceptor', () => {
 
     it('should set network object on calling setRequestHeader', (done) => {
 
-        let requestHeaders = { 'Content-type': 'application/json', 'token': '9u4hiudhi3bf' };
+        let requestHeaders = { 'content-type': 'application/json', 'token': '9u4hiudhi3bf' };
 
         Interceptor.enableInterception();
         Interceptor.setOnDoneCallback((network) => {
@@ -87,7 +88,7 @@ describe('Network Interceptor', () => {
 
     it('should set responseHeaders in network object on receiving response', (done) => {
 
-        const headers = { 'Content-type': 'application/json', 'Accept': 'text/html' }
+        const headers = { 'Content-type': 'application/json', 'Accept': 'text/html','Content-Length':144 }
         Interceptor.enableInterception();
         Interceptor.setOnDoneCallback((network) => {
             expect(network.responseHeaders['Content-type'].trim()).toEqual(headers['Content-type']);
@@ -168,6 +169,54 @@ describe('Network Interceptor', () => {
         FakeRequest.mockResponse(requests[0]);
         expect(callback).not.toHaveBeenCalled();
     });
+    it('should set gqlQueryName in network object on receiving response', (done) => {
+      const headers = {};
+      headers[InstabugConstants.GRAPHQL_HEADER] =
+        InstabugConstants.GRAPHQL_HEADER;
+      const responseBody = { data: [{ item: 'first' }, { item: 'second' }] };
+      Interceptor.enableInterception();
+      Interceptor.setOnDoneCallback((network) => {
+        expect(network.gqlQueryName).toEqual(
+          headers[InstabugConstants.GRAPHQL_HEADER]
+        );
+        done();
+      });
+      FakeRequest.open(method, url);
+      FakeRequest.setRequestHeaders(headers);
+      FakeRequest.send();
+      FakeRequest.mockResponse(requests[0], null, JSON.stringify(responseBody));
+    });
+
+    it('should set gqlQueryName in network object on receiving response with empty string', (done) => {
+      const headers = {};
+      headers[InstabugConstants.GRAPHQL_HEADER] = 'null';
+      Interceptor.enableInterception();
+      Interceptor.setOnDoneCallback((network) => {
+        expect(network.gqlQueryName).toEqual('');
+        done();
+      });
+      FakeRequest.open(method, url);
+      FakeRequest.setRequestHeaders(headers);
+      FakeRequest.send();
+      FakeRequest.mockResponse(requests[0]);
+    });
+  
+    it('should set serverErrorMessage in network object on receiving response', (done) => {
+      const headers = {};
+      headers[InstabugConstants.GRAPHQL_HEADER] =
+        InstabugConstants.GRAPHQL_HEADER;
+      const responseBody = { errors: [{ item: 'first' }, { item: 'second' }] };
+      Interceptor.enableInterception();
+      Interceptor.setOnDoneCallback((network) => {
+        expect(network.serverErrorMessage).toEqual('GraphQLError');
+        done();
+      });
+      FakeRequest.open(method, url);
+      FakeRequest.setRequestHeaders(headers);
+      FakeRequest.setResponseType('text');
+      FakeRequest.send();
+      FakeRequest.mockResponse(requests[0], null, JSON.stringify(responseBody));
+    });
 
 
-});
+});

android/src/main/java/com/instabug/reactlibrary/RNInstabugAPMModule.java

@@ -4,23 +4,44 @@
 import android.os.Handler;
 import android.os.Looper;
 import android.os.SystemClock;
+import android.util.Log;
 
 import com.facebook.react.bridge.Callback;
 import com.facebook.react.bridge.ReactApplicationContext;
 import com.facebook.react.bridge.ReactContextBaseJavaModule;
 import com.facebook.react.bridge.ReactMethod;
 import com.instabug.apm.APM;
 import com.instabug.apm.model.ExecutionTrace;
+import com.instabug.apm.networking.APMNetworkLogger;
 import com.instabug.bug.BugReporting;
 import com.instabug.chat.Chats;
 import com.instabug.library.Feature;
 import com.instabug.reactlibrary.utils.InstabugUtil;
 import com.instabug.reactlibrary.utils.MainThreadHandler;
 
+import org.json.JSONException;
+import org.json.JSONObject;
+
+import java.io.File;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+
+import java.io.File;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.Iterator;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+import com.instabug.library.Platform;
 
 import javax.annotation.Nonnull;
 
+import static com.instabug.reactlibrary.utils.InstabugUtil.getMethod;
+
 public class RNInstabugAPMModule extends ReactContextBaseJavaModule {
 
     public RNInstabugAPMModule(ReactApplicationContext reactApplicationContext) {
@@ -238,4 +259,62 @@ public void run() {
             }
         });
     }
+
+    /**
+    *  Send Apm network log by Reflection 
+    */
+    @ReactMethod
+    public void networkLog(String networkData) throws JSONException {
+        try{
+            APMNetworkLogger apmNetworkLogger = new APMNetworkLogger();
+            JSONObject jsonObject = new JSONObject(networkData);
+            final String requestUrl = (String) jsonObject.get("url");
+            final String requestBody = (String) jsonObject.get("requestBody");
+            final String responseBody = (String) jsonObject.get("responseBody");
+            final String requestMethod = (String) jsonObject.get("method");
+            //--------------------------------------------
+            final String requestContentType = (String) jsonObject.get("requestContentType");
+            final String responseContentType = (String) jsonObject.get("contentType");
+            //--------------------------------------------
+            final long requestBodySize = ((Number) jsonObject.get("requestBodySize")).longValue();
+            final long responseBodySize = ((Number) jsonObject.get("responseBodySize")).longValue();
+            //--------------------------------------------
+            final String errorDomain = (String) jsonObject.get("errorDomain");
+            final Integer statusCode = (Integer) jsonObject.get("responseCode");
+            final long requestDuration = ((Number) jsonObject.get("duration")).longValue();
+            final long requestStartTime = ((Number) jsonObject.get("startTime")).longValue() * 1000;
+            final String requestHeaders = (String) jsonObject.get("requestHeaders").toString(); 
+            final String responseHeaders = (String) jsonObject.get("responseHeaders").toString(); 
+            final String errorMessage;
+            if(errorDomain.equals("")) {
+                errorMessage = null;
+            } else {
+                errorMessage = errorDomain;
+            }
+            //--------------------------------------------
+            String gqlQueryName = null;
+            if(jsonObject.has("gqlQueryName")){
+                gqlQueryName = (String) jsonObject.get("gqlQueryName");
+            } 
+            final String serverErrorMessage = (String) jsonObject.get("serverErrorMessage");
+            
+            try {
+                Method method = getMethod(Class.forName("com.instabug.apm.networking.APMNetworkLogger"), "log", long.class, long.class, String.class, String.class, long.class, String.class, String.class, String.class, String.class, String.class, long.class, int.class, String.class, String.class, String.class, String.class);
+                if (method != null) {
+                    method.invoke(apmNetworkLogger, requestStartTime, requestDuration, requestHeaders, requestBody, requestBodySize, requestMethod, requestUrl, requestContentType, responseHeaders, responseBody, responseBodySize, statusCode, responseContentType, errorMessage, gqlQueryName, serverErrorMessage);
+                } else {
+                    Log.e("IB-CP-Bridge", "apmNetworkLogByReflection was not found by reflection");
+                }
+            } catch (ClassNotFoundException e) {
+                e.printStackTrace();
+            } catch (IllegalAccessException e) {
+                e.printStackTrace();
+            } catch (InvocationTargetException e) {
+                e.printStackTrace();
+            }
+        }
+        catch(Exception e) {
+            e.printStackTrace();
+        }
+    }
 }

index.d.ts

@@ -532,6 +532,12 @@ export namespace NetworkLogger {
    * @param {function} handler
    */
   function setProgressHandlerForRequest(handler: () => void): void;
+  /**
+   * Apollo Link Request Handler to track network log for graphQL using apollo
+   * @param {any} operation 
+   * @param {any} forward 
+   */
+  function apolloLinkRequestHandler(operation: any, forward: any):any;
 }
 export class Trace {
   constructor(id: string, name?: string, attributes?: object);

ios/RNInstabug/InstabugReactBridge.m

@@ -376,7 +376,16 @@ - (dispatch_queue_t)methodQueue {
     int64_t startTime = [networkData[@"startTime"] integerValue] * 1000;
     int64_t duration = [networkData[@"duration"] doubleValue] * 1000;
 
-    SEL networkLogSEL = NSSelectorFromString(@"addNetworkLogWithUrl:method:requestBody:requestBodySize:responseBody:responseBodySize:responseCode:requestHeaders:responseHeaders:contentType:errorDomain:errorCode:startTime:duration:");
+    NSString* gqlQueryName = nil;
+    NSString* serverErrorMessage = nil;
+    if (networkData[@"gqlQueryName"] != [NSNull null]) {
+        gqlQueryName = networkData[@"gqlQueryName"];
+    }
+    if (networkData[@"serverErrorMessage"] != [NSNull null]) {
+        serverErrorMessage = networkData[@"serverErrorMessage"];
+    }
+
+    SEL networkLogSEL = NSSelectorFromString(@"addNetworkLogWithUrl:method:requestBody:requestBodySize:responseBody:responseBodySize:responseCode:requestHeaders:responseHeaders:contentType:errorDomain:errorCode:startTime:duration:gqlQueryName:serverErrorMessage:");
 
     if([[IBGNetworkLogger class] respondsToSelector:networkLogSEL]) {
         NSInvocation *inv = [NSInvocation invocationWithMethodSignature:[[IBGNetworkLogger class] methodSignatureForSelector:networkLogSEL]];
@@ -397,7 +406,9 @@ - (dispatch_queue_t)methodQueue {
         [inv setArgument:&(errorCode) atIndex:13];
         [inv setArgument:&(startTime) atIndex:14];
         [inv setArgument:&(duration) atIndex:15];
-        
+        [inv setArgument:&(gqlQueryName) atIndex:16];
+        [inv setArgument:&(serverErrorMessage) atIndex:17];
+
         [inv invoke];
     }
 }