aws-appsync-subscription-link 3.0.9 → 3.1.0

package/CHANGELOG.md

@@ -3,6 +3,36 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+<a name="3.1.0"></a>
+# [3.1.0](https://github.com/awslabs/aws-mobile-appsync-sdk-js/compare/aws-appsync-subscription-link@3.0.11...aws-appsync-subscription-link@3.1.0) (2022-06-24)
+
+
+### Features
+
+* Add keepAliveTimeoutMs config for AppSync WebSocket link ([#724](https://github.com/awslabs/aws-mobile-appsync-sdk-js/issues/724)) ([74b8351](https://github.com/awslabs/aws-mobile-appsync-sdk-js/commit/74b8351))
+
+
+
+
+<a name="3.0.11"></a>
+## [3.0.11](https://github.com/awslabs/aws-mobile-appsync-sdk-js/compare/aws-appsync-subscription-link@3.0.10...aws-appsync-subscription-link@3.0.11) (2022-05-02)
+
+
+
+
+**Note:** Version bump only for package aws-appsync-subscription-link
+
+<a name="3.0.10"></a>
+## [3.0.10](https://github.com/awslabs/aws-mobile-appsync-sdk-js/compare/aws-appsync-subscription-link@3.0.9...aws-appsync-subscription-link@3.0.10) (2022-03-04)
+
+
+### Bug Fixes
+
+* Port over Amplify fix for subscription race conditions ([#509](https://github.com/awslabs/aws-mobile-appsync-sdk-js/issues/509)) ([#704](https://github.com/awslabs/aws-mobile-appsync-sdk-js/issues/704)) ([92b50c4](https://github.com/awslabs/aws-mobile-appsync-sdk-js/commit/92b50c4))
+
+
+
+
 <a name="3.0.9"></a>
 ## [3.0.9](https://github.com/awslabs/aws-mobile-appsync-sdk-js/compare/aws-appsync-subscription-link@3.0.8...aws-appsync-subscription-link@3.0.9) (2021-09-24)
 

package/__tests__/link/realtime-subscription-handshake-link-test.ts

@@ -2,11 +2,15 @@ import { AUTH_TYPE } from "aws-appsync-auth-link";
 import { execute } from "@apollo/client/core";
 import gql from 'graphql-tag';
 import { AppSyncRealTimeSubscriptionHandshakeLink } from '../../src/realtime-subscription-handshake-link';
+import { MESSAGE_TYPES } from "../../src/types";
+import { v4 as uuid } from "uuid";
+jest.mock('uuid', () => ({ v4: jest.fn() }));
 
 const query = gql`subscription { someSubscription { aField } }`
 
 class myWebSocket implements WebSocket {
-    binaryType: BinaryType; bufferedAmount: number;
+    binaryType: BinaryType;
+    bufferedAmount: number;
     extensions: string;
     onclose: (this: WebSocket, ev: CloseEvent) => any;
     onerror: (this: WebSocket, ev: Event) => any;
@@ -49,8 +53,22 @@ describe("RealTime subscription link", () => {
                 type: AUTH_TYPE.API_KEY,
                 apiKey: 'xxxxx'
             },
-            region: 'us-east-1',
-            url: 'https://xxxxx.appsync-api.amazonaws.com/graphql'
+            region: 'us-west-2',
+            url: 'https://firsttesturl12345678901234.appsync-api.us-west-2.amazonaws.com/graphql'
+        });
+
+        expect(link).toBeInstanceOf(AppSyncRealTimeSubscriptionHandshakeLink);
+    });
+
+    test("Can instantiate link with custom domain", () => {
+        expect.assertions(1);
+        const link = new AppSyncRealTimeSubscriptionHandshakeLink({
+            auth: {
+                type: AUTH_TYPE.API_KEY,
+                apiKey: 'xxxxx'
+            },
+            region: 'us-west-2',
+            url: 'https://test1.testcustomdomain.com/graphql'
         });
 
         expect(link).toBeInstanceOf(AppSyncRealTimeSubscriptionHandshakeLink);
@@ -62,7 +80,7 @@ describe("RealTime subscription link", () => {
             return "2019-11-13T18:47:04.733Z";
         }));
         AppSyncRealTimeSubscriptionHandshakeLink.createWebSocket = jest.fn((url, protocol) => {
-            expect(url).toBe('wss://xxxxx.appsync-realtime-api.amazonaws.com/graphql?header=eyJob3N0IjoieHh4eHguYXBwc3luYy1hcGkuYW1hem9uYXdzLmNvbSIsIngtYW16LWRhdGUiOiIyMDE5MTExM1QxODQ3MDRaIiwieC1hcGkta2V5IjoieHh4eHgifQ==&payload=e30=');
+            expect(url).toBe('wss://apikeytesturl1234567890123.appsync-realtime-api.us-west-2.amazonaws.com/graphql?header=eyJob3N0IjoiYXBpa2V5dGVzdHVybDEyMzQ1Njc4OTAxMjMuYXBwc3luYy1hcGkudXMtd2VzdC0yLmFtYXpvbmF3cy5jb20iLCJ4LWFtei1kYXRlIjoiMjAxOTExMTNUMTg0NzA0WiIsIngtYXBpLWtleSI6Inh4eHh4In0=&payload=e30=');
             expect(protocol).toBe('graphql-ws');
             done();
             return new myWebSocket();
@@ -72,13 +90,50 @@ describe("RealTime subscription link", () => {
                 type: AUTH_TYPE.API_KEY,
                 apiKey: 'xxxxx'
             },
-            region: 'us-east-1',
-            url: 'https://xxxxx.appsync-api.amazonaws.com/graphql'
+            region: 'us-west-2',
+            url: 'https://apikeytesturl1234567890123.appsync-api.us-west-2.amazonaws.com/graphql'
         });
 
         execute(link, { query }).subscribe({
             error: (err) => {
-                console.log({ err });
+                console.log(JSON.stringify(err));
+                fail;
+            },
+            next: (data) => {
+                console.log({ data });
+                done();
+            },
+            complete: () => {
+                console.log('done with this');
+                done();
+            }
+
+        });
+    });
+
+    test("Initialize WebSocket correctly for API KEY with custom domain", (done) => {
+        expect.assertions(2);
+        jest.spyOn(Date.prototype, 'toISOString').mockImplementation(jest.fn(() => {
+            return "2019-11-13T18:47:04.733Z";
+        }));
+        AppSyncRealTimeSubscriptionHandshakeLink.createWebSocket = jest.fn((url, protocol) => {
+            expect(url).toBe('wss://apikeytest.testcustomdomain.com/graphql/realtime?header=eyJob3N0IjoiYXBpa2V5dGVzdC50ZXN0Y3VzdG9tZG9tYWluLmNvbSIsIngtYW16LWRhdGUiOiIyMDE5MTExM1QxODQ3MDRaIiwieC1hcGkta2V5IjoieHh4eHgifQ==&payload=e30=');
+            expect(protocol).toBe('graphql-ws');
+            done();
+            return new myWebSocket();
+        });
+        const link = new AppSyncRealTimeSubscriptionHandshakeLink({
+            auth: {
+                type: AUTH_TYPE.API_KEY,
+                apiKey: 'xxxxx'
+            },
+            region: 'us-west-2',
+            url: 'https://apikeytest.testcustomdomain.com/graphql'
+        });
+
+        execute(link, { query }).subscribe({
+            error: (err) => {
+                console.log(JSON.stringify(err));
                 fail;
             },
             next: (data) => {
@@ -99,7 +154,7 @@ describe("RealTime subscription link", () => {
             return "2019-11-13T18:47:04.733Z";
         }));
         AppSyncRealTimeSubscriptionHandshakeLink.createWebSocket = jest.fn((url, protocol) => {
-            expect(url).toBe('wss://xxxxx.appsync-realtime-api.amazonaws.com/graphql?header=eyJBdXRob3JpemF0aW9uIjoidG9rZW4iLCJob3N0IjoieHh4eHguYXBwc3luYy1hcGkuYW1hem9uYXdzLmNvbSJ9&payload=e30=');
+            expect(url).toBe('wss://cognitouserpooltesturl1234.appsync-realtime-api.us-west-2.amazonaws.com/graphql?header=eyJBdXRob3JpemF0aW9uIjoidG9rZW4iLCJob3N0IjoiY29nbml0b3VzZXJwb29sdGVzdHVybDEyMzQuYXBwc3luYy1hcGkudXMtd2VzdC0yLmFtYXpvbmF3cy5jb20ifQ==&payload=e30=');
             expect(protocol).toBe('graphql-ws');
             done();
             return new myWebSocket();
@@ -109,13 +164,50 @@ describe("RealTime subscription link", () => {
                 type: AUTH_TYPE.AMAZON_COGNITO_USER_POOLS,
                 jwtToken: 'token'
             },
-            region: 'us-east-1',
-            url: 'https://xxxxx.appsync-api.amazonaws.com/graphql'
+            region: 'us-west-2',
+            url: 'https://cognitouserpooltesturl1234.appsync-api.us-west-2.amazonaws.com/graphql'
         });
 
         execute(link, { query }).subscribe({
             error: (err) => {
-                console.log({ err });
+                console.log(JSON.stringify(err));
+                fail;
+            },
+            next: (data) => {
+                console.log({ data });
+                done();
+            },
+            complete: () => {
+                console.log('done with this');
+                done();
+            }
+
+        });
+    });
+
+    test("Initialize WebSocket correctly for COGNITO USER POOLS with custom domain", (done) => {
+        expect.assertions(2);
+        jest.spyOn(Date.prototype, 'toISOString').mockImplementation(jest.fn(() => {
+            return "2019-11-13T18:47:04.733Z";
+        }));
+        AppSyncRealTimeSubscriptionHandshakeLink.createWebSocket = jest.fn((url, protocol) => {
+            expect(url).toBe('wss://cognitouserpools.testcustomdomain.com/graphql/realtime?header=eyJBdXRob3JpemF0aW9uIjoidG9rZW4iLCJob3N0IjoiY29nbml0b3VzZXJwb29scy50ZXN0Y3VzdG9tZG9tYWluLmNvbSJ9&payload=e30=');
+            expect(protocol).toBe('graphql-ws');
+            done();
+            return new myWebSocket();
+        });
+        const link = new AppSyncRealTimeSubscriptionHandshakeLink({
+            auth: {
+                type: AUTH_TYPE.AMAZON_COGNITO_USER_POOLS,
+                jwtToken: 'token'
+            },
+            region: 'us-west-2',
+            url: 'https://cognitouserpools.testcustomdomain.com/graphql'
+        });
+
+        execute(link, { query }).subscribe({
+            error: (err) => {
+                console.log(JSON.stringify(err));
                 fail;
             },
             next: (data) => {
@@ -136,7 +228,44 @@ describe("RealTime subscription link", () => {
             return "2019-11-13T18:47:04.733Z";
         }));
         AppSyncRealTimeSubscriptionHandshakeLink.createWebSocket = jest.fn((url, protocol) => {
-            expect(url).toBe('wss://xxxxx.appsync-realtime-api.amazonaws.com/graphql?header=eyJBdXRob3JpemF0aW9uIjoidG9rZW4iLCJob3N0IjoieHh4eHguYXBwc3luYy1hcGkuYW1hem9uYXdzLmNvbSJ9&payload=e30=');
+            expect(url).toBe('wss://openidconnecttesturl123456.appsync-realtime-api.us-west-2.amazonaws.com/graphql?header=eyJBdXRob3JpemF0aW9uIjoidG9rZW4iLCJob3N0Ijoib3BlbmlkY29ubmVjdHRlc3R1cmwxMjM0NTYuYXBwc3luYy1hcGkudXMtd2VzdC0yLmFtYXpvbmF3cy5jb20ifQ==&payload=e30=');
+            expect(protocol).toBe('graphql-ws');
+            done();
+            return new myWebSocket();
+        });
+        const link = new AppSyncRealTimeSubscriptionHandshakeLink({
+            auth: {
+                type: AUTH_TYPE.OPENID_CONNECT,
+                jwtToken: 'token'
+            },
+            region: 'us-west-2',
+            url: 'https://openidconnecttesturl123456.appsync-api.us-west-2.amazonaws.com/graphql'
+        });
+
+        execute(link, { query }).subscribe({
+            error: (err) => {
+                console.log(JSON.stringify(err));
+                fail;
+            },
+            next: (data) => {
+                console.log({ data });
+                done();
+            },
+            complete: () => {
+                console.log('done with this');
+                done();
+            }
+
+        });
+    });
+
+    test("Initialize WebSocket correctly for OPENID_CONNECT with custom domain", (done) => {
+        expect.assertions(2);
+        jest.spyOn(Date.prototype, 'toISOString').mockImplementation(jest.fn(() => {
+            return "2019-11-13T18:47:04.733Z";
+        }));
+        AppSyncRealTimeSubscriptionHandshakeLink.createWebSocket = jest.fn((url, protocol) => {
+            expect(url).toBe('wss://openidconnecttesturl.testcustomdomain.com/graphql/realtime?header=eyJBdXRob3JpemF0aW9uIjoidG9rZW4iLCJob3N0Ijoib3BlbmlkY29ubmVjdHRlc3R1cmwudGVzdGN1c3RvbWRvbWFpbi5jb20ifQ==&payload=e30=');
             expect(protocol).toBe('graphql-ws');
             done();
             return new myWebSocket();
@@ -146,13 +275,13 @@ describe("RealTime subscription link", () => {
                 type: AUTH_TYPE.OPENID_CONNECT,
                 jwtToken: 'token'
             },
-            region: 'us-east-1',
-            url: 'https://xxxxx.appsync-api.amazonaws.com/graphql'
+            region: 'us-west-2',
+            url: 'https://openidconnecttesturl.testcustomdomain.com/graphql'
         });
 
         execute(link, { query }).subscribe({
             error: (err) => {
-                console.log({ err });
+                console.log(JSON.stringify(err));
                 fail;
             },
             next: (data) => {
@@ -173,7 +302,7 @@ describe("RealTime subscription link", () => {
             return "2019-11-13T18:47:04.733Z";
         }));
         AppSyncRealTimeSubscriptionHandshakeLink.createWebSocket = jest.fn((url, protocol) => {
-            expect(url).toBe('wss://xxxxx.appsync-realtime-api.amazonaws.com/graphql?header=eyJBdXRob3JpemF0aW9uIjoidG9rZW4iLCJob3N0IjoieHh4eHguYXBwc3luYy1hcGkuYW1hem9uYXdzLmNvbSJ9&payload=e30=');
+            expect(url).toBe('wss://awslambdatesturl1234567890.appsync-realtime-api.us-west-2.amazonaws.com/graphql?header=eyJBdXRob3JpemF0aW9uIjoidG9rZW4iLCJob3N0IjoiYXdzbGFtYmRhdGVzdHVybDEyMzQ1Njc4OTAuYXBwc3luYy1hcGkudXMtd2VzdC0yLmFtYXpvbmF3cy5jb20ifQ==&payload=e30=');
             expect(protocol).toBe('graphql-ws');
             done();
             return new myWebSocket();
@@ -183,8 +312,8 @@ describe("RealTime subscription link", () => {
                 type: AUTH_TYPE.AWS_LAMBDA,
                 token: 'token'
             },
-            region: 'us-east-1',
-            url: 'https://xxxxx.appsync-api.amazonaws.com/graphql'
+            region: 'us-west-2',
+            url: 'https://awslambdatesturl1234567890.appsync-api.us-west-2.amazonaws.com/graphql'
         });
 
         execute(link, { query }).subscribe({
@@ -201,4 +330,196 @@ describe("RealTime subscription link", () => {
         });
     })
 
+    test('Initialize WebSocket correctly for AWS_LAMBDA with custom domain', (done) => {
+        expect.assertions(2);
+        jest.spyOn(Date.prototype, 'toISOString').mockImplementation(jest.fn(() => {
+            return "2019-11-13T18:47:04.733Z";
+        }));
+        AppSyncRealTimeSubscriptionHandshakeLink.createWebSocket = jest.fn((url, protocol) => {
+            expect(url).toBe('wss://awslambdatesturl.testcustomdomain.com/graphql/realtime?header=eyJBdXRob3JpemF0aW9uIjoidG9rZW4iLCJob3N0IjoiYXdzbGFtYmRhdGVzdHVybC50ZXN0Y3VzdG9tZG9tYWluLmNvbSJ9&payload=e30=');
+            expect(protocol).toBe('graphql-ws');
+            done();
+            return new myWebSocket();
+        });
+        const link = new AppSyncRealTimeSubscriptionHandshakeLink({
+            auth: {
+                type: AUTH_TYPE.AWS_LAMBDA,
+                token: 'token'
+            },
+            region: 'us-west-2',
+            url: 'https://awslambdatesturl.testcustomdomain.com/graphql'
+        });
+
+        execute(link, { query }).subscribe({
+            error: (err) => {
+                fail;
+            },
+            next: (data) => {
+                done();
+            },
+            complete: () => {
+                done();
+            }
+
+        });
+    });
+
+    test("Can use a custom keepAliveTimeoutMs", (done) => {
+        const id = "abcd-efgh-ijkl-mnop";
+        uuid.mockImplementationOnce(() => id);
+
+        expect.assertions(5);
+        jest.spyOn(Date.prototype, 'toISOString').mockImplementation(jest.fn(() => {
+            return "2019-11-13T18:47:04.733Z";
+        }));
+        AppSyncRealTimeSubscriptionHandshakeLink.createWebSocket = jest.fn((url, protocol) => {
+            expect(url).toBe('wss://apikeytest.testcustomdomain.com/graphql/realtime?header=eyJob3N0IjoiYXBpa2V5dGVzdC50ZXN0Y3VzdG9tZG9tYWluLmNvbSIsIngtYW16LWRhdGUiOiIyMDE5MTExM1QxODQ3MDRaIiwieC1hcGkta2V5IjoieHh4eHgifQ==&payload=e30=');
+            expect(protocol).toBe('graphql-ws');
+            const socket = new myWebSocket();
+
+            setTimeout(() => {
+                socket.close = () => {};
+                socket.onopen.call(socket, (undefined as unknown as Event));
+                socket.send = (msg: string) => {
+                    const { type } = JSON.parse(msg);
+
+                    switch (type) {
+                        case MESSAGE_TYPES.GQL_CONNECTION_INIT:
+                            socket.onmessage.call(socket, {
+                                data: JSON.stringify({
+                                    type: MESSAGE_TYPES.GQL_CONNECTION_ACK,
+                                    payload: {
+                                        connectionTimeoutMs: 99999,
+                                    },
+                                })
+                            } as MessageEvent);
+                            setTimeout(() => {
+                                socket.onmessage.call(socket, {
+                                    data: JSON.stringify({
+                                        id,
+                                        type: MESSAGE_TYPES.GQL_DATA,
+                                        payload: {
+                                            data: { something: 123 },
+                                        },
+                                    })
+                                } as MessageEvent);
+
+                            }, 100);
+                            break;
+                    }
+                };
+            }, 100);
+
+            return socket;
+        });
+        const link = new AppSyncRealTimeSubscriptionHandshakeLink({
+            auth: {
+                type: AUTH_TYPE.API_KEY,
+                apiKey: 'xxxxx'
+            },
+            region: 'us-west-2',
+            url: 'https://apikeytest.testcustomdomain.com/graphql',
+            keepAliveTimeoutMs: 123456,
+        });
+
+        expect(link).toBeInstanceOf(AppSyncRealTimeSubscriptionHandshakeLink);
+        expect((link as any).keepAliveTimeout).toBe(123456);
+
+        const sub = execute(link, { query }).subscribe({
+            error: (err) => {
+                console.log(JSON.stringify(err));
+                fail();
+            },
+            next: (data) => {
+                expect((link as any).keepAliveTimeout).toBe(123456);
+                done();
+                sub.unsubscribe();
+            },
+            complete: () => {
+                console.log('done with this');
+                fail();
+            }
+
+        });
+    });
+
+    test("Uses service-provided timeout when no custom keepAliveTimeoutMs is configured", (done) => {
+        const id = "abcd-efgh-ijkl-mnop";
+        uuid.mockImplementationOnce(() => id);
+
+        expect.assertions(5);
+        jest.spyOn(Date.prototype, 'toISOString').mockImplementation(jest.fn(() => {
+            return "2019-11-13T18:47:04.733Z";
+        }));
+        AppSyncRealTimeSubscriptionHandshakeLink.createWebSocket = jest.fn((url, protocol) => {
+            expect(url).toBe('wss://apikeytest.testcustomdomain.com/graphql/realtime?header=eyJob3N0IjoiYXBpa2V5dGVzdC50ZXN0Y3VzdG9tZG9tYWluLmNvbSIsIngtYW16LWRhdGUiOiIyMDE5MTExM1QxODQ3MDRaIiwieC1hcGkta2V5IjoieHh4eHgifQ==&payload=e30=');
+            expect(protocol).toBe('graphql-ws');
+            const socket = new myWebSocket();
+
+            setTimeout(() => {
+                socket.close = () => {};
+                socket.onopen.call(socket, (undefined as unknown as Event));
+                socket.send = (msg: string) => {
+                    const { type } = JSON.parse(msg);
+
+                    switch (type) {
+                        case MESSAGE_TYPES.GQL_CONNECTION_INIT:
+                            socket.onmessage.call(socket, {
+                                data: JSON.stringify({
+                                    type: MESSAGE_TYPES.GQL_CONNECTION_ACK,
+                                    payload: {
+                                        connectionTimeoutMs: 99999,
+                                    },
+                                })
+                            } as MessageEvent);
+                            setTimeout(() => {
+                                socket.onmessage.call(socket, {
+                                    data: JSON.stringify({
+                                        id,
+                                        type: MESSAGE_TYPES.GQL_DATA,
+                                        payload: {
+                                            data: { something: 123 },
+                                        },
+                                    })
+                                } as MessageEvent);
+
+                            }, 100);
+                            break;
+                    }
+                };
+            }, 100);
+
+            return socket;
+        });
+        const link = new AppSyncRealTimeSubscriptionHandshakeLink({
+            auth: {
+                type: AUTH_TYPE.API_KEY,
+                apiKey: 'xxxxx'
+            },
+            region: 'us-west-2',
+            url: 'https://apikeytest.testcustomdomain.com/graphql',
+        });
+
+        expect(link).toBeInstanceOf(AppSyncRealTimeSubscriptionHandshakeLink);
+        expect((link as any).keepAliveTimeout).toBeUndefined();
+
+        const sub = execute(link, { query }).subscribe({
+            error: (err) => {
+                console.log(JSON.stringify(err));
+                fail();
+            },
+            next: (data) => {
+                expect((link as any).keepAliveTimeout).toBe(99999);
+                done();
+                sub.unsubscribe();
+            },
+            complete: () => {
+                console.log('done with this');
+                fail();
+            }
+
+        });
+    });
+
+
 });

package/lib/index.d.ts

@@ -1,6 +1,6 @@
 import { CONTROL_EVENTS_KEY } from "./subscription-handshake-link";
 import { ApolloLink } from "@apollo/client/core";
-import { UrlInfo } from "./types";
-declare function createSubscriptionHandshakeLink(args: UrlInfo, resultsFetcherLink?: ApolloLink): ApolloLink;
+import { AppSyncRealTimeSubscriptionConfig } from "./types";
+declare function createSubscriptionHandshakeLink(args: AppSyncRealTimeSubscriptionConfig, resultsFetcherLink?: ApolloLink): ApolloLink;
 declare function createSubscriptionHandshakeLink(url: string, resultsFetcherLink?: ApolloLink): ApolloLink;
 export { CONTROL_EVENTS_KEY, createSubscriptionHandshakeLink };

package/lib/realtime-subscription-handshake-link.d.ts

@@ -1,9 +1,9 @@
 /*!
- * Copyright 2017-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 2017-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
 import { ApolloLink, Observable, Operation, FetchResult } from "@apollo/client/core";
-import { UrlInfo } from "./types";
+import { AppSyncRealTimeSubscriptionConfig } from "./types";
 export declare const CONTROL_EVENTS_KEY = "@@controlEvents";
 export declare class AppSyncRealTimeSubscriptionHandshakeLink extends ApolloLink {
     private url;
@@ -12,17 +12,16 @@ export declare class AppSyncRealTimeSubscriptionHandshakeLink extends ApolloLink
     private awsRealTimeSocket;
     private socketStatus;
     private keepAliveTimeoutId;
-    private keepAliveTimeout;
+    private keepAliveTimeout?;
     private subscriptionObserverMap;
     private promiseArray;
-    constructor({ url: theUrl, region: theRegion, auth: theAuth }: UrlInfo);
-    request(operation: Operation): Observable<FetchResult<{
-        [key: string]: any;
-    }, Record<string, any>, Record<string, any>>>;
+    constructor({ url: theUrl, region: theRegion, auth: theAuth, keepAliveTimeoutMs }: AppSyncRealTimeSubscriptionConfig);
+    private isCustomDomain;
+    request(operation: Operation): Observable<FetchResult<Record<string, any>, Record<string, any>, Record<string, any>>>;
     private _verifySubscriptionAlreadyStarted;
     private _sendUnsubscriptionMessage;
     private _removeSubscriptionObserver;
-    private _closeSocketWhenFlushed;
+    private _closeSocketIfRequired;
     private _startSubscriptionWithAWSAppSyncRealTime;
     private _initializeWebSocketConnection;
     private _awsRealTimeHeaderBasedAuth;
@@ -35,5 +34,4 @@ export declare class AppSyncRealTimeSubscriptionHandshakeLink extends ApolloLink
     private _errorDisconnect;
     private _timeoutStartSubscriptionAck;
     static createWebSocket(awsRealTimeUrl: string, protocol: string): WebSocket;
-    private static _discoverAppSyncRealTimeEndpoint;
 }

package/lib/realtime-subscription-handshake-link.js

@@ -61,7 +61,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /*!
- * Copyright 2017-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 2017-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
 var core_1 = require("@apollo/client/core");
@@ -89,24 +89,39 @@ var CONNECTION_INIT_TIMEOUT = 15000;
  * Time in milliseconds to wait for GQL_START_ACK message
  */
 var START_ACK_TIMEOUT = 15000;
+/**
+ * Frequency in milliseconds in which the server sends GQL_CONNECTION_KEEP_ALIVE messages
+ */
+var SERVER_KEEP_ALIVE_TIMEOUT = 1 * 60 * 1000;
 /**
  * Default Time in milliseconds to wait for GQL_CONNECTION_KEEP_ALIVE message
  */
 var DEFAULT_KEEP_ALIVE_TIMEOUT = 5 * 60 * 1000;
+var standardDomainPattern = /^https:\/\/\w{26}\.appsync\-api\.\w{2}(?:(?:\-\w{2,})+)\-\d\.amazonaws.com\/graphql$/i;
+var customDomainPath = '/realtime';
 var AppSyncRealTimeSubscriptionHandshakeLink = /** @class */ (function (_super) {
     __extends(AppSyncRealTimeSubscriptionHandshakeLink, _super);
     function AppSyncRealTimeSubscriptionHandshakeLink(_a) {
-        var theUrl = _a.url, theRegion = _a.region, theAuth = _a.auth;
+        var theUrl = _a.url, theRegion = _a.region, theAuth = _a.auth, keepAliveTimeoutMs = _a.keepAliveTimeoutMs;
         var _this = _super.call(this) || this;
         _this.socketStatus = types_1.SOCKET_STATUS.CLOSED;
-        _this.keepAliveTimeout = DEFAULT_KEEP_ALIVE_TIMEOUT;
+        _this.keepAliveTimeout = undefined;
         _this.subscriptionObserverMap = new Map();
         _this.promiseArray = [];
         _this.url = theUrl;
         _this.region = theRegion;
         _this.auth = theAuth;
+        _this.keepAliveTimeout = keepAliveTimeoutMs;
+        if (_this.keepAliveTimeout < SERVER_KEEP_ALIVE_TIMEOUT) {
+            var configName = 'keepAliveTimeoutMs';
+            throw new Error(configName + " must be greater than or equal to " + SERVER_KEEP_ALIVE_TIMEOUT + " (" + _this.keepAliveTimeout + " used).");
+        }
         return _this;
     }
+    // Check if url matches standard domain pattern
+    AppSyncRealTimeSubscriptionHandshakeLink.prototype.isCustomDomain = function (url) {
+        return url.match(standardDomainPattern) === null;
+    };
     AppSyncRealTimeSubscriptionHandshakeLink.prototype.request = function (operation) {
         var _a;
         var _this = this;
@@ -220,22 +235,25 @@ var AppSyncRealTimeSubscriptionHandshakeLink = /** @class */ (function (_super)
     };
     AppSyncRealTimeSubscriptionHandshakeLink.prototype._removeSubscriptionObserver = function (subscriptionId) {
         this.subscriptionObserverMap.delete(subscriptionId);
-        if (this.subscriptionObserverMap.size === 0) {
-            // Socket could be sending data to unsubscribe so is required to wait until is flushed
-            this._closeSocketWhenFlushed();
-        }
+        // Verifying for 1000ms after removing subscription in case there are new subscriptions on mount / unmount
+        setTimeout(this._closeSocketIfRequired.bind(this), 1000);
     };
-    AppSyncRealTimeSubscriptionHandshakeLink.prototype._closeSocketWhenFlushed = function () {
-        logger("closing WebSocket...");
-        clearTimeout(this.keepAliveTimeoutId);
+    AppSyncRealTimeSubscriptionHandshakeLink.prototype._closeSocketIfRequired = function () {
+        if (this.subscriptionObserverMap.size > 0) {
+            // There are active subscriptions on the WebSocket
+            return;
+        }
         if (!this.awsRealTimeSocket) {
             this.socketStatus = types_1.SOCKET_STATUS.CLOSED;
             return;
         }
         if (this.awsRealTimeSocket.bufferedAmount > 0) {
-            setTimeout(this._closeSocketWhenFlushed.bind(this), 1000);
+            // There is still data on the WebSocket
+            setTimeout(this._closeSocketIfRequired.bind(this), 1000);
         }
         else {
+            logger("closing WebSocket...");
+            clearTimeout(this.keepAliveTimeoutId);
             var tempSocket = this.awsRealTimeSocket;
             tempSocket.close(1000);
             this.awsRealTimeSocket = null;
@@ -349,7 +367,7 @@ var AppSyncRealTimeSubscriptionHandshakeLink = /** @class */ (function (_super)
             return;
         }
         return new Promise(function (res, rej) { return __awaiter(_this, void 0, void 0, function () {
-            var discoverableEndpoint, payloadString, headerString, _a, _b, headerQs, payloadQs, awsRealTimeUrl, err_2;
+            var payloadString, headerString, _a, _b, headerQs, payloadQs, discoverableEndpoint, awsRealTimeUrl, err_2;
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
@@ -359,7 +377,6 @@ var AppSyncRealTimeSubscriptionHandshakeLink = /** @class */ (function (_super)
                     case 1:
                         _c.trys.push([1, 4, , 5]);
                         this.socketStatus = types_1.SOCKET_STATUS.CONNECTING;
-                        discoverableEndpoint = AppSyncRealTimeSubscriptionHandshakeLink._discoverAppSyncRealTimeEndpoint(this.url);
                         payloadString = "{}";
                         _b = (_a = JSON).stringify;
                         return [4 /*yield*/, this._awsRealTimeHeaderBasedAuth({
@@ -377,6 +394,16 @@ var AppSyncRealTimeSubscriptionHandshakeLink = /** @class */ (function (_super)
                         headerString = _b.apply(_a, [_c.sent()]);
                         headerQs = Buffer.from(headerString).toString("base64");
                         payloadQs = Buffer.from(payloadString).toString("base64");
+                        discoverableEndpoint = appSyncGraphqlEndpoint;
+                        if (this.isCustomDomain(discoverableEndpoint)) {
+                            discoverableEndpoint = discoverableEndpoint.concat(customDomainPath);
+                        }
+                        else {
+                            discoverableEndpoint = discoverableEndpoint.replace('appsync-api', 'appsync-realtime-api').replace('gogi-beta', 'grt-beta');
+                        }
+                        discoverableEndpoint = discoverableEndpoint
+                            .replace("https://", "wss://")
+                            .replace('http://', 'ws://');
                         awsRealTimeUrl = discoverableEndpoint + "?header=" + headerQs + "&payload=" + payloadQs;
                         return [4 /*yield*/, this._initializeRetryableHandshake({ awsRealTimeUrl: awsRealTimeUrl })];
                     case 3:
@@ -588,12 +615,13 @@ var AppSyncRealTimeSubscriptionHandshakeLink = /** @class */ (function (_super)
                                         rej(new Error(JSON.stringify(event)));
                                     };
                                     _this.awsRealTimeSocket.onmessage = function (message) {
+                                        var _a;
                                         logger("subscription message from AWS AppSyncRealTime: " + message.data + " ");
                                         var data = JSON.parse(message.data);
-                                        var type = data.type, _a = data.payload, _b = (_a === void 0 ? {} : _a).connectionTimeoutMs, connectionTimeoutMs = _b === void 0 ? DEFAULT_KEEP_ALIVE_TIMEOUT : _b;
+                                        var type = data.type, _b = data.payload, _c = (_b === void 0 ? {} : _b).connectionTimeoutMs, connectionTimeoutMs = _c === void 0 ? DEFAULT_KEEP_ALIVE_TIMEOUT : _c;
                                         if (type === types_1.MESSAGE_TYPES.GQL_CONNECTION_ACK) {
                                             ackOk = true;
-                                            _this.keepAliveTimeout = connectionTimeoutMs;
+                                            _this.keepAliveTimeout = (_a = _this.keepAliveTimeout) !== null && _a !== void 0 ? _a : connectionTimeoutMs;
                                             _this.awsRealTimeSocket.onmessage = _this._handleIncomingSubscriptionMessage.bind(_this);
                                             _this.awsRealTimeSocket.onerror = function (err) {
                                                 logger(err);
@@ -607,7 +635,7 @@ var AppSyncRealTimeSubscriptionHandshakeLink = /** @class */ (function (_super)
                                             return;
                                         }
                                         if (type === types_1.MESSAGE_TYPES.GQL_CONNECTION_ERROR) {
-                                            var _c = data.payload, _d = (_c === void 0 ? {} : _c).errors, _e = (_d === void 0 ? [] : _d)[0], _f = _e === void 0 ? {} : _e, _g = _f.errorType, errorType = _g === void 0 ? "" : _g, _h = _f.errorCode, errorCode = _h === void 0 ? 0 : _h;
+                                            var _d = data.payload, _e = (_d === void 0 ? {} : _d).errors, _f = (_e === void 0 ? [] : _e)[0], _g = _f === void 0 ? {} : _f, _h = _g.errorType, errorType = _h === void 0 ? "" : _h, _j = _g.errorCode, errorCode = _j === void 0 ? 0 : _j;
                                             rej({ errorType: errorType, errorCode: errorCode });
                                         }
                                     };
@@ -757,13 +785,6 @@ var AppSyncRealTimeSubscriptionHandshakeLink = /** @class */ (function (_super)
     AppSyncRealTimeSubscriptionHandshakeLink.createWebSocket = function (awsRealTimeUrl, protocol) {
         return new WebSocket(awsRealTimeUrl, protocol);
     };
-    AppSyncRealTimeSubscriptionHandshakeLink._discoverAppSyncRealTimeEndpoint = function (url) {
-        return url
-            .replace("https://", "wss://")
-            .replace('http://', 'ws://')
-            .replace("appsync-api", "appsync-realtime-api")
-            .replace("gogi-beta", "grt-beta");
-    };
     return AppSyncRealTimeSubscriptionHandshakeLink;
 }(core_1.ApolloLink));
 exports.AppSyncRealTimeSubscriptionHandshakeLink = AppSyncRealTimeSubscriptionHandshakeLink;

package/lib/types/index.d.ts

@@ -71,6 +71,9 @@ export declare type UrlInfo = {
     auth: AuthOptions;
     region: string;
 };
+export declare type AppSyncRealTimeSubscriptionConfig = UrlInfo & {
+    keepAliveTimeoutMs?: number;
+};
 export declare type ObserverQuery = {
     observer: ZenObservable.SubscriptionObserver<any>;
     query: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aws-appsync-subscription-link",
-  "version": "3.0.9",
+  "version": "3.1.0",
   "main": "lib/index.js",
   "license": "Apache-2.0",
   "description": "AWS Mobile AppSync SDK for JavaScript",