Skip to content

feat(core): Error Handling Revamp #3102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonathanedey merged 18 commits into from
Apr 29, 2026
Merged

feat(core): Error Handling Revamp #3102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
18fadbd
Initial exports and external api changes
jonathanedey Mar 4, 2026
2158268
Connect response to error info
jonathanedey Mar 5, 2026
930120e
feat: Revamp error handling to include `httpResponse` and `cause` in …
jonathanedey Mar 16, 2026
aa72cee
more refactoring
jonathanedey Mar 17, 2026
d7b67a6
refactor: Update all services to use ErrorInfo format
jonathanedey Mar 26, 2026
2dbe1c6
refactor: Update unit tests to verify error cause and httpResponse po…
jonathanedey Mar 27, 2026
81531c5
chore: fix lint
jonathanedey Mar 27, 2026
afcb54c
chore: remove debug tests
jonathanedey Mar 27, 2026
e92c4e0
fix: Ran api documentor and fix some export errors
jonathanedey Mar 30, 2026
3e44067
fix: Removed outdated `__proto__` workaround and updated api doc strings
jonathanedey Mar 31, 2026
8457e85
chore: Fix lint
jonathanedey Apr 8, 2026
9e0fd4f
fix: Used a helper function to map `RequestResponse` to `HttpResponse`
jonathanedey Apr 9, 2026
1249539
fix: Removed last of the stringified response bodies in response mess…
jonathanedey Apr 13, 2026
6c74e52
chore: Fix lint
jonathanedey Apr 13, 2026
892471a
chore: Generate apidocs
jonathanedey Apr 13, 2026
04ef02e
Merge branch 'error-revamp' into je-error-re
jonathanedey Apr 15, 2026
3d35bd6
fix: Apply revamp changes to pnv
jonathanedey Apr 15, 2026
3d38b0b
chore: Added review suggestions
jonathanedey Apr 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions etc/firebase-admin.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,14 @@ export namespace database {
const ServerValue: rtdb.ServerValue;
}

// @public
export interface ErrorInfo {
cause?: Error;
code: string;
httpResponse?: HttpResponse;
message: string;
}

// @public
export interface FirebaseArrayIndexError {
error: FirebaseError;
Expand All @@ -228,12 +236,19 @@ export interface FirebaseArrayIndexError {

// @public
export interface FirebaseError {
cause?: Error;
code: string;
httpResponse?: HttpResponse;
message: string;
stack?: string;
toJSON(): object;
}

// @public
export class FirebaseError extends Error implements FirebaseError {
constructor(errorInfo: ErrorInfo);
}

// @public (undocumented)
export function firestore(app?: App): _firestore.Firestore;

Expand Down Expand Up @@ -299,6 +314,15 @@ export interface GoogleOAuthAccessToken {
expires_in: number;
}

// @public
export interface HttpResponse {
data?: string | object;
headers: {
[key: string]: any;
};
status: number;
}

// @public (undocumented)
export function initializeApp(options?: AppOptions, name?: string): app.App;

Expand Down
11 changes: 11 additions & 0 deletions etc/firebase-admin.app-check.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ export class AppCheck {
verifyToken(appCheckToken: string, options?: VerifyAppCheckTokenOptions): Promise<VerifyAppCheckTokenResponse>;
}

// @public
export type AppCheckErrorCode = 'aborted' | 'invalid-argument' | 'invalid-credential' | 'internal-error' | 'permission-denied' | 'unauthenticated' | 'not-found' | 'app-check-token-expired' | 'unknown-error';

// @public
export interface AppCheckToken {
token: string;
Expand All @@ -39,6 +42,14 @@ export interface DecodedAppCheckToken {
sub: string;
}

// Warning: (ae-forgotten-export) The symbol "PrefixedFirebaseError" needs to be exported by the entry point index.d.ts
//
Copy link
Copy Markdown
Member

@lahirumaramba lahirumaramba Apr 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this something we can address (for both PrefixedFirebaseError and ErrorInfo? I think it is okay to ignore this but I am just double checking :)

Copy link
Copy Markdown
Collaborator Author

@jonathanedey jonathanedey Apr 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For ErrorInfo it's the same scenario we have for App. Where even though we export it commonly, api documenter wants it to be exported again from other paths where it is used in the definition. So i don't think we have good options other than exposing it from multiple paths.

For PrefixedFirebaseError this is technically internal logic and not exposed at all even though it's a middle step between FirebaseError and the service specific errors. Not sure if there is a way to exclude it from the docs.

// @public
export class FirebaseAppCheckError extends PrefixedFirebaseError {
// Warning: (ae-forgotten-export) The symbol "ErrorInfo" needs to be exported by the entry point index.d.ts
constructor(info: ErrorInfo, message?: string);
}

// @public
export function getAppCheck(app?: App): AppCheck;

Expand Down
25 changes: 25 additions & 0 deletions etc/firebase-admin.app.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,19 @@ export interface Credential {
// @public
export function deleteApp(app: App): Promise<void>;

// @public
export interface ErrorInfo {
cause?: Error;
code: string;
httpResponse?: HttpResponse;
message: string;
}

// Warning: (ae-forgotten-export) The symbol "PrefixedFirebaseError" needs to be exported by the entry point index.d.ts
//
// @public
export class FirebaseAppError extends PrefixedFirebaseError {
constructor(info: ErrorInfo, message?: string);
}

// @public
Expand All @@ -77,12 +86,19 @@ export interface FirebaseArrayIndexError {

// @public
export interface FirebaseError {
cause?: Error;
code: string;
httpResponse?: HttpResponse;
message: string;
stack?: string;
toJSON(): object;
}

// @public
export class FirebaseError extends Error implements FirebaseError {
constructor(errorInfo: ErrorInfo);
}

// @public
export function getApp(appName?: string): App;

Expand All @@ -97,6 +113,15 @@ export interface GoogleOAuthAccessToken {
expires_in: number;
}

// @public
export interface HttpResponse {
data?: string | object;
headers: {
[key: string]: any;
};
status: number;
}

// @public
export function initializeApp(options?: AppOptions, appName?: string): App;

Expand Down
Loading
Loading