firebase/flutterfire

[馃摎] Firebase Storage exceptions / error handling

Open

#7,474 opened on Dec 6, 2021

View on GitHub
聽(4 comments)聽(0 reactions)聽(0 assignees)Dart聽(9,199 stars)聽(4,097 forks)batch import
Needs Attentiongood first issueplatform: allplugin: storagetype: documentation

Description

I would like to be able to catch and respond according to specific errors from firebase_storage in my Flutter app.

Here is what i would like to do:

UploadTask task = FirebaseStorage.instance.reference().putFile("filePath");
task.catchError((FirebaseStorageException exception) {
  switch (exception.state) {
    case FirebaseStorageExceptionState.unknown:
       break;
    case FirebaseStorageExceptionState.canceled:
       break;
    ...
  }
})

For now i saw only 1 line in the documentation :

Future<void> uploadFile(String filePath) async {
  File file = File(filePath);

  try {
    await firebase_storage.FirebaseStorage.instance
        .ref('uploads/file-to-upload.png')
        .putFile(file);
  } on firebase_core.FirebaseException catch (e) {
    // e.g, e.code == 'canceled'
  }
}

Saying e.code == 'canceled'. Fine, but what are the others String we should catch as code please ?

I think all of the error codes should be added, or an enum describing the error state would also be great if possible.

Contributor guide

Tech stack
dartflutterfirebase
Domain
backendapideveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Dart programmingFirebase Storage basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue requests adding a FirebaseStorageException enum with specific error states (like canceled, unknown). The implementer should look at the existing FlutterFire plugin codebase, specifically the firebase storage package, to see how other Firebase exceptions (e.g., FirebaseAuthException) are structured. Similar enums exist for other Firebase services. The goal is to create an enum or expose error codes matching the underlying platform SDKs. Check the Firebase iOS and Android Storage SDKs for the list of error codes. Update the Dart API and documentation accordingly.