[MOB-8850] Remove Deprecated APIs (#703)

* Remove Chats Module

* Remove Deprecated Surveys APIs

* Remove Deprecated Replies APIs

* Remove Deprecated BugReporting APIs

* Remove Deprecated Instabug APIs

There were 3 types of deprecated APIs:

 1. Methods who got renamed in JS but the native methods still had
    the old JS name (e.g. `start`).
 2. Methods who got moved to different modules, they were removed from
    iOS module but not Android (e.g. `getUnreadMessagesCount`).
 3. Methods who just got renamed in JS to match the native method name
    (e.g. `setStringToKey`).

* Update CHANGELOG

Co-authored-by: Ali Abdelfattah <[email protected]>

Author: TheBuggedYRN

CHANGELOG.md

@@ -3,6 +3,7 @@
 * Adds the ability to opt out of iOS source maps auto upload through the INSTABUG_SOURCEMAPS_UPLOAD_DISABLE env variable
 * Adds dynamic entry file support through the INSTABUG_ENTRY_FILE env variable
 * Fixes an issue with swipe invocation event not working on Android
+* Breaking: Removes the deprecated APIs. For the full list, check PR #703
 
 ## 10.13.0 (2022-03-17)
 

InstabugSample/App.js

@@ -20,7 +20,6 @@ import Instabug, {
   BugReporting,
   FeatureRequests,
   Surveys,
-  Chats,
   CrashReporting,
   Replies,
 } from 'instabug-reactnative';
@@ -138,13 +137,11 @@ class Home extends Component<{}> {
   }
 
   sendFeedback() {
-    BugReporting.showWithOptions(BugReporting.reportType.feedback, [
-      BugReporting.option.emailFieldHidden,
-    ]);
+    BugReporting.show(BugReporting.reportType.feedback, [BugReporting.option.emailFieldHidden]);
   }
 
   startNewConversation() {
-    BugReporting.showWithOptions(BugReporting.reportType.question);
+    BugReporting.show(BugReporting.reportType.question);
   }
 
   showUnreadMessagesCount() {

InstabugSample/ios/InstabugSample.xcodeproj/project.pbxproj

@@ -12,7 +12,6 @@
 		13B07FBF1A68108700A75B9A /* Images.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 13B07FB51A68108700A75B9A /* Images.xcassets */; };
 		13B07FC11A68108700A75B9A /* main.m in Sources */ = {isa = PBXBuildFile; fileRef = 13B07FB71A68108700A75B9A /* main.m */; };
 		5614D013CB1F880181CC6385 /* libPods-InstabugSample-InstabugSampleTests.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 195CA9739B516DE1C316BC72 /* libPods-InstabugSample-InstabugSampleTests.a */; };
-		63D4BF6E2715AA740039BE63 /* InstabugChatsTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 63D4BF662715AA740039BE63 /* InstabugChatsTests.m */; };
 		63D4BF6F2715AA740039BE63 /* InstabugSurveysTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 63D4BF682715AA740039BE63 /* InstabugSurveysTests.m */; };
 		63D4BF702715AA740039BE63 /* InstabugFeatureRequestsTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 63D4BF692715AA740039BE63 /* InstabugFeatureRequestsTests.m */; };
 		63D4BF712715AA740039BE63 /* InstabugAPMTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 63D4BF6A2715AA740039BE63 /* InstabugAPMTests.m */; };
@@ -48,7 +47,6 @@
 		3FAC85A98493CDAD1F8FB224 /* libPods-InstabugSample.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = "libPods-InstabugSample.a"; sourceTree = BUILT_PRODUCTS_DIR; };
 		4787814ECE7122710F5A5A59 /* Pods-InstabugSample-InstabugSampleTests.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-InstabugSample-InstabugSampleTests.debug.xcconfig"; path = "Target Support Files/Pods-InstabugSample-InstabugSampleTests/Pods-InstabugSample-InstabugSampleTests.debug.xcconfig"; sourceTree = "<group>"; };
 		618F0D2C25DB5EDD119673AA /* Pods-InstabugSample.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-InstabugSample.debug.xcconfig"; path = "Target Support Files/Pods-InstabugSample/Pods-InstabugSample.debug.xcconfig"; sourceTree = "<group>"; };
-		63D4BF662715AA740039BE63 /* InstabugChatsTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = InstabugChatsTests.m; sourceTree = "<group>"; };
 		63D4BF672715AA740039BE63 /* IBGConstants.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = IBGConstants.h; sourceTree = "<group>"; };
 		63D4BF682715AA740039BE63 /* InstabugSurveysTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = InstabugSurveysTests.m; sourceTree = "<group>"; };
 		63D4BF692715AA740039BE63 /* InstabugFeatureRequestsTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = InstabugFeatureRequestsTests.m; sourceTree = "<group>"; };
@@ -88,7 +86,6 @@
 				63D4BF6D2715AA740039BE63 /* IBGConstants.m */,
 				63D4BF6A2715AA740039BE63 /* InstabugAPMTests.m */,
 				63D4BF6C2715AA740039BE63 /* InstabugBugReportingTests.m */,
