Merge pull request #548 from Instabug/release/v10.0.0

Release/v10.0.0

Author: bsameh-at-instabug

CHANGELOG.md

@@ -1,3 +1,10 @@
+## v10.0.0 (2021-02-10)
+
+* Introduces Instabug’s new App Performance Monitoring (APM)
+* Adds support for Push Notifications
+* Bumps the minimum supported iOS version to iOS 10
+* Various bug fixes and improvements
+
 ## v9.1.10 (2020-12-02)
 
 * Fixes a crash caused by the network logger when the object passed is too large

InstabugSample/ios/InstabugSample.xcodeproj/project.pbxproj

@@ -21,6 +21,7 @@
 		BAD36E3122F19973007F5E74 /* InstabugRepliesTests.m in Sources */ = {isa = PBXBuildFile; fileRef = BAD36E3022F19973007F5E74 /* InstabugRepliesTests.m */; };
 		BAD36E3322F19B1B007F5E74 /* InstabugSurveysTests.m in Sources */ = {isa = PBXBuildFile; fileRef = BAD36E3222F19B1B007F5E74 /* InstabugSurveysTests.m */; };
 		C006102922E9EBCA00EDC852 /* libOCMock.a in Frameworks */ = {isa = PBXBuildFile; fileRef = C006102822E9EBCA00EDC852 /* libOCMock.a */; };
+		C0AB369625854A6100F1E21E /* InstabugAPMTests.m in Sources */ = {isa = PBXBuildFile; fileRef = C0AB369525854A6100F1E21E /* InstabugAPMTests.m */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXContainerItemProxy section */
@@ -63,9 +64,9 @@
 		BAD36E3022F19973007F5E74 /* InstabugRepliesTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = InstabugRepliesTests.m; sourceTree = "<group>"; };
 		BAD36E3222F19B1B007F5E74 /* InstabugSurveysTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = InstabugSurveysTests.m; sourceTree = "<group>"; };
 		C006102822E9EBCA00EDC852 /* libOCMock.a */ = {isa = PBXFileReference; lastKnownFileType = archive.ar; name = libOCMock.a; path = usr/lib/libOCMock.a; sourceTree = "<group>"; };
+		C0AB369525854A6100F1E21E /* InstabugAPMTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = InstabugAPMTests.m; sourceTree = "<group>"; };
 		C74E4010ABE7AFC7DB5E79DC /* Pods-InstabugSampleTests.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-InstabugSampleTests.debug.xcconfig"; path = "Pods/Target Support Files/Pods-InstabugSampleTests/Pods-InstabugSampleTests.debug.xcconfig"; sourceTree = "<group>"; };
 		ED297162215061F000B7C4FE /* JavaScriptCore.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = JavaScriptCore.framework; path = System/Library/Frameworks/JavaScriptCore.framework; sourceTree = SDKROOT; };
-		FA49CB8462F384E9EDD7DDFD /* Instabug.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Instabug.framework; path = "../node_modules/instabug-reactnative/ios/Instabug.framework"; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -101,6 +102,7 @@
 				BAD36E2E22F19788007F5E74 /* InstabugFeatureRequestsTests.m */,
 				BAD36E3022F19973007F5E74 /* InstabugRepliesTests.m */,
 				BAD36E3222F19B1B007F5E74 /* InstabugSurveysTests.m */,
+				C0AB369525854A6100F1E21E /* InstabugAPMTests.m */,
 			);
 			path = InstabugSampleTests;
 			sourceTree = "<group>";
@@ -410,6 +412,7 @@
 				BAD36E1E22F0906A007F5E74 /* IBGConstants.m in Sources */,
 				BAD36E3322F19B1B007F5E74 /* InstabugSurveysTests.m in Sources */,
 				BAD36E2F22F19788007F5E74 /* InstabugFeatureRequestsTests.m in Sources */,
+				C0AB369625854A6100F1E21E /* InstabugAPMTests.m in Sources */,
 				BAD36E1C22F08B27007F5E74 /* InstabugBugReportingTests.m in Sources */,
 				BAD36E2D22F1955C007F5E74 /* InstabugChatsTests.m in Sources */,
 				00E356F31AD99517003FC87E /* InstabugSampleTests.m in Sources */,

InstabugSample/ios/InstabugSampleTests/InstabugAPMTests.m

