docs: add new "strict mode" for deprecation warnings

will throw an error with associated stack if any namespaced API
usage is detected - this can help locate usage very very rapidly

Author: mikehardy

docs/migrating-to-v22.md

@@ -13,6 +13,18 @@ You may notice a lot of console warning logs as we deprecate the existing namesp
 globalThis.RNFB_SILENCE_MODULAR_DEPRECATION_WARNINGS = true;
 ```
 
+# Enabling deprecation strict modes
+
+You may enable a feature for the API migration which will throw a javascript error immediately when any namespaced API usage is detected.
+
+This is useful to help you quickly locate any remaining usage of the deprecated namespace API via examination of the line numbers in the stack trace.
+
+Note that there may be modular API implementation errors within the react-native-firebase modules, this may still be useful as a troubleshooting aid when collaborating with the maintainers to correct these errors.
+
+```js
+globalThis.RNFB_MODULAR_DEPRECATION_STRICT_MODE === true;
+```
+
 # Migrating to React Native modular API
 
 If you are familiar with the Firebase JS SDK, the upgrade will be a familiar process, following similar steps to [the migration guide](https://firebase.google.com/docs/web/modular-upgrade#refactor_to_the_modular_style) for firebase-js-sdk.

packages/app/lib/common/index.js

@@ -227,6 +227,10 @@ export function deprecationConsoleWarning(nameSpace, methodName, instanceName, i
         if (!globalThis.RNFB_SILENCE_MODULAR_DEPRECATION_WARNINGS) {
           // eslint-disable-next-line no-console
           console.warn(createMessage(nameSpace, methodName, instanceName));
+
+          if (globalThis.RNFB_MODULAR_DEPRECATION_STRICT_MODE === true) {
+            throw new Error('Deprecated API usage detected while in strict mode.');
+          }
         }
       }
     }
@@ -372,5 +376,9 @@ export function warnIfNotModularCall(args, replacementMethodName = '') {
   if (!globalThis.RNFB_SILENCE_MODULAR_DEPRECATION_WARNINGS) {
     // eslint-disable-next-line no-console
     console.warn(message);
+
+    if (globalThis.RNFB_MODULAR_DEPRECATION_STRICT_MODE === true) {
+      throw new Error('Deprecated API usage detected while in strict mode.');
+    }
   }
 }

tests/app.js

@@ -72,8 +72,8 @@ ErrorUtils.setGlobalHandler((err, isFatal) => {
 
 function loadTests(_) {
   describe('React Native Firebase', function () {
-    if (!globalThis.RNFBDebug) {
-      // Only retry tests if not debugging locally,
+    if (!globalThis.RNFBDebug && !globalThis.RNFB_MODULAR_DEPRECATION_STRICT_MODE) {
+      // Only retry tests if not debugging or hunting deprecated API usage locally,
       // otherwise it gets annoying to debug.
       this.retries(4);
     }

tests/globals.js

@@ -48,6 +48,9 @@ import shouldMatchers from 'should';
 //            [TEST->Finish][✅] uploads a base64url string
 globalThis.RNFBDebug = false;
 
+// this may be used to locate modular API errors quickly
+globalThis.RNFB_MODULAR_DEPRECATION_STRICT_MODE = false;
+
 // RNFB packages.
 import '@react-native-firebase/analytics';
 import '@react-native-firebase/app-check';