Real-time listeners (onSnapshot) in Firebase - Mini Project: Build & Apply

Real-time Listeners with Firebase onSnapshot

📖 Scenario: You are building a simple web app that shows a live list of messages from users. The messages are stored in a Firebase Firestore database. You want the app to update instantly whenever a new message is added, without needing to refresh the page.

🎯 Goal: Build a Firebase Firestore real-time listener using onSnapshot to automatically update the list of messages whenever the database changes.

📋 What You'll Learn

Create a Firestore collection reference called messagesRef pointing to the messages collection

Create a real-time listener using onSnapshot on messagesRef

Inside the listener, update a local array messages with the current documents' data

Log the updated messages array inside the listener to verify real-time updates

💡 Why This Matters

🌍 Real World

Real-time listeners are essential for chat apps, live dashboards, and collaborative tools where data must update instantly for all users.

💼 Career

Understanding how to implement real-time data updates with Firebase is a valuable skill for frontend and full-stack developers working on interactive web applications.

1

Setup Firestore collection reference

Create a constant called messagesRef that references the Firestore collection named messages using collection(db, 'messages').

Firebase

import { getFirestore, collection } from 'firebase/firestore';
import { initializeApp } from 'firebase/app';

const firebaseConfig = {
  apiKey: 'your-api-key',
  authDomain: 'your-auth-domain',
  projectId: 'your-project-id'
};

const app = initializeApp(firebaseConfig);
const db = getFirestore(app);

// Create messagesRef pointing to 'messages' collection
// Your code here

Hint

Use the collection function with db and the string 'messages' to create messagesRef.

2

Create an empty array to hold messages

Create a variable called messages and set it to an empty array [] to store the message data locally.

Firebase

import { getFirestore, collection } from 'firebase/firestore';
import { initializeApp } from 'firebase/app';

const firebaseConfig = {
  apiKey: 'your-api-key',
  authDomain: 'your-auth-domain',
  projectId: 'your-project-id'
};

const app = initializeApp(firebaseConfig);
const db = getFirestore(app);

const messagesRef = collection(db, 'messages');

// Create an empty array called messages
// Your code here

Hint

Declare messages as an empty array using let messages = [].

3

Add a real-time listener with onSnapshot

Use onSnapshot on messagesRef to listen for real-time updates. Inside the callback, update the messages array by mapping over snapshot.docs and extracting each document's data with doc.data().

Firebase

import { getFirestore, collection } from 'firebase/firestore';
import { initializeApp } from 'firebase/app';
import { onSnapshot } from 'firebase/firestore';

const firebaseConfig = {
  apiKey: 'your-api-key',
  authDomain: 'your-auth-domain',
  projectId: 'your-project-id'
};

const app = initializeApp(firebaseConfig);
const db = getFirestore(app);

const messagesRef = collection(db, 'messages');

let messages = [];

// Add onSnapshot listener on messagesRef
// Your code here

Hint

Use onSnapshot(messagesRef, callback) and inside the callback set messages = snapshot.docs.map(doc => doc.data()).

4

Log messages inside the onSnapshot listener

Inside the onSnapshot callback, add a line to log the updated messages array using console.log(messages) to verify real-time updates.

Firebase

import { getFirestore, collection } from 'firebase/firestore';
import { initializeApp } from 'firebase/app';
import { onSnapshot } from 'firebase/firestore';

const firebaseConfig = {
  apiKey: 'your-api-key',
  authDomain: 'your-auth-domain',
  projectId: 'your-project-id'
};

const app = initializeApp(firebaseConfig);
const db = getFirestore(app);

const messagesRef = collection(db, 'messages');

let messages = [];

onSnapshot(messagesRef, (snapshot) => {
  messages = snapshot.docs.map(doc => doc.data());
  // Log messages here
  // Your code here
});

Hint

Inside the onSnapshot callback, add console.log(messages) to see updates.

Practice

1. What does the onSnapshot method do in Firebase Firestore?

easy

A. It creates a new Firestore database.

B. It deletes a document from Firestore.

C. It uploads files to Firebase Storage.

D. It listens for real-time updates to data and runs a callback when data changes.

Solution

1. Step 1: Understand the purpose of onSnapshot

   The onSnapshot method is designed to listen for changes in Firestore data in real-time.

2. Step 2: Identify what happens when data changes

   When data changes, onSnapshot runs a callback function to update the app immediately.

3. Final Answer:

   It listens for real-time updates to data and runs a callback when data changes. -> Option D

