msw 0.0.0-fetch.rc-15 → 0.0.0-fetch.rc-17

package/lib/core/index.mjs

@@ -1,8 +1,8 @@
 import { checkGlobals } from './utils/internal/checkGlobals.mjs';
 import { SetupApi } from './SetupApi.mjs';
 import { RequestHandler } from './handlers/RequestHandler.mjs';
-import { rest } from './rest.mjs';
-import { RestHandler, RESTMethods } from './handlers/RestHandler.mjs';
+import { http } from './http.mjs';
+import { HttpHandler, HttpMethods } from './handlers/HttpHandler.mjs';
 import { graphql } from './graphql.mjs';
 import { GraphQLHandler } from './handlers/GraphQLHandler.mjs';
 import { matchRequestUrl } from './utils/matching/matchRequestUrl.mjs';
@@ -16,15 +16,15 @@ import { NetworkError } from './NetworkError.mjs';
 checkGlobals();
 export {
   GraphQLHandler,
+  HttpHandler,
+  HttpMethods,
   NetworkError,
-  RESTMethods,
   RequestHandler,
-  RestHandler,
   SetupApi,
   bypass,
   cleanUrl,
   graphql,
+  http,
   matchRequestUrl,
-  passthrough,
-  rest
+  passthrough
 };

package/lib/core/passthrough.d.ts

@@ -1,9 +1,12 @@
 /**
- * Instruct Mock Service Worker to perform this request as-is.
+ * Performs the captured request as-is.
+ *
+ * This stops request handler lookup so no other handlers
+ * can affect this request past this point.
  * Unlike `bypass()`, this will not trigger an additional request.
  *
  * @example
- * rest.get('/user', () => {
+ * http.get('/resource', () => {
  *   return passthrough()
  * })
  */

package/lib/core/sharedOptions.d.ts

@@ -15,13 +15,51 @@ interface SharedOptions {
     onUnhandledRequest?: UnhandledRequestStrategy;
 }
 type LifeCycleEventsMap = {
-    'request:start': [request: Request, requestId: string];
-    'request:match': [request: Request, requestId: string];
-    'request:unhandled': [request: Request, requestId: string];
-    'request:end': [request: Request, requestId: string];
-    'response:mocked': [response: Response, request: Request, requestId: string];
-    'response:bypass': [response: Response, request: Request, requestId: string];
-    unhandledException: [error: Error, request: Request, requestId: string];
+    'request:start': [
+        args: {
+            request: Request;
+            requestId: string;
+        }
+    ];
+    'request:match': [
+        args: {
+            request: Request;
+            requestId: string;
+        }
+    ];
+    'request:unhandled': [
+        args: {
+            request: Request;
+            requestId: string;
+        }
+    ];
+    'request:end': [
+        args: {
+            request: Request;
+            requestId: string;
+        }
+    ];
+    'response:mocked': [
+        args: {
+            response: Response;
+            request: Request;
+            requestId: string;
+        }
+    ];
+    'response:bypass': [
+        args: {
+            response: Response;
+            request: Request;
+            requestId: string;
+        }
+    ];
+    unhandledException: [
+        args: {
+            error: Error;
+            request: Request;
+            requestId: string;
+        }
+    ];
 };
 type LifeCycleEventEmitter<EventsMap extends Record<string | symbol, any>> = Pick<Emitter<EventsMap>, 'on' | 'removeListener' | 'removeAllListeners'>;
 

package/lib/core/utils/handleRequest.js

