update ws protocol

aws-amplify · Oct 18, 2024 · 538dd9f · 538dd9f
1 parent f975992
commit 538dd9f
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 11 deletions.
diff --git a/.github/workflows/push-preid-release.yml b/.github/workflows/push-preid-release.yml
@@ -9,7 +9,7 @@ on:
   push:
     branches:
       # Change this to your branch name where "example-preid" corresponds to the preid you want your changes released on
-      - feat/example-preid-branch/main
+      - feat/events/main
 
 jobs:
   e2e:

diff --git a/packages/api-graphql/src/Providers/AWSAppSyncEventsProvider/index.ts b/packages/api-graphql/src/Providers/AWSAppSyncEventsProvider/index.ts
@@ -42,10 +42,15 @@ interface DataResponse {
 }
 
 const PROVIDER_NAME = 'AWSAppSyncEventsProvider';
+const WS_PROTOCOL_NAME = 'aws-appsync-event-ws';
 
 class AWSAppSyncEventProvider extends AWSWebSocketProvider {
 	constructor() {
-		super(PROVIDER_NAME);
+		super({ providerName: PROVIDER_NAME, wsProtocolName: WS_PROTOCOL_NAME });
+	}
+
+	getProviderName() {
+		return PROVIDER_NAME;
 	}
 
 	public async connect(options: AWSAppSyncEventProviderOptions) {

diff --git a/packages/api-graphql/src/Providers/AWSAppSyncRealTimeProvider/index.ts b/packages/api-graphql/src/Providers/AWSAppSyncRealTimeProvider/index.ts
@@ -41,11 +41,15 @@ interface DataPayload {
 }
 
 const PROVIDER_NAME = 'AWSAppSyncRealTimeProvider';
+const WS_PROTOCOL_NAME = 'graphql-ws';
 
-// get rid of generic. Just map the options from Gogi-specific to general
 export class AWSAppSyncRealTimeProvider extends AWSWebSocketProvider {
 	constructor() {
-		super(PROVIDER_NAME);
+		super({ providerName: PROVIDER_NAME, wsProtocolName: WS_PROTOCOL_NAME });
+	}
+
+	getProviderName() {
+		return PROVIDER_NAME;
 	}
 
 	public subscribe(
@@ -55,10 +59,6 @@ export class AWSAppSyncRealTimeProvider extends AWSWebSocketProvider {
 		return super.subscribe(options, customUserAgentDetails);
 	}
 
-	getProviderName() {
-		return PROVIDER_NAME;
-	}
-
 	protected async _prepareSubscriptionPayload({
 		options,
 		subscriptionId,

diff --git a/packages/api-graphql/src/Providers/AWSWebSocketProvider/index.ts b/packages/api-graphql/src/Providers/AWSWebSocketProvider/index.ts
@@ -70,6 +70,11 @@ interface ParsedMessagePayload {
 	};
 }
 
+interface AWSWebSocketProviderArgs {
+	providerName: string;
+	wsProtocolName: string;
+}
+
 export abstract class AWSWebSocketProvider {
 	protected logger: ConsoleLogger;
 	protected subscriptionObserverMap = new Map<string, ObserverQuery>();
@@ -84,9 +89,11 @@ export abstract class AWSWebSocketProvider {
 	private readonly connectionStateMonitor = new ConnectionStateMonitor();
 	private readonly reconnectionMonitor = new ReconnectionMonitor();
 	private connectionStateMonitorSubscription: SubscriptionLike;
+	private readonly wsProtocolName: string;
 
-	constructor(providerName: string) {
-		this.logger = new ConsoleLogger(providerName);
+	constructor(args: AWSWebSocketProviderArgs) {
+		this.logger = new ConsoleLogger(args.providerName);
+		this.wsProtocolName = args.wsProtocolName;
 
 		this.connectionStateMonitorSubscription =
 			this._startConnectionStateMonitoring();
@@ -774,7 +781,7 @@ export abstract class AWSWebSocketProvider {
 	private async _openConnection(awsRealTimeUrl: string, subprotocol: string) {
 		return new Promise<void>((resolve, reject) => {
 			const newSocket = this._getNewWebSocket(awsRealTimeUrl, [
-				'graphql-ws',
+				this.wsProtocolName,
 				subprotocol,
 			]);