🔥 Testing with jest or running `npx expo run` fails with 'Native module RNFBAppModule not found. Re-check module install, linking, configuration, build and install steps.' #8189

itsramiel · 2024-12-12T12:22:57Z

Maintainer Edit:

Jest: For testing with jest, you must mock react-native-firebase so it does not attempt to access native modules. We include an example of this that we use, but it is your responsibility
Expo For use of Expo, for example npx expo run that won't work. Expo Go doesn't have our react-native-firebase modules. You need to prebuild and then locally compile. We document that https://rnfirebase.io/#local-app-compilation

Original issue follows:

Issue

Testing a react native app with an import from firebase such as import messaging from '@react-native-firebase/messaging'; causes jest to fail:

 FAIL  __tests__/App.test.tsx
  ● Test suite failed to run

    Native module RNFBAppModule not found. Re-check module install, linking, configuration, build and install steps.

    > 1 | import messaging from '@react-native-firebase/messaging';
        | ^
      2 | messaging;
      3 |
      4 | function App() {

      at new RNFBNativeEventEmitter (node_modules/@react-native-firebase/app/lib/internal/RNFBNativeEventEmitter.js:25:13)
      at Object.<anonymous> (node_modules/@react-native-firebase/app/lib/internal/RNFBNativeEventEmitter.js:106:16)
      at Object.require (node_modules/@react-native-firebase/app/lib/internal/registry/nativeModule.js:20:1)
      at Object.require (node_modules/@react-native-firebase/app/lib/FirebaseApp.js:18:1)
      at Object.require (node_modules/@react-native-firebase/app/lib/internal/index.js:18:1)
      at Object.require (node_modules/@react-native-firebase/messaging/lib/index.js:28:1)
      at Object.require (App.tsx:1:1)
      at Object.require (__tests__/App.test.tsx:7:1)

Test Suites: 1 failed, 1 total
Tests:       0 total
Snapshots:   0 total
Time:        0.152 s
Ran all test suites.

Project Files

Javascript

Click To Expand

`package.json`:

{
  "name": "Firebase",
  "version": "0.0.1",
  "private": true,
  "scripts": {
    "android": "react-native run-android",
    "ios": "react-native run-ios",
    "lint": "eslint .",
    "start": "react-native start",
    "test": "jest"
  },
  "dependencies": {
    "@react-native-firebase/app": "^21.6.1",
    "@react-native-firebase/messaging": "^21.6.1",
    "react": "18.3.1",
    "react-native": "0.76.5"
  },
  "devDependencies": {
    "@babel/core": "^7.25.2",
    "@babel/preset-env": "^7.25.3",
    "@babel/runtime": "^7.25.0",
    "@react-native-community/cli": "15.0.1",
    "@react-native-community/cli-platform-android": "15.0.1",
    "@react-native-community/cli-platform-ios": "15.0.1",
    "@react-native/babel-preset": "0.76.5",
    "@react-native/eslint-config": "0.76.5",
    "@react-native/metro-config": "0.76.5",
    "@react-native/typescript-config": "0.76.5",
    "@types/react": "^18.2.6",
    "@types/react-test-renderer": "^18.0.0",
    "babel-jest": "^29.6.3",
    "eslint": "^8.19.0",
    "jest": "^29.6.3",
    "prettier": "2.8.8",
    "react-test-renderer": "18.3.1",
    "typescript": "5.0.4"
  },
  "engines": {
    "node": ">=18"
  },
  "packageManager": "[email protected]"
}

`firebase.json` for react-native-firebase v6:

Irrelevant here. Doesnt affect testing environment

# N/A

iOS

Click To Expand

`ios/Podfile`:

Irrelevant

I'm not using Pods
I'm using Pods and my Podfile looks like:

# N/A

`AppDelegate.m`:

Irrelevant

// N/A

Android

Click To Expand

Have you converted to AndroidX?

Irrelevant

my application is an AndroidX application?
I am using android/gradle.settings jetifier=true for Android compatibility?
I am using the NPM package jetifier for react-native compatibility?

`android/build.gradle`:

// N/A

`android/app/build.gradle`:

// N/A

`android/settings.gradle`:

// N/A

`MainApplication.java`:

// N/A

`AndroidManifest.xml`:

<!-- N/A -->

Environment

Click To Expand

react-native info output:

info Fetching system and libraries information...
System:
  OS: macOS 15.1
  CPU: (14) arm64 Apple M3 Max
  Memory: 1.75 GB / 36.00 GB
  Shell:
    version: "5.9"
    path: /bin/zsh
Binaries:
  Node:
    version: 20.11.1
    path: /private/var/folders/p1/47x14k7x3hs1y75l4l8qd9980000gn/T/xfs-2ded1f97/node
  Yarn:
    version: 3.6.4
    path: /private/var/folders/p1/47x14k7x3hs1y75l4l8qd9980000gn/T/xfs-2ded1f97/yarn
  npm:
    version: 10.2.4
    path: ~/.nvm/versions/node/v20.11.1/bin/npm
  Watchman:
    version: 2024.10.28.00
    path: /opt/homebrew/bin/watchman
Managers:
  CocoaPods:
    version: 1.14.3
    path: /Users/itsramiel/.rbenv/shims/pod
SDKs:
  iOS SDK:
    Platforms:
      - DriverKit 24.1
      - iOS 18.1
      - macOS 15.1
      - tvOS 18.1
      - visionOS 2.1
      - watchOS 11.1
  Android SDK: Not Found
IDEs:
  Android Studio: 2024.1 AI-241.18034.62.2412.12266719
  Xcode:
    version: 16.1/16B40
    path: /usr/bin/xcodebuild
Languages:
  Java:
    version: 17.0.10
    path: /usr/bin/javac
  Ruby:
    version: 3.0.0
    path: /Users/itsramiel/.rbenv/shims/ruby
npmPackages:
  "@react-native-community/cli":
    installed: 15.0.1
    wanted: 15.0.1
  react:
    installed: 18.3.1
    wanted: 18.3.1
  react-native:
    installed: 0.76.5
    wanted: 0.76.5
  react-native-macos: Not Found
npmGlobalPackages:
  "*react-native*": Not Found
Android:
  hermesEnabled: true
  newArchEnabled: true
iOS:
  hermesEnabled: Not found
  newArchEnabled: false

Platform that you're experiencing the issue on: None(testing env, jest)
- iOS
- Android
- iOS but have not tested behavior on Android
- Android but have not tested behavior on iOS
- Both
react-native-firebase version you're using that has this issue:
- e.g. 5.4.3
Firebase module(s) you're using that has the issue:
- e.g. Instance ID
Are you using TypeScript?
- Y/N & VERSION

👉 Check out React Native Firebase and Invertase on Twitter for updates on the library.

Info I find relevant:

So basically you can reproduce with:

import messaging from '@react-native-firebase/messaging';
messaging;

function App() {
  return null;
}

export default App;

The error is this:

    Native module RNFBAppModule not found. Re-check module install, linking, configuration, build and install steps.

    > 1 | import messaging from '@react-native-firebase/messaging';
        | ^
      2 | messaging;
      3 |
      4 | function App() {

      at new RNFBNativeEventEmitter (node_modules/@react-native-firebase/app/lib/internal/RNFBNativeEventEmitter.js:25:13)
      at Object.<anonymous> (node_modules/@react-native-firebase/app/lib/internal/RNFBNativeEventEmitter.js:106:16)
      at Object.require (node_modules/@react-native-firebase/app/lib/internal/registry/nativeModule.js:20:1)
      at Object.require (node_modules/@react-native-firebase/app/lib/FirebaseApp.js:18:1)
      at Object.require (node_modules/@react-native-firebase/app/lib/internal/index.js:18:1)
      at Object.require (node_modules/@react-native-firebase/messaging/lib/index.js:28:1)
      at Object.require (App.tsx:1:1)
      at Object.require (__tests__/App.test.tsx:7:1)

The problem is that this import:
at Object.require (node_modules/@react-native-firebase/app/lib/internal/registry/nativeModule.js:20:1)

is resolving to app/lib/internal/nativeModule.ios.js since apparently ios is the default platform in react native preset for jest.

Now this file imports from: app/lib/internal/nativeModuleAndroidIos.js

which tries to get the module from NativeModules which obv will return undefined in a jest env:

react-native-firebase/packages/app/lib/internal/nativeModuleAndroidIos.js

Line 11 in 3623a50

const nativeModule = NativeModules[moduleName];

which leads to the throwing of the error:

react-native-firebase/packages/app/lib/internal/RNFBNativeEventEmitter.js

Lines 23 to 28 in 3623a50

    
           const RNFBAppModule = getReactNativeModule('RNFBAppModule'); 
        
           if (!RNFBAppModule) { 
        
             throw new Error( 
        
               'Native module RNFBAppModule not found. Re-check module install, linking, configuration, build and install steps.', 
        
             ); 
        
           }

The text was updated successfully, but these errors were encountered:

mikehardy · 2024-12-12T12:44:30Z

Using jest to test modules that requires native modules will require mocking and setup of course, this is a typical jest use case you have and a typical jest need for that use case

A follow-on in this instance should be: well, how do they do it then? That is, how do we do our testing in our repo so it works for us?

https://github.com/invertase/react-native-firebase/blob/main/jest.config.js

which has

react-native-firebase/jest.config.js

Line 8 in 3623a50

setupFiles: ['./jest.setup.ts'],

Which points to

https://github.com/invertase/react-native-firebase/blob/main/jest.setup.ts

I'd do what we do in that file - or! if there is a better way - please suggest anything better for that file as we use jest too and we welcome PRs.

Should work?

itsramiel · 2024-12-13T07:29:54Z

What I would love to have is a mock file I could import and then mock the libary with that mock. This is a common thing that other libraries do, examples:

import mockRNCNetInfo from '@react-native-community/netinfo/jest/netinfo-mock.js';
jest.mock('@react-native-community/netinfo', () => mockRNCNetInfo);

import mockRNLocalize from 'react-native-localize/mock/index.js';
jest.mock('react-native-localize', () => mockRNLocalize);

jest.mock('@react-native-async-storage/async-storage', () =>
  require('@react-native-async-storage/async-storage/jest/async-storage-mock')
);

If the library would provide such a mock that can be used internally plus for library users, then that would be perfect.

Note: The failing of jest is new. This didnt use to happen in 18.7.1 but did happen when upgrading to 21.6.1. Same was experiences by others, but their solution was to downgrade which is obv not the correct solution.

mikehardy · 2024-12-16T12:45:25Z

It would be great if we shipped a mock yes. I also maintain netinfo ( 👋 ), so I'm familiar with this.

So how did it go when you used that mock file in your jest setup?

There is only so much time in a day - if you opened a PR that added that mock to the list of files in package.json so it was shipped with @react-native-firebase/app that would be great, after you've confirmed it worked for you

itsramiel · 2024-12-17T08:06:41Z

Yes, copy pasting jest.setup.js into my projects jest.setup.js does fix the tests, but the file is mocking react-native not the library. Shouldnt we expose a mock of the library instead? Or how is this setup file meant to be used? I am not sure if exposing a setup file that mocks react native is the best here

mikehardy · 2024-12-17T22:02:24Z

It mocks react-native yes, because we do module loading. It mocks the minimum to make that "work" (read as: not fail) in a jest environment, then for the rest of react-native, the mock is the actual implementation of react-native

What could possibly go wrong ;-)

You tested it and it worked for you, that's great news. No reason we couldn't ship it and people could use it if they like

itsramiel · 2024-12-18T07:28:56Z

What could possibly go wrong ;-)

