@aws-amplify/auth 6.4.2 → 6.4.3-unstable.555defc.0

package/src/providers/cognito/apis/signInWithSRP.ts

@@ -27,10 +27,7 @@ import {
 	SignInWithSRPInput,
 	SignInWithSRPOutput,
 } from '../types';
-import {
-	cleanActiveSignInState,
-	setActiveSignInState,
-} from '../utils/signInStore';
+import { setActiveSignInState, signInStore } from '../utils/signInStore';
 import { cacheCognitoTokens } from '../tokenProvider/cacheTokens';
 import { tokenOrchestrator } from '../tokenProvider';
 import { dispatchSignedInHubEvent } from '../utils/dispatchSignedInHubEvent';
@@ -89,7 +86,7 @@ export async function signInWithSRP(
 			signInDetails,
 		});
 		if (AuthenticationResult) {
-			cleanActiveSignInState();
+			signInStore.dispatch({ type: 'RESET_STATE' });
 			await cacheCognitoTokens({
 				username: activeUsername,
 				...AuthenticationResult,
@@ -115,7 +112,7 @@ export async function signInWithSRP(
 			challengeParameters: handledChallengeParameters as ChallengeParameters,
 		});
 	} catch (error) {
-		cleanActiveSignInState();
+		signInStore.dispatch({ type: 'RESET_STATE' });
 		assertServiceError(error);
 		const result = getSignInResultFromError(error.name);
 		if (result) return result;

package/src/providers/cognito/apis/signInWithUserPassword.ts

@@ -25,10 +25,7 @@ import {
 	SignInWithUserPasswordInput,
 	SignInWithUserPasswordOutput,
 } from '../types';
-import {
-	cleanActiveSignInState,
-	setActiveSignInState,
-} from '../utils/signInStore';
+import { setActiveSignInState, signInStore } from '../utils/signInStore';
 import { cacheCognitoTokens } from '../tokenProvider/cacheTokens';
 import { tokenOrchestrator } from '../tokenProvider';
 import { dispatchSignedInHubEvent } from '../utils/dispatchSignedInHubEvent';
@@ -84,6 +81,7 @@ export async function signInWithUserPassword(
 			signInDetails,
 		});
 		if (AuthenticationResult) {
+			signInStore.dispatch({ type: 'RESET_STATE' });
 			await cacheCognitoTokens({
 				...AuthenticationResult,
 				username: activeUsername,
@@ -95,7 +93,6 @@ export async function signInWithUserPassword(
 				}),
 				signInDetails,
 			});
-			cleanActiveSignInState();
 
 			await dispatchSignedInHubEvent();
 
@@ -110,7 +107,7 @@ export async function signInWithUserPassword(
 			challengeParameters: retriedChallengeParameters as ChallengeParameters,
 		});
 	} catch (error) {
-		cleanActiveSignInState();
+		signInStore.dispatch({ type: 'RESET_STATE' });
 		assertServiceError(error);
 		const result = getSignInResultFromError(error.name);
 		if (result) return result;

package/src/providers/cognito/utils/signInStore.ts

@@ -1,6 +1,8 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+import { syncSessionStorage } from '@aws-amplify/core';
+
 import { CognitoAuthSignInDetails } from '../types';
 import { ChallengeName } from '../../../foundation/factories/serviceClients/cognitoIdentityProvider/types';
 
@@ -17,7 +19,8 @@ type SignInAction =
 	| { type: 'SET_SIGN_IN_STATE'; value: SignInState }
 	| { type: 'SET_USERNAME'; value?: string }
 	| { type: 'SET_CHALLENGE_NAME'; value?: ChallengeName }
-	| { type: 'SET_SIGN_IN_SESSION'; value?: string };
+	| { type: 'SET_SIGN_IN_SESSION'; value?: string }
+	| { type: 'RESET_STATE' };
 
 type Store<State, Action> = (reducer: Reducer<State, Action>) => {
 	getState(): ReturnType<Reducer<State, Action>>;
@@ -26,44 +29,110 @@ type Store<State, Action> = (reducer: Reducer<State, Action>) => {
 
 type Reducer<State, Action> = (state: State, action: Action) => State;
 
+// Minutes until stored session invalidates
+const MS_TO_EXPIRY = 3 * 60 * 1000; // 3 mins
+const TGT_STATE = 'CognitoSignInState';
+const SIGN_IN_STATE_KEYS = {
+	username: `${TGT_STATE}.username`,
+	challengeName: `${TGT_STATE}.challengeName`,
+	signInSession: `${TGT_STATE}.signInSession`,
+	expiry: `${TGT_STATE}.expiry`,
+};
+
 const signInReducer: Reducer<SignInState, SignInAction> = (state, action) => {
 	switch (action.type) {
 		case 'SET_SIGN_IN_SESSION':
+			persistSignInState({ signInSession: action.value });
+
 			return {
 				...state,
 				signInSession: action.value,
 			};
+
 		case 'SET_SIGN_IN_STATE':
+			persistSignInState(action.value);
+
 			return {
 				...action.value,
 			};
+
 		case 'SET_CHALLENGE_NAME':
+			persistSignInState({ challengeName: action.value });
+
 			return {
 				...state,
 				challengeName: action.value,
 			};
+
 		case 'SET_USERNAME':
+			persistSignInState({ username: action.value });
+
 			return {
 				...state,
 				username: action.value,
 			};
+
 		case 'SET_INITIAL_STATE':
-			return defaultState();
+			return initializeState();
+
+		case 'RESET_STATE':
+			clearPersistedSignInState();
+
+			return getDefaultState();
+
+		// this state is never reachable
 		default:
 			return state;
 	}
 };
 
-function defaultState(): SignInState {
-	return {
-		username: undefined,
-		challengeName: undefined,
-		signInSession: undefined,
-	};
-}
+const isExpired = (expiryDate: string | null): boolean => {
+	const expiryTimestamp = Number(expiryDate);
+	const currentTimestamp = Date.now();
+
+	return expiryTimestamp <= currentTimestamp;
+};
+
+const clearPersistedSignInState = () => {
+	for (const storedKey of Object.values(SIGN_IN_STATE_KEYS)) {
+		syncSessionStorage.removeItem(storedKey);
+	}
+};
+
+const getDefaultState = (): SignInState => ({
+	username: undefined,
+	challengeName: undefined,
+	signInSession: undefined,
+});
+
+// Hydrate signInStore from Synced Session Storage
+const initializeState = (): SignInState => {
+	const expiry = syncSessionStorage.getItem(SIGN_IN_STATE_KEYS.expiry);
+
+	if (!expiry || (expiry && isExpired(expiry))) {
+		clearPersistedSignInState();
+
+		return getDefaultState();
+	} else {
+		const username =
+			syncSessionStorage.getItem(SIGN_IN_STATE_KEYS.username) ?? undefined;
+
+		const challengeName = (syncSessionStorage.getItem(
+			SIGN_IN_STATE_KEYS.challengeName,
+		) ?? undefined) as ChallengeName;
+		const signInSession =
+			syncSessionStorage.getItem(SIGN_IN_STATE_KEYS.signInSession) ?? undefined;
+
+		return {
+			username,
+			challengeName,
+			signInSession,
+		};
+	}
+};
 
 const createStore: Store<SignInState, SignInAction> = reducer => {
-	let currentState = reducer(defaultState(), { type: 'SET_INITIAL_STATE' });
+	let currentState = reducer(getDefaultState(), { type: 'SET_INITIAL_STATE' });
 
 	return {
 		getState: () => currentState,
@@ -82,6 +151,23 @@ export function setActiveSignInState(state: SignInState): void {
 	});
 }
 
-export function cleanActiveSignInState(): void {
-	signInStore.dispatch({ type: 'SET_INITIAL_STATE' });
-}
+// Save local state into Session Storage
+export const persistSignInState = ({
+	challengeName,
+	signInSession,
+	username,
+}: SignInState) => {
+	username && syncSessionStorage.setItem(SIGN_IN_STATE_KEYS.username, username);
+	challengeName &&
+		syncSessionStorage.setItem(SIGN_IN_STATE_KEYS.challengeName, challengeName);
+
+	if (signInSession) {
+		syncSessionStorage.setItem(SIGN_IN_STATE_KEYS.signInSession, signInSession);
+
+		// Updates expiry when session is passed
+		syncSessionStorage.setItem(
+			SIGN_IN_STATE_KEYS.expiry,
+			String(Date.now() + MS_TO_EXPIRY),
+		);
+	}
+};