@trpc/client 10.0.0-alpha.2 → 10.0.0-alpha.3

package/dist/{declarations/src/links → links}/wsLink.d.ts

@@ -1,20 +1,20 @@
-import { AnyRouter } from '@trpc/server';
-import { retryDelay } from '../internals/retryDelay';
-import { UnsubscribeFn } from '../rx';
-import { Operation, OperationResultObserver, TRPCLink } from './types';
-export interface WebSocketClientOptions {
-    url: string;
-    WebSocket?: WebSocket;
-    retryDelayMs?: typeof retryDelay;
-}
-export declare function createWSClient(opts: WebSocketClientOptions): {
-    close: () => void;
-    request: (op: Operation, callbacks: OperationResultObserver<AnyRouter<any>, unknown>) => UnsubscribeFn;
-    getConnection(): WebSocket;
-};
-export declare type TRPCWebSocketClient = ReturnType<typeof createWSClient>;
-export interface WebSocketLinkOptions {
-    client: TRPCWebSocketClient;
-}
-export declare function wsLink<TRouter extends AnyRouter>(opts: WebSocketLinkOptions): TRPCLink<TRouter>;
+import { AnyRouter } from '@trpc/server';
+import { retryDelay } from '../internals/retryDelay';
+import { UnsubscribeFn } from '../rx';
+import { Operation, OperationResultObserver, TRPCLink } from './types';
+export interface WebSocketClientOptions {
+    url: string;
+    WebSocket?: WebSocket;
+    retryDelayMs?: typeof retryDelay;
+}
+export declare function createWSClient(opts: WebSocketClientOptions): {
+    close: () => void;
+    request: (op: Operation, callbacks: OperationResultObserver<AnyRouter<any>, unknown>) => UnsubscribeFn;
+    getConnection(): WebSocket;
+};
+export declare type TRPCWebSocketClient = ReturnType<typeof createWSClient>;
+export interface WebSocketLinkOptions {
+    client: TRPCWebSocketClient;
+}
+export declare function wsLink<TRouter extends AnyRouter>(opts: WebSocketLinkOptions): TRPCLink<TRouter>;
 //# sourceMappingURL=wsLink.d.ts.map

package/dist/links/wsLink.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wsLink.d.ts","sourceRoot":"","sources":["../../src/links/wsLink.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAiB,MAAM,cAAc,CAAC;AAOxD,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAGtC,OAAO,EAAE,SAAS,EAAE,uBAAuB,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEvE,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,YAAY,CAAC,EAAE,OAAO,UAAU,CAAC;CAClC;AACD,wBAAgB,cAAc,CAAC,IAAI,EAAE,sBAAsB;;kBA8LpC,SAAS,kEAA0B,aAAa;;EAgDtE;AACD,oBAAY,mBAAmB,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AAEpE,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,mBAAmB,CAAC;CAC7B;AAiBD,wBAAgB,MAAM,CAAC,OAAO,SAAS,SAAS,EAC9C,IAAI,EAAE,oBAAoB,GACzB,QAAQ,CAAC,OAAO,CAAC,CAkDnB"}

package/dist/links/wsLink.js