I am not familiar with jest but my initial thought was that if we mock rn, then does that override other mocks of rn that a user may already have. I am not very familiar with jest. maybe you already know, or I have to test

mikehardy · 2024-12-18T14:37:49Z

You'd have to test that, however if jest is already mocking things then I would assume (dangerous!) that when our jest says "import" for react-native we'll get the mocked one.

it may be then that our mocks will collide with other specific mocks, but ours is mocking the minimum we need - not sure what we can do about that.

Then the rest of the react native module from import is spread into our mock so it should still apply

I'm not sure a different way to do it though, we have a multi-module system and need to reach into react-native and inspect / load etc our native modules. In a jest context that has to be mocked.

GideonAgboba · 2024-12-29T17:53:47Z

THIS ERROR OCCURS IN BRIDGELESS MODE. PLEASE CAN WE UPGRADE THIS LIBRARY TO SUPPORT BRIDGELESS MODE?

mikehardy · 2024-12-29T17:56:52Z

@GideonAgboba I DON'T BELIEVE JEST CAN TELL WHETHER SOMETHING IS BRIDGELESS OR NOT, YOU HAVE TO MOCK THINGS EITHER WAY

danielctchin · 2025-01-02T14:09:35Z

Hi there anyone got this to work? Had the same issue with npx expo start, however on npx expo run, it works.
Error: Native module RNFBAppModule not found. Re-check module install, linking, configuration, build and install steps.

