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

package/src/Providers/AWSAppSyncRealTimeProvider/index.ts

@@ -1,107 +1,27 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { Observable, SubscriptionLike } from 'rxjs';
-import { GraphQLError } from 'graphql';
-import {
-	ConsoleLogger,
-	Hub,
-	HubPayload,
-	fetchAuthSession,
-} from '@aws-amplify/core';
-import { signRequest } from '@aws-amplify/core/internals/aws-client-utils';
+
 import {
-	AmplifyUrl,
-	AmplifyUrlSearchParams,
 	CustomUserAgentDetails,
 	DocumentType,
 	GraphQLAuthMode,
-	NonRetryableError,
 	USER_AGENT_HEADER,
-	amplifyUuid,
-	base64Encoder,
 	getAmplifyUserAgent,
-	isNonRetryableError,
-	jitteredExponentialRetry,
 } from '@aws-amplify/core/internals/utils';
-import {
-	CustomHeaders,
-	RequestOptions,
-} from '@aws-amplify/data-schema/runtime';
-
-import {
-	CONTROL_MSG,
-	ConnectionState,
-	PubSubContentObserver,
-} from '../../types/PubSub';
-import {
-	AMPLIFY_SYMBOL,
-	AWS_APPSYNC_REALTIME_HEADERS,
-	CONNECTION_INIT_TIMEOUT,
-	CONNECTION_STATE_CHANGE,
-	DEFAULT_KEEP_ALIVE_ALERT_TIMEOUT,
-	DEFAULT_KEEP_ALIVE_TIMEOUT,
-	MAX_DELAY_MS,
-	MESSAGE_TYPES,
-	NON_RETRYABLE_CODES,
-	SOCKET_STATUS,
-	START_ACK_TIMEOUT,
-	SUBSCRIPTION_STATUS,
-} from '../constants';
-import {
-	CONNECTION_CHANGE,
-	ConnectionStateMonitor,
-} from '../../utils/ConnectionStateMonitor';
-import {
-	ReconnectEvent,
-	ReconnectionMonitor,
-} from '../../utils/ReconnectionMonitor';
+import { CustomHeaders } from '@aws-amplify/data-schema/runtime';
 