@@ -0,0 +1,151 @@
+//
+//  InstabugAPMTests.m
+//  InstabugSampleTests
+//
+//  Created by Ali Abdelfattah on 12/12/20.
+//  Copyright © 2020 Facebook. All rights reserved.
+//
+
+#import <XCTest/XCTest.h>
+#import "OCMock/OCMock.h"
+#import "InstabugAPMBridge.h"
+#import <Instabug/IBGTypes.h>
+#import <Instabug/IBGAPM.h>
+#import "Instabug/Instabug.h"
+#import "IBGConstants.h"
+
+@interface InstabugAPMTests : XCTestCase
+@property (nonatomic, retain) InstabugAPMBridge *instabugBridge;
+@end
+
+@protocol APMCPTestProtocol <NSObject>
+/**
+ * This protocol helps in correctly mapping APM mocked methods
+ * when their method name matches another method in a different
+ * module that differs in method signature.
+ */
+- (void)setEnabled:(BOOL)isEnabled;
+
+@end
+
+@protocol ExecutionTraceCPTestProtocol <NSObject>
+/**
+ * This protocol helps in correctly mapping IBGExecutionTrace mocked methods
+ * when their method name matches another method in a different
+ * module that differs in method signature.
+ */
+- (void)end;
+@end
+
+@implementation InstabugAPMTests
+
+- (void)setUp {
+    // Put setup code here. This method is called before the invocation of each test method in the class.
+    self.instabugBridge = [[InstabugAPMBridge alloc] init];
+}
+
+/*
++------------------------------------------------------------------------+
+|                            APM Module                              |
++------------------------------------------------------------------------+
+*/
+
+- (void) testSetAPMEnabled {
+  id mock = OCMClassMock([IBGAPM class]);
+  BOOL isEnabled = YES;
+
+  OCMStub([mock setEnabled:isEnabled]);
+  [self.instabugBridge setEnabled:isEnabled];
+  OCMVerify([mock setEnabled:isEnabled]);
+}
+
+- (void) testSetLogLevel {
+  id mock = OCMClassMock([IBGAPM class]);
+  BOOL logLevel = IBGLogLevelVerbose;
+  
+  OCMStub([mock setLogLevel:logLevel]);
+  [self.instabugBridge setLogLevel:logLevel];
+  OCMVerify([mock setLogLevel:logLevel]);
+}
+
+- (void) testSetAppLaunchEnabled {
+  id mock = OCMClassMock([IBGAPM class]);
+  BOOL isEnabled = YES;
+  
+  OCMStub([mock setAppLaunchEnabled:isEnabled]);
+  [self.instabugBridge setAppLaunchEnabled:isEnabled];
+  OCMVerify([mock setAppLaunchEnabled:isEnabled]);
+}
+
+- (void) testSetAutoUITraceEnabled {
+  id mock = OCMClassMock([IBGAPM class]);
+  BOOL isEnabled = YES;
+  
+  OCMStub([mock setAutoUITraceEnabled:isEnabled]);
+  [self.instabugBridge setAutoUITraceEnabled:isEnabled];
+  OCMVerify([mock setAutoUITraceEnabled:isEnabled]);
+}
+
+- (void) testStartExecutionTrace {
+  id mock = OCMClassMock([IBGAPM class]);
+  NSString* traceName = @"Trace_1";
+  NSString* traceKey = @"1";
+  RCTResponseSenderBlock callback = ^(NSArray *response) {};
+  
+  OCMStub([mock startExecutionTraceWithName:traceName]);
+  [self.instabugBridge startExecutionTrace:traceName :traceKey :callback];
+  OCMVerify([mock startExecutionTraceWithName:traceName]);
+}
+
+- (void) testSetExecutionTraceAttribute {
+  NSString* traceName = @"Trace_1";
+  NSString* traceId = @"Id_1";
+  NSString* traceKey = @"Key_1";
+  NSString* traceValue = @"1";
+  RCTResponseSenderBlock callback = ^(NSArray *response) {};
+  IBGExecutionTrace * trace = [IBGExecutionTrace alloc];
+  id mock = OCMClassMock([IBGAPM class]);
+  id traceMock = OCMPartialMock(trace);
+  
+  OCMStub([mock startExecutionTraceWithName:traceName]).andReturn(trace);
+  [self.instabugBridge startExecutionTrace:traceName :traceId :callback];
+  
+  OCMStub([traceMock setAttributeWithKey:traceKey value:traceValue]);
+  [self.instabugBridge setExecutionTraceAttribute:traceId :traceKey :traceValue];
+  OCMVerify([traceMock setAttributeWithKey:traceKey value:traceValue]);
+}
+
+- (void) testEndExecutionTrace {
+  NSString* traceName = @"Trace_1";
+  NSString* traceId = @"Id_1";
+  RCTResponseSenderBlock callback = ^(NSArray *response) {};
+  IBGExecutionTrace * trace = [IBGExecutionTrace alloc];
+  id apmMock = OCMClassMock([IBGAPM class]);
+  id<ExecutionTraceCPTestProtocol> traceMock = OCMPartialMock(trace);
+
+  OCMStub([apmMock startExecutionTraceWithName:traceName]).andReturn(trace);
+  [self.instabugBridge startExecutionTrace:traceName :traceId :callback];
+  
+  OCMStub([traceMock end]);
+  [self.instabugBridge endExecutionTrace:traceId];
+  OCMVerify([traceMock end]);
+}
+
+- (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]);
+}
+
+@end

