@cubejs-client/ws-transport 1.3.13 → 1.3.14

package/dist/index.d.ts

@@ -1,12 +1,4 @@
 import type { ITransport, ITransportResponse } from '@cubejs-client/core';
-/**
- * @title @cubejs-client/ws-transport
- * @permalink /@cubejs-client-ws-transport
- * @menuCategory Cube.js Frontend
- * @subcategory Reference
- * @menuOrder 4
- * @description WebSocket transport for Cube.js client
- */
 declare class WebSocketTransportResult {
     protected readonly status: unknown;
     protected readonly result: unknown;

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAE1E;;;;;;;GAOG;AAEH,cAAM,wBAAwB;IAC5B,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEnC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;gBAEhB,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE;IAKhE,IAAI;IAIV,KAAK;IAKC,IAAI;CAGlB;AAED,KAAK,yBAAyB,GAAG;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IAEf,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,KAAK,OAAO,GAAG;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,GAAG,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC,CAAC;AAEF,KAAK,YAAY,GAAG;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,CAAC,MAAM,EAAE,wBAAwB,KAAK,IAAI,CAAC;CACtD,CAAC;AAEF,cAAM,kBAAmB,YAAW,UAAU,CAAC,wBAAwB,CAAC;IACtE,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAElC,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAM;IAElD,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAEpC,SAAS,CAAC,EAAE,EAAE,GAAG,CAAQ;IAEzB,SAAS,CAAC,cAAc,EAAE,MAAM,CAAK;IAErC,SAAS,CAAC,uBAAuB,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAM;IAErE,SAAS,CAAC,YAAY,EAAE,OAAO,EAAE,CAAM;gBAEpB,EAAE,aAAa,EAAE,MAAM,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,EAAE,yBAAyB;IAY5G,IAAW,aAAa,CAAC,KAAK,oBAAA,EAM7B;IAEY,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IASnC,IAAW,aAAa,uBAEvB;IAED,SAAS,CAAC,UAAU;IAqFpB,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG;IAa3B,OAAO,CACZ,MAAM,EAAE,MAAM,EACd,EAAE,aAAa,EAAE,GAAG,MAAM,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACpD,kBAAkB,CAAC,wBAAwB,CAAC;CA+ChD;AAED,eAAe,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAE1E,cAAM,wBAAwB;IAC5B,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEnC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;gBAEhB,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE;IAKhE,IAAI;IAIV,KAAK;IAKC,IAAI;CAGlB;AAED,KAAK,yBAAyB,GAAG;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IAEf,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,KAAK,OAAO,GAAG;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,GAAG,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC,CAAC;AAEF,KAAK,YAAY,GAAG;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,CAAC,MAAM,EAAE,wBAAwB,KAAK,IAAI,CAAC;CACtD,CAAC;AAEF,cAAM,kBAAmB,YAAW,UAAU,CAAC,wBAAwB,CAAC;IACtE,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAElC,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAM;IAElD,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAEpC,SAAS,CAAC,EAAE,EAAE,GAAG,CAAQ;IAEzB,SAAS,CAAC,cAAc,EAAE,MAAM,CAAK;IAErC,SAAS,CAAC,uBAAuB,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAM;IAErE,SAAS,CAAC,YAAY,EAAE,OAAO,EAAE,CAAM;gBAEpB,EAAE,aAAa,EAAE,MAAM,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,EAAE,yBAAyB;IAY5G,IAAW,aAAa,CAAC,KAAK,oBAAA,EAM7B;IAEY,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IASnC,IAAW,aAAa,uBAEvB;IAED,SAAS,CAAC,UAAU;IAqFpB,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG;IAa3B,OAAO,CACZ,MAAM,EAAE,MAAM,EACd,EAAE,aAAa,EAAE,GAAG,MAAM,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACpD,kBAAkB,CAAC,wBAAwB,CAAC;CA+ChD;AAED,eAAe,kBAAkB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cubejs-client/ws-transport",
-  "version": "1.3.13",
+  "version": "1.3.14",
   "engines": {},
   "repository": {
     "type": "git",
@@ -20,13 +20,12 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.1.2",
-    "@cubejs-client/core": "1.3.13",
+    "@cubejs-client/core": "1.3.14",
     "core-js": "^3.6.5",
     "isomorphic-ws": "^4.0.1",
     "ws": "^7.3.1"
   },
   "files": [
-    "src",
     "dist"
   ],
   "license": "MIT",
@@ -34,7 +33,7 @@
     "@babel/core": "^7.3.3",
     "@babel/preset-env": "^7.3.1",
     "@babel/preset-typescript": "^7.12.1",
-    "@cubejs-backend/linter": "1.3.13",
+    "@cubejs-backend/linter": "1.3.14",
     "@types/ws": "^7.2.9",
     "typescript": "~5.2.2"
   },
