firebase / functions-samples

Collection of sample apps showcasing popular use cases using Cloud Functions for Firebase
https://firebase.google.com/docs/functions
Apache License 2.0
12.03k stars 3.83k forks source link

Ignoring trigger because the Cloud Firestore emulator is not running (firebase serve) #572

Open AndersonHappens opened 5 years ago

AndersonHappens commented 5 years ago

How to reproduce these conditions

Sample name or URL where you found the bug https://github.com/firebase/functions-samples/tree/master/stripe

Failing Function code used (including require/import commands at the top) 'use strict';

const functions = require('firebase-functions'); const admin = require('firebase-admin'); admin.initializeApp(); const logging = require('@google-cloud/logging')(); const stripe = require('stripe')(functions.config().stripe.token); const currency = functions.config().stripe.currency || 'USD';

// [START chargecustomer] // Charge the Stripe customer whenever an amount is written to the Realtime database exports.createStripeCharge = functions.firestore.document('stripe_customers/{userId}/charges/{id}').onCreate(async (snap, context) => { const val = snap.data(); try { // Look up the Stripe customer id written in createStripeCustomer const snapshot = await admin.firestore().collection(stripe_customers).doc(context.params.userId).get() const snapval = snapshot.data(); const customer = snapval.customer_id // Create a charge using the pushId as the idempotency key // protecting against double charges const amount = val.amount; const idempotencyKey = context.params.id; const charge = {amount, currency, customer}; if (val.source !== null) { charge.source = val.source; } const response = await stripe.charges.create(charge, {idempotency_key: idempotencyKey}); // If the result is successful, write it back to the database return snap.ref.set(response, { merge: true }); } catch(error) { // We want to capture errors and render them in a user-friendly way, while // still logging an exception with StackDriver console.log(error); await snap.ref.set({error: userFacingMessage(error)}, { merge: true }); return reportError(error, {user: context.params.userId}); } }); // [END chargecustomer]]

// When a user is created, register them with Stripe exports.createStripeCustomer = functions.auth.user().onCreate(async (user) => { const customer = await stripe.customers.create({email: user.email}); return admin.firestore().collection('stripe_customers').doc(user.uid).set({customer_id: customer.id}); });

// Add a payment source (card) for a user by writing a stripe payment source token to Realtime database exports.addPaymentSource = functions.firestore.document('/stripe_customers/{userId}/tokens/{pushId}').onCreate(async (snap, context) => { const source = snap.data(); const token = source.token; if (source === null){ return null; }

try { const snapshot = await admin.firestore().collection('stripe_customers').doc(context.params.userId).get(); const customer = snapshot.data().customer_id; const response = await stripe.customers.createSource(customer, {source: token}); return admin.firestore().collection('stripe_customers').doc(context.params.userId).collection("sources").doc(response.fingerprint).set(response, {merge: true}); } catch (error) { await snap.ref.set({'error':userFacingMessage(error)},{merge:true}); return reportError(error, {user: context.params.userId}); } });

// When a user deletes their account, clean up after them exports.cleanupUser = functions.auth.user().onDelete(async (user) => { const snapshot = await admin.firestore().collection('stripe_customers').doc(user.uid).get(); const customer = snapshot.data(); await stripe.customers.del(customer.customer_id); return admin.firestore().collection('stripe_customers').doc(user.uid).delete(); });

// To keep on top of errors, we should raise a verbose error report with Stackdriver rather // than simply relying on console.error. This will calculate users affected + send you email // alerts, if you've opted into receiving them. // [START reporterror] function reportError(err, context = {}) { // This is the name of the StackDriver log stream that will receive the log // entry. This name can be any valid log stream name, but must contain "err" // in order for the error to be picked up by StackDriver Error Reporting. const logName = 'errors'; const log = logging.log(logName);

// https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/MonitoredResource const metadata = { resource: { type: 'cloud_function', labels: {function_name: process.env.FUNCTION_NAME}, }, };

// https://cloud.google.com/error-reporting/reference/rest/v1beta1/ErrorEvent const errorEvent = { message: err.stack, serviceContext: { service: process.env.FUNCTION_NAME, resourceType: 'cloud_function', }, context: context, };

