chore: adding warnings regarding using custom endpoints

Author: HuiSF

packages/core/__tests__/singleton/Auth/index.test.ts

@@ -0,0 +1,52 @@
+import { ConsoleLogger } from '../../../src/Logger';
+import { AuthClass } from '../../../src/singleton/Auth';
+
+jest.mock('../../../src/Logger', () => {
+	const warn = jest.fn();
+
+	return {
+		ConsoleLogger: jest.fn(() => ({
+			warn,
+		})),
+	};
+});
+
+describe('Auth', () => {
+	const auth = new AuthClass();
+	const logger = new ConsoleLogger('Auth');
+	const mockedWarn = logger.warn as jest.Mock;
+
+	describe('configure', () => {
+		const mockConfig = {
+			userPoolClientId: 'userPoolClientId',
+			userPoolId: 'userPoolId',
+		};
+
+		it('prints warning when use custom endpoint for Cognito User Pool', () => {
+			auth.configure({
+				Cognito: {
+					...mockConfig,
+					userPoolEndpoint: 'https://custom-endpoint.com',
+				},
+			});
+
+			expect(mockedWarn).toHaveBeenCalledWith(
+				expect.stringContaining('Amazon Cognito User Pool'),
+			);
+		});
+
+		it('prints warning when use custom endpoint for Cognito Identity Pool', () => {
+			auth.configure({
+				Cognito: {
+					...mockConfig,
+					identityPoolId: 'identityPoolId',
+					identityPoolEndpoint: 'https://custom-endpoint.com',
+				},
+			});
+
+			expect(mockedWarn).toHaveBeenCalledWith(
+				expect.stringContaining('Amazon Cognito Identity Pool'),
+			);
+		});
+	});
+});

packages/core/src/singleton/Auth/index.ts

@@ -1,5 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
+import { ConsoleLogger } from '../../Logger';
+
 import {
 	AuthConfig,
 	AuthSession,
@@ -9,6 +11,8 @@ import {
 	LibraryAuthOptions,
 } from './types';
 
+const logger = new ConsoleLogger('Auth');
+
 export function isTokenExpired({
 	expiresAt,
 	clockDrift,
@@ -41,6 +45,19 @@ export class AuthClass {
 	): void {
 		this.authConfig = authResourcesConfig;
 		this.authOptions = authOptions;
+
+		if (authResourcesConfig && authResourcesConfig.Cognito?.userPoolEndpoint) {
+			logger.warn(getCustomEndpointWarningMessage('Amazon Cognito User Pool'));
+		}
+
+		if (
+			authResourcesConfig &&
+			authResourcesConfig.Cognito?.identityPoolEndpoint
+		) {
+			logger.warn(
+				getCustomEndpointWarningMessage('Amazon Cognito Identity Pool'),
+			);
+		}
 	}
 
 	/**
@@ -106,3 +123,6 @@ export class AuthClass {
 		);
 	}
 }
+
+const getCustomEndpointWarningMessage = (target: string): string =>
+	`You are using a custom Amazon ${target} endpoint, ensure the endpoint is correct.`;

packages/core/src/singleton/Auth/types.ts

@@ -135,6 +135,9 @@ export interface AuthIdentityPoolConfig {
 
 export interface CognitoIdentityPoolConfig {
 	identityPoolId: string;
+	/**
+	 * Use this field to specify a custom endpoint for the Amazon Cognito identity pool. Ensure this endpoint is correct and valid.
+	 */
 	identityPoolEndpoint?: string;
 	allowGuestAccess?: boolean;
 }
@@ -152,6 +155,9 @@ export type CognitoUserPoolConfigMfaStatus = 'on' | 'off' | 'optional';
 export interface CognitoUserPoolConfig {
 	userPoolClientId: string;
 	userPoolId: string;
+	/**
+	 * Use this field to specify a custom endpoint for the Amazon Cognito user pool. Ensure this endpoint is correct and valid.
+	 */
 	userPoolEndpoint?: string;
 	signUpVerificationMethod?: 'code' | 'link';
 	loginWith?: {