firebase/flutterfire

[馃摎]Holistically document all throwed exception codes.

Open

#6,326 opened on Jun 6, 2021

View on GitHub
聽(9 comments)聽(10 reactions)聽(0 assignees)Dart聽(9,199 stars)聽(4,097 forks)batch import
good first issueplatform: allplugin: authplugin: functionstype: documentation

Description

Use case

I use FirebaseFunctions and FirebaseAuth. I want to catch FirebaseException and show AlertDialog with special localized alert message, depending on what code is provided.

Problem

I can't find complete exception code list. firebase_auth.dart has scant lists before methods, but firebase_functions.dart hasn't them at all. FlutterFire Docs mentions about only few individual codes. Firebase has something looks like i want, but for Admin SDK (https://firebase.google.com/docs/auth/admin/errors). Is there the a similar list for FlutterFire?

Proposal

Holistically document all throwed exception codes.

Contributor guide

Tech stack
flutter
Domain
documentation
Issue type
documentation
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.
1-2 days
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
FlutterFirebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue requests a comprehensive list of all exception codes thrown by FirebaseAuth and FirebaseFunctions in FlutterFire. Start by scanning the source files firebase auth.dart and firebase functions.dart for all `throw FirebaseException(...)` calls. Collect each unique `code` parameter. Also review any existing documentation in the repository and reference the Firebase Admin SDK error codes page for structure. The deliverable is a markdown file or updated docstrings listing all codes with descriptions.