@@ -44,5 +43,5 @@
   "eslintConfig": {
     "extends": "../cubejs-linter"
   },
-  "gitHead": "801fbe5c470d7d3d9ee03a937073048f5523be42"
+  "gitHead": "91c5e878fceff1984b8bcfa2dde95e7e086f26c6"
 }

package/src/index.ts

@@ -1,255 +0,0 @@
-import WebSocket from 'isomorphic-ws';
-import type { ITransport, ITransportResponse } from '@cubejs-client/core';
-
-/**
- * @title @cubejs-client/ws-transport
- * @permalink /@cubejs-client-ws-transport
- * @menuCategory Cube.js Frontend
- * @subcategory Reference
- * @menuOrder 4
- * @description WebSocket transport for Cube.js client
- */
-
-class WebSocketTransportResult {
-  protected readonly status: unknown;
-
-  protected readonly result: unknown;
-
-  public constructor({ status, message }: { status: unknown, message: unknown }) {
-    this.status = status;
-    this.result = message;
-  }
-
-  public async json() {
-    return this.result;
-  }
-
-  public clone() {
-    // no need to actually clone it
-    return this;
-  }
-
-  public async text() {
-    return typeof this.result === 'string' ? this.result : JSON.stringify(this.result);
-  }
-}
-
-type WebSocketTransportOptions = {
-  authorization?: string,
-  apiUrl: string,
-  // @deprecated
-  hearBeatInterval?: number,
-  heartBeatInterval?: number,
-};
-
-type Message = {
-  messageId: number,
-  requestId: any,
-  method: string,
-  params: Record<string, unknown>,
-};
-
-type Subscription = {
-  message: Message,
-  callback: (result: WebSocketTransportResult) => void,
-};
-
-class WebSocketTransport implements ITransport<WebSocketTransportResult> {
-  protected readonly apiUrl: string;
-
-  protected readonly heartBeatInterval: number = 60;
-
-  protected token: string | undefined;
-
-  protected ws: any = null;
-
-  protected messageCounter: number = 1;
-
-  protected messageIdToSubscription: Record<number, Subscription> = {};
-
-  protected messageQueue: Message[] = [];
-
-  public constructor({ authorization, apiUrl, heartBeatInterval, hearBeatInterval }: WebSocketTransportOptions) {
-    this.token = authorization;
-    this.apiUrl = apiUrl;
-
-    if (heartBeatInterval) {
-      this.heartBeatInterval = heartBeatInterval;
-    } else if (hearBeatInterval) {
-      console.warn('Option hearBeatInterval is deprecated. It was replaced by heartBeatInterval.');
-      this.heartBeatInterval = hearBeatInterval;
-    }
-  }
-
-  public set authorization(token) {
-    this.token = token;
-
-    if (this.ws) {
-      this.ws.close();
-    }
-  }
-
-  public async close(): Promise<void> {
-    if (this.ws) {
-      // Flush send queue before sending close frame
-      this.ws.sendQueue();
-
-      this.ws.close();
-    }
-  }
-
-  public get authorization() {
-    return this.token;
-  }
-
-  protected initSocket() {
-    if (this.ws) {
-      return this.ws.initPromise;
-    }
-
-    const ws: any = new WebSocket(this.apiUrl);
-
-    ws.messageIdSent = {};
-
-    ws.sendMessage = (message: any) => {
-      if (!message.messageId || message.messageId && !ws.messageIdSent[message.messageId]) {
-        ws.send(JSON.stringify(message));
-        ws.messageIdSent[message.messageId] = true;
-      }
-    };
-
-    ws.sendQueue = () => {
-      this.messageQueue.forEach(message => ws.sendMessage(message));
-      this.messageQueue = [];
-    };
-
-    ws.reconcile = () => {
-      if (new Date().getTime() - ws.lastMessageTimestamp.getTime() > 4 * this.heartBeatInterval * 1000) {
-        ws.close();
-      } else {
-        Object.keys(this.messageIdToSubscription).forEach(messageId => {
-          // @ts-ignore
-          ws.sendMessage(this.messageIdToSubscription[messageId].message);
-        });
-      }
-    };
-
-    ws.lastMessageTimestamp = new Date();
-
-    ws.initPromise = new Promise<void>(resolve => {
-      ws.onopen = () => {
-        ws.sendMessage({ authorization: this.authorization });
-      };
-
-      ws.onmessage = (event: any) => {
-        ws.lastMessageTimestamp = new Date();
-
-        const message: any = JSON.parse(event.data);
-        if (message.handshake) {
-          ws.reconcile();
-          ws.reconcileTimer = setInterval(() => {
-            ws.messageIdSent = {};
-            ws.reconcile();
-          }, this.heartBeatInterval * 1000);
-          resolve();
-        }
-
-        if (this.messageIdToSubscription[message.messageId]) {
-          this.messageIdToSubscription[message.messageId].callback(
-            new WebSocketTransportResult(message)
-          );
-        }
-
-        ws.sendQueue();
-      };
-
-      ws.onclose = () => {
-        if (ws && ws.readyState !== WebSocket.CLOSED && ws.readyState !== WebSocket.CLOSING) {
-          ws.close();
-        }
-        if (ws.reconcileTimer) {
-          clearInterval(ws.reconcileTimer);
-          ws.reconcileTimer = null;
-        }
-        if (this.ws === ws) {
-          this.ws = null;
-          if (Object.keys(this.messageIdToSubscription).length) {
-            this.initSocket();
-          }
-        }
-      };
-
-      ws.onerror = ws.onclose;
-    });
-
-    this.ws = ws;
-
-    return this.ws.initPromise;
-  }
-
-  protected sendMessage(message: any) {
-    if (message.unsubscribe && this.messageQueue.find(m => m.messageId === message.unsubscribe)) {
-      this.messageQueue = this.messageQueue.filter(m => m.messageId !== message.unsubscribe);
-    } else {
-      this.messageQueue.push(message);
-    }
-
-    setTimeout(async () => {
-      await this.initSocket();
-      this.ws.sendQueue();
-    }, 100);
-  }
-
-  public request(
-    method: string,
-    { baseRequestId, ...params }: Record<string, unknown>
-  ): ITransportResponse<WebSocketTransportResult> {
-    const message: Message = {
-      messageId: this.messageCounter++,
-      requestId: baseRequestId,
-      method,
-      params
-    };
-
-    const pendingResults: WebSocketTransportResult[] = [];
-    let nextMessage: ((value: any) => void) | null = null;
-
-    const runNextMessage = () => {
-      if (nextMessage) {
-        nextMessage(pendingResults.pop());
-        nextMessage = null;
-      }
-    };
-
-    this.messageIdToSubscription[message.messageId] = {
-      message,
-      callback: (result) => {
-        pendingResults.push(result);
-        runNextMessage();
-      }
-    };
-
-    const transport = this;
-
-    return {
-      async subscribe(callback) {
-        transport.sendMessage(message);
-
-        const result = await new Promise<WebSocketTransportResult>((resolve) => {
-          nextMessage = resolve;
-          if (pendingResults.length) {
-            runNextMessage();
-          }
-        });
-
-        return callback(result, () => this.subscribe(callback));
-      },
-      async unsubscribe() {
-        transport.sendMessage({ unsubscribe: message.messageId });
-        delete transport.messageIdToSubscription[message.messageId];
-      }
-    };
-  }
-}
-
-export default WebSocketTransport;