@@ -48,9 +48,9 @@ var import_readResponseCookies = require("./request/readResponseCookies.js");
 function handleRequest(request, requestId, handlers, options, emitter, handleRequestOptions) {
   return __async(this, null, function* () {
     var _a, _b, _c, _d, _e, _f;
-    emitter.emit("request:start", request, requestId);
+    emitter.emit("request:start", { request, requestId });
     if (request.headers.get("x-msw-intention") === "bypass") {
-      emitter.emit("request:end", request, requestId);
+      emitter.emit("request:end", { request, requestId });
       (_a = handleRequestOptions == null ? void 0 : handleRequestOptions.onPassthroughResponse) == null ? void 0 : _a.call(handleRequestOptions, request);
       return;
     }
@@ -62,29 +62,33 @@ function handleRequest(request, requestId, handlers, options, emitter, handleReq
       );
     });
     if (lookupResult.error) {
-      emitter.emit("unhandledException", lookupResult.error, request, requestId);
+      emitter.emit("unhandledException", {
+        error: lookupResult.error,
+        request,
+        requestId
+      });
       throw lookupResult.error;
     }
     if (!lookupResult.data) {
       yield (0, import_onUnhandledRequest.onUnhandledRequest)(request, handlers, options.onUnhandledRequest);
-      emitter.emit("request:unhandled", request, requestId);
-      emitter.emit("request:end", request, requestId);
+      emitter.emit("request:unhandled", { request, requestId });
+      emitter.emit("request:end", { request, requestId });
       (_b = handleRequestOptions == null ? void 0 : handleRequestOptions.onPassthroughResponse) == null ? void 0 : _b.call(handleRequestOptions, request);
       return;
     }
     const { response } = lookupResult.data;
     if (!response) {
-      emitter.emit("request:end", request, requestId);
+      emitter.emit("request:end", { request, requestId });
       (_c = handleRequestOptions == null ? void 0 : handleRequestOptions.onPassthroughResponse) == null ? void 0 : _c.call(handleRequestOptions, request);
       return;
     }
     if (response.status === 302 && response.headers.get("x-msw-intention") === "passthrough") {
-      emitter.emit("request:end", request, requestId);
+      emitter.emit("request:end", { request, requestId });
       (_d = handleRequestOptions == null ? void 0 : handleRequestOptions.onPassthroughResponse) == null ? void 0 : _d.call(handleRequestOptions, request);
       return;
     }
     (0, import_readResponseCookies.readResponseCookies)(request, response);
-    emitter.emit("request:match", request, requestId);
+    emitter.emit("request:match", { request, requestId });
     const requiredLookupResult = lookupResult.data;
     const transformedResponse = ((_e = handleRequestOptions == null ? void 0 : handleRequestOptions.transformResponse) == null ? void 0 : _e.call(handleRequestOptions, response)) || response;
     (_f = handleRequestOptions == null ? void 0 : handleRequestOptions.onMockedResponse) == null ? void 0 : _f.call(
@@ -92,7 +96,7 @@ function handleRequest(request, requestId, handlers, options, emitter, handleReq
       transformedResponse,
       requiredLookupResult
     );
-    emitter.emit("request:end", request, requestId);
+    emitter.emit("request:end", { request, requestId });
     return transformedResponse;
   });
 }

package/lib/core/utils/handleRequest.mjs

@@ -25,9 +25,9 @@ import { readResponseCookies } from './request/readResponseCookies.mjs';
 function handleRequest(request, requestId, handlers, options, emitter, handleRequestOptions) {
   return __async(this, null, function* () {
     var _a, _b, _c, _d, _e, _f;
-    emitter.emit("request:start", request, requestId);
+    emitter.emit("request:start", { request, requestId });
     if (request.headers.get("x-msw-intention") === "bypass") {
-      emitter.emit("request:end", request, requestId);
+      emitter.emit("request:end", { request, requestId });
       (_a = handleRequestOptions == null ? void 0 : handleRequestOptions.onPassthroughResponse) == null ? void 0 : _a.call(handleRequestOptions, request);
       return;
     }
@@ -39,29 +39,33 @@ function handleRequest(request, requestId, handlers, options, emitter, handleReq
       );
     });
     if (lookupResult.error) {
-      emitter.emit("unhandledException", lookupResult.error, request, requestId);
+      emitter.emit("unhandledException", {
+        error: lookupResult.error,
+        request,
+        requestId
+      });
       throw lookupResult.error;
     }
     if (!lookupResult.data) {
       yield onUnhandledRequest(request, handlers, options.onUnhandledRequest);
-      emitter.emit("request:unhandled", request, requestId);
-      emitter.emit("request:end", request, requestId);
+      emitter.emit("request:unhandled", { request, requestId });
+      emitter.emit("request:end", { request, requestId });
       (_b = handleRequestOptions == null ? void 0 : handleRequestOptions.onPassthroughResponse) == null ? void 0 : _b.call(handleRequestOptions, request);
       return;
     }
     const { response } = lookupResult.data;
     if (!response) {
-      emitter.emit("request:end", request, requestId);
+      emitter.emit("request:end", { request, requestId });
       (_c = handleRequestOptions == null ? void 0 : handleRequestOptions.onPassthroughResponse) == null ? void 0 : _c.call(handleRequestOptions, request);
       return;
     }
     if (response.status === 302 && response.headers.get("x-msw-intention") === "passthrough") {
-      emitter.emit("request:end", request, requestId);
+      emitter.emit("request:end", { request, requestId });
       (_d = handleRequestOptions == null ? void 0 : handleRequestOptions.onPassthroughResponse) == null ? void 0 : _d.call(handleRequestOptions, request);
       return;
     }
     readResponseCookies(request, response);
-    emitter.emit("request:match", request, requestId);
+    emitter.emit("request:match", { request, requestId });
     const requiredLookupResult = lookupResult.data;
     const transformedResponse = ((_e = handleRequestOptions == null ? void 0 : handleRequestOptions.transformResponse) == null ? void 0 : _e.call(handleRequestOptions, response)) || response;
     (_f = handleRequestOptions == null ? void 0 : handleRequestOptions.onMockedResponse) == null ? void 0 : _f.call(
@@ -69,7 +73,7 @@ function handleRequest(request, requestId, handlers, options, emitter, handleReq
       transformedResponse,
       requiredLookupResult
     );
-    emitter.emit("request:end", request, requestId);
+    emitter.emit("request:end", { request, requestId });
     return transformedResponse;
   });
 }

