fix(core|auth|adapterCore): use createAuthTokenRefresher ⤵️

Now we are using the createAuthTokenRefresher for creating new instances of the deduped token refresher function for different use cases: 1. on client: there is only one instance gets created on app load 2. on server: a new instance gets created in each context that's created by runWithAmplifySeverContext function
aws-amplify · May 17, 2024 · 2de2895 · 2de2895
1 parent d7d33da
commit 2de2895
Show file tree

Hide file tree

Showing 12 changed files with 30 additions and 28 deletions.
diff --git a/packages/auth/__tests__/providers/cognito/refreshToken.test.ts b/packages/auth/__tests__/providers/cognito/refreshToken.test.ts
@@ -1,5 +1,5 @@
 import { decodeJWT } from '@aws-amplify/core/internals/utils';
-import { refreshAuthTokens } from '../../../src/providers/cognito/utils/refreshAuthTokens';
+import { createAuthTokenRefresher } from '../../../src/providers/cognito/utils/refreshAuthTokens';
 import { CognitoAuthTokens } from '../../../src/providers/cognito/tokenProvider/types';
 import { initiateAuth } from '../../../src/providers/cognito/utils/clients/CognitoIdentityProvider';
 import { mockAccessToken, mockRequestId } from './testUtils/data';
@@ -14,6 +14,7 @@ jest.mock(
 describe('refreshToken', () => {
 	const mockedUsername = 'mockedUsername';
 	const mockedRefreshToken = 'mockedRefreshToken';
+	const refreshAuthTokens = createAuthTokenRefresher();
 	// assert mocks
 	const mockInitiateAuth = initiateAuth as jest.Mock;
 	describe('positive cases', () => {

diff --git a/packages/auth/src/providers/cognito/index.ts b/packages/auth/src/providers/cognito/index.ts
@@ -79,6 +79,5 @@ export {
 	CognitoUserPoolTokenProviderType,
 	TokenOrchestrator,
 	DefaultTokenStore,
-	refreshAuthTokens,
-	refreshAuthTokensWithoutDedupe,
+	createAuthTokenRefresher,
 } from './tokenProvider';
diff --git a/packages/auth/src/providers/cognito/tokenProvider/CognitoUserPoolsTokenProvider.ts b/packages/auth/src/providers/cognito/tokenProvider/CognitoUserPoolsTokenProvider.ts
@@ -9,7 +9,7 @@ import {
 	defaultStorage,
 } from '@aws-amplify/core';
 
-import { refreshAuthTokens } from '../utils/refreshAuthTokens';
+import { createAuthTokenRefresher } from '../utils/refreshAuthTokens';
 
 import { DefaultTokenStore } from './TokenStore';
 import { TokenOrchestrator } from './TokenOrchestrator';
@@ -25,7 +25,7 @@ export class CognitoUserPoolsTokenProvider
 		this.authTokenStore.setKeyValueStorage(defaultStorage);
 		this.tokenOrchestrator = new TokenOrchestrator();
 		this.tokenOrchestrator.setAuthTokenStore(this.authTokenStore);
-		this.tokenOrchestrator.setTokenRefresher(refreshAuthTokens);
+		this.tokenOrchestrator.setTokenRefresher(createAuthTokenRefresher());
 	}
 
 	getTokens(

diff --git a/packages/auth/src/providers/cognito/tokenProvider/index.ts b/packages/auth/src/providers/cognito/tokenProvider/index.ts
@@ -1,10 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export {
-	refreshAuthTokens,
-	refreshAuthTokensWithoutDedupe,
-} from '../utils/refreshAuthTokens';
+export { createAuthTokenRefresher } from '../utils/refreshAuthTokens';
 export { DefaultTokenStore } from './TokenStore';
 export { TokenOrchestrator } from './TokenOrchestrator';
 export { CognitoUserPoolTokenProviderType } from './types';

diff --git a/packages/auth/src/providers/cognito/utils/refreshAuthTokens.ts b/packages/auth/src/providers/cognito/utils/refreshAuthTokens.ts
@@ -4,8 +4,8 @@
 import { AuthConfig } from '@aws-amplify/core';
 import {
 	assertTokenProviderConfig,
-	deDupeAsyncFunction,
 	decodeJWT,
+	dedupeAsyncFunction,
 } from '@aws-amplify/core/internals/utils';
 
 import { CognitoAuthTokens, TokenRefresher } from '../tokenProvider/types';
@@ -16,7 +16,7 @@ import { AuthError } from '../../../errors/AuthError';
 
 import { getUserContextData } from './userContextData';
 
-const refreshAuthTokensFunction: TokenRefresher = async ({
+const refreshAuthTokens: TokenRefresher = async ({
 	tokens,
 	authConfig,
 	username,
@@ -76,5 +76,5 @@ const refreshAuthTokensFunction: TokenRefresher = async ({
 	};
 };
 
-export const refreshAuthTokens = deDupeAsyncFunction(refreshAuthTokensFunction);
-export const refreshAuthTokensWithoutDedupe = refreshAuthTokensFunction;
+export const createAuthTokenRefresher = () =>
+	dedupeAsyncFunction(refreshAuthTokens);
diff --git a/...__tests__/adapterCore/authProvidersFactories/cognito/createUserPoolsTokenProvider.test.ts b/...__tests__/adapterCore/authProvidersFactories/cognito/createUserPoolsTokenProvider.test.ts
@@ -4,7 +4,7 @@
 import {
 	DefaultTokenStore,
 	TokenOrchestrator,
-	refreshAuthTokensWithoutDedupe,
+	createAuthTokenRefresher,
 } from '@aws-amplify/auth/cognito';
 import { AuthConfig, KeyValueStorageInterface } from '@aws-amplify/core';
 
@@ -27,10 +27,16 @@ const mockAuthConfig: AuthConfig = {
 };
 const MockDefaultTokenStore = DefaultTokenStore as jest.Mock;
 const MockTokenOrchestrator = TokenOrchestrator as jest.Mock;
-const mockRefreshAuthTokens = refreshAuthTokensWithoutDedupe as jest.Mock;
+const mockCreateAuthTokenRefresher = createAuthTokenRefresher as jest.Mock;
 
 describe('createUserPoolsTokenProvider', () => {
+	const mockRefreshTokenFunc = jest.fn();
+
 	beforeEach(() => {
+		mockCreateAuthTokenRefresher.mockReturnValue(mockRefreshTokenFunc);
+	});
+
+	afterEach(() => {
 		jest.resetAllMocks();
 	});
 
@@ -60,7 +66,7 @@ describe('createUserPoolsTokenProvider', () => {
 		).toHaveBeenCalledWith(mockTokenStoreInstance);
 		expect(
 			mockTokenOrchestratorInstance.setTokenRefresher,
-		).toHaveBeenCalledWith(mockRefreshAuthTokens);
+		).toHaveBeenCalledWith(mockRefreshTokenFunc);
 
 		expect(tokenProvider).toBeDefined();
 	});

diff --git a/packages/aws-amplify/__tests__/exports.test.ts b/packages/aws-amplify/__tests__/exports.test.ts
@@ -218,8 +218,7 @@ describe('aws-amplify Exports', () => {
 					'DefaultIdentityIdStore',
 					'TokenOrchestrator',
 					'DefaultTokenStore',
-					'refreshAuthTokens',
-					'refreshAuthTokensWithoutDedupe',
+					'createAuthTokenRefresher',
 				].sort(),
 			);
 		});

diff --git a/...s-amplify/src/adapter-core/authProvidersFactories/cognito/createUserPoolsTokenProvider.ts b/...s-amplify/src/adapter-core/authProvidersFactories/cognito/createUserPoolsTokenProvider.ts
@@ -4,7 +4,7 @@
 import {
 	DefaultTokenStore,
 	TokenOrchestrator,
-	refreshAuthTokensWithoutDedupe,
+	createAuthTokenRefresher,
 } from '@aws-amplify/auth/cognito';
 import {
 	AuthConfig,
@@ -28,7 +28,7 @@ export const createUserPoolsTokenProvider = (
 	const tokenOrchestrator = new TokenOrchestrator();
 	tokenOrchestrator.setAuthConfig(authConfig);
 	tokenOrchestrator.setAuthTokenStore(authTokenStore);
-	tokenOrchestrator.setTokenRefresher(refreshAuthTokensWithoutDedupe);
+	tokenOrchestrator.setTokenRefresher(createAuthTokenRefresher());
 
 	return {
 		getTokens: ({ forceRefresh } = { forceRefresh: false }) =>

diff --git a/packages/core/__tests__/utils/deDupeAsyncRequests.test.ts b/packages/core/__tests__/utils/deDupeAsyncRequests.test.ts
@@ -1,4 +1,4 @@
-import { deDupeAsyncFunction } from '../../src/utils/deDupeAsyncFunction';
+import { dedupeAsyncFunction } from '../../src/utils/dedupeAsyncFunction';
 
 describe('dedupeAsyncFunction()', () => {
 	const numberOfConcurrentCalls = 10;
@@ -13,28 +13,28 @@ describe('dedupeAsyncFunction()', () => {
 	});
 
 	it('should invoke the mockServiceFunction', async () => {
-		const deDupedFunction = deDupeAsyncFunction(mockServiceFunction);
+		const deDupedFunction = dedupeAsyncFunction(mockServiceFunction);
 
 		deDupedFunction();
 		expect(mockServiceFunction).toHaveBeenCalledTimes(1);
 	});
 
 	it('should invoke the mockServiceFunction one time during concurrent sync calls', () => {
-		const deDupedFunction = deDupeAsyncFunction(mockServiceFunction);
+		const deDupedFunction = dedupeAsyncFunction(mockServiceFunction);
 		for (let i = 0; i < numberOfConcurrentCalls; i++) {
 			deDupedFunction();
 		}
 		expect(mockServiceFunction).toHaveBeenCalledTimes(1);
 	});
 
 	it('should return a value once the mockServiceFunction is resolved', async () => {
-		const deDupedFunction = deDupeAsyncFunction(mockServiceFunction);
+		const deDupedFunction = dedupeAsyncFunction(mockServiceFunction);
 		expect(await deDupedFunction()).toEqual(mockReturnValue);
 		expect(mockServiceFunction).toHaveBeenCalledTimes(1);
 	});
 
 	it('should allow to invoke the mockServiceFunction again after the promise has being resolved', async () => {
-		const deDupedFunction = deDupeAsyncFunction(mockServiceFunction);
+		const deDupedFunction = dedupeAsyncFunction(mockServiceFunction);
 		for (let i = 0; i < numberOfConcurrentCalls; i++) {
 			expect(deDupedFunction()).toBeInstanceOf(Promise);
 		}

diff --git a/packages/core/src/libraryUtils.ts b/packages/core/src/libraryUtils.ts
@@ -18,7 +18,7 @@ export {
 	retry,
 	urlSafeDecode,
 	urlSafeEncode,
-	deDupeAsyncFunction,
+	dedupeAsyncFunction,
 } from './utils';
 export { parseAWSExports } from './parseAWSExports';
 export { isAmplifyOutputs, parseAmplifyOutputs } from './parseAmplifyOutputs';

diff --git a/...ges/core/src/utils/deDupeAsyncFunction.ts → ...ges/core/src/utils/dedupeAsyncFunction.ts b/...ges/core/src/utils/deDupeAsyncFunction.ts → ...ges/core/src/utils/dedupeAsyncFunction.ts
@@ -7,7 +7,7 @@
  * @param asyncFunction - asyncFunction to be deduped.
  * @returns - the return type of the callback
  */
-export const deDupeAsyncFunction = <A extends any[], R>(
+export const dedupeAsyncFunction = <A extends any[], R>(
 	asyncFunction: (...args: A) => Promise<R>,
 ) => {
 	let inflightPromise: Promise<R> | undefined;

diff --git a/packages/core/src/utils/index.ts b/packages/core/src/utils/index.ts
@@ -15,4 +15,4 @@ export {
 export { urlSafeDecode } from './urlSafeDecode';
 export { urlSafeEncode } from './urlSafeEncode';
 export { deepFreeze } from './deepFreeze';
-export { deDupeAsyncFunction } from './deDupeAsyncFunction';
+export { dedupeAsyncFunction } from './dedupeAsyncFunction';