feat(auth): adds hub events to updateUserAttributes api

packages/amazon-cognito-identity-js/__tests__/CognitoUser.test.js

@@ -1657,4 +1657,39 @@ describe('refreshSession()', () => {
 			new Error('Username is null. Cannot retrieve a new session')
 		);
 	});
+
+	test('update attributes usage of three out of three parameters in callback', () => {
+		const codeDeliverDetailsResult = {
+			'CodeDeliveryDetailsList': [ 
+			   { 
+				  'AttributeName': 'email',
+				  'DeliveryMedium': 'EMAIL',
+				  'Destination': 'e***@e***'
+			   }
+			]
+		};
+		const spyon = jest.spyOn(CognitoUser.prototype, 'updateAttributes')
+			.mockImplementationOnce((attrs, callback) => {
+				callback(null, 'SUCCESS', codeDeliverDetailsResult);
+		});
+		const attrs = [
+			{
+				Name: 'email',
+				Value: 'email@email.com'
+			},
+			{
+				Name: 'family_name',
+				Value: 'familyName'
+			}
+		];
+		cognitoUser.updateAttributes(
+			attrs,
+			(err, result, details) => {
+				expect(err).toBe(null);
+				expect(result).toBe('SUCCESS');
+				expect(details).toBe(codeDeliverDetailsResult);
+			} 
+		);
+		spyon.mockClear();
+	});
 });

packages/amazon-cognito-identity-js/src/CognitoUser.js

@@ -1125,13 +1125,13 @@ export default class CognitoUser {
 				UserAttributes: attributes,
 				ClientMetadata: clientMetadata,
 			},
-			err => {
+			(err,result) => {
 				if (err) {
 					return callback(err, null);
 				}
 
 				// update cached user
-				return this.getUserData(() => callback(null, 'SUCCESS'), {
+				return this.getUserData(() => callback(null, 'SUCCESS', result), {
 					bypassCache: true,
 				});
 			}

packages/auth/__tests__/auth-unit-test.ts

@@ -2995,6 +2995,102 @@ describe('auth unit test', () => {
 			);
 			spyon.mockClear();
 		});
+
+		test('error hub event', async (done) => {
+			expect.assertions(3);
+			const spyon = jest.spyOn(CognitoUser.prototype, 'updateAttributes')
+				.mockImplementationOnce((attrs, callback: any) => {
+					callback(new Error('Error'), null, null);
+			});
+
+			const auth = new Auth(authOptions);
+
+			const user = new CognitoUser({
+				Username: 'username',
+				Pool: userPool,
+			});
+
+			const attributes = {
+				email: 'email',
+				phone_number: 'phone_number',
+				sub: 'sub',
+			};
+
+			const listenToHub = Hub.listen('auth', ({ payload }) => {
+				const { event } = payload;
+				if (event === 'updateUserAttributes_failure') {
+					expect(payload.data.message).toBe('Error');
+					expect(payload.message).toBe('Failed to update attributes');
+					listenToHub();
+					done();
+				}
+			});
+
+			try {
+				await auth.updateUserAttributes(user, attributes);
+			} catch (e) {
+				expect(e).toEqual(new Error('Error'));
+			}
+
+			spyon.mockClear();
+		});
+
+		test('happy case code delivery details hub event', async (done) => {
+			expect.assertions(2);
+
+			const codeDeliverDetailsResult: any = {
+				'CodeDeliveryDetailsList': [ 
+				   { 
+					  'AttributeName': 'email',
+					  'DeliveryMedium': 'EMAIL',
+					  'Destination': 'e***@e***'
+				   }
+				]
+			};
+			const spyon = jest.spyOn(CognitoUser.prototype, 'updateAttributes')
+				.mockImplementationOnce((attrs, callback: any) => {
+					callback(null, 'SUCCESS', codeDeliverDetailsResult);
+			});
+			const auth = new Auth(authOptions);
+
+			const user = new CognitoUser({
+				Username: 'username',
+				Pool: userPool,
+			});
+
+			const attributes = {
+				email: 'email',
+				phone_number: 'phone_number',
+				sub: 'sub',
+			};
+			const payloadData = {
+				'email': {
+					isUpdated: false,
+					codeDeliveryDetails: {
+						AttributeName: 'email',
+						DeliveryMedium: 'EMAIL',
+						Destination: 'e***@e***'
+					}
+				},
+				'phone_number': {
+					isUpdated: true
+				},
+				'sub': {
+					isUpdated: true
+				}
+			};
+			const listenToHub = Hub.listen('auth', ({ payload }) => {
+				const { event } = payload;
+				if (event === 'updateUserAttributes') {
+					expect(payload.data).toEqual(payloadData);
+					listenToHub();
+					done();
+				}
+			});
+
+			expect(await auth.updateUserAttributes(user, attributes)).toBe('SUCCESS');
+			spyon.mockClear();
+		});
 	});
 
 	describe('deleteUserAttributes test', () => {

packages/auth/src/Auth.ts

@@ -53,6 +53,7 @@ import {
 	CognitoRefreshToken,
 	CognitoAccessToken,
 	NodeCallback,
+	CodeDeliveryDetails,
 } from 'amazon-cognito-identity-js';
 
 import { parse } from 'url';
@@ -1424,10 +1425,16 @@ export class AuthClass {
 				}
 				user.updateAttributes(
 					attributeList,
-					(err, result) => {
+					(err, result, details) => {
+
 						if (err) {
+							dispatchAuthEvent('updateUserAttributes_failure', err, 'Failed to update attributes');
 							return reject(err);
 						} else {
+							const attrs = this.createUpdateAttributesResultList(
+								attributes as Record<string, string>, details?.CodeDeliveryDetailsList
+							);
+							dispatchAuthEvent('updateUserAttributes', attrs, 'Attributes successfully updated');
 							return resolve(result);
 						}
 					},
@@ -1436,6 +1443,25 @@ export class AuthClass {
 			});
 		});
 	}
+
+	private createUpdateAttributesResultList(
+		attributes: Record<string, string>, 
+		codeDeliveryDetailsList?: CodeDeliveryDetails []
+	): Record<string, string> {
+		const attrs = {};
+		Object.keys(attributes).forEach(key => {
+			attrs[key] = {
+				isUpdated: true
+			};
+			const codeDeliveryDetails = codeDeliveryDetailsList?.find(value => value.AttributeName === key);
+			if (codeDeliveryDetails) {
+				attrs[key].isUpdated = false;
+				attrs[key].codeDeliveryDetails = codeDeliveryDetails;
+			}
+		});
+		return attrs;
+	}
+
 	/**
 	 * Return user attributes
 	 * @param {Object} user - The CognitoUser object