msw 2.12.5 → 2.12.6

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 (62) hide show
  1. package/lib/browser/index.js +6 -0
  2. package/lib/browser/index.js.map +1 -1
  3. package/lib/browser/index.mjs +6 -0
  4. package/lib/browser/index.mjs.map +1 -1
  5. package/lib/core/{HttpResponse-U6SfxBlj.d.mts → HttpResponse-C86fdZzb.d.mts} +6 -0
  6. package/lib/core/{HttpResponse-DC89RDb7.d.ts → HttpResponse-DM21DMt_.d.ts} +6 -0
  7. package/lib/core/HttpResponse.d.mts +1 -1
  8. package/lib/core/HttpResponse.d.ts +1 -1
  9. package/lib/core/SetupApi.d.mts +1 -1
  10. package/lib/core/SetupApi.d.ts +1 -1
  11. package/lib/core/getResponse.d.mts +1 -1
  12. package/lib/core/getResponse.d.ts +1 -1
  13. package/lib/core/graphql.d.mts +1 -1
  14. package/lib/core/graphql.d.ts +1 -1
  15. package/lib/core/handlers/GraphQLHandler.d.mts +1 -1
  16. package/lib/core/handlers/GraphQLHandler.d.ts +1 -1
  17. package/lib/core/handlers/HttpHandler.d.mts +1 -1
  18. package/lib/core/handlers/HttpHandler.d.ts +1 -1
  19. package/lib/core/handlers/RequestHandler.d.mts +1 -1
  20. package/lib/core/handlers/RequestHandler.d.ts +1 -1
  21. package/lib/core/http.d.mts +1 -1
  22. package/lib/core/http.d.ts +1 -1
  23. package/lib/core/index.d.mts +1 -1
  24. package/lib/core/index.d.ts +1 -1
  25. package/lib/core/passthrough.d.mts +1 -1
  26. package/lib/core/passthrough.d.ts +1 -1
  27. package/lib/core/sse.d.mts +1 -1
  28. package/lib/core/sse.d.ts +1 -1
  29. package/lib/core/sse.js +25 -21
  30. package/lib/core/sse.js.map +1 -1
  31. package/lib/core/sse.mjs +25 -21
  32. package/lib/core/sse.mjs.map +1 -1
  33. package/lib/core/utils/HttpResponse/decorators.d.mts +1 -1
  34. package/lib/core/utils/HttpResponse/decorators.d.ts +1 -1
  35. package/lib/core/utils/executeHandlers.d.mts +1 -1
  36. package/lib/core/utils/executeHandlers.d.ts +1 -1
  37. package/lib/core/utils/executeHandlers.js.map +1 -1
  38. package/lib/core/utils/executeHandlers.mjs.map +1 -1
  39. package/lib/core/utils/handleRequest.d.mts +2 -9
  40. package/lib/core/utils/handleRequest.d.ts +2 -9
  41. package/lib/core/utils/handleRequest.js.map +1 -1
  42. package/lib/core/utils/handleRequest.mjs +3 -1
  43. package/lib/core/utils/handleRequest.mjs.map +1 -1
  44. package/lib/core/utils/internal/isHandlerKind.d.mts +1 -1
  45. package/lib/core/utils/internal/isHandlerKind.d.ts +1 -1
  46. package/lib/core/utils/internal/parseGraphQLRequest.d.mts +1 -1
  47. package/lib/core/utils/internal/parseGraphQLRequest.d.ts +1 -1
  48. package/lib/core/utils/internal/parseMultipartData.d.mts +1 -1
  49. package/lib/core/utils/internal/parseMultipartData.d.ts +1 -1
  50. package/lib/core/utils/internal/requestHandlerUtils.d.mts +1 -1
  51. package/lib/core/utils/internal/requestHandlerUtils.d.ts +1 -1
  52. package/lib/core/ws/handleWebSocketEvent.d.mts +1 -1
  53. package/lib/core/ws/handleWebSocketEvent.d.ts +1 -1
  54. package/lib/iife/index.js +31 -21
  55. package/lib/iife/index.js.map +1 -1
  56. package/lib/mockServiceWorker.js +1 -1
  57. package/package.json +2 -2
  58. package/src/browser/setupWorker/start/createFallbackRequestListener.ts +3 -0
  59. package/src/browser/setupWorker/start/createRequestListener.ts +3 -0
  60. package/src/core/sse.ts +38 -29
  61. package/src/core/utils/executeHandlers.ts +6 -0
  62. package/src/core/utils/handleRequest.ts +6 -9
