@aws-amplify/auth 4.6.2-next.36 → 4.6.2-next.41

package/lib/Auth.d.ts

@@ -16,6 +16,7 @@ export declare class AuthClass {
     private oAuthFlowInProgress;
     private pendingSignIn;
     private autoSignInInitiated;
+    private inflightSessionPromise;
     Credentials: import("@aws-amplify/core").CredentialsClass;
     /**
      * Initialize Auth with AWS configurations
@@ -199,6 +200,7 @@ export declare class AuthClass {
      * @return - A promise resolves to session object if success
      */
     currentSession(): Promise<CognitoUserSession>;
+    private _userSession;
     /**
      * Get the corresponding user session
      * @param {Object} user - The CognitoUser object

package/lib/Auth.js

@@ -1,16 +1,6 @@
 "use strict";
-/*
- * Copyright 2017-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
- * the License. A copy of the License is located at
- *
- *	 http://aws.amazon.com/apache2.0/
- *
- * or in the "license" file accompanying this file. This file 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.
- */
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
 var tslib_1 = require("tslib");
 var types_1 = require("./types");
@@ -50,6 +40,7 @@ var AuthClass = /** @class */ (function () {
         this.user = null;
         this.oAuthFlowInProgress = false;
         this.autoSignInInitiated = false;
+        this.inflightSessionPromise = null;
         this.Credentials = core_1.Credentials;
         this.wrapRefreshSessionCallback = function (callback) {
             var wrapped = function (error, data) {
@@ -1386,10 +1377,10 @@ var AuthClass = /** @class */ (function () {
         return new Promise(function (res, rej) {
             _this._storageSync
                 .then(function () { return tslib_1.__awaiter(_this, void 0, void 0, function () {
-                var user, clientMetadata;
+                var user, session, bypassCache, clientMetadata, _a, scope, err_1;
                 var _this = this;
-                return tslib_1.__generator(this, function (_a) {
-                    switch (_a.label) {
+                return tslib_1.__generator(this, function (_b) {
+                    switch (_b.label) {
                         case 0:
                             if (!this.isOAuthInProgress()) return [3 /*break*/, 2];
                             logger.debug('OAuth signIn in progress, waiting for resolution...');
@@ -1413,8 +1404,8 @@ var AuthClass = /** @class */ (function () {
                                     }
                                 })];
                         case 1:
-                            _a.sent();
-                            _a.label = 2;
+                            _b.sent();
+                            _b.label = 2;
                         case 2:
                             user = this.userPool.getCurrentUser();
                             if (!user) {
@@ -1422,96 +1413,77 @@ var AuthClass = /** @class */ (function () {
                                 rej('No current user');
                                 return [2 /*return*/];
                             }
+                            _b.label = 3;
+                        case 3:
+                            _b.trys.push([3, 7, , 8]);
+                            return [4 /*yield*/, this._userSession(user)];
+                        case 4:
+                            session = _b.sent();
+                            bypassCache = params ? params.bypassCache : false;
+                            if (!bypassCache) return [3 /*break*/, 6];
+                            return [4 /*yield*/, this.Credentials.clear()];
+                        case 5:
+                            _b.sent();
+                            _b.label = 6;
+                        case 6:
                             clientMetadata = this._config.clientMetadata;
-                            // refresh the session if the session expired.
-                            user.getSession(function (err, session) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
-                                var cleanUpError_5, bypassCache, clientMetadata, _a, scope;
-                                var _this = this;
-                                return tslib_1.__generator(this, function (_b) {
-                                    switch (_b.label) {
-                                        case 0:
-                                            if (!err) return [3 /*break*/, 5];
-                                            logger.debug('Failed to get the user session', err);
-                                            if (!this.isSessionInvalid(err)) return [3 /*break*/, 4];
-                                            _b.label = 1;
-                                        case 1:
-                                            _b.trys.push([1, 3, , 4]);
-                                            return [4 /*yield*/, this.cleanUpInvalidSession(user)];
-                                        case 2:
-                                            _b.sent();
-                                            return [3 /*break*/, 4];
-                                        case 3:
-                                            cleanUpError_5 = _b.sent();
-                                            rej(new Error("Session is invalid due to: " + err.message + " and failed to clean up invalid session: " + cleanUpError_5.message));
-                                            return [2 /*return*/];
-                                        case 4:
-                                            rej(err);
-                                            return [2 /*return*/];
-                                        case 5:
-                                            bypassCache = params ? params.bypassCache : false;
-                                            if (!bypassCache) return [3 /*break*/, 7];
-                                            return [4 /*yield*/, this.Credentials.clear()];
-                                        case 6:
-                                            _b.sent();
-                                            _b.label = 7;
-                                        case 7:
-                                            clientMetadata = this._config.clientMetadata;
-                                            _a = session.getAccessToken().decodePayload().scope, scope = _a === void 0 ? '' : _a;
-                                            if (scope.split(' ').includes(USER_ADMIN_SCOPE)) {
-                                                user.getUserData(function (err, data) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
-                                                    var cleanUpError_6, preferredMFA, attributeList, i, attribute, userAttribute, attributes;
-                                                    return tslib_1.__generator(this, function (_a) {
-                                                        switch (_a.label) {
-                                                            case 0:
-                                                                if (!err) return [3 /*break*/, 7];
-                                                                logger.debug('getting user data failed', err);
-                                                                if (!this.isSessionInvalid(err)) return [3 /*break*/, 5];
-                                                                _a.label = 1;
-                                                            case 1:
-                                                                _a.trys.push([1, 3, , 4]);
-                                                                return [4 /*yield*/, this.cleanUpInvalidSession(user)];
-                                                            case 2:
-                                                                _a.sent();
-                                                                return [3 /*break*/, 4];
-                                                            case 3:
-                                                                cleanUpError_6 = _a.sent();
-                                                                rej(new Error("Session is invalid due to: " + err.message + " and failed to clean up invalid session: " + cleanUpError_6.message));
-                                                                return [2 /*return*/];
-                                                            case 4:
-                                                                rej(err);
-                                                                return [3 /*break*/, 6];
-                                                            case 5:
-                                                                res(user);
-                                                                _a.label = 6;
-                                                            case 6: return [2 /*return*/];
-                                                            case 7:
-                                                                preferredMFA = data.PreferredMfaSetting || 'NOMFA';
-                                                                attributeList = [];
-                                                                for (i = 0; i < data.UserAttributes.length; i++) {
-                                                                    attribute = {
-                                                                        Name: data.UserAttributes[i].Name,
-                                                                        Value: data.UserAttributes[i].Value,
-                                                                    };
-                                                                    userAttribute = new amazon_cognito_identity_js_1.CognitoUserAttribute(attribute);
-                                                                    attributeList.push(userAttribute);
-                                                                }
-                                                                attributes = this.attributesToObject(attributeList);
-                                                                Object.assign(user, { attributes: attributes, preferredMFA: preferredMFA });
-                                                                return [2 /*return*/, res(user)];
-                                                        }
-                                                    });
-                                                }); }, { bypassCache: bypassCache, clientMetadata: clientMetadata });
-                                            }
-                                            else {
-                                                logger.debug("Unable to get the user data because the " + USER_ADMIN_SCOPE + " " +
-                                                    "is not in the scopes of the access token");
+                            _a = session.getAccessToken().decodePayload().scope, scope = _a === void 0 ? '' : _a;
+                            if (scope.split(' ').includes(USER_ADMIN_SCOPE)) {
+                                user.getUserData(function (err, data) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
+                                    var cleanUpError_5, preferredMFA, attributeList, i, attribute, userAttribute, attributes;
+                                    return tslib_1.__generator(this, function (_a) {
+                                        switch (_a.label) {
+                                            case 0:
+                                                if (!err) return [3 /*break*/, 7];
+                                                logger.debug('getting user data failed', err);
+                                                if (!this.isSessionInvalid(err)) return [3 /*break*/, 5];
+                                                _a.label = 1;
+                                            case 1:
+                                                _a.trys.push([1, 3, , 4]);
+                                                return [4 /*yield*/, this.cleanUpInvalidSession(user)];
+                                            case 2:
+                                                _a.sent();
+                                                return [3 /*break*/, 4];
+                                            case 3:
+                                                cleanUpError_5 = _a.sent();
+                                                rej(new Error("Session is invalid due to: " + err.message + " and failed to clean up invalid session: " + cleanUpError_5.message));
+                                                return [2 /*return*/];
+                                            case 4:
+                                                rej(err);
+                                                return [3 /*break*/, 6];
+                                            case 5:
+                                                res(user);
+                                                _a.label = 6;
+                                            case 6: return [2 /*return*/];
+                                            case 7:
+                                                preferredMFA = data.PreferredMfaSetting || 'NOMFA';
+                                                attributeList = [];
+                                                for (i = 0; i < data.UserAttributes.length; i++) {
+                                                    attribute = {
+                                                        Name: data.UserAttributes[i].Name,
+                                                        Value: data.UserAttributes[i].Value,
+                                                    };
+                                                    userAttribute = new amazon_cognito_identity_js_1.CognitoUserAttribute(attribute);
+                                                    attributeList.push(userAttribute);
+                                                }
+                                                attributes = this.attributesToObject(attributeList);
+                                                Object.assign(user, { attributes: attributes, preferredMFA: preferredMFA });
                                                 return [2 /*return*/, res(user)];
-                                            }
-                                            return [2 /*return*/];
-                                    }
-                                });
-                            }); }, { clientMetadata: clientMetadata });
-                            return [2 /*return*/];
+                                        }
+                                    });
+                                }); }, { bypassCache: bypassCache, clientMetadata: clientMetadata });
+                            }
+                            else {
+                                logger.debug("Unable to get the user data because the " + USER_ADMIN_SCOPE + " " +
+                                    "is not in the scopes of the access token");
+                                return [2 /*return*/, res(user)];
+                            }
+                            return [3 /*break*/, 8];
+                        case 7:
+                            err_1 = _b.sent();
+                            rej(err_1);
+                            return [3 /*break*/, 8];
+                        case 8: return [2 /*return*/];
                     }
                 });
             }); })
@@ -1621,50 +1593,73 @@ var AuthClass = /** @class */ (function () {
             });
         });
     };
