WIP Re-designs the RequestHandler API

src/graphql.ts

@@ -286,20 +286,6 @@ function graphQLRequestHandler<QueryType, VariablesType = Record<string, any>>(
       console.log('Response:', loggedResponse)
       console.groupEnd()
     },
-
-    getMetaInfo() {
-      const header =
-        expectedOperationType === 'all'
-          ? `[graphql] ${expectedOperationType} (origin: ${mask.toString()})`
-          : `[graphql] ${expectedOperationType} ${expectedOperationName} (origin: ${mask.toString()})`
-
-      return {
-        type: 'graphql',
-        header,
-        mask,
-        callFrame,
-      }
-    },
   }
 }
 

src/index.ts

@@ -19,15 +19,13 @@ export {
   defaultContext,
   MockedRequest,
   RequestHandler,
-  RequestHandlerMetaInfo,
   RequestParams,
   RequestQuery,
   ResponseResolver,
   ResponseResolverReturnType,
   AsyncResponseResolverReturnType,
 } from './utils/handlers/requestHandler'
 export {
-  rest,
   restContext,
   RestContext,
   RESTMethods,
@@ -47,3 +45,5 @@ export { matchRequestUrl } from './utils/matching/matchRequestUrl'
 /* Utils */
 export { compose } from './utils/internal/compose'
 export { DelayMode } from './context/delay'
+
+export { rest } from './utils/handlers/2.0/rest'

src/node/createSetupServer.ts

@@ -1,13 +1,13 @@
-import * as cookieUtils from 'cookie'
 import { bold } from 'chalk'
+import * as cookieUtils from 'cookie'
 import { Headers, flattenHeadersObject } from 'headers-utils'
 import { StrictEventEmitter } from 'strict-event-emitter'
 import {
   RequestInterceptor,
   MockedResponse as MockedInterceptedResponse,
   Interceptor,
 } from 'node-request-interceptor'
-import { RequestHandlersList } from '../setupWorker/glossary'
+import { RequestApplicator, RequestHandlersList } from '../setupWorker/glossary'
 import { MockedRequest } from '../utils/handlers/requestHandler'
 import { getResponse } from '../utils/getResponse'
 import { parseBody } from '../utils/request/parseBody'
@@ -17,7 +17,6 @@ import { onUnhandledRequest } from '../utils/request/onUnhandledRequest'
 import { ServerLifecycleEventsMap, SetupServerApi } from './glossary'
 import { SharedOptions } from '../sharedOptions'
 import { uuidv4 } from '../utils/internal/uuidv4'
-import { request } from 'express'
 
 const DEFAULT_LISTEN_OPTIONS: SharedOptions = {
   onUnhandledRequest: 'bypass',
@@ -31,7 +30,7 @@ export function createSetupServer(...interceptors: Interceptor[]) {
   const emitter = new StrictEventEmitter<ServerLifecycleEventsMap>()
 
   return function setupServer(
-    ...requestHandlers: RequestHandlersList
+    ...requestHandlers: RequestApplicator[]
   ): SetupServerApi {
     requestHandlers.forEach((handler) => {
       if (Array.isArray(handler))
@@ -50,7 +49,7 @@ export function createSetupServer(...interceptors: Interceptor[]) {
 
     // Store the list of request handlers for the current server instance,
     // so it could be modified at a runtime.
-    let currentHandlers: RequestHandlersList = [...requestHandlers]
+    let currentHandlers: RequestApplicator[] = [...requestHandlers]
 
     interceptor.on('response', (req, res) => {
       const requestId = req.headers?.['x-msw-request-id'] as string
@@ -91,7 +90,6 @@ export function createSetupServer(...interceptors: Interceptor[]) {
             body: parseBody(req.body, requestHeaders),
             headers: requestHeaders,
             cookies: {},
-            params: {},
             redirect: 'manual',
             referrer: '',
             keepalive: false,
@@ -176,11 +174,11 @@ export function createSetupServer(...interceptors: Interceptor[]) {
 
       printHandlers() {
         currentHandlers.forEach((handler) => {
-          const meta = handler.getMetaInfo()
+          const { header, callFrame } = handler.info
 
           console.log(`\
-${bold(meta.header)}
-  Declaration: ${meta.callFrame}
+${bold(header)}
+  Declaration: ${callFrame}
 `)
         })
       },

src/node/glossary.ts

@@ -1,6 +1,6 @@
 import { MockedResponse as MockedInterceptedResponse } from 'node-request-interceptor'
 import { SharedOptions } from '../sharedOptions'
-import { RequestHandlersList } from '../setupWorker/glossary'
+import { RequestApplicator } from '../setupWorker/glossary'
 import { MockedRequest } from '../utils/handlers/requestHandler'
 
 export interface ServerLifecycleEventsMap {
@@ -29,7 +29,7 @@ export interface SetupServerApi {
    * Prepends given request handlers to the list of existing handlers.
    * @see {@link https://mswjs.io/docs/api/setup-server/use `server.use()`}
    */
-  use(...handlers: RequestHandlersList): void
+  use(...handlers: RequestApplicator[]): void
 
   /**
    * Marks all request handlers that respond using `res.once()` as unused.
@@ -41,7 +41,7 @@ export interface SetupServerApi {
    * Resets request handlers to the initial list given to the `setupServer` call, or to the explicit next request handlers list, if given.
    * @see {@link https://mswjs.io/docs/api/setup-server/reset-handlers `server.reset-handlers()`}
    */
-  resetHandlers(...nextHandlers: RequestHandlersList): void
+  resetHandlers(...nextHandlers: RequestApplicator[]): void
 
   /**
    * Lists all active request handlers.

src/rest.ts

@@ -75,12 +75,12 @@ const createRestHandler = (method: RESTMethods) => {
   >(
     mask: Mask,
     resolver: ResponseResolver<
-      MockedRequest<RequestBodyType, RequestParamsType>,
+      MockedRequest<RequestBodyType>,
       typeof restContext,
       ResponseBodyType
     >,
   ): RequestHandler<
-    MockedRequest<RequestBodyType, RequestParamsType>,
+    MockedRequest<RequestBodyType>,
     typeof restContext,
     ParsedRestRequest,
     MockedRequest<RequestBodyType>,
@@ -112,6 +112,7 @@ const createRestHandler = (method: RESTMethods) => {
           params,
         }
       },
+
       resolver,
 
       defineContext() {
@@ -165,15 +166,6 @@ ${queryParams
         console.log('Response', loggedResponse)
         console.groupEnd()
       },
-
-      getMetaInfo() {
-        return {
-          type: 'rest',
-          header: `[rest] ${method} ${mask.toString()}`,
-          mask,
-          callFrame,
-        }
-      },
     }
   }
 }

src/setupWorker/glossary.ts

@@ -6,6 +6,7 @@ import { SharedOptions } from '../sharedOptions'
 import { ServiceWorkerMessage } from '../utils/createBroadcastChannel'
 import { createStart } from './start/createStart'
 import { createStop } from './stop/createStop'
+import { RequestHandler as RequestHandlerClass } from '../utils/handlers/2.0/RequestHandler'
 
 export type Mask = RegExp | string
 export type ResolvedMask = Mask | URL
@@ -92,7 +93,7 @@ export interface SetupWorkerInternalContext {
   startOptions: StartOptions | undefined
   worker: ServiceWorker | null
   registration: ServiceWorkerRegistration | null
-  requestHandlers: RequestHandler<any, any>[]
+  requestHandlers: RequestApplicator[]
   emitter: StrictEventEmitter<WorkerLifecycleEventsMap>
   keepAliveInterval?: number
   workerChannel: {
@@ -176,6 +177,7 @@ export type StartOptions = SharedOptions & {
   findWorker?: FindWorker
 }
 
+export type RequestApplicator = RequestHandlerClass
 export type RequestHandlersList = RequestHandler<any, any, any, any, any>[]
 
 export type ResponseWithSerializedHeaders<BodyType = any> = Omit<
@@ -203,7 +205,7 @@ export interface SetupWorkerApi {
    * @param {RequestHandler[]} handlers List of runtime request handlers.
    * @see {@link https://mswjs.io/docs/api/setup-worker/use `worker.use()`}
    */
-  use: (...handlers: RequestHandlersList) => void
+  use: (...handlers: RequestApplicator[]) => void
 
   /**
    * Marks all request handlers that respond using `res.once()` as unused.
@@ -216,7 +218,7 @@ export interface SetupWorkerApi {
    * @param {RequestHandler[]} nextHandlers List of the new initial request handlers.
    * @see {@link https://mswjs.io/docs/api/setup-worker/reset-handlers `worker.resetHandlers()`}
    */
-  resetHandlers: (...nextHandlers: RequestHandlersList) => void
+  resetHandlers: (...nextHandlers: RequestApplicator[]) => void
 
   /**
    * Lists all active request handlers.

src/setupWorker/setupWorker.ts

@@ -1,16 +1,17 @@
 import { StrictEventEmitter } from 'strict-event-emitter'
 import {
   SetupWorkerInternalContext,
-  RequestHandlersList,
   SetupWorkerApi,
   ServiceWorkerIncomingEventsMap,
+  RequestApplicator,
 } from './glossary'
 import { createStart } from './start/createStart'
 import { createStop } from './stop/createStop'
 import * as requestHandlerUtils from '../utils/handlers/requestHandlerUtils'
 import { isNodeProcess } from '../utils/internal/isNodeProcess'
 import { ServiceWorkerMessage } from '../utils/createBroadcastChannel'
 import { jsonParse } from '../utils/internal/jsonParse'
+import { RestHandler } from '../utils/handlers/2.0/RestHandler'
 
 interface Listener {
   target: EventTarget
@@ -29,7 +30,7 @@ let listeners: Listener[] = []
  * @see {@link https://mswjs.io/docs/api/setup-worker `setupWorker`}
  */
 export function setupWorker(
-  ...requestHandlers: RequestHandlersList
+  ...requestHandlers: RequestApplicator[]
 ): SetupWorkerApi {
   requestHandlers.forEach((handler) => {
     if (Array.isArray(handler))
@@ -143,6 +144,7 @@ export function setupWorker(
     stop: createStop(context),
 
     use(...handlers) {
+      console.log('adding new handlers', handlers)
       requestHandlerUtils.use(context.requestHandlers, ...handlers)
     },
 
@@ -159,14 +161,23 @@ export function setupWorker(
 
     printHandlers() {
       context.requestHandlers.forEach((handler) => {
-        const meta = handler.getMetaInfo()
+        const { header, callFrame } = handler.info
 
-        console.groupCollapsed(meta.header)
-        console.log(`Declaration: ${meta.callFrame}`)
-        console.log('Resolver: %s', handler.resolver)
-        if (['rest'].includes(meta.type)) {
-          console.log('Match:', `https://mswjs.io/repl?path=${meta.mask}`)
+        console.groupCollapsed(header)
+
+        if (callFrame) {
+          console.log(`Declaration: ${callFrame}`)
+        }
+
+        console.log('Handler:', handler)
+
+        if (handler instanceof RestHandler) {
+          console.log(
+            'Match:',
+            `https://mswjs.io/repl?path=${handler.info.mask}`,
+          )
         }
+
         console.groupEnd()
       })
     },