mikehardy · 2025-01-02T15:33:47Z

on npx expo run, it works

Sounds like you go it to run?

Error: Native module RNFBAppModule not found. Re-check module install, linking, configuration, build and install steps

"Re-check .... build ... steps"

When using Expo with custom native modules getting those things exactly right is critical

danielctchin · 2025-01-05T13:42:12Z

Thanks @mikehardy.
I got it to work if its expo run.
But on development environment, we usually use npx expo start. And by running this comment we still hit the error above.
Do we need to import some files?

mikehardy · 2025-01-05T20:02:43Z

Apologies @danielctchin I don't use Expo so I don't know. If expo run works, use that is what I'd do

tim5go · 2025-01-18T10:39:20Z

Hi @mikehardy
I'm facing the same issue with import analytics from '@react-native-firebase/analytics;.

For developers who use Expo, getting npx expo start to work is crucial as it allows for real-time code changes without needing a full rebuild. I hope you understand our difficulty with this. Thank you!

mikehardy · 2025-01-18T11:51:43Z

How did expo run work for you? Do you have any other suggestions? You'll have to understand I don't use expo so I'm not able to troubleshoot this

farooq-8627 · 2025-01-22T10:54:46Z

does any one got the solution for npx expo start??

tim5go · 2025-01-22T14:13:07Z