+    AuthClass.prototype._userSession = function (user) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var clientMetadata;
+            var _this = this;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!user) {
+                            logger.debug('the user is null');
+                            return [2 /*return*/, this.rejectAuthError(Auth_1.AuthErrorTypes.NoUserSession)];
+                        }
+                        clientMetadata = this._config.clientMetadata;
+                        // Debouncing the concurrent userSession calls by caching the promise.
+                        // This solution asumes users will always call this function with the same CognitoUser instance.
+                        if (!this.inflightSessionPromise) {
+                            this.inflightSessionPromise = new Promise(function (res, rej) {
+                                user.getSession(function (err, session) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
+                                    var cleanUpError_6;
+                                    return tslib_1.__generator(this, function (_a) {
+                                        switch (_a.label) {
+                                            case 0:
+                                                if (!err) return [3 /*break*/, 5];
+                                                logger.debug('Failed to get the session from user', user);
+                                                if (!this.isSessionInvalid(err)) return [3 /*break*/, 4];
+                                                _a.label = 1;
+                                            case 1:
+                                                _a.trys.push([1, 3, , 4]);
+                                                return [4 /*yield*/, this.cleanUpInvalidSession(user)];
+                                            case 2:
+                                                _a.sent();
+                                                return [3 /*break*/, 4];
+                                            case 3:
+                                                cleanUpError_6 = _a.sent();
+                                                rej(new Error("Session is invalid due to: " + err.message + " and failed to clean up invalid session: " + cleanUpError_6.message));
+                                                return [2 /*return*/];
+                                            case 4:
+                                                rej(err);
+                                                return [2 /*return*/];
+                                            case 5:
+                                                logger.debug('Succeed to get the user session', session);
+                                                res(session);
+                                                return [2 /*return*/];
+                                        }
+                                    });
+                                }); }, { clientMetadata: clientMetadata });
+                            });
+                        }
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, , 3, 4]);
+                        return [4 /*yield*/, this.inflightSessionPromise];
+                    case 2: return [2 /*return*/, _a.sent()];
+                    case 3:
+                        this.inflightSessionPromise = null;
+                        return [7 /*endfinally*/];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
     /**
      * Get the corresponding user session
      * @param {Object} user - The CognitoUser object
      * @return - A promise resolves to the session
      */
     AuthClass.prototype.userSession = function (user) {
-        var _this = this;
-        if (!user) {
-            logger.debug('the user is null');
-            return this.rejectAuthError(Auth_1.AuthErrorTypes.NoUserSession);
-        }
-        var clientMetadata = this._config.clientMetadata; // TODO: verify behavior if this is override during signIn
-        return new Promise(function (res, rej) {
-            logger.debug('Getting the session from this user:', user);
-            user.getSession(function (err, session) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
-                var cleanUpError_7;
-                return tslib_1.__generator(this, function (_a) {
-                    switch (_a.label) {
-                        case 0:
-                            if (!err) return [3 /*break*/, 5];
-                            logger.debug('Failed to get the session from user', user);
-                            if (!this.isSessionInvalid(err)) return [3 /*break*/, 4];
-                            _a.label = 1;
-                        case 1:
-                            _a.trys.push([1, 3, , 4]);
-                            return [4 /*yield*/, this.cleanUpInvalidSession(user)];
-                        case 2:
-                            _a.sent();
-                            return [3 /*break*/, 4];
-                        case 3:
-                            cleanUpError_7 = _a.sent();
-                            rej(new Error("Session is invalid due to: " + err.message + " and failed to clean up invalid session: " + cleanUpError_7.message));
-                            return [2 /*return*/];
-                        case 4:
-                            rej(err);
-                            return [2 /*return*/];
-                        case 5:
-                            logger.debug('Succeed to get the user session', session);
-                            res(session);
-                            return [2 /*return*/];
-                    }
-                });
-            }); }, { clientMetadata: clientMetadata });
-        });
+        return this._userSession(user);
     };
     /**
      * Get authenticated credentials of current user.
@@ -1808,7 +1803,7 @@ var AuthClass = /** @class */ (function () {
                                     // we must validate the user as an authenticated user by using getSession
                                     var clientMetadata = _this._config.clientMetadata; // TODO: verify behavior if this is override during signIn
                                     user.getSession(function (err, result) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
-                                        var cleanUpError_8;
+                                        var cleanUpError_7;
                                         var _this = this;
                                         return tslib_1.__generator(this, function (_a) {
                                             switch (_a.label) {
@@ -1824,8 +1819,8 @@ var AuthClass = /** @class */ (function () {
                                                     _a.sent();
                                                     return [3 /*break*/, 4];
                                                 case 3:
-                                                    cleanUpError_8 = _a.sent();
-                                                    rej(new Error("Session is invalid due to: " + err.message + " and failed to clean up invalid session: " + cleanUpError_8.message));
+                                                    cleanUpError_7 = _a.sent();
+                                                    rej(new Error("Session is invalid due to: " + err.message + " and failed to clean up invalid session: " + cleanUpError_7.message));
                                                     return [2 /*return*/];
                                                 case 4: return [2 /*return*/, rej(err)];
                                                 case 5:
@@ -2049,7 +2044,7 @@ var AuthClass = /** @class */ (function () {
      */
     AuthClass.prototype.currentUserInfo = function () {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var source, user, attributes, userAttrs, credentials, e_12, info, err_1, user;
+            var source, user, attributes, userAttrs, credentials, e_12, info, err_2, user;
             return tslib_1.__generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -2090,8 +2085,8 @@ var AuthClass = /** @class */ (function () {
                         };
                         return [2 /*return*/, info];
                     case 8:
-                        err_1 = _a.sent();
-                        logger.error('currentUserInfo error', err_1);
+                        err_2 = _a.sent();
+                        logger.error('currentUserInfo error', err_2);
                         return [2 /*return*/, {}];
                     case 9:
                         if (source === 'federated') {
@@ -2172,7 +2167,7 @@ var AuthClass = /** @class */ (function () {
      */
     AuthClass.prototype._handleAuthResponse = function (URL) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var currentUrl, hasCodeOrError, hasTokenOrError, _a, accessToken, idToken, refreshToken, state, session, credentials, isCustomStateIncluded, currentUser, customState, err_2;
+            var currentUrl, hasCodeOrError, hasTokenOrError, _a, accessToken, idToken, refreshToken, state, session, credentials, isCustomStateIncluded, currentUser, customState, err_3;
             return tslib_1.__generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
@@ -2245,16 +2240,16 @@ var AuthClass = /** @class */ (function () {
                         //#endregion
                         return [2 /*return*/, credentials];
                     case 6:
-                        err_2 = _b.sent();
-                        logger.debug('Error in cognito hosted auth response', err_2);
+                        err_3 = _b.sent();
+                        logger.debug('Error in cognito hosted auth response', err_3);
                         // Just like a successful handling of `?code`, replace the window history to "dispose" of the `code`.
                         // Otherwise, reloading the page will throw errors as the `code` has already been spent.
                         if (window && typeof window.history !== 'undefined') {
                             window.history.replaceState({}, null, this._config.oauth.redirectSignIn);
                         }
-                        dispatchAuthEvent('signIn_failure', err_2, "The OAuth response flow failed");
-                        dispatchAuthEvent('cognitoHostedUI_failure', err_2, "A failure occurred when returning to the Cognito Hosted UI");
-                        dispatchAuthEvent('customState_failure', err_2, "A failure occurred when returning state");
+                        dispatchAuthEvent('signIn_failure', err_3, "The OAuth response flow failed");
+                        dispatchAuthEvent('cognitoHostedUI_failure', err_3, "A failure occurred when returning to the Cognito Hosted UI");
+                        dispatchAuthEvent('customState_failure', err_3, "A failure occurred when returning state");
                         return [3 /*break*/, 7];
                     case 7: return [3 /*break*/, 9];
                     case 8: