release(required): Amplify JS release

.github/integ-config/integ-all.yml

@@ -1011,3 +1011,12 @@ tests:
     browser: [chrome]
     env:
       NEXT_PUBLIC_BACKEND_CONFIG: pwl-webauthn
+  - test_name: integ_next_refresh_token_auth
+    desc: 'refresh token auth'
+    framework: next
+    category: auth
+    sample_name: [mfa]
+    spec: refresh-token-auth
+    browser: *minimal_browser_list
+    env:
+      NEXT_PUBLIC_BACKEND_CONFIG: misc-tokenref

packages/adapter-nextjs/src/api/generateServerClient.ts

@@ -12,9 +12,10 @@ import {
 	V6ClientSSRRequest,
 } from '@aws-amplify/api-graphql';
 import {
-	GraphQLAuthMode,
-	parseAmplifyConfig,
-} from '@aws-amplify/core/internals/utils';
+	CommonPublicClientOptions,
+	DefaultCommonClientOptions,
+} from '@aws-amplify/api-graphql/internals';
+import { parseAmplifyConfig } from '@aws-amplify/core/internals/utils';
 
 import { NextServer } from '../types';
 
@@ -23,14 +24,10 @@ import { createServerRunnerForAPI } from './createServerRunnerForAPI';
 interface CookiesClientParams {
 	cookies: NextServer.ServerComponentContext['cookies'];
 	config: NextServer.CreateServerRunnerInput['config'];
-	authMode?: GraphQLAuthMode;
-	authToken?: string;
 }
 
 interface ReqClientParams {
 	config: NextServer.CreateServerRunnerInput['config'];
-	authMode?: GraphQLAuthMode;
-	authToken?: string;
 }
 
 /**
@@ -44,13 +41,10 @@ interface ReqClientParams {
  */
 export function generateServerClientUsingCookies<
 	T extends Record<any, any> = never,
