feat: custom user agent InternalCognitoUserPool (#11716)

* chore: port CognitoUserPool over to InternalCognitoUserPool * chore: restore CognitoUserPool * feat: add userAgentValue parameter to signUp * feat: update class name and imports * feat: make CognitoUserPool extend internal and override signUp * feat: export InternalCognitoUserPool from internals index * feat: send userAgentValue to client service call * test: fix internalsIndex test * build: export InternalCognitoUserPool from internals scope * chore: update CognitoUserPool type to extend internal * Apply suggestions from code review Co-authored-by: Jim Blanchard <jim.l.blanchard@gmail.com> * chore: remove unnecessary test on internals index * chore: increase bundle size limit --------- Co-authored-by: Jim Blanchard <jim.l.blanchard@gmail.com> Co-authored-by: israx <70438514+israx@users.noreply.github.com>
aws-amplify · Aug 8, 2023 · 94bfc5f · 94bfc5f
1 parent 115d96e
commit 94bfc5f
Show file tree

Hide file tree

Showing 8 changed files with 245 additions and 194 deletions.
diff --git a/packages/amazon-cognito-identity-js/__tests__/internalsIndex.test.js b/packages/amazon-cognito-identity-js/__tests__/internalsIndex.test.js
diff --git a/packages/amazon-cognito-identity-js/index.d.ts b/packages/amazon-cognito-identity-js/index.d.ts
diff --git a/packages/amazon-cognito-identity-js/internals/index.d.ts b/packages/amazon-cognito-identity-js/internals/index.d.ts
diff --git a/packages/amazon-cognito-identity-js/src/Client.js b/packages/amazon-cognito-identity-js/src/Client.js
@@ -83,6 +83,7 @@ export default class Client {
 	 * @param {string} operation API operation
 	 * @param {object} params Input parameters
 	 * @param {function} callback Callback called when a response is returned
+	 * @param {string} userAgentValue Optional string containing custom user agent value
 	 * @returns {void}
 	 */
 	request(operation, params, callback, userAgentValue) {

diff --git a/packages/amazon-cognito-identity-js/src/CognitoUserPool.js b/packages/amazon-cognito-identity-js/src/CognitoUserPool.js
@@ -3,83 +3,13 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import Client from './Client';
 import CognitoUser from './CognitoUser';
-import StorageHelper from './StorageHelper';
+import { InternalCognitoUserPool } from './internals';
 
 const USER_POOL_ID_MAX_LENGTH = 55;
 
 /** @class */
-export default class CognitoUserPool {
-	/**
-	 * Constructs a new CognitoUserPool object
-	 * @param {object} data Creation options.
-	 * @param {string} data.UserPoolId Cognito user pool id.
-	 * @param {string} data.ClientId User pool application client id.
-	 * @param {string} data.endpoint Optional custom service endpoint.
-	 * @param {object} data.fetchOptions Optional options for fetch API.
-	 *        (only credentials option is supported)
-	 * @param {object} data.Storage Optional storage object.
-	 * @param {boolean} data.AdvancedSecurityDataCollectionFlag Optional:
-	 *        boolean flag indicating if the data collection is enabled
-	 *        to support cognito advanced security features. By default, this
-	 *        flag is set to true.
-	 */
-	constructor(data, wrapRefreshSessionCallback) {
-		const {
-			UserPoolId,
-			ClientId,
-			endpoint,
-			fetchOptions,
-			AdvancedSecurityDataCollectionFlag,
-		} = data || {};
-		if (!UserPoolId || !ClientId) {
-			throw new Error('Both UserPoolId and ClientId are required.');
-		}
-		if (UserPoolId.length > USER_POOL_ID_MAX_LENGTH || !/^[\w-]+_[0-9a-zA-Z]+$/.test(UserPoolId)) {
-			throw new Error('Invalid UserPoolId format.');
-		}
-		const region = UserPoolId.split('_')[0];
-
-		this.userPoolId = UserPoolId;
-		this.clientId = ClientId;
-
-		this.client = new Client(region, endpoint, fetchOptions);
-
-		/**
-		 * By default, AdvancedSecurityDataCollectionFlag is set to true,
-		 * if no input value is provided.
-		 */
-		this.advancedSecurityDataCollectionFlag =
-			AdvancedSecurityDataCollectionFlag !== false;
-
-		this.storage = data.Storage || new StorageHelper().getStorage();
-
-		if (wrapRefreshSessionCallback) {
-			this.wrapRefreshSessionCallback = wrapRefreshSessionCallback;
-		}
-	}
-
-	/**
-	 * @returns {string} the user pool id
-	 */
-	getUserPoolId() {
-		return this.userPoolId;
-	}
-
-	/**
-	 * @returns {string} the user pool name
-	 */
-	getUserPoolName() {
-		return this.getUserPoolId().split('_')[1];
-	}
-
-	/**
-	 * @returns {string} the client id
-	 */
-	getClientId() {
-		return this.clientId;
-	}
+export default class CognitoUserPool extends InternalCognitoUserPool {
 
 	/**
 	 * @typedef {object} SignUpResult
@@ -105,90 +35,13 @@ export default class CognitoUserPool {
 		callback,
 		clientMetadata
 	) {
-		const jsonReq = {
-			ClientId: this.clientId,
-			Username: username,
-			Password: password,
-			UserAttributes: userAttributes,
-			ValidationData: validationData,
-			ClientMetadata: clientMetadata,
-		};
-		if (this.getUserContextData(username)) {
-			jsonReq.UserContextData = this.getUserContextData(username);
-		}
-		this.client.request('SignUp', jsonReq, (err, data) => {
-			if (err) {
-				return callback(err, null);
-			}
-
-			const cognitoUser = {
-				Username: username,
-				Pool: this,
-				Storage: this.storage,
-			};
-
-			const returnData = {
-				user: new CognitoUser(cognitoUser),
-				userConfirmed: data.UserConfirmed,
-				userSub: data.UserSub,
-				codeDeliveryDetails: data.CodeDeliveryDetails,
-			};
-
-			return callback(null, returnData);
-		});
-	}
-
-	/**
-	 * method for getting the current user of the application from the local storage
-	 *
-	 * @returns {CognitoUser} the user retrieved from storage
-	 */
-	getCurrentUser() {
-		const lastUserKey = `CognitoIdentityServiceProvider.${this.clientId}.LastAuthUser`;
-
-		const lastAuthUser = this.storage.getItem(lastUserKey);
-		if (lastAuthUser) {
-			const cognitoUser = {
-				Username: lastAuthUser,
-				Pool: this,
-				Storage: this.storage,
-			};
-
-			return new CognitoUser(cognitoUser);
-		}
-
-		return null;
-	}
-
-	/**
-	 * This method returns the encoded data string used for cognito advanced security feature.
-	 * This would be generated only when developer has included the JS used for collecting the
-	 * data on their client. Please refer to documentation to know more about using AdvancedSecurity
-	 * features
-	 * @param {string} username the username for the context data
-	 * @returns {string} the user context data
-	 **/
-	getUserContextData(username) {
-		if (typeof AmazonCognitoAdvancedSecurityData === 'undefined') {
-			return undefined;
-		}
-		/* eslint-disable */
-		const amazonCognitoAdvancedSecurityDataConst = AmazonCognitoAdvancedSecurityData;
-		/* eslint-enable */
-
-		if (this.advancedSecurityDataCollectionFlag) {
-			const advancedSecurityData = amazonCognitoAdvancedSecurityDataConst.getData(
-				username,
-				this.userPoolId,
-				this.clientId
-			);
-			if (advancedSecurityData) {
-				const userContextData = {
-					EncodedData: advancedSecurityData,
-				};
-				return userContextData;
-			}
-		}
-		return {};
+		return super.signUp(
+			username,
+			password,
+			userAttributes,
+			validationData,
+			callback,
+			clientMetadata
+		);
 	}
 }