__tests__/apm.spec.js

@@ -0,0 +1,84 @@
+/**
+ * @format
+ * @lint-ignore-every XPLATJSCOPYRIGHT1
+ */
+
+import "react-native";
+import { NativeModules } from "react-native";
+import "../jest/mockAPM";
+import APM from "../modules/APM";
+import sinon from "sinon";
+
+import IBGEventEmitter from "../utils/IBGEventEmitter";
+
+describe("APM Module", () => {
+  const setEnabled = sinon.spy(NativeModules.IBGAPM, "setEnabled");
+  const setAppLaunchEnabled = sinon.spy(NativeModules.IBGAPM, "setAppLaunchEnabled");
+  const setLogLevel = sinon.spy(NativeModules.IBGAPM, "setLogLevel");
+  const setAutoUITraceEnabled = sinon.spy(NativeModules.IBGAPM, "setAutoUITraceEnabled");
+  const startExecutionTrace = sinon.spy(NativeModules.IBGAPM, "startExecutionTrace");
+  const setExecutionTraceAttribute = sinon.spy(NativeModules.IBGAPM, "setExecutionTraceAttribute");
+  const endExecutionTrace = sinon.spy(NativeModules.IBGAPM, "endExecutionTrace");
+  const startUITrace = sinon.spy(NativeModules.IBGAPM, "startUITrace");
+  const endUITrace = sinon.spy(NativeModules.IBGAPM, "endUITrace");
+
+  beforeEach(() => {
+    IBGEventEmitter.removeAllListeners();
+  });
+
+  it("should call the native method setEnabled", () => {
+    APM.setEnabled(true);
+
+    expect(setEnabled.calledOnceWithExactly(true)).toBe(true);
+  });
+
+  it("should call the native method setAppLaunchEnabled", () => {
+    APM.setAppLaunchEnabled(true);
+
+    expect(setAppLaunchEnabled.calledOnceWithExactly(true)).toBe(true);
+  });
+
+  it("should call the native method setAutoUITraceEnabled", () => {
+    APM.setAutoUITraceEnabled(true);
+
+    expect(setAutoUITraceEnabled.calledOnceWithExactly(true)).toBe(true);
+  });
+
+  it("should call the native method setLogLevel", () => {
+    APM.setLogLevel(APM.logLevel.verbose);
+
+    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");
+
+    expect(startUITrace.calledOnceWithExactly("uiTrace")).toBe(true);
+  });
+
+  it("should call the native method endUITrace", () => {
+    APM.endUITrace();
+
+    expect(endUITrace.calledOnceWithExactly()).toBe(true);
+  });
+});

__tests__/index.spec.js

@@ -196,15 +196,6 @@ describe('Instabug Module', () => {
 
   });
 
