@aws-amplify/api-graphql 4.4.0 → 4.4.1-events.619318.0

package/src/Providers/AWSAppSyncEventsProvider/index.ts

@@ -0,0 +1,187 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import {
+	CustomUserAgentDetails,
+	DocumentType,
+	GraphQLAuthMode,
+	USER_AGENT_HEADER,
+	getAmplifyUserAgent,
+} from '@aws-amplify/core/internals/utils';
+import { CustomHeaders } from '@aws-amplify/data-schema/runtime';
+
+import { MESSAGE_TYPES } from '../constants';
+import { AWSWebSocketProvider } from '../AWSWebSocketProvider';
+import { awsRealTimeHeaderBasedAuth } from '../AWSWebSocketProvider/authHeaders';
+
+// resolved/actual AuthMode values. identityPool gets resolves to IAM upstream in InternalGraphQLAPI._graphqlSubscribe
+type ResolvedGraphQLAuthModes = Exclude<GraphQLAuthMode, 'identityPool'>;
+
+interface AWSAppSyncEventProviderOptions {
+	appSyncGraphqlEndpoint?: string;
+	authenticationType?: ResolvedGraphQLAuthModes;
+	query?: string;
+	variables?: DocumentType;
+	apiKey?: string;
+	region?: string;
+	libraryConfigHeaders?(): Promise<Record<string, unknown> | Headers>;
+	additionalHeaders?: CustomHeaders;
+	additionalCustomHeaders?: Record<string, string>;
+	authToken?: string;
+}
+
+interface DataPayload {
+	id: string;
+	event: string;
+	type: string;
+}
+
+interface DataResponse {
+	id: string;
+	payload: string;
+	type: string;
+}
+
+const PROVIDER_NAME = 'AWSAppSyncEventsProvider';
+
+class AWSAppSyncEventProvider extends AWSWebSocketProvider {
+	constructor() {
+		super(PROVIDER_NAME);
+	}
+
+	public async connect(options: AWSAppSyncEventProviderOptions) {
+		super.connect(options);
+	}
+
+	public subscribe(
+		options?: AWSAppSyncEventProviderOptions,
+		customUserAgentDetails?: CustomUserAgentDetails,
+	) {
+		return super.subscribe(options, customUserAgentDetails).pipe();
+	}
+
+	public async publish(
+		options: AWSAppSyncEventProviderOptions,
+		customUserAgentDetails?: CustomUserAgentDetails,
+	) {
+		super.publish(options, customUserAgentDetails);
+	}
+
+	protected async _prepareSubscriptionPayload({
+		options,
+		subscriptionId,
+		customUserAgentDetails,
+		additionalCustomHeaders,
+		libraryConfigHeaders,
+		publish,
+	}: {
+		options: AWSAppSyncEventProviderOptions;
+		subscriptionId: string;
+		customUserAgentDetails: CustomUserAgentDetails | undefined;
+		additionalCustomHeaders: Record<string, string>;
+		libraryConfigHeaders: Record<string, string>;
+		publish?: boolean;
+	}): Promise<string> {
+		const {
+			appSyncGraphqlEndpoint,
+			authenticationType,
+			query,
+			variables,
+			apiKey,
+			region,
+		} = options;
+
+		// This will be needed for WS publish
+		// const data = {
+		// 	events: [variables],
+		// };
+
+		const serializedData = JSON.stringify([variables]);
+
+		const headers = {
+			...(await awsRealTimeHeaderBasedAuth({
+				apiKey,
+				appSyncGraphqlEndpoint,
+				authenticationType,
+				payload: serializedData,
+				canonicalUri: '',
+				region,
+				additionalCustomHeaders,
+			})),
+			...libraryConfigHeaders,
+			...additionalCustomHeaders,
+			[USER_AGENT_HEADER]: getAmplifyUserAgent(customUserAgentDetails),
+		};
+
+		// Commented out code will be needed for WS publish
+		const subscriptionMessage = {
+			id: subscriptionId,
+			channel: query,
+			// events: [JSON.stringify(variables)],
+			authorization: {
+				...headers,
+			},
+			// payload: {
+			// 	events: serializedData,
+			// 	extensions: {
+			// 		authorization: {
+			// 			...headers,
+			// 		},
+			// 	},
+			// },
+			type: publish
+				? MESSAGE_TYPES.EVENT_PUBLISH
+				: MESSAGE_TYPES.EVENT_SUBSCRIBE,
+		};
+
+		const serializedSubscriptionMessage = JSON.stringify(subscriptionMessage);
+
+		return serializedSubscriptionMessage;
+	}
+
+	protected _handleSubscriptionData(
+		message: MessageEvent,
+	): [boolean, DataResponse] {
+		this.logger.debug(
+			`subscription message from AWS AppSync Events: ${message.data}`,
+		);
+
+		const {
+			id = '',
+			event: payload,
+			type,
+		}: DataPayload = JSON.parse(String(message.data));
+
+		const {
+			observer = null,
+			query = '',
+			variables = {},
+		} = this.subscriptionObserverMap.get(id) || {};
+
+		this.logger.debug({ id, observer, query, variables });
+
+		if (type === MESSAGE_TYPES.DATA && payload) {
+			const deserializedEvent = JSON.parse(payload);
+			if (observer) {
+				observer.next(deserializedEvent);
+			} else {
+				this.logger.debug(`observer not found for id: ${id}`);
+			}
+
+			return [true, { id, type, payload: deserializedEvent }];
+		}
+
+		return [false, { id, type, payload }];
+	}
+
+	protected _unsubscribeMessage(subscriptionId: string): {
+		id: string;
+		type: string;
+	} {
+		return {
+			id: subscriptionId,
+			type: MESSAGE_TYPES.EVENT_STOP,
+		};
+	}
+}
+
+export const AppSyncEventProvider = new AWSAppSyncEventProvider();