msw 2.3.0-ws.rc-6 → 2.3.1
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 +3 -9
- package/cli/init.js +0 -0
- package/config/scripts/postinstall.js +0 -0
- package/lib/browser/index.d.mts +6 -7
- package/lib/browser/index.d.ts +6 -7
- package/lib/browser/index.js +156 -83
- package/lib/browser/index.js.map +1 -1
- package/lib/browser/index.mjs +156 -83
- package/lib/browser/index.mjs.map +1 -1
- package/lib/core/{GraphQLHandler-DGyzNtRQ.d.ts → GraphQLHandler-COiPfZ8k.d.ts} +1 -1
- package/lib/core/{GraphQLHandler-CzcXr7At.d.mts → GraphQLHandler-Dq_WRbKe.d.mts} +1 -1
- package/lib/core/{HttpResponse-BOzDwzB6.d.ts → HttpResponse-B07UKAkU.d.ts} +2 -2
- package/lib/core/{HttpResponse-CSyJ1cbO.d.mts → HttpResponse-C7niBMwb.d.mts} +2 -2
- package/lib/core/HttpResponse.d.mts +1 -1
- package/lib/core/HttpResponse.d.ts +1 -1
- package/lib/core/SetupApi.d.mts +12 -15
- package/lib/core/SetupApi.d.ts +12 -15
- package/lib/core/SetupApi.js +1 -3
- package/lib/core/SetupApi.js.map +1 -1
- package/lib/core/SetupApi.mjs +1 -3
- package/lib/core/SetupApi.mjs.map +1 -1
- package/lib/core/getResponse.d.mts +1 -1
- package/lib/core/getResponse.d.ts +1 -1
- package/lib/core/graphql.d.mts +2 -2
- package/lib/core/graphql.d.ts +2 -2
- package/lib/core/handlers/GraphQLHandler.d.mts +2 -2
- package/lib/core/handlers/GraphQLHandler.d.ts +2 -2
- package/lib/core/handlers/HttpHandler.d.mts +1 -1
- package/lib/core/handlers/HttpHandler.d.ts +1 -1
- package/lib/core/handlers/RequestHandler.d.mts +1 -1
- package/lib/core/handlers/RequestHandler.d.ts +1 -1
- package/lib/core/http.d.mts +1 -1
- package/lib/core/http.d.ts +1 -1
- package/lib/core/index.d.mts +2 -5
- package/lib/core/index.d.ts +2 -5
- package/lib/core/index.js +1 -5
- package/lib/core/index.js.map +1 -1
- package/lib/core/index.mjs +1 -7
- package/lib/core/index.mjs.map +1 -1
- package/lib/core/passthrough.d.mts +1 -1
- package/lib/core/passthrough.d.ts +1 -1
- package/lib/core/utils/HttpResponse/decorators.d.mts +1 -1
- package/lib/core/utils/HttpResponse/decorators.d.ts +1 -1
- package/lib/core/utils/executeHandlers.d.mts +1 -1
- package/lib/core/utils/executeHandlers.d.ts +1 -1
- package/lib/core/utils/executeHandlers.js +0 -4
- package/lib/core/utils/executeHandlers.js.map +1 -1
- package/lib/core/utils/executeHandlers.mjs +0 -6
- package/lib/core/utils/executeHandlers.mjs.map +1 -1
- package/lib/core/utils/handleRequest.d.mts +2 -2
- package/lib/core/utils/handleRequest.d.ts +2 -2
- package/lib/core/utils/handleRequest.js.map +1 -1
- package/lib/core/utils/handleRequest.mjs.map +1 -1
- package/lib/core/utils/internal/Disposable.d.mts +2 -2
- package/lib/core/utils/internal/Disposable.d.ts +2 -2
- package/lib/core/utils/internal/Disposable.js +5 -2
- package/lib/core/utils/internal/Disposable.js.map +1 -1
- package/lib/core/utils/internal/Disposable.mjs +5 -2
- package/lib/core/utils/internal/Disposable.mjs.map +1 -1
- package/lib/core/utils/internal/devUtils.d.mts +10 -1
- package/lib/core/utils/internal/devUtils.d.ts +10 -1
- package/lib/core/utils/internal/devUtils.js +7 -0
- package/lib/core/utils/internal/devUtils.js.map +1 -1
- package/lib/core/utils/internal/devUtils.mjs +7 -0
- package/lib/core/utils/internal/devUtils.mjs.map +1 -1
- package/lib/core/utils/internal/parseGraphQLRequest.d.mts +2 -2
- package/lib/core/utils/internal/parseGraphQLRequest.d.ts +2 -2
- package/lib/core/utils/internal/parseMultipartData.d.mts +1 -1
- package/lib/core/utils/internal/parseMultipartData.d.ts +1 -1
- package/lib/core/utils/internal/requestHandlerUtils.d.mts +1 -1
- package/lib/core/utils/internal/requestHandlerUtils.d.ts +1 -1
- package/lib/core/utils/logging/getTimestamp.d.mts +1 -4
- package/lib/core/utils/logging/getTimestamp.d.ts +1 -4
- package/lib/core/utils/logging/getTimestamp.js +2 -6
- package/lib/core/utils/logging/getTimestamp.js.map +1 -1
- package/lib/core/utils/logging/getTimestamp.mjs +2 -6
- package/lib/core/utils/logging/getTimestamp.mjs.map +1 -1
- package/lib/core/utils/matching/matchRequestUrl.d.mts +1 -2
- package/lib/core/utils/matching/matchRequestUrl.d.ts +1 -2
- package/lib/core/utils/matching/matchRequestUrl.js +0 -4
- package/lib/core/utils/matching/matchRequestUrl.js.map +1 -1
- package/lib/core/utils/matching/matchRequestUrl.mjs +0 -4
- package/lib/core/utils/matching/matchRequestUrl.mjs.map +1 -1
- package/lib/core/utils/matching/normalizePath.d.mts +1 -0
- package/lib/core/utils/matching/normalizePath.d.ts +1 -0
- package/lib/core/utils/matching/normalizePath.js.map +1 -1
- package/lib/core/utils/matching/normalizePath.mjs.map +1 -1
- package/lib/core/utils/request/onUnhandledRequest.js +3 -3
- package/lib/core/utils/request/onUnhandledRequest.js.map +1 -1
- package/lib/core/utils/request/onUnhandledRequest.mjs +4 -4
- package/lib/core/utils/request/onUnhandledRequest.mjs.map +1 -1
- package/lib/core/utils/url/cleanUrl.d.mts +2 -1
- package/lib/core/utils/url/cleanUrl.d.ts +2 -1
- package/lib/core/utils/url/cleanUrl.js +3 -0
- package/lib/core/utils/url/cleanUrl.js.map +1 -1
- package/lib/core/utils/url/cleanUrl.mjs +3 -0
- package/lib/core/utils/url/cleanUrl.mjs.map +1 -1
- package/lib/iife/index.js +180 -1103
- package/lib/iife/index.js.map +1 -1
- package/lib/mockServiceWorker.js +1 -1
- package/lib/native/index.d.mts +5 -6
- package/lib/native/index.d.ts +5 -6
- package/lib/native/index.js +5 -13
- package/lib/native/index.js.map +1 -1
- package/lib/native/index.mjs +6 -14
- package/lib/native/index.mjs.map +1 -1
- package/lib/node/index.d.mts +7 -8
- package/lib/node/index.d.ts +7 -8
- package/lib/node/index.js +5 -13
- package/lib/node/index.js.map +1 -1
- package/lib/node/index.mjs +6 -14
- package/lib/node/index.mjs.map +1 -1
- package/package.json +36 -29
- package/src/browser/setupWorker/glossary.ts +10 -10
- package/src/browser/setupWorker/setupWorker.ts +3 -34
- package/src/browser/setupWorker/stop/createStop.ts +0 -4
- package/src/core/SetupApi.ts +20 -28
- package/src/core/index.ts +1 -8
- package/src/core/utils/executeHandlers.ts +2 -6
- package/src/core/utils/handleRequest.ts +2 -1
- package/src/core/utils/internal/Disposable.ts +6 -3
- package/src/core/utils/internal/devUtils.test.ts +21 -0
- package/src/core/utils/internal/devUtils.ts +13 -0
- package/src/core/utils/logging/getTimestamp.test.ts +6 -20
- package/src/core/utils/logging/getTimestamp.ts +6 -11
- package/src/core/utils/matching/matchRequestUrl.test.ts +8 -41
- package/src/core/utils/matching/matchRequestUrl.ts +0 -4
- package/src/core/utils/matching/normalizePath.test.ts +7 -1
- package/src/core/utils/matching/normalizePath.ts +1 -0
- package/src/core/utils/request/onUnhandledRequest.test.ts +30 -4
- package/src/core/utils/request/onUnhandledRequest.ts +4 -4
- package/src/core/utils/url/cleanUrl.test.ts +8 -3
- package/src/core/utils/url/cleanUrl.ts +9 -1
- package/src/core/utils/url/getAbsoluteUrl.node.test.ts +3 -3
- package/src/core/utils/url/getAbsoluteUrl.test.ts +5 -5
- package/src/core/utils/url/isAbsoluteUrl.test.ts +7 -7
- package/src/node/SetupServerApi.ts +7 -8
- package/src/node/SetupServerCommonApi.ts +8 -15
- package/src/node/glossary.ts +7 -5
- package/src/node/setupServer.ts +1 -2
- package/lib/core/handlers/WebSocketHandler.d.mts +0 -32
- package/lib/core/handlers/WebSocketHandler.d.ts +0 -32
- package/lib/core/handlers/WebSocketHandler.js +0 -62
- package/lib/core/handlers/WebSocketHandler.js.map +0 -1
- package/lib/core/handlers/WebSocketHandler.mjs +0 -44
- package/lib/core/handlers/WebSocketHandler.mjs.map +0 -1
- package/lib/core/ws/WebSocketClientManager.d.mts +0 -58
- package/lib/core/ws/WebSocketClientManager.d.ts +0 -58
- package/lib/core/ws/WebSocketClientManager.js +0 -162
- package/lib/core/ws/WebSocketClientManager.js.map +0 -1
- package/lib/core/ws/WebSocketClientManager.mjs +0 -142
- package/lib/core/ws/WebSocketClientManager.mjs.map +0 -1
- package/lib/core/ws/handleWebSocketEvent.d.mts +0 -16
- package/lib/core/ws/handleWebSocketEvent.d.ts +0 -16
- package/lib/core/ws/handleWebSocketEvent.js +0 -56
- package/lib/core/ws/handleWebSocketEvent.js.map +0 -1
- package/lib/core/ws/handleWebSocketEvent.mjs +0 -36
- package/lib/core/ws/handleWebSocketEvent.mjs.map +0 -1
- package/lib/core/ws/utils/attachWebSocketLogger.d.mts +0 -34
- package/lib/core/ws/utils/attachWebSocketLogger.d.ts +0 -34
- package/lib/core/ws/utils/attachWebSocketLogger.js +0 -217
- package/lib/core/ws/utils/attachWebSocketLogger.js.map +0 -1
- package/lib/core/ws/utils/attachWebSocketLogger.mjs +0 -197
- package/lib/core/ws/utils/attachWebSocketLogger.mjs.map +0 -1
- package/lib/core/ws/utils/getMessageLength.d.mts +0 -11
- package/lib/core/ws/utils/getMessageLength.d.ts +0 -11
- package/lib/core/ws/utils/getMessageLength.js +0 -33
- package/lib/core/ws/utils/getMessageLength.js.map +0 -1
- package/lib/core/ws/utils/getMessageLength.mjs +0 -13
- package/lib/core/ws/utils/getMessageLength.mjs.map +0 -1
- package/lib/core/ws/utils/getPublicData.d.mts +0 -5
- package/lib/core/ws/utils/getPublicData.d.ts +0 -5
- package/lib/core/ws/utils/getPublicData.js +0 -36
- package/lib/core/ws/utils/getPublicData.js.map +0 -1
- package/lib/core/ws/utils/getPublicData.mjs +0 -16
- package/lib/core/ws/utils/getPublicData.mjs.map +0 -1
- package/lib/core/ws/utils/truncateMessage.d.mts +0 -3
- package/lib/core/ws/utils/truncateMessage.d.ts +0 -3
- package/lib/core/ws/utils/truncateMessage.js +0 -31
- package/lib/core/ws/utils/truncateMessage.js.map +0 -1
- package/lib/core/ws/utils/truncateMessage.mjs +0 -11
- package/lib/core/ws/utils/truncateMessage.mjs.map +0 -1
- package/lib/core/ws/webSocketInterceptor.d.mts +0 -5
- package/lib/core/ws/webSocketInterceptor.d.ts +0 -5
- package/lib/core/ws/webSocketInterceptor.js +0 -26
- package/lib/core/ws/webSocketInterceptor.js.map +0 -1
- package/lib/core/ws/webSocketInterceptor.mjs +0 -6
- package/lib/core/ws/webSocketInterceptor.mjs.map +0 -1
- package/lib/core/ws.d.mts +0 -49
- package/lib/core/ws.d.ts +0 -49
- package/lib/core/ws.js +0 -65
- package/lib/core/ws.js.map +0 -1
- package/lib/core/ws.mjs +0 -48
- package/lib/core/ws.mjs.map +0 -1
- package/src/core/handlers/WebSocketHandler.ts +0 -71
- package/src/core/ws/WebSocketClientManager.test.ts +0 -157
- package/src/core/ws/WebSocketClientManager.ts +0 -234
- package/src/core/ws/handleWebSocketEvent.ts +0 -56
- package/src/core/ws/utils/attachWebSocketLogger.ts +0 -269
- package/src/core/ws/utils/getMessageLength.test.ts +0 -16
- package/src/core/ws/utils/getMessageLength.ts +0 -19
- package/src/core/ws/utils/getPublicData.test.ts +0 -38
- package/src/core/ws/utils/getPublicData.ts +0 -17
- package/src/core/ws/utils/truncateMessage.test.ts +0 -12
- package/src/core/ws/utils/truncateMessage.ts +0 -9
- package/src/core/ws/webSocketInterceptor.ts +0 -3
- package/src/core/ws.test.ts +0 -23
- package/src/core/ws.ts +0 -124
package/src/core/ws.test.ts
DELETED
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @vitest-environment node-websocket
|
|
3
|
-
*/
|
|
4
|
-
import { ws } from './ws'
|
|
5
|
-
|
|
6
|
-
it('exports the "link()" method', () => {
|
|
7
|
-
expect(ws).toHaveProperty('link')
|
|
8
|
-
expect(ws.link).toBeInstanceOf(Function)
|
|
9
|
-
})
|
|
10
|
-
|
|
11
|
-
it('throws an error when calling "ws.link()" without a URL argument', () => {
|
|
12
|
-
expect(() =>
|
|
13
|
-
// @ts-expect-error Intentionally invalid call.
|
|
14
|
-
ws.link(),
|
|
15
|
-
).toThrow('Expected a WebSocket server URL but got undefined')
|
|
16
|
-
})
|
|
17
|
-
|
|
18
|
-
it('throws an error when given a non-path argument to "ws.link()"', () => {
|
|
19
|
-
expect(() =>
|
|
20
|
-
// @ts-expect-error Intentionally invalid argument.
|
|
21
|
-
ws.link(2),
|
|
22
|
-
).toThrow('Expected a WebSocket server URL to be a valid path but got number')
|
|
23
|
-
})
|
package/src/core/ws.ts
DELETED
|
@@ -1,124 +0,0 @@
|
|
|
1
|
-
import { invariant } from 'outvariant'
|
|
2
|
-
import type {
|
|
3
|
-
WebSocketClientConnectionProtocol,
|
|
4
|
-
WebSocketData,
|
|
5
|
-
} from '@mswjs/interceptors/WebSocket'
|
|
6
|
-
import {
|
|
7
|
-
WebSocketHandler,
|
|
8
|
-
kEmitter,
|
|
9
|
-
type WebSocketHandlerEventMap,
|
|
10
|
-
} from './handlers/WebSocketHandler'
|
|
11
|
-
import { Path, isPath } from './utils/matching/matchRequestUrl'
|
|
12
|
-
import { WebSocketClientManager } from './ws/WebSocketClientManager'
|
|
13
|
-
|
|
14
|
-
const wsBroadcastChannel = new BroadcastChannel('msw:ws-client-manager')
|
|
15
|
-
|
|
16
|
-
export type WebSocketLink = {
|
|
17
|
-
/**
|
|
18
|
-
* A set of all WebSocket clients connected
|
|
19
|
-
* to this link.
|
|
20
|
-
*/
|
|
21
|
-
clients: Set<WebSocketClientConnectionProtocol>
|
|
22
|
-
|
|
23
|
-
on<EventType extends keyof WebSocketHandlerEventMap>(
|
|
24
|
-
event: EventType,
|
|
25
|
-
listener: (...args: WebSocketHandlerEventMap[EventType]) => void,
|
|
26
|
-
): WebSocketHandler
|
|
27
|
-
|
|
28
|
-
/**
|
|
29
|
-
* Broadcasts the given data to all WebSocket clients.
|
|
30
|
-
*
|
|
31
|
-
* @example
|
|
32
|
-
* const service = ws.link('wss://example.com')
|
|
33
|
-
* service.on('connection', () => {
|
|
34
|
-
* service.broadcast('hello, everyone!')
|
|
35
|
-
* })
|
|
36
|
-
*/
|
|
37
|
-
broadcast(data: WebSocketData): void
|
|
38
|
-
|
|
39
|
-
/**
|
|
40
|
-
* Broadcasts the given data to all WebSocket clients
|
|
41
|
-
* except the ones provided in the `clients` argument.
|
|
42
|
-
*
|
|
43
|
-
* @example
|
|
44
|
-
* const service = ws.link('wss://example.com')
|
|
45
|
-
* service.on('connection', ({ client }) => {
|
|
46
|
-
* service.broadcastExcept(client, 'hi, the rest of you!')
|
|
47
|
-
* })
|
|
48
|
-
*/
|
|
49
|
-
broadcastExcept(
|
|
50
|
-
clients:
|
|
51
|
-
| WebSocketClientConnectionProtocol
|
|
52
|
-
| Array<WebSocketClientConnectionProtocol>,
|
|
53
|
-
data: WebSocketData,
|
|
54
|
-
): void
|
|
55
|
-
}
|
|
56
|
-
|
|
57
|
-
/**
|
|
58
|
-
* Intercepts outgoing WebSocket connections to the given URL.
|
|
59
|
-
*
|
|
60
|
-
* @example
|
|
61
|
-
* const chat = ws.link('wss://chat.example.com')
|
|
62
|
-
* chat.on('connection', ({ client }) => {
|
|
63
|
-
* client.send('hello from server!')
|
|
64
|
-
* })
|
|
65
|
-
*/
|
|
66
|
-
function createWebSocketLinkHandler(url: Path): WebSocketLink {
|
|
67
|
-
invariant(url, 'Expected a WebSocket server URL but got undefined')
|
|
68
|
-
|
|
69
|
-
invariant(
|
|
70
|
-
isPath(url),
|
|
71
|
-
'Expected a WebSocket server URL to be a valid path but got %s',
|
|
72
|
-
typeof url,
|
|
73
|
-
)
|
|
74
|
-
|
|
75
|
-
const clientManager = new WebSocketClientManager(wsBroadcastChannel, url)
|
|
76
|
-
|
|
77
|
-
return {
|
|
78
|
-
get clients() {
|
|
79
|
-
return clientManager.clients
|
|
80
|
-
},
|
|
81
|
-
on(event, listener) {
|
|
82
|
-
const handler = new WebSocketHandler(url)
|
|
83
|
-
|
|
84
|
-
// Add the connection event listener for when the
|
|
85
|
-
// handler matches and emits a connection event.
|
|
86
|
-
// When that happens, store that connection in the
|
|
87
|
-
// set of all connections for reference.
|
|
88
|
-
handler[kEmitter].on('connection', ({ client }) => {
|
|
89
|
-
clientManager.addConnection(client)
|
|
90
|
-
})
|
|
91
|
-
|
|
92
|
-
// The "handleWebSocketEvent" function will invoke
|
|
93
|
-
// the "run()" method on the WebSocketHandler.
|
|
94
|
-
// If the handler matches, it will emit the "connection"
|
|
95
|
-
// event. Attach the user-defined listener to that event.
|
|
96
|
-
handler[kEmitter].on(event, listener)
|
|
97
|
-
|
|
98
|
-
return handler
|
|
99
|
-
},
|
|
100
|
-
|
|
101
|
-
broadcast(data) {
|
|
102
|
-
// This will invoke "send()" on the immediate clients
|
|
103
|
-
// in this runtime and post a message to the broadcast channel
|
|
104
|
-
// to trigger send for the clients in other runtimes.
|
|
105
|
-
this.broadcastExcept([], data)
|
|
106
|
-
},
|
|
107
|
-
|
|
108
|
-
broadcastExcept(clients, data) {
|
|
109
|
-
const ignoreClients = Array.prototype
|
|
110
|
-
.concat(clients)
|
|
111
|
-
.map((client) => client.id)
|
|
112
|
-
|
|
113
|
-
clientManager.clients.forEach((otherClient) => {
|
|
114
|
-
if (!ignoreClients.includes(otherClient.id)) {
|
|
115
|
-
otherClient.send(data)
|
|
116
|
-
}
|
|
117
|
-
})
|
|
118
|
-
},
|
|
119
|
-
}
|
|
120
|
-
}
|
|
121
|
-
|
|
122
|
-
export const ws = {
|
|
123
|
-
link: createWebSocketLinkHandler,
|
|
124
|
-
}
|