refactor(in-app-messaging): migrate to TypeScript

Author: mikehardy

jest.setup.ts

@@ -261,7 +261,7 @@ jest.doMock('react-native', () => {
           transactionBegin: jest.fn(),
           transactionDispose: jest.fn(),
         },
-        RNFBInAppMessagingModule: {
+        RNFBFiamModule: {
           isMessagesDisplaySuppressed: false,
           isAutomaticDataCollectionEnabled: true,
           setMessagesDisplaySuppressed: jest.fn(),

packages/app/lib/common/index.ts

@@ -429,6 +429,15 @@ const mapOfDeprecationReplacements: DeprecationMap = {
       getToken: 'getToken()',
     },
   },
+  inAppMessaging: {
+    default: {
+      isMessagesDisplaySuppressed: 'isMessagesDisplaySuppressed()',
+      setMessagesDisplaySuppressed: 'setMessagesDisplaySuppressed()',
+      isAutomaticDataCollectionEnabled: 'isAutomaticDataCollectionEnabled()',
+      setAutomaticDataCollectionEnabled: 'setAutomaticDataCollectionEnabled()',
+      triggerEvent: 'triggerEvent()',
+    },
+  },
   messaging: {
     default: {
       isAutoInitEnabled: 'isAutoInitEnabled()',

packages/in-app-messaging/__tests__/inappmessaging.test.ts

@@ -1,4 +1,4 @@
-import { afterAll, beforeAll, describe, expect, it } from '@jest/globals';
+import { afterAll, beforeAll, beforeEach, describe, expect, it, jest } from '@jest/globals';
 
 import {
   firebase,
@@ -10,6 +10,14 @@ import {
   triggerEvent,
 } from '../lib';
 
+import {
+  createCheckV9Deprecation,
+  CheckV9DeprecationFunction,
+} from '../../app/lib/common/unitTestUtils';
+
+// @ts-ignore test
+import FirebaseModule from '../../app/lib/internal/FirebaseModule';
+
 describe('in-app-messaging', function () {
   describe('namespace', function () {
     beforeAll(async function () {
@@ -25,10 +33,36 @@ describe('in-app-messaging', function () {
     it('accessible from firebase.app()', function () {
       const app = firebase.app();
       expect(app.inAppMessaging).toBeDefined();
+      expect(app.inAppMessaging().app).toEqual(app);
     });
   });
 
   describe('modular', function () {
+    beforeEach(async function () {
+      // @ts-ignore test
+      jest.spyOn(FirebaseModule.prototype, 'native', 'get').mockImplementation(() => {
+        return new Proxy(
+          {},
+          {
+            get: (_target, prop) => {
+              if (
+                prop === 'isMessagesDisplaySuppressed' ||
+                prop === 'isAutomaticDataCollectionEnabled'
+              ) {
+                return false;
+              }
+
+              return jest.fn().mockResolvedValue(null as never);
+            },
+          },
+        );
+      });
+
+      const inAppMessaging = getInAppMessaging();
+      await setMessagesDisplaySuppressed(inAppMessaging, false);
+      await setAutomaticDataCollectionEnabled(inAppMessaging, false);
+    });
+
     it('`getInAppMessaging` function is properly exposed to end user', function () {
       expect(getInAppMessaging).toBeDefined();
     });
@@ -52,5 +86,103 @@ describe('in-app-messaging', function () {
     it('`triggerEvent` function is properly exposed to end user', function () {
       expect(triggerEvent).toBeDefined();
     });
+
+    it('updates isMessagesDisplaySuppressed synchronously after setMessagesDisplaySuppressed', function () {
+      const inAppMessaging = getInAppMessaging();
+      expect(isMessagesDisplaySuppressed(inAppMessaging)).toBe(false);
+      setMessagesDisplaySuppressed(inAppMessaging, true);
+      expect(isMessagesDisplaySuppressed(inAppMessaging)).toBe(true);
+    });
+
+    it('updates isMessagesDisplaySuppressed after setMessagesDisplaySuppressed resolves', async function () {
+      const inAppMessaging = getInAppMessaging();
+      await setMessagesDisplaySuppressed(inAppMessaging, true);
+      expect(isMessagesDisplaySuppressed(inAppMessaging)).toBe(true);
+    });
+
+    it('updates isAutomaticDataCollectionEnabled synchronously after setAutomaticDataCollectionEnabled', function () {
+      const inAppMessaging = getInAppMessaging();
+      expect(isAutomaticDataCollectionEnabled(inAppMessaging)).toBe(false);
+      setAutomaticDataCollectionEnabled(inAppMessaging, true);
+      expect(isAutomaticDataCollectionEnabled(inAppMessaging)).toBe(true);
+    });
+
+    it('updates isAutomaticDataCollectionEnabled after setAutomaticDataCollectionEnabled resolves', async function () {
+      const inAppMessaging = getInAppMessaging();
+      await setAutomaticDataCollectionEnabled(inAppMessaging, true);
+      expect(isAutomaticDataCollectionEnabled(inAppMessaging)).toBe(true);
+    });
+  });
+
+  describe('test `console.warn` is called for RNFB v8 API & not called for v9 API', function () {
+    let inAppMessagingV9Deprecation: CheckV9DeprecationFunction;
+
+    beforeEach(function () {
+      inAppMessagingV9Deprecation = createCheckV9Deprecation(['inAppMessaging']);
+
+      // @ts-ignore test
+      jest.spyOn(FirebaseModule.prototype, 'native', 'get').mockImplementation(() => {
+        return new Proxy(
+          {},
+          {
+            get: (_target, prop) => {
+              if (
+                prop === 'isMessagesDisplaySuppressed' ||
+                prop === 'isAutomaticDataCollectionEnabled'
+              ) {
+                return false;
+              }
+
+              return jest.fn().mockResolvedValue(null as never);
+            },
+          },
+        );
+      });
+    });
+
+    it('isMessagesDisplaySuppressed', function () {
+      const inAppMessaging = getInAppMessaging();
+      inAppMessagingV9Deprecation(
+        () => isMessagesDisplaySuppressed(inAppMessaging),
+        () => inAppMessaging.isMessagesDisplaySuppressed,
+        'isMessagesDisplaySuppressed',
+      );
+    });
+
+    it('setMessagesDisplaySuppressed', function () {
+      const inAppMessaging = getInAppMessaging();
+      inAppMessagingV9Deprecation(
+        () => setMessagesDisplaySuppressed(inAppMessaging, true),
+        () => inAppMessaging.setMessagesDisplaySuppressed(true),
+        'setMessagesDisplaySuppressed',
+      );
+    });
+
+    it('isAutomaticDataCollectionEnabled', function () {
+      const inAppMessaging = getInAppMessaging();
+      inAppMessagingV9Deprecation(
+        () => isAutomaticDataCollectionEnabled(inAppMessaging),
+        () => inAppMessaging.isAutomaticDataCollectionEnabled,
+        'isAutomaticDataCollectionEnabled',
+      );
+    });
+
+    it('setAutomaticDataCollectionEnabled', function () {
+      const inAppMessaging = getInAppMessaging();
+      inAppMessagingV9Deprecation(
+        () => setAutomaticDataCollectionEnabled(inAppMessaging, false),
+        () => inAppMessaging.setAutomaticDataCollectionEnabled(false),
+        'setAutomaticDataCollectionEnabled',
+      );
+    });
+
+    it('triggerEvent', function () {
+      const inAppMessaging = getInAppMessaging();
+      inAppMessagingV9Deprecation(
+        () => triggerEvent(inAppMessaging, 'test-event'),
+        () => inAppMessaging.triggerEvent('test-event'),
+        'triggerEvent',
+      );
+    });
   });
 });