fix: (14277) Unable to override options when calling events.connect and subscribe (#14278)

* fix: (14277) Unable to override options when calling `events.connect` and `subscribe`

This fixes issue where overriding options are not applied to methods`events.connect` and `subscribe`.

fixes: 14277

* refactor: Adopt more explicit auth assignment, extend to cover apiKeys and fix types

* fix: Add support for both post and publish

---------

Co-authored-by: Aaron S. <94858815+stocaaro@users.noreply.github.com>
Co-authored-by: Aaron S <stocaaro@stocad.com>

Author: rsmogura

packages/api-graphql/__tests__/events.test.ts

@@ -100,13 +100,13 @@ describe('Events client', () => {
 			});
 		});
 
-		const authModes: GraphQLAuthMode[] = [
-			'apiKey',
-			'userPool',
-			'oidc',
-			'iam',
-			'lambda',
-			'none',
+		const authModeConfigs: { authMode: GraphQLAuthMode, apiKey?: string, authToken?: string }[] = [
+			{ authMode: 'apiKey', apiKey: 'testAPIKey' },
+			{ authMode: 'userPool', authToken: 'userPoolToken' },
+			{ authMode: 'oidc', authToken: 'oidcToken' },
+			{ authMode: 'iam', authToken: 'iamToken' },
+			{ authMode: 'lambda', authToken: 'lambdaToken' },
+			{ authMode: 'none' },
 		];
 
 		describe('channel', () => {
@@ -124,12 +124,16 @@ describe('Events client', () => {
 					mockProvider = AppSyncEventProvider;
 				});
 
-				for (const authMode of authModes) {
-					test(`auth override: ${authMode}`, async () => {
-						await events.connect('/', { authMode });
+				for (const authConfig of authModeConfigs) {
+					const {authMode: authenticationType, ...config} = authConfig
+					test(`connect auth override: ${authConfig.authMode}`, async () => {
+						const channel = await events.connect('/', authConfig);
 
 						expect(mockProvider.connect).toHaveBeenCalledWith(
-							expect.objectContaining({ authenticationType: authMode }),
+							expect.objectContaining({
+								authenticationType,
+								...config
+							}),
 						);
 					});
 				}
@@ -153,20 +157,24 @@ describe('Events client', () => {
 					mockProvider = AppSyncEventProvider;
 				});
 
-				for (const authMode of authModes) {
-					test(`auth override: ${authMode}`, async () => {
-						const channel = await events.connect('/');
+				for (const authConfig of authModeConfigs) {
+					const {authMode: authenticationType, ...config} = authConfig
 
-						channel.subscribe(
+					test(`subscription auth override: ${authConfig.authMode}`, async () => {
+						const channel = await events.connect('/');
+						channel.subscribe( 
 							{
 								next: data => void data,
 								error: error => void error,
 							},
-							{ authMode },
-						);
-
-						expect(mockSubscribeObservable).toHaveBeenCalledWith(
-							expect.objectContaining({ authenticationType: authMode }),
+							authConfig
+						)
+
+						expect(mockProvider.subscribe).toHaveBeenCalledWith(
+							expect.objectContaining({
+								authenticationType,
+								...config
+							}),
 						);
 					});
 				}
@@ -195,14 +203,21 @@ describe('Events client', () => {
 					mockProvider = AppSyncEventProvider;
 				});
 
-				for (const authMode of authModes) {
-					test(`auth override: ${authMode}`, async () => {
-						const channel = await events.connect('/');
+				for (const authConfig of authModeConfigs) {
+					const {authMode: authenticationType, ...config} = authConfig
 
-						channel.publish({ some: 'data' }, { authMode });
+					test(`publish auth override: ${authConfig.authMode}`, async () => {
+						const channel = await events.connect('/');
+						channel.publish( 
+							"Test message",
+							authConfig
+						)
 
 						expect(mockProvider.publish).toHaveBeenCalledWith(
-							expect.objectContaining({ authenticationType: authMode }),
+							expect.objectContaining({
+								authenticationType,
+								...config
+							}),
 						);
 					});
 				}
@@ -230,16 +245,19 @@ describe('Events client', () => {
 				);
 			});
 
-			for (const authMode of authModes) {
-				test(`auth override: ${authMode}`, async () => {
-					await events.post('/', { test: 'data' }, { authMode });
+			for (const authConfig of authModeConfigs) {
+				const {authMode: authenticationType, ...config} = authConfig
+
+				test(`auth override: ${authenticationType}`, async () => {
+					await events.post('/', { test: 'data' }, authConfig);
 
 					expect(mockReq).toHaveBeenCalledWith(
 						Amplify,
 						expect.objectContaining({
 							query: '/',
 							variables: ['{"test":"data"}'],
-							authenticationType: authMode,
+							authenticationType,
+							...config
 						}),
 						{},
 						abortController,

packages/api-graphql/src/internals/events/index.ts

@@ -12,6 +12,7 @@ import { configure, normalizeAuth, serializeEvents } from './utils';
 import type {
 	EventsChannel,
 	EventsOptions,
+	ProviderOptions,
 	PublishResponse,
 	PublishedEvent,
 	SubscriptionObserver,
@@ -44,12 +45,14 @@ async function connect(
 	channel: string,
 	options?: EventsOptions,
 ): Promise<EventsChannel> {
-	const providerOptions = configure();
+	const providerOptions: ProviderOptions = configure();
 
 	providerOptions.authenticationType = normalizeAuth(
 		options?.authMode,
 		providerOptions.authenticationType,
 	);
+	providerOptions.apiKey = options?.apiKey || providerOptions.apiKey;
+	providerOptions.authToken = options?.authToken || providerOptions.authToken;
 
 	await eventProvider.connect(providerOptions);
 
@@ -70,6 +73,9 @@ async function connect(
 			subOptions?.authMode,
 			subscribeOptions.authenticationType,
 		);
+		subscribeOptions.apiKey = subOptions?.apiKey || subscribeOptions.apiKey;
+		subscribeOptions.authToken =
+			subOptions?.authToken || subscribeOptions.authToken;
 
 		_subscription = eventProvider
 			.subscribe(subscribeOptions)
@@ -94,6 +100,9 @@ async function connect(
 			pubOptions?.authMode,
 			publishOptions.authenticationType,
 		);
+		publishOptions.apiKey = pubOptions?.apiKey || publishOptions.apiKey;
+		publishOptions.authToken =
+			pubOptions?.authToken || publishOptions.authToken;
 
 		return eventProvider.publish(publishOptions);
 	};
@@ -141,11 +150,13 @@ async function post(
 	event: DocumentType | DocumentType[],
 	options?: EventsOptions,
 ): Promise<void | PublishedEvent[]> {
-	const providerOptions = configure();
+	const providerOptions: ProviderOptions = configure();
 	providerOptions.authenticationType = normalizeAuth(
 		options?.authMode,
 		providerOptions.authenticationType,
 	);
+	providerOptions.apiKey = options?.apiKey || providerOptions.apiKey;
+	providerOptions.authToken = options?.authToken || providerOptions.authToken;
 
 	// trailing slash required in publish
 	const normalizedChannelName = channel[0] === '/' ? channel : `/${channel}`;
@@ -154,7 +165,6 @@ async function post(
 		...providerOptions,
 		query: normalizedChannelName,
 		variables: serializeEvents(event),
-		authToken: options?.authToken,
 	};
 
 	const abortController = new AbortController();

packages/api-graphql/src/internals/events/types.ts

@@ -84,6 +84,7 @@ export type ResolvedGraphQLAuthModes = Exclude<GraphQLAuthMode, 'identityPool'>;
 export interface EventsOptions {
 	authMode?: GraphQLAuthMode;
 	authToken?: string;
+	apiKey?: string;
 }
 
 export interface PublishedEvent {
@@ -95,3 +96,14 @@ export interface PublishResponse {
 	failed: PublishedEvent[];
 	successful: PublishedEvent[];
 }
+
+interface EventsConfigure {
+	appSyncGraphqlEndpoint: string;
+	region?: string;
+	authenticationType: ResolvedGraphQLAuthModes;
+	apiKey?: string;
+}
+
+export type ProviderOptions = EventsConfigure & {
+	authToken?: string;
+};