undici 7.0.0-alpha.1 → 7.0.0-alpha.2
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.
- package/README.md +2 -2
- package/docs/docs/api/Client.md +1 -1
- package/docs/docs/api/Debug.md +1 -1
- package/docs/docs/api/Dispatcher.md +53 -2
- package/docs/docs/api/MockAgent.md +2 -0
- package/docs/docs/api/MockPool.md +2 -1
- package/docs/docs/api/RetryAgent.md +1 -1
- package/docs/docs/api/RetryHandler.md +1 -1
- package/docs/docs/api/WebSocket.md +45 -3
- package/index.js +6 -2
- package/lib/api/abort-signal.js +2 -0
- package/lib/api/api-pipeline.js +4 -2
- package/lib/api/api-request.js +4 -2
- package/lib/api/api-stream.js +3 -1
- package/lib/api/api-upgrade.js +2 -2
- package/lib/api/readable.js +194 -41
- package/lib/api/util.js +2 -0
- package/lib/core/connect.js +49 -22
- package/lib/core/constants.js +11 -9
- package/lib/core/diagnostics.js +122 -128
- package/lib/core/request.js +4 -4
- package/lib/core/symbols.js +2 -0
- package/lib/core/tree.js +4 -2
- package/lib/core/util.js +220 -39
- package/lib/dispatcher/client-h1.js +299 -60
- package/lib/dispatcher/client-h2.js +1 -1
- package/lib/dispatcher/client.js +24 -7
- package/lib/dispatcher/fixed-queue.js +91 -49
- package/lib/dispatcher/pool-stats.js +2 -0
- package/lib/dispatcher/proxy-agent.js +3 -1
- package/lib/handler/redirect-handler.js +2 -2
- package/lib/handler/retry-handler.js +2 -2
- package/lib/interceptor/dns.js +346 -0
- package/lib/mock/mock-agent.js +5 -8
- package/lib/mock/mock-client.js +7 -2
- package/lib/mock/mock-errors.js +3 -1
- package/lib/mock/mock-interceptor.js +8 -6
- package/lib/mock/mock-pool.js +7 -2
- package/lib/mock/mock-symbols.js +2 -1
- package/lib/mock/mock-utils.js +33 -5
- package/lib/util/timers.js +50 -6
- package/lib/web/cache/cache.js +24 -21
- package/lib/web/cache/cachestorage.js +1 -1
- package/lib/web/cookies/index.js +6 -4
- package/lib/web/fetch/body.js +42 -34
- package/lib/web/fetch/constants.js +35 -26
- package/lib/web/fetch/formdata-parser.js +14 -3
- package/lib/web/fetch/formdata.js +40 -20
- package/lib/web/fetch/headers.js +116 -84
- package/lib/web/fetch/index.js +65 -59
- package/lib/web/fetch/request.js +130 -55
- package/lib/web/fetch/response.js +79 -36
- package/lib/web/fetch/util.js +104 -57
- package/lib/web/fetch/webidl.js +38 -14
- package/lib/web/websocket/connection.js +92 -15
- package/lib/web/websocket/constants.js +2 -3
- package/lib/web/websocket/events.js +4 -2
- package/lib/web/websocket/receiver.js +20 -26
- package/lib/web/websocket/stream/websocketerror.js +83 -0
- package/lib/web/websocket/stream/websocketstream.js +485 -0
- package/lib/web/websocket/util.js +115 -10
- package/lib/web/websocket/websocket.js +45 -170
- package/package.json +6 -6
- package/types/interceptors.d.ts +14 -0
- package/types/mock-agent.d.ts +3 -0
- package/types/readable.d.ts +10 -7
- package/types/webidl.d.ts +24 -4
- package/types/websocket.d.ts +33 -0
- package/lib/mock/pluralizer.js +0 -29
- package/lib/web/cache/symbols.js +0 -5
- package/lib/web/fetch/symbols.js +0 -8
|
@@ -0,0 +1,485 @@
|
|
|
1
|
+
'use strict'
|
|
2
|
+
|
|
3
|
+
const { createDeferredPromise, environmentSettingsObject } = require('../../fetch/util')
|
|
4
|
+
const { states, opcodes, sentCloseFrameState } = require('../constants')
|
|
5
|
+
const { webidl } = require('../../fetch/webidl')
|
|
6
|
+
const { getURLRecord, isValidSubprotocol, isEstablished, failWebsocketConnection, utf8Decode } = require('../util')
|
|
7
|
+
const { establishWebSocketConnection, closeWebSocketConnection } = require('../connection')
|
|
8
|
+
const { types } = require('node:util')
|
|
9
|
+
const { channels } = require('../../../core/diagnostics')
|
|
10
|
+
const { WebsocketFrameSend } = require('../frame')
|
|
11
|
+
const { ByteParser } = require('../receiver')
|
|
12
|
+
const { WebSocketError, createUnvalidatedWebSocketError } = require('./websocketerror')
|
|
13
|
+
const { utf8DecodeBytes } = require('../../fetch/util')
|
|
14
|
+
const { kEnumerableProperty } = require('../../../core/util')
|
|
15
|
+
|
|
16
|
+
let emittedExperimentalWarning = false
|
|
17
|
+
|
|
18
|
+
class WebSocketStream {
|
|
19
|
+
// Each WebSocketStream object has an associated url , which is a URL record .
|
|
20
|
+
/** @type {URL} */
|
|
21
|
+
#url
|
|
22
|
+
|
|
23
|
+
// Each WebSocketStream object has an associated opened promise , which is a promise.
|
|
24
|
+
/** @type {ReturnType<typeof createDeferredPromise>} */
|
|
25
|
+
#openedPromise
|
|
26
|
+
|
|
27
|
+
// Each WebSocketStream object has an associated closed promise , which is a promise.
|
|
28
|
+
/** @type {ReturnType<typeof createDeferredPromise>} */
|
|
29
|
+
#closedPromise
|
|
30
|
+
|
|
31
|
+
// Each WebSocketStream object has an associated readable stream , which is a ReadableStream .
|
|
32
|
+
/** @type {ReadableStream} */
|
|
33
|
+
#readableStream
|
|
34
|
+
/** @type {ReadableStreamDefaultController} */
|
|
35
|
+
#readableStreamController
|
|
36
|
+
|
|
37
|
+
// Each WebSocketStream object has an associated writable stream , which is a WritableStream .
|
|
38
|
+
/** @type {WritableStream} */
|
|
39
|
+
#writableStream
|
|
40
|
+
|
|
41
|
+
// Each WebSocketStream object has an associated boolean handshake aborted , which is initially false.
|
|
42
|
+
#handshakeAborted = false
|
|
43
|
+
|
|
44
|
+
/** @type {import('../websocket').Handler} */
|
|
45
|
+
#handler = {
|
|
46
|
+
// https://whatpr.org/websockets/48/7b748d3...d5570f3.html#feedback-to-websocket-stream-from-the-protocol
|
|
47
|
+
onConnectionEstablished: (response, extensions) => this.#onConnectionEstablished(response, extensions),
|
|
48
|
+
onFail: (_code, _reason) => {},
|
|
49
|
+
onMessage: (opcode, data) => this.#onMessage(opcode, data),
|
|
50
|
+
onParserError: (err) => failWebsocketConnection(this.#handler, null, err.message),
|
|
51
|
+
onParserDrain: () => this.#handler.socket.resume(),
|
|
52
|
+
onSocketData: (chunk) => {
|
|
53
|
+
if (!this.#parser.write(chunk)) {
|
|
54
|
+
this.#handler.socket.pause()
|
|
55
|
+
}
|
|
56
|
+
},
|
|
57
|
+
onSocketError: (err) => {
|
|
58
|
+
this.#handler.readyState = states.CLOSING
|
|
59
|
+
|
|
60
|
+
if (channels.socketError.hasSubscribers) {
|
|
61
|
+
channels.socketError.publish(err)
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
this.#handler.socket.destroy()
|
|
65
|
+
},
|
|
66
|
+
onSocketClose: () => this.#onSocketClose(),
|
|
67
|
+
|
|
68
|
+
readyState: states.CONNECTING,
|
|
69
|
+
socket: null,
|
|
70
|
+
closeState: new Set(),
|
|
71
|
+
controller: null,
|
|
72
|
+
wasEverConnected: false
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
/** @type {import('../receiver').ByteParser} */
|
|
76
|
+
#parser
|
|
77
|
+
|
|
78
|
+
constructor (url, options = undefined) {
|
|
79
|
+
if (!emittedExperimentalWarning) {
|
|
80
|
+
process.emitWarning('WebSocketStream is experimental! Expect it to change at any time.', {
|
|
81
|
+
code: 'UNDICI-WSS'
|
|
82
|
+
})
|
|
83
|
+
emittedExperimentalWarning = true
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
webidl.argumentLengthCheck(arguments, 1, 'WebSocket')
|
|
87
|
+
|
|
88
|
+
url = webidl.converters.USVString(url)
|
|
89
|
+
if (options !== null) {
|
|
90
|
+
options = webidl.converters.WebSocketStreamOptions(options)
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
// 1. Let baseURL be this 's relevant settings object 's API base URL .
|
|
94
|
+
const baseURL = environmentSettingsObject.settingsObject.baseUrl
|
|
95
|
+
|
|
96
|
+
// 2. Let urlRecord be the result of getting a URL record given url and baseURL .
|
|
97
|
+
const urlRecord = getURLRecord(url, baseURL)
|
|
98
|
+
|
|
99
|
+
// 3. Let protocols be options [" protocols "] if it exists , otherwise an empty sequence.
|
|
100
|
+
const protocols = options.protocols
|
|
101
|
+
|
|
102
|
+
// 4. If any of the values in protocols occur more than once or otherwise fail to match the requirements for elements that comprise the value of ` Sec-WebSocket-Protocol ` fields as defined by The WebSocket Protocol , then throw a " SyntaxError " DOMException . [WSP]
|
|
103
|
+
if (protocols.length !== new Set(protocols.map(p => p.toLowerCase())).size) {
|
|
104
|
+
throw new DOMException('Invalid Sec-WebSocket-Protocol value', 'SyntaxError')
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
if (protocols.length > 0 && !protocols.every(p => isValidSubprotocol(p))) {
|
|
108
|
+
throw new DOMException('Invalid Sec-WebSocket-Protocol value', 'SyntaxError')
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
// 5. Set this 's url to urlRecord .
|
|
112
|
+
this.#url = urlRecord.toString()
|
|
113
|
+
|
|
114
|
+
// 6. Set this 's opened promise and closed promise to new promises.
|
|
115
|
+
this.#openedPromise = createDeferredPromise()
|
|
116
|
+
this.#closedPromise = createDeferredPromise()
|
|
117
|
+
|
|
118
|
+
// 7. Apply backpressure to the WebSocket.
|
|
119
|
+
// TODO
|
|
120
|
+
|
|
121
|
+
// 8. If options [" signal "] exists ,
|
|
122
|
+
if (options.signal != null) {
|
|
123
|
+
// 8.1. Let signal be options [" signal "].
|
|
124
|
+
const signal = options.signal
|
|
125
|
+
|
|
126
|
+
// 8.2. If signal is aborted , then reject this 's opened promise and closed promise with signal ’s abort reason
|
|
127
|
+
// and return.
|
|
128
|
+
if (signal.aborted) {
|
|
129
|
+
this.#openedPromise.reject(signal.reason)
|
|
130
|
+
this.#closedPromise.reject(signal.reason)
|
|
131
|
+
return
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
// 8.3. Add the following abort steps to signal :
|
|
135
|
+
signal.addEventListener('abort', () => {
|
|
136
|
+
// 8.3.1. If the WebSocket connection is not yet established : [WSP]
|
|
137
|
+
if (!isEstablished(this.#handler.readyState)) {
|
|
138
|
+
// 8.3.1.1. Fail the WebSocket connection .
|
|
139
|
+
failWebsocketConnection(this.#handler)
|
|
140
|
+
|
|
141
|
+
// Set this 's ready state to CLOSING .
|
|
142
|
+
this.#handler.readyState = states.CLOSING
|
|
143
|
+
|
|
144
|
+
// Reject this 's opened promise and closed promise with signal ’s abort reason .
|
|
145
|
+
this.#openedPromise.reject(signal.reason)
|
|
146
|
+
this.#closedPromise.reject(signal.reason)
|
|
147
|
+
|
|
148
|
+
// Set this 's handshake aborted to true.
|
|
149
|
+
this.#handshakeAborted = true
|
|
150
|
+
}
|
|
151
|
+
}, { once: true })
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
// 9. Let client be this 's relevant settings object .
|
|
155
|
+
const client = environmentSettingsObject.settingsObject
|
|
156
|
+
|
|
157
|
+
// 10. Run this step in parallel :
|
|
158
|
+
// 10.1. Establish a WebSocket connection given urlRecord , protocols , and client . [FETCH]
|
|
159
|
+
this.#handler.controller = establishWebSocketConnection(
|
|
160
|
+
urlRecord,
|
|
161
|
+
protocols,
|
|
162
|
+
client,
|
|
163
|
+
this.#handler,
|
|
164
|
+
options
|
|
165
|
+
)
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
// The url getter steps are to return this 's url , serialized .
|
|
169
|
+
get url () {
|
|
170
|
+
return this.#url.toString()
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
// The opened getter steps are to return this 's opened promise .
|
|
174
|
+
get opened () {
|
|
175
|
+
return this.#openedPromise.promise
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
// The closed getter steps are to return this 's closed promise .
|
|
179
|
+
get closed () {
|
|
180
|
+
return this.#closedPromise.promise
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
// The close( closeInfo ) method steps are:
|
|
184
|
+
close (closeInfo = undefined) {
|
|
185
|
+
if (closeInfo !== null) {
|
|
186
|
+
closeInfo = webidl.converters.WebSocketCloseInfo(closeInfo)
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
// 1. Let code be closeInfo [" closeCode "] if present, or null otherwise.
|
|
190
|
+
const code = closeInfo.closeCode ?? null
|
|
191
|
+
|
|
192
|
+
// 2. Let reason be closeInfo [" reason "].
|
|
193
|
+
const reason = closeInfo.reason
|
|
194
|
+
|
|
195
|
+
// 3. Close the WebSocket with this , code , and reason .
|
|
196
|
+
closeWebSocketConnection(this.#handler, code, reason, true)
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
#write (chunk) {
|
|
200
|
+
// 1. Let promise be a new promise created in stream ’s relevant realm .
|
|
201
|
+
const promise = createDeferredPromise()
|
|
202
|
+
|
|
203
|
+
// 2. Let data be null.
|
|
204
|
+
let data = null
|
|
205
|
+
|
|
206
|
+
// 3. Let opcode be null.
|
|
207
|
+
let opcode = null
|
|
208
|
+
|
|
209
|
+
// 4. If chunk is a BufferSource ,
|
|
210
|
+
if (ArrayBuffer.isView(chunk) || types.isArrayBuffer(chunk)) {
|
|
211
|
+
// 4.1. Set data to a copy of the bytes given chunk .
|
|
212
|
+
data = new Uint8Array(ArrayBuffer.isView(chunk) ? new Uint8Array(chunk.buffer, chunk.byteOffset, chunk.byteLength) : chunk)
|
|
213
|
+
|
|
214
|
+
// 4.2. Set opcode to a binary frame opcode.
|
|
215
|
+
opcode = opcodes.BINARY
|
|
216
|
+
} else {
|
|
217
|
+
// 5. Otherwise,
|
|
218
|
+
|
|
219
|
+
// 5.1. Let string be the result of converting chunk to an IDL USVString .
|
|
220
|
+
// If this throws an exception, return a promise rejected with the exception.
|
|
221
|
+
let string
|
|
222
|
+
|
|
223
|
+
try {
|
|
224
|
+
string = webidl.converters.DOMString(chunk)
|
|
225
|
+
} catch (e) {
|
|
226
|
+
promise.reject(e)
|
|
227
|
+
return
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
// 5.2. Set data to the result of UTF-8 encoding string .
|
|
231
|
+
data = new TextEncoder().encode(string)
|
|
232
|
+
|
|
233
|
+
// 5.3. Set opcode to a text frame opcode.
|
|
234
|
+
opcode = opcodes.TEXT
|
|
235
|
+
}
|
|
236
|
+
|
|
237
|
+
// 6. In parallel,
|
|
238
|
+
// 6.1. Wait until there is sufficient buffer space in stream to send the message.
|
|
239
|
+
|
|
240
|
+
// 6.2. If the closing handshake has not yet started , Send a WebSocket Message to stream comprised of data using opcode .
|
|
241
|
+
if (!this.#handler.closeState.has(sentCloseFrameState.SENT) && !this.#handler.closeState.has(sentCloseFrameState.RECEIVED)) {
|
|
242
|
+
const frame = new WebsocketFrameSend(data)
|
|
243
|
+
|
|
244
|
+
this.#handler.socket.write(frame.createFrame(opcode), () => {
|
|
245
|
+
promise.resolve(undefined)
|
|
246
|
+
})
|
|
247
|
+
}
|
|
248
|
+
|
|
249
|
+
// 6.3. Queue a global task on the WebSocket task source given stream ’s relevant global object to resolve promise with undefined.
|
|
250
|
+
return promise
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
/** @type {import('../websocket').Handler['onConnectionEstablished']} */
|
|
254
|
+
#onConnectionEstablished (response, parsedExtensions) {
|
|
255
|
+
this.#handler.socket = response.socket
|
|
256
|
+
|
|
257
|
+
const parser = new ByteParser(this.#handler, parsedExtensions)
|
|
258
|
+
parser.on('drain', () => this.#handler.onParserDrain())
|
|
259
|
+
parser.on('error', (err) => this.#handler.onParserError(err))
|
|
260
|
+
|
|
261
|
+
this.#parser = parser
|
|
262
|
+
|
|
263
|
+
// 1. Change stream ’s ready state to OPEN (1).
|
|
264
|
+
this.#handler.readyState = states.OPEN
|
|
265
|
+
|
|
266
|
+
// 2. Set stream ’s was ever connected to true.
|
|
267
|
+
// This is done in the opening handshake.
|
|
268
|
+
|
|
269
|
+
// 3. Let extensions be the extensions in use .
|
|
270
|
+
const extensions = parsedExtensions ?? ''
|
|
271
|
+
|
|
272
|
+
// 4. Let protocol be the subprotocol in use .
|
|
273
|
+
const protocol = response.headersList.get('sec-websocket-protocol') ?? ''
|
|
274
|
+
|
|
275
|
+
// 5. Let pullAlgorithm be an action that pulls bytes from stream .
|
|
276
|
+
// 6. Let cancelAlgorithm be an action that cancels stream with reason , given reason .
|
|
277
|
+
// 7. Let readable be a new ReadableStream .
|
|
278
|
+
// 8. Set up readable with pullAlgorithm and cancelAlgorithm .
|
|
279
|
+
const readable = new ReadableStream({
|
|
280
|
+
start: (controller) => {
|
|
281
|
+
this.#readableStreamController = controller
|
|
282
|
+
},
|
|
283
|
+
pull (controller) {
|
|
284
|
+
let chunk
|
|
285
|
+
while (controller.desiredSize > 0 && (chunk = response.socket.read()) !== null) {
|
|
286
|
+
controller.enqueue(chunk)
|
|
287
|
+
}
|
|
288
|
+
},
|
|
289
|
+
cancel: (reason) => this.#cancel(reason)
|
|
290
|
+
})
|
|
291
|
+
|
|
292
|
+
// 9. Let writeAlgorithm be an action that writes chunk to stream , given chunk .
|
|
293
|
+
// 10. Let closeAlgorithm be an action that closes stream .
|
|
294
|
+
// 11. Let abortAlgorithm be an action that aborts stream with reason , given reason .
|
|
295
|
+
// 12. Let writable be a new WritableStream .
|
|
296
|
+
// 13. Set up writable with writeAlgorithm , closeAlgorithm , and abortAlgorithm .
|
|
297
|
+
const writable = new WritableStream({
|
|
298
|
+
write: (chunk) => this.#write(chunk),
|
|
299
|
+
close: () => closeWebSocketConnection(this.#handler, null, null),
|
|
300
|
+
abort: (reason) => this.#closeUsingReason(reason)
|
|
301
|
+
})
|
|
302
|
+
|
|
303
|
+
// Set stream ’s readable stream to readable .
|
|
304
|
+
this.#readableStream = readable
|
|
305
|
+
|
|
306
|
+
// Set stream ’s writable stream to writable .
|
|
307
|
+
this.#writableStream = writable
|
|
308
|
+
|
|
309
|
+
// Resolve stream ’s opened promise with WebSocketOpenInfo «[ " extensions " → extensions , " protocol " → protocol , " readable " → readable , " writable " → writable ]».
|
|
310
|
+
this.#openedPromise.resolve({
|
|
311
|
+
extensions,
|
|
312
|
+
protocol,
|
|
313
|
+
readable,
|
|
314
|
+
writable
|
|
315
|
+
})
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
/** @type {import('../websocket').Handler['onMessage']} */
|
|
319
|
+
#onMessage (type, data) {
|
|
320
|
+
// 1. If stream’s ready state is not OPEN (1), then return.
|
|
321
|
+
if (this.#handler.readyState !== states.OPEN) {
|
|
322
|
+
return
|
|
323
|
+
}
|
|
324
|
+
|
|
325
|
+
// 2. Let chunk be determined by switching on type:
|
|
326
|
+
// - type indicates that the data is Text
|
|
327
|
+
// a new DOMString containing data
|
|
328
|
+
// - type indicates that the data is Binary
|
|
329
|
+
// a new Uint8Array object, created in the relevant Realm of the
|
|
330
|
+
// WebSocketStream object, whose contents are data
|
|
331
|
+
let chunk
|
|
332
|
+
|
|
333
|
+
if (type === opcodes.TEXT) {
|
|
334
|
+
try {
|
|
335
|
+
chunk = utf8Decode(data)
|
|
336
|
+
} catch {
|
|
337
|
+
failWebsocketConnection(this.#handler, 'Received invalid UTF-8 in text frame.')
|
|
338
|
+
return
|
|
339
|
+
}
|
|
340
|
+
} else if (type === opcodes.BINARY) {
|
|
341
|
+
chunk = new Uint8Array(data.buffer, data.byteOffset, data.byteLength)
|
|
342
|
+
}
|
|
343
|
+
|
|
344
|
+
// 3. Enqueue chunk into stream’s readable stream.
|
|
345
|
+
this.#readableStreamController.enqueue(chunk)
|
|
346
|
+
|
|
347
|
+
// 4. Apply backpressure to the WebSocket.
|
|
348
|
+
}
|
|
349
|
+
|
|
350
|
+
/** @type {import('../websocket').Handler['onSocketClose']} */
|
|
351
|
+
#onSocketClose () {
|
|
352
|
+
const wasClean =
|
|
353
|
+
this.#handler.closeState.has(sentCloseFrameState.SENT) &&
|
|
354
|
+
this.#handler.closeState.has(sentCloseFrameState.RECEIVED)
|
|
355
|
+
|
|
356
|
+
// 1. Change the ready state to CLOSED (3).
|
|
357
|
+
this.#handler.readyState = states.CLOSED
|
|
358
|
+
|
|
359
|
+
// 2. If stream ’s handshake aborted is true, then return.
|
|
360
|
+
if (this.#handshakeAborted) {
|
|
361
|
+
return
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
// 3. If stream ’s was ever connected is false, then reject stream ’s opened promise with a new WebSocketError.
|
|
365
|
+
if (!this.#handler.wasEverConnected) {
|
|
366
|
+
this.#openedPromise.reject(new WebSocketError('Socket never opened'))
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
const result = this.#parser.closingInfo
|
|
370
|
+
|
|
371
|
+
// 4. Let code be the WebSocket connection close code .
|
|
372
|
+
// https://datatracker.ietf.org/doc/html/rfc6455#section-7.1.5
|
|
373
|
+
// If this Close control frame contains no status code, _The WebSocket
|
|
374
|
+
// Connection Close Code_ is considered to be 1005. If _The WebSocket
|
|
375
|
+
// Connection is Closed_ and no Close control frame was received by the
|
|
376
|
+
// endpoint (such as could occur if the underlying transport connection
|
|
377
|
+
// is lost), _The WebSocket Connection Close Code_ is considered to be
|
|
378
|
+
// 1006.
|
|
379
|
+
let code = result?.code ?? 1005
|
|
380
|
+
|
|
381
|
+
if (!this.#handler.closeState.has(sentCloseFrameState.SENT) && !this.#handler.closeState.has(sentCloseFrameState.RECEIVED)) {
|
|
382
|
+
code = 1006
|
|
383
|
+
}
|
|
384
|
+
|
|
385
|
+
// 5. Let reason be the result of applying UTF-8 decode without BOM to the WebSocket connection close reason .
|
|
386
|
+
const reason = result?.reason == null ? '' : utf8DecodeBytes(Buffer.from(result.reason))
|
|
387
|
+
|
|
388
|
+
// 6. If the connection was closed cleanly ,
|
|
389
|
+
if (wasClean) {
|
|
390
|
+
// 6.1. Close stream ’s readable stream .
|
|
391
|
+
this.#readableStream.cancel().catch(() => {})
|
|
392
|
+
|
|
393
|
+
// 6.2. Error stream ’s writable stream with an " InvalidStateError " DOMException indicating that a closed WebSocketStream cannot be written to.
|
|
394
|
+
if (!this.#writableStream.locked) {
|
|
395
|
+
this.#writableStream.abort(new DOMException('A closed WebSocketStream cannot be written to', 'InvalidStateError'))
|
|
396
|
+
}
|
|
397
|
+
|
|
398
|
+
// 6.3. Resolve stream ’s closed promise with WebSocketCloseInfo «[ " closeCode " → code , " reason " → reason ]».
|
|
399
|
+
this.#closedPromise.resolve({
|
|
400
|
+
closeCode: code,
|
|
401
|
+
reason
|
|
402
|
+
})
|
|
403
|
+
} else {
|
|
404
|
+
// 7. Otherwise,
|
|
405
|
+
|
|
406
|
+
// 7.1. Let error be a new WebSocketError whose closeCode is code and reason is reason .
|
|
407
|
+
const error = createUnvalidatedWebSocketError('unclean close', code, reason)
|
|
408
|
+
|
|
409
|
+
// 7.2. Error stream ’s readable stream with error .
|
|
410
|
+
this.#readableStreamController.error(error)
|
|
411
|
+
|
|
412
|
+
// 7.3. Error stream ’s writable stream with error .
|
|
413
|
+
this.#writableStream.abort(error)
|
|
414
|
+
|
|
415
|
+
// 7.4. Reject stream ’s closed promise with error .
|
|
416
|
+
this.#closedPromise.reject(error)
|
|
417
|
+
}
|
|
418
|
+
}
|
|
419
|
+
|
|
420
|
+
#closeUsingReason (reason) {
|
|
421
|
+
// 1. Let code be null.
|
|
422
|
+
let code = null
|
|
423
|
+
|
|
424
|
+
// 2. Let reasonString be the empty string.
|
|
425
|
+
let reasonString = ''
|
|
426
|
+
|
|
427
|
+
// 3. If reason implements WebSocketError ,
|
|
428
|
+
if (webidl.is.WebSocketError(reason)) {
|
|
429
|
+
// 3.1. Set code to reason ’s closeCode .
|
|
430
|
+
code = reason.closeCode
|
|
431
|
+
|
|
432
|
+
// 3.2. Set reasonString to reason ’s reason .
|
|
433
|
+
reasonString = reason.reason
|
|
434
|
+
}
|
|
435
|
+
|
|
436
|
+
// 4. Close the WebSocket with stream , code , and reasonString . If this throws an exception,
|
|
437
|
+
// discard code and reasonString and close the WebSocket with stream .
|
|
438
|
+
closeWebSocketConnection(this.#handler, code, reasonString)
|
|
439
|
+
}
|
|
440
|
+
|
|
441
|
+
// To cancel a WebSocketStream stream given reason , close using reason giving stream and reason .
|
|
442
|
+
#cancel (reason) {
|
|
443
|
+
this.#closeUsingReason(reason)
|
|
444
|
+
}
|
|
445
|
+
}
|
|
446
|
+
|
|
447
|
+
Object.defineProperties(WebSocketStream.prototype, {
|
|
448
|
+
url: kEnumerableProperty,
|
|
449
|
+
opened: kEnumerableProperty,
|
|
450
|
+
closed: kEnumerableProperty,
|
|
451
|
+
close: kEnumerableProperty,
|
|
452
|
+
[Symbol.toStringTag]: {
|
|
453
|
+
value: 'WebSocketStream',
|
|
454
|
+
writable: false,
|
|
455
|
+
enumerable: false,
|
|
456
|
+
configurable: true
|
|
457
|
+
}
|
|
458
|
+
})
|
|
459
|
+
|
|
460
|
+
webidl.converters.WebSocketStreamOptions = webidl.dictionaryConverter([
|
|
461
|
+
{
|
|
462
|
+
key: 'protocols',
|
|
463
|
+
converter: webidl.sequenceConverter(webidl.converters.USVString),
|
|
464
|
+
defaultValue: () => []
|
|
465
|
+
},
|
|
466
|
+
{
|
|
467
|
+
key: 'signal',
|
|
468
|
+
converter: webidl.nullableConverter(webidl.converters.AbortSignal),
|
|
469
|
+
defaultValue: () => null
|
|
470
|
+
}
|
|
471
|
+
])
|
|
472
|
+
|
|
473
|
+
webidl.converters.WebSocketCloseInfo = webidl.dictionaryConverter([
|
|
474
|
+
{
|
|
475
|
+
key: 'closeCode',
|
|
476
|
+
converter: (V) => webidl.converters['unsigned short'](V, { enforceRange: true })
|
|
477
|
+
},
|
|
478
|
+
{
|
|
479
|
+
key: 'reason',
|
|
480
|
+
converter: webidl.converters.USVString,
|
|
481
|
+
defaultValue: () => ''
|
|
482
|
+
}
|
|
483
|
+
])
|
|
484
|
+
|
|
485
|
+
module.exports = { WebSocketStream }
|
|
@@ -50,6 +50,7 @@ function isClosed (readyState) {
|
|
|
50
50
|
* @param {EventTarget} target
|
|
51
51
|
* @param {(...args: ConstructorParameters<typeof Event>) => Event} eventFactory
|
|
52
52
|
* @param {EventInit | undefined} eventInitDict
|
|
53
|
+
* @returns {void}
|
|
53
54
|
*/
|
|
54
55
|
function fireEvent (e, target, eventFactory = (type, init) => new Event(type, init), eventInitDict = {}) {
|
|
55
56
|
// 1. If eventConstructor is not given, then let eventConstructor be Event.
|
|
@@ -72,11 +73,16 @@ function fireEvent (e, target, eventFactory = (type, init) => new Event(type, in
|
|
|
72
73
|
* @param {import('./websocket').Handler} handler
|
|
73
74
|
* @param {number} type Opcode
|
|
74
75
|
* @param {Buffer} data application data
|
|
76
|
+
* @returns {void}
|
|
75
77
|
*/
|
|
76
78
|
function websocketMessageReceived (handler, type, data) {
|
|
77
79
|
handler.onMessage(type, data)
|
|
78
80
|
}
|
|
79
81
|
|
|
82
|
+
/**
|
|
83
|
+
* @param {Buffer} buffer
|
|
84
|
+
* @returns {ArrayBuffer}
|
|
85
|
+
*/
|
|
80
86
|
function toArrayBuffer (buffer) {
|
|
81
87
|
if (buffer.byteLength === buffer.buffer.byteLength) {
|
|
82
88
|
return buffer.buffer
|
|
@@ -89,6 +95,7 @@ function toArrayBuffer (buffer) {
|
|
|
89
95
|
* @see https://datatracker.ietf.org/doc/html/rfc2616
|
|
90
96
|
* @see https://bugs.chromium.org/p/chromium/issues/detail?id=398407
|
|
91
97
|
* @param {string} protocol
|
|
98
|
+
* @returns {boolean}
|
|
92
99
|
*/
|
|
93
100
|
function isValidSubprotocol (protocol) {
|
|
94
101
|
// If present, this value indicates one
|
|
@@ -135,6 +142,7 @@ function isValidSubprotocol (protocol) {
|
|
|
135
142
|
/**
|
|
136
143
|
* @see https://datatracker.ietf.org/doc/html/rfc6455#section-7-4
|
|
137
144
|
* @param {number} code
|
|
145
|
+
* @returns {boolean}
|
|
138
146
|
*/
|
|
139
147
|
function isValidStatusCode (code) {
|
|
140
148
|
if (code >= 1000 && code < 1015) {
|
|
@@ -150,15 +158,34 @@ function isValidStatusCode (code) {
|
|
|
150
158
|
|
|
151
159
|
/**
|
|
152
160
|
* @param {import('./websocket').Handler} handler
|
|
161
|
+
* @param {number} code
|
|
153
162
|
* @param {string|undefined} reason
|
|
163
|
+
* @returns {void}
|
|
154
164
|
*/
|
|
155
|
-
function failWebsocketConnection (handler, reason) {
|
|
156
|
-
|
|
165
|
+
function failWebsocketConnection (handler, code, reason) {
|
|
166
|
+
// If _The WebSocket Connection is Established_ prior to the point where
|
|
167
|
+
// the endpoint is required to _Fail the WebSocket Connection_, the
|
|
168
|
+
// endpoint SHOULD send a Close frame with an appropriate status code
|
|
169
|
+
// (Section 7.4) before proceeding to _Close the WebSocket Connection_.
|
|
170
|
+
if (isEstablished(handler.readyState)) {
|
|
171
|
+
// avoid circular require - performance is not important here
|
|
172
|
+
const { closeWebSocketConnection } = require('./connection')
|
|
173
|
+
closeWebSocketConnection(handler, code, reason, false)
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
handler.controller.abort()
|
|
177
|
+
|
|
178
|
+
if (handler.socket?.destroyed === false) {
|
|
179
|
+
handler.socket.destroy()
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
handler.onFail(code, reason)
|
|
157
183
|
}
|
|
158
184
|
|
|
159
185
|
/**
|
|
160
186
|
* @see https://datatracker.ietf.org/doc/html/rfc6455#section-5.5
|
|
161
187
|
* @param {number} opcode
|
|
188
|
+
* @returns {boolean}
|
|
162
189
|
*/
|
|
163
190
|
function isControlFrame (opcode) {
|
|
164
191
|
return (
|
|
@@ -168,14 +195,27 @@ function isControlFrame (opcode) {
|
|
|
168
195
|
)
|
|
169
196
|
}
|
|
170
197
|
|
|
198
|
+
/**
|
|
199
|
+
* @param {number} opcode
|
|
200
|
+
* @returns {boolean}
|
|
201
|
+
*/
|
|
171
202
|
function isContinuationFrame (opcode) {
|
|
172
203
|
return opcode === opcodes.CONTINUATION
|
|
173
204
|
}
|
|
174
205
|
|
|
206
|
+
/**
|
|
207
|
+
* @param {number} opcode
|
|
208
|
+
* @returns {boolean}
|
|
209
|
+
*/
|
|
175
210
|
function isTextBinaryFrame (opcode) {
|
|
176
211
|
return opcode === opcodes.TEXT || opcode === opcodes.BINARY
|
|
177
212
|
}
|
|
178
213
|
|
|
214
|
+
/**
|
|
215
|
+
*
|
|
216
|
+
* @param {number} opcode
|
|
217
|
+
* @returns {boolean}
|
|
218
|
+
*/
|
|
179
219
|
function isValidOpcode (opcode) {
|
|
180
220
|
return isTextBinaryFrame(opcode) || isContinuationFrame(opcode) || isControlFrame(opcode)
|
|
181
221
|
}
|
|
@@ -209,6 +249,7 @@ function parseExtensions (extensions) {
|
|
|
209
249
|
* @see https://www.rfc-editor.org/rfc/rfc7692#section-7.1.2.2
|
|
210
250
|
* @description "client-max-window-bits = 1*DIGIT"
|
|
211
251
|
* @param {string} value
|
|
252
|
+
* @returns {boolean}
|
|
212
253
|
*/
|
|
213
254
|
function isValidClientWindowBits (value) {
|
|
214
255
|
for (let i = 0; i < value.length; i++) {
|
|
@@ -222,22 +263,84 @@ function isValidClientWindowBits (value) {
|
|
|
222
263
|
return true
|
|
223
264
|
}
|
|
224
265
|
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
266
|
+
/**
|
|
267
|
+
* @see https://whatpr.org/websockets/48/7b748d3...d5570f3.html#get-a-url-record
|
|
268
|
+
* @param {string} url
|
|
269
|
+
* @param {string} [baseURL]
|
|
270
|
+
*/
|
|
271
|
+
function getURLRecord (url, baseURL) {
|
|
272
|
+
// 1. Let urlRecord be the result of applying the URL parser to url with baseURL .
|
|
273
|
+
// 2. If urlRecord is failure, then throw a " SyntaxError " DOMException .
|
|
274
|
+
let urlRecord
|
|
275
|
+
|
|
276
|
+
try {
|
|
277
|
+
urlRecord = new URL(url, baseURL)
|
|
278
|
+
} catch (e) {
|
|
279
|
+
throw new DOMException(e, 'SyntaxError')
|
|
280
|
+
}
|
|
281
|
+
|
|
282
|
+
// 3. If urlRecord ’s scheme is " http ", then set urlRecord ’s scheme to " ws ".
|
|
283
|
+
// 4. Otherwise, if urlRecord ’s scheme is " https ", set urlRecord ’s scheme to " wss ".
|
|
284
|
+
if (urlRecord.protocol === 'http:') {
|
|
285
|
+
urlRecord.protocol = 'ws:'
|
|
286
|
+
} else if (urlRecord.protocol === 'https:') {
|
|
287
|
+
urlRecord.protocol = 'wss:'
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
// 5. If urlRecord ’s scheme is not " ws " or " wss ", then throw a " SyntaxError " DOMException .
|
|
291
|
+
if (urlRecord.protocol !== 'ws:' && urlRecord.protocol !== 'wss:') {
|
|
292
|
+
throw new DOMException('expected a ws: or wss: url', 'SyntaxError')
|
|
293
|
+
}
|
|
294
|
+
|
|
295
|
+
// If urlRecord ’s fragment is non-null, then throw a " SyntaxError " DOMException .
|
|
296
|
+
if (urlRecord.hash.length || urlRecord.href.endsWith('#')) {
|
|
297
|
+
throw new DOMException('hash', 'SyntaxError')
|
|
298
|
+
}
|
|
299
|
+
|
|
300
|
+
// Return urlRecord .
|
|
301
|
+
return urlRecord
|
|
302
|
+
}
|
|
303
|
+
|
|
304
|
+
// https://whatpr.org/websockets/48.html#validate-close-code-and-reason
|
|
305
|
+
function validateCloseCodeAndReason (code, reason) {
|
|
306
|
+
// 1. If code is not null, but is neither an integer equal to
|
|
307
|
+
// 1000 nor an integer in the range 3000 to 4999, inclusive,
|
|
308
|
+
// throw an "InvalidAccessError" DOMException.
|
|
309
|
+
if (code !== null) {
|
|
310
|
+
if (code !== 1000 && (code < 3000 || code > 4999)) {
|
|
311
|
+
throw new DOMException('invalid code', 'InvalidAccessError')
|
|
312
|
+
}
|
|
313
|
+
}
|
|
314
|
+
|
|
315
|
+
// 2. If reason is not null, then:
|
|
316
|
+
if (reason !== null) {
|
|
317
|
+
// 2.1. Let reasonBytes be the result of UTF-8 encoding reason.
|
|
318
|
+
// 2.2. If reasonBytes is longer than 123 bytes, then throw a
|
|
319
|
+
// "SyntaxError" DOMException.
|
|
320
|
+
const reasonBytesLength = Buffer.byteLength(reason)
|
|
321
|
+
|
|
322
|
+
if (reasonBytesLength > 123) {
|
|
323
|
+
throw new DOMException(`Reason must be less than 123 bytes; received ${reasonBytesLength}`, 'SyntaxError')
|
|
324
|
+
}
|
|
325
|
+
}
|
|
326
|
+
}
|
|
228
327
|
|
|
229
328
|
/**
|
|
230
329
|
* Converts a Buffer to utf-8, even on platforms without icu.
|
|
231
|
-
* @
|
|
330
|
+
* @type {(buffer: Buffer) => string}
|
|
232
331
|
*/
|
|
233
|
-
const utf8Decode =
|
|
234
|
-
|
|
235
|
-
|
|
332
|
+
const utf8Decode = (() => {
|
|
333
|
+
if (typeof process.versions.icu === 'string') {
|
|
334
|
+
const fatalDecoder = new TextDecoder('utf-8', { fatal: true })
|
|
335
|
+
return fatalDecoder.decode.bind(fatalDecoder)
|
|
336
|
+
}
|
|
337
|
+
return function (buffer) {
|
|
236
338
|
if (isUtf8(buffer)) {
|
|
237
339
|
return buffer.toString('utf-8')
|
|
238
340
|
}
|
|
239
341
|
throw new TypeError('Invalid utf-8 received.')
|
|
240
342
|
}
|
|
343
|
+
})()
|
|
241
344
|
|
|
242
345
|
module.exports = {
|
|
243
346
|
isConnecting,
|
|
@@ -256,5 +359,7 @@ module.exports = {
|
|
|
256
359
|
isValidOpcode,
|
|
257
360
|
parseExtensions,
|
|
258
361
|
isValidClientWindowBits,
|
|
259
|
-
toArrayBuffer
|
|
362
|
+
toArrayBuffer,
|
|
363
|
+
getURLRecord,
|
|
364
|
+
validateCloseCodeAndReason
|
|
260
365
|
}
|