Migrate Surveys to NativeEventEmitter

Author: a7medev

android/src/main/java/com/instabug/reactlibrary/RNInstabugSurveysModule.java

@@ -1,15 +1,12 @@
 package com.instabug.reactlibrary;
 
-import android.os.Handler;
-import android.os.Looper;
-
 import com.facebook.react.bridge.Callback;
 import com.facebook.react.bridge.ReactApplicationContext;
-import com.facebook.react.bridge.ReactContextBaseJavaModule;
 import com.facebook.react.bridge.ReactMethod;
 import com.facebook.react.bridge.WritableArray;
 import com.instabug.library.Feature;
 import com.instabug.reactlibrary.utils.ArrayUtil;
+import com.instabug.reactlibrary.utils.EventEmitterModule;
 import com.instabug.reactlibrary.utils.InstabugUtil;
 import com.instabug.reactlibrary.utils.MainThreadHandler;
 import com.instabug.survey.callbacks.*;
@@ -22,7 +19,7 @@
 
 import javax.annotation.Nonnull;
 
-public class RNInstabugSurveysModule extends ReactContextBaseJavaModule {
+public class RNInstabugSurveysModule extends EventEmitterModule {
 
     public RNInstabugSurveysModule(ReactApplicationContext reactContext) {
         super(reactContext);
@@ -34,6 +31,16 @@ public String getName() {
         return "IBGSurveys";
     }
 
+    @ReactMethod
+    public void addListener(String event) {
+        super.addListener(event);
+    }
+
+    @ReactMethod
+    public void removeListeners(Integer count) {
+        super.removeListeners(count);
+    }
+
     /**
      * Returns true if the survey with a specific token was answered before.
      * Will return false if the token does not exist or if the survey was not answered before.
@@ -137,7 +144,7 @@ public void run() {
                 Surveys.setOnShowCallback(new OnShowCallback() {
                     @Override
                     public void onShow() {
-                        InstabugUtil.sendEvent(getReactApplicationContext(), Constants.IBG_ON_SHOW_SURVEY_HANDLER, null);
+                        sendEvent(Constants.IBG_ON_SHOW_SURVEY_HANDLER, null);
                     }
                 });
             }
@@ -159,7 +166,7 @@ public void run() {
                 Surveys.setOnDismissCallback(new OnDismissCallback() {
                     @Override
                     public void onDismiss() {
-                        InstabugUtil.sendEvent(getReactApplicationContext(), Constants.IBG_ON_DISMISS_SURVEY_HANDLER, null);
+                        sendEvent(Constants.IBG_ON_DISMISS_SURVEY_HANDLER, null);
                     }
                 });
             }

src/modules/Surveys.ts

@@ -1,13 +1,26 @@
-import { Platform } from 'react-native';
+import { NativeEventEmitter, Platform } from 'react-native';
 
 import { NativeSurveys } from '../native';
-import IBGEventEmitter from '../utils/IBGEventEmitter';
-import InstabugConstants from '../utils/InstabugConstants';
 
 export interface Survey {
   title: string;
 }
 
+/**
+ * @internal You shouldn't use this enum since you never emit or listen
+ * for native events in your code.
+ */
+export enum $NativeEvents {
+  WILL_SHOW_SURVEY_HANDLER = 'IBGWillShowSurvey',
+  DID_DISMISS_SURVEY_HANDLER = 'IBGDidDismissSurvey',
+}
+
+/**
+ * @internal You shouldn't use this since you never emit or listen for native
+ * events in your code.
+ */
+export const $emitter = new NativeEventEmitter(NativeSurveys);
+
 /**
  * Sets whether surveys are enabled or not.
  * If you disable surveys on the SDK but still have active surveys on your Instabug dashboard,
@@ -56,11 +69,7 @@ export const setAutoShowingEnabled = (autoShowingSurveysEnabled: boolean) => {
  * presenting the survey's UI.
  */
 export const setOnShowHandler = (onShowHandler: () => void) => {
-  IBGEventEmitter.addListener(
-    NativeSurveys,
-    InstabugConstants.WILL_SHOW_SURVEY_HANDLER,
-    onShowHandler,
-  );
+  $emitter.addListener($NativeEvents.WILL_SHOW_SURVEY_HANDLER, onShowHandler);
   NativeSurveys.setOnShowHandler(onShowHandler);
 };
 
@@ -72,11 +81,7 @@ export const setOnShowHandler = (onShowHandler: () => void) => {
  * the survey's UI is dismissed.
  */
 export const setOnDismissHandler = (onDismissHandler: () => void) => {
-  IBGEventEmitter.addListener(
-    NativeSurveys,
-    InstabugConstants.DID_DISMISS_SURVEY_HANDLER,
-    onDismissHandler,
-  );
+  $emitter.addListener($NativeEvents.DID_DISMISS_SURVEY_HANDLER, onDismissHandler);
   NativeSurveys.setOnDismissHandler(onDismissHandler);
 };
 

src/utils/InstabugConstants.ts

@@ -1,7 +1,5 @@
 enum InstabugConstants {
   ON_REPLY_RECEIVED_HANDLER = 'IBGOnNewReplyReceivedCallback',
-  WILL_SHOW_SURVEY_HANDLER = 'IBGWillShowSurvey',
-  DID_DISMISS_SURVEY_HANDLER = 'IBGDidDismissSurvey',
   GRAPHQL_HEADER = 'ibg-graphql-header',
 }
 

test/mocks/mockSurveys.ts

@@ -10,6 +10,8 @@ export default {
     showSurvey: jest.fn(),
     hasRespondedToSurvey: jest.fn((_, cb) => cb(true)),
     setShouldShowWelcomeScreen: jest.fn(),
+
     addListener: jest.fn(),
+    removeListeners: jest.fn(),
   },
 };

test/modules/Surveys.spec.ts

@@ -2,10 +2,15 @@ import { Platform } from 'react-native';
 
 import * as Surveys from '../../src/modules/Surveys';
 import { NativeSurveys } from '../../src/native';
-import IBGEventEmitter from '../../src/utils/IBGEventEmitter';
-import IBGConstants from '../../src/utils/InstabugConstants';
 
 describe('Surveys Module', () => {
+  beforeEach(() => {
+    const events = Object.values(Surveys.$NativeEvents);
+    events.forEach((event) => {
+      Surveys.$emitter.removeAllListeners(event);
+    });
+  });
+
   it('should call the native method setSurveysEnabled', () => {
     Surveys.setEnabled(true);
 
@@ -60,9 +65,9 @@ describe('Surveys Module', () => {
   it('should invoke callback on emitting the event IBGWillShowSurvey', () => {
     const callback = jest.fn();
     Surveys.setOnShowHandler(callback);
-    IBGEventEmitter.emit(IBGConstants.WILL_SHOW_SURVEY_HANDLER);
+    Surveys.$emitter.emit(Surveys.$NativeEvents.WILL_SHOW_SURVEY_HANDLER);
 
-    expect(IBGEventEmitter.getListeners(IBGConstants.WILL_SHOW_SURVEY_HANDLER).length).toEqual(1);
+    expect(Surveys.$emitter.listenerCount(Surveys.$NativeEvents.WILL_SHOW_SURVEY_HANDLER)).toBe(1);
     expect(callback).toHaveBeenCalled();
   });
 
@@ -77,9 +82,11 @@ describe('Surveys Module', () => {
   it('should invoke callback on emitting the event IBGDidDismissSurvey', () => {
     const callback = jest.fn();
     Surveys.setOnDismissHandler(callback);
-    IBGEventEmitter.emit(IBGConstants.DID_DISMISS_SURVEY_HANDLER);
+    Surveys.$emitter.emit(Surveys.$NativeEvents.DID_DISMISS_SURVEY_HANDLER);
 
-    expect(IBGEventEmitter.getListeners(IBGConstants.DID_DISMISS_SURVEY_HANDLER).length).toEqual(1);
+    expect(Surveys.$emitter.listenerCount(Surveys.$NativeEvents.DID_DISMISS_SURVEY_HANDLER)).toBe(
+      1,
+    );
     expect(callback).toHaveBeenCalled();
   });