userver.js 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", { value: true });
  3. exports.uServer = void 0;
  4. const debug_1 = require("debug");
  5. const server_1 = require("./server");
  6. const transports_uws_1 = require("./transports-uws");
  7. const debug = (0, debug_1.default)("engine:uws");
  8. /**
  9. * An Engine.IO server based on the `uWebSockets.js` package.
  10. */
  11. // TODO export it into its own package
  12. class uServer extends server_1.BaseServer {
  13. init() { }
  14. cleanup() { }
  15. /**
  16. * Prepares a request by processing the query string.
  17. *
  18. * @private
  19. */
  20. prepare(req, res) {
  21. req.method = req.getMethod().toUpperCase();
  22. req.url = req.getUrl();
  23. const params = new URLSearchParams(req.getQuery());
  24. req._query = Object.fromEntries(params.entries());
  25. req.headers = {};
  26. req.forEach((key, value) => {
  27. req.headers[key] = value;
  28. });
  29. // @ts-expect-error
  30. req.connection = {
  31. remoteAddress: Buffer.from(res.getRemoteAddressAsText()).toString(),
  32. };
  33. res.onAborted(() => {
  34. debug("response has been aborted");
  35. });
  36. }
  37. createTransport(transportName, req) {
  38. return new transports_uws_1.default[transportName](req);
  39. }
  40. /**
  41. * Attach the engine to a µWebSockets.js server
  42. * @param app
  43. * @param options
  44. */
  45. attach(app /* : TemplatedApp */, options = {}) {
  46. const path = this._computePath(options);
  47. app
  48. .any(path, this.handleRequest.bind(this))
  49. //
  50. .ws(path, {
  51. compression: options.compression,
  52. idleTimeout: options.idleTimeout,
  53. maxBackpressure: options.maxBackpressure,
  54. maxPayloadLength: this.opts.maxHttpBufferSize,
  55. upgrade: this.handleUpgrade.bind(this),
  56. open: (ws) => {
  57. const transport = ws.getUserData().transport;
  58. transport.socket = ws;
  59. transport.writable = true;
  60. transport.emit("ready");
  61. },
  62. message: (ws, message, isBinary) => {
  63. ws.getUserData().transport.onData(isBinary ? message : Buffer.from(message).toString());
  64. },
  65. close: (ws, code, message) => {
  66. ws.getUserData().transport.onClose(code, message);
  67. },
  68. });
  69. }
  70. _applyMiddlewares(req, res, callback) {
  71. if (this.middlewares.length === 0) {
  72. return callback();
  73. }
  74. // needed to buffer headers until the status is computed
  75. req.res = new ResponseWrapper(res);
  76. super._applyMiddlewares(req, req.res, (err) => {
  77. // some middlewares (like express-session) wait for the writeHead() call to flush their headers
  78. // see https://github.com/expressjs/session/blob/1010fadc2f071ddf2add94235d72224cf65159c6/index.js#L220-L244
  79. req.res.writeHead();
  80. callback(err);
  81. });
  82. }
  83. handleRequest(res, req) {
  84. debug('handling "%s" http request "%s"', req.getMethod(), req.getUrl());
  85. this.prepare(req, res);
  86. req.res = res;
  87. const callback = (errorCode, errorContext) => {
  88. if (errorCode !== undefined) {
  89. this.emit("connection_error", {
  90. req,
  91. code: errorCode,
  92. message: server_1.Server.errorMessages[errorCode],
  93. context: errorContext,
  94. });
  95. this.abortRequest(req.res, errorCode, errorContext);
  96. return;
  97. }
  98. if (req._query.sid) {
  99. debug("setting new request for existing client");
  100. // @ts-ignore
  101. this.clients[req._query.sid].transport.onRequest(req);
  102. }
  103. else {
  104. const closeConnection = (errorCode, errorContext) => this.abortRequest(res, errorCode, errorContext);
  105. this.handshake(req._query.transport, req, closeConnection);
  106. }
  107. };
  108. this._applyMiddlewares(req, res, (err) => {
  109. if (err) {
  110. callback(server_1.Server.errors.BAD_REQUEST, { name: "MIDDLEWARE_FAILURE" });
  111. }
  112. else {
  113. this.verify(req, false, callback);
  114. }
  115. });
  116. }
  117. handleUpgrade(res, req, context) {
  118. debug("on upgrade");
  119. this.prepare(req, res);
  120. req.res = res;
  121. const callback = async (errorCode, errorContext) => {
  122. if (errorCode !== undefined) {
  123. this.emit("connection_error", {
  124. req,
  125. code: errorCode,
  126. message: server_1.Server.errorMessages[errorCode],
  127. context: errorContext,
  128. });
  129. this.abortRequest(res, errorCode, errorContext);
  130. return;
  131. }
  132. const id = req._query.sid;
  133. let transport;
  134. if (id) {
  135. const client = this.clients[id];
  136. if (!client) {
  137. debug("upgrade attempt for closed client");
  138. return res.close();
  139. }
  140. else if (client.upgrading) {
  141. debug("transport has already been trying to upgrade");
  142. return res.close();
  143. }
  144. else if (client.upgraded) {
  145. debug("transport had already been upgraded");
  146. return res.close();
  147. }
  148. else {
  149. debug("upgrading existing transport");
  150. transport = this.createTransport(req._query.transport, req);
  151. client._maybeUpgrade(transport);
  152. }
  153. }
  154. else {
  155. transport = await this.handshake(req._query.transport, req, (errorCode, errorContext) => this.abortRequest(res, errorCode, errorContext));
  156. if (!transport) {
  157. return;
  158. }
  159. }
  160. // emit headers events for WebSocket upgrades
  161. const additionalHeaders = {};
  162. const isInitialRequest = !id;
  163. if (isInitialRequest) {
  164. this.emit("initial_headers", additionalHeaders, req);
  165. }
  166. this.emit("headers", additionalHeaders, req);
  167. // calling writeStatus() triggers the flushing of any header added in a middleware
  168. req.res.writeStatus("101 Switching Protocols");
  169. Object.keys(additionalHeaders).forEach((key) => {
  170. req.res.writeHeader(key, additionalHeaders[key]);
  171. });
  172. res.upgrade({
  173. transport,
  174. }, req.getHeader("sec-websocket-key"), req.getHeader("sec-websocket-protocol"), req.getHeader("sec-websocket-extensions"), context);
  175. };
  176. this._applyMiddlewares(req, res, (err) => {
  177. if (err) {
  178. callback(server_1.Server.errors.BAD_REQUEST, { name: "MIDDLEWARE_FAILURE" });
  179. }
  180. else {
  181. this.verify(req, true, callback);
  182. }
  183. });
  184. }
  185. abortRequest(res, errorCode, errorContext) {
  186. const statusCode = errorCode === server_1.Server.errors.FORBIDDEN
  187. ? "403 Forbidden"
  188. : "400 Bad Request";
  189. const message = errorContext && errorContext.message
  190. ? errorContext.message
  191. : server_1.Server.errorMessages[errorCode];
  192. res.writeStatus(statusCode);
  193. res.writeHeader("Content-Type", "application/json");
  194. res.end(JSON.stringify({
  195. code: errorCode,
  196. message,
  197. }));
  198. }
  199. }
  200. exports.uServer = uServer;
  201. class ResponseWrapper {
  202. constructor(res) {
  203. this.res = res;
  204. this.statusWritten = false;
  205. this.headers = [];
  206. this.isAborted = false;
  207. }
  208. set statusCode(status) {
  209. if (!status) {
  210. return;
  211. }
  212. // FIXME: handle all status codes?
  213. this.writeStatus(status === 200 ? "200 OK" : "204 No Content");
  214. }
  215. writeHead(status) {
  216. this.statusCode = status;
  217. }
  218. setHeader(key, value) {
  219. if (Array.isArray(value)) {
  220. value.forEach((val) => {
  221. this.writeHeader(key, val);
  222. });
  223. }
  224. else {
  225. this.writeHeader(key, value);
  226. }
  227. }
  228. removeHeader() {
  229. // FIXME: not implemented
  230. }
  231. // needed by vary: https://github.com/jshttp/vary/blob/5d725d059b3871025cf753e9dfa08924d0bcfa8f/index.js#L134
  232. getHeader() { }
  233. writeStatus(status) {
  234. if (this.isAborted)
  235. return;
  236. this.res.writeStatus(status);
  237. this.statusWritten = true;
  238. this.writeBufferedHeaders();
  239. return this;
  240. }
  241. writeHeader(key, value) {
  242. if (this.isAborted)
  243. return;
  244. if (key === "Content-Length") {
  245. // the content length is automatically added by uWebSockets.js
  246. return;
  247. }
  248. if (this.statusWritten) {
  249. this.res.writeHeader(key, value);
  250. }
  251. else {
  252. this.headers.push([key, value]);
  253. }
  254. }
  255. writeBufferedHeaders() {
  256. this.headers.forEach(([key, value]) => {
  257. this.res.writeHeader(key, value);
  258. });
  259. }
  260. end(data) {
  261. if (this.isAborted)
  262. return;
  263. this.res.cork(() => {
  264. if (!this.statusWritten) {
  265. // status will be inferred as "200 OK"
  266. this.writeBufferedHeaders();
  267. }
  268. this.res.end(data);
  269. });
  270. }
  271. onData(fn) {
  272. if (this.isAborted)
  273. return;
  274. this.res.onData(fn);
  275. }
  276. onAborted(fn) {
  277. if (this.isAborted)
  278. return;
  279. this.res.onAborted(() => {
  280. // Any attempt to use the UWS response object after abort will throw!
  281. this.isAborted = true;
  282. fn();
  283. });
  284. }
  285. cork(fn) {
  286. if (this.isAborted)
  287. return;
  288. this.res.cork(fn);
  289. }
  290. }