4. Quick Check:

   onSnapshot = real-time updates listener [OK]

Hint: Remember: onSnapshot = live updates listener [OK]

Common Mistakes:

• Confusing onSnapshot with data deletion
• Thinking onSnapshot uploads files
• Assuming onSnapshot creates databases

2. Which of the following is the correct syntax to start listening to a Firestore collection named users using onSnapshot?

easy

A. db.users.onSnapshot(snapshot => { /* handle data */ });

B. db.collection('users').getSnapshot(snapshot => { /* handle data */ });

C. db.collection('users').onSnapshot(snapshot => { /* handle data */ });

D. db.collection('users').listen(snapshot => { /* handle data */ });

Solution

1. Step 1: Recall Firestore collection access syntax

   Firestore collections are accessed with db.collection('collectionName').

2. Step 2: Confirm the correct method for real-time listening

   The method to listen for real-time updates is onSnapshot, not getSnapshot or listen.

3. Final Answer:

   db.collection('users').onSnapshot(snapshot => { /* handle data */ }); -> Option C

4. Quick Check:

   Correct syntax = collection + onSnapshot [OK]

Hint: Use collection('name').onSnapshot for real-time data [OK]

Common Mistakes:

• Using .users instead of .collection('users')
• Using getSnapshot or listen instead of onSnapshot
• Missing parentheses or arrow function syntax

3. Given the code below, what will be logged if the users collection has two documents with names 'Alice' and 'Bob'?

db.collection('users').onSnapshot(snapshot => {
  snapshot.forEach(doc => {
    console.log(doc.data().name);
  });
});

medium

A. Alice\nBob

B. undefined\nundefined

C. Error: doc.data is not a function

D. No output

Solution

1. Step 1: Understand onSnapshot callback behavior

   The callback receives a snapshot of the collection documents at the time of the update.

2. Step 2: Loop through each document and access data

   Using snapshot.forEach, each document's data is accessed with doc.data(), and the name field is logged.

3. Final Answer:

   Alice\nBob -> Option A

4. Quick Check:

   doc.data().name logs names correctly [OK]

Hint: Use doc.data() inside forEach to get document fields [OK]

Common Mistakes:

• Trying to access doc.name instead of doc.data().name
• Using snapshot.docs without forEach
• Expecting synchronous return instead of callback

4. What is wrong with this code snippet that uses onSnapshot?

const unsubscribe = db.collection('messages').onSnapshot(snapshot => {
  snapshot.forEach(doc => {
    console.log(doc.data().text);
  });
});
// Later in code
unsubscribe();
unsubscribe();

medium

A. Not unsubscribing causes memory leaks.

B. The code is correct and unsubscribing twice is safe.

C. Calling unsubscribe twice causes an error.

D. onSnapshot does not return an unsubscribe function.

Solution

1. Step 1: Understand unsubscribe function from onSnapshot

   The onSnapshot method returns a function to stop listening when called.

2. Step 2: Analyze calling unsubscribe multiple times

   The unsubscribe function is idempotent; calling it more than once is safe and has no effect after the first call.

3. Final Answer:

   The code is correct and unsubscribing twice is safe. -> Option B

4. Quick Check:

   Unsubscribe function safe to call multiple times [OK]

Hint: Unsubscribe() is safe to call multiple times [OK]

Common Mistakes:

• Forgetting to unsubscribe (memory leaks)
• Assuming onSnapshot does not return unsubscribe
• Confusing unsubscribe with data operations

5. You want to listen to a Firestore document settings/config and update your app UI only when the field theme changes. How can you efficiently use onSnapshot to achieve this?

hard

A. Use onSnapshot on the document and inside callback compare previous and current theme values before updating UI.

B. Use onSnapshot on the whole collection settings and update UI on any change.

C. Call get() repeatedly every second to check for changes.

D. Use onSnapshot on the document but update UI without checking field changes.

Solution

1. Step 1: Use onSnapshot on the specific document

   Listening to the exact document settings/config avoids unnecessary updates from other documents.

2. Step 2: Compare previous and current theme values inside callback

   By storing the previous theme value, you can check if it changed before updating the UI, improving efficiency.

3. Final Answer:

   Use onSnapshot on the document and inside callback compare previous and current theme values before updating UI. -> Option A

4. Quick Check:

   Compare field changes inside onSnapshot callback [OK]

Hint: Compare old and new data inside onSnapshot callback [OK]

Common Mistakes:

• Listening to whole collection causing extra updates
• Polling with get() instead of real-time listener
• Updating UI without checking if field changed