// Write the error log entry return new Promise((resolve, reject) => { log.write(log.entry(metadata, errorEvent), (error) => { if (error) { return reject(error); } return resolve(); }); }); } // [END reporterror]

// Sanitize the error message for the user function userFacingMessage(error) { return error.type ? error.message : 'An error occurred, developers have been alerted'; } Steps to set up and reproduce Windows 10, brand new installation of node 10 and firebase-tools (v 6.9.2). Follow the instructions on the github page for installing the npm package and setting up stripe key and so on, but instead of firebase deploy, I used firebase serve. Change node version to 10 in package.json. Attached stripe example to firebase hosting as well.

Sample data pasted or attached as JSON (not an image)

Security rules used

Debug output

Errors in the console logs functions: Using node@10 from host.

Screenshots

Expected behavior

The local emulator starts running and I can test firebase functions without deploying them.

Actual behavior

Firebase hosting works fine, but all cloud firestore functions get ignored.

AndersonHappens commented 5 years ago

Update: I just tried this on macbook and I got the same results. So it's not a Windows exclusive error. Mac version: Sierra, 10.12.6 npm: 6.4.1 node: 10.15.3 firebase: 6.9.2 firebase-admin: 7.3.0 firebase-functions: 2.3.1 firebase-functions-test: 0.1.6 @google-cloud/logging 0.7.1 stripe: 4.25.0

AndersonHappens commented 5 years ago

Possibly related to commit #1263: https://github.com/firebase/firebase-tools/pull/1263/commits/e0e58984767da875df4ada4bf1e38d14bd2f4f94

nikitakarpenkov commented 5 years ago

@AndersonHappens could be you don't have firestore configured properly in your firebase.json file. This makes emulator not being started.

What you need is to run firebase init firestore in your project directory. This would create firestore rules and indexes files and update your firebase.json correspondingly.

AndersonHappens commented 5 years ago

I did try that before but nothing seemed to change.

On Mon, May 27, 2019, 8:57 AM Nikita Karpenkov notifications@github.com wrote:

@AndersonHappens https://github.com/AndersonHappens could be you don't have firestore configured properly in your firebase.json file. This makes emulator not being started.

What you need is to run firebase init firestore in your project directory. This would create firestore rules and indexes files and update your firebase.json correspondingly.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/firebase/functions-samples/issues/572?email_source=notifications&email_token=ACTN3LTZIL4HYBNZIRAKX7DPXPLD5A5CNFSM4HMKXJL2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODWJXTNY#issuecomment-496204215, or mute the thread https://github.com/notifications/unsubscribe-auth/ACTN3LQXFWYOLQVVUU6RT33PXPLD5ANCNFSM4HMKXJLQ .

adxworld commented 5 years ago

I have the same exact issue. Found any fix?

AndersonHappens commented 5 years ago

