chore: enhance inline code documentation for APM module.

andrewdanieldev · andrewdanieldev · commit 252126e0d470 · 2025-02-17T16:31:09.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
@@ -43,7 +43,9 @@ public String getName() {
     }
 
     /**
-     * Sets the printed logs priority. Filter to one of the following levels.
+     * This method is exporting a method
+     * named `ibgSleep` to be accessible from JavaScript side. When this method is
+     * called from JavaScript, it (sleeps) the current thread for 3 seconds.
      */
     @ReactMethod
     public void ibgSleep() {
@@ -57,6 +59,14 @@ public void run() {
 
     /**
      * Enables or disables APM.
+     *
+     * This function is exporting a method named
+     * [setEnabled] to be accessible from JavaScript side. When this method is
+     * called from JavaScript, it will set the `enabled` property of the [APM] class provided by the
+     * Instabug SDK to the value passed as the `isEnabled` parameter. This property controls whether the
+     * APM (Application Performance Monitoring) feature of Instabug is enabled or disabled based on the
+     * boolean value passed to it.
+     *
      * @param isEnabled boolean indicating enabled or disabled.
      */
     @ReactMethod
@@ -75,6 +85,12 @@ public void run() {
 
     /**
      * Enables or disables app launch tracking.
+     *
+     * This function is exporting a method named
+     * `setAppLaunchEnabled` to be accessible from JavaScript side. When this
+     * method is called from JavaScript, it will set the `coldAppLaunchEnabled` property of the `IBGAPM`
+     * class provided by the Instabug SDK to the value passed as the `isEnabled` parameter.
+     *
      * @param isEnabled boolean indicating enabled or disabled.
      */
     @ReactMethod
@@ -92,7 +108,10 @@ public void run() {
     }
 
     /**
-     * Ends app launch
+     * This function is exporting a method named `endAppLaunch` to be
+     * accessible from JavaScript side. When this method is called from
+     * JavaScript, it will invoke the `endAppLaunch` method from the [APM] class provided by the
+     * Instabug SDK. This method is used to signal the end of the app launch process.
      */
     @ReactMethod
     public void endAppLaunch() {
@@ -110,6 +129,15 @@ public void run() {
 
     /**
      * Enables or disables auto UI tracing
+     *
+     * This function is exporting a method named
+     * [setAutoUITraceEnabled] to be accessible from JavaScript side. When this
+     * method is called from JavaScript, it will set the `autoUITraceEnabled` property of the [APM]
+     * class provided by the Instabug SDK to the value passed as the `isEnabled` parameter. This property
+     * controls whether automatic tracing of UI interactions is enabled or disabled within the SDK. By
+     * toggling this property, you can control whether the SDK captures data related to user interface
+     * performance and behavior automatically.
+     *
      * @param isEnabled boolean indicating enabled or disabled.
      */
     @ReactMethod
@@ -281,6 +309,12 @@ public void run() {
 
     /**
      * Starts a UI trace
+     *
+     * This function is exporting a method named
+     * [startUITrace] to be accessible from JavaScript side. When this method is
+     * called from JavaScript, it will invoke the [startUITrace] method from the [APM] class
+     * provided by the Instabug SDK to start a new UI trace.
+     *
      * @param name string name of the UI trace.
      */
     @ReactMethod
@@ -298,7 +332,10 @@ public void run() {
     }
 
     /**
-     * Ends the current running UI trace
+     * This function is exporting a method named [endUITrace] to be
+     * accessible from JavaScript side. When this method is called from
+     * JavaScript, it will invoke the `endUITrace` method from the []APM] class provided by the Instabug
+     * SDK. This method is used to terminate the currently active UI trace.
      */
     @ReactMethod
     public void endUITrace() {
@@ -314,6 +351,73 @@ public void run() {
         });
     }
 
+ /**
+  * The `networkLogAndroid` function logs network-related information using APMNetworkLogger in a React
+  * Native module.
+  *
+  * @param requestStartTime The `requestStartTime` parameter in the `networkLogAndroid` method
+  * represents the timestamp when the network request started. It is of type `double` and is passed as
+  * a parameter to log network-related information.
+  * @param requestDuration The `requestDuration` parameter in the `networkLogAndroid` method represents
+  * the duration of the network request in milliseconds. It indicates the time taken for the request to
+  * complete from the moment it was initiated until the response was received. This parameter helps in
+  * measuring the performance of network requests and identifying any potential
+  * @param requestHeaders requestHeaders is a string parameter that contains the headers of the network
+  * request. It typically includes information such as the content type, authorization token, and any
+  * other headers that were sent with the request.
+  * @param requestBody The `requestBody` parameter in the `networkLogAndroid` method represents the
+  * body of the HTTP request being logged. It contains the data that is sent as part of the request to
+  * the server. This could include form data, JSON payload, XML data, or any other content that is
+  * being transmitted
+  * @param requestBodySize The `requestBodySize` parameter in the `networkLogAndroid` method represents
+  * the size of the request body in bytes. It is a double value that indicates the size of the request
+  * body being sent in the network request. This parameter is used to log information related to the
+  * network request, including details
+  * @param requestMethod The `requestMethod` parameter in the `networkLogAndroid` method represents the
+  * HTTP method used in the network request, such as GET, POST, PUT, DELETE, etc. It indicates the type
+  * of operation that the client is requesting from the server.
+  * @param requestUrl The `requestUrl` parameter in the `networkLogAndroid` method represents the URL
+  * of the network request being logged. It typically contains the address of the server to which the
+  * request is being made, along with any additional path or query parameters required for the request.
+  * This URL is essential for identifying the
+  * @param requestContentType The `requestContentType` parameter in the `networkLogAndroid` method
+  * represents the content type of the request being made. This could be values like
+  * "application/json", "application/xml", "text/plain", etc., indicating the format of the data being
+  * sent in the request body. It helps in specifying
+  * @param responseHeaders The `responseHeaders` parameter in the `networkLogAndroid` method represents
+  * the headers of the response received from a network request. These headers typically include
+  * information such as content type, content length, server information, and any other metadata
+  * related to the response. The `responseHeaders` parameter is expected to
+  * @param responseBody The `responseBody` parameter in the `networkLogAndroid` method represents the
+  * body of the response received from a network request. It contains the data or content sent back by
+  * the server in response to the request made by the client. This could be in various formats such as
+  * JSON, XML, HTML
+  * @param responseBodySize The `responseBodySize` parameter in the `networkLogAndroid` method
+  * represents the size of the response body in bytes. It is a double value that indicates the size of
+  * the response body received from the network request. This parameter is used to log information
+  * related to the network request and response, including
+  * @param statusCode The `statusCode` parameter in the `networkLogAndroid` method represents the HTTP
+  * status code of the network request/response. It indicates the status of the HTTP response, such as
+  * success (200), redirection (3xx), client errors (4xx), or server errors (5xx). This parameter is
+  * @param responseContentType The `responseContentType` parameter in the `networkLogAndroid` method
+  * represents the content type of the response received from the network request. It indicates the
+  * format of the data in the response, such as JSON, XML, HTML, etc. This information is useful for
+  * understanding how to parse and handle the
+  * @param errorDomain The `errorDomain` parameter in the `networkLogAndroid` method is used to specify
+  * the domain of an error, if any occurred during the network request. If there was no error, this
+  * parameter will be `null`.
+  * @param w3cAttributes The `w3cAttributes` parameter in the `networkLogAndroid` method is a
+  * ReadableMap object that contains additional attributes related to W3C external trace. It may
+  * include the following key-value pairs:
+  * @param gqlQueryName The `gqlQueryName` parameter in the `networkLogAndroid` method represents the
+  * name of the GraphQL query being executed. It is a nullable parameter, meaning it can be null if no
+  * GraphQL query name is provided. This parameter is used to log information related to GraphQL
+  * queries in the network logging
+  * @param serverErrorMessage The `serverErrorMessage` parameter in the `networkLogAndroid` method is
+  * used to pass any error message received from the server during network communication. This message
+  * can provide additional details about any errors that occurred on the server side, helping in
+  * debugging and troubleshooting network-related issues.
+  */
     @ReactMethod
     private void networkLogAndroid(final double requestStartTime,
                                    final double requestDuration,
diff --git a/ios/RNInstabug/InstabugAPMBridge.m b/ios/RNInstabug/InstabugAPMBridge.m
@@ -36,33 +36,55 @@ - (id) init
     return self;
 }
 
+// This method is exporting a method
+// named `ibgSleep` to be accessible from JavaScript side. When this method is
+// called from JavaScript, it (sleeps) the current thread for 3 seconds.
 RCT_EXPORT_METHOD(ibgSleep) {
     [NSThread sleepForTimeInterval:3.0f];
-    // for (int i = 1; i <= 1000000; i++)
-    // {
-    //     double value = sqrt(i);
-
-    //     printf("%@", [NSNumber numberWithDouble:value]);
-    // }
-    // [NSThread sleepForTimeInterval:3.0f];
 }
 
+// Enables or disables APM.
+//
+// This function is exporting a method named
+// `setEnabled` to be accessible from JavaScript side. When this method is
+// called from JavaScript, it will set the `enabled` property of the `IBGAPM` class provided by the
+// Instabug SDK to the value passed as the `isEnabled` parameter. This property controls whether the
+// APM (Application Performance Monitoring) feature of Instabug is enabled or disabled based on the
+// boolean value passed to it.
 RCT_EXPORT_METHOD(setEnabled:(BOOL)isEnabled) {
     IBGAPM.enabled = isEnabled;
 }
 
+// This function is exporting a method named
+// `setAppLaunchEnabled` to be accessible from JavaScript side. When this
+// method is called from JavaScript, it will set the `coldAppLaunchEnabled` property of the `IBGAPM`
+// class provided by the Instabug SDK to the value passed as the `isEnabled` parameter.
 RCT_EXPORT_METHOD(setAppLaunchEnabled:(BOOL)isEnabled) {
     IBGAPM.coldAppLaunchEnabled = isEnabled;
 }
 
+// This function is exporting a method named `endAppLaunch` to be
+// accessible from JavaScript side. When this method is called from
+// JavaScript, it will invoke the `endAppLaunch` method from the `IBGAPM` class provided by the
+// Instabug SDK. This method is used to signal the end of the app launch process.
 RCT_EXPORT_METHOD(endAppLaunch) {
     [IBGAPM endAppLaunch];
 }
 
+// This function is exporting a method named
+// `setAutoUITraceEnabled` to be accessible from JavaScript side. When this
+// method is called from JavaScript, it will set the `autoUITraceEnabled` property of the `IBGAPM`
+// class provided by the Instabug SDK to the value passed as the `isEnabled` parameter. This property
+// controls whether automatic tracing of UI interactions is enabled or disabled within the SDK. By
+// toggling this property, you can control whether the SDK captures data related to user interface
+// performance and behavior automatically.
 RCT_EXPORT_METHOD(setAutoUITraceEnabled:(BOOL)isEnabled) {
     IBGAPM.autoUITraceEnabled = isEnabled;
 }
 
+// This method `startExecutionTrace` is exporting a function to be accessible from JavaScript in a
+// React Native application.
+// Deprecated see [startFlow: (NSString *)name]
 RCT_EXPORT_METHOD(startExecutionTrace:(NSString *)name :(NSString *)id
                                      :(RCTPromiseResolveBlock)resolve
                                      :(RCTPromiseRejectBlock)reject) {
@@ -75,37 +97,64 @@ - (id) init
     }
 }
 
+// This method is exporting a function to be accessible from JavaScript side.
+// Deprecated see [setFlowAttribute:(NSString *)name :(NSString *)key :(NSString *_Nullable)value]
 RCT_EXPORT_METHOD(setExecutionTraceAttribute:(NSString *)id :(NSString *)key :(NSString *)value) {
     IBGExecutionTrace *trace = [traces objectForKey:id];
     if (trace != nil) {
         [trace setAttributeWithKey:key value:value];
     }
 }
 
+// This function is exporting a method named
+// `endExecutionTrace` to be accessible from JavaScript side.
+// Deprecated see [endFlow: (NSString *)name]
 RCT_EXPORT_METHOD(endExecutionTrace:(NSString *)id) {
     IBGExecutionTrace *trace = [traces objectForKey:id];
     if (trace != nil) {
         [trace end];
     }
 }
 
+// This function is exporting a method named
+// `startFlow` to be accessible from JavaScript side. When this method is
+// called from JavaScript, it will invoke the `startFlowWithName:` method from the `IBGAPM` class
+// provided by the Instabug SDK. This method is used to start a flow trace with the specified name,
+// allowing the SDK to capture and analyze the flow of execution within the application.
 RCT_EXPORT_METHOD(startFlow: (NSString *)name) {
     [IBGAPM startFlowWithName:name];
 }
 
+// This function is exporting a method named `endFlow` to
+// be accessible from JavaScript side. When this method is called from
+// JavaScript, it will invoke the `endFlowWithName:` method from the `IBGAPM` class provided by the
+// Instabug SDK. This method is used to end a flow trace with the specified name, allowing the SDK to
+// capture and analyze the flow of execution within the application.
 RCT_EXPORT_METHOD(endFlow: (NSString *)name) {
     [IBGAPM endFlowWithName:name];
 }
 
 
+// The function is exporting a method named `setFlowAttribute` to be accessible from
+// JavaScript side. When this method is
+// called from JavaScript, it will invoke the `setAttributeForFlowWithName:` method from the `IBGAPM` class
+// provided by the Instabug SDK to set a user defined attribute for the currently active flow.
 RCT_EXPORT_METHOD(setFlowAttribute:(NSString *)name :(NSString *)key :(NSString *_Nullable)value) {
     [IBGAPM setAttributeForFlowWithName:name key:key value:value];
 }
 
+// This function is exporting a method named
+// `startUITrace` to be accessible from JavaScript side. When this method is
+// called from JavaScript, it will invoke the `startUITraceWithName:` method from the `IBGAPM` class
+// provided by the Instabug SDK to start a new UI trace.
 RCT_EXPORT_METHOD(startUITrace:(NSString *)name) {
     [IBGAPM startUITraceWithName:name];
 }
 
+// This function is exporting a method named `endUITrace` to be
+// accessible from JavaScript side. When this method is called from
+// JavaScript, it will invoke the `endUITrace` method from the `IBGAPM` class provided by the Instabug
+// SDK. This method is used to terminate the currently active UI trace.
 RCT_EXPORT_METHOD(endUITrace) {
     [IBGAPM endUITrace];
 }
diff --git a/src/modules/APM.ts b/src/modules/APM.ts
@@ -13,23 +13,26 @@ export const setEnabled = (isEnabled: boolean) => {
 };
 
 /**
- * Enables or disables APM App Launch
+ * If APM is enabled, Instabug SDK starts collecting data about the app launch time by default.
+ * This API is used to give user more control over this behavior.
  * @param isEnabled
  */
 export const setAppLaunchEnabled = (isEnabled: boolean) => {
   NativeAPM.setAppLaunchEnabled(isEnabled);
 };
 
 /**
- * Ends app launch
+ * To define when an app launch is complete,
+ * such as when it's intractable, use the end app launch API.
+ * You can then view this data with the automatic cold and hot app launches.
  */
 export const endAppLaunch = () => {
   NativeAPM.endAppLaunch();
 };
 
 /**
  * Enables or disables APM Network Metric
- * @param isEnabled
+ * @param isEnabled - a boolean indicates either iOS monitoring is enabled or disabled.
  */
 export const setNetworkEnabledIOS = (isEnabled: boolean) => {
   if (Platform.OS === 'ios') {
@@ -114,15 +117,17 @@ export const setFlowAttribute = (name: string, key: string, value?: string | nul
 };
 
 /**
- * Starts a custom trace
- * @param name
+ * Initiates a UI trace with the specified name using a native module.
+ * @param {string} name - The `name` parameter in the `startUITrace` function is a string that
+ * represents the name of the UI trace that you want to start. This name is used to identify and track
+ * the specific UI trace within the application.
  */
 export const startUITrace = (name: string) => {
   NativeAPM.startUITrace(name);
 };
 
 /**
- * Ends a custom trace
+ * Ends the currently running custom trace.
  */
 export const endUITrace = () => {
   NativeAPM.endUITrace();
