Skip to content

Commit e9ab7fd

Browse files
maneeshtmaneesht
authored
Merge f7dd97d into f8ddadb 
2 parents f8ddadb + f7dd97d commit e9ab7fd

File tree

8 files changed

+182
-35
lines changed

8 files changed

+182
-35
lines changed

‎.changeset/hungry-glasses-impress.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
"firebase": minor
3+
"@firebase/storage": minor
4+
"@firebase/storage-types": minor
5+
"@firebase/storage-compat": minor
6+
---
7+
8+
Fixed issue where users were unable to check if an Error was an instance of `StorageError`.

‎common/api-review/storage.api.md

Lines changed: 70 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -134,13 +134,11 @@ export function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStora
134134
// @public
135135
export function getStream(ref: StorageReference, maxDownloadSizeBytes?: number): NodeJS.ReadableStream;
136136

137-
// Warning: (ae-forgotten-export) The symbol "StorageError" needs to be exported by the entry point index.d.ts
138-
//
139137
// @internal (undocumented)
140-
export function _invalidArgument(message: string): StorageError_2;
138+
export function _invalidArgument(message: string): StorageError;
141139

142140
// @internal (undocumented)
143-
export function _invalidRootOperation(name: string): StorageError_2;
141+
export function _invalidRootOperation(name: string): StorageError;
144142

145143
// @public
146144
export function list(ref: StorageReference, options?: ListOptions): Promise<ListResult>;
@@ -217,8 +215,71 @@ export interface SettableMetadata {
217215
}
218216

