Christian Genco

Firebase

Firebase

0. What we won't cover #

Hosting (use vercel), crashlytics, FCM, remote config, ab testing, dynamic links, predictions, app distribution, anything mobile

1. Setting Up a Firebase Project and Using the Emulator #

v9 #

In August 2021 Google introduced the v9 version of the Firebase library for Javascript. This version of the SDK is designed in a more functional style which enables tree shaking to minimize unused code.

In my opinion this change has been kind of a pain but here we are. You may see still see code floating around Stack Overflow in the old style that looks like this:

import firebase from "firebase/app";
import "firebase/firestore";

const db = firebase.firestore();

const userDoc = db.collection("users").doc("user1");
userDoc.set({
  name: "John Doe",
  email: "john@example.com",
  points: 100,
});

The newer v9 version (and the version used in this post) to do the same thing would look like this:

import { doc, setDoc, getFirestore } from "firebase/firestore";

const db = getFirestore();

const userDoc = doc(db, "users", "user1");
setDoc(userDoc, {
  name: "John Doe",
  email: "john@example.com",
  points: 100,
});

Except, confusingly, when using firebase-admin which we'll talk about in the Firebase Serverless Functions part. For that we're still on the pre-v9 style.

2. Firestore #

2.1 Introduction to Firestore #

Cloud Firestore is a NoSQL document-based scalable real-time database hosted by Google.

It’s the most convenient way I’ve found to add a database to web apps. When combined with other products from Firebase it’s powerful enough to completely remove the need for a traditional backend like Rails, Django, or Laravel.

When using Firestore you’ll never have to worry about scaling, uptime, replication, or other headaches you’ll run into when using traditional databases. As long as you architect your app in a way that avoids triggering recursive writes (we’ll cover this in the Cloud Functions section) Firestore will (probably) be much cheaper than using a regular database.

My experience with using it has been blissful. It has some serious limits that need to be worked around but if you can design your web apps with Firestore in mind the database layer requires much less ongoing thought in the app building and maintenance process. Plus, you get real-time updates and nearly infinite scaling practically for free!

2.2 Writing a Document #

Firestore holds Collections of Documents. Documents can contain Collections.

You can think of a Document as a JSON object. Firestore documents can hold strings, numbers, booleans, dates, and null as well as maps, arrays, references to other documents, and geographical points.

Here's how to write a document:

import { getFirestore, doc, setDoc } from "firebase/firestore";

const db = getFirestore();

const postRef = doc(db, "posts", "myPostId");
await setDoc(postRef, {
  title: "My First Blog Post",
  views: 150,
  isPublished: true,
  publishedAt: new Date(),
  owner: null,
  metadata: {
    author: "Christian",
  },
  tags: ["tag1", "tag2", "tag3"],
  // author: authorRef,
  // location: new GeoPoint(37.422, 122.084),
});

Note that we don't have to define any sort of schema for which keys in this collection will contain values that will be a certain type. We just set a JSON object at a document path! Firestore is extremely flexible in this way. You can decide to add collections or attributes to documents on the fly and it just works.

Every 100k document writes costs $0.18.

In the above code I specified an ID for this document (myPostId) but we also could’ve added a document to a Collection and gotten an automatically generated ID, like this:

import { getFirestore, collection, addDoc } from "firebase/firestore";

const db = getFirestore();

const postsRef = doc(db, "posts");
await addDoc(postRef, { title: "My post" });

2.3 Reading a Document #

Uncommonly you’ll want to read a document a single time like this:

import { getFirestore, doc, getDoc } from "firebase/firestore";

const db = getFirestore();

const postRef = doc(db, "posts", "myPostId");
const postSnap = await getDoc(postRef);
const post = postSnap.data();

More commonly you’ll want to read a document and keep it updated if it changes, like this:

import { getFirestore, doc, onSnapshot } from "firebase/firestore";

const db = getFirestore();

const postRef = doc(db, "posts", "myPostId");
const unsubscribe = onSnapshot(postRef, (postSnap) => {
  const post = postSnap.data();
});

