msw 2.5.2 → 2.6.1

package/src/node/SetupServerApi.ts

@@ -4,14 +4,15 @@ import { XMLHttpRequestInterceptor } from '@mswjs/interceptors/XMLHttpRequest'
 import { FetchInterceptor } from '@mswjs/interceptors/fetch'
 import { HandlersController } from '~/core/SetupApi'
 import type { RequestHandler } from '~/core/handlers/RequestHandler'
+import type { WebSocketHandler } from '~/core/handlers/WebSocketHandler'
 import type { SetupServer } from './glossary'
 import { SetupServerCommonApi } from './SetupServerCommonApi'
 
 const store = new AsyncLocalStorage<RequestHandlersContext>()
 
 type RequestHandlersContext = {
-  initialHandlers: Array<RequestHandler>
-  handlers: Array<RequestHandler>
+  initialHandlers: Array<RequestHandler | WebSocketHandler>
+  handlers: Array<RequestHandler | WebSocketHandler>
 }
 
 /**
@@ -22,7 +23,7 @@ type RequestHandlersContext = {
 class AsyncHandlersController implements HandlersController {
   private rootContext: RequestHandlersContext
 
-  constructor(initialHandlers: Array<RequestHandler>) {
+  constructor(initialHandlers: Array<RequestHandler | WebSocketHandler>) {
     this.rootContext = { initialHandlers, handlers: [] }
   }
 
@@ -30,18 +31,18 @@ class AsyncHandlersController implements HandlersController {
     return store.getStore() || this.rootContext
   }
 
-  public prepend(runtimeHandlers: Array<RequestHandler>) {
+  public prepend(runtimeHandlers: Array<RequestHandler | WebSocketHandler>) {
     this.context.handlers.unshift(...runtimeHandlers)
   }
 
-  public reset(nextHandlers: Array<RequestHandler>) {
+  public reset(nextHandlers: Array<RequestHandler | WebSocketHandler>) {
     const context = this.context
     context.handlers = []
     context.initialHandlers =
       nextHandlers.length > 0 ? nextHandlers : context.initialHandlers
   }
 
-  public currentHandlers(): Array<RequestHandler> {
+  public currentHandlers(): Array<RequestHandler | WebSocketHandler> {
     const { initialHandlers, handlers } = this.context
     return handlers.concat(initialHandlers)
   }
@@ -51,7 +52,7 @@ export class SetupServerApi
   extends SetupServerCommonApi
   implements SetupServer
 {
-  constructor(handlers: Array<RequestHandler>) {
+  constructor(handlers: Array<RequestHandler | WebSocketHandler>) {
     super(
       [ClientRequestInterceptor, XMLHttpRequestInterceptor, FetchInterceptor],
       handlers,

package/src/node/SetupServerCommonApi.ts

@@ -14,9 +14,13 @@ import type { LifeCycleEventsMap, SharedOptions } from '~/core/sharedOptions'
 import { SetupApi } from '~/core/SetupApi'
 import { handleRequest } from '~/core/utils/handleRequest'
 import type { RequestHandler } from '~/core/handlers/RequestHandler'
+import type { WebSocketHandler } from '~/core/handlers/WebSocketHandler'
 import { mergeRight } from '~/core/utils/internal/mergeRight'
 import { InternalError, devUtils } from '~/core/utils/internal/devUtils'
 import type { SetupServerCommon } from './glossary'
+import { handleWebSocketEvent } from '~/core/ws/handleWebSocketEvent'
+import { webSocketInterceptor } from '~/core/ws/webSocketInterceptor'
+import { isHandlerKind } from '~/core/utils/internal/isHandlerKind'
 
 export const DEFAULT_LISTEN_OPTIONS: RequiredDeep<SharedOptions> = {
   onUnhandledRequest: 'warn',
@@ -34,7 +38,7 @@ export class SetupServerCommonApi
 
   constructor(
     interceptors: Array<{ new (): Interceptor<HttpRequestEventMap> }>,
-    handlers: Array<RequestHandler>,
+    handlers: Array<RequestHandler | WebSocketHandler>,
   ) {
     super(...handlers)
 
@@ -58,7 +62,9 @@ export class SetupServerCommonApi
         const response = await handleRequest(
           request,
           requestId,
-          this.handlersController.currentHandlers(),
+          this.handlersController
+            .currentHandlers()
+            .filter(isHandlerKind('RequestHandler')),
           this.resolvedOptions,
           this.emitter,
         )
@@ -90,6 +96,19 @@ export class SetupServerCommonApi
         )
       },
     )
+
+    // Preconfigure the WebSocket interception but don't enable it just yet.
+    // It will be enabled when the server starts.
+    handleWebSocketEvent({
+      getUnhandledRequestStrategy: () => {
+        return this.resolvedOptions.onUnhandledRequest
+      },
+      getHandlers: () => {
+        return this.handlersController.currentHandlers()
+      },
+      onMockedConnection: () => {},
+      onPassthroughConnection: () => {},
+    })
   }
 
   public listen(options: Partial<SharedOptions> = {}): void {
@@ -100,10 +119,11 @@ export class SetupServerCommonApi
 
     // Apply the interceptor when starting the server.
     this.interceptor.apply()
+    this.subscriptions.push(() => this.interceptor.dispose())
 
-    this.subscriptions.push(() => {
-      this.interceptor.dispose()
-    })
+    // Apply the WebSocket interception.
+    webSocketInterceptor.apply()
+    this.subscriptions.push(() => webSocketInterceptor.dispose())
 
     // Assert that the interceptor has been applied successfully.
     // Also guards us from forgetting to call "interceptor.apply()"

package/src/node/glossary.ts

@@ -1,8 +1,6 @@
 import type { PartialDeep } from 'type-fest'
-import type {
-  RequestHandler,
-  RequestHandlerDefaultInfo,
-} from '~/core/handlers/RequestHandler'
+import type { RequestHandler } from '~/core/handlers/RequestHandler'
+import type { WebSocketHandler } from '~/core/handlers/WebSocketHandler'
 import type {
   LifeCycleEventEmitter,
   LifeCycleEventsMap,
@@ -29,7 +27,7 @@ export interface SetupServerCommon {
    *
    * @see {@link https://mswjs.io/docs/api/setup-server/use `server.use()` API reference}
    */
