firebase-admin 6.2.0 → 6.5.1

package/lib/storage/storage.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v6.2.0 */
+/*! firebase-admin v6.5.1 */
 "use strict";
 /*!
  * Copyright 2017 Google Inc.

package/lib/utils/api-request.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v6.2.0 */
+/*! firebase-admin v6.5.1 */
 "use strict";
 /*!
  * Copyright 2017 Google Inc.
@@ -26,12 +26,12 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-var deep_copy_1 = require("./deep-copy");
 var error_1 = require("./error");
 var validator = require("./validator");
 var http = require("http");
 var https = require("https");
 var url = require("url");
+var events_1 = require("events");
 var DefaultHttpResponse = /** @class */ (function () {
     /**
      * Constructs a new HttpResponse from the given LowLevelResponse.
@@ -129,11 +129,10 @@ exports.HttpClient = HttpClient;
  * Sends an HTTP request based on the provided configuration. This is a wrapper around the http and https
  * packages of Node.js, providing content processing, timeouts and error handling.
  */
-function sendRequest(httpRequestConfig) {
-    var config = deep_copy_1.deepCopy(httpRequestConfig);
+function sendRequest(config) {
     return new Promise(function (resolve, reject) {
         var data;
-        var headers = config.headers || {};
+        var headers = Object.assign({}, config.headers);
         var fullUrl = config.url;
         if (config.data) {
             // GET and HEAD do not support body in request.
@@ -142,13 +141,14 @@ function sendRequest(httpRequestConfig) {
                     return reject(createError(config.method + " requests cannot have a body", config));
                 }
                 // Parse URL and append data to query string.
-                var configUrl = new url.URL(fullUrl);
-                for (var key in config.data) {
-                    if (config.data.hasOwnProperty(key)) {
-                        configUrl.searchParams.append(key, config.data[key]);
+                var parsedUrl = new url.URL(fullUrl);
+                var dataObj = config.data;
+                for (var key in dataObj) {
+                    if (dataObj.hasOwnProperty(key)) {
+                        parsedUrl.searchParams.append(key, dataObj[key]);
                     }
                 }
-                fullUrl = configUrl.toString();
+                fullUrl = parsedUrl.toString();
             }
             else if (validator.isObject(config.data)) {
                 data = Buffer.from(JSON.stringify(config.data), 'utf-8');
@@ -173,11 +173,16 @@ function sendRequest(httpRequestConfig) {
         var parsed = url.parse(fullUrl);
         var protocol = parsed.protocol || 'https:';
         var isHttps = protocol === 'https:';
+        var port = parsed.port;
+        if (!port) {
+            port = isHttps ? '443' : '80';
+        }
         var options = {
             hostname: parsed.hostname,
-            port: parsed.port,
+            port: port,
             path: parsed.path,
             method: config.method,
+            agent: config.httpAgent,
             headers: headers,
         };
         var transport = isHttps ? https : http;
@@ -278,10 +283,13 @@ var AuthorizedHttpClient = /** @class */ (function (_super) {
     AuthorizedHttpClient.prototype.send = function (request) {
         var _this = this;
         return this.app.INTERNAL.getToken().then(function (accessTokenObj) {
-            var requestCopy = deep_copy_1.deepCopy(request);
-            requestCopy.headers = requestCopy.headers || {};
+            var requestCopy = Object.assign({}, request);
+            requestCopy.headers = Object.assign({}, request.headers);
             var authHeader = 'Authorization';
             requestCopy.headers[authHeader] = "Bearer " + accessTokenObj.accessToken;
+            if (!requestCopy.httpAgent && _this.app.options.httpAgent) {
+                requestCopy.httpAgent = _this.app.options.httpAgent;
+            }
             return _super.prototype.send.call(_this, requestCopy);
         });
     };
@@ -340,3 +348,110 @@ var ApiSettings = /** @class */ (function () {
     return ApiSettings;
 }());
 exports.ApiSettings = ApiSettings;
+/**
+ * Class used for polling an endpoint with exponential backoff.
+ *
+ * Example usage:
+ * ```
+ * const poller = new ExponentialBackoffPoller();
+ * poller
+ *     .poll(() => {
+ *       return myRequestToPoll()
+ *           .then((responseData: any) => {
+ *             if (!isValid(responseData)) {
+ *               // Continue polling.
+ *               return null;
+ *             }
+ *
+ *             // Polling complete. Resolve promise with final response data.
+ *             return responseData;
+ *           });
+ *     })
+ *     .then((responseData: any) => {
+ *       console.log(`Final response: ${responseData}`);
+ *     });
+ * ```
+ */
+var ExponentialBackoffPoller = /** @class */ (function (_super) {
+    __extends(ExponentialBackoffPoller, _super);
+    function ExponentialBackoffPoller(initialPollingDelayMillis, maxPollingDelayMillis, masterTimeoutMillis) {
+        if (initialPollingDelayMillis === void 0) { initialPollingDelayMillis = 1000; }
+        if (maxPollingDelayMillis === void 0) { maxPollingDelayMillis = 10000; }
+        if (masterTimeoutMillis === void 0) { masterTimeoutMillis = 60000; }
+        var _this = _super.call(this) || this;
+        _this.initialPollingDelayMillis = initialPollingDelayMillis;
+        _this.maxPollingDelayMillis = maxPollingDelayMillis;
+        _this.masterTimeoutMillis = masterTimeoutMillis;
+        _this.numTries = 0;
+        _this.completed = false;
+        return _this;
+    }
+    /**
+     * Poll the provided callback with exponential backoff.
+     *
+     * @param {() => Promise<object>} callback The callback to be called for each poll. If the
+     *     callback resolves to a falsey value, polling will continue. Otherwise, the truthy
+     *     resolution will be used to resolve the promise returned by this method.
+     * @return {Promise<object>} A Promise which resolves to the truthy value returned by the provided
+     *     callback when polling is complete.
+     */
+    ExponentialBackoffPoller.prototype.poll = function (callback) {
+        var _this = this;
+        if (this.pollCallback) {
+            throw new Error('poll() can only be called once per instance of ExponentialBackoffPoller');
+        }
+        this.pollCallback = callback;
+        this.on('poll', this.repoll);
+        this.masterTimer = setTimeout(function () {
+            if (_this.completed) {
+                return;
+            }
+            _this.markCompleted();
+            _this.reject(new Error('ExponentialBackoffPoller deadline exceeded - Master timeout reached'));
+        }, this.masterTimeoutMillis);
+        return new Promise(function (resolve, reject) {
+            _this.resolve = resolve;
+            _this.reject = reject;
+            _this.repoll();
+        });
+    };
+    ExponentialBackoffPoller.prototype.repoll = function () {
+        var _this = this;
+        this.pollCallback()
+            .then(function (result) {
+            if (_this.completed) {
+                return;
+            }
+            if (!result) {
+                _this.repollTimer =
+                    setTimeout(function () { return _this.emit('poll'); }, _this.getPollingDelayMillis());
+                _this.numTries++;
+                return;
+            }
+            _this.markCompleted();
+            _this.resolve(result);
+        })
+            .catch(function (err) {
+            if (_this.completed) {
+                return;
+            }
+            _this.markCompleted();
+            _this.reject(err);
+        });
+    };
+    ExponentialBackoffPoller.prototype.getPollingDelayMillis = function () {
+        var increasedPollingDelay = Math.pow(2, this.numTries) * this.initialPollingDelayMillis;
+        return Math.min(increasedPollingDelay, this.maxPollingDelayMillis);
+    };
+    ExponentialBackoffPoller.prototype.markCompleted = function () {
+        this.completed = true;
+        if (this.masterTimer) {
+            clearTimeout(this.masterTimer);
+        }
+        if (this.repollTimer) {
+            clearTimeout(this.repollTimer);
+        }
+    };
+    return ExponentialBackoffPoller;
+}(events_1.EventEmitter));
+exports.ExponentialBackoffPoller = ExponentialBackoffPoller;

package/lib/utils/deep-copy.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v6.2.0 */
+/*! firebase-admin v6.5.1 */
 "use strict";
 /*!
  * Copyright 2017 Google Inc.

package/lib/utils/error.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v6.2.0 */
+/*! firebase-admin v6.5.1 */
 "use strict";
 /*!
  * Copyright 2017 Google Inc.
@@ -158,10 +158,19 @@ var FirebaseAuthError = /** @class */ (function (_super) {
      * @return {FirebaseAuthError} The corresponding developer-facing error.
      */
     FirebaseAuthError.fromServerError = function (serverErrorCode, message, rawServerResponse) {
+        // serverErrorCode could contain additional details:
+        // ERROR_CODE : Detailed message which can also contain colons
+        var colonSeparator = (serverErrorCode || '').indexOf(':');
+        var customMessage = null;
+        if (colonSeparator !== -1) {
+            customMessage = serverErrorCode.substring(colonSeparator + 1).trim();
+            serverErrorCode = serverErrorCode.substring(0, colonSeparator).trim();
+        }
         // If not found, default to internal error.
         var clientCodeKey = AUTH_SERVER_TO_CLIENT_CODE[serverErrorCode] || 'INTERNAL_ERROR';
         var error = deep_copy_1.deepCopy(AuthClientErrorCode[clientCodeKey]);
-        error.message = message || error.message;
+        // Server detailed message should have highest priority.
+        error.message = customMessage || message || error.message;
         if (clientCodeKey === 'INTERNAL_ERROR' && typeof rawServerResponse !== 'undefined') {
             try {
                 error.message += " Raw server response: \"" + JSON.stringify(rawServerResponse) + "\"";
@@ -288,6 +297,21 @@ var FirebaseMessagingError = /** @class */ (function (_super) {
     return FirebaseMessagingError;
 }(PrefixedFirebaseError));
 exports.FirebaseMessagingError = FirebaseMessagingError;
+/**
+ * Firebase project management error code structure. This extends PrefixedFirebaseError.
+ *
+ * @param {ProjectManagementErrorCode} code The error code.
+ * @param {string} message The error message.
+ * @constructor
+ */
+var FirebaseProjectManagementError = /** @class */ (function (_super) {
+    __extends(FirebaseProjectManagementError, _super);
+    function FirebaseProjectManagementError(code, message) {
+        return _super.call(this, 'project-management', code, message) || this;
+    }
+    return FirebaseProjectManagementError;
+}(PrefixedFirebaseError));
+exports.FirebaseProjectManagementError = FirebaseProjectManagementError;
 /**
  * App client error codes and their default messages.
  */
@@ -317,6 +341,10 @@ var AuthClientErrorCode = /** @class */ (function () {
         code: 'claims-too-large',
         message: 'Developer claims maximum payload size exceeded.',
     };
+    AuthClientErrorCode.CONFIGURATION_NOT_FOUND = {
+        code: 'configuration-not-found',
+        message: 'There is no configuration corresponding to the provided identifier.',
+    };
     AuthClientErrorCode.ID_TOKEN_EXPIRED = {
         code: 'id-token-expired',
         message: 'The provided Firebase ID token is expired.',
@@ -663,8 +691,8 @@ exports.InstanceIdClientErrorCode = InstanceIdClientErrorCode;
 var AUTH_SERVER_TO_CLIENT_CODE = {
     // Claims payload is too large.
     CLAIMS_TOO_LARGE: 'CLAIMS_TOO_LARGE',
-    // Project not found.
-    CONFIGURATION_NOT_FOUND: 'PROJECT_NOT_FOUND',
+    // Configuration not found.
+    CONFIGURATION_NOT_FOUND: 'CONFIGURATION_NOT_FOUND',
     // Provided credential has insufficient permissions.
     INSUFFICIENT_PERMISSION: 'INSUFFICIENT_PERMISSION',
     // ActionCodeSettings missing continue URL.

package/lib/utils/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v6.2.0 */
+/*! firebase-admin v6.5.1 */
 "use strict";
 /*!
  * Copyright 2017 Google Inc.

package/lib/utils/validator.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v6.2.0 */
+/*! firebase-admin v6.5.1 */
 "use strict";
 /*!
  * Copyright 2017 Google Inc.
@@ -77,6 +77,19 @@ function isString(value) {
     return typeof value === 'string';
 }
 exports.isString = isString;
+/**
+ * Validates that a value is a base64 string.
+ *
+ * @param {any} value The value to validate.
+ * @return {boolean} Whether the value is a base64 string or not.
+ */
+function isBase64String(value) {
+    if (!isString(value)) {
+        return false;
+    }
+    return /^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/.test(value);
+}
+exports.isBase64String = isBase64String;
 /**
  * Validates that a value is a non-empty string.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-admin",
-  "version": "6.2.0",
+  "version": "6.5.1",
   "description": "Firebase admin SDK for Node.js",
   "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
   "license": "Apache-2.0",
@@ -95,7 +95,7 @@
     "minimist": "^1.2.0",
     "mocha": "^5.2.0",
     "nock": "^9.6.0",
-    "npm-run-all": "^4.1.2",
+    "npm-run-all": "^4.1.5",
     "nyc": "^11.5.0",
     "request": "^2.75.0",
     "request-promise": "^4.1.1",