No fixes found for me. I could still deploy the functions just fine (I just couldn't emulate them), so I deployed them while having them pointed to a fake test database path and tested them locally with that fake path, and then when I deployed the website for real I changed the paths in both the functions and in my hosting project to point towards the actual database.

BrentWMiller commented 5 years ago

I changed the serve script in my functions package.json to npm run build && firebase serve --only functions,firestore and it recognizes both my HTTP triggers and Cloud Firestore Triggers.


Edit: Moving my other comment here for visibility with this issue

So this isn't working like I thought.

Running serve ("serve": "npm run build && firebase serve --only functions") I get the following message for any Firestore triggers:

Ignoring trigger "ordersCreate" because the Cloud Firestore emulator is not running.

Switching the serve command to npm run build && firebase serve --only functions,firestore I get the following message for any Firestore triggers:

Trigger "ordersCreate" has been acknowledged by the Cloud Firestore emulator.

The emulator now works, but...

Unfortunately, this still means the triggers aren't initialized so I can't test them locally and see any console logs or other debugging information.

adxworld commented 5 years ago

@AndersonHappens Well, thats exactly what I have been doing for a long while.

adxworld commented 5 years ago

@BrentWMiller I gotta try it. Will get back to you after I did.

AndersonHappens commented 5 years ago

I've been messing with this for the last few hours.

Running firebase serve --only functions,firestore prompts me to setup the firestore emulator, which I thought I had done, but apparently hadn't.

Running firebase setup:emulators:firestore and then firebase serve --only functions,firestore again then told me that my stripe token was undefined, but it was clearly defined using firebase functions:config:get, so I followed the advice in this thread: https://github.com/firebase/firebase-tools/issues/678 and did
firebase functions:config:get > .runtimeconfig.json and that got rid of that error. (Though the thread references a page for performing that command, but I can't find any references to that command anywhere in the actual documentation).

If I then try to test everything at once with firebase serve --only hosting,functions,firestore, then it tells me that Trigger "x" has been acknowledged by the Cloud Functions emulator for most of my functions.

However, if I just call firebase serve it still gives me the "Ignoring trigger because the Cloud Firestore emulator is not running" warning, even if I am running the firebase emulators in a different console window and have run export FIRESTORE_EMULATOR_HOST=localhost:8080, but that is really whatever, calling all of the things I want explicitly isn't that much of a pain.

The real issue I have now is that the firestore emulator doesn't seem to do anything! If I use the firebase website created by hosting to update firestore, it updates the actual database and calls the actual firestore function which gets logged in the firebase logs. If I change the local index.js to add different logs, those logs don't appear and only the old ones are used. It does not log the console.log calls to the terminal like the documentation says or even to the debug file.

At this point I feel like I'm missing something obvious or that the emulator is not designed to work like I think it does. Is there some flag or command I am missing so that hosting sends the data to the emulator instead of the actual database or does the emulator not intercept the database writes from firebase hosting?

kreoo commented 5 years ago

Same problem. Tried using firebase emulators:start to start hosting, firestore, functions. The idea was same op, to test triggers on a database. Also tried with firebase serve no go. Same error in all, updates the actual database and even though it reports as "acknowledged" by emulator the functions does not trigger "onCreate" and so on....

functions package:
  "firebase-admin": "^8.0.0",
  "firebase-functions": "^3.0.0",
  "glob": "^7.1.4"

mainproject:
  "firebase": "^6.2.0",

$ firebase --version
7.0.0
AndersonHappens commented 5 years ago

I tried again today. Functions are being acknowledged by the emulator, but the modified functions are not being used and only the deployed functions are. Additionally, no logging is happening in console.

node version: 8.13.0

firebase version: 7.1.1 firebase-admin: 8.2.0 firebase-functions: 3.1.0

I also tried updating node to 12.6.0 and npm to 6.9.0, but that didn't change anything.

lincolnlemos commented 5 years ago

Same here

dreamdev21 commented 5 years ago

Same here, any update?

digitalml commented 5 years ago

when will this be fixed please?

SamalaSumanth0262 commented 5 years ago

Same here too, are there are any other open issues related to this ?

danieldanielecki commented 5 years ago

firebase serve did not work, firebase serve --only functions,firestore did work for me on Node 10.

"firebase": "^6.3.1",
"firebase-admin": "^8.3.0",
"firebase-functions": "^3.0.2"
AndersonHappens commented 5 years ago

@danieldanielecki did you test the firestore functions for firebase serve --only functions,firestore and see if they printed to your local console? Did you test to see if it was running your local code (and not your deployed code)? Because for me it only ever runs the deployed code and not the local code I'm trying to serve

skwny commented 5 years ago

All emulators start for me, however I receive this message for my auth onCreate trigger:

functions[auth_onCreate-default]: function ignored because the firebaseauth.googleapis.com emulator does not exist or is not running.

dorian-marchal commented 5 years ago

Same here, I can't my triggers to work locally via the emulators.

jmdibble commented 5 years ago

This is killing me slowly. Fixed it a couple of days ago, and bam, same error again?! Cannot seem to work out why.

georgewwindsor commented 5 years ago

this bug is ruining my life. it makes testing database sharding almost impossible.

super-jb commented 4 years ago

Any updates on this error? Same issue package.json "serve": "npm run build && firebase serve --only functions,firestore" console output: functions[createUserRecord]: function ignored because the firebaseauth.googleapis.com emulator does not exist or is not running.

sidzan commented 4 years ago

I am facing the same issue, I am trying to send email "welcome email" but it is not working, any suggestion is much appreciated

export const sendWelcomeEmail = functions.auth.user().onCreate((user) => {
    console.info("sendWelcomeEmail", user);
});

I get the following In the console functions[sendWelcomeEmail]: function ignored because the firebaseauth.googleapis.com emulator does not exist or is not running.

UPDATE This does work when deployed. It only does not work locally. Anyone stuck on development don't be discouraged , just deploy and test it live

barnu5 commented 4 years ago

Together with this issue, the emulators are unusable on windows:

https://github.com/firebase/firebase-tools/issues/1458

Galzk commented 4 years ago

Guys this is my first major firebase project and I'm kinda stuck, same issue, deploying functions takes forever and this was my only sane option :/ Is the only solution is dual booting Linux or getting a mac? I really like the tech but the dev experience I'm getting is not smooth at all...

laurentpayot commented 4 years ago

@Galzk you can also git-clone, edit, and deploy your project from the Google Cloud Shell of your Firebase account: https://ssh.cloud.google.com/cloudshell/editor

Galzk commented 4 years ago

@Galzk you can also git-clone, edit, and deploy your project from the Google Cloud Shell of your Firebase account: https://ssh.cloud.google.com/cloudshell/editor

Thank you for that, trying now

stephan227 commented 4 years ago

I just spent 4 hours trying to resolve this issue. Ended up shotgunning the onCreate event straight to production after trying everything I found here and on stackoverflow. I'm still getting the error: functions[createUserDoc]: function ignored because the firebaseauth.googleapis.com emulator does not exist or is not running.

iamboroda commented 4 years ago

Had similar problem with firestore emulator. Was resolved after I run

firebase init

again, selecting database and functions. Maybe same will help for other types of emulators.

simondotm commented 4 years ago

Just in case another person visits this thread because of the ignored trigger error, just double check you've referenced functions.**firebase**.document(...) and not functions.**database**.ref(..) in your trigger code like I accidentally did. Mea culpa from copying example code without looking closely.

benjaminbalazs commented 4 years ago

I also spent the whole day trying to get trigger work, or just get rid of the "because the firebaseauth.googleapis.com emulator does..".

tremendus commented 4 years ago

Another tip on this issue - for me, I was running Vue just project in the root folder with firebase functions in its standard ~/functions folder and since Vue dev server was configured to run on :8080, I had switched Firestore port to 8800 in firebase.json at firebase init. However I was seeing the same error as the rest of you.

However, when I switched the Vue port over to 8000 and put the Firestore port back to default 8080, it all works for me.

Seems like even though you can set the port in the firebase json, it's possible not probed when running the emulators or maybe when calling them.

arrrrny commented 4 years ago

I changed the serve script in my functions package.json to npm run build && firebase serve --only functions,firestore and it recognizes both my HTTP triggers and Cloud Firestore Triggers.

Same is true for realtime database, just add 'database' like npm run build && firebase serve --only functions,database

pro-react233 commented 4 years ago

I received same as message when I run the "firebase serve" function ignored because the firestore emulator does not exist or is not running. I have had a headache for a few weeks.

andyfangaf commented 4 years ago

I'm getting a similar error but for auth. And this is right after firebase init.

function ignored because the firebaseauth.googleapis.com emulator does not exist or is not running.
andyfangaf commented 4 years ago

Looks like auth cloud functions are not supported in the local emulator https://github.com/firebase/firebase-tools/issues/1677

NilPuig commented 4 years ago

First you need to download the emulator: firebase setup:emulators:firestore and then run the functions locally withfirebase serve --only functions,firestore

andyfangaf commented 4 years ago

@NilPuig I don't think there's an emulator for Cloud Functions yet.

pro-react233 commented 4 years ago

Me too

alexroldan commented 4 years ago

This is how I got mine working for firestore emulator .... reference for future project ...

1) I added these to windows environment variables

FIRESTORE_EMULATOR_HOST = localhost:8080 FIREBASE_FIRESTORE_EMULATOR_ADDRESS = localhost:8080

2) I'm using vuejs ... in the main.js file I have this code after firebase.initializeApp