Even more commonly you’ll just read data from a Firebase React hook with something like const { data: post } = useDoc(/posts/myPostId")

2.4 Updating a Document #

To upsert a Document (ie: create it if it doesn’t exist and update it if it does) use:

import { getFirestore, doc, setDoc } from "firebase/firestore";
const db = getFirestore();

const postRef = doc(db, "posts", "myPostId");

await setDoc(postRef, { views: 151 }, { merge: true });

To update an existing document (and fail if the document doesn’t exist) use:

import { getFirestore, doc, updateDoc } from "firebase/firestore";
const db = getFirestore();

const postRef = doc(db, "posts", "myPostId");

await updateDoc(postRef, { views: 151 });

There are a handful of special values (known as Field Values) that you can include as attributes when updating a Document to avoid race conditions. They are:

Two other useful Field Values are:

Here's how we might use Field Values to update a document:

import {
  getFirestore,
  doc,
  updateDoc,
  getFirestore,
  deleteField,
  serverTimestamp,
  arrayUnion,
  increment,
} from "firebase/firestore";

const db = getFirestore();

const postRef = doc(db, "posts", "myPostId");
updateDoc(postRef, {
  updatedAt: serverTimestamp(),
  tags: arrayUnion("newTag"),
  views: increment(1),
  owner: deleteField(),
});

2.6 Writing Multiple Documents in a Batch and Transaction #

There are two ways to perform bulk writes of documents to Firestore: batches and transactions. Neither is billed differently than if you wrote documents one at a time but:

  1. Batches and transactions are more network efficient
  2. Batches and transactions ensure that either all of the writes succeed or they all fail

Batches simply group set or update actions:

import { getFirestore, doc, writeBatch } from "firebase/firestore";
const db = getFirestore();

const batch = writeBatch(db);

const post1Ref = doc(db, "posts", "1");
const post2Ref = doc(db, "posts", "2");

batch.set(post1Ref, { title: "Post 1" });
batch.set(post2Ref, { title: "Post 2" }, { merge: true });

await batch.commit();

Transactions group reads and set or update actions for writes that depend on data from other documents:

import { getFirestore, doc, runTransaction } from "firebase/firestore";

const db = getFirestore();

const fromUserRef = doc(db, "users", "1");
const toUserRef = doc(db, "users", "2");

const points = 100;

await runTransaction(db, async (transaction) => {
  const fromUserSnap = await transaction.get(fromUserRef);
  const toUserSnap = await transaction.get(toUserRef);

  if (!fromUserSnap.exists()) throw "From User does not exist!";
  if (!toUserSnap.exists()) throw "To User does not exist!";
  if (fromUserSnap.data().points < points) throw "Not enough points!";

  transaction.update(fromUserRef, {
    points: fromUserSnap.data().points - points,
  });
  transaction.update(toUserRef, { points: toUserSnap.data().points + points });
});

In a transaction, if one of the read documents changes while the writes are being performed the transaction will start over.

2.7 Reading a Collection # 

const usersCollectionRef = collection(db, "users");
const userSnapshot = await getDocs(usersCollectionRef);

const userList = userSnapshot.docs.map((doc) => doc.data());

Hook

2.9 Querying and sorting #

Here’s where the limits of Firestore get spooky. If you’re coming from any sort of SQL database these limits may feel like dealbreakers. I encourage you to sit with the unfamiliarity until you’ve considered how you might get your job done with Firestore before jumping ship. In practice I haven’t yet found an application that couldn’t be modeled entirely within Firebase.

If you really need a way to query data in your app that Firestore doesn’t support, most commonly full text search, you can probably get there with an extension.

Alright let’s rip this bandaid off. With Firestore you can’t:

Still with me? Cool. Here’s how to do a basic query:

import {
  collection,
  query,
  where,
  getDocs,
  getFirestore,
} from "firebase/firestore";

const db = getFirestore();
const usersRef = collection(db, "users");

const q = query(usersRef, where("points", ">", 100));

const querySnapshot = await getDocs(q);

const users = querySnapshot.docs.map((doc) => doc.data());

where() conditions:==, !=, <, <=, >, >=, array-contains, array-contains-any, in, not-in

If you try to do multiple fields you’ll get a link to make an index

Ordering

Pagination #

Limit Start at, startAftwe, end at, end before

Document count

2.12 Creating an Index #

2.13 Limits of Querying #

2.14 Deleting Documents #

TTL

2.15 Deleting Nested Collections #

2.10 Data Modeling #

A common pattern I’ve used that makes writing security rules straightforward is having a top level users collection that stores user Documents, then storing application data specific to that user as a sub collection on the user document.

2.16 Security Rules #

2.17 Backups #

2.18 Pricing #

3. Firebase Authentication #

3.1 Introduction #

3.2 Setting Up Firebase Authentication #

3.3 Email/Password Authentication #

3.4 Logging Out Users #

3.5 Third-Party Authentication Providers #

3.6 Deleting User Accounts #

3.7 Deleting User Data with Accounts #

3.8 Linking Authentication with Firestore #

3.9 Understanding and Handling Authentication Errors #

4. Firebase Cloud Storage #

4.1 Introduction to Firebase Cloud Storage #

4.2 Creating Buckets and the Default Bucket #

4.3 Understanding Bucket Tiers and Locations #

4.4 Uploading an Object #

4.5 Downloading an Object #

4.7 Deleting an Object #

4.8 Firebase Cloud Storage Pricing #

4.9 Security Rules for Firebase Cloud Storage #

5. Firebase Serverless Functions #

5.1 Introduction to Firebase Serverless Functions #

5.2 Setting Up a Firebase Functions Project and Using the Emulator #

5.3 Setup and Deployment of Firebase Functions #

5.4 HTTPS Triggers #

5.5 Reading and Writing to Firestore from Functions #

5.6 Firestore Triggers: onCreate and onDelete #

5.7 Firestore Triggers: onUpdate #

5.8 Auth Triggers #

5.9 Callable Functions #

5.10 Scheduled Functions #

5.11 Understanding Cold Starts #

5.12 Testing and Debugging Functions #

5.13 Managing Dependencies in Firebase Functions #

5.14 Error Handling in Firebase Functions #

5.15 Monitoring and Logging #

5.16 Firebase Serverless Functions Pricing #

6. Firebase Analytics #

6.1 Introduction to Firebase Analytics #

6.2 Setting Up Firebase Analytics #

6.3 Events in Firebase Analytics #

6.4 Tracking Signup Conversion Percentage #

6.5 Tracking Trial to Paid Conversions #

6.6 Measuring User Activation #

6.7 Monitoring Onboarding #

6.8 User Properties and Audiences #

6.9 Reporting and Dashboards #

6.10 Integrations with Other Firebase Services #

6.11 Firebase Analytics Pricing #

7. Firebase Plugins #

7.1 Introduction to Firebase Plugins #

7.2 Sending Emails with Firebase #

7.3 Making Email Templates #

7.4 Sending SMS and MMS Messages with Twilio #

7.5 SaaS Billing with the Stripe Plugin #

7.6 Image Manipulation with ImageMagick #

7.7 Full Text Search with Algolia #

7.8 Machine Learning with ML Kit #

7.9 Using Firebase Cloud Messaging for Notifications #

This complete outline should guide your comprehensive blog post on Firebase. It covers all the high-level topics, broken down into the finer details that you plan to discuss.

Firestore #

Batch writes #

https://googleapis.dev/nodejs/firestore/latest/Firestore.html#bulkWriter

Recursive deletes (delete a doc and its subcollections) #

Only works on the backend:

await firestore.recursiveDelete(docRef);

Google Cloud Storage #

Frustratingly if you include a leading / in the path of your objects you upload Google Cloud Storage will create a new folder called / in your root directory.

Make sure you don't include a leading slash in your path or you'll be very confused for a long time when your files aren't actually where you think they are:

const { Storage } = require("@google-cloud/storage");
const gcs = new Storage();

const bucketName = "project-id.appspot.com";
const bucket = gcs.bucket(bucketName);

const data = "important data";
const badPath = `/no/wrong/bad/data.txt`;
const goodPath = `yes/correct/data.txt`;
await bucket.file(goodPath).save(data);

Firebase Cloud Functions #

Set timeout and memory allocation # 

exports.doSomething = functions
  .runWith({
    timeoutSeconds: 9 * 60,
    memory: "1GB",
  })
  .firestore.document("collection/{docId}")
  .onCreate(doSomething);

Available options for memory (and accompanying CPU speed) are:

Source: https://firebase.google.com/docs/functions/manage-functions#set_timeout_and_memory_allocation

Environment Variables #

Instead of the old way of adding variables to functions.config(), add environment variables to functions/.env and check them into version control:

DROPBOX_KEY="foobarbaz"

Environment variables are synced with firebase when you deploy your firebase cloud functions with firebase deploy --only functions.

Secrets #

Set secrets with firebase functions:secrets:set SECRET_NAME. Destroy them with functions:secrets:destroy SECRET_NAME.

Access secrets in your functions as regular environment variables: process.env.SECRET_NAME

Make sure to explicitly whitelist the secret name for each function that uses it:

exports.myFunction = functions
  .runWith({
    secrets: ["SECRET_NAME"],
  })
  .https.onRequest(myFunction);

Remove cold start delay #

To remove the cold start delay on cloud functions you need an instance running all the time:

exports.foo = functions.runWith({ minInstances: 1 }).https.onRequest(foo);

You'll always have an instance running which based on the google cloud pricing will cost no more than:

There are some free tier and sustained use discounts I don't totally understand.

Note that functions running in some regions are cheaper than others. us-central1 is one of the cheaper Tier 1 regions.

Deploying #

Functions deploy had errors with the following functions #

Try:

Sources: