Firebase SDK for Cloud Functions Quickstart - Firestore with auth context

This quickstart demonstrates using the Firebase SDK for Cloud Functions with Firestore with authentication context.

Introduction

This sample app adds auth metadata to all documents written to a collection.

Set up the sample

Before you can test the functions locally or deploy to a Firebase project, you'll need to run npm install in the functions directory.

Run locally with the Firebase Emulator suite

The Firebase Local Emulator Suite allows you to build and test apps on your local machine instead of deploying to a Firebase project.

1. Create a Firebase project in the Firebase Console

   Wondering why this step is needed? Even though the emulator will run this sample on your local machine, it needs to interact with a Firebase project to retrieve some configuration values.

2. Set up or update the Firebase CLI

3. Run firebase emulators:start

4. Open the Emulator Suite UI

   1. Look in the output of the firebase emulators:start command for the URL of the Emulator Suite UI. It defaults to localhost:4000, but may be hosted on a different port on your machine.
   2. Enter that URL in your browser to open the UI.

5. Trigger the functions

   1. Look in the output of the firebase emulators:start command for the URL of the http function "verifyComment". It will look similar to: http://localhost:5001/MY_PROJECT/us-central1/verifyComment
      1. MY_PROJECT will be replaced with your project ID
      2. The port may be different on your local machine
   2. Create a new document in the comments collection in Firestore in the emulator UI.

6. View the effects of the functions in the Emulator Suite UI

   1. In the "Logs" tab, you should see new logs indicating that the functions "verifyComment" and "makeuppercase" ran:

      functions: Beginning execution of "verifyComment"

   2. In the "Firestore" tab, you should see the document containing your original message updated to include auth context.

Deploy and test on a live Firebase project

To deploy and test the sample:

1. Create a Firebase project on the Firebase Console
2. Deploy your project's code using firebase deploy
3. Create a new document in the comments collection in Firestore in the Firebase console.

You should see the document containing your original message updated to include auth context.

Contributing

We'd love that you contribute to the project. Before doing so please read our Contributor guide.

License

© Google, 2023. Licensed under an Apache-2 license.