if (window.location.host.includes("localhost") || window.location.host.includes("127.0.0.1") || process.env.NODE_ENV === "development") { firebase.functions().useFunctionsEmulator("http://localhost:5001"); firebase.firestore().settings({ host: "localhost:8080", ssl: false, }); }

3) Your project mush have installed firebase functions, firestore, emulators, etc ... you have to search on how to do it ... then I have this code in the index.js of functions folder

const funcName = functions.firestore.document("users/{userId}").onWrite((change, context) => { console.log("USERID:", context.params.userId); return true; });

4) in the client side ... my method calls like this

firebase .firestore().collection("users").doc(user.uid) .set( {name: this.profile.name, }, { merge: true });

5) to start the emulator for firestore, it must be

firebase emulators:start --only firestore,functions

6) in firebase.json i have this entry

"emulators": {
    "functions": {
        "port": 5001
    },
    "firestore": {
        "port": 8080,
        "host": "localhost"
    },
    "hosting": {
        "port": 5000
    }
},

7) you need to restart the emulator from time to time, especially when you think you're doing the right thing but the result is not

NEED TO MAKE THIS WORK: function ignored because the auth emulator does not exist or is not running.

benwinding commented 4 years ago

Nothing here has helped me get firestore triggers working... has anyone got firestore triggers working locally within tests?