Hi @mikehardy
As someone suggested from StackOverFlow, the breaking change occurs when upgrading from v19.0.0 to v21.4.0.

For that, I made the file diff as below for these 2 versions:

Since I am new to this repo - react-native-firebase too, I am not sure why this change was made originally (maybe for tackling other bugs ???)

Hope this will help all of us to dig out the root cause 🙏🏻🙏🏻🙏🏻

mikehardy · 2025-01-22T14:52:10Z

I believe that was part of getting web to work as an underlying fallback and to implement "other" platform support (e.g., macOS)

Here's a different question though, taking the opposite perspective:

How could react-native-firebase work at all, if it is unable to locate the native app module? (answer: it cannot, at least not on a native platform)

Follow-on question: is it better to determine quickly and fail quickly if the underlying app module is not found, or to quietly proceed and then fail later? (answer: fail fast is typically better, allowing for some exceptions, none of which really apply here I don't think)

So what we have here is a change that attempts to locate the native module immediately and fails if it cannot. Which...seems like a good change. At least for the native platforms

Why does npx expo start not correctly install + run the native modules?

Is npx expo start a purely web command, with no expectation of the native modules being available? If so, and there is the expectation that react-native-firebase works perfectly in a web-only context, I'm not sure that's a correct expectation at the moment. react-native-firebase still at its heart relies on native modules, with some firebase-js-sdk backfill for modules that aren't available on "other" platforms. We hope to be 100% web compatible in the future but we're not there yet I don't think, and still require "shims" to work on web-only.

Indeed, npx expo start appears to rely on the Expo Go app on native platforms which will never work for react-native-firebase because it does not include the built-in react-native-firebase modules, nor will it ever include them.

So perhaps there is some variation of the expo cli stuff you need to use instead, like

https://docs.expo.dev/more/expo-cli/#prebuild and
https://docs.expo.dev/more/expo-cli/#compiling-android

mikehardy · 2025-01-22T14:55:01Z

Also worth noting:

the original poster is talking about jest, which is more like a web context, and requires jest mocking
this issue has been mostly hijacked and is now "hey, npx expo start doesn't work", which is somewhat related to the original issue but is really a separate issue
we have documentation that explains you need to use prebuild etc for Expo: https://rnfirebase.io/#local-app-compilation

mikehardy · 2025-01-22T15:05:00Z

The stackoverflow link was not related to jest or expo and so was also not relevant, however it's got all the juicy keywords to show up in searches for a handful of related searches - just as this issue does. So it acts as a magnet perhaps for people. I responded there as well, attempting to answer both this question and the original posters question on SO https://stackoverflow.com/questions/79177592/error-native-module-rnfbappmodule-not-found-re-check-module-install-linking/79378252#79378252

tim5go · 2025-01-22T15:09:25Z

@mikehardy
Your explanation is very clear, thanks 🙏🏻

mikehardy · 2025-01-22T16:17:00Z

I have edited the original description to directly include how to use jest or expo here, and updated the title.
I believe both cases are resolved so I'm closing this issue but it isn't locked or anything.
If there's something missing conversation may of course continue and we'll all try to help each other
Cheers

sberkaye · 2025-01-24T21:15:24Z

@mikehardy I've been using react-native-firebase on Expo after following the steps on the documentation, creating a clean prebuild and then compiling locally. (as documented here) I had no issues running it on iOS, but on Android it gives the same "Error: Native module RNFBAppModule not found. Re-check module install, linking, configuration, build and install steps." error after compiling & running. I had deleted android folder to create clean prebuilds, ran npx expo run prebuild --clean and then built with npx expo run:android but it didn't work. I saw your comment here & on StackOverflow but unfortunately following the documentation didn't work for me. Running npx expo run:ios works completely fine though. Here are my package versions:

"@react-native-firebase/app": "^21.7.1",
"@react-native-firebase/auth": "^21.7.1",
"expo": "~52.0.11",
"react-native": "0.76.3",

Can you provide any insights? Thanks in advance!

itsramiel added Needs Attention type: bug New bug report labels Dec 12, 2024

mikehardy closed this as completed Jan 22, 2025

mikehardy added resolution: user Issue with users code or an issue that should be directed to Stack Overflow or the Discord server. resolution: solution-provided and removed type: bug New bug report Needs Attention labels Jan 22, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🔥 Testing with jest or running `npx expo run` fails with 'Native module RNFBAppModule not found. Re-check module install, linking, configuration, build and install steps.' #8189

🔥 Testing with jest or running `npx expo run` fails with 'Native module RNFBAppModule not found. Re-check module install, linking, configuration, build and install steps.' #8189

itsramiel commented Dec 12, 2024 •

edited by mikehardy

Loading

`package.json`:

`firebase.json` for react-native-firebase v6:

`ios/Podfile`:

`AppDelegate.m`:

Have you converted to AndroidX?

`android/build.gradle`:

`android/app/build.gradle`:

`android/settings.gradle`:

`MainApplication.java`:

`AndroidManifest.xml`:

mikehardy commented Dec 12, 2024

itsramiel commented Dec 13, 2024

mikehardy commented Dec 16, 2024

itsramiel commented Dec 17, 2024

mikehardy commented Dec 17, 2024

itsramiel commented Dec 18, 2024

mikehardy commented Dec 18, 2024

GideonAgboba commented Dec 29, 2024

mikehardy commented Dec 29, 2024

danielctchin commented Jan 2, 2025

mikehardy commented Jan 2, 2025

danielctchin commented Jan 5, 2025

mikehardy commented Jan 5, 2025

tim5go commented Jan 18, 2025

mikehardy commented Jan 18, 2025

farooq-8627 commented Jan 22, 2025

tim5go commented Jan 22, 2025

mikehardy commented Jan 22, 2025 •

edited

Loading

mikehardy commented Jan 22, 2025 •

edited

Loading

mikehardy commented Jan 22, 2025

tim5go commented Jan 22, 2025

mikehardy commented Jan 22, 2025

sberkaye commented Jan 24, 2025 •

edited

Loading

🔥 Testing with jest or running npx expo run fails with 'Native module RNFBAppModule not found. Re-check module install, linking, configuration, build and install steps.' #8189

🔥 Testing with jest or running npx expo run fails with 'Native module RNFBAppModule not found. Re-check module install, linking, configuration, build and install steps.' #8189

Comments

itsramiel commented Dec 12, 2024 • edited by mikehardy Loading

Maintainer Edit:

Issue

Project Files

Javascript

package.json:

firebase.json for react-native-firebase v6:

iOS

ios/Podfile:

AppDelegate.m:

Android

Have you converted to AndroidX?

android/build.gradle:

android/app/build.gradle:

android/settings.gradle:

MainApplication.java:

AndroidManifest.xml:

Environment

Info I find relevant:

mikehardy commented Dec 12, 2024

itsramiel commented Dec 13, 2024

mikehardy commented Dec 16, 2024

itsramiel commented Dec 17, 2024

mikehardy commented Dec 17, 2024

itsramiel commented Dec 18, 2024

mikehardy commented Dec 18, 2024

GideonAgboba commented Dec 29, 2024

mikehardy commented Dec 29, 2024

danielctchin commented Jan 2, 2025

mikehardy commented Jan 2, 2025

danielctchin commented Jan 5, 2025

mikehardy commented Jan 5, 2025

tim5go commented Jan 18, 2025

mikehardy commented Jan 18, 2025

farooq-8627 commented Jan 22, 2025

tim5go commented Jan 22, 2025

mikehardy commented Jan 22, 2025 • edited Loading

mikehardy commented Jan 22, 2025 • edited Loading

mikehardy commented Jan 22, 2025

tim5go commented Jan 22, 2025

mikehardy commented Jan 22, 2025

sberkaye commented Jan 24, 2025 • edited Loading

🔥 Testing with jest or running `npx expo run` fails with 'Native module RNFBAppModule not found. Re-check module install, linking, configuration, build and install steps.' #8189

🔥 Testing with jest or running `npx expo run` fails with 'Native module RNFBAppModule not found. Re-check module install, linking, configuration, build and install steps.' #8189

itsramiel commented Dec 12, 2024 •

edited by mikehardy

Loading

`package.json`:

`firebase.json` for react-native-firebase v6:

`ios/Podfile`:

`AppDelegate.m`:

`android/build.gradle`:

`android/app/build.gradle`:

`android/settings.gradle`:

`MainApplication.java`:

`AndroidManifest.xml`:

mikehardy commented Jan 22, 2025 •

edited

Loading

mikehardy commented Jan 22, 2025 •

edited

Loading

sberkaye commented Jan 24, 2025 •

edited

Loading