Merge pull request #228 from Instabug/fix/enable-apm-traces-tests

Fix APM's Execution Traces Unit Tests

Author: Ali Abdelfattah

android/src/main/java/com/instabug/instabugflutter/InstabugFlutterPlugin.java

@@ -1031,23 +1031,19 @@ public void run() {
      * Starts an execution trace
      * @param name string name of the trace.
      */
-    public void startExecutionTrace(final String name, final String id) {
-        new Handler(Looper.getMainLooper()).post(new Runnable() {
-            @Override
-            public void run() {
-                try {
-                    String result = null;
-                    ExecutionTrace trace = APM.startExecutionTrace(name);
-                    if (trace != null) {
-                        result = id;
-                        traces.put(id, trace);
-                    }
-                    channel.invokeMethod("startExecutionTraceCallBack", result);
-                } catch (Exception e) {
-                    e.printStackTrace();
-                }
+    public String startExecutionTrace(final String name, final String id) {
+        try {
+            String result = null;
+            ExecutionTrace trace = APM.startExecutionTrace(name);
+            if (trace != null) {
+                result = id;
+                traces.put(id, trace);
             }
-        });
+            return result;
+        } catch (Exception e) {
+            e.printStackTrace();
+            return null;
+        }
     }
 
     /**

ios/Classes/InstabugFlutterPlugin.h

@@ -476,7 +476,7 @@
   */
 + (void)setColdAppLaunchEnabled:(NSNumber *)isEnabled;
 
-+ (void)startExecutionTrace:(NSString *)name id:(NSString *)id;
++ (NSString *)startExecutionTrace:(NSString *)name id:(NSString *)id;
 
 + (void)setExecutionTraceAttribute:(NSString *)id key:(NSString *)key value:(NSString *)value;
 

ios/Classes/InstabugFlutterPlugin.m

@@ -897,13 +897,13 @@ + (void)setColdAppLaunchEnabled:(NSNumber *)isEnabled {
   * @param {string} name of the trace.
   * @param {string} id of the trace.
   */
-+ (void)startExecutionTrace:(NSString *)name id:(NSString *)id {
++ (NSString *)startExecutionTrace:(NSString *)name id:(NSString *)id {
     IBGExecutionTrace *trace = [IBGAPM startExecutionTraceWithName:name];
     if (trace != nil) {
         [traces setObject: trace forKey: id];
-        [channel invokeMethod:@"startExecutionTraceCallBack" arguments:id];
+        return id;
     } else {
-        [channel invokeMethod:@"startExecutionTraceCallBack" arguments:nil];
+        return nil;
     }
 }
 

lib/APM.dart

@@ -6,6 +6,7 @@ import 'dart:io';
 import 'package:flutter/services.dart';
 import 'package:instabug_flutter/models/network_data.dart';
 import 'package:instabug_flutter/models/trace.dart';
+import 'package:instabug_flutter/utils/ibg_date_time.dart';
 
 enum LogLevel {
   none,
@@ -23,14 +24,6 @@ class APM {
   static Future<String?> get platformVersion async =>
       await _channel.invokeMethod<String>('getPlatformVersion');
 
-  static Future<dynamic> _handleMethod(MethodCall call) async {
-    switch (call.method) {
-      case 'startExecutionTraceCallBack':
-        _startExecutionTraceCallback(call.arguments);
-        return;
-    }
-  }
-
   /// Enables or disables APM feature.
   /// [boolean] isEnabled
   static Future<void> setEnabled(bool isEnabled) async {
@@ -54,24 +47,20 @@ class APM {
 
   /// Starts an execution trace.
   /// [String] name of the trace.
-  static Future<dynamic> startExecutionTrace(String name) async {
-    final String TRACE_NOT_STARTED_APM_NOT_ENABLED = "Execution trace " +
-        name +
-        " wasn't created. Please make sure to enable APM first by following the instructions at this link: https://docs.instabug.com/reference#enable-or-disable-apm";
-    final DateTime id = DateTime.now();
-    final Completer completer = new Completer<Trace>();
-    final List<dynamic> params = <dynamic>[name.toString(), id.toString()];
-    _channel.setMethodCallHandler(_handleMethod);
-    final Function callback = (String idBack) async {
-      if (idBack != null) {
-        completer.complete(Trace(idBack, name));
-      } else {
-        completer.completeError(TRACE_NOT_STARTED_APM_NOT_ENABLED);
-      }
-    };
-    _startExecutionTraceCallback = callback;
-    await _channel.invokeMethod<Object>('startExecutionTrace:id:', params);
-    return completer.future;
+  static Future<Trace> startExecutionTrace(String name) async {
+    final DateTime id = IBGDateTime.instance.now();
+    final List<dynamic> params = <dynamic>[name, id.toString()];
+    final traceId =
+        await _channel.invokeMethod<String?>('startExecutionTrace:id:', params);
+
+    if (traceId == null) {
+      return Future.error(
+        "Execution trace $name wasn't created. Please make sure to enable APM first by following "
+        'the instructions at this link: https://docs.instabug.com/reference#enable-or-disable-apm',
+      );
+    }
+
+    return Trace(traceId, name);
   }
 
   /// Sets attribute of an execution trace.
@@ -114,6 +103,7 @@ class APM {
   static Future<void> endUITrace() async {
     await _channel.invokeMethod<Object>('endUITrace');
   }
+
   /// Ends UI trace.
   static void endAppLaunch() async {
     await _channel.invokeMethod<Object>('endAppLaunch');

lib/utils/ibg_date_time.dart

@@ -0,0 +1,19 @@
+import 'package:meta/meta.dart';
+
+/// Mockable [DateTime] class.
+class IBGDateTime {
+  IBGDateTime._();
+
+  static IBGDateTime _instance = IBGDateTime._();
+  static IBGDateTime get instance => _instance;
+
+  /// Shorthand for [instance]
+  static IBGDateTime get I => instance;
+
+  @visibleForTesting
+  static void setInstance(IBGDateTime instance) {
+    _instance = instance;
+  }
+
+  DateTime now() => DateTime.now();
+}

test/instabug_flutter_test.dart

@@ -19,6 +19,7 @@ import 'package:instabug_flutter/models/crash_data.dart';
 import 'package:instabug_flutter/models/exception_data.dart';
 import 'package:instabug_flutter/models/network_data.dart';
 import 'package:instabug_flutter/models/trace.dart' as execution_trace;
+import 'package:instabug_flutter/utils/ibg_date_time.dart';
 import 'package:instabug_flutter/utils/platform_manager.dart';
 import 'package:mockito/annotations.dart';
 import 'package:mockito/mockito.dart';
@@ -28,6 +29,7 @@ import 'instabug_flutter_test.mocks.dart';
 
 @GenerateMocks([
   PlatformManager,
+  IBGDateTime,
 ])
 void main() {
   TestWidgetsFlutterBinding.ensureInitialized();
@@ -83,6 +85,8 @@ void main() {
       switch (methodCall.method) {
         case 'getTags':
           return <String>['tag1', 'tag2'];
+        case 'startExecutionTrace:id:':
+          return methodCall.arguments[0];
         case 'getUserAttributeForKey:':
           return userAttribute;
         case 'getUserAttributes':
@@ -1063,17 +1067,23 @@ void main() {
   });
 
   test('startExecutionTrace: Test', () async {
-    const String name = 'test_trace';
+    const String name = 'test-trace';
     final DateTime timestamp = DateTime.now();
-    final List<dynamic> args = <dynamic>[name.toString(), timestamp.toString()];
+    final List<dynamic> args = <dynamic>[name, timestamp.toString()];
+
+    final mockDateTime = MockIBGDateTime();
+    IBGDateTime.setInstance(mockDateTime);
+    when(mockDateTime.now()).thenAnswer((_) => timestamp);
+
     await APM.startExecutionTrace(name);
+
     expect(log, <Matcher>[
       isMethodCall(
         'startExecutionTrace:id:',
         arguments: args,
       )
     ]);
-  }, skip: 'TODO: mock timestamp');
+  });
 
   test('setExecutionTraceAttribute: Test', () async {
     const String name = 'test_trace';
@@ -1089,7 +1099,7 @@ void main() {
         arguments: args,
       )
     ]);
-  }, skip: 'TODO: mock timestamp');
+  });
 
   test('setCrashReportingEnabled: Test', () async {
     const bool isEnabled = false;