Edit: I forgot to mention that I am using Firebase cloud functions to host the site.
I am having trouble successfully initializing the NodeJS SDK with an authorization strategy that combines my service account file together with Google Application Default Credentials as detailed here: https://firebase.google.com/docs/admin/setup#initialize-sdk
I set the environment variable GOOGLE_APPLICATION_CREDENTIALS to the file path of the JSON file that contains my service account key like so:
Windows Powershell method:
$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\XXX\firebase\service-account.json"
Then, I created my server backend utils file to initialize the SDK like so:
server/utils/firebase.ts:
// Purpose: initialize firebase and export it with service credentials
import { initializeApp } from 'firebase-admin/app'
// Add other libraries here (ie, auth)
import { getFirestore } from 'firebase-admin/firestore'
import { getAuth } from 'firebase-admin/auth'
// Initialize firebase with service credentials established with Google application default credentials
// Reference: https://firebase.google.com/docs/admin/setup#windows
const app = initializeApp()
const firestore = getFirestore()
const auth = getAuth()
export { app, firestore, auth }
Unfortunately, when I try to fetch a document from Firestore, I get the following server error. I thought I could implicitly initialize the SDK without parameters in the initializeApp() ?
{
"url": "/api/users/5cnu6iDlTsa5mujH2sKPsBJ8OKH2/profile",
"statusCode": 500,
"statusMessage": "",
"message": "Unable to detect a Project Id in the current environment. \nTo learn more about authentication and Google APIs, visit: \nhttps://cloud.google.com/docs/authentication/getting-started",
"stack": "<pre><span class=\"stack internal\">at GoogleAuth.findAndCacheProjectId ...snipped...
}
However, if I initialize the SDK like the below code, I have no problem fetching from Firestore:
// Purpose: initialize firebase and export it with service credentials
// Add other libraries here (ie, auth)
import { initializeApp, cert } from 'firebase-admin/app'
import { getFirestore } from 'firebase-admin/firestore'
import { getAuth } from 'firebase-admin/auth'
import serviceAccount from '../../service-account.json' //<--- app root location
const app = initializeApp({
credential: cert(serviceAccount)
})
const firestore = getFirestore()
const auth = getAuth()
export { app, firestore, auth }
I suppose I can go with the latter method, but I think the former is more secure?
Yes, this warning/error has been posted many times, but I have tried everything mentioned on StackOverflow and Github, but nothing is working for me.
Auth Emulator and FireStore Emulator up and running.
FireStore always gives a warning (with the confusing text "errored") when I try to use it read any data:
WARN [2022-09-13T22:23:28.341Z] #firebase/firestore: Firestore (9.9.4): Connection WebChannel transport errored: ...
... "j": {"g": [Circular]}, "l": "http://localhost:8080/google.firestore.v1.Firestore/Listen/channel", "o": undefined, "s": false, "v": true}, "type": "c"}
I also see this popup from time to time inconsistently:
ERROR [2022-09-13T22:43:13.780Z] #firebase/firestore: Firestore (9.9.4): Could not reach Cloud Firestore backend. Connection failed 1 times. Most recent error: FirebaseError: [code=unavailable]: The operation could not be completed
This typically indicates that your device does not have a healthy Internet connection at the moment. The client will operate in offline mode until it is able to successfully connect to the backend.
Here is the upfront boilerplate:
const firebaseConfig = {
...
};
const app = initializeApp(firebaseConfig);
const auth = getAuth(app);
connectAuthEmulator(auth, "http://localhost:9099");
const db = getFirestore(app);
connectFirestoreEmulator(db, "localhost", 8080);
A few of the many variations I have tried:
const db = getFirestore();
Every combination of the following flags alone and together:
const db = initializeFirestore(app, {useFetchStreams: false, experimentalForceLongPolling: true});
This is a React Native application. I am running the app inside the Android Emulator.
I have the above code in a Firebase.js that is imported by my App.js.
Anyone understand what the root cause is here?
Here is an example of trying to read:
const snap = getDocs(collection(db, "users")).then(snap => {
console.log(snap); // prints "[object Object]"
snap.forEach(user => {
console.log(`${user.id} => ${user.data()}`); // not reached
})
});
And that prints essentially nothing, as mentioned in comments, but no errors.
Here is a slightly different example that causes an error:
const randomDoc = getDoc(doc(db, "users", "o3ou4uwi9CYeM1dM8egg")).then(doc => {
console.log(randomDoc);
});
Output:
WARN Possible Unhandled Promise Rejection (id: 0):
FirebaseError: Failed to get document because the client is offline.
construct#[native code]
construct#[native code]
...
The Firebase Emulator GUI shows an empty requests page for Firestore, as if no requests have been made.
I have a collection named "users" in my Root, which contains a few dummy documents with {name: "foo"} fields, so I'm expecting the forEach above to print a few times.
There were 3 separate problems:
The Android emulator doesn't run on localhost / 127.0.0.1. It runs on 10.0.2.2. After changing that, I am able to successfully use the Auth Emulator, and the Firestore emulator is now registering my requests, but returning the error above FirebaseError: Failed to get document because the client is offline..
To solve the second error, you must edit firestore.rules and change everything to allow for testing:
rules_version = '2';
service cloud.firestore {
match /databases/{database}/documents {
match /{document=**} {
allow read, write: if true;
}
}
}
After (1) and (2) we are seemingly back to square 1 (transport error), but use this to init db: const db = initializeFirestore(app, {experimentalForceLongPolling: true});
Finally...success.
My init looks like this for now:
const app = initializeApp(firebaseConfig);
const auth = getAuth(app);
if (__DEV__) {
try {
if (Platform.OS === "android") {
connectAuthEmulator(auth, "http://10.0.2.2:9099");
} else {
connectAuthEmulator(auth, "http://localhost:9099");
}
} catch (error) {
console.error(error);
}
}
var db = null;
if (__DEV__) {
try {
if (Platform.OS === "android") {
db = initializeFirestore(app, {experimentalForceLongPolling: true});
connectFirestoreEmulator(db, "10.0.2.2", 8080);
} else {
db = getFirestore(app);
connectFirestoreEmulator(db, "localhost", 8080);
}
} catch (error) {
console.error(error);
}
}
else {
db = getFirestore(app);
}
I am trying to get Firebase App Check working in a Vue 3 web app. I have Firebase configured and reCAPTCHA v3 configured.
Here is the code where I initialize Firebase and App Check. I am logging the recaptcha site key to console to make sure the env variables are getting injected correctly.
const fbConfig = {
apiKey: import.meta.env.VITE_APP_FIREBASE_APIKEY,
authDomain: import.meta.env.VITE_APP_FIREBASE_AUTHDOMAIN,
projectId: import.meta.env.VITE_APP_FIREBASE_PROJECTID,
appId: import.meta.env.VITE_APP_FIREBASE_APPID,
storageBucket: import.meta.env.VITE_APP_STORAGEBUCKET,
messagingSenderId: import.meta.env.VITE_APP_MESSAGINGSENDERID,
}
const fbapp = initializeApp(fbConfig)
if (location.hostname === "localhost") {
self.FIREBASE_APPCHECK_DEBUG_TOKEN = true;
}
console.log("APPCHECK Token: ", import.meta.env.VITE_APP_RECAPTCHA_SITEKEY)
const appCheck = initializeAppCheck(fbapp, {
provider: new ReCaptchaV3Provider(import.meta.env.VITE_APP_RECAPTCHA_SITEKEY),
// Optional argument. If true, the SDK automatically refreshes App Check
// tokens as needed.
isTokenAutoRefreshEnabled: true
});
This works as expected on local host where the debug token is used. When I deploy to a live site I get this error.
{ code: 400, message: "Invalid app resource name: \"projects/<name removed>/apps/\"<code removed>\"\".", status: "INVALID_ARGUMENT" }
Any thoughts?
Found the problem. The appId was getting quoted in the environment variables for some reason. Fixing that fixed the issue.
I have configured firebase to run locally for debugging using the emulator by following this link.
Now I want to be able to run my app connected to the localhost for debugging triggers as well. Is there a way to achieve this by configuring my flutter app to use the localhost?
My emulator is running as following:
My latest setup of flutter fire
void main() {
WidgetsFlutterBinding.ensureInitialized();
await Firebase.initializeApp();
const bool USE_EMULATOR = true;
if (USE_EMULATOR) {
// [Firestore | localhost:8080]
FirebaseFirestore.instance.settings = const Settings(
host: 'localhost:8080',
sslEnabled: false,
persistenceEnabled: false,
);
// [Authentication | localhost:9099]
await FirebaseAuth.instance.useEmulator('http://localhost:9099');
// [Storage | localhost:9199]
await FirebaseStorage.instance.useEmulator(
host: 'localhost',
port: 9199,
);
}
}
Make sure your host and port matches from firebase emulators:start
NOTE: in main.dart now you can always provide 'localhost'
await FirebaseAuth.instance.useEmulator('http://localhost:9099');
because it will change automagically to '10.0.2.2' if it is running on android
Long story short!
for latest guide follow https://firebase.flutter.dev/docs/firestore/usage#emulator-usage
Old but, Gold. Detailed config.(Outdated)
STEP 1 [setup firestore in flutter in main.dart]
Future<void> main() async {
WidgetsFlutterBinding.ensureInitialized(); <--- Important!
await Firestore.instance.settings(
host: '192.168.1.38:5002', <--- Make sure to put your local ip
sslEnabled: false); it will not work if you use 'localhost:5002'
Google it "how to find my local ip"
}
STEP 1 [setup firestore in flutter in main.dart] for newer version of firebase
Future<void> main() async {
WidgetsFlutterBinding.ensureInitialized(); <--- Important!
String host = Platform.isAndroid ? '10.0.2.2:5002' : 'localhost:5002';
await FirebaseFirestore.instance.settings = Settings(
host: host,
sslEnabled: false,
);
}
STEP 2 [init firebase project]
firebase init
STEP 3 [config firestore emulator e.g firebase.json]
"emulators": {
"ui": {
"enabled": true,
"host": "localhost",
"port": 4000
},
"functions": {
"port": 5001
},
"firestore": {
"host": "0.0.0.0", <------ Make sure to set it "0.0.0.0"
"port": 5002
},
}
STEP 4 [run emulators and flutter app]
firebase emulators:start
flutter run
Worked both on iOS simulator and Android emulators
P.S: try to restart firestore emulator or/and flutter app
Done!
BONUS [import export data to firestore emulator]
when you stop firestore emulator all data in firestore will be gone.
So maybe before stoping emulator if you want to continue from where
you left of you can export firestore emulator data like so
firebase emulators:export ../data (../data can be any path you want 😎)
to load exported data
firebase emulators:start --import ../data
you can save different states of your firestore emulator for different cases, example
firebase emulators:start --import ../initialData
firebase emulators:start --import ../otherStateData
❤️ Note for myself use dart for firebase functions ❤️
If you want to use dart for firebase functions you can follow this https://github.com/pulyaevskiy/firebase-functions-interop
one good thing I found for myself to detect if your function is running in emulator or production you can read more here
long story short
functions/index.js
export const prepopulateFirestoreEmulator = functions.https.onRequest(
(request, response) => {
if (process.env.FUNCTIONS_EMULATOR && process.env.FIRESTORE_EMULATOR_HOST) {
// TODO: prepopulate firestore emulator from 'yourproject/src/sample_data.json
response.send('Prepopulated firestore with sample_data.json!');
} else {
response.send(
"Do not populate production firestore with sample_data.json"
);
}
}
);
functions/index.dart
import 'package:firebase_functions_interop/firebase_functions_interop.dart';
import 'package:node_interop/node.dart';
import 'package:node_interop/util.dart';
void devPrepopulateCollections(ExpressHttpRequest request) {
var env =
new Map<String, String>.from(dartify(process.env)); // <-- important part
if (env.containsKey('FUNCTIONS_EMULATOR') &&
env.containsKey('FIRESTORE_EMULATOR_HOST')) {
// TODO: prepopulate firestore emulator from 'yourproject/src/sample_data.json
request.response
..write("Prepopulated firestore with sample_data.json!")
..close();
} else {
request.response
..write("Do not populate production firestore with sample_data.json")
..close();
}
}
After carefully going through the docs here, I got it working by configuring the host setting on the firestore instance:
import 'package:cloud_firestore/cloud_firestore.dart';
import 'package:flutter/material.dart';
import 'package:tracker/screens/screens.dart';
void main() async {
// This will set the app to communicate with localhost
await Firestore.instance.settings(host: "10.0.2.2:8080", sslEnabled: false);
runApp(AppSetupScreen());
}
Note: This will only work with emulator and not with physical device.
An add-on:
To make the Firebase emulators work with the physical devices
Work for both iOS and Android devices
1. Cloud functions setup:
in firebase.json
{
// ...other configs
"emulators": {
"functions": {
"port": 5001,
"host": "0.0.0.0" // must have
},
"firestore": {
"port": 8080,
"host": "0.0.0.0" // must have
},
}
}
2. Your Flutter app setup:
The IP address you use for cloud functions and firestore should be the same
// The FirebaseFunctions config
// ! You need to replace the placeholder with your IP address below:
FirebaseFunctions.instance.useFunctionsEmulator(origin: 'http://<YOUR_IP_ADDRESS>:5001');
// The Firestore config
// ! You need to replace the placeholder with your IP address below:
FirebaseFirestore.instance.settings = Settings(
host: '<YOUR_IP_ADDRESS>:8080',
sslEnabled: false,
persistenceEnabled: false,
);
for cloud_firestore: ^0.14.1+2, instead of using FirebaseFirestore.instance.settings use this -
FirebaseFunctions.instance.useFunctionsEmulator(
origin: "http://localhost:5001",
);
It internally handles setting up 10.0.2.2 if the device is android.
Your main block should look like the following
Future<void> main() async {
WidgetsFlutterBinding.ensureInitialized();
await Firebase.initializeApp();
FirebaseFunctions.instance.useFunctionsEmulator(
origin: "http://localhost:5001",
);
runApp(MyApp());
}
Looks like i've connected ios to localhost:8080, but db works very slow and I also didn't notice any logs in a file. #UsmanZaheer, can you please tell when did it write logs and was it working fast?
Steps:
firebase init
add links that have been created by ini to package.json in functions;
"firestore": {
"rules": "firestore.rules",
"indexes": "firestore.indexes.json"
},
firebase emulators:start
in main() write
await Firestore.instance.settings(
host: 'http://localhost:8080',
sslEnabled: false,
persistenceEnabled: false,
timestampsInSnapshotsEnabled: true
).catchError((e) => print(e));
Adjustment for Flutter Web
addition to the correct answer by #Sultanmyrza
Platform requires dart:io/dart:html which are mutually exclussive so to check for the platform I use kIsWeb
FirebaseFirestore __firestore;
FirebaseFirestore get _firestore {
if (__firestore != null) {
return __firestore;
}
debugPrint('isFirebaseEmulator: $isFirebaseEmulator');
__firestore = FirebaseFirestore.instance;
if (isFirebaseEmulator) {
__firestore.settings = const Settings(
host: kIsWeb ? 'localhost:8080' : '10.0.2.2:8080',
sslEnabled: false,
);
}
return __firestore;
}
Latest Update: To connect flutter app to your local firebase emulator suite, follow this official instruction for configuration.
My init function looks like so:
init_firebase.dart
Future<void> initFirebase() async {
await Firebase.initializeApp(
options: DefaultFirebaseOptions.currentPlatform,
);
if (!kReleaseMode) {
try {
await Future.wait([
FirebaseAuth.instance.useAuthEmulator('localhost', 9099),
FirebaseStorage.instance.useStorageEmulator('localhost', 9199),
]);
FirebaseFunctions.instance.useFunctionsEmulator('localhost', 5001);
FirebaseFirestore.instance.useFirestoreEmulator('localhost', 8080);
} catch (e) {}
}
}
By using !kReleaseMode, we don't have to have a boolean that we switch each time. It will just use emulator by default during development
By wrapping it in try-catch block we avoid some errors from hot reload
Your main.dart should look like this:
void main() async {
WidgetsFlutterBinding.ensureInitialized();
await Firestore.instance
.settings(
host: 'http://localhost:8080',
sslEnabled: false,
persistenceEnabled: false,
)
.catchError((e) => print(e));
//
// ...
//
runApp(App(...));
}
in your firebase.json file
"emulators": {
"firestore": {
"host": "localhost",
"port": 8080
},
...
}
you should also set the following in your terminal:
export FIRESTORE_EMULATOR_HOST=localhost:8080
and then run
firebase emulators:start
I'm creating an app that lists users and I'm doing that through Firebase Functions. After a recent update I've been forced to update firebase-admin from 7.4.0 to 8.2.0 but now I'm getting the following error:
Unhandled error { Error: //developers.google.com/identity/sign-in/web/devconsole-project. Raw server response: "{"error":{"code":401,"message":"Request had invalid authentication credentials. Expected OAuth 2 access token, login cookie or other valid authentication credential. See https://developers.google.com/identity/sign-in/web/devconsole-project.","errors":[{"message":"Invalid Credentials","domain":"global","reason":"authError","location":"Authorization","locationType":"header"}],"status":"UNAUTHENTICATED"}}"
I've already done the following:
Use service account
Follow instructions here but I'm still seeing the errors above.
Edit: Here's the code
import admin from "firebase-admin";
import functions from "firebase-functions";
const app = admin.initializeApp();
const auth = admin.auth(app);
export const listUsers = functions.https.onCall(async () => {
const users = await auth.listUsers();
return users.users.map(user => {
return user.toJSON();
});
});