benwinding commented 4 years ago

For anyone struggling with testing firestore triggers, I've made an example repository that will hopefully help other people

https://github.com/benwinding/example-jest-firestore-triggers

sshahzaiib commented 4 years ago

For anyone struggling with testing firestore triggers, I've made an example repository that will hopefully help other people

https://github.com/benwinding/example-jest-firestore-triggers

I changed the start script in package.json "start": "firebase emulators:start --only firestore,functions"

yarn run v1.22.4 $ firebase emulators:start --only firestore,functions i emulators: Starting emulators: functions, firestore ... ✔ functions[createNotificationOnRequest]: firestore function initialized. ✔ emulators: All emulators started, it is now safe to connect.

at first it downloaded some firestore emulator package around 90MB everything is running fine now

ahmadalibaloch commented 4 years ago

Not working: firebase serve --only functions,firestore

Error: Please use firebase emulators:start to start the Realtime Database or Cloud Firestore emulators. firebase serve only supports Hosting and Cloud Functions.

benwinding commented 4 years ago

@ahmadalibaloch make sure you have the latest firestore-tools installed

peetacho commented 4 years ago

Mine still shows this error: functions[sendEmailConfirmation]: function ignored because the database emulator does not exist or is not running.

mamidipalli commented 4 years ago

I overcame this by running firebase init emulators

Found it from here: https://github.com/firebase/firebase-tools/pull/1755

Rovholo commented 4 years ago

I solved this issue on my project. The problem with mine was that I had not initialised firestore. to initialise firestore run: firebase init firestore actually check if it gives an error( if it does there may be a solution prescribed on the terminal/comand prompt) run firebase emulators:start to start all emulators. Thanks @mamidipalli . I actually understood what to do after I saw your comment.

I overcame this by running firebase init emulators

Found it from here: firebase/firebase-tools#1755

jkim430 commented 4 years ago

Just in case another person visits this thread because of the ignored trigger error, just double check you've referenced functions.**firebase**.document(...) and not functions.**database**.ref(..) in your trigger code like I accidentally did. Mea culpa from copying example code without looking closely.

Thank you!! This solved my issue - I had copied code from an article that was using the RT database instead of firestore, so they had this:

exports.sendAdminNotification = functions.database.ref('/collection/{id}').onWrite(event => {});

and I changed to this:

exports.sendAdminNotification = functions.firestore.document('/collection/{id}').onWrite((change, context) => {});

Also, when you run the firestore emulator, it doesn't actually listen to your real firestore, but sets up a mock firestore that you can modify using the local UI (e.g. localhost:4000/firestore). When you make updates to this mock firestore, your event triggers in your firebase functions should pick it up. More info here