aws-appsync-subscription-link 3.0.11 → 3.1.1

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 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.1"></a>
+## [3.1.1](https://github.com/awslabs/aws-mobile-appsync-sdk-js/compare/aws-appsync-subscription-link@3.1.0...aws-appsync-subscription-link@3.1.1) (2022-10-07)
+
+
+
+
+**Note:** Version bump only for package aws-appsync-subscription-link
+
+<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)
 

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

@@ -2,11 +2,14 @@ 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; 
+    binaryType: BinaryType;
     bufferedAmount: number;
     extensions: string;
     onclose: (this: WebSocket, ev: CloseEvent) => any;
@@ -359,6 +362,164 @@ describe("RealTime subscription link", () => {
             }
 
         });
-    })
+    });
+
+    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

@@ -3,7 +3,7 @@
  * 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,10 +12,10 @@ 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);
+    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;

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

@@ -89,6 +89,10 @@ 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
  */
@@ -98,15 +102,20 @@ 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
@@ -606,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);
@@ -625,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 });
                                         }
                                     };

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

@@ -3,6 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { ApolloLink, Observable, Operation, FetchResult } from "@apollo/client/core";
+import * as ZenObservable from 'zen-observable-ts';
 declare type MqttConnectionInfo = {
     client: string;
     url: string;
@@ -14,7 +15,7 @@ export declare class SubscriptionHandshakeLink extends ApolloLink {
     private topicObservers;
     private clientObservers;
     constructor(subsInfoContextKey: any);
-    request(operation: Operation): Observable<unknown>;
+    request(operation: Operation): Observable<FetchResult> | null;
     connectNewClients(connectionInfo: MqttConnectionInfo[], observer: ZenObservable.Observer<FetchResult>, operation: Operation): Promise<any[]>;
     connectNewClient(connectionInfo: MqttConnectionInfo, observer: ZenObservable.Observer<FetchResult>, selectionNames: string[]): Promise<any>;
     subscribeToTopics<T>(client: any, topics: string[], observer: ZenObservable.Observer<T>): Promise<unknown[]>;

package/lib/types/index.d.ts

@@ -1,4 +1,5 @@
 import { AuthOptions } from "aws-appsync-auth-link";
+import * as ZenObservable from 'zen-observable-ts';
 export declare enum SUBSCRIPTION_STATUS {
     PENDING = 0,
     CONNECTED = 1,
@@ -71,6 +72,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.11",
+  "version": "3.1.1",
   "main": "lib/index.js",
   "license": "Apache-2.0",
   "description": "AWS Mobile AppSync SDK for JavaScript",
@@ -21,7 +21,8 @@
   "dependencies": {
     "aws-appsync-auth-link": "^3.0.7",
     "debug": "2.6.9",
-    "url": "^0.11.0"
+    "url": "^0.11.0",
+    "zen-observable-ts": "^1.2.5"
   },
   "devDependencies": {
     "@apollo/client": "^3.2.0",