package/lib/core/utils/internal/parseGraphQLRequest.js

@@ -103,9 +103,9 @@ function extractMultipartVariables(variables, map, files) {
 function getGraphQLInput(request) {
   return __async(this, null, function* () {
     var _a;
-    const url = new URL(request.url);
     switch (request.method) {
       case "GET": {
+        const url = new URL(request.url);
         const query = url.searchParams.get("query");
         const variables = url.searchParams.get("variables") || "";
         return {
@@ -114,9 +114,10 @@ function getGraphQLInput(request) {
         };
       }
       case "POST": {
+        const requestClone = request.clone();
         if ((_a = request.headers.get("content-type")) == null ? void 0 : _a.includes("multipart/form-data")) {
           const responseJson = (0, import_parseMultipartData.parseMultipartData)(
-            yield request.text(),
+            yield requestClone.text(),
             request.headers
           );
           if (!responseJson) {
@@ -140,7 +141,7 @@ function getGraphQLInput(request) {
             variables
           };
         }
-        const requestJson = yield request.json().catch(() => null);
+        const requestJson = yield requestClone.json().catch(() => null);
         if (requestJson == null ? void 0 : requestJson.query) {
           const { query, variables } = requestJson;
           return {

package/lib/core/utils/internal/parseGraphQLRequest.mjs

@@ -80,9 +80,9 @@ function extractMultipartVariables(variables, map, files) {
 function getGraphQLInput(request) {
   return __async(this, null, function* () {
     var _a;
-    const url = new URL(request.url);
     switch (request.method) {
       case "GET": {
+        const url = new URL(request.url);
         const query = url.searchParams.get("query");
         const variables = url.searchParams.get("variables") || "";
         return {
@@ -91,9 +91,10 @@ function getGraphQLInput(request) {
         };
       }
       case "POST": {
+        const requestClone = request.clone();
         if ((_a = request.headers.get("content-type")) == null ? void 0 : _a.includes("multipart/form-data")) {
           const responseJson = parseMultipartData(
-            yield request.text(),
+            yield requestClone.text(),
             request.headers
           );
           if (!responseJson) {
@@ -117,7 +118,7 @@ function getGraphQLInput(request) {
             variables
           };
         }
-        const requestJson = yield request.json().catch(() => null);
+        const requestJson = yield requestClone.json().catch(() => null);
         if (requestJson == null ? void 0 : requestJson.query) {
           const { query, variables } = requestJson;
           return {

package/lib/core/utils/request/onUnhandledRequest.js

@@ -64,8 +64,8 @@ const TYPE_MATCH_DELTA = 0.5;
 function groupHandlersByType(handlers) {
   return handlers.reduce(
     (groups, handler) => {
-      if (handler instanceof import__.RestHandler) {
-        groups.rest.push(handler);
+      if (handler instanceof import__.HttpHandler) {
+        groups.http.push(handler);
       }
       if (handler instanceof import__.GraphQLHandler) {
         groups.graphql.push(handler);
@@ -73,12 +73,12 @@ function groupHandlersByType(handlers) {
       return groups;
     },
     {
-      rest: [],
+      http: [],
       graphql: []
     }
   );
 }
-function getRestHandlerScore() {
+function getHttpHandlerScore() {
   return (request, handler) => {
     const { path, method } = handler.info;
     if (path instanceof RegExp || method instanceof RegExp) {
@@ -126,19 +126,25 @@ function onUnhandledRequest(request, handlers, strategy = "warn") {
     const parsedGraphQLQuery = yield (0, import_parseGraphQLRequest.parseGraphQLRequest)(request).catch(
       () => null
     );
+    const publicUrl = (0, import_getPublicUrlFromRequest.getPublicUrlFromRequest)(request);
     function generateHandlerSuggestion() {
       const handlerGroups = groupHandlersByType(handlers);
-      const relevantHandlers = parsedGraphQLQuery ? handlerGroups.graphql : handlerGroups.rest;
+      const relevantHandlers = parsedGraphQLQuery ? handlerGroups.graphql : handlerGroups.http;
       const suggestedHandlers = getSuggestedHandler(
         request,
         relevantHandlers,
-        parsedGraphQLQuery ? getGraphQLHandlerScore(parsedGraphQLQuery) : getRestHandlerScore()
+        parsedGraphQLQuery ? getGraphQLHandlerScore(parsedGraphQLQuery) : getHttpHandlerScore()
       );
       return suggestedHandlers.length > 0 ? getSuggestedHandlersMessage(suggestedHandlers) : "";
     }
+    function getGraphQLRequestHeader(parsedGraphQLRequest) {
+      if (!(parsedGraphQLRequest == null ? void 0 : parsedGraphQLRequest.operationName)) {
+        return `anonymous ${parsedGraphQLRequest == null ? void 0 : parsedGraphQLRequest.operationType} (${request.method} ${publicUrl})`;
+      }
+      return `${parsedGraphQLRequest.operationType} ${parsedGraphQLRequest.operationName} (${request.method} ${publicUrl})`;
+    }
     function generateUnhandledRequestMessage() {
-      const publicUrl = (0, import_getPublicUrlFromRequest.getPublicUrlFromRequest)(request);
-      const requestHeader = parsedGraphQLQuery ? `${parsedGraphQLQuery.operationType} ${parsedGraphQLQuery.operationName} (${request.method} ${publicUrl})` : `${request.method} ${publicUrl}`;
+      const requestHeader = parsedGraphQLQuery ? getGraphQLRequestHeader(parsedGraphQLQuery) : `${request.method} ${publicUrl}`;
       const handlerSuggestion = generateHandlerSuggestion();
       const messageTemplate = [
         `captured a request without a matching request handler:`,

package/lib/core/utils/request/onUnhandledRequest.mjs

@@ -19,7 +19,7 @@ var __async = (__this, __arguments, generator) => {
   });
 };
 import jsLevenshtein from "@bundled-es-modules/js-levenshtein";
-import { RestHandler, GraphQLHandler } from '../../index.mjs';
+import { HttpHandler, GraphQLHandler } from '../../index.mjs';
 import {
   parseGraphQLRequest
 } from '../internal/parseGraphQLRequest.mjs';
@@ -33,8 +33,8 @@ const TYPE_MATCH_DELTA = 0.5;
 function groupHandlersByType(handlers) {
   return handlers.reduce(
     (groups, handler) => {
-      if (handler instanceof RestHandler) {
-        groups.rest.push(handler);
+      if (handler instanceof HttpHandler) {
+        groups.http.push(handler);
       }
       if (handler instanceof GraphQLHandler) {
         groups.graphql.push(handler);
@@ -42,12 +42,12 @@ function groupHandlersByType(handlers) {
       return groups;
     },
     {
-      rest: [],
+      http: [],
       graphql: []
     }
   );
 }
-function getRestHandlerScore() {
+function getHttpHandlerScore() {
   return (request, handler) => {
     const { path, method } = handler.info;
     if (path instanceof RegExp || method instanceof RegExp) {
@@ -95,19 +95,25 @@ function onUnhandledRequest(request, handlers, strategy = "warn") {
     const parsedGraphQLQuery = yield parseGraphQLRequest(request).catch(
       () => null
     );
+    const publicUrl = getPublicUrlFromRequest(request);
     function generateHandlerSuggestion() {
       const handlerGroups = groupHandlersByType(handlers);
-      const relevantHandlers = parsedGraphQLQuery ? handlerGroups.graphql : handlerGroups.rest;
+      const relevantHandlers = parsedGraphQLQuery ? handlerGroups.graphql : handlerGroups.http;
       const suggestedHandlers = getSuggestedHandler(
         request,
         relevantHandlers,
-        parsedGraphQLQuery ? getGraphQLHandlerScore(parsedGraphQLQuery) : getRestHandlerScore()
+        parsedGraphQLQuery ? getGraphQLHandlerScore(parsedGraphQLQuery) : getHttpHandlerScore()
       );
       return suggestedHandlers.length > 0 ? getSuggestedHandlersMessage(suggestedHandlers) : "";
     }
+    function getGraphQLRequestHeader(parsedGraphQLRequest) {
+      if (!(parsedGraphQLRequest == null ? void 0 : parsedGraphQLRequest.operationName)) {
+        return `anonymous ${parsedGraphQLRequest == null ? void 0 : parsedGraphQLRequest.operationType} (${request.method} ${publicUrl})`;
+      }
+      return `${parsedGraphQLRequest.operationType} ${parsedGraphQLRequest.operationName} (${request.method} ${publicUrl})`;
+    }
     function generateUnhandledRequestMessage() {
-      const publicUrl = getPublicUrlFromRequest(request);
-      const requestHeader = parsedGraphQLQuery ? `${parsedGraphQLQuery.operationType} ${parsedGraphQLQuery.operationName} (${request.method} ${publicUrl})` : `${request.method} ${publicUrl}`;
+      const requestHeader = parsedGraphQLQuery ? getGraphQLRequestHeader(parsedGraphQLQuery) : `${request.method} ${publicUrl}`;
       const handlerSuggestion = generateHandlerSuggestion();
       const messageTemplate = [
         `captured a request without a matching request handler:`,