@@ -7,7 +7,7 @@
7
7
  * - Please do NOT modify this file.
8
8
  */
9
9
 
10
- const PACKAGE_VERSION = '2.12.5'
10
+ const PACKAGE_VERSION = '2.12.6'
11
11
  const INTEGRITY_CHECKSUM = '4db4a41e972cec1b64cc569c66952d82'
12
12
  const IS_MOCKED_RESPONSE = Symbol('isMockedResponse')
13
13
  const activeClientIds = new Set()
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "msw",
3
- "version": "2.12.5",
3
+ "version": "2.12.6",
4
4
  "description": "Seamless REST/GraphQL API mocking library for browser and Node.js.",
5
5
  "type": "commonjs",
6
6
  "main": "./lib/core/index.js",
@@ -285,7 +285,7 @@
285
285
  "vitest-environment-miniflare": "^2.14.4",
286
286
  "webpack": "^5.95.0",
287
287
  "webpack-http-server": "^0.5.0",
288
- "msw": "2.12.5"
288
+ "msw": "2.12.6"
289
289
  },
290
290
  "peerDependencies": {
291
291
  "typescript": ">= 4.8.x"
@@ -29,6 +29,9 @@ export function createFallbackRequestListener(
29
29
  options,
30
30
  context.emitter,
31
31
  {
32
+ resolutionContext: {
33
+ quiet: options.quiet,
34
+ },
32
35
  onMockedResponse(_, { handler, parsedResult }) {
33
36
  if (!options.quiet) {
34
37
  context.emitter.once('response:mocked', ({ response }) => {
@@ -46,6 +46,9 @@ export const createRequestListener = (
46
46
  options,
47
47
  context.emitter,
48
48
  {
49
+ resolutionContext: {
50
+ quiet: options.quiet,
51
+ },
49
52
  onPassthroughResponse() {
50
53
  event.postMessage('PASSTHROUGH')
51
54
  },
package/src/core/sse.ts CHANGED
@@ -6,6 +6,7 @@ import {
6
6
  type HttpRequestResolverExtras,
7
7
  type HttpRequestParsedResult,
8
8
  } from './handlers/HttpHandler'
9
+ import type { ResponseResolutionContext } from '~/core/utils/executeHandlers'
9
10
  import type { Path, PathParams } from './utils/matching/matchRequestUrl'
10
11
  import { delay } from './delay'
11
12
  import { getTimestamp } from './utils/logging/getTimestamp'
@@ -67,9 +68,19 @@ export const sse: ServerSentEventRequestHandler = (path, resolver) => {
67
68
  return new ServerSentEventHandler(path, resolver)
68
69
  }
69
70
 
71
+ const SSE_RESPONSE_INIT: ResponseInit = {
72
+ headers: {
73
+ 'content-type': 'text/event-stream',
74
+ 'cache-control': 'no-cache',
75
+ connection: 'keep-alive',
76
+ },
77
+ }
78
+
70
79
  class ServerSentEventHandler<
71
80
  EventMap extends EventMapConstraint,
72
81
  > extends HttpHandler {
82
+ #emitter: Emitter<ServerSentEventClientEventMap>
83
+
73
84
  constructor(path: Path, resolver: ServerSentEventResolver<EventMap, any>) {
74
85
  invariant(
75
86
  typeof EventSource !== 'undefined',
@@ -77,37 +88,12 @@ class ServerSentEventHandler<
77
88
  path,
78
89
  )
79
90
 
80
- const clientEmitter = new Emitter<ServerSentEventClientEventMap>()
81
-
82
91
  super('GET', path, async (info) => {
83
- const responseInit: ResponseInit = {
84
- headers: {
85
- 'content-type': 'text/event-stream',
86
- 'cache-control': 'no-cache',
87
- connection: 'keep-alive',
88
- },
89
- }
90
-
91
- /**
92
- * @note Log the intercepted request early.
93
- * Normally, the `this.log()` method is called when the handler returns a response.
94
- * For SSE, call that method earlier so the logs are in correct order.
95
- */
96
- await super.log({
97
- request: info.request,
98
- /**
99
- * @note Construct a placeholder response since SSE response
100
- * is being streamed and cannot be cloned/consumed for logging.
101
- */
102
- response: new Response('[streaming]', responseInit),
103
- })
104
- this.#attachClientLogger(info.request, clientEmitter)
105
-
106
92
  const stream = new ReadableStream({
107
- async start(controller) {
93
+ start: async (controller) => {
108
94
  const client = new ServerSentEventClient<EventMap>({
109
95
  controller,
110
- emitter: clientEmitter,
96
+ emitter: this.#emitter,
111
97
  })
112
98
  const server = new ServerSentEventServer({
113
99
  request: info.request,
@@ -122,19 +108,42 @@ class ServerSentEventHandler<
122
108
  },
123
109
  })
124
110
 
125
- return new Response(stream, responseInit)
111
+ return new Response(stream, SSE_RESPONSE_INIT)
126
112
  })
113
+
114
+ this.#emitter = new Emitter<ServerSentEventClientEventMap>()
127
115
  }
128
116
 
129
117
  async predicate(args: {
130
118
  request: Request
131
119
  parsedResult: HttpRequestParsedResult
120
+ resolutionContext?: ResponseResolutionContext
132
121
  }) {
133
122
  if (args.request.headers.get('accept') !== 'text/event-stream') {
134
123
  return false
135
124
  }
136
125
 
137
- return super.predicate(args)
126
+ const matches = await super.predicate(args)
127
+
128
+ if (matches && !args.resolutionContext?.quiet) {
129
+ /**
130
+ * @note Log the intercepted request early.
131
+ * Normally, the `this.log()` method is called when the handler returns a response.
132
+ * For SSE, call that method earlier so the logs are in correct order.
133
+ */
134
+ await super.log({
135
+ request: args.request,
136
+ /**
137
+ * @note Construct a placeholder response since SSE response
138
+ * is being streamed and cannot be cloned/consumed for logging.
139
+ */
140
+ response: new Response('[streaming]', SSE_RESPONSE_INIT),
141
+ })
142
+
143
+ this.#attachClientLogger(args.request, this.#emitter)
144
+ }
145
+
146
+ return matches
138
147
  }
139
148
 
140
149
  async log(_args: { request: Request; response: Response }): Promise<void> {
@@ -10,7 +10,13 @@ export interface HandlersExecutionResult {
10
10
  }
11
11
 
12
12
  export interface ResponseResolutionContext {
13
+ /**
14
+ * A base url to use when resolving relative urls.
15
+ * @note This is primarily used by the `@mswjs/http-middleware`
16
+ * to resolve relative urls in the context of the running server
17
+ */
13
18
  baseUrl?: string
19
+ quiet?: boolean
14
20
  }
15
21
 
16
22
  /**
@@ -3,7 +3,11 @@ import { Emitter } from 'strict-event-emitter'
3
3
  import { LifeCycleEventsMap, SharedOptions } from '../sharedOptions'
4
4
  import { RequiredDeep } from '../typeUtils'
5
5
  import type { RequestHandler } from '../handlers/RequestHandler'
6
- import { HandlersExecutionResult, executeHandlers } from './executeHandlers'
6
+ import {
7
+ type HandlersExecutionResult,
8
+ type ResponseResolutionContext,
9
+ executeHandlers,
10
+ } from './executeHandlers'
7
11
  import { onUnhandledRequest } from './request/onUnhandledRequest'
8
12
  import { storeResponseCookies } from './request/storeResponseCookies'
9
13
 
@@ -13,14 +17,7 @@ export interface HandleRequestOptions {
13
17
  * but is exposed to aid in creating extensions like
14
18
  * `@mswjs/http-middleware`.
15
19
  */
16
- resolutionContext?: {
17
- /**
18
- * A base url to use when resolving relative urls.
19
- * @note This is primarily used by the `@mswjs/http-middleware`
20
- * to resolve relative urls in the context of the running server
21
- */
22
- baseUrl?: string
23
- }
20
+ resolutionContext?: ResponseResolutionContext
24
21
 
25
22
  /**
26
23
  * Invoked whenever a request is performed as-is.