@@ -0,0 +1,384 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var _classCallCheck = require('@babel/runtime/helpers/classCallCheck');
+var _assertThisInitialized = require('@babel/runtime/helpers/assertThisInitialized');
+var _inherits = require('@babel/runtime/helpers/inherits');
+var _possibleConstructorReturn = require('@babel/runtime/helpers/possibleConstructorReturn');
+var _getPrototypeOf = require('@babel/runtime/helpers/getPrototypeOf');
+var _wrapNativeSuper = require('@babel/runtime/helpers/wrapNativeSuper');
+var observable = require('../observable-85669100.js');
+var TRPCClientError = require('../TRPCClientError-ec6bd2ca.js');
+require('@babel/runtime/helpers/defineProperty');
+require('@babel/runtime/helpers/createClass');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var _classCallCheck__default = /*#__PURE__*/_interopDefaultLegacy(_classCallCheck);
+var _assertThisInitialized__default = /*#__PURE__*/_interopDefaultLegacy(_assertThisInitialized);
+var _inherits__default = /*#__PURE__*/_interopDefaultLegacy(_inherits);
+var _possibleConstructorReturn__default = /*#__PURE__*/_interopDefaultLegacy(_possibleConstructorReturn);
+var _getPrototypeOf__default = /*#__PURE__*/_interopDefaultLegacy(_getPrototypeOf);
+var _wrapNativeSuper__default = /*#__PURE__*/_interopDefaultLegacy(_wrapNativeSuper);
+
+/* istanbul ignore next */
+var retryDelay = function retryDelay(attemptIndex) {
+  return attemptIndex === 0 ? 0 : Math.min(1000 * Math.pow(2, attemptIndex), 30000);
+};
+
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf__default["default"](Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf__default["default"](this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn__default["default"](this, result); }; }
+
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+function createWSClient(opts) {
+  var url = opts.url,
+      _opts$WebSocket = opts.WebSocket,
+      WebSocketImpl = _opts$WebSocket === void 0 ? WebSocket : _opts$WebSocket,
+      _opts$retryDelayMs = opts.retryDelayMs,
+      retryDelayFn = _opts$retryDelayMs === void 0 ? retryDelay : _opts$retryDelayMs;
+  /* istanbul ignore next */
+
+  if (!WebSocketImpl) {
+    throw new Error("No WebSocket implementation found - you probably don't want to use this on the server, but if you do you need to pass a `WebSocket`-ponyfill");
+  }
+  /**
+   * outgoing messages buffer whilst not open
+   */
+
+
+  var outgoing = [];
+  /**
+   * pending outgoing requests that are awaiting callback
+   */
+
+  var pendingRequests = Object.create(null);
+  var connectAttempt = 0;
+  var dispatchTimer = null;
+  var connectTimer = null;
+  var activeConnection = createWS();
+  var state = 'connecting';
+  /**
+   * tries to send the list of messages
+   */
+
+  function dispatch() {
+    if (state !== 'open' || dispatchTimer) {
+      return;
+    }
+
+    dispatchTimer = setTimeout(function () {
+      dispatchTimer = null;
+
+      if (outgoing.length === 1) {
+        // single send
+        activeConnection.send(JSON.stringify(outgoing.pop()));
+      } else {
+        // batch send
+        activeConnection.send(JSON.stringify(outgoing));
+      } // clear
+
+
+      outgoing = [];
+    });
+  }
+
+  function tryReconnect() {
+    if (connectTimer || state === 'closed') {
+      return;
+    }
+
+    var timeout = retryDelayFn(connectAttempt++);
+    reconnectInMs(timeout);
+  }
+
+  function reconnect() {
+    state = 'connecting';
+    var oldConnection = activeConnection;
+    activeConnection = createWS();
+    closeIfNoPending(oldConnection);
+  }
+
+  function reconnectInMs(ms) {
+    if (connectTimer) {
+      return;
+    }
+
+    state = 'connecting';
+    connectTimer = setTimeout(reconnect, ms);
+  }
+
+  function closeIfNoPending(conn) {
+    // disconnect as soon as there are are no pending result
+    var hasPendingRequests = Object.values(pendingRequests).some(function (p) {
+      return p.ws === conn;
+    });
+
+    if (!hasPendingRequests) {
+      conn.close();
+    }
+  }
+
+  function resumeSubscriptionOnReconnect(req) {
+    if (outgoing.some(function (r) {
+      return r.id === req.op.id;
+    })) {
+      return;
+    }
+
+    request(req.op, req.callbacks);
+  }
+
+  function createWS() {
+    var conn = new WebSocket(url);
+    clearTimeout(connectTimer);
+    connectTimer = null;
+    conn.addEventListener('open', function () {
+      /* istanbul ignore next */
+      if (conn !== activeConnection) {
+        return;
+      }
+
+      connectAttempt = 0;
+      state = 'open';
+      dispatch();
+    });
+    conn.addEventListener('error', function () {
+      if (conn === activeConnection) {
+        tryReconnect();
+      }
+    });
+
+    var handleIncomingRequest = function handleIncomingRequest(req) {
+      if (req.method === 'reconnect' && conn === activeConnection) {
+        reconnect(); // notify subscribers
+
+        for (var _i = 0, _Object$values = Object.values(pendingRequests); _i < _Object$values.length; _i++) {
+          var pendingReq = _Object$values[_i];
+
+          if (pendingReq.type === 'subscription') {
+            resumeSubscriptionOnReconnect(pendingReq);
+          }
+        }
+      }
+    };
+
+    var handleIncomingResponse = function handleIncomingResponse(data) {
+      var _req$callbacks$next, _req$callbacks;
+
+      var req = data.id !== null && pendingRequests[data.id];
+
+      if (!req) {
+        // do something?
+        return;
+      }
+
+      (_req$callbacks$next = (_req$callbacks = req.callbacks).next) === null || _req$callbacks$next === void 0 ? void 0 : _req$callbacks$next.call(_req$callbacks, {
+        data: data
+      });
+
+      if (req.ws !== activeConnection && conn === activeConnection) {
+        var oldWs = req.ws; // gracefully replace old connection with this
+
+        req.ws = activeConnection;
+        closeIfNoPending(oldWs);
+      }
+
+      if ('result' in data && data.result.type === 'stopped' && conn === activeConnection) {
+        req.callbacks.complete();
+      }
+    };
+
+    conn.addEventListener('message', function (_ref) {
+      var data = _ref.data;
+      var msg = JSON.parse(data);
+
+      if ('method' in msg) {
+        handleIncomingRequest(msg);
+      } else {
+        handleIncomingResponse(msg);
+      }
+
+      if (conn !== activeConnection || state === 'closed') {
+        // when receiving a message, we close old connection that has no pending requests
+        closeIfNoPending(conn);
+      }
+    });
+    conn.addEventListener('close', function () {
+      if (activeConnection === conn) {
+        // connection might have been replaced already
+        tryReconnect();
+      }
+
+      for (var key in pendingRequests) {
+        var _req$callbacks$error, _req$callbacks2;
+
+        var req = pendingRequests[key];
+
+        if (req.ws !== conn) {
+          continue;
+        }
+
+        (_req$callbacks$error = (_req$callbacks2 = req.callbacks).error) === null || _req$callbacks$error === void 0 ? void 0 : _req$callbacks$error.call(_req$callbacks2, TRPCClientError.TRPCClientError.from(new TRPCWebSocketClosedError('WebSocket closed prematurely')));
+
+        if (req.type !== 'subscription') {
+          var _req$callbacks$comple, _req$callbacks3;
+
+          delete pendingRequests[key];
+          (_req$callbacks$comple = (_req$callbacks3 = req.callbacks).complete) === null || _req$callbacks$comple === void 0 ? void 0 : _req$callbacks$comple.call(_req$callbacks3);
+        } else if (state !== 'closed') {
+          // request restart of sub with next connection
+          resumeSubscriptionOnReconnect(req);
+        }
+      }
+    });
+    return conn;
+  }
+
+  function request(op, callbacks) {
+    var type = op.type,
+        input = op.input,
+        path = op.path,
+        id = op.id;
+    var envelope = {
+      id: id,
+      jsonrpc: '2.0',
+      method: type,
+      params: {
+        input: input,
+        path: path
+      }
+    };
+    pendingRequests[id] = {
+      ws: activeConnection,
+      type: type,
+      callbacks: callbacks,
+      op: op
+    }; // enqueue message
+
+    outgoing.push(envelope);
+    dispatch();
+    return function () {
+      var _pendingRequests$id, _callbacks$complete;
+
+      var callbacks = (_pendingRequests$id = pendingRequests[id]) === null || _pendingRequests$id === void 0 ? void 0 : _pendingRequests$id.callbacks;
+      delete pendingRequests[id];
+      outgoing = outgoing.filter(function (msg) {
+        return msg.id !== id;
+      });
+      callbacks === null || callbacks === void 0 ? void 0 : (_callbacks$complete = callbacks.complete) === null || _callbacks$complete === void 0 ? void 0 : _callbacks$complete.call(callbacks);
+
+      if (op.type === 'subscription') {
+        outgoing.push({
+          id: id,
+          method: 'subscription.stop',
+          params: undefined
+        });
+        dispatch();
+      }
+    };
+  }
+
+  return {
+    close: function close() {
+      state = 'closed';
+      closeIfNoPending(activeConnection);
+    },
+    request: request,
+    getConnection: function getConnection() {
+      return activeConnection;
+    }
+  };
+}
+
+var TRPCWebSocketClosedError = /*#__PURE__*/function (_Error) {
+  _inherits__default["default"](TRPCWebSocketClosedError, _Error);
+
+  var _super = /*#__PURE__*/_createSuper(TRPCWebSocketClosedError);
+
+  function TRPCWebSocketClosedError(message) {
+    var _this;
+
+    _classCallCheck__default["default"](this, TRPCWebSocketClosedError);
+
+    _this = _super.call(this, message);
+    _this.name = 'TRPCWebSocketClosedError';
+    Object.setPrototypeOf(_assertThisInitialized__default["default"](_this), TRPCWebSocketClosedError.prototype);
+    return _this;
+  }
+
+  return TRPCWebSocketClosedError;
+}( /*#__PURE__*/_wrapNativeSuper__default["default"](Error));
+
+var TRPCSubscriptionEndedError = /*#__PURE__*/function (_Error2) {
+  _inherits__default["default"](TRPCSubscriptionEndedError, _Error2);
+
+  var _super2 = /*#__PURE__*/_createSuper(TRPCSubscriptionEndedError);
+
+  function TRPCSubscriptionEndedError(message) {
+    var _this2;
+
+    _classCallCheck__default["default"](this, TRPCSubscriptionEndedError);
+
+    _this2 = _super2.call(this, message);
+    _this2.name = 'TRPCSubscriptionEndedError';
+    Object.setPrototypeOf(_assertThisInitialized__default["default"](_this2), TRPCSubscriptionEndedError.prototype);
+    return _this2;
+  }
+
+  return TRPCSubscriptionEndedError;
+}( /*#__PURE__*/_wrapNativeSuper__default["default"](Error));
+
+function wsLink(opts) {
+  return function () {
+    var client = opts.client;
+    return function (_ref2) {
+      var op = _ref2.op;
+      return observable.observable(function (observer) {
+        var type = op.type,
+            input = op.input,
+            path = op.path,
+            id = op.id,
+            context = op.context;
+        var isDone = false;
+        var unsub = client.request({
+          type: type,
+          path: path,
+          input: input,
+          id: id,
+          context: context
+        }, {
+          error: function error(err) {
+            isDone = true;
+            observer.error(err);
+            unsub();
+          },
+          complete: function complete() {
+            if (!isDone) {
+              isDone = true;
+              observer.error(TRPCClientError.TRPCClientError.from(new TRPCSubscriptionEndedError('Operation ended prematurely')));
+            } else {
+              observer.complete();
+            }
+          },
+          next: function next(result) {
+            observer.next(result);
+
+            if (op.type !== 'subscription') {
+              // if it isn't a subscription we don't care about next response
+              isDone = true;
+              unsub();
+              observer.complete();
+            }
+          }
+        });
+        return function () {
+          isDone = true;
+          unsub();
+        };
+      });
+    };
+  };
+}
+
+exports.createWSClient = createWSClient;
+exports.wsLink = wsLink;