serverless-spy 0.0.10 → 0.0.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (172) hide show
  1. package/.jsii +7 -4
  2. package/lib/{cjs/cli → cli}/cli.d.ts +0 -0
  3. package/lib/cli/cli.js +87 -0
  4. package/lib/cli/cli.mjs +85 -0
  5. package/lib/{cjs/cli → cli}/ws.d.ts +0 -0
  6. package/lib/cli/ws.js +68 -0
  7. package/lib/cli/ws.mjs +66 -0
  8. package/lib/{cjs/common → common}/getWebSocketUrl.d.ts +0 -0
  9. package/lib/common/getWebSocketUrl.js +57 -0
  10. package/lib/common/getWebSocketUrl.mjs +53 -0
  11. package/lib/common/spyEvents/DynamoDBSpyEvent.d.ts +10 -0
  12. package/lib/common/spyEvents/DynamoDBSpyEvent.js +3 -0
  13. package/lib/common/spyEvents/DynamoDBSpyEvent.mjs +2 -0
  14. package/lib/common/spyEvents/EventBridgeRuleSpyEvent.d.ts +9 -0
  15. package/lib/common/spyEvents/EventBridgeRuleSpyEvent.js +3 -0
  16. package/lib/common/spyEvents/EventBridgeRuleSpyEvent.mjs +2 -0
  17. package/lib/common/spyEvents/EventBridgeSpyEvent.d.ts +9 -0
  18. package/lib/common/spyEvents/EventBridgeSpyEvent.js +3 -0
  19. package/lib/common/spyEvents/EventBridgeSpyEvent.mjs +2 -0
  20. package/lib/common/spyEvents/FunctionConsoleSpyEvent.d.ts +10 -0
  21. package/lib/common/spyEvents/FunctionConsoleSpyEvent.js +3 -0
  22. package/lib/common/spyEvents/FunctionConsoleSpyEvent.mjs +2 -0
  23. package/lib/common/spyEvents/FunctionContext.d.ts +7 -0
  24. package/lib/common/spyEvents/FunctionContext.js +3 -0
  25. package/lib/common/spyEvents/FunctionContext.mjs +2 -0
  26. package/lib/common/spyEvents/FunctionErrorSpyEvent.d.ts +8 -0
  27. package/lib/common/spyEvents/FunctionErrorSpyEvent.js +3 -0
  28. package/lib/common/spyEvents/FunctionErrorSpyEvent.mjs +2 -0
  29. package/lib/common/spyEvents/FunctionRequestSpyEvent.d.ts +7 -0
  30. package/lib/common/spyEvents/FunctionRequestSpyEvent.js +3 -0
  31. package/lib/common/spyEvents/FunctionRequestSpyEvent.mjs +2 -0
  32. package/lib/common/spyEvents/FunctionResponseSpyEvent.d.ts +8 -0
  33. package/lib/common/spyEvents/FunctionResponseSpyEvent.js +3 -0
  34. package/lib/common/spyEvents/FunctionResponseSpyEvent.mjs +2 -0
  35. package/lib/common/spyEvents/S3SpyEvent.d.ts +8 -0
  36. package/lib/common/spyEvents/S3SpyEvent.js +3 -0
  37. package/lib/common/spyEvents/S3SpyEvent.mjs +2 -0
  38. package/lib/common/spyEvents/SnsSubscriptionSpyEvent.d.ts +11 -0
  39. package/lib/common/spyEvents/SnsSubscriptionSpyEvent.js +3 -0
  40. package/lib/common/spyEvents/SnsSubscriptionSpyEvent.mjs +2 -0
  41. package/lib/common/spyEvents/SnsTopicSpyEvent.d.ts +11 -0
  42. package/lib/common/spyEvents/SnsTopicSpyEvent.js +3 -0
  43. package/lib/common/spyEvents/SnsTopicSpyEvent.mjs +2 -0
  44. package/lib/common/spyEvents/SpyEvent.d.ts +3 -0
  45. package/lib/common/spyEvents/SpyEvent.js +3 -0
  46. package/lib/common/spyEvents/SpyEvent.mjs +2 -0
  47. package/lib/common/spyEvents/SpyMessage.d.ts +6 -0
  48. package/lib/common/spyEvents/SpyMessage.js +3 -0
  49. package/lib/common/spyEvents/SpyMessage.mjs +2 -0
  50. package/lib/common/spyEvents/SqsSpyEvent.d.ts +7 -0
  51. package/lib/common/spyEvents/SqsSpyEvent.js +3 -0
  52. package/lib/common/spyEvents/SqsSpyEvent.mjs +2 -0
  53. package/lib/{cjs/index.d.ts → index.d.ts} +0 -0
  54. package/lib/{cjs/index.js → index.js} +1 -1
  55. package/lib/index.mjs +3 -0
  56. package/lib/{cjs/listener → listener}/PrettifyForDisplay.d.ts +0 -0
  57. package/lib/listener/PrettifyForDisplay.js +3 -0
  58. package/lib/listener/PrettifyForDisplay.mjs +2 -0
  59. package/lib/{cjs/listener → listener}/RecursivePartial.d.ts +0 -0
  60. package/lib/listener/RecursivePartial.js +3 -0
  61. package/lib/listener/RecursivePartial.mjs +2 -0
  62. package/lib/{mjs/listener → listener}/SpyHandlers.ts.d.ts +11 -11
  63. package/lib/listener/SpyHandlers.ts.js +3 -0
  64. package/lib/listener/SpyHandlers.ts.mjs +2 -0
  65. package/lib/{mjs/listener → listener}/SpyListener.d.ts +10 -10
  66. package/lib/listener/SpyListener.js +3 -0
  67. package/lib/listener/SpyListener.mjs +2 -0
  68. package/lib/{mjs/listener → listener}/createServerlessSpyListener.d.ts +1 -1
  69. package/lib/listener/createServerlessSpyListener.js +167 -0
  70. package/lib/listener/createServerlessSpyListener.mjs +163 -0
  71. package/lib/{cjs/listener → listener}/index.d.ts +0 -0
  72. package/lib/{cjs/listener → listener}/index.js +1 -1
  73. package/lib/listener/index.mjs +3 -0
  74. package/lib/{cjs/listener → listener}/matchers.d.ts +0 -0
  75. package/lib/listener/matchers.js +55 -0
  76. package/lib/listener/matchers.mjs +55 -0
  77. package/lib/{cjs/listener → listener}/setup.d.ts +0 -0
  78. package/lib/listener/setup.js +21 -0
  79. package/lib/listener/setup.mjs +21 -0
  80. package/lib/{cjs/src → src}/ServerlessSpy.d.ts +0 -0
  81. package/lib/{cjs/src → src}/ServerlessSpy.js +1 -1
  82. package/lib/src/ServerlessSpy.mjs +293 -0
  83. package/lib/{cjs/src → src}/index.d.ts +0 -0
  84. package/lib/{cjs/src → src}/index.js +0 -0
  85. package/lib/src/index.mjs +2 -0
  86. package/listener/SpyHandlers.ts.ts +11 -11
  87. package/listener/SpyListener.ts +10 -10
  88. package/listener/createServerlessSpyListener.ts +4 -5
  89. package/{cli/node_modules → node_modules}/ws/LICENSE +0 -0
  90. package/{cli/node_modules → node_modules}/ws/README.md +0 -0
  91. package/{cli/node_modules → node_modules}/ws/browser.js +0 -0
  92. package/{cli/node_modules → node_modules}/ws/index.js +0 -0
  93. package/{cli/node_modules → node_modules}/ws/lib/buffer-util.js +0 -0
  94. package/{cli/node_modules → node_modules}/ws/lib/constants.js +0 -0
  95. package/{cli/node_modules → node_modules}/ws/lib/event-target.js +0 -0
  96. package/{cli/node_modules → node_modules}/ws/lib/extension.js +0 -0
  97. package/{cli/node_modules → node_modules}/ws/lib/limiter.js +0 -0
  98. package/{cli/node_modules → node_modules}/ws/lib/permessage-deflate.js +0 -0
  99. package/{cli/node_modules → node_modules}/ws/lib/receiver.js +0 -0
  100. package/{cli/node_modules → node_modules}/ws/lib/sender.js +0 -0
  101. package/{cli/node_modules → node_modules}/ws/lib/stream.js +0 -0
  102. package/{cli/node_modules → node_modules}/ws/lib/subprotocol.js +0 -0
  103. package/{cli/node_modules → node_modules}/ws/lib/validation.js +0 -0
  104. package/{cli/node_modules → node_modules}/ws/lib/websocket-server.js +0 -0
  105. package/{cli/node_modules → node_modules}/ws/lib/websocket.js +0 -0
  106. package/{cli/node_modules → node_modules}/ws/package.json +0 -0
  107. package/{cli/node_modules → node_modules}/ws/wrapper.mjs +0 -0
  108. package/package.json +17 -14
  109. package/tsconfig.npm.json +1 -0
  110. package/cli/package-lock.json +0 -2356
  111. package/cli/package.json +0 -14
  112. package/common/package.json +0 -22
  113. package/lib/cjs/cli/cli.js +0 -87
  114. package/lib/cjs/cli/ws.js +0 -68
  115. package/lib/cjs/common/getWebSocketUrl.js +0 -57
  116. package/lib/cjs/listener/PrettifyForDisplay.js +0 -3
  117. package/lib/cjs/listener/RecursivePartial.js +0 -3
  118. package/lib/cjs/listener/SpyHandlers.ts.d.ts +0 -109
  119. package/lib/cjs/listener/SpyHandlers.ts.js +0 -3
  120. package/lib/cjs/listener/SpyListener.d.ts +0 -40
  121. package/lib/cjs/listener/SpyListener.js +0 -3
  122. package/lib/cjs/listener/createServerlessSpyListener.d.ts +0 -13
  123. package/lib/cjs/listener/createServerlessSpyListener.js +0 -167
  124. package/lib/cjs/listener/matchers.js +0 -55
  125. package/lib/cjs/listener/setup.js +0 -21
  126. package/lib/mjs/cli/cli.d.ts +0 -1
  127. package/lib/mjs/cli/cli.js +0 -85
  128. package/lib/mjs/cli/ws.d.ts +0 -1
  129. package/lib/mjs/cli/ws.js +0 -66
  130. package/lib/mjs/common/getWebSocketUrl.d.ts +0 -2
  131. package/lib/mjs/common/getWebSocketUrl.js +0 -53
  132. package/lib/mjs/index.d.ts +0 -2
  133. package/lib/mjs/index.js +0 -3
  134. package/lib/mjs/listener/PrettifyForDisplay.d.ts +0 -3
  135. package/lib/mjs/listener/PrettifyForDisplay.js +0 -2
  136. package/lib/mjs/listener/RecursivePartial.d.ts +0 -4
  137. package/lib/mjs/listener/RecursivePartial.js +0 -2
  138. package/lib/mjs/listener/SpyHandlers.ts.js +0 -2
  139. package/lib/mjs/listener/SpyListener.js +0 -2
  140. package/lib/mjs/listener/createServerlessSpyListener.js +0 -163
  141. package/lib/mjs/listener/index.d.ts +0 -2
  142. package/lib/mjs/listener/index.js +0 -3
  143. package/lib/mjs/listener/matchers.d.ts +0 -0
  144. package/lib/mjs/listener/matchers.js +0 -55
  145. package/lib/mjs/listener/setup.d.ts +0 -0
  146. package/lib/mjs/listener/setup.js +0 -21
  147. package/lib/mjs/src/ServerlessSpy.d.ts +0 -27
  148. package/lib/mjs/src/ServerlessSpy.js +0 -293
  149. package/lib/mjs/src/index.d.ts +0 -1
  150. package/lib/mjs/src/index.js +0 -2
  151. package/listener/node_modules/ws/LICENSE +0 -19
  152. package/listener/node_modules/ws/README.md +0 -495
  153. package/listener/node_modules/ws/browser.js +0 -8
  154. package/listener/node_modules/ws/index.js +0 -13
  155. package/listener/node_modules/ws/lib/buffer-util.js +0 -127
  156. package/listener/node_modules/ws/lib/constants.js +0 -12
  157. package/listener/node_modules/ws/lib/event-target.js +0 -266
  158. package/listener/node_modules/ws/lib/extension.js +0 -203
  159. package/listener/node_modules/ws/lib/limiter.js +0 -55
  160. package/listener/node_modules/ws/lib/permessage-deflate.js +0 -511
  161. package/listener/node_modules/ws/lib/receiver.js +0 -618
  162. package/listener/node_modules/ws/lib/sender.js +0 -478
  163. package/listener/node_modules/ws/lib/stream.js +0 -159
  164. package/listener/node_modules/ws/lib/subprotocol.js +0 -62
  165. package/listener/node_modules/ws/lib/validation.js +0 -125
  166. package/listener/node_modules/ws/lib/websocket-server.js +0 -535
  167. package/listener/node_modules/ws/lib/websocket.js +0 -1305
  168. package/listener/node_modules/ws/package.json +0 -61
  169. package/listener/node_modules/ws/wrapper.mjs +0 -8
  170. package/listener/package.json +0 -19
  171. package/listener/tsconfig.dev.json +0 -16
  172. package/listener/tsconfig.json +0 -16
