@firebase/storage 0.9.10 → 0.9.11-20221010190246

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 #Unreleased
 
+## 0.9.11-20221010190246
+
+### Patch Changes
+
+- [`4eb8145fb`](https://github.com/firebase/firebase-js-sdk/commit/4eb8145fb3b503884ea610e813be359127d1a705) [#6653](https://github.com/firebase/firebase-js-sdk/pull/6653) - Fixed bug where upload status wasn't being checked after an upload failure.
+  Implemented exponential backoff and max retry strategy.
+- Updated dependencies [[`29d034072`](https://github.com/firebase/firebase-js-sdk/commit/29d034072c20af394ce384e42aa10a37d5dfcb18)]:
+  - @firebase/util@1.7.1-20221010190246
+  - @firebase/app@0.8.1-20221010190246
+  - @firebase/component@0.5.19-20221010190246
+
 ## 0.9.10
 
 ### Patch Changes

package/dist/index.browser.cjs.js

@@ -45,7 +45,11 @@ var DEFAULT_MAX_OPERATION_RETRY_TIME = 2 * 60 * 1000;
  *
  * The timeout for upload.
  */
-var DEFAULT_MAX_UPLOAD_RETRY_TIME = 10 * 60 * 1000;
+var DEFAULT_MAX_UPLOAD_RETRY_TIME = 10 * 60 * 1000;
+/**
+ * 1 second
+ */
+var DEFAULT_MIN_SLEEP_TIME_MILLIS = 1000;
 
 /**
  * @license
@@ -73,9 +77,12 @@ var StorageError = /** @class */ (function (_super) {
      * @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
      */
-    function StorageError(code, message) {
+    function StorageError(code, message, status_) {
+        if (status_ === void 0) { status_ = 0; }
         var _this = _super.call(this, prependCode(code), "Firebase Storage: " + message + " (" + prependCode(code) + ")") || this;
+        _this.status_ = status_;
         /**
          * Stores custom error data unque to StorageError.
          */
@@ -86,6 +93,16 @@ var StorageError = /** @class */ (function (_super) {
         Object.setPrototypeOf(_this, StorageError.prototype);
         return _this;
     }
+    Object.defineProperty(StorageError.prototype, "status", {
+        get: function () {
+            return this.status_;
+        },
+        set: function (status) {
+            this.status_ = status;
+        },
+        enumerable: false,
+        configurable: true
+    });
     /**
      * Compares a StorageErrorCode against this error's code, filtering out the prefix.
      */
@@ -361,14 +378,20 @@ var FailRequest = /** @class */ (function () {
  * 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)
     var waitSeconds = 1;
@@ -391,13 +414,13 @@ callback, timeout) {
         }
         if (!triggeredCallback) {
             triggeredCallback = true;
-            callback.apply(null, args);
+            backoffCompleteCb.apply(null, args);
         }
     }
     function callWithDelay(millis) {
         retryTimeoutId = setTimeout(function () {
             retryTimeoutId = null;
-            f(handler, canceled());
+            doRequest(responseHandler, canceled());
         }, millis);
     }
     function clearGlobalTimeout() {
@@ -405,7 +428,7 @@ callback, timeout) {
             clearTimeout(globalTimeoutId);
         }
     }
-    function handler(success) {
+    function responseHandler(success) {
         var args = [];
         for (var _i = 1; _i < arguments.length; _i++) {
             args[_i - 1] = arguments[_i];
@@ -587,6 +610,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
+    var isFiveHundredCode = status >= 500 && status < 600;
+    var extraRetryCodes = [
+        // Request Timeout: web server didn't receive full request in time.
+        408,
+        // Too Many Requests: you're getting rate-limited, basically.
+        429
+    ];
+    var isExtraRetryCode = extraRetryCodes.indexOf(status) !== -1;
+    var isAdditionalRetryCode = additionalRetryCodes.indexOf(status) !== -1;
+    return isFiveHundredCode || isExtraRetryCode || isAdditionalRetryCode;
+}
+
 /**
  * @license
  * Copyright 2017 Google LLC
@@ -612,8 +672,9 @@ var ErrorCode;
  * happens in the specified `callback_`.
  */
 var NetworkRequest = /** @class */ (function () {
-    function NetworkRequest(url_, method_, headers_, body_, successCodes_, additionalRetryCodes_, callback_, errorCallback_, timeout_, progressCallback_, connectionFactory_) {
+    function NetworkRequest(url_, method_, headers_, body_, successCodes_, additionalRetryCodes_, callback_, errorCallback_, timeout_, progressCallback_, connectionFactory_, retry) {
         var _this = this;
+        if (retry === void 0) { retry = true; }
         this.url_ = url_;
         this.method_ = method_;
         this.headers_ = headers_;
@@ -625,6 +686,7 @@ var NetworkRequest = /** @class */ (function () {
         this.timeout_ = timeout_;
         this.progressCallback_ = progressCallback_;
         this.connectionFactory_ = connectionFactory_;
+        this.retry = retry;
         this.pendingConnection_ = null;
         this.backoffId_ = null;
         this.canceled_ = false;
@@ -649,9 +711,7 @@ var NetworkRequest = /** @class */ (function () {
             _this.pendingConnection_ = connection;
             var progressListener = function (progressEvent) {
                 var loaded = progressEvent.loaded;
-                var total = progressEvent.lengthComputable
-                    ? progressEvent.total
-                    : -1;
+                var total = progressEvent.lengthComputable ? progressEvent.total : -1;
                 if (_this.progressCallback_ !== null) {
                     _this.progressCallback_(loaded, total);
                 }
@@ -670,7 +730,9 @@ var NetworkRequest = /** @class */ (function () {
                 _this.pendingConnection_ = null;
                 var hitServer = connection.getErrorCode() === ErrorCode.NO_ERROR;
                 var status = connection.getStatus();
-                if (!hitServer || _this.isRetryStatusCode_(status)) {
+                if ((!hitServer ||
+                    isRetryStatusCode(status, _this.additionalRetryCodes_)) &&
+                    _this.retry) {
                     var wasCanceled = connection.getErrorCode() === ErrorCode.ABORT;
                     backoffCallback(false, new RequestEndStatus(false, null, wasCanceled));
                     return;
@@ -746,20 +808,6 @@ var NetworkRequest = /** @class */ (function () {
             this.pendingConnection_.abort();
         }
     };
-    NetworkRequest.prototype.isRetryStatusCode_ = function (status) {
-        // The codes for which to retry came from this page:
-        // https://cloud.google.com/storage/docs/exponential-backoff
-        var isFiveHundredCode = status >= 500 && status < 600;
-        var extraRetryCodes = [
-            // Request Timeout: web server didn't receive full request in time.
-            408,
-            // Too Many Requests: you're getting rate-limited, basically.
-            429
-        ];
-        var isExtraRetryCode = extraRetryCodes.indexOf(status) !== -1;
-        var isRequestSpecificRetryCode = this.additionalRetryCodes_.indexOf(status) !== -1;
-        return isFiveHundredCode || isExtraRetryCode || isRequestSpecificRetryCode;
-    };
     return NetworkRequest;
 }());
 /**
@@ -793,7 +841,8 @@ 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) {
+    if (retry === void 0) { retry = true; }
     var queryPart = makeQueryString(requestInfo.urlParams);
     var url = requestInfo.url + queryPart;
     var headers = Object.assign({}, requestInfo.headers);
@@ -801,7 +850,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);
 }
 
 /**
@@ -1633,6 +1682,7 @@ function sharedErrorHandler(location) {
                 }
             }
         }
+        newErr.status = xhr.getStatus();
         newErr.serverResponse = err.serverResponse;
         return newErr;
     }
@@ -1918,7 +1968,16 @@ function continueResumableUpload(location, service, url, blob, chunkSize, mappin
     }
     var startByte = status_.current;
     var endByte = startByte + bytesToUpload;
-    var uploadCommand = bytesToUpload === bytesLeft ? 'upload, finalize' : 'upload';
+    var uploadCommand = '';
+    if (bytesToUpload === 0) {
+        uploadCommand = 'finalize';
+    }
+    else if (bytesLeft === bytesToUpload) {
+        uploadCommand = 'upload, finalize';
+    }
+    else {
+        uploadCommand = 'upload';
+    }
     var headers = {
         'X-Goog-Upload-Command': uploadCommand,
         'X-Goog-Upload-Offset': "" + status_.current
@@ -2302,6 +2361,18 @@ var UploadTask = /** @class */ (function () {
                 _this.completeTransitions_();
             }
             else {
+                var 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 */);
             }
@@ -2316,6 +2387,8 @@ var UploadTask = /** @class */ (function () {
                 _this._transition("error" /* ERROR */);
             }
         };
+        this.sleepTime = 0;
+        this.maxSleepTime = this._ref.storage.maxUploadRetryTime;
         this._promise = new Promise(function (resolve, reject) {
             _this._resolve = resolve;
             _this._reject = reject;
@@ -2325,6 +2398,9 @@ var UploadTask = /** @class */ (function () {
         // to the top level with a dummy handler.
         this._promise.then(null, function () { });
     }
+    UploadTask.prototype.isExponentialBackoffExpired = function () {
+        return this.sleepTime > this.maxSleepTime;
+    };
     UploadTask.prototype._makeProgressCallback = function () {
         var _this = this;
         var sizeBefore = this._transferred;
@@ -2334,6 +2410,7 @@ var UploadTask = /** @class */ (function () {
         return blob.size() > 256 * 1024;
     };
     UploadTask.prototype._start = function () {
+        var _this = this;
         if (this._state !== "running" /* RUNNING */) {
             // This can happen if someone pauses us in a resume callback, for example.
             return;
@@ -2355,7 +2432,9 @@ var UploadTask = /** @class */ (function () {
                         this._fetchMetadata();
                     }
                     else {
-                        this._continueUpload();
+                        setTimeout(function () {
+                            _this._continueUpload();
+                        }, this.sleepTime);
                     }
                 }
             }
@@ -2436,7 +2515,9 @@ var UploadTask = /** @class */ (function () {
                 _this._transition("error" /* ERROR */);
                 return;
             }
-            var uploadRequest = _this._ref.storage._makeRequest(requestInfo, newTextConnection, authToken, appCheckToken);
+            var 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(function (newStatus) {
                 _this._increaseMultiplier();
@@ -2455,7 +2536,7 @@ var UploadTask = /** @class */ (function () {
     UploadTask.prototype._increaseMultiplier = function () {
         var 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;
         }
     };
@@ -2611,6 +2692,7 @@ var UploadTask = /** @class */ (function () {
      */
     UploadTask.prototype.on = function (type, nextOrObserver, error, completed) {
         var _this = this;
+        // Note: `type` isn't being used. Its type is also incorrect. TaskEvent should not be a string.
         var observer = new Observer(nextOrObserver || undefined, error || undefined, completed || undefined);
         this._addObserver(observer);
         return function () {
@@ -3374,10 +3456,11 @@ var FirebaseStorageImpl = /** @class */ (function () {
      * @param requestInfo - HTTP RequestInfo object
      * @param authToken - Firebase auth token
      */
-    FirebaseStorageImpl.prototype._makeRequest = function (requestInfo, requestFactory, authToken, appCheckToken) {
+    FirebaseStorageImpl.prototype._makeRequest = function (requestInfo, requestFactory, authToken, appCheckToken, retry) {
         var _this = this;
+        if (retry === void 0) { retry = true; }
         if (!this._deleted) {
-            var request_1 = makeRequest(requestInfo, this._appId, authToken, appCheckToken, requestFactory, this._firebaseVersion);
+            var request_1 = makeRequest(requestInfo, this._appId, authToken, appCheckToken, requestFactory, this._firebaseVersion, retry);
             this._requests.add(request_1);
             // Request removes itself from set when complete.
             request_1.getPromise().then(function () { return _this._requests.delete(request_1); }, function () { return _this._requests.delete(request_1); });
@@ -3407,7 +3490,7 @@ var FirebaseStorageImpl = /** @class */ (function () {
 }());
 
 var name = "@firebase/storage";
-var version = "0.9.10";
+var version = "0.9.11-20221010190246";
 
 /**
  * @license