219217
// @public
220-
export interface StorageError extends FirebaseError {
221-
serverResponse: string | null;
218+
export class StorageError extends FirebaseError {
219+
constructor(code: StorageErrorCode, message: string, status_?: number);
220+
_codeEquals(code: StorageErrorCode): boolean;
221+
customData: {
222+
serverResponse: string | null;
223+
};
224+
get serverResponse(): null | string;
225+
set serverResponse(serverResponse: string | null);
226+
// (undocumented)
227+
get status(): number;
228+
set status(status: number);
229+
}
230+
231+
// @public
232+
export enum StorageErrorCode {
233+
// (undocumented)
234+
APP_DELETED = "app-deleted",
235+
// (undocumented)
236+
BUCKET_NOT_FOUND = "bucket-not-found",
237+
// (undocumented)
238+
CANCELED = "canceled",
239+
// (undocumented)
240+
CANNOT_SLICE_BLOB = "cannot-slice-blob",
241+
// (undocumented)
242+
INTERNAL_ERROR = "internal-error",
243+
// (undocumented)
244+
INVALID_ARGUMENT = "invalid-argument",
245+
// (undocumented)
246+
INVALID_ARGUMENT_COUNT = "invalid-argument-count",
247+
// (undocumented)
248+
INVALID_CHECKSUM = "invalid-checksum",
249+
// (undocumented)
250+
INVALID_DEFAULT_BUCKET = "invalid-default-bucket",
251+
// (undocumented)
252+
INVALID_EVENT_NAME = "invalid-event-name",
253+
// (undocumented)
254+
INVALID_FORMAT = "invalid-format",
255+
// (undocumented)
256+
INVALID_ROOT_OPERATION = "invalid-root-operation",
257+
// (undocumented)
258+
INVALID_URL = "invalid-url",
259+
// (undocumented)
260+
NO_DEFAULT_BUCKET = "no-default-bucket",
261+
// (undocumented)
262+
NO_DOWNLOAD_URL = "no-download-url",
263+
// (undocumented)
264+
OBJECT_NOT_FOUND = "object-not-found",
265+
// (undocumented)
266+
PROJECT_NOT_FOUND = "project-not-found",
267+
// (undocumented)
268+
QUOTA_EXCEEDED = "quota-exceeded",
269+
// (undocumented)
270+
RETRY_LIMIT_EXCEEDED = "retry-limit-exceeded",
271+
// (undocumented)
272+
SERVER_FILE_WRONG_SIZE = "server-file-wrong-size",
273+
// (undocumented)
274+
UNAUTHENTICATED = "unauthenticated",
275+
// (undocumented)
276+
UNAUTHORIZED = "unauthorized",
277+
// (undocumented)
278+
UNAUTHORIZED_APP = "unauthorized-app",
279+
// (undocumented)
280+
UNKNOWN = "unknown",
281+
// (undocumented)
282+
UNSUPPORTED_ENVIRONMENT = "unsupported-environment"
222283
}
223284

224285
// @public
@@ -318,20 +379,20 @@ export class _UploadTask {
318379
constructor(ref: _Reference, blob: _FbsBlob, metadata?: Metadata | null);
319380
_blob: _FbsBlob;
320381
cancel(): boolean;
321-
catch<T>(onRejected: (p1: StorageError_2) => T | Promise<T>): Promise<T>;
382+
catch<T>(onRejected: (p1: StorageError) => T | Promise<T>): Promise<T>;
322383
// (undocumented)
323384
isExponentialBackoffExpired(): boolean;
324385
// Warning: (ae-forgotten-export) The symbol "Metadata" needs to be exported by the entry point index.d.ts
325386
_metadata: Metadata | null;
326387
// Warning: (ae-forgotten-export) The symbol "Unsubscribe" needs to be exported by the entry point index.d.ts
327388
// Warning: (ae-forgotten-export) The symbol "Subscribe" needs to be exported by the entry point index.d.ts
328-
on(type: _TaskEvent, nextOrObserver?: StorageObserver<UploadTaskSnapshot> | null | ((snapshot: UploadTaskSnapshot) => unknown), error?: ((a: StorageError_2) => unknown) | null, completed?: CompleteFn | null): Unsubscribe_2 | Subscribe_2<UploadTaskSnapshot>;
389+
on(type: _TaskEvent, nextOrObserver?: StorageObserver<UploadTaskSnapshot> | null | ((snapshot: UploadTaskSnapshot) => unknown), error?: ((a: StorageError) => unknown) | null, completed?: CompleteFn | null): Unsubscribe_2 | Subscribe_2<UploadTaskSnapshot>;
329390
pause(): boolean;
330391
resume(): boolean;
331392
get snapshot(): UploadTaskSnapshot;
332393
// Warning: (ae-forgotten-export) The symbol "InternalTaskState" needs to be exported by the entry point index.d.ts
333394
_state: InternalTaskState;
334-
then<U>(onFulfilled?: ((value: UploadTaskSnapshot) => U | Promise<U>) | null, onRejected?: ((error: StorageError_2) => U | Promise<U>) | null): Promise<U>;
395+
then<U>(onFulfilled?: ((value: UploadTaskSnapshot) => U | Promise<U>) | null, onRejected?: ((error: StorageError) => U | Promise<U>) | null): Promise<U>;
335396
_transferred: number;
336397
}
337398

‎packages/firebase/compat/index.d.ts

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8017,11 +8017,59 @@ declare namespace firebase.storage {
80178017
md5Hash?: string | null;
80188018
}
80198019

8020+
/**
8021+
* Error codes that can be attached to `StorageError`s.
8022+
*/
8023+
export enum StorageErrorCode {
8024+
UNKNOWN = 'unknown',
8025+
OBJECT_NOT_FOUND = 'object-not-found',
8026+
BUCKET_NOT_FOUND = 'bucket-not-found',
8027+
PROJECT_NOT_FOUND = 'project-not-found',
8028+
QUOTA_EXCEEDED = 'quota-exceeded',
8029+
UNAUTHENTICATED = 'unauthenticated',
8030+
UNAUTHORIZED = 'unauthorized',
8031+
UNAUTHORIZED_APP = 'unauthorized-app',
8032+
RETRY_LIMIT_EXCEEDED = 'retry-limit-exceeded',
8033+
INVALID_CHECKSUM = 'invalid-checksum',
8034+
CANCELED = 'canceled',
8035+
INVALID_EVENT_NAME = 'invalid-event-name',
8036+
INVALID_URL = 'invalid-url',
8037+
INVALID_DEFAULT_BUCKET = 'invalid-default-bucket',
8038+
NO_DEFAULT_BUCKET = 'no-default-bucket',
8039+
CANNOT_SLICE_BLOB = 'cannot-slice-blob',
8040+
SERVER_FILE_WRONG_SIZE = 'server-file-wrong-size',
8041+
NO_DOWNLOAD_URL = 'no-download-url',
8042+
INVALID_ARGUMENT = 'invalid-argument',
8043+
INVALID_ARGUMENT_COUNT = 'invalid-argument-count',
8044+
APP_DELETED = 'app-deleted',
8045+
INVALID_ROOT_OPERATION = 'invalid-root-operation',
8046+
INVALID_FORMAT = 'invalid-format',
8047+
INTERNAL_ERROR = 'internal-error',
8048+
UNSUPPORTED_ENVIRONMENT = 'unsupported-environment'
8049+
}
8050+
80208051
/**
80218052
* An error returned by the Firebase Storage SDK.
80228053
*/
8023-
interface FirebaseStorageError extends FirebaseError {
8024-
serverResponse: string | null;
8054+
export interface FirebaseStorageError extends FirebaseError {
8055+
/**
8056+
* Stores custom error data unque to StorageError.
8057+
*/
8058+
customData: {
8059+
serverResponse: string | null;
8060+
};
8061+
8062+
get status(): number;
8063+
set status(status: number);
8064+
/**
8065+
* Compares a StorageErrorCode against this error's code, filtering out the prefix.
8066+
*/
8067+
_codeEquals(code: StorageErrorCode): boolean;
8068+
/**
8069+
* Optional response message that was added by the server.
8070+
*/
8071+
get serverResponse(): null | string;
8072+
set serverResponse(serverResponse: string | null);
80258073
}
80268074

80278075
interface StorageObserver<T> {

‎packages/storage-compat/src/task.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ export class UploadTaskCompat implements types.UploadTask, Compat<UploadTask> {
6565
| types.StorageObserver<UploadTaskSnapshotCompat>
6666
| null
6767
| ((a: UploadTaskSnapshotCompat) => unknown),
68-
error?: (error: StorageError) => void | null,
68+
error?: ((error: StorageError) => void) | null,
6969
completed?: () => void | null
7070
): Unsubscribe | Subscribe<UploadTaskSnapshotCompat> {
7171
let wrappedNextOrObserver:

‎packages/storage-types/index.d.ts

Lines changed: 48 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,16 +91,60 @@ export interface UploadMetadata extends SettableMetadata {
9191
md5Hash?: string | null;
9292
}
9393

94-
interface FirebaseStorageError extends FirebaseError {
95-
serverResponse: string | null;
96-
}
97-
9894
export interface StorageObserver<T> {
9995
next?: NextFn<T> | null;
10096
error?: (error: FirebaseStorageError) => void | null;
10197
complete?: CompleteFn | null;
10298
}
10399

100+
export enum StorageErrorCode {
101+
UNKNOWN = 'unknown',
102+
OBJECT_NOT_FOUND = 'object-not-found',
103+
BUCKET_NOT_FOUND = 'bucket-not-found',
104+
PROJECT_NOT_FOUND = 'project-not-found',
105+
QUOTA_EXCEEDED = 'quota-exceeded',
106+
UNAUTHENTICATED = 'unauthenticated',
107+
UNAUTHORIZED = 'unauthorized',
108+
UNAUTHORIZED_APP = 'unauthorized-app',
109+
RETRY_LIMIT_EXCEEDED = 'retry-limit-exceeded',
110+
INVALID_CHECKSUM = 'invalid-checksum',
111+
CANCELED = 'canceled',
112+
INVALID_EVENT_NAME = 'invalid-event-name',
113+
INVALID_URL = 'invalid-url',
114+
INVALID_DEFAULT_BUCKET = 'invalid-default-bucket',
115+
NO_DEFAULT_BUCKET = 'no-default-bucket',
116+
CANNOT_SLICE_BLOB = 'cannot-slice-blob',
117+
SERVER_FILE_WRONG_SIZE = 'server-file-wrong-size',
118+
NO_DOWNLOAD_URL = 'no-download-url',
119+
INVALID_ARGUMENT = 'invalid-argument',
120+
INVALID_ARGUMENT_COUNT = 'invalid-argument-count',
121+
APP_DELETED = 'app-deleted',
122+
INVALID_ROOT_OPERATION = 'invalid-root-operation',
123+
INVALID_FORMAT = 'invalid-format',
124+
INTERNAL_ERROR = 'internal-error',
125+
UNSUPPORTED_ENVIRONMENT = 'unsupported-environment'
126+
}
127+
128+
export interface FirebaseStorageError extends FirebaseError {
129+
/**
130+
* Stores custom error data unque to StorageError.
131+
*/
132+
customData: {
133+
serverResponse: string | null;
134+
};
135+
136+
get status(): number;
137+
set status(status: number);
138+
/**
139+
* Compares a StorageErrorCode against this error's code, filtering out the prefix.
140+
*/
141+
_codeEquals(code: StorageErrorCode): boolean;
142+
/**
143+
* Optional response message that was added by the server.
144+
*/
145+
get serverResponse(): null | string;
146+
set serverResponse(serverResponse: string | null);
147+
}
104148
export interface UploadTask {
105149
cancel(): boolean;
106150
catch(onRejected: (error: FirebaseStorageError) => any): Promise<any>;

‎packages/storage/src/api.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ import { StringFormat } from './implementation/string';
5959

6060
export { EmulatorMockTokenOptions } from '@firebase/util';
6161

62+
export { StorageError, StorageErrorCode } from './implementation/error';
63+
6264
/**
6365
* Public types.
6466
*/

‎packages/storage/src/implementation/error.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ export const errors = {};
8585
* @public
8686
* Error codes that can be attached to `StorageError`s.
8787
*/
88-
export const enum StorageErrorCode {
88+
export enum StorageErrorCode {
8989
// Shared between all platforms
9090
UNKNOWN = 'unknown',
9191
OBJECT_NOT_FOUND = 'object-not-found',

‎packages/storage/src/public-types.ts

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,8 @@
1717

1818
// eslint-disable-next-line import/no-extraneous-dependencies
1919
import { FirebaseApp, _FirebaseService } from '@firebase/app';
20-
import {
21-
CompleteFn,
22-
FirebaseError,
23-
NextFn,
24-
Subscribe,
25-
Unsubscribe
26-
} from '@firebase/util';
20+
import { CompleteFn, NextFn, Subscribe, Unsubscribe } from '@firebase/util';
21+
import { StorageError } from './implementation/error';
2722

2823
/**
2924
* A Firebase Storage instance.
@@ -249,17 +244,6 @@ export type TaskEvent = 'state_changed';
249244
*/
250245
export type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error';
251246

252-
/**
253-
* An error returned by the Firebase Storage SDK.
254-
* @public
255-
*/
256-
export interface StorageError extends FirebaseError {
257-
/**
258-
* A server response message for the error, if applicable.
259-
*/
260-
serverResponse: string | null;
261-
}
262-
263247
/**
264248
* A stream observer for Firebase Storage.
265249
* @public

0 commit comments

Comments
 (0)