-  it('should not call the native method setPushNotificationsEnabled when platform is android', () => {
-
-    Platform.OS = 'android';
-    Instabug.setPushNotificationsEnabled(true);
-
-    expect(setPushNotificationsEnabled.notCalled).toBe(true);
-
-  });
-
   it('should call the native method setLocale', () => {
 
     const locale = Instabug.locale.english;

__tests__/replies.spec.js

@@ -21,12 +21,20 @@ describe('Replies Module', () => {
   const setChatNotificationEnabled = sinon.spy(NativeModules.IBGReplies, 'setInAppNotificationEnabled');
   const setEnableInAppNotificationSound = sinon.spy(NativeModules.IBGReplies, 'setInAppNotificationSound');
   const setPushNotificationsEnabled = sinon.spy(NativeModules.IBGReplies, 'setPushNotificationsEnabled');
+  const setPushNotificationRegistrationToken = sinon.spy(NativeModules.IBGReplies, 'setPushNotificationRegistrationToken');
+  const setNotificationIcon = sinon.spy(NativeModules.IBGReplies, 'setNotificationIcon');
+  const setPushNotificationChannelId = sinon.spy(NativeModules.IBGReplies, 'setPushNotificationChannelId');
+  const setSystemReplyNotificationSoundEnabled = sinon.spy(NativeModules.IBGReplies, 'setSystemReplyNotificationSoundEnabled');
 
   beforeEach(() => {
     setOnNewReplyReceivedCallback.resetHistory();
     setEnableInAppNotificationSound.resetHistory();
     IBGEventEmitter.removeAllListeners();
     setPushNotificationsEnabled.resetHistory();
+    setPushNotificationRegistrationToken.resetHistory();
+    setNotificationIcon.resetHistory();
+    setPushNotificationChannelId.resetHistory();
+    setSystemReplyNotificationSoundEnabled.resetHistory();
   });
 
   it('should call the native method setRepliesEnabled', () => {
@@ -115,24 +123,73 @@ describe('Replies Module', () => {
 
   });
 
+
   it('should call the native method setPushNotificationsEnabled', () => {
 
-    Platform.OS = 'ios';
     Replies.setPushNotificationsEnabled(true);
 
     expect(setPushNotificationsEnabled.calledOnceWithExactly(true)).toBe(true);
 
   });
 
 
-  it('should not call the native method setPushNotificationsEnabled when platform is android', () => {
+  it('should call the native method setPushNotificationRegistrationToken on Android', () => {
+    Platform.OS = 'android';
+    Replies.setPushNotificationRegistrationTokenAndroid('123');
+
+    expect(setPushNotificationRegistrationToken.calledOnceWithExactly('123')).toBe(true);
+  });
+
+  it('should not call the native method setPushNotificationRegistrationToken on iOS', () => {
+    Platform.OS = 'ios';
+    Replies.setPushNotificationRegistrationTokenAndroid(true);
+
+    expect(setPushNotificationRegistrationToken.notCalled).toBe(true);
+  });
+
 
+  it('should call the native method setNotificationIcon on Android', () => {
     Platform.OS = 'android';
-    Replies.setPushNotificationsEnabled(true);
+    Replies.setNotificationIconAndroid(123);
+
+    expect(setNotificationIcon.calledOnceWithExactly(123)).toBe(true);
+  });
 
-    expect(setPushNotificationsEnabled.notCalled).toBe(true);
+  it('should not call the native method setNotificationIcon on iOS', () => {
+    Platform.OS = 'ios';
+    Replies.setNotificationIconAndroid(123);
 
+    expect(setNotificationIcon.notCalled).toBe(true);
   });
 
 
+  it('should call the native method setPushNotificationChannelId on Android', () => {
+    Platform.OS = 'android';
+    Replies.setPushNotificationChannelIdAndroid('123');
+
+    expect(setPushNotificationChannelId.calledOnceWithExactly('123')).toBe(true);
+  });
+
+  it('should not call the native method setPushNotificationChannelId on iOS', () => {
+    Platform.OS = 'ios';
+    Replies.setPushNotificationChannelIdAndroid('123');
+
+    expect(setPushNotificationChannelId.notCalled).toBe(true);
+  });
+
+
+  it('should call the native method setSystemReplyNotificationSoundEnabled on Android', () => {
+    Platform.OS = 'android';
+    Replies.setSystemReplyNotificationSoundEnabledAndroid(true);
+
+    expect(setSystemReplyNotificationSoundEnabled.calledOnceWithExactly(true)).toBe(true);
+  });
+
+  it('should not call the native method setSystemReplyNotificationSoundEnabled on iOS', () => {
+    Platform.OS = 'ios';
+    Replies.setSystemReplyNotificationSoundEnabledAndroid(true);
+
+    expect(setSystemReplyNotificationSoundEnabled.notCalled).toBe(true);
+  });
+
 });