-				63D4BF662715AA740039BE63 /* InstabugChatsTests.m */,
 				63D4BF692715AA740039BE63 /* InstabugFeatureRequestsTests.m */,
 				63D4BF6B2715AA740039BE63 /* InstabugRepliesTests.m */,
 				63D4BF682715AA740039BE63 /* InstabugSurveysTests.m */,
@@ -438,7 +435,6 @@
 			files = (
 				63D4BF742715AA740039BE63 /* IBGConstants.m in Sources */,
 				63D4BF712715AA740039BE63 /* InstabugAPMTests.m in Sources */,
-				63D4BF6E2715AA740039BE63 /* InstabugChatsTests.m in Sources */,
 				63D4BF702715AA740039BE63 /* InstabugFeatureRequestsTests.m in Sources */,
 				63D4BF732715AA740039BE63 /* InstabugBugReportingTests.m in Sources */,
 				00E356F31AD99517003FC87E /* InstabugSampleTests.m in Sources */,

InstabugSample/ios/InstabugSampleTests/InstabugChatsTests.m

@@ -52,15 +52,15 @@ - (void)setUp {
  +------------------------------------------------------------------------+
  */
 
-- (void)testStartWithToken {
+- (void)testStart {
   id<InstabugCPTestProtocol> mock = OCMClassMock([Instabug class]);
   IBGInvocationEvent floatingButtonInvocationEvent = IBGInvocationEventFloatingButton;
   NSString *appToken = @"app_token";
   NSArray *invocationEvents = [NSArray arrayWithObjects:[NSNumber numberWithInteger:floatingButtonInvocationEvent], nil];
-  XCTestExpectation *expectation = [self expectationWithDescription:@"Testing [Instabug startWithToken]"];
+  XCTestExpectation *expectation = [self expectationWithDescription:@"Testing [Instabug start]"];
 
   OCMStub([mock startWithToken:appToken invocationEvents:floatingButtonInvocationEvent]);
-  [self.instabugBridge startWithToken:appToken invocationEvents:invocationEvents];
+  [self.instabugBridge start:appToken invocationEvents:invocationEvents];
 
   [[NSRunLoop mainRunLoop] performBlock:^{
     OCMVerify([mock startWithToken:appToken invocationEvents:floatingButtonInvocationEvent]);
@@ -171,13 +171,13 @@ - (void)testSetString {
   OCMVerify([mock setValue:value forStringWithKey:key]);
 }
 
-- (void)testIdentifyUserWithEmail {
+- (void)testIdentifyUser {
   id mock = OCMClassMock([Instabug class]);
   NSString *email = @"[email protected]";
   NSString *name = @"this is my name";
 
   OCMStub([mock identifyUserWithEmail:email name:name]);
-  [self.instabugBridge identifyUserWithEmail:email name:name];
+  [self.instabugBridge identifyUser:email name:name];
   OCMVerify([mock identifyUserWithEmail:email name:name]);
 }
 
@@ -189,12 +189,12 @@ - (void)testLogOut {
   OCMVerify([mock logOut]);
 }
 
-- (void)testLogUserEventWithName {
+- (void)testLogUserEvent {
   id mock = OCMClassMock([Instabug class]);
   NSString *name = @"event name";
 
   OCMStub([mock logUserEventWithName:name]);
-  [self.instabugBridge logUserEventWithName:name];
+  [self.instabugBridge logUserEvent:name];
   OCMVerify([mock logUserEventWithName:name]);
 }
 
@@ -266,12 +266,6 @@ - (void)testClearAllUserAttributes {
   OCMVerify([mock removeUserAttributeForKey:key]);
 }
 
-- (void)testSetViewHierarchyEnabled {
-  BOOL enabled = true;
-  [self.instabugBridge setViewHierarchyEnabled:enabled];
-  XCTAssertTrue(Instabug.shouldCaptureViewHierarchy);
-}
-
 - (void)testShowWelcomeMessageWithMode {
   id mock = OCMClassMock([Instabug class]);
   IBGWelcomeMessageMode welcomeMessageMode = IBGWelcomeMessageModeBeta;

InstabugSample/ios/InstabugSampleTests/InstabugSampleTests.m

@@ -65,12 +65,12 @@ describe('Testing BugReporting Module', () => {
 
   });
 
-  it('should call the native method setInvocationOptions with an array of invocationOptions', () => {
+  it('should call the native method setOptions with an array of options', () => {
 
-    const arrayOfInvocationOptions = [BugReporting.invocationOptions.commentFieldRequired];
-    BugReporting.setInvocationOptions(arrayOfInvocationOptions);
+    const arrayOfOptions = [BugReporting.option.commentFieldRequired];
+    BugReporting.setOptions(arrayOfOptions);
 
-    expect(setOptions.calledOnceWithExactly(arrayOfInvocationOptions)).toBe(true);
+    expect(setOptions.calledOnceWithExactly(arrayOfOptions)).toBe(true);
 
   });
 
@@ -151,7 +151,7 @@ describe('Testing BugReporting Module', () => {
   it('should call the native method show with a reportType and array of options', () => {
 
     const reportType = BugReporting.reportType.bug;
-    const arrayOfOptions = [BugReporting.invocationOptions.commentFieldRequired];
+    const arrayOfOptions = [BugReporting.option.commentFieldRequired];
     BugReporting.show(reportType, arrayOfOptions);
 
     expect(show.calledOnceWithExactly(reportType, arrayOfOptions)).toBe(true);

__tests__/bugReporting.spec.js

@@ -20,24 +20,21 @@ import InstabugUtils from '../utils/InstabugUtils';
 
 describe('Instabug Module', () => {
 
-  const startWithToken = sinon.spy(NativeModules.Instabug, 'startWithToken');
+  const start = sinon.spy(NativeModules.Instabug, 'start');
   const setUserData = sinon.spy(NativeModules.Instabug, 'setUserData');
   const setTrackUserSteps = sinon.spy(NativeModules.Instabug, 'setTrackUserSteps');
   const setIBGLogPrintsToConsole = sinon.spy(NativeModules.Instabug, 'setIBGLogPrintsToConsole');
   const setSessionProfilerEnabled = sinon.spy(NativeModules.Instabug, 'setSessionProfilerEnabled');
-  const setPushNotificationsEnabled = sinon.spy(NativeModules.IBGReplies, 'setPushNotificationsEnabled');
-  const setFloatingButtonEdge = sinon.spy(NativeModules.IBGBugReporting, 'setFloatingButtonEdge');
   const setLocale = sinon.spy(NativeModules.Instabug, 'setLocale');
   const setColorTheme = sinon.spy(NativeModules.Instabug, 'setColorTheme');
   const setPrimaryColor = sinon.spy(NativeModules.Instabug, 'setPrimaryColor');
   const appendTags = sinon.spy(NativeModules.Instabug, 'appendTags');
   const resetTags = sinon.spy(NativeModules.Instabug, 'resetTags');
   const getTags = sinon.spy(NativeModules.Instabug, 'getTags');
   const setString = sinon.spy(NativeModules.Instabug, 'setString');
-  const setEnabledAttachmentTypes = sinon.spy(NativeModules.IBGBugReporting, 'setEnabledAttachmentTypes');
-  const identifyUserWithEmail = sinon.spy(NativeModules.Instabug, 'identifyUserWithEmail');
+  const identifyUser = sinon.spy(NativeModules.Instabug, 'identifyUser');
   const logOut = sinon.spy(NativeModules.Instabug, 'logOut');
-  const logUserEventWithName = sinon.spy(NativeModules.Instabug, 'logUserEventWithName');
+  const logUserEvent = sinon.spy(NativeModules.Instabug, 'logUserEvent');
   const log = sinon.spy(NativeModules.Instabug, 'log');
   const logVerbose = sinon.spy(NativeModules.Instabug, 'logVerbose');
   const logInfo = sinon.spy(NativeModules.Instabug, 'logInfo');
@@ -71,10 +68,9 @@ describe('Instabug Module', () => {
   const clearAllExperiments = sinon.spy(NativeModules.Instabug, 'clearAllExperiments');
 
   beforeEach(() => {
-    startWithToken.resetHistory();
+    start.resetHistory();
     setTrackUserSteps.resetHistory();
     setIBGLogPrintsToConsole.resetHistory();
-    setPushNotificationsEnabled.resetHistory();
     log.resetHistory();
     setSdkDebugLogsLevel.resetHistory();
     setDebugEnabled.resetHistory();
@@ -104,25 +100,25 @@ describe('Instabug Module', () => {
     expect(reportScreenChange.calledOnceWithExactly(screenName)).toBe(true);
   });
 
-  it('should call the native method startWithToken', () => {
+  it('should call the native method start', () => {
 
     Platform.OS = 'ios';
     const token = 'some-token';
     const invocationEvents = [Instabug.invocationEvent.floatingButton, Instabug.invocationEvent.shake];
     Instabug.start(token, invocationEvents);
 
-    expect(startWithToken.calledOnceWithExactly(token, invocationEvents)).toBe(true);
+    expect(start.calledOnceWithExactly(token, invocationEvents)).toBe(true);
 
   });
 
-  // it('should not call the native method startWithToken when platform is android', () => {
+  // it('should not call the native method start when platform is android', () => {
 
   //   Platform.OS = 'android';
   //   const token = 'some-token';
   //   const invocationEvents = [Instabug.invocationEvent.floatingButton, Instabug.invocationEvent.shake];
   //   Instabug.start(token, invocationEvents);
 
-  //   expect(startWithToken.calledOnceWithExactly(token, invocationEvents)).toBe(true);
+  //   expect(start.calledOnceWithExactly(token, invocationEvents)).toBe(true);
 
   // });
 
@@ -179,25 +175,6 @@ describe('Instabug Module', () => {
 
   });
 
-  it('should call the native method setPushNotificationsEnabled', () => {
-
-    Platform.OS = 'ios';
-    Instabug.setPushNotificationsEnabled(true);
-
-    expect(setPushNotificationsEnabled.calledOnceWithExactly(true)).toBe(true);
-
-  });
-
-  it('should call the native method setFloatingButtonEdge', () => {
-
-    const offsetFromTop = 10;
-    const edge = Instabug.floatingButtonEdge.left;
-    Instabug.setFloatingButtonEdge(edge, offsetFromTop);
-
-    expect(setFloatingButtonEdge.calledOnceWithExactly(edge, offsetFromTop)).toBe(true);
-
-  });
-
   it('should call the native method setLocale', () => {
 
     const locale = Instabug.locale.english;
@@ -263,22 +240,14 @@ describe('Instabug Module', () => {
 
   });
 
-  it('should call the native method setEnabledAttachmentTypes', () => {
-
-    Instabug.setEnabledAttachmentTypes(true, true, false, true);
-
-    expect(setEnabledAttachmentTypes.calledOnceWithExactly(true, true, false, true)).toBe(true);
-
-  });
-
-  it('should call the native method identifyUserWithEmail', () => {
+  it('should call the native method identifyUser', () => {
 
 
     const email = '[email protected]';
     const name = 'Instabug';
     Instabug.identifyUser(email, name);
 
-    expect(identifyUserWithEmail.calledOnceWithExactly(email, name)).toBe(true);
+    expect(identifyUser.calledOnceWithExactly(email, name)).toBe(true);
 
   });
 
@@ -290,12 +259,12 @@ describe('Instabug Module', () => {
 
   });
 
-  it('should call the native method logUserEventWithName', () => {
+  it('should call the native method logUserEvent', () => {
 
     const event = 'click';
     Instabug.logUserEvent(event);
 
-    expect(logUserEventWithName.calledOnceWithExactly(event)).toBe(true);
+    expect(logUserEvent.calledOnceWithExactly(event)).toBe(true);
 
   });