Upload progress monitoring in Firebase - Commands & Configuration

Introduction

When you upload files to Firebase Storage, you want to see how much has uploaded so far. Upload progress monitoring shows you the current upload status in real time. This helps users know if the upload is working and how long it might take.

When you want to show a progress bar while uploading images to Firebase Storage.

When uploading large videos and you want to inform users about the upload status.

When you want to retry or handle errors based on upload progress events.

When you want to log upload speed or time taken for analytics.

When you want to disable UI elements until the upload finishes.

Commands

Log in to your Firebase account to access your projects and storage.

Terminal

firebase login

Expected Output

✔  Success! Logged in as [e-mail]

Initialize Firebase Storage in your project to enable file uploads.

Terminal

firebase init storage

Expected Output

✔  Firebase Storage: Initialized storage in your project

✔  Created storage.rules file

✔  Created storage.indexes.json file

Run a Node.js script that uploads a file to Firebase Storage and shows upload progress in the console.

Terminal

node upload_with_progress.js

Expected Output

Upload is 10% done

Upload is 25% done

Upload is 50% done

Upload is 75% done

Upload is 100% done

Upload complete!

Key Concept

If you remember nothing else from this pattern, remember: listen to upload state changes to track progress and update users in real time.

Common Mistakes

Not attaching a listener to the upload task's state changes.

Without the listener, you cannot get progress updates and users won't see upload status.

Use the 'on' method on the upload task to listen for 'state_changed' events.

Ignoring error events during upload.

Errors can stop the upload silently, confusing users.

Handle error callbacks to inform users and retry if needed.

Calculating progress incorrectly by dividing bytes transferred by total bytes without converting to percentage.

This causes wrong progress display.

Multiply the fraction by 100 to get a percentage.

Summary

Initialize Firebase Storage in your project using the Firebase CLI.

Use an upload task in your code and listen for 'state_changed' events to monitor progress.

Update the user interface or console output with the upload percentage during the upload.

Practice

1. What does the state_changed event in Firebase Storage upload tasks help you monitor?

easy

A. The number of files in storage

B. The download speed of the file

C. The file size before upload

D. The progress of the file upload

Solution

1. Step 1: Understand the purpose of state_changed

   The state_changed event triggers updates during the upload process.

2. Step 2: Identify what is monitored

   This event provides progress updates, such as bytes transferred and total bytes.

3. Final Answer:

   The progress of the file upload -> Option D

4. Quick Check:

   Upload progress = state_changed event [OK]

Hint: Remember: state_changed tracks upload progress [OK]

Common Mistakes:

• Confusing upload progress with download speed
• Thinking it tracks file size before upload
• Assuming it counts files in storage

2. Which of the following is the correct way to attach a listener for upload progress in Firebase Storage using JavaScript?

easy

A. uploadTask.on('state_changed', progressCallback)

B. uploadTask.listen('progress', progressCallback)

C. uploadTask.addEventListener('upload', progressCallback)

D. uploadTask.track('state_change', progressCallback)

Solution

1. Step 1: Recall Firebase Storage upload syntax

   The method to listen for upload events is on with event name state_changed.

2. Step 2: Match correct method and event

   Only uploadTask.on('state_changed', progressCallback) is valid syntax.

3. Final Answer:

   uploadTask.on('state_changed', progressCallback) -> Option A

4. Quick Check:

   Use .on('state_changed') for progress [OK]

Hint: Use .on('state_changed') to monitor upload progress [OK]

Common Mistakes:

• Using non-existent methods like listen or track
• Wrong event names like 'progress' or 'upload'
• Confusing event listener syntax with DOM events

3. Given the following code snippet, what will be logged if 500 bytes out of 1000 bytes are uploaded?

uploadTask.on('state_changed', (snapshot) => {
  const progress = (snapshot.bytesTransferred / snapshot.totalBytes) * 100;
  console.log(`Upload is ${progress}% done`);
});

medium

A. Upload is 0.5% done

B. Upload is 50% done

C. Upload is 500% done

D. Upload is 100% done

Solution

1. Step 1: Calculate progress percentage

   Progress = (500 / 1000) * 100 = 50%

2. Step 2: Understand console output

   The console logs: "Upload is 50% done".

3. Final Answer:

   Upload is 50% done -> Option B

4. Quick Check:

   Progress = bytesTransferred / totalBytes * 100 [OK]

Hint: Divide bytesTransferred by totalBytes, multiply by 100 [OK]

Common Mistakes:

• Confusing bytesTransferred with percentage
• Multiplying by 100 twice
• Using integer division without decimal

4. You wrote this code to monitor upload progress but it never logs anything:

uploadTask.on('state_change', (snapshot) => {
  const progress = (snapshot.bytesTransferred / snapshot.totalBytes) * 100;
  console.log(`Upload is ${progress}% done`);
});

What is the error?

medium

A. The event name should be 'state_changed', not 'state_change'

B. The callback function is missing a return statement

C. You must use uploadTask.addListener instead of on

D. The progress calculation formula is incorrect

Solution

1. Step 1: Check event name spelling

   The correct event name is 'state_changed', not 'state_change'.

2. Step 2: Understand impact of wrong event name

   Using wrong event name means callback never triggers, so no logs appear.

3. Final Answer:

   The event name should be 'state_changed', not 'state_change' -> Option A

4. Quick Check:

   Event name must be exact 'state_changed' [OK]

Hint: Check event spelling: 'state_changed' not 'state_change' [OK]

Common Mistakes:

• Misspelling event names
• Expecting logs without callback firing
• Confusing method names like addListener vs on

5. You want to display upload progress as a percentage and also show a message when upload completes. Which code snippet correctly implements this using Firebase Storage's state_changed event?

hard

A. uploadTask.on('progress', snapshot => {
const progress = (snapshot.bytesTransferred / snapshot.totalBytes) * 100;
console.log(`Upload is ${progress}% done`);
});

B. uploadTask.on('state_changed', snapshot => {
console.log('Upload complete!');
});

C. uploadTask.on('state_changed', snapshot => {
const progress = (snapshot.bytesTransferred / snapshot.totalBytes) * 100;
console.log(`Upload is ${progress}% done`);
}, error => {
console.error(error);
}, () => {
console.log('Upload complete!');
});

D. uploadTask.on('state_changed', () => {
console.log('Upload is done');
});

Solution

1. Step 1: Use correct event and callbacks

   The state_changed event accepts three callbacks: progress, error, and completion.

2. Step 2: Verify progress calculation and completion message

   uploadTask.on('state_changed', snapshot => { const progress = (snapshot.bytesTransferred / snapshot.totalBytes) * 100; console.log(`Upload is ${progress}% done`); }, error => { console.error(error); }, () => { console.log('Upload complete!'); }); calculates progress and logs completion correctly; others miss callbacks or use wrong event.

3. Final Answer:

   uploadTask.on('state_changed', snapshot => { const progress = (snapshot.bytesTransferred / snapshot.totalBytes) * 100; console.log(`Upload is ${progress}% done`); }, error => { console.error(error); }, () => { console.log('Upload complete!'); }); -> Option C

4. Quick Check:

   Use three callbacks with 'state_changed' event [OK]

Hint: Use three callbacks with 'state_changed' for progress and completion [OK]

Common Mistakes:

• Using wrong event names like 'progress'
• Missing completion callback
• Logging completion inside progress callback