@aws-amplify/api-graphql 4.7.2-graphql-data-ka.518fb2c.0 → 4.7.2-publish-event-websocket.65d9752.0

package/src/Providers/AWSWebSocketProvider/index.ts

@@ -23,7 +23,7 @@ import {
 	CONNECTION_INIT_TIMEOUT,
 	CONNECTION_STATE_CHANGE,
 	DEFAULT_KEEP_ALIVE_ALERT_TIMEOUT,
-	DEFAULT_KEEP_ALIVE_HEARTBEAT_TIMEOUT,
+	DEFAULT_KEEP_ALIVE_TIMEOUT,
 	MAX_DELAY_MS,
 	MESSAGE_TYPES,
 	NON_RETRYABLE_CODES,
@@ -83,8 +83,9 @@ export abstract class AWSWebSocketProvider {
 
 	protected awsRealTimeSocket?: WebSocket;
 	private socketStatus: SOCKET_STATUS = SOCKET_STATUS.CLOSED;
-	private kaTimestamp?: number;
-	private keepAliveHeartbeatIntervalId?: ReturnType<typeof setTimeout>;
+	private keepAliveTimeoutId?: ReturnType<typeof setTimeout>;
+	private keepAliveTimeout = DEFAULT_KEEP_ALIVE_TIMEOUT;
+	private keepAliveAlertTimeoutId?: ReturnType<typeof setTimeout>;
 	private promiseArray: { res(): void; rej(reason?: any): void }[] = [];
 	private connectionState: ConnectionState | undefined;
 	private readonly connectionStateMonitor = new ConnectionStateMonitor();
@@ -118,7 +119,6 @@ export abstract class AWSWebSocketProvider {
 		return new Promise<void>((resolve, reject) => {
 			if (this.awsRealTimeSocket) {
 				this.awsRealTimeSocket.onclose = (_: CloseEvent) => {
-					this._closeSocket();
 					this.subscriptionObserverMap = new Map();
 					this.awsRealTimeSocket = undefined;
 					resolve();
@@ -171,7 +171,7 @@ export abstract class AWSWebSocketProvider {
 							this.logger.debug(
 								`${CONTROL_MSG.REALTIME_SUBSCRIPTION_INIT_ERROR}: ${err}`,
 							);
-							this._closeSocket();
+							this.connectionStateMonitor.record(CONNECTION_CHANGE.CLOSED);
 						})
 						.finally(() => {
 							subscriptionStartInProgress = false;
@@ -255,6 +255,11 @@ export abstract class AWSWebSocketProvider {
 
 		return new Promise((resolve, reject) => {
 			if (this.awsRealTimeSocket) {
+				const timeoutId = setTimeout(() => {
+					cleanup();
+					reject(new Error('Publish operation timed out'));
+				}, 30000); // 30 seconds timeout
+
 				const publishListener = (event: MessageEvent) => {
 					const data = JSON.parse(event.data);
 					if (data.id === subscriptionId && data.type === 'publish_success') {
@@ -263,22 +268,47 @@ export abstract class AWSWebSocketProvider {
 								'message',
 								publishListener,
 							);
-
+						cleanup();
 						resolve();
 					}
 
 					if (data.erroredEvents && data.erroredEvents.length > 0) {
 						// TODO: handle errors
+						const errors = data.erroredEvents.map(
+							(errorEvent: any) => errorEvent.error,
+						);
+						cleanup();
+						reject(new Error(`Publish errors: ${errors.join(', ')}`));
 					}
 				};
-				this.awsRealTimeSocket.addEventListener('message', publishListener);
-				this.awsRealTimeSocket.addEventListener('close', () => {
+
+				const errorListener = (error: Event) => {
+					cleanup();
+					reject(new Error(`WebSocket error: ${error}`));
+				};
+
+				const closeListener = () => {
+					cleanup();
 					reject(new Error('WebSocket is closed'));
-				});
-				//
-				// this.awsRealTimeSocket.addEventListener('error', publishListener);
+				};
+
+				const cleanup = () => {
+					clearTimeout(timeoutId);
+					this.awsRealTimeSocket?.removeEventListener(
+						'message',
+						publishListener,
+					);
+					this.awsRealTimeSocket?.removeEventListener('error', errorListener);
+					this.awsRealTimeSocket?.removeEventListener('close', closeListener);
+				};
+
+				this.awsRealTimeSocket.addEventListener('message', publishListener);
+				this.awsRealTimeSocket.addEventListener('error', errorListener);
+				this.awsRealTimeSocket.addEventListener('close', closeListener);
 
 				this.awsRealTimeSocket.send(serializedSubscriptionMessage);
+			} else {
+				reject(new Error('WebSocket is not connected'));
 			}
 		});
 	}
@@ -435,7 +465,7 @@ export abstract class AWSWebSocketProvider {
 		this.logger.debug({ err });
 		const message = String(err.message ?? '');
 		// Resolving to give the state observer time to propogate the update
-		this._closeSocket();
+		this.connectionStateMonitor.record(CONNECTION_CHANGE.CLOSED);
 
 		// Capture the error only when the network didn't cause disruption
 		if (
@@ -544,7 +574,12 @@ export abstract class AWSWebSocketProvider {
 			setTimeout(this._closeSocketIfRequired.bind(this), 1000);
 		} else {
 			this.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;
@@ -552,7 +587,7 @@ export abstract class AWSWebSocketProvider {
 			tempSocket.close(1000);
 			this.awsRealTimeSocket = undefined;
 			this.socketStatus = SOCKET_STATUS.CLOSED;
-			this._closeSocket();
+			this.connectionStateMonitor.record(CONNECTION_CHANGE.CLOSED);
 		}
 	}
 
@@ -572,43 +607,13 @@ export abstract class AWSWebSocketProvider {
 		errorType: string;
 	};
 
-	private maintainKeepAlive() {
-		this.kaTimestamp = Date.now();
-	}
-
-	private keepAliveHeartbeat(connectionTimeoutMs: number) {
-		const currentTime = Date.now();
-
-		// Check for missed KA message
-		if (
-			this.kaTimestamp &&
-			currentTime - this.kaTimestamp > DEFAULT_KEEP_ALIVE_ALERT_TIMEOUT
-		) {
-			this.connectionStateMonitor.record(CONNECTION_CHANGE.KEEP_ALIVE_MISSED);
-		} else {
-			this.connectionStateMonitor.record(CONNECTION_CHANGE.KEEP_ALIVE);
-		}
-
-		// Recognize we are disconnected if we haven't seen messages in the keep alive timeout period
-		if (
-			this.kaTimestamp &&
-			currentTime - this.kaTimestamp > connectionTimeoutMs
-		) {
-			this._errorDisconnect(CONTROL_MSG.TIMEOUT_DISCONNECT);
-		}
-	}
-
 	private _handleIncomingSubscriptionMessage(message: MessageEvent) {
 		if (typeof message.data !== 'string') {
 			return;
 		}
 
 		const [isData, data] = this._handleSubscriptionData(message);
-		if (isData) {
-			this.maintainKeepAlive();
-
-			return;
-		}
+		if (isData) return;
 
 		const { type, id, payload } = data;
 
@@ -657,7 +662,16 @@ export abstract class AWSWebSocketProvider {
 		}
 
 		if (type === MESSAGE_TYPES.GQL_CONNECTION_KEEP_ALIVE) {
-			this.maintainKeepAlive();
+			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;
 		}
@@ -702,21 +716,13 @@ export abstract class AWSWebSocketProvider {
 		this.logger.debug(`Disconnect error: ${msg}`);
 
 		if (this.awsRealTimeSocket) {
-			this._closeSocket();
+			this.connectionStateMonitor.record(CONNECTION_CHANGE.CLOSED);
 			this.awsRealTimeSocket.close();
 		}
 
 		this.socketStatus = SOCKET_STATUS.CLOSED;
 	}
 
-	private _closeSocket() {
-		if (this.keepAliveHeartbeatIntervalId) {
-			clearInterval(this.keepAliveHeartbeatIntervalId);
-			this.keepAliveHeartbeatIntervalId = undefined;
-		}
-		this.connectionStateMonitor.record(CONNECTION_CHANGE.CLOSED);
-	}
-
 	private _timeoutStartSubscriptionAck(subscriptionId: string) {
 		const subscriptionObserver =
 			this.subscriptionObserverMap.get(subscriptionId);
@@ -732,7 +738,7 @@ export abstract class AWSWebSocketProvider {
 				subscriptionState: SUBSCRIPTION_STATUS.FAILED,
 			});
 
-			this._closeSocket();
+			this.connectionStateMonitor.record(CONNECTION_CHANGE.CLOSED);
 			this.logger.debug(
 				'timeoutStartSubscription',
 				JSON.stringify({ query, variables }),
@@ -844,7 +850,6 @@ export abstract class AWSWebSocketProvider {
 				this.logger.debug(`WebSocket connection error`);
 			};
 			newSocket.onclose = () => {
-				this._closeSocket();
 				reject(new Error('Connection handshake error'));
 			};
 			newSocket.onopen = () => {
@@ -874,7 +879,6 @@ export abstract class AWSWebSocketProvider {
 
 			this.awsRealTimeSocket.onclose = event => {
 				this.logger.debug(`WebSocket closed ${event.reason}`);
-				this._closeSocket();
 				reject(new Error(JSON.stringify(event)));
 			};
 
@@ -938,11 +942,7 @@ export abstract class AWSWebSocketProvider {
 			return;
 		}
 
-		// Setup a keep alive heartbeat for this connection
-		this.keepAliveHeartbeatIntervalId = setInterval(() => {
-			this.keepAliveHeartbeat(connectionTimeoutMs);
-		}, DEFAULT_KEEP_ALIVE_HEARTBEAT_TIMEOUT);
-
+		this.keepAliveTimeout = connectionTimeoutMs;
 		this.awsRealTimeSocket.onmessage =
 			this._handleIncomingSubscriptionMessage.bind(this);
 
@@ -953,7 +953,6 @@ export abstract class AWSWebSocketProvider {
 
 		this.awsRealTimeSocket.onclose = event => {
 			this.logger.debug(`WebSocket closed ${event.reason}`);
-			this._closeSocket();
 			this._errorDisconnect(CONTROL_MSG.CONNECTION_CLOSED);
 		};
 	}

package/src/Providers/constants.ts

@@ -128,11 +128,6 @@ export const START_ACK_TIMEOUT = 15000;
  */
 export const DEFAULT_KEEP_ALIVE_TIMEOUT = 5 * 60 * 1000;
 
-/**
- * Default Time in milleseconds between monitoring checks of keep alive status
- */
-export const DEFAULT_KEEP_ALIVE_HEARTBEAT_TIMEOUT = 5 * 1000;
-
 /**
  * Default Time in milleseconds to alert for missed GQL_CONNECTION_KEEP_ALIVE message
  */

package/src/internals/events/index.ts

@@ -70,7 +70,7 @@ async function connect(
 	};
 
 	// WS publish is not enabled in the service yet. It will be a follow up feature
-	const _pub = async (
+	const pub = async (
 		event: DocumentType,
 		pubOptions?: EventsOptions,
 	): Promise<any> => {
@@ -94,7 +94,7 @@ async function connect(
 	return {
 		subscribe: sub,
 		close,
-		// publish: pub,
+		publish: pub,
 	};
 }
 

package/src/internals/events/types.ts

@@ -3,6 +3,7 @@
 
 import { Subscription } from 'rxjs';
 import type { GraphQLAuthMode } from '@aws-amplify/core/internals/utils';
+import { DocumentType } from '@aws-amplify/core/internals/utils';
 
 export interface SubscriptionObserver<T> {
 	next(value: T): void;
@@ -51,6 +52,15 @@ export interface EventsChannel {
 	 *
 	 */
 	close(): void;
+	/**
+	 *
+	 * @param event
+	 * @param pubOptions
+	 *
+	 * @example
+	 * await channel.publish({ some: "data" });
+	 */
+	publish(event: DocumentType, pubOptions?: EventsOptions): Promise<any>;
 }
 
 export type ResolvedGraphQLAuthModes = Exclude<GraphQLAuthMode, 'identityPool'>;