userver.js 8.6 KB

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