feat: support app flows

abdelhamid-f-nasser · abdelhamid-f-nasser · commit 676e61178298 · 2024-02-21T09:59:00.000+02:00
diff --git a/android/src/main/java/com/instabug/reactlibrary/RNInstabugAPMModule.java b/android/src/main/java/com/instabug/reactlibrary/RNInstabugAPMModule.java
@@ -4,6 +4,7 @@
 import android.os.SystemClock;
 import android.util.Log;
 
+import androidx.annotation.NonNull;
 import com.facebook.react.bridge.Promise;
 import com.facebook.react.bridge.ReactApplicationContext;
 import com.facebook.react.bridge.ReactContextBaseJavaModule;
@@ -123,14 +124,92 @@ public void run() {
         });
     }
 
+    /**
+     * Starts an AppFlow with the specified name.
+     * <br/>
+     * On starting two flows with the same name the older flow will end with force abandon end reason.
+     * AppFlow name cannot exceed 150 characters otherwise it's truncated,
+     * leading and trailing whitespaces are also ignored.
+     *
+     * @param name AppFlow name. It can not be empty string or null.
+     *             Starts a new AppFlow, if APM is enabled, feature is enabled
+     *             and Instabug SDK is initialised.
+     */
+    @ReactMethod
+    public void startFlow(@NonNull final String name) {
+        MainThreadHandler.runOnMainThread(new Runnable() {
+            @Override
+            public void run() {
+                try {
+                    APM.startFlow(name);
+                } catch (Exception e) {
+                    e.printStackTrace();
+                }
+            }
+        });
+    }
+
+    /**
+     * Sets custom attributes for AppFlow with a given name.
+     * <br/>
+     * Setting an attribute value to null will remove its corresponding key if it already exists.
+     * <br/>
+     * Attribute key name cannot exceed 30 characters.
+     * Leading and trailing whitespaces are also ignored.
+     * Does not accept empty strings or null.
+     * <br/>
+     * Attribute value name cannot exceed 60 characters,
+     * leading and trailing whitespaces are also ignored.
+     * Does not accept empty strings.
+     * <br/>
+     * If a trace is ended, attributes will not be added and existing ones will not be updated.
+     * <br/>
+     *
+     * @param name  AppFlow name. It can not be empty string or null
+     * @param key   AppFlow attribute value. It can not be empty string or null
+     * @param value AppFlow attribute key. It can not be empty string. Null to remove attribute
+     */
+    @ReactMethod
+    public void setFlowAttribute(@NonNull final String name, @NonNull final String key, final String value) {
+        MainThreadHandler.runOnMainThread(new Runnable() {
+            @Override
+            public void run() {
+                try {
+                    APM.setFlowAttribute(name, key, value);
+                } catch (Exception e) {
+                    e.printStackTrace();
+                }
+            }
+        });
+    }
+
+    /**
+     * Ends AppFlow with a given name.
+     *
+     * @param name AppFlow name to be ended. It can not be empty string or null
+     */
+    @ReactMethod
+    public void endFlow(@NonNull final String name) {
+        MainThreadHandler.runOnMainThread(new Runnable() {
+            @Override
+            public void run() {
+                try {
+                    APM.endFlow(name);
+                } catch (Exception e) {
+                    e.printStackTrace();
+                }
+            }
+        });
+    }
+
     /**
      * Starts an execution trace
      *
      * @param name string name of the trace.
      *
      * @deprecated see {@link #startFlow(String)}
      */
