feat(@aws-amplify/auth): delete user attributes (#7342)

* feat: delete user attributes * fix: remove un-accepted clientMetadata props * test: add test od deleteUserAttributes function * test: fix test code of deleteUserAttributes * test: fix test code of deleteUserAttributes Co-authored-by: Hidetaka Okamoto <[email protected]> Co-authored-by: Sam Martinez <[email protected]> Co-authored-by: KJ(Kaijie) Huang <[email protected]> Co-authored-by: KJ(Kaijie) Huang <[email protected]> Co-authored-by: Francisco Rodriguez <[email protected]>
aws-amplify · Jul 23, 2021 · 1b1df67 · 1b1df67
1 parent b881933
commit 1b1df67
Show file tree

Hide file tree

Showing 2 changed files with 76 additions and 0 deletions.
diff --git a/packages/auth/__tests__/auth-unit-test.ts b/packages/auth/__tests__/auth-unit-test.ts
@@ -204,6 +204,9 @@ jest.mock('amazon-cognito-identity-js/lib/CognitoUser', () => {
 	CognitoUser.prototype.updateAttributes = (attributeList, callback) => {
 		callback(null, 'SUCCESS');
 	};
+	CognitoUser.prototype.deleteAttributes = (attributeList, callback) => {
+		callback(null, 'SUCCESS');
+	};
 
 	CognitoUser.prototype.setAuthenticationFlowType = type => {};
 
@@ -2686,6 +2689,52 @@ describe('auth unit test', () => {
 		});
 	});
 
+	describe('deleteUserAttributes test', () => {
+		test('happy case', async () => {
+			const auth = new Auth(authOptions);
+
+			const user = new CognitoUser({
+				Username: 'username',
+				Pool: userPool,
+			});
+
+			const attributeNames = [
+				'email', 'phone_number'
+			];
+
+			const spyon = jest
+				.spyOn(Auth.prototype, 'userSession')
+				.mockImplementationOnce(() => {
+					return new Promise((res) => {
+						res(session);
+					});
+				});
+
+			expect.assertions(1);
+			expect(await auth.deleteUserAttributes(user, attributeNames)).toBe('SUCCESS');
+
+			spyon.mockClear();
+		});
+
+		test('happy case to call with expected attributes', async () => {
+			const spyon = jest.spyOn(CognitoUser.prototype, 'deleteAttributes');
+			const auth = new Auth(authOptionsWithClientMetadata);
+			const user = new CognitoUser({
+				Username: 'username',
+				Pool: userPool,
+			});
+
+			await auth.deleteUserAttributes(user, ['email', 'phone_number']);
+
+			expect(await CognitoUser.prototype.deleteAttributes).toBeCalledWith(
+				['email', 'phone_number'],
+				jasmine.any(Function),
+			);
+			spyon.mockClear();
+		});
+
+	});
+
 	describe('federatedSignIn test', () => {
 		test('No Identity Pool and No User Pool', async () => {
 			const options: AuthOptions = {};

diff --git a/packages/auth/src/Auth.ts b/packages/auth/src/Auth.ts
@@ -1111,6 +1111,33 @@ export class AuthClass {
 		});
 	}
 
+	/**
+	 * Delete an authenticated users' attributes
+	 * @param {CognitoUser} - The currently logged in user object
+	 * @return {Promise}
+	 **/
+	public deleteUserAttributes(
+		user: CognitoUser | any,
+		attributeNames: string[],
+	) {
+		const that = this;
+		return new Promise((resolve, reject) => {
+			that.userSession(user).then(session => {
+				user.deleteAttributes(
+					attributeNames,
+					(err, result) => {
+						if (err) {
+							return reject(err);
+						} else {
+							return resolve(result);
+						}
+					}
+				);
+			});
+		});
+
+	}
+
 	/**
 	 * Update an authenticated users' attributes
 	 * @param {CognitoUser} - The currently logged in user object