-const logger = new ConsoleLogger('AWSAppSyncRealTimeProvider');
-
-const dispatchApiEvent = (payload: HubPayload) => {
-	Hub.dispatch('api', payload, 'PubSub', AMPLIFY_SYMBOL);
-};
+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'>;
-export interface ObserverQuery {
-	observer: PubSubContentObserver;
-	query: string;
-	variables: Record<string, DocumentType>;
-	subscriptionState: SUBSCRIPTION_STATUS;
-	subscriptionReadyCallback?(): void;
-	subscriptionFailedCallback?(reason?: any): void;
-	startAckTimeoutId?: ReturnType<typeof setTimeout>;
-}
-
-const standardDomainPattern =
-	/^https:\/\/\w{26}\.appsync-api\.\w{2}(?:(?:-\w{2,})+)-\d\.amazonaws.com(?:\.cn)?\/graphql$/i;
-
-const customDomainPath = '/realtime';
-
-interface DataObject extends Record<string, unknown> {
-	data: Record<string, unknown>;
-}
-
-interface DataPayload {
-	id: string;
-	payload: DataObject;
-	type: string;
-}
-
-interface ParsedMessagePayload {
-	type: string;
-	payload: {
-		connectionTimeoutMs: number;
-		errors?: [{ errorType: string; errorCode: number }];
-	};
-}
 
 export interface AWSAppSyncRealTimeProviderOptions {
 	appSyncGraphqlEndpoint?: string;
 	authenticationType?: ResolvedGraphQLAuthModes;
 	query?: string;
-	variables?: Record<string, DocumentType>;
+	variables?: DocumentType;
 	apiKey?: string;
 	region?: string;
 	libraryConfigHeaders?(): Promise<Record<string, unknown> | Headers>;
@@ -110,209 +30,48 @@ export interface AWSAppSyncRealTimeProviderOptions {
 	authToken?: string;
 }
 
-type AWSAppSyncRealTimeAuthInput =
-	Partial<AWSAppSyncRealTimeProviderOptions> & {
-		canonicalUri: string;
-		payload: string;
-		host?: string | undefined;
-	};
-
-export class AWSAppSyncRealTimeProvider {
-	private awsRealTimeSocket?: WebSocket;
-	private socketStatus: SOCKET_STATUS = SOCKET_STATUS.CLOSED;
-	private keepAliveTimeoutId?: ReturnType<typeof setTimeout>;
-	private keepAliveTimeout = DEFAULT_KEEP_ALIVE_TIMEOUT;
-	private keepAliveAlertTimeoutId?: ReturnType<typeof setTimeout>;
-	private subscriptionObserverMap = new Map<string, ObserverQuery>();
-	private promiseArray: { res(): void; rej(reason?: any): void }[] = [];
-	private connectionState: ConnectionState | undefined;
-	private readonly connectionStateMonitor = new ConnectionStateMonitor();
-	private readonly reconnectionMonitor = new ReconnectionMonitor();
-	private connectionStateMonitorSubscription: SubscriptionLike;
-
-	constructor() {
-		// Monitor the connection state and pass changes along to Hub
-		this.connectionStateMonitorSubscription =
-			this.connectionStateMonitor.connectionStateObservable.subscribe(
-				connectionState => {
-					dispatchApiEvent({
-						event: CONNECTION_STATE_CHANGE,
-						data: {
-							provider: this,
-							connectionState,
-						},
-						message: `Connection state is ${connectionState}`,
-					});
-					this.connectionState = connectionState;
-
-					// Trigger START_RECONNECT when the connection is disrupted
-					if (connectionState === ConnectionState.ConnectionDisrupted) {
-						this.reconnectionMonitor.record(ReconnectEvent.START_RECONNECT);
-					}
-
-					// Trigger HALT_RECONNECT to halt reconnection attempts when the state is anything other than
-					//   ConnectionDisrupted or Connecting
-					if (
-						[
-							ConnectionState.Connected,
-							ConnectionState.ConnectedPendingDisconnect,
-							ConnectionState.ConnectedPendingKeepAlive,
-							ConnectionState.ConnectedPendingNetwork,
-							ConnectionState.ConnectionDisruptedPendingNetwork,
-							ConnectionState.Disconnected,
-						].includes(connectionState)
-					) {
-						this.reconnectionMonitor.record(ReconnectEvent.HALT_RECONNECT);
-					}
-				},
-			);
-	}
-
-	/**
-	 * Mark the socket closed and release all active listeners
-	 */
-	close() {
-		// Mark the socket closed both in status and the connection monitor
-		this.socketStatus = SOCKET_STATUS.CLOSED;
-		this.connectionStateMonitor.record(CONNECTION_CHANGE.CONNECTION_FAILED);
-
-		// Turn off the subscription monitor Hub publishing
-		this.connectionStateMonitorSubscription.unsubscribe();
-		// Complete all reconnect observers
-		this.reconnectionMonitor.close();
-	}
+interface DataObject extends Record<string, unknown> {
+	data: Record<string, unknown>;
+}
 
-	getNewWebSocket(url: string, protocol: string[]) {
-		return new WebSocket(url, protocol);
-	}
+interface DataPayload {
+	id: string;
+	payload: DataObject;
+	type: string;
+}
 
-	getProviderName() {
-		return 'AWSAppSyncRealTimeProvider';
-	}
+const PROVIDER_NAME = 'AWSAppSyncRealTimeProvider';
 
-	// Check if url matches standard domain pattern
-	private isCustomDomain(url: string): boolean {
-		return url.match(standardDomainPattern) === null;
+// get rid of generic. Just map the options from Gogi-specific to general
+export class AWSAppSyncRealTimeProvider extends AWSWebSocketProvider {
+	constructor() {
+		super(PROVIDER_NAME);
 	}
 
-	subscribe(
+	public subscribe(
 		options?: AWSAppSyncRealTimeProviderOptions,
 		customUserAgentDetails?: CustomUserAgentDetails,
-	): Observable<Record<string, unknown>> {
-		const {
-			appSyncGraphqlEndpoint,
-			region,
-			query,
-			variables,
-			authenticationType,
-			additionalHeaders,
-			apiKey,
-			authToken,
-			libraryConfigHeaders,
-		} = options || {};
-
-		return new Observable(observer => {
-			if (!options || !appSyncGraphqlEndpoint) {
-				observer.error({
-					errors: [
-						{
-							...new GraphQLError(
-								`Subscribe only available for AWS AppSync endpoint`,
-							),
-						},
-					],
-				});
-				observer.complete();
-			} else {
-				let subscriptionStartActive = false;
-				const subscriptionId = amplifyUuid();
-				const startSubscription = () => {
-					if (!subscriptionStartActive) {
-						subscriptionStartActive = true;
-
-						const startSubscriptionPromise =
-							this._startSubscriptionWithAWSAppSyncRealTime({
-								options: {
-									query,
-									variables,
-									region,
-									authenticationType,
-									appSyncGraphqlEndpoint,
-									additionalHeaders,
-									apiKey,
-									authToken,
-									libraryConfigHeaders,
-								},
-								observer,
-								subscriptionId,
-								customUserAgentDetails,
-							}).catch<any>(err => {
-								logger.debug(
-									`${CONTROL_MSG.REALTIME_SUBSCRIPTION_INIT_ERROR}: ${err}`,
-								);
-
-								this.connectionStateMonitor.record(CONNECTION_CHANGE.CLOSED);
-							});
-						startSubscriptionPromise.finally(() => {
-							subscriptionStartActive = false;
-						});
-					}
-				};
-
-				// Add an observable to the reconnection list to manage reconnection for this subscription
-				const reconnectSubscription = new Observable(
-					reconnectSubscriptionObserver => {
-						this.reconnectionMonitor.addObserver(reconnectSubscriptionObserver);
-					},
-				).subscribe(() => {
-					startSubscription();
-				});
-
-				startSubscription();
-
-				return async () => {
-					// Cleanup reconnection subscription
-					reconnectSubscription?.unsubscribe();
-
-					// Cleanup after unsubscribing or observer.complete was called after _startSubscriptionWithAWSAppSyncRealTime
-					try {
-						// Waiting that subscription has been connected before trying to unsubscribe
-						await this._waitForSubscriptionToBeConnected(subscriptionId);
-
-						const { subscriptionState } =
-							this.subscriptionObserverMap.get(subscriptionId) || {};
-
-						if (!subscriptionState) {
-							// subscription already unsubscribed
-							return;
-						}
+	) {
+		return super.subscribe(options, customUserAgentDetails);
+	}
 
-						if (subscriptionState === SUBSCRIPTION_STATUS.CONNECTED) {
-							this._sendUnsubscriptionMessage(subscriptionId);
-						} else {
-							throw new Error('Subscription never connected');
-						}
-					} catch (err) {
-						logger.debug(`Error while unsubscribing ${err}`);
-					} finally {
-						this._removeSubscriptionObserver(subscriptionId);
-					}
-				};
-			}
-		});
+	getProviderName() {
+		return PROVIDER_NAME;
 	}
 
-	private async _startSubscriptionWithAWSAppSyncRealTime({
+	protected async _prepareSubscriptionPayload({
 		options,
-		observer,
 		subscriptionId,
 		customUserAgentDetails,
+		additionalCustomHeaders,
+		libraryConfigHeaders,
 	}: {
 		options: AWSAppSyncRealTimeProviderOptions;
-		observer: PubSubContentObserver;
 		subscriptionId: string;
 		customUserAgentDetails: CustomUserAgentDetails | undefined;
-	}) {
+		additionalCustomHeaders: Record<string, string>;
+		libraryConfigHeaders: Record<string, string>;
+	}): Promise<string> {
 		const {
 			appSyncGraphqlEndpoint,
 			authenticationType,
@@ -320,59 +79,24 @@ export class AWSAppSyncRealTimeProvider {
 			variables,
 			apiKey,
 			region,
-			libraryConfigHeaders = () => ({}),
-			additionalHeaders = {},
-			authToken,
 		} = options;
-
-		let additionalCustomHeaders: Record<string, string> = {};
-
-		if (typeof additionalHeaders === 'function') {
-			const requestOptions: RequestOptions = {
-				url: appSyncGraphqlEndpoint || '',
-				queryString: query || '',
-			};
-			additionalCustomHeaders = await additionalHeaders(requestOptions);
-		} else {
-			additionalCustomHeaders = additionalHeaders;
-		}
-
-		// if an authorization header is set, have the explicit authToken take precedence
-		if (authToken) {
-			additionalCustomHeaders = {
-				...additionalCustomHeaders,
-				Authorization: authToken,
-			};
-		}
-
-		const subscriptionState: SUBSCRIPTION_STATUS = SUBSCRIPTION_STATUS.PENDING;
 		const data = {
 			query,
 			variables,
 		};
-		// Having a subscription id map will make it simple to forward messages received
-		this.subscriptionObserverMap.set(subscriptionId, {
-			observer,
-			query: query ?? '',
-			variables: variables ?? {},
-			subscriptionState,
-			startAckTimeoutId: undefined,
-		});
-
-		// Preparing payload for subscription message
+		const serializedData = JSON.stringify(data);
 
-		const dataString = JSON.stringify(data);
-		const headerObj = {
-			...(await this._awsRealTimeHeaderBasedAuth({
+		const headers = {
+			...(await awsRealTimeHeaderBasedAuth({
 				apiKey,
 				appSyncGraphqlEndpoint,
 				authenticationType,
-				payload: dataString,
+				payload: serializedData,
 				canonicalUri: '',
 				region,
 				additionalCustomHeaders,
 			})),
-			...(await libraryConfigHeaders()),
+			...libraryConfigHeaders,
 			...additionalCustomHeaders,
 			[USER_AGENT_HEADER]: getAmplifyUserAgent(customUserAgentDetails),
 		};
@@ -380,775 +104,58 @@ export class AWSAppSyncRealTimeProvider {
 		const subscriptionMessage = {
 			id: subscriptionId,
 			payload: {
-				data: dataString,
+				data: serializedData,
 				extensions: {
 					authorization: {
-						...headerObj,
+						...headers,
 					},
 				},
 			},
 			type: MESSAGE_TYPES.GQL_START,
 		};
 
-		const stringToAWSRealTime = JSON.stringify(subscriptionMessage);
-
-		try {
-			this.connectionStateMonitor.record(CONNECTION_CHANGE.OPENING_CONNECTION);
-			await this._initializeWebSocketConnection({
-				apiKey,
-				appSyncGraphqlEndpoint,
-				authenticationType,
-				region,
-				additionalCustomHeaders,
-			});
-		} catch (err: any) {
-			this._logStartSubscriptionError(subscriptionId, observer, err);
-
-			return;
-		}
-
-		// Potential race condition can occur when unsubscribe is called during _initializeWebSocketConnection.
-		// E.g.unsubscribe gets invoked prior to finishing WebSocket handshake or START_ACK.
-		// Both subscriptionFailedCallback and subscriptionReadyCallback are used to synchronized this.
-
-		const { subscriptionFailedCallback, subscriptionReadyCallback } =
-			this.subscriptionObserverMap.get(subscriptionId) ?? {};
-
-		// This must be done before sending the message in order to be listening immediately
-		this.subscriptionObserverMap.set(subscriptionId, {
-			observer,
-			subscriptionState,
-			query: query ?? '',
-			variables: variables ?? {},
-			subscriptionReadyCallback,
-			subscriptionFailedCallback,
-			startAckTimeoutId: setTimeout(() => {
-				this._timeoutStartSubscriptionAck(subscriptionId);
-			}, START_ACK_TIMEOUT),
-		});
-		if (this.awsRealTimeSocket) {
-			this.awsRealTimeSocket.send(stringToAWSRealTime);
-		}
-	}
-
-	// Log logic for start subscription failures
-	private _logStartSubscriptionError(
-		subscriptionId: string,
-		observer: PubSubContentObserver,
-		err: { message?: string },
-	) {
-		logger.debug({ err });
-		const message = String(err.message ?? '');
-		// Resolving to give the state observer time to propogate the update
-		this.connectionStateMonitor.record(CONNECTION_CHANGE.CLOSED);
-
-		// Capture the error only when the network didn't cause disruption
-		if (
-			this.connectionState !== ConnectionState.ConnectionDisruptedPendingNetwork
-		) {
-			// When the error is non-retriable, error out the observable
-			if (isNonRetryableError(err)) {
-				observer.error({
-					errors: [
-						{
-							...new GraphQLError(
-								`${CONTROL_MSG.CONNECTION_FAILED}: ${message}`,
-							),
-						},
-					],
-				});
-			} else {
-				logger.debug(`${CONTROL_MSG.CONNECTION_FAILED}: ${message}`);
-			}
-
-			const { subscriptionFailedCallback } =
-				this.subscriptionObserverMap.get(subscriptionId) || {};
-
-			// Notify concurrent unsubscription
-			if (typeof subscriptionFailedCallback === 'function') {
-				subscriptionFailedCallback();
-			}
-		}
-	}
-
-	// Waiting that subscription has been connected before trying to unsubscribe
-	private async _waitForSubscriptionToBeConnected(subscriptionId: string) {
-		const subscriptionObserver =
-			this.subscriptionObserverMap.get(subscriptionId);
-		if (subscriptionObserver) {
-			const { subscriptionState } = subscriptionObserver;
-			// This in case unsubscribe is invoked before sending start subscription message
-			if (subscriptionState === SUBSCRIPTION_STATUS.PENDING) {
-				return new Promise<void>((resolve, reject) => {
-					const {
-						observer,
-						subscriptionState: observedSubscriptionState,
-						variables,
-						query,
-					} = subscriptionObserver;
-					this.subscriptionObserverMap.set(subscriptionId, {
-						observer,
-						subscriptionState: observedSubscriptionState,
-						variables,
-						query,
-						subscriptionReadyCallback: resolve,
-						subscriptionFailedCallback: reject,
-					});
-				});
-			}
-		}
-	}
-
-	private _sendUnsubscriptionMessage(subscriptionId: string) {
-		try {
-			if (
-				this.awsRealTimeSocket &&
-				this.awsRealTimeSocket.readyState === WebSocket.OPEN &&
-				this.socketStatus === SOCKET_STATUS.READY
-			) {
-				// Preparing unsubscribe message to stop receiving messages for that subscription
-				const unsubscribeMessage = {
-					id: subscriptionId,
-					type: MESSAGE_TYPES.GQL_STOP,
-				};
-				const stringToAWSRealTime = JSON.stringify(unsubscribeMessage);
-				this.awsRealTimeSocket.send(stringToAWSRealTime);
-			}
-		} catch (err) {
-			// If GQL_STOP is not sent because of disconnection issue, then there is nothing the client can do
-			logger.debug({ err });
-		}
-	}
-
-	private _removeSubscriptionObserver(subscriptionId: string) {
-		this.subscriptionObserverMap.delete(subscriptionId);
+		const serializedSubscriptionMessage = JSON.stringify(subscriptionMessage);
 
-		// Verifying 1000ms after removing subscription in case there are new subscription unmount/mount
-		setTimeout(this._closeSocketIfRequired.bind(this), 1000);
+		return serializedSubscriptionMessage;
 	}
 
-	private _closeSocketIfRequired() {
-		if (this.subscriptionObserverMap.size > 0) {
-			// Active subscriptions on the WebSocket
-			return;
-		}
-
-		if (!this.awsRealTimeSocket) {
-			this.socketStatus = SOCKET_STATUS.CLOSED;
-
-			return;
-		}
-
-		this.connectionStateMonitor.record(CONNECTION_CHANGE.CLOSING_CONNECTION);
-
-		if (this.awsRealTimeSocket.bufferedAmount > 0) {
-			// Still data on the WebSocket
-			setTimeout(this._closeSocketIfRequired.bind(this), 1000);
-		} else {
-			logger.debug('closing WebSocket...');
-			if (this.keepAliveTimeoutId) {
-				clearTimeout(this.keepAliveTimeoutId);
-			}
-			if (this.keepAliveAlertTimeoutId) {
-				clearTimeout(this.keepAliveAlertTimeoutId);
-			}
-			const tempSocket = this.awsRealTimeSocket;
-			// Cleaning callbacks to avoid race condition, socket still exists
-			tempSocket.onclose = null;
-			tempSocket.onerror = null;
-			tempSocket.close(1000);
-			this.awsRealTimeSocket = undefined;
-			this.socketStatus = SOCKET_STATUS.CLOSED;
-			this.connectionStateMonitor.record(CONNECTION_CHANGE.CLOSED);
-		}
-	}
-
-	private _handleIncomingSubscriptionMessage(message: MessageEvent) {
-		if (typeof message.data !== 'string') {
-			return;
-		}
-		logger.debug(
+	protected _handleSubscriptionData(
+		message: MessageEvent,
+	): [boolean, DataPayload] {
+		this.logger.debug(
 			`subscription message from AWS AppSync RealTime: ${message.data}`,
 		);
-		const {
-			id = '',
-			payload,
-			type,
-		}: DataPayload = JSON.parse(String(message.data));
+
+		const { id = '', payload, type } = JSON.parse(String(message.data));
+
 		const {
 			observer = null,
 			query = '',
 			variables = {},
-			startAckTimeoutId,
-			subscriptionReadyCallback,
-			subscriptionFailedCallback,
 		} = this.subscriptionObserverMap.get(id) || {};
 
-		logger.debug({ id, observer, query, variables });
+		this.logger.debug({ id, observer, query, variables });
 
-		if (type === MESSAGE_TYPES.GQL_DATA && payload && payload.data) {
+		if (type === MESSAGE_TYPES.DATA && payload && payload.data) {
 			if (observer) {
 				observer.next(payload);
 			} else {
-				logger.debug(`observer not found for id: ${id}`);
-			}
-
-			return;
-		}
-
-		if (type === MESSAGE_TYPES.GQL_START_ACK) {
-			logger.debug(
-				`subscription ready for ${JSON.stringify({ query, variables })}`,
-			);
-			if (typeof subscriptionReadyCallback === 'function') {
-				subscriptionReadyCallback();
-			}
-			if (startAckTimeoutId) clearTimeout(startAckTimeoutId);
-			dispatchApiEvent({
-				event: CONTROL_MSG.SUBSCRIPTION_ACK,
-				data: { query, variables },
-				message: 'Connection established for subscription',
-			});
-			const subscriptionState = SUBSCRIPTION_STATUS.CONNECTED;
-			if (observer) {
-				this.subscriptionObserverMap.set(id, {
-					observer,
-					query,
-					variables,
-					startAckTimeoutId: undefined,
-					subscriptionState,
-					subscriptionReadyCallback,
-					subscriptionFailedCallback,
-				});
-			}
-			this.connectionStateMonitor.record(
-				CONNECTION_CHANGE.CONNECTION_ESTABLISHED,
-			);
-
-			return;
-		}
-
-		if (type === MESSAGE_TYPES.GQL_CONNECTION_KEEP_ALIVE) {
-			if (this.keepAliveTimeoutId) clearTimeout(this.keepAliveTimeoutId);
-			if (this.keepAliveAlertTimeoutId)
-				clearTimeout(this.keepAliveAlertTimeoutId);
-			this.keepAliveTimeoutId = setTimeout(() => {
-				this._errorDisconnect(CONTROL_MSG.TIMEOUT_DISCONNECT);
-			}, this.keepAliveTimeout);
-			this.keepAliveAlertTimeoutId = setTimeout(() => {
-				this.connectionStateMonitor.record(CONNECTION_CHANGE.KEEP_ALIVE_MISSED);
-			}, DEFAULT_KEEP_ALIVE_ALERT_TIMEOUT);
-			this.connectionStateMonitor.record(CONNECTION_CHANGE.KEEP_ALIVE);
-
-			return;
-		}
-
-		if (type === MESSAGE_TYPES.GQL_ERROR) {
-			const subscriptionState = SUBSCRIPTION_STATUS.FAILED;
-			if (observer) {
-				this.subscriptionObserverMap.set(id, {
-					observer,
-					query,
-					variables,
-					startAckTimeoutId,
-					subscriptionReadyCallback,
-					subscriptionFailedCallback,
-					subscriptionState,
-				});
-
-				logger.debug(
-					`${CONTROL_MSG.CONNECTION_FAILED}: ${JSON.stringify(payload)}`,
-				);
-
-				observer.error({
-					errors: [
-						{
-							...new GraphQLError(
-								`${CONTROL_MSG.CONNECTION_FAILED}: ${JSON.stringify(payload)}`,
-							),
-						},
-					],
-				});
-
-				if (startAckTimeoutId) clearTimeout(startAckTimeoutId);
-
-				if (typeof subscriptionFailedCallback === 'function') {
-					subscriptionFailedCallback();
-				}
-			}
-		}
-	}
-
-	private _errorDisconnect(msg: string) {
-		logger.debug(`Disconnect error: ${msg}`);
-
-		if (this.awsRealTimeSocket) {
-			this.connectionStateMonitor.record(CONNECTION_CHANGE.CLOSED);
-			this.awsRealTimeSocket.close();
-		}
-
-		this.socketStatus = SOCKET_STATUS.CLOSED;
-	}
-
-	private _timeoutStartSubscriptionAck(subscriptionId: string) {
-		const subscriptionObserver =
-			this.subscriptionObserverMap.get(subscriptionId);
-		if (subscriptionObserver) {
-			const { observer, query, variables } = subscriptionObserver;
-			if (!observer) {
-				return;
-			}
-			this.subscriptionObserverMap.set(subscriptionId, {
-				observer,
-				query,
-				variables,
-				subscriptionState: SUBSCRIPTION_STATUS.FAILED,
-			});
-
-			this.connectionStateMonitor.record(CONNECTION_CHANGE.CLOSED);
-			logger.debug(
-				'timeoutStartSubscription',
-				JSON.stringify({ query, variables }),
-			);
-		}
-	}
-
-	/**
-	 * Strips out `Authorization` header if present
-	 */
-	private _extractNonAuthHeaders(
-		headers?: AWSAppSyncRealTimeProviderOptions['additionalCustomHeaders'],
-	): Record<string, string> {
-		if (!headers) {
-			return {};
-		}
-
-		if ('Authorization' in headers) {
-			const { Authorization: _, ...nonAuthHeaders } = headers;
-
-			return nonAuthHeaders;
-		}
-
-		return headers;
-	}
-
-	/**
-	 *
-	 * @param headers - http headers
-	 * @returns uri-encoded query parameters derived from custom headers
-	 */
-	private _queryParamsFromCustomHeaders(
-		headers?: AWSAppSyncRealTimeProviderOptions['additionalCustomHeaders'],
-	): URLSearchParams {
-		const nonAuthHeaders = this._extractNonAuthHeaders(headers);
-
-		const params = new AmplifyUrlSearchParams();
-
-		Object.entries(nonAuthHeaders).forEach(([k, v]) => {
-			params.append(k, v);
-		});
-
-		return params;
-	}
-
-	/**
-	 * Normalizes AppSync realtime endpoint URL
-	 *
-	 * @param appSyncGraphqlEndpoint - AppSync endpointUri from config
-	 * @param urlParams - URLSearchParams
-	 * @returns fully resolved string realtime endpoint URL
-	 */
-	private _realtimeUrlWithQueryString(
-		appSyncGraphqlEndpoint: string | undefined,
-		urlParams: URLSearchParams,
-	): string {
-		const protocol = 'wss://';
-
-		let realtimeEndpoint = appSyncGraphqlEndpoint ?? '';
-
-		if (this.isCustomDomain(realtimeEndpoint)) {
-			realtimeEndpoint = realtimeEndpoint.concat(customDomainPath);
-		} else {
-			realtimeEndpoint = realtimeEndpoint
-				.replace('appsync-api', 'appsync-realtime-api')
-				.replace('gogi-beta', 'grt-beta');
-		}
-
-		realtimeEndpoint = realtimeEndpoint
-			.replace('https://', protocol)
-			.replace('http://', protocol);
-
-		const realtimeEndpointUrl = new AmplifyUrl(realtimeEndpoint);
-
-		// preserves any query params a customer might manually set in the configuration
-		const existingParams = new AmplifyUrlSearchParams(
-			realtimeEndpointUrl.search,
-		);
-
-		for (const [k, v] of urlParams.entries()) {
-			existingParams.append(k, v);
-		}
-
-		realtimeEndpointUrl.search = existingParams.toString();
-
-		return realtimeEndpointUrl.toString();
-	}
-
-	private _initializeWebSocketConnection({
-		appSyncGraphqlEndpoint,
-		authenticationType,
-		apiKey,
-		region,
-		additionalCustomHeaders,
-	}: AWSAppSyncRealTimeProviderOptions) {
-		if (this.socketStatus === SOCKET_STATUS.READY) {
-			return;
-		}
-
-		// TODO(Eslint): refactor to now use async function as the promise executor
-		// eslint-disable-next-line no-async-promise-executor
-		return new Promise<void>(async (resolve, reject) => {
-			this.promiseArray.push({ res: resolve, rej: reject });
-
-			if (this.socketStatus === SOCKET_STATUS.CLOSED) {
-				try {
-					this.socketStatus = SOCKET_STATUS.CONNECTING;
-
-					const payloadString = '{}';
-
-					const authHeader = await this._awsRealTimeHeaderBasedAuth({
-						authenticationType,
-						payload: payloadString,
-						canonicalUri: '/connect',
-						apiKey,
-						appSyncGraphqlEndpoint,
-						region,
-						additionalCustomHeaders,
-					});
-
-					const headerString = authHeader ? JSON.stringify(authHeader) : '';
-					// base64url-encoded string
-					const encodedHeader = base64Encoder.convert(headerString, {
-						urlSafe: true,
-						skipPadding: true,
-					});
-
-					const authTokenSubprotocol = `header-${encodedHeader}`;
-
-					const queryParams = this._queryParamsFromCustomHeaders(
-						additionalCustomHeaders,
-					);
-
-					const awsRealTimeUrl = this._realtimeUrlWithQueryString(
-						appSyncGraphqlEndpoint,
-						queryParams,
-					);
-
-					await this._initializeRetryableHandshake(
-						awsRealTimeUrl,
-						authTokenSubprotocol,
-					);
-
-					this.promiseArray.forEach(({ res }) => {
-						logger.debug('Notifying connection successful');
-						res();
-					});
-					this.socketStatus = SOCKET_STATUS.READY;
-					this.promiseArray = [];
-				} catch (err) {
-					logger.debug('Connection exited with', err);
-					this.promiseArray.forEach(({ rej }) => {
-						rej(err);
-					});
-					this.promiseArray = [];
-					if (
-						this.awsRealTimeSocket &&
-						this.awsRealTimeSocket.readyState === WebSocket.OPEN
-					) {
-						this.awsRealTimeSocket.close(3001);
-					}
-					this.awsRealTimeSocket = undefined;
-					this.socketStatus = SOCKET_STATUS.CLOSED;
-				}
-			}
-		});
-	}
-
-	private async _initializeRetryableHandshake(
-		awsRealTimeUrl: string,
-		subprotocol: string,
-	) {
-		logger.debug(`Initializaling retryable Handshake`);
-		await jitteredExponentialRetry(
-			this._initializeHandshake.bind(this),
-			[awsRealTimeUrl, subprotocol],
-			MAX_DELAY_MS,
-		);
-	}
-
-	/**
-	 *
-	 * @param subprotocol -
-	 */
-	private async _initializeHandshake(
-		awsRealTimeUrl: string,
-		subprotocol: string,
-	) {
-		logger.debug(`Initializing handshake ${awsRealTimeUrl}`);
-		// Because connecting the socket is async, is waiting until connection is open
-		// Step 1: connect websocket
-		try {
-			await (() => {
-				return new Promise<void>((resolve, reject) => {
-					const newSocket = this.getNewWebSocket(awsRealTimeUrl, [
-						'graphql-ws',
-						subprotocol,
-					]);
-
-					newSocket.onerror = () => {
-						logger.debug(`WebSocket connection error`);
-					};
-					newSocket.onclose = () => {
-						reject(new Error('Connection handshake error'));
-					};
-					newSocket.onopen = () => {
-						this.awsRealTimeSocket = newSocket;
-
-						resolve();
-					};
-				});
-			})();
-			// Step 2: wait for ack from AWS AppSyncReaTime after sending init
-			await (() => {
-				return new Promise((resolve, reject) => {
-					if (this.awsRealTimeSocket) {
-						let ackOk = false;
-						this.awsRealTimeSocket.onerror = error => {
-							logger.debug(`WebSocket error ${JSON.stringify(error)}`);
-						};
-						this.awsRealTimeSocket.onclose = event => {
-							logger.debug(`WebSocket closed ${event.reason}`);
-							reject(new Error(JSON.stringify(event)));
-						};
-
-						this.awsRealTimeSocket.onmessage = (message: MessageEvent) => {
-							if (typeof message.data !== 'string') {
-								return;
-							}
-							logger.debug(
-								`subscription message from AWS AppSyncRealTime: ${message.data} `,
-							);
-							const data = JSON.parse(message.data) as ParsedMessagePayload;
-							const {
-								type,
-								payload: {
-									connectionTimeoutMs = DEFAULT_KEEP_ALIVE_TIMEOUT,
-								} = {},
-							} = data;
-							if (type === MESSAGE_TYPES.GQL_CONNECTION_ACK) {
-								ackOk = true;
-								if (this.awsRealTimeSocket) {
-									this.keepAliveTimeout = connectionTimeoutMs;
-									this.awsRealTimeSocket.onmessage =
-										this._handleIncomingSubscriptionMessage.bind(this);
-									this.awsRealTimeSocket.onerror = err => {
-										logger.debug(err);
-										this._errorDisconnect(CONTROL_MSG.CONNECTION_CLOSED);
-									};
-									this.awsRealTimeSocket.onclose = event => {
-										logger.debug(`WebSocket closed ${event.reason}`);
-										this._errorDisconnect(CONTROL_MSG.CONNECTION_CLOSED);
-									};
-								}
-								resolve('Cool, connected to AWS AppSyncRealTime');
-
-								return;
-							}
-
-							if (type === MESSAGE_TYPES.GQL_CONNECTION_ERROR) {
-								const {
-									payload: {
-										errors: [{ errorType = '', errorCode = 0 } = {}] = [],
-									} = {},
-								} = data;
-
-								// TODO(Eslint): refactor to reject an Error object instead of a plain object
-								// eslint-disable-next-line prefer-promise-reject-errors
-								reject({ errorType, errorCode });
-							}
-						};
-
-						const gqlInit = {
-							type: MESSAGE_TYPES.GQL_CONNECTION_INIT,
-						};
-						this.awsRealTimeSocket.send(JSON.stringify(gqlInit));
-
-						const checkAckOk = (targetAckOk: boolean) => {
-							if (!targetAckOk) {
-								this.connectionStateMonitor.record(
-									CONNECTION_CHANGE.CONNECTION_FAILED,
-								);
-								reject(
-									new Error(
-										`Connection timeout: ack from AWSAppSyncRealTime was not received after ${CONNECTION_INIT_TIMEOUT} ms`,
-									),
-								);
-							}
-						};
-
-						setTimeout(() => {
-							checkAckOk(ackOk);
-						}, CONNECTION_INIT_TIMEOUT);
-					}
-				});
-			})();
-		} catch (err) {
-			const { errorType, errorCode } = err as {
-				errorType: string;
-				errorCode: number;
-			};
-
-			if (NON_RETRYABLE_CODES.includes(errorCode)) {
-				throw new NonRetryableError(errorType);
-			} else if (errorType) {
-				throw new Error(errorType);
-			} else {
-				throw err;
-			}
-		}
-	}
-
-	private async _awsRealTimeHeaderBasedAuth({
-		apiKey,
-		authenticationType,
-		payload,
-		canonicalUri,
-		appSyncGraphqlEndpoint,
-		region,
-		additionalCustomHeaders,
-	}: AWSAppSyncRealTimeAuthInput): Promise<
-		Record<string, unknown> | undefined
-	> {
-		const headerHandler: {
-			[key in ResolvedGraphQLAuthModes]: (
-				arg0: AWSAppSyncRealTimeAuthInput,
-			) => Promise<Record<string, unknown>> | Record<string, unknown>;
-		} = {
-			apiKey: this._awsRealTimeApiKeyHeader.bind(this),
-			iam: this._awsRealTimeIAMHeader.bind(this),
-			oidc: this._awsAuthTokenHeader.bind(this),
-			userPool: this._awsAuthTokenHeader.bind(this),
-			lambda: this._customAuthHeader,
-			none: this._customAuthHeader,
-		};
-
-		if (!authenticationType || !headerHandler[authenticationType]) {
-			logger.debug(`Authentication type ${authenticationType} not supported`);
-
-			return undefined;
-		} else {
-			const handler = headerHandler[authenticationType];
-
-			const host = appSyncGraphqlEndpoint
-				? new AmplifyUrl(appSyncGraphqlEndpoint).host
-				: undefined;
-
-			logger.debug(`Authenticating with ${JSON.stringify(authenticationType)}`);
-			let resolvedApiKey;
-			if (authenticationType === 'apiKey') {
-				resolvedApiKey = apiKey;
+				this.logger.debug(`observer not found for id: ${id}`);
 			}
-			const result = await handler({
-				payload,
-				canonicalUri,
-				appSyncGraphqlEndpoint,
-				apiKey: resolvedApiKey,
-				region,
-				host,
-				additionalCustomHeaders,
-			});
 
-			return result;
+			return [true, { id, type, payload }];
 		}
-	}
-
-	private async _awsAuthTokenHeader({ host }: AWSAppSyncRealTimeAuthInput) {
-		const session = await fetchAuthSession();
 
-		return {
-			Authorization: session?.tokens?.accessToken?.toString(),
-			host,
-		};
+		return [false, { id, type, payload }];
 	}
 
-	private async _awsRealTimeApiKeyHeader({
-		apiKey,
-		host,
-	}: AWSAppSyncRealTimeAuthInput) {
-		const dt = new Date();
-		const dtStr = dt.toISOString().replace(/[:-]|\.\d{3}/g, '');
-
+	protected _unsubscribeMessage(subscriptionId: string): {
+		id: string;
+		type: string;
+	} {
 		return {
-			host,
-			'x-amz-date': dtStr,
-			'x-api-key': apiKey,
-		};
-	}
-
-	private async _awsRealTimeIAMHeader({
-		payload,
-		canonicalUri,
-		appSyncGraphqlEndpoint,
-		region,
-	}: AWSAppSyncRealTimeAuthInput) {
-		const endpointInfo = {
-			region,
-			service: 'appsync',
-		};
-
-		const creds = (await fetchAuthSession()).credentials;
-
-		const request = {
-			url: `${appSyncGraphqlEndpoint}${canonicalUri}`,
-			data: payload,
-			method: 'POST',
-			headers: { ...AWS_APPSYNC_REALTIME_HEADERS },
-		};
-
-		const signedParams = signRequest(
-			{
-				headers: request.headers,
-				method: request.method,
-				url: new AmplifyUrl(request.url),
-				body: request.data,
-			},
-			{
-				// TODO: What do we need to do to remove these !'s?
-				credentials: creds!,
-				signingRegion: endpointInfo.region!,
-				signingService: endpointInfo.service,
-			},
-		);
-
-		return signedParams.headers;
-	}
-
-	private _customAuthHeader({
-		host,
-		additionalCustomHeaders,
-	}: AWSAppSyncRealTimeAuthInput) {
-		/**
-		 * If `additionalHeaders` was provided to the subscription as a function,
-		 * the headers that are returned by that function will already have been
-		 * provided before this function is called.
-		 */
-		if (!additionalCustomHeaders?.Authorization) {
-			throw new Error('No auth token specified');
-		}
-
-		return {
-			Authorization: additionalCustomHeaders.Authorization,
-			host,
+			id: subscriptionId,
+			type: MESSAGE_TYPES.GQL_STOP,
 		};
 	}
 }