-    @Deprecated(since = "Use `startFlow` instead.")
+    @Deprecated
     @ReactMethod
     public void startExecutionTrace(final String name, final String id, final Promise promise) {
         MainThreadHandler.runOnMainThread(new Runnable() {
@@ -161,7 +240,7 @@ public void run() {
      *
      * @deprecated see {@link #setFlowAttribute}
      */
-    @Deprecated(since = "Use `setFlowAttribute` instead")
+    @Deprecated
     @ReactMethod
     public void setExecutionTraceAttribute(final String id, final String key, final String value) {
         MainThreadHandler.runOnMainThread(new Runnable() {
@@ -183,7 +262,7 @@ public void run() {
      *
      * @deprecated see {@link #endFlow}
      */
-    @Deprecated(since = "Use `endFlow` instead")
+    @Deprecated
     @ReactMethod
     public void endExecutionTrace(final String id) {
         MainThreadHandler.runOnMainThread(new Runnable() {
@@ -234,7 +313,7 @@ public void run() {
     }
 
     /**
-    *  Send Apm network log by Reflection 
+    *  Send Apm network log by Reflection
     */
     @ReactMethod
     public void networkLog(String networkData) throws JSONException {
@@ -256,8 +335,8 @@ public void networkLog(String networkData) throws JSONException {
             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 requestHeaders = (String) jsonObject.get("requestHeaders").toString();
+            final String responseHeaders = (String) jsonObject.get("responseHeaders").toString();
             final String errorMessage;
             if(errorDomain.equals("")) {
                 errorMessage = null;
@@ -268,9 +347,9 @@ public void networkLog(String networkData) throws JSONException {
             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) {
diff --git a/android/src/test/java/com/instabug/reactlibrary/RNInstabugAPMModuleTest.java b/android/src/test/java/com/instabug/reactlibrary/RNInstabugAPMModuleTest.java
@@ -125,6 +125,37 @@ public void givenTruesetEnabled_whenQuery_thenShouldCallNativeApiWithEnabled() {
         verify(promise).resolve(any());
     }
 
+    @Test
+    public void testStartFlow() {
+        String appFlowName = "appFlowName";
+
+        apmModule.startFlow(appFlowName);
+
+        mockAPM.verify(() -> APM.startFlow(appFlowName));
+        mockAPM.verifyNoMoreInteractions();
+    }
+
+    @Test
+    public void testEndFlow() {
+        String appFlowName = "appFlowName";
+
+        apmModule.endFlow(appFlowName);
+
+        mockAPM.verify(() -> APM.endFlow(appFlowName));
+        mockAPM.verifyNoMoreInteractions();
+    }
+
+    @Test
+    public void testSetFlowAttribute() {
+        String appFlowName = "appFlowName";
+        String flowAttributeKey = "attributeKey";
+        String flowAttributeValue = "attributeValue";
+        apmModule.setFlowAttribute(appFlowName, flowAttributeKey, flowAttributeValue);
+
+        mockAPM.verify(() -> APM.setFlowAttribute(appFlowName, flowAttributeKey, flowAttributeValue));
+        mockAPM.verifyNoMoreInteractions();
+    }
+
     // @Test
     // public void givenString$setExecutionTraceAttribute_whenQuery_thenShouldCallNativeApiWithIntArgs() {
     //     // given
diff --git a/examples/default/ios/InstabugTests/InstabugAPMTests.m b/examples/default/ios/InstabugTests/InstabugAPMTests.m
@@ -62,15 +62,15 @@ - (void) testSetAPMEnabled {
 - (void) testSetAppLaunchEnabled {
   id mock = OCMClassMock([IBGAPM class]);
   BOOL isEnabled = YES;
-  
+
   OCMStub([mock setColdAppLaunchEnabled:isEnabled]);
   [self.instabugBridge setAppLaunchEnabled:isEnabled];
   OCMVerify([mock setColdAppLaunchEnabled:isEnabled]);
 }
 
 - (void) testEndAppLaunch {
   id mock = OCMClassMock([IBGAPM class]);
-  
+
   OCMStub([mock endAppLaunch]);
   [self.instabugBridge endAppLaunch];
   OCMVerify([mock endAppLaunch]);
@@ -79,7 +79,7 @@ - (void) testEndAppLaunch {
 - (void) testSetAutoUITraceEnabled {
   id mock = OCMClassMock([IBGAPM class]);
   BOOL isEnabled = YES;
-  
+
   OCMStub([mock setAutoUITraceEnabled:isEnabled]);
   [self.instabugBridge setAutoUITraceEnabled:isEnabled];
   OCMVerify([mock setAutoUITraceEnabled:isEnabled]);
@@ -91,7 +91,7 @@ - (void) testStartExecutionTrace {
   NSString* traceKey = @"1";
   RCTPromiseResolveBlock resolve = ^(id result) {};
   RCTPromiseRejectBlock reject = ^(NSString *code, NSString *message, NSError *error) {};
-  
+
   OCMStub([mock startExecutionTraceWithName:traceName]);
   [self.instabugBridge startExecutionTrace:traceName :traceKey :resolve :reject];
   OCMVerify([mock startExecutionTraceWithName:traceName]);
@@ -107,10 +107,10 @@ - (void) testSetExecutionTraceAttribute {
   IBGExecutionTrace * trace = [IBGExecutionTrace alloc];
   id mock = OCMClassMock([IBGAPM class]);
   id traceMock = OCMPartialMock(trace);
-  
+
   OCMStub([mock startExecutionTraceWithName:traceName]).andReturn(trace);
   [self.instabugBridge startExecutionTrace:traceName :traceId :resolve :reject];
-  
+
   OCMStub([traceMock setAttributeWithKey:traceKey value:traceValue]);
   [self.instabugBridge setExecutionTraceAttribute:traceId :traceKey :traceValue];
   OCMVerify([traceMock setAttributeWithKey:traceKey value:traceValue]);
@@ -127,24 +127,50 @@ - (void) testEndExecutionTrace {
 
   OCMStub([apmMock startExecutionTraceWithName:traceName]).andReturn(trace);
   [self.instabugBridge startExecutionTrace:traceName :traceId :resolve :reject];
-  
+
   OCMStub([traceMock end]);
   [self.instabugBridge endExecutionTrace:traceId];
   OCMVerify([traceMock end]);
 }
 
+- (void) testStartFlow {
+  id mock = OCMClassMock([IBGAPM class]);
+  NSString* appFlowName = @"APP_Flow_1";
+
+  [self.instabugBridge startFlow:appFlowName];
+  OCMVerify([mock startFlowWithName:appFlowName]);
+}
+
+- (void) testEndFlow {
+  id mock = OCMClassMock([IBGAPM class]);
+  NSString* appFlowName = @"APP_Flow_1";
+
+  [self.instabugBridge endFlow:appFlowName];
+  OCMVerify([mock endFlowWithName:appFlowName]);
+}
+
+- (void) testSetFlowAttribute {
+  id mock = OCMClassMock([IBGAPM class]);
+  NSString* appFlowName = @"APP_Flow_1";
+  NSString* attributeKey = @"Attribute_Key_1";
+  NSString* attributeValue = @"Attribute_Value_1";
+
+  [self.instabugBridge setFlowAttribute:appFlowName :attributeKey :attributeValue];
+  OCMVerify([mock setAttributeForFlowWithName:appFlowName key:attributeKey value:attributeValue]);
+}
+
 - (void) testStartUITrace {
   id mock = OCMClassMock([IBGAPM class]);
   NSString* traceName = @"UITrace_1";
-  
+
   OCMStub([mock startUITraceWithName:traceName]);
   [self.instabugBridge startUITrace:traceName];
   OCMVerify([mock startUITraceWithName:traceName]);
 }
 
 - (void) testEndUITrace {
   id mock = OCMClassMock([IBGAPM class]);
-  
+
   OCMStub([mock endUITrace]);
   [self.instabugBridge endUITrace];
   OCMVerify([mock endUITrace]);
diff --git a/ios/RNInstabug/InstabugAPMBridge.h b/ios/RNInstabug/InstabugAPMBridge.h
@@ -21,6 +21,9 @@
 - (void)setExecutionTraceAttribute:(NSString *)id:(NSString *)key
                                   :(NSString *)value DEPRECATED_MSG_ATTRIBUTE("Please use APM.setTraceAttribute instead.");
 - (void)endExecutionTrace:(NSString *)id  DEPRECATED_MSG_ATTRIBUTE("Please use APM.endFlow instead.");
+- (void)startFlow:(NSString *)name;
+- (void)endFlow:(NSString *)name;
+- (void)setFlowAttribute:(NSString *)name :(NSString *)key :(NSString *_Nullable)value;
 - (void)startUITrace:(NSString *)name;
 - (void)endUITrace;
 
diff --git a/ios/RNInstabug/InstabugAPMBridge.m b/ios/RNInstabug/InstabugAPMBridge.m
@@ -88,6 +88,19 @@ - (id) init
     }
 }
 
+RCT_EXPORT_METHOD(startFlow: (NSString *)name) {
+    [IBGAPM startFlowWithName:name];
+}
+
+RCT_EXPORT_METHOD(endFlow: (NSString *)name) {
+    [IBGAPM endFlowWithName:name];
+}
+
+
+RCT_EXPORT_METHOD(setFlowAttribute:(NSString *)name :(NSString *)key :(NSString *_Nullable)value) {
+    [IBGAPM setAttributeForFlowWithName:name key:key value:value];
+}
+
 RCT_EXPORT_METHOD(startUITrace:(NSString *)name) {
     [IBGAPM startUITraceWithName:name];
 }
diff --git a/src/modules/APM.ts b/src/modules/APM.ts
@@ -68,6 +68,51 @@ export const startExecutionTrace = async (name: string): Promise<Trace> => {
   return new Trace(id, name);
 };
 
+/**
+ * Starts an AppFlow with the specified name.
+ *
+ * On starting two flows with the same name, the older flow will end with a force abandon end reason.
+ * The AppFlow name cannot exceed 150 characters; otherwise, it's truncated,
+ * leading and trailing whitespaces are also ignored.
+ *
+ * @param name - The name of the AppFlow. It cannot be an empty string or null.
+ *               A new AppFlow is started if APM is enabled, the feature is enabled,
+ *               and the Instabug SDK is initialized.
+ */
+export const startFlow = (name: string) => {
+  NativeAPM.startFlow(name);
+};
+
+/**
+ * Ends an AppFlow with the given name.
+ *
+ * @param name - The name of the AppFlow to end. It cannot be an empty string or null.
+ */
+export const endFlow = (name: string) => {
+  NativeAPM.endFlow(name);
+};
+
+/**
+ * Sets custom attributes for an AppFlow with a given name.
+ *
+ * Setting an attribute value to null will remove the corresponding key if it already exists.
+ * Attribute keys cannot exceed 30 characters and leading/trailing whitespaces are ignored.
+ * Empty strings or null for attribute keys are not accepted.
+ *
+ * Attribute values cannot exceed 60 characters and leading/trailing whitespaces are ignored.
+ * Empty strings for attribute values are not accepted, but null can be used to remove an attribute.
+ *
+ * If an AppFlow is ended, attributes will not be added and existing ones will not be updated.
+ *
+ * @param name - The name of the AppFlow. It cannot be an empty string or null.
+ * @param key - The key of the attribute. It cannot be an empty string or null.
+ * @param [value] - The value of the attribute. It cannot be an empty string. Use null to remove the attribute.
+ */
+
+export const setFlowAttribute = (name: string, key: string, value?: string) => {
+  NativeAPM.setFlowAttribute(name, key, value);
+};
+
 /**
  * Starts a custom trace
  * @param name
diff --git a/src/native/NativeAPM.ts b/src/native/NativeAPM.ts
@@ -18,6 +18,11 @@ export interface ApmNativeModule extends NativeModule {
   setExecutionTraceAttribute(id: string, key: string, value: string): void;
   endExecutionTrace(id: string): void;
 
+  // App Flows APIs //
+  startFlow(name: string): void;
+  endFlow(name: string): void;
+  setFlowAttribute(name: string, key: string, value?: string): void;
+
   // UI Traces APIs //
   setAutoUITraceEnabled(isEnabled: boolean): void;
   startUITrace(name: string): void;
diff --git a/test/mocks/mockAPM.ts b/test/mocks/mockAPM.ts
@@ -9,6 +9,9 @@ const mockAPM: ApmNativeModule = {
   startExecutionTrace: jest.fn(),
   setExecutionTraceAttribute: jest.fn(),
   endExecutionTrace: jest.fn(),
+  startFlow: jest.fn(),
+  setFlowAttribute: jest.fn(),
+  endFlow: jest.fn(),
   startUITrace: jest.fn(),
   endUITrace: jest.fn(),
   endAppLaunch: jest.fn(),
diff --git a/test/modules/APM.spec.ts b/test/modules/APM.spec.ts

Original file line number	Diff line number	Diff line change
`@@ -88,6 +88,19 @@ - (id) init`
`88`	`88`	`}`
`89`	`89`	`}`
`90`	`90`
	`91`	`+RCT_EXPORT_METHOD(startFlow: (NSString *)name) {`
	`92`	`+ [IBGAPM startFlowWithName:name];`
	`93`	`+}`
	`94`	`+`
	`95`	`+RCT_EXPORT_METHOD(endFlow: (NSString *)name) {`
	`96`	`+ [IBGAPM endFlowWithName:name];`
	`97`	`+}`
	`98`	`+`
	`99`	`+`
	`100`	`+RCT_EXPORT_METHOD(setFlowAttribute:(NSString )name :(NSString )key :(NSString *_Nullable)value) {`
	`101`	`+ [IBGAPM setAttributeForFlowWithName:name key:key value:value];`
	`102`	`+}`
	`103`	`+`
`91`	`104`	`RCT_EXPORT_METHOD(startUITrace:(NSString *)name) {`
`92`	`105`	`[IBGAPM startUITraceWithName:name];`
`93`	`106`	`}`