@firebase/storage 0.9.10 → 0.9.11-20221010190246

package/dist/node-esm/index.node.esm.js

@@ -42,7 +42,11 @@ const DEFAULT_MAX_OPERATION_RETRY_TIME = 2 * 60 * 1000;
  *
  * The timeout for upload.
  */
-const DEFAULT_MAX_UPLOAD_RETRY_TIME = 10 * 60 * 1000;
+const DEFAULT_MAX_UPLOAD_RETRY_TIME = 10 * 60 * 1000;
+/**
+ * 1 second
+ */
+const DEFAULT_MIN_SLEEP_TIME_MILLIS = 1000;
 
 /**
  * @license
@@ -69,9 +73,11 @@ class StorageError extends FirebaseError {
      * @param code - A StorageErrorCode string to be prefixed with 'storage/' and
      *  added to the end of the message.
      * @param message  - Error message.
+     * @param status_ - Corresponding HTTP Status Code
      */
-    constructor(code, message) {
+    constructor(code, message, status_ = 0) {
         super(prependCode(code), `Firebase Storage: ${message} (${prependCode(code)})`);
+        this.status_ = status_;
         /**
          * Stores custom error data unque to StorageError.
          */
@@ -81,6 +87,12 @@ class StorageError extends FirebaseError {
         // returns false.
         Object.setPrototypeOf(this, StorageError.prototype);
     }
+    get status() {
+        return this.status_;
+    }
+    set status(status) {
+        this.status_ = status;
+    }
     /**
      * Compares a StorageErrorCode against this error's code, filtering out the prefix.
      */
@@ -340,14 +352,20 @@ class FailRequest {
  * limitations under the License.
  */
 /**
- * @param f May be invoked
- *     before the function returns.
- * @param callback Get all the arguments passed to the function
- *     passed to f, including the initial boolean.
+ * Accepts a callback for an action to perform (`doRequest`),
+ * and then a callback for when the backoff has completed (`backoffCompleteCb`).
+ * The callback sent to start requires an argument to call (`onRequestComplete`).
+ * When `start` calls `doRequest`, it passes a callback for when the request has
+ * completed, `onRequestComplete`. Based on this, the backoff continues, with
+ * another call to `doRequest` and the above loop continues until the timeout
+ * is hit, or a successful response occurs.
+ * @description
+ * @param doRequest Callback to perform request
+ * @param backoffCompleteCb Callback to call when backoff has been completed
  */
-function start(f, 
+function start(doRequest, 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-callback, timeout) {
+backoffCompleteCb, timeout) {
     // TODO(andysoto): make this code cleaner (probably refactor into an actual
     // type instead of a bunch of functions with state shared in the closure)
     let waitSeconds = 1;
@@ -366,13 +384,13 @@ callback, timeout) {
     function triggerCallback(...args) {
         if (!triggeredCallback) {
             triggeredCallback = true;
-            callback.apply(null, args);
+            backoffCompleteCb.apply(null, args);
         }
     }
     function callWithDelay(millis) {
         retryTimeoutId = setTimeout(() => {
             retryTimeoutId = null;
-            f(handler, canceled());
+            doRequest(responseHandler, canceled());
         }, millis);
     }
     function clearGlobalTimeout() {
@@ -380,7 +398,7 @@ callback, timeout) {
             clearTimeout(globalTimeoutId);
         }
     }
-    function handler(success, ...args) {
+    function responseHandler(success, ...args) {
         if (triggeredCallback) {
             clearGlobalTimeout();
             return;
@@ -558,6 +576,43 @@ var ErrorCode;
     ErrorCode[ErrorCode["ABORT"] = 2] = "ABORT";
 })(ErrorCode || (ErrorCode = {}));
 
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Checks the status code to see if the action should be retried.
+ *
+ * @param status Current HTTP status code returned by server.
+ * @param additionalRetryCodes additional retry codes to check against
+ */
+function isRetryStatusCode(status, additionalRetryCodes) {
+    // The codes for which to retry came from this page:
+    // https://cloud.google.com/storage/docs/exponential-backoff
+    const isFiveHundredCode = status >= 500 && status < 600;
+    const extraRetryCodes = [
+        // Request Timeout: web server didn't receive full request in time.
+        408,
+        // Too Many Requests: you're getting rate-limited, basically.
+        429
+    ];
+    const isExtraRetryCode = extraRetryCodes.indexOf(status) !== -1;
+    const isAdditionalRetryCode = additionalRetryCodes.indexOf(status) !== -1;
+    return isFiveHundredCode || isExtraRetryCode || isAdditionalRetryCode;
+}
+
 /**
  * @license
  * Copyright 2017 Google LLC
@@ -583,7 +638,7 @@ var ErrorCode;
  * happens in the specified `callback_`.
  */
 class NetworkRequest {
-    constructor(url_, method_, headers_, body_, successCodes_, additionalRetryCodes_, callback_, errorCallback_, timeout_, progressCallback_, connectionFactory_) {
+    constructor(url_, method_, headers_, body_, successCodes_, additionalRetryCodes_, callback_, errorCallback_, timeout_, progressCallback_, connectionFactory_, retry = true) {
         this.url_ = url_;
         this.method_ = method_;
         this.headers_ = headers_;
@@ -595,6 +650,7 @@ class NetworkRequest {
         this.timeout_ = timeout_;
         this.progressCallback_ = progressCallback_;
         this.connectionFactory_ = connectionFactory_;
+        this.retry = retry;
         this.pendingConnection_ = null;
         this.backoffId_ = null;
         this.canceled_ = false;
@@ -618,9 +674,7 @@ class NetworkRequest {
             this.pendingConnection_ = connection;
             const progressListener = progressEvent => {
                 const loaded = progressEvent.loaded;
-                const total = progressEvent.lengthComputable
-                    ? progressEvent.total
-                    : -1;
+                const total = progressEvent.lengthComputable ? progressEvent.total : -1;
                 if (this.progressCallback_ !== null) {
                     this.progressCallback_(loaded, total);
                 }
@@ -639,7 +693,9 @@ class NetworkRequest {
                 this.pendingConnection_ = null;
                 const hitServer = connection.getErrorCode() === ErrorCode.NO_ERROR;
                 const status = connection.getStatus();
-                if (!hitServer || this.isRetryStatusCode_(status)) {
+                if ((!hitServer ||
+                    isRetryStatusCode(status, this.additionalRetryCodes_)) &&
+                    this.retry) {
                     const wasCanceled = connection.getErrorCode() === ErrorCode.ABORT;
                     backoffCallback(false, new RequestEndStatus(false, null, wasCanceled));
                     return;
@@ -715,20 +771,6 @@ class NetworkRequest {
             this.pendingConnection_.abort();
         }
     }
-    isRetryStatusCode_(status) {
-        // The codes for which to retry came from this page:
-        // https://cloud.google.com/storage/docs/exponential-backoff
-        const isFiveHundredCode = status >= 500 && status < 600;
-        const extraRetryCodes = [
-            // Request Timeout: web server didn't receive full request in time.
-            408,
-            // Too Many Requests: you're getting rate-limited, basically.
-            429
-        ];
-        const isExtraRetryCode = extraRetryCodes.indexOf(status) !== -1;
-        const isRequestSpecificRetryCode = this.additionalRetryCodes_.indexOf(status) !== -1;
-        return isFiveHundredCode || isExtraRetryCode || isRequestSpecificRetryCode;
-    }
 }
 /**
  * A collection of information about the result of a network request.
@@ -760,7 +802,7 @@ function addAppCheckHeader_(headers, appCheckToken) {
         headers['X-Firebase-AppCheck'] = appCheckToken;
     }
 }
-function makeRequest(requestInfo, appId, authToken, appCheckToken, requestFactory, firebaseVersion) {
+function makeRequest(requestInfo, appId, authToken, appCheckToken, requestFactory, firebaseVersion, retry = true) {
     const queryPart = makeQueryString(requestInfo.urlParams);
     const url = requestInfo.url + queryPart;
     const headers = Object.assign({}, requestInfo.headers);
@@ -768,7 +810,7 @@ function makeRequest(requestInfo, appId, authToken, appCheckToken, requestFactor
     addAuthHeader_(headers, authToken);
     addVersionHeader_(headers, firebaseVersion);
     addAppCheckHeader_(headers, appCheckToken);
-    return new NetworkRequest(url, requestInfo.method, headers, requestInfo.body, requestInfo.successCodes, requestInfo.additionalRetryCodes, requestInfo.handler, requestInfo.errorHandler, requestInfo.timeout, requestInfo.progressCallback, requestFactory);
+    return new NetworkRequest(url, requestInfo.method, headers, requestInfo.body, requestInfo.successCodes, requestInfo.additionalRetryCodes, requestInfo.handler, requestInfo.errorHandler, requestInfo.timeout, requestInfo.progressCallback, requestFactory, retry);
 }
 
 /**
@@ -1590,6 +1632,7 @@ function sharedErrorHandler(location) {
                 }
             }
         }
+        newErr.status = xhr.getStatus();
         newErr.serverResponse = err.serverResponse;
         return newErr;
     }
@@ -1874,7 +1917,16 @@ function continueResumableUpload(location, service, url, blob, chunkSize, mappin
     }
     const startByte = status_.current;
     const endByte = startByte + bytesToUpload;
-    const uploadCommand = bytesToUpload === bytesLeft ? 'upload, finalize' : 'upload';
+    let uploadCommand = '';
+    if (bytesToUpload === 0) {
+        uploadCommand = 'finalize';
+    }
+    else if (bytesLeft === bytesToUpload) {
+        uploadCommand = 'upload, finalize';
+    }
+    else {
+        uploadCommand = 'upload';
+    }
     const headers = {
         'X-Goog-Upload-Command': uploadCommand,
         'X-Goog-Upload-Offset': `${status_.current}`
@@ -2249,6 +2301,18 @@ class UploadTask {
                 this.completeTransitions_();
             }
             else {
+                const backoffExpired = this.isExponentialBackoffExpired();
+                if (isRetryStatusCode(error.status, [])) {
+                    if (backoffExpired) {
+                        error = retryLimitExceeded();
+                    }
+                    else {
+                        this.sleepTime = Math.max(this.sleepTime * 2, DEFAULT_MIN_SLEEP_TIME_MILLIS);
+                        this._needToFetchStatus = true;
+                        this.completeTransitions_();
+                        return;
+                    }
+                }
                 this._error = error;
                 this._transition("error" /* ERROR */);
             }
@@ -2263,6 +2327,8 @@ class UploadTask {
                 this._transition("error" /* ERROR */);
             }
         };
+        this.sleepTime = 0;
+        this.maxSleepTime = this._ref.storage.maxUploadRetryTime;
         this._promise = new Promise((resolve, reject) => {
             this._resolve = resolve;
             this._reject = reject;
@@ -2272,6 +2338,9 @@ class UploadTask {
         // to the top level with a dummy handler.
         this._promise.then(null, () => { });
     }
+    isExponentialBackoffExpired() {
+        return this.sleepTime > this.maxSleepTime;
+    }
     _makeProgressCallback() {
         const sizeBefore = this._transferred;
         return loaded => this._updateProgress(sizeBefore + loaded);
@@ -2301,7 +2370,9 @@ class UploadTask {
                         this._fetchMetadata();
                     }
                     else {
-                        this._continueUpload();
+                        setTimeout(() => {
+                            this._continueUpload();
+                        }, this.sleepTime);
                     }
                 }
             }
@@ -2377,7 +2448,9 @@ class UploadTask {
                 this._transition("error" /* ERROR */);
                 return;
             }
-            const uploadRequest = this._ref.storage._makeRequest(requestInfo, newTextConnection, authToken, appCheckToken);
+            const uploadRequest = this._ref.storage._makeRequest(requestInfo, newTextConnection, authToken, appCheckToken, 
+            /*retry=*/ false // Upload requests should not be retried as each retry should be preceded by another query request. Which is handled in this file.
+            );
             this._request = uploadRequest;
             uploadRequest.getPromise().then((newStatus) => {
                 this._increaseMultiplier();
@@ -2396,7 +2469,7 @@ class UploadTask {
     _increaseMultiplier() {
         const currentSize = RESUMABLE_UPLOAD_CHUNK_SIZE * this._chunkMultiplier;
         // Max chunk size is 32M.
-        if (currentSize < 32 * 1024 * 1024) {
+        if (currentSize * 2 < 32 * 1024 * 1024) {
             this._chunkMultiplier *= 2;
         }
     }
@@ -2545,6 +2618,7 @@ class UploadTask {
      *     callbacks.
      */
     on(type, nextOrObserver, error, completed) {
+        // Note: `type` isn't being used. Its type is also incorrect. TaskEvent should not be a string.
         const observer = new Observer(nextOrObserver || undefined, error || undefined, completed || undefined);
         this._addObserver(observer);
         return () => {
@@ -3247,9 +3321,9 @@ class FirebaseStorageImpl {
      * @param requestInfo - HTTP RequestInfo object
      * @param authToken - Firebase auth token
      */
-    _makeRequest(requestInfo, requestFactory, authToken, appCheckToken) {
+    _makeRequest(requestInfo, requestFactory, authToken, appCheckToken, retry = true) {
         if (!this._deleted) {
-            const request = makeRequest(requestInfo, this._appId, authToken, appCheckToken, requestFactory, this._firebaseVersion);
+            const request = makeRequest(requestInfo, this._appId, authToken, appCheckToken, requestFactory, this._firebaseVersion, retry);
             this._requests.add(request);
             // Request removes itself from set when complete.
             request.getPromise().then(() => this._requests.delete(request), () => this._requests.delete(request));
@@ -3269,7 +3343,7 @@ class FirebaseStorageImpl {
 }
 
 const name = "@firebase/storage";
-const version = "0.9.10";
+const version = "0.9.11-20221010190246";
 
 /**
  * @license