->({
-	config,
-	cookies,
-	authMode,
-	authToken,
-}: CookiesClientParams): V6ClientSSRCookies<T> {
-	if (typeof cookies !== 'function') {
+	Options extends CommonPublicClientOptions &
+		CookiesClientParams = DefaultCommonClientOptions & CookiesClientParams,
+>(options: Options): V6ClientSSRCookies<T, Options> {
+	if (typeof options.cookies !== 'function') {
 		throw new AmplifyServerContextError({
 			message:
 				'generateServerClientUsingCookies is only compatible with the `cookies` Dynamic Function available in Server Components.',
@@ -61,24 +55,25 @@ export function generateServerClientUsingCookies<
 	}
 
 	const { runWithAmplifyServerContext, resourcesConfig } =
-		createServerRunnerForAPI({ config });
+		createServerRunnerForAPI({ config: options.config });
 
 	// This function reference gets passed down to InternalGraphQLAPI.ts.graphql
 	// where this._graphql is passed in as the `fn` argument
 	// causing it to always get invoked inside `runWithAmplifyServerContext`
 	const getAmplify = (fn: (amplify: any) => Promise<any>) =>
 		runWithAmplifyServerContext({
-			nextServerContext: { cookies },
+			nextServerContext: { cookies: options.cookies },
 			operation: contextSpec =>
 				fn(getAmplifyServerContext(contextSpec).amplify),
 		});
 
-	return generateClientWithAmplifyInstance<T, V6ClientSSRCookies<T>>({
+	const { cookies: _cookies, config: _config, ...params } = options;
+
+	return generateClientWithAmplifyInstance<T, V6ClientSSRCookies<T, Options>>({
 		amplify: getAmplify,
 		config: resourcesConfig,
-		authMode,
-		authToken,
-	});
+		...params,
+	} as any); // TS can't narrow the type here.
 }
 
 /**
@@ -99,12 +94,15 @@ export function generateServerClientUsingCookies<
  */
 export function generateServerClientUsingReqRes<
 	T extends Record<any, any> = never,
->({ config, authMode, authToken }: ReqClientParams): V6ClientSSRRequest<T> {
-	const amplifyConfig = parseAmplifyConfig(config);
+	Options extends CommonPublicClientOptions &
+		ReqClientParams = DefaultCommonClientOptions & ReqClientParams,
+>(options: Options): V6ClientSSRRequest<T, Options> {
+	const amplifyConfig = parseAmplifyConfig(options.config);
+
+	const { config: _config, ...params } = options;
 
 	return generateClient<T>({
 		config: amplifyConfig,
-		authMode,
-		authToken,
-	});
+		...params,
+	}) as any;
 }

packages/api-graphql/__tests__/internals/generateClient.test.ts

@@ -270,7 +270,14 @@ describe('generateClient', () => {
 			const client = generateClient<Schema>({ amplify: Amplify });
 
 			const spy = jest.fn(() => from([graphqlMessage]));
-			(raw.GraphQLAPI as any).appSyncRealTime = { subscribe: spy };
+			(raw.GraphQLAPI as any).appSyncRealTime = {
+				get() {
+					return { subscribe: spy }
+				},
+				set() {
+					// not needed for test mock
+				}
+			};
 
 			expect(normalizePostGraphqlCalls(spy)).toMatchSnapshot();
 
@@ -497,7 +504,14 @@ describe('generateClient', () => {
 				const client = generateClient<Schema>({ amplify: Amplify });
 
 				const spy = jest.fn(() => from([graphqlMessage]));
-				(raw.GraphQLAPI as any).appSyncRealTime = { subscribe: spy };
+				(raw.GraphQLAPI as any).appSyncRealTime = {
+					get() {
+						return { subscribe: spy }
+					},
+					set() {
+						// not needed for test mock
+					}
+				};
 
 				client.models.Note.onCreate({
 					filter: graphqlVariables.filter,
@@ -531,7 +545,14 @@ describe('generateClient', () => {
 				});
 
 				const spy = jest.fn(() => from([graphqlMessage]));
-				(raw.GraphQLAPI as any).appSyncRealTime = { subscribe: spy };
+				(raw.GraphQLAPI as any).appSyncRealTime = {
+					get() {
+						return { subscribe: spy }
+					},
+					set() {
+						// not needed for test mock
+					}
+				};
 
 				client.models.Note.onCreate({
 					filter: graphqlVariables.filter,
@@ -561,7 +582,14 @@ describe('generateClient', () => {
 				const client = generateClient<Schema>({ amplify: Amplify });
 
 				const spy = jest.fn(() => from([graphqlMessage]));
-				(raw.GraphQLAPI as any).appSyncRealTime = { subscribe: spy };
+				(raw.GraphQLAPI as any).appSyncRealTime = {
+					get() {
+						return { subscribe: spy }
+					},
+					set() {
+						// not needed for test mock
+					}
+				};
 
 				client.models.Note.onCreate({
 					filter: graphqlVariables.filter,
@@ -583,7 +611,14 @@ describe('generateClient', () => {
 				const client = generateClient<Schema>({ amplify: Amplify });
 
 				const spy = jest.fn(() => from([graphqlMessage]));
-				(raw.GraphQLAPI as any).appSyncRealTime = { subscribe: spy };
+				(raw.GraphQLAPI as any).appSyncRealTime = {
+					get() {
+						return { subscribe: spy }
+					},
+					set() {
+						// not needed for test mock
+					}
+				};
 
 				client.models.Note.onCreate({
 					filter: graphqlVariables.filter,
@@ -711,7 +746,14 @@ describe('generateClient', () => {
 			const client = generateClient<Schema>({ amplify: Amplify });
 
 			const spy = jest.fn(() => from([graphqlMessage]));
-			(raw.GraphQLAPI as any).appSyncRealTime = { subscribe: spy };
+			(raw.GraphQLAPI as any).appSyncRealTime = {
+				get() {
+					return { subscribe: spy }
+				},
+				set() {
+					// not needed for test mock
+				}
+			};
 
 			client.models.Note.onCreate({
 				filter: graphqlVariables.filter,

packages/api-graphql/src/internals/InternalGraphQLAPI.ts

@@ -52,7 +52,7 @@ export class InternalGraphQLAPIClass {
 	/**
 	 * @private
 	 */
-	private appSyncRealTime = new AWSAppSyncRealTimeProvider();
+	private appSyncRealTime = new Map<string, AWSAppSyncRealTimeProvider>();
 
 	private _api = {
 		post,
@@ -88,7 +88,14 @@ export class InternalGraphQLAPIClass {
 		amplify:
 			| AmplifyClassV6
 			| ((fn: (amplify: any) => Promise<any>) => Promise<AmplifyClassV6>),
-		{ query: paramQuery, variables = {}, authMode, authToken }: GraphQLOptions,
+		{
+			query: paramQuery,
+			variables = {},
+			authMode,
+			authToken,
+			endpoint,
+			apiKey,
+		}: GraphQLOptions,
 		additionalHeaders?: CustomHeaders,
 		customUserAgentDetails?: CustomUserAgentDetails,
 	): Observable<GraphQLResult<T>> | Promise<GraphQLResult<T>> {
@@ -115,7 +122,7 @@ export class InternalGraphQLAPIClass {
 				if (isAmplifyInstance(amplify)) {
 					responsePromise = this._graphql<T>(
 						amplify,
-						{ query, variables, authMode },
+						{ query, variables, authMode, apiKey, endpoint },
 						headers,
 						abortController,
 						customUserAgentDetails,
@@ -127,7 +134,7 @@ export class InternalGraphQLAPIClass {
 					const wrapper = async (amplifyInstance: AmplifyClassV6) => {
 						const result = await this._graphql<T>(
 							amplifyInstance,
-							{ query, variables, authMode },
+							{ query, variables, authMode, apiKey, endpoint },
 							headers,
 							abortController,
 							customUserAgentDetails,
@@ -152,7 +159,7 @@ export class InternalGraphQLAPIClass {
 			case 'subscription':
 				return this._graphqlSubscribe(
 					amplify as AmplifyClassV6,
-					{ query, variables, authMode },
+					{ query, variables, authMode, apiKey, endpoint },
 					headers,
 					customUserAgentDetails,
 					authToken,
@@ -164,7 +171,13 @@ export class InternalGraphQLAPIClass {
 
 	private async _graphql<T = any>(
 		amplify: AmplifyClassV6,
-		{ query, variables, authMode: explicitAuthMode }: GraphQLOptions,
+		{
+			query,
+			variables,
+			authMode: authModeOverride,
+			endpoint: endpointOverride,
+			apiKey: apiKeyOverride,
+		}: GraphQLOptions,
 		additionalHeaders: CustomHeaders = {},
 		abortController: AbortController,
 		customUserAgentDetails?: CustomUserAgentDetails,
@@ -179,7 +192,7 @@ export class InternalGraphQLAPIClass {
 			defaultAuthMode,
 		} = resolveConfig(amplify);
 
-		const initialAuthMode = explicitAuthMode || defaultAuthMode || 'iam';
+		const initialAuthMode = authModeOverride || defaultAuthMode || 'iam';
 		// identityPool is an alias for iam. TODO: remove 'iam' in v7
 		const authMode =
 			initialAuthMode === 'identityPool' ? 'iam' : initialAuthMode;
@@ -205,7 +218,7 @@ export class InternalGraphQLAPIClass {
 			const requestOptions: RequestOptions = {
 				method: 'POST',
 				url: new AmplifyUrl(
-					customEndpoint || appSyncGraphqlEndpoint || '',
+					endpointOverride || customEndpoint || appSyncGraphqlEndpoint || '',
 				).toString(),
 				queryString: print(query as DocumentNode),
 			};
@@ -226,7 +239,7 @@ export class InternalGraphQLAPIClass {
 		const authHeaders = await headerBasedAuth(
 			amplify,
 			authMode,
-			apiKey,
+			apiKeyOverride ?? apiKey,
 			additionalCustomHeaders,
 		);
 
@@ -282,7 +295,8 @@ export class InternalGraphQLAPIClass {
 			};
 		}
 
-		const endpoint = customEndpoint || appSyncGraphqlEndpoint;
+		const endpoint =
+			endpointOverride || customEndpoint || appSyncGraphqlEndpoint;
 
 		if (!endpoint) {
 			throw createGraphQLResultWithError<T>(new GraphQLApiError(NO_ENDPOINT));
@@ -341,15 +355,21 @@ export class InternalGraphQLAPIClass {
 
 	private _graphqlSubscribe(
 		amplify: AmplifyClassV6,
-		{ query, variables, authMode: explicitAuthMode }: GraphQLOptions,
+		{
+			query,
+			variables,
+			authMode: authModeOverride,
+			apiKey: apiKeyOverride,
+			endpoint,
+		}: GraphQLOptions,
 		additionalHeaders: CustomHeaders = {},
 		customUserAgentDetails?: CustomUserAgentDetails,
 		authToken?: string,
 	): Observable<any> {
 		const config = resolveConfig(amplify);
 
 		const initialAuthMode =
-			explicitAuthMode || config?.defaultAuthMode || 'iam';
+			authModeOverride || config?.defaultAuthMode || 'iam';
 		// identityPool is an alias for iam. TODO: remove 'iam' in v7
 		const authMode =
 			initialAuthMode === 'identityPool' ? 'iam' : initialAuthMode;
@@ -364,15 +384,26 @@ export class InternalGraphQLAPIClass {
 		 */
 		const { headers: libraryConfigHeaders } = resolveLibraryOptions(amplify);
 
-		return this.appSyncRealTime
+		const appSyncGraphqlEndpoint = endpoint ?? config?.endpoint;
+
+		// TODO: This could probably be an exception. But, lots of tests rely on
+		// attempting to connect to nowhere. So, I'm treating as the opposite of
+		// a Chesterton's fence for now. (A fence I shouldn't build, because I don't
+		// know why somethings depends on its absence!)
+		const memoKey = appSyncGraphqlEndpoint ?? 'none';
+		const realtimeProvider =
+			this.appSyncRealTime.get(memoKey) ?? new AWSAppSyncRealTimeProvider();
+		this.appSyncRealTime.set(memoKey, realtimeProvider);
+
+		return realtimeProvider
 			.subscribe(
 				{
 					query: print(query as DocumentNode),
 					variables,
-					appSyncGraphqlEndpoint: config?.endpoint,
+					appSyncGraphqlEndpoint,
 					region: config?.region,
 					authenticationType: authMode,
-					apiKey: config?.apiKey,
+					apiKey: apiKeyOverride ?? config?.apiKey,
 					additionalHeaders,
 					authToken,
 					libraryConfigHeaders,