@@ -1,125 +0,0 @@
1
- 'use strict';
2
-
3
- //
4
- // Allowed token characters:
5
- //
6
- // '!', '#', '$', '%', '&', ''', '*', '+', '-',
7
- // '.', 0-9, A-Z, '^', '_', '`', a-z, '|', '~'
8
- //
9
- // tokenChars[32] === 0 // ' '
10
- // tokenChars[33] === 1 // '!'
11
- // tokenChars[34] === 0 // '"'
12
- // ...
13
- //
14
- // prettier-ignore
15
- const tokenChars = [
16
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 0 - 15
17
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 16 - 31
18
- 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1, 1, 0, 1, 1, 0, // 32 - 47
19
- 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, // 48 - 63
20
- 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, // 64 - 79
21
- 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 1, // 80 - 95
22
- 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, // 96 - 111
23
- 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 0, 1, 0 // 112 - 127
24
- ];
25
-
26
- /**
27
- * Checks if a status code is allowed in a close frame.
28
- *
29
- * @param {Number} code The status code
30
- * @return {Boolean} `true` if the status code is valid, else `false`
31
- * @public
32
- */
33
- function isValidStatusCode(code) {
34
- return (
35
- (code >= 1000 &&
36
- code <= 1014 &&
37
- code !== 1004 &&
38
- code !== 1005 &&
39
- code !== 1006) ||
40
- (code >= 3000 && code <= 4999)
41
- );
42
- }
43
-
44
- /**
45
- * Checks if a given buffer contains only correct UTF-8.
46
- * Ported from https://www.cl.cam.ac.uk/%7Emgk25/ucs/utf8_check.c by
47
- * Markus Kuhn.
48
- *
49
- * @param {Buffer} buf The buffer to check
50
- * @return {Boolean} `true` if `buf` contains only correct UTF-8, else `false`
51
- * @public
52
- */
53
- function _isValidUTF8(buf) {
54
- const len = buf.length;
55
- let i = 0;
56
-
57
- while (i < len) {
58
- if ((buf[i] & 0x80) === 0) {
59
- // 0xxxxxxx
60
- i++;
61
- } else if ((buf[i] & 0xe0) === 0xc0) {
62
- // 110xxxxx 10xxxxxx
63
- if (
64
- i + 1 === len ||
65
- (buf[i + 1] & 0xc0) !== 0x80 ||
66
- (buf[i] & 0xfe) === 0xc0 // Overlong
67
- ) {
68
- return false;
69
- }
70
-
71
- i += 2;
72
- } else if ((buf[i] & 0xf0) === 0xe0) {
73
- // 1110xxxx 10xxxxxx 10xxxxxx
74
- if (
75
- i + 2 >= len ||
76
- (buf[i + 1] & 0xc0) !== 0x80 ||
77
- (buf[i + 2] & 0xc0) !== 0x80 ||
78
- (buf[i] === 0xe0 && (buf[i + 1] & 0xe0) === 0x80) || // Overlong
79
- (buf[i] === 0xed && (buf[i + 1] & 0xe0) === 0xa0) // Surrogate (U+D800 - U+DFFF)
80
- ) {
81
- return false;
82
- }
83
-
84
- i += 3;
85
- } else if ((buf[i] & 0xf8) === 0xf0) {
86
- // 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
87
- if (
88
- i + 3 >= len ||
89
- (buf[i + 1] & 0xc0) !== 0x80 ||
90
- (buf[i + 2] & 0xc0) !== 0x80 ||
91
- (buf[i + 3] & 0xc0) !== 0x80 ||
92
- (buf[i] === 0xf0 && (buf[i + 1] & 0xf0) === 0x80) || // Overlong
93
- (buf[i] === 0xf4 && buf[i + 1] > 0x8f) ||
94
- buf[i] > 0xf4 // > U+10FFFF
95
- ) {
96
- return false;
97
- }
98
-
99
- i += 4;
100
- } else {
101
- return false;
102
- }
103
- }
104
-
105
- return true;
106
- }
107
-
108
- module.exports = {
109
- isValidStatusCode,
110
- isValidUTF8: _isValidUTF8,
111
- tokenChars
112
- };
113
-
114
- /* istanbul ignore else */
115
- if (!process.env.WS_NO_UTF_8_VALIDATE) {
116
- try {
117
- const isValidUTF8 = require('utf-8-validate');
118
-
119
- module.exports.isValidUTF8 = function (buf) {
120
- return buf.length < 150 ? _isValidUTF8(buf) : isValidUTF8(buf);
121
- };
122
- } catch (e) {
123
- // Continue regardless of the error.
124
- }
125
- }
@@ -1,535 +0,0 @@
1
- /* eslint no-unused-vars: ["error", { "varsIgnorePattern": "^net|tls|https$" }] */
2
-
3
- 'use strict';
4
-
5
- const EventEmitter = require('events');
6
- const http = require('http');
7
- const https = require('https');
8
- const net = require('net');
9
- const tls = require('tls');
10
- const { createHash } = require('crypto');
11
-
12
- const extension = require('./extension');
13
- const PerMessageDeflate = require('./permessage-deflate');
14
- const subprotocol = require('./subprotocol');
15
- const WebSocket = require('./websocket');
16
- const { GUID, kWebSocket } = require('./constants');
17
-
18
- const keyRegex = /^[+/0-9A-Za-z]{22}==$/;
19
-
20
- const RUNNING = 0;
21
- const CLOSING = 1;
22
- const CLOSED = 2;
23
-
24
- /**
25
- * Class representing a WebSocket server.
26
- *
27
- * @extends EventEmitter
28
- */
29
- class WebSocketServer extends EventEmitter {
30
- /**
31
- * Create a `WebSocketServer` instance.
32
- *
33
- * @param {Object} options Configuration options
34
- * @param {Number} [options.backlog=511] The maximum length of the queue of
35
- * pending connections
36
- * @param {Boolean} [options.clientTracking=true] Specifies whether or not to
37
- * track clients
38
- * @param {Function} [options.handleProtocols] A hook to handle protocols
39
- * @param {String} [options.host] The hostname where to bind the server
40
- * @param {Number} [options.maxPayload=104857600] The maximum allowed message
41
- * size
42
- * @param {Boolean} [options.noServer=false] Enable no server mode
43
- * @param {String} [options.path] Accept only connections matching this path
44
- * @param {(Boolean|Object)} [options.perMessageDeflate=false] Enable/disable
45
- * permessage-deflate
46
- * @param {Number} [options.port] The port where to bind the server
47
- * @param {(http.Server|https.Server)} [options.server] A pre-created HTTP/S
48
- * server to use
49
- * @param {Boolean} [options.skipUTF8Validation=false] Specifies whether or
50
- * not to skip UTF-8 validation for text and close messages
51
- * @param {Function} [options.verifyClient] A hook to reject connections
52
- * @param {Function} [options.WebSocket=WebSocket] Specifies the `WebSocket`
53
- * class to use. It must be the `WebSocket` class or class that extends it
54
- * @param {Function} [callback] A listener for the `listening` event
55
- */
56
- constructor(options, callback) {
57
- super();
58
-
59
- options = {
60
- maxPayload: 100 * 1024 * 1024,
61
- skipUTF8Validation: false,
62
- perMessageDeflate: false,
63
- handleProtocols: null,
64
- clientTracking: true,
65
- verifyClient: null,
66
- noServer: false,
67
- backlog: null, // use default (511 as implemented in net.js)
68
- server: null,
69
- host: null,
70
- path: null,
71
- port: null,
72
- WebSocket,
73
- ...options
74
- };
75
-
76
- if (
77
- (options.port == null && !options.server && !options.noServer) ||
78
- (options.port != null && (options.server || options.noServer)) ||
79
- (options.server && options.noServer)
80
- ) {
81
- throw new TypeError(
82
- 'One and only one of the "port", "server", or "noServer" options ' +
83
- 'must be specified'
84
- );
85
- }
86
-
87
- if (options.port != null) {
88
- this._server = http.createServer((req, res) => {
89
- const body = http.STATUS_CODES[426];
90
-
91
- res.writeHead(426, {
92
- 'Content-Length': body.length,
93
- 'Content-Type': 'text/plain'
94
- });
95
- res.end(body);
96
- });
97
- this._server.listen(
98
- options.port,
99
- options.host,
100
- options.backlog,
101
- callback
102
- );
103
- } else if (options.server) {
104
- this._server = options.server;
105
- }
106
-
107
- if (this._server) {
108
- const emitConnection = this.emit.bind(this, 'connection');
109
-
110
- this._removeListeners = addListeners(this._server, {
111
- listening: this.emit.bind(this, 'listening'),
112
- error: this.emit.bind(this, 'error'),
113
- upgrade: (req, socket, head) => {
114
- this.handleUpgrade(req, socket, head, emitConnection);
115
- }
116
- });
117
- }
118
-
119
- if (options.perMessageDeflate === true) options.perMessageDeflate = {};
120
- if (options.clientTracking) {
121
- this.clients = new Set();
122
- this._shouldEmitClose = false;
123
- }
124
-
125
- this.options = options;
126
- this._state = RUNNING;
127
- }
128
-
129
- /**
130
- * Returns the bound address, the address family name, and port of the server
131
- * as reported by the operating system if listening on an IP socket.
132
- * If the server is listening on a pipe or UNIX domain socket, the name is
133
- * returned as a string.
134
- *
135
- * @return {(Object|String|null)} The address of the server
136
- * @public
137
- */
138
- address() {
139
- if (this.options.noServer) {
140
- throw new Error('The server is operating in "noServer" mode');
141
- }
142
-
143
- if (!this._server) return null;
144
- return this._server.address();
145
- }
146
-
147
- /**
148
- * Stop the server from accepting new connections and emit the `'close'` event
149
- * when all existing connections are closed.
150
- *
151
- * @param {Function} [cb] A one-time listener for the `'close'` event
152
- * @public
153
- */
154
- close(cb) {
155
- if (this._state === CLOSED) {
156
- if (cb) {
157
- this.once('close', () => {
158
- cb(new Error('The server is not running'));
159
- });
160
- }
161
-
162
- process.nextTick(emitClose, this);
163
- return;
164
- }
165
-
166
- if (cb) this.once('close', cb);
167
-
168
- if (this._state === CLOSING) return;
169
- this._state = CLOSING;
170
-
171
- if (this.options.noServer || this.options.server) {
172
- if (this._server) {
173
- this._removeListeners();
174
- this._removeListeners = this._server = null;
175
- }
176
-
177
- if (this.clients) {
178
- if (!this.clients.size) {
179
- process.nextTick(emitClose, this);
180
- } else {
181
- this._shouldEmitClose = true;
182
- }
183
- } else {
184
- process.nextTick(emitClose, this);
185
- }
186
- } else {
187
- const server = this._server;
188
-
189
- this._removeListeners();
190
- this._removeListeners = this._server = null;
191
-
192
- //
193
- // The HTTP/S server was created internally. Close it, and rely on its
194
- // `'close'` event.
195
- //
196
- server.close(() => {
197
- emitClose(this);
198
- });
199
- }
200
- }
201
-
202
- /**
203
- * See if a given request should be handled by this server instance.
204
- *
205
- * @param {http.IncomingMessage} req Request object to inspect
206
- * @return {Boolean} `true` if the request is valid, else `false`
207
- * @public
208
- */
209
- shouldHandle(req) {
210
- if (this.options.path) {
211
- const index = req.url.indexOf('?');
212
- const pathname = index !== -1 ? req.url.slice(0, index) : req.url;
213
-
214
- if (pathname !== this.options.path) return false;
215
- }
216
-
217
- return true;
218
- }
219
-
220
- /**
221
- * Handle a HTTP Upgrade request.
222
- *
223
- * @param {http.IncomingMessage} req The request object
224
- * @param {(net.Socket|tls.Socket)} socket The network socket between the
225
- * server and client
226
- * @param {Buffer} head The first packet of the upgraded stream
227
- * @param {Function} cb Callback
228
- * @public
229
- */
230
- handleUpgrade(req, socket, head, cb) {
231
- socket.on('error', socketOnError);
232
-
233
- const key = req.headers['sec-websocket-key'];
234
- const version = +req.headers['sec-websocket-version'];
235
-
236
- if (req.method !== 'GET') {
237
- const message = 'Invalid HTTP method';
238
- abortHandshakeOrEmitwsClientError(this, req, socket, 405, message);
239
- return;
240
- }
241
-
242
- if (req.headers.upgrade.toLowerCase() !== 'websocket') {
243
- const message = 'Invalid Upgrade header';
244
- abortHandshakeOrEmitwsClientError(this, req, socket, 400, message);
245
- return;
246
- }
247
-
248
- if (!key || !keyRegex.test(key)) {
249
- const message = 'Missing or invalid Sec-WebSocket-Key header';
250
- abortHandshakeOrEmitwsClientError(this, req, socket, 400, message);
251
- return;
252
- }
253
-
254
- if (version !== 8 && version !== 13) {
255
- const message = 'Missing or invalid Sec-WebSocket-Version header';
256
- abortHandshakeOrEmitwsClientError(this, req, socket, 400, message);
257
- return;
258
- }
259
-
260
- if (!this.shouldHandle(req)) {
261
- abortHandshake(socket, 400);
262
- return;
263
- }
264
-
265
- const secWebSocketProtocol = req.headers['sec-websocket-protocol'];
266
- let protocols = new Set();
267
-
268
- if (secWebSocketProtocol !== undefined) {
269
- try {
270
- protocols = subprotocol.parse(secWebSocketProtocol);
271
- } catch (err) {
272
- const message = 'Invalid Sec-WebSocket-Protocol header';
273
- abortHandshakeOrEmitwsClientError(this, req, socket, 400, message);
274
- return;
275
- }
276
- }
277
-
278
- const secWebSocketExtensions = req.headers['sec-websocket-extensions'];
279
- const extensions = {};
280
-
281
- if (
282
- this.options.perMessageDeflate &&
283
- secWebSocketExtensions !== undefined
284
- ) {
285
- const perMessageDeflate = new PerMessageDeflate(
286
- this.options.perMessageDeflate,
287
- true,
288
- this.options.maxPayload
289
- );
290
-
291
- try {
292
- const offers = extension.parse(secWebSocketExtensions);
293
-
294
- if (offers[PerMessageDeflate.extensionName]) {
295
- perMessageDeflate.accept(offers[PerMessageDeflate.extensionName]);
296
- extensions[PerMessageDeflate.extensionName] = perMessageDeflate;
297
- }
298
- } catch (err) {
299
- const message =
300
- 'Invalid or unacceptable Sec-WebSocket-Extensions header';
301
- abortHandshakeOrEmitwsClientError(this, req, socket, 400, message);
302
- return;
303
- }
304
- }
305
-
306
- //
307
- // Optionally call external client verification handler.
308
- //
309
- if (this.options.verifyClient) {
310
- const info = {
311
- origin:
312
- req.headers[`${version === 8 ? 'sec-websocket-origin' : 'origin'}`],
313
- secure: !!(req.socket.authorized || req.socket.encrypted),
314
- req
315
- };
316
-
317
- if (this.options.verifyClient.length === 2) {
318
- this.options.verifyClient(info, (verified, code, message, headers) => {
319
- if (!verified) {
320
- return abortHandshake(socket, code || 401, message, headers);
321
- }
322
-
323
- this.completeUpgrade(
324
- extensions,
325
- key,
326
- protocols,
327
- req,
328
- socket,
329
- head,
330
- cb
331
- );
332
- });
333
- return;
334
- }
335
-
336
- if (!this.options.verifyClient(info)) return abortHandshake(socket, 401);
337
- }
338
-
339
- this.completeUpgrade(extensions, key, protocols, req, socket, head, cb);
340
- }
341
-
342
- /**
343
- * Upgrade the connection to WebSocket.
344
- *
345
- * @param {Object} extensions The accepted extensions
346
- * @param {String} key The value of the `Sec-WebSocket-Key` header
347
- * @param {Set} protocols The subprotocols
348
- * @param {http.IncomingMessage} req The request object
349
- * @param {(net.Socket|tls.Socket)} socket The network socket between the
350
- * server and client
351
- * @param {Buffer} head The first packet of the upgraded stream
352
- * @param {Function} cb Callback
353
- * @throws {Error} If called more than once with the same socket
354
- * @private
355
- */
356
- completeUpgrade(extensions, key, protocols, req, socket, head, cb) {
357
- //
358
- // Destroy the socket if the client has already sent a FIN packet.
359
- //
360
- if (!socket.readable || !socket.writable) return socket.destroy();
361
-
362
- if (socket[kWebSocket]) {
363
- throw new Error(
364
- 'server.handleUpgrade() was called more than once with the same ' +
365
- 'socket, possibly due to a misconfiguration'
366
- );
367
- }
368
-
369
- if (this._state > RUNNING) return abortHandshake(socket, 503);
370
-
371
- const digest = createHash('sha1')
372
- .update(key + GUID)
373
- .digest('base64');
374
-
375
- const headers = [
376
- 'HTTP/1.1 101 Switching Protocols',
377
- 'Upgrade: websocket',
378
- 'Connection: Upgrade',
379
- `Sec-WebSocket-Accept: ${digest}`
380
- ];
381
-
382
- const ws = new this.options.WebSocket(null);
383
-
384
- if (protocols.size) {
385
- //
386
- // Optionally call external protocol selection handler.
387
- //
388
- const protocol = this.options.handleProtocols
389
- ? this.options.handleProtocols(protocols, req)
390
- : protocols.values().next().value;
391
-
392
- if (protocol) {
393
- headers.push(`Sec-WebSocket-Protocol: ${protocol}`);
394
- ws._protocol = protocol;
395
- }
396
- }
397
-
398
- if (extensions[PerMessageDeflate.extensionName]) {
399
- const params = extensions[PerMessageDeflate.extensionName].params;
400
- const value = extension.format({
401
- [PerMessageDeflate.extensionName]: [params]
402
- });
403
- headers.push(`Sec-WebSocket-Extensions: ${value}`);
404
- ws._extensions = extensions;
405
- }
406
-
407
- //
408
- // Allow external modification/inspection of handshake headers.
409
- //
410
- this.emit('headers', headers, req);
411
-
412
- socket.write(headers.concat('\r\n').join('\r\n'));
413
- socket.removeListener('error', socketOnError);
414
-
415
- ws.setSocket(socket, head, {
416
- maxPayload: this.options.maxPayload,
417
- skipUTF8Validation: this.options.skipUTF8Validation
418
- });
419
-
420
- if (this.clients) {
421
- this.clients.add(ws);
422
- ws.on('close', () => {
423
- this.clients.delete(ws);
424
-
425
- if (this._shouldEmitClose && !this.clients.size) {
426
- process.nextTick(emitClose, this);
427
- }
428
- });
429
- }
430
-
431
- cb(ws, req);
432
- }
433
- }
434
-
435
- module.exports = WebSocketServer;
436
-
437
- /**
438
- * Add event listeners on an `EventEmitter` using a map of <event, listener>
439
- * pairs.
440
- *
441
- * @param {EventEmitter} server The event emitter
442
- * @param {Object.<String, Function>} map The listeners to add
443
- * @return {Function} A function that will remove the added listeners when
444
- * called
445
- * @private
446
- */
447
- function addListeners(server, map) {
448
- for (const event of Object.keys(map)) server.on(event, map[event]);
449
-
450
- return function removeListeners() {
451
- for (const event of Object.keys(map)) {
452
- server.removeListener(event, map[event]);
453
- }
454
- };
455
- }
456
-
457
- /**
458
- * Emit a `'close'` event on an `EventEmitter`.
459
- *
460
- * @param {EventEmitter} server The event emitter
461
- * @private
462
- */
463
- function emitClose(server) {
464
- server._state = CLOSED;
465
- server.emit('close');
466
- }
467
-
468
- /**
469
- * Handle socket errors.
470
- *
471
- * @private
472
- */
473
- function socketOnError() {
474
- this.destroy();
475
- }
476
-
477
- /**
478
- * Close the connection when preconditions are not fulfilled.
479
- *
480
- * @param {(net.Socket|tls.Socket)} socket The socket of the upgrade request
481
- * @param {Number} code The HTTP response status code
482
- * @param {String} [message] The HTTP response body
483
- * @param {Object} [headers] Additional HTTP response headers
484
- * @private
485
- */
486
- function abortHandshake(socket, code, message, headers) {
487
- //
488
- // The socket is writable unless the user destroyed or ended it before calling
489
- // `server.handleUpgrade()` or in the `verifyClient` function, which is a user
490
- // error. Handling this does not make much sense as the worst that can happen
491
- // is that some of the data written by the user might be discarded due to the
492
- // call to `socket.end()` below, which triggers an `'error'` event that in
493
- // turn causes the socket to be destroyed.
494
- //
495
- message = message || http.STATUS_CODES[code];
496
- headers = {
497
- Connection: 'close',
498
- 'Content-Type': 'text/html',
499
- 'Content-Length': Buffer.byteLength(message),
500
- ...headers
501
- };
502
-
503
- socket.once('finish', socket.destroy);
504
-
505
- socket.end(
506
- `HTTP/1.1 ${code} ${http.STATUS_CODES[code]}\r\n` +
507
- Object.keys(headers)
508
- .map((h) => `${h}: ${headers[h]}`)
509
- .join('\r\n') +
510
- '\r\n\r\n' +
511
- message
512
- );
513
- }
514
-
515
- /**
516
- * Emit a `'wsClientError'` event on a `WebSocketServer` if there is at least
517
- * one listener for it, otherwise call `abortHandshake()`.
518
- *
519
- * @param {WebSocketServer} server The WebSocket server
520
- * @param {http.IncomingMessage} req The request object
521
- * @param {(net.Socket|tls.Socket)} socket The socket of the upgrade request
522
- * @param {Number} code The HTTP response status code
523
- * @param {String} message The HTTP response body
524
- * @private
525
- */
526
- function abortHandshakeOrEmitwsClientError(server, req, socket, code, message) {
527
- if (server.listenerCount('wsClientError')) {
528
- const err = new Error(message);
529
- Error.captureStackTrace(err, abortHandshakeOrEmitwsClientError);
530
-
531
- server.emit('wsClientError', err, socket, req);
532
- } else {
533
- abortHandshake(socket, code, message);
534
- }
535
- }