-  use(...handlers: Array<RequestHandler>): void
+  use(...handlers: Array<RequestHandler | WebSocketHandler>): void
 
   /**
    * Marks all request handlers that respond using `res.once()` as unused.
@@ -43,14 +41,14 @@ export interface SetupServerCommon {
    *
    * @see {@link https://mswjs.io/docs/api/setup-server/reset-handlers `server.reset-handlers()` API reference}
    */
-  resetHandlers(...nextHandlers: Array<RequestHandler>): void
+  resetHandlers(...nextHandlers: Array<RequestHandler | WebSocketHandler>): void
 
   /**
    * Returns a readonly list of currently active request handlers.
    *
    * @see {@link https://mswjs.io/docs/api/setup-server/list-handlers `server.listHandlers()` API reference}
    */
-  listHandlers(): ReadonlyArray<RequestHandler<RequestHandlerDefaultInfo, any>>
+  listHandlers(): ReadonlyArray<RequestHandler | WebSocketHandler>
 
   /**
    * Life-cycle events.

package/src/node/setupServer.ts

@@ -1,4 +1,5 @@
 import type { RequestHandler } from '~/core/handlers/RequestHandler'
+import type { WebSocketHandler } from '~/core/handlers/WebSocketHandler'
 import { SetupServerApi } from './SetupServerApi'
 
 /**
@@ -8,7 +9,7 @@ import { SetupServerApi } from './SetupServerApi'
  * @see {@link https://mswjs.io/docs/api/setup-server `setupServer()` API reference}
  */
 export const setupServer = (
-  ...handlers: Array<RequestHandler>
+  ...handlers: Array<RequestHandler | WebSocketHandler>
 ): SetupServerApi => {
   return new SetupServerApi(handlers)
 }