refactor: de-duplicate deprecation warning calls and tests (#8135)

invertase · Nov 14, 2024 · 78bde5e · 78bde5e
1 parent 4667063
commit 78bde5e
Show file tree

Hide file tree

Showing 4 changed files with 66 additions and 101 deletions.
diff --git a/packages/app/__tests__/app.test.ts b/packages/app/__tests__/app.test.ts
@@ -10,6 +10,16 @@ import firebase, {
   setLogLevel,
 } from '../lib';
 
+// this could be extracted to some test utils location
+const checkV9Deprecation = (modularFunction: () => void, nonModularFunction: () => void) => {
+  const consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+  modularFunction();
+  expect(consoleWarnSpy).not.toHaveBeenCalled();
+  nonModularFunction();
+  expect(consoleWarnSpy).toHaveBeenCalledTimes(1);
+  consoleWarnSpy.mockRestore();
+};
+
 describe('App', function () {
   describe('modular', function () {
     it('`deleteApp` function is properly exposed to end user', function () {
@@ -41,78 +51,56 @@ describe('App', function () {
     });
   });
 
-  describe('test `console.warn` is called for RNFB v8 API & not called for v9 API', function () {
+  describe('`console.warn` only called for non-modular API', function () {
     it('deleteApp', function () {
-      const firebaseApp = firebase.app();
-      const consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+      // this test has a slightly special setup
       // @ts-ignore test
-      jest.spyOn(firebaseApp, '_deleteApp').mockImplementation(() => Promise.resolve(null));
-      // we don't need to test this because we call underlying deleteApp directly
-      // deleteApp(firebaseApp);
-
-      firebaseApp.delete();
-      // Check that console.warn was called for v8 method call
-      expect(consoleWarnSpy).toHaveBeenCalled();
-      // Restore the original console.warn
-      consoleWarnSpy.mockRestore();
+      jest.spyOn(getApp(), '_deleteApp').mockImplementation(() => Promise.resolve(null));
+      checkV9Deprecation(
+        () => {}, // no modular replacement
+        () => getApp().delete(), // modular getApp(), then non-modular to check
+      );
     });
 
     it('getApps', function () {
-      const consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
-      // Check that console.warn was not called for v9 method call
-      getApps();
-      expect(consoleWarnSpy).not.toHaveBeenCalled();
-      // Check that console.warn was called for v8 method call
-      firebase.apps;
-      expect(consoleWarnSpy).toHaveBeenCalled();
-      // Restore the original console.warn
-      consoleWarnSpy.mockRestore();
+      checkV9Deprecation(
+        () => getApps(),
+        () => firebase.apps,
+      );
     });
 
     it('getApp', function () {
-      const consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
-      // Check that console.warn was not called for v9 method call
-      getApp();
-      expect(consoleWarnSpy).not.toHaveBeenCalled();
-      // Check that console.warn was called for v8 method call
-      firebase.app();
-      expect(consoleWarnSpy).toHaveBeenCalled();
-      // Restore the original console.warn
-      consoleWarnSpy.mockRestore();
+      checkV9Deprecation(
+        () => getApp(),
+        () => firebase.app(),
+      );
     });
 
     it('setLogLevel', function () {
-      const consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
-      // Check that console.warn was not called for v9 method call
-      setLogLevel('debug');
-      expect(consoleWarnSpy).not.toHaveBeenCalled();
-      // Check that console.warn was called for v8 method call
-      firebase.setLogLevel('debug');
-      expect(consoleWarnSpy).toHaveBeenCalled();
-      // Restore the original console.warn
-      consoleWarnSpy.mockRestore();
+      checkV9Deprecation(
+        () => setLogLevel('debug'),
+        () => firebase.setLogLevel('debug'),
+      );
     });
 
     it('FirebaseApp.toString()', function () {
-      const consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
-      const app = firebase.app();
-      app.toString();
-      // Check that console.warn was called for deprecated method call
-      firebase.setLogLevel('debug');
-      expect(consoleWarnSpy).toHaveBeenCalled();
-      // Restore the original console.warn
-      consoleWarnSpy.mockRestore();
+      checkV9Deprecation(
+        () => {}, // no modular replacement
+        () => getApp().toString(), // modular getApp(), then non-modular to check
+      );
     });
 
     it('FirebaseApp.extendApp()', function () {
-      const consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
-      const app = firebase.app();
-      // To overcome type assertion
-      (app as any).extendApp({ some: 'property' });
-      // Check that console.warn was called for deprecated method call
-      expect(consoleWarnSpy).toHaveBeenCalled();
-      // Restore the original console.warn
-      consoleWarnSpy.mockRestore();
+      checkV9Deprecation(
+        // no modular replacement for this one so no modular func to send in
+        () => {},
+        // modular getApp(), then non-modular to check
+        () => {
+          const app = getApp();
+          (app as any).extendApp({ some: 'property' });
+          return;
+        },
+      );
     });
   });
 });
diff --git a/packages/app/lib/FirebaseApp.js b/packages/app/lib/FirebaseApp.js
@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  */
-import { isNotModularCall } from '@react-native-firebase/app/lib/common';
+import { warnIfNotModularCall } from '@react-native-firebase/app/lib/common';
 import { getAppModule } from './internal/registry/nativeModule';
 
 export default class FirebaseApp {
@@ -61,33 +61,21 @@ export default class FirebaseApp {
   }
 
   extendApp(extendedProps) {
-    // eslint-disable-next-line no-console
-    console.warn(
-      'This v8 method is deprecated and will be removed in the next major release as part of move to match Firebase Web modular v9 SDK API.',
-    );
-
+    // this method has no modular alternative, send true for param 'noAlternative'
+    warnIfNotModularCall(arguments, '', true);
     this._checkDestroyed();
     Object.assign(this, extendedProps);
   }
 
   delete() {
-    if (isNotModularCall(arguments)) {
-      // eslint-disable-next-line no-console
-      console.warn(
-        'This v8 method is deprecated and will be removed in the next major release as part of move to match Firebase Web modular v9 SDK API. Please use `deleteApp()` instead.',
-      );
-    }
+    warnIfNotModularCall(arguments, 'deleteApp()');
     this._checkDestroyed();
     return this._deleteApp();
   }
 
   toString() {
-    if (isNotModularCall(arguments)) {
-      // eslint-disable-next-line no-console
-      console.warn(
-        'This v8 method is deprecated and will be removed in the next major release as part of move to match Firebase Web modular v9 SDK API.',
-      );
-    }
+    // this method has no modular alternative, send true for param 'noAlternative'
+    warnIfNotModularCall(arguments, '', true);
     return this.name;
   }
 }
diff --git a/packages/app/lib/common/index.js b/packages/app/lib/common/index.js
@@ -105,11 +105,20 @@ export function tryJSONStringify(data) {
 
 export const MODULAR_DEPRECATION_ARG = 'react-native-firebase-modular-method-call';
 
-export function isNotModularCall(args) {
+export function warnIfNotModularCall(args, replacementMethodName, noAlternative) {
   for (let i = 0; i < args.length; i++) {
     if (args[i] === MODULAR_DEPRECATION_ARG) {
-      return false;
+      return;
     }
   }
-  return true;
+  let message =
+    'This v8 method is deprecated and will be removed in the next major release ' +
+    'as part of move to match Firebase Web modular v9 SDK API.';
+
+  if (!noAlternative) {
+    message += ` Please use \`${replacementMethodName}\` instead.`;
+  }
+
+  // eslint-disable-next-line no-console
+  console.warn(message);
 }
diff --git a/packages/app/lib/internal/registry/app.js b/packages/app/lib/internal/registry/app.js
@@ -19,7 +19,7 @@ import {
   isIOS,
   isOther,
   isNull,
-  isNotModularCall,
+  warnIfNotModularCall,
   isObject,
   isFunction,
   isString,
@@ -85,12 +85,7 @@ export function initializeNativeApps() {
  * @param name
  */
 export function getApp(name = DEFAULT_APP_NAME) {
-  if (isNotModularCall(arguments)) {
-    // eslint-disable-next-line no-console
-    console.warn(
-      'This v8 method is deprecated and will be removed in the next major release as part of move to match Firebase Web modular v9 SDK API. Please use `getApp()` instead.',
-    );
-  }
+  warnIfNotModularCall(arguments, 'getApp()');
   if (!initializedNativeApps) {
     initializeNativeApps();
   }
@@ -107,12 +102,7 @@ export function getApp(name = DEFAULT_APP_NAME) {
  * Gets all app instances, used for `firebase.apps`
  */
 export function getApps() {
-  if (isNotModularCall(arguments)) {
-    // eslint-disable-next-line no-console
-    console.warn(
-      'This v8 method is deprecated and will be removed in the next major release as part of move to match Firebase Web modular v9 SDK API. Please use `getApps()` instead.',
-    );
-  }
+  warnIfNotModularCall(arguments, 'getApps()');
   if (!initializedNativeApps) {
     initializeNativeApps();
   }
@@ -125,12 +115,7 @@ export function getApps() {
  * @param configOrName
  */
 export function initializeApp(options = {}, configOrName) {
-  if (isNotModularCall(arguments)) {
-    // eslint-disable-next-line no-console
-    console.warn(
-      'This v8 method is deprecated and will be removed in the next major release as part of move to match Firebase Web modular v9 SDK API. Please use `initializeApp()` instead.',
-    );
-  }
+  warnIfNotModularCall(arguments, 'initializeApp()');
   let appConfig = configOrName;
 
   if (!isObject(configOrName) || isNull(configOrName)) {
@@ -219,12 +204,7 @@ export function initializeApp(options = {}, configOrName) {
 }
 
 export function setLogLevel(logLevel) {
-  if (isNotModularCall(arguments)) {
-    // eslint-disable-next-line no-console
-    console.warn(
-      'This v8 method is deprecated and will be removed in the next major release as part of move to match Firebase Web modular v9 SDK API. Please use `setLogLevel()` instead.',
-    );
-  }
+  warnIfNotModularCall(arguments, 'setLogLevel()');
   if (!['error', 'warn', 'info', 'debug', 'verbose'].includes(logLevel)) {
     throw new Error('LogLevel must be one of "error", "warn", "info", "debug", "verbose"');
   }