msw 0.22.2 → 0.22.3

package/lib/esm/{matchRequestUrl-deps.js → getCallFrame-deps.js}

@@ -179,4 +179,29 @@ function matchRequestUrl(url, mask) {
     return match(cleanMask, cleanRequestUrl);
 }
 
-export { prepareRequest as a, prepareResponse as b, getTimestamp as c, getStatusCodeColor as d, getUrlByMask as g, jsonParse as j, matchRequestUrl as m, parseBody as p };
+/**
+ * Return the stack trace frame of a function's invocation.
+ */
+function getCallFrame() {
+    try {
+        const inspectionError = new Error();
+        inspectionError.name = 'Inspection Error';
+        throw inspectionError;
+    }
+    catch (error) {
+        const frames = error.stack.split('\n');
+        // Get the first frame that doesn't reference the library's internal trace.
+        // Assume that frame is the invocation frame.
+        const declarationFrame = frames.slice(1).find((frame) => {
+            return !/(node_modules)?\/lib\/(umd|esm)\//.test(frame);
+        });
+        if (!declarationFrame) {
+            return;
+        }
+        // Extract file reference from the stack frame.
+        const [, declarationPath] = declarationFrame.match(/\((.+?)\)$/) || [];
+        return declarationPath;
+    }
+}
+
+export { getCallFrame as a, prepareRequest as b, prepareResponse as c, getTimestamp as d, getStatusCodeColor as e, getUrlByMask as g, jsonParse as j, matchRequestUrl as m, parseBody as p };

package/lib/esm/graphql.js

@@ -1,6 +1,6 @@
 import { a as set, s as status, d as delay, f as fetch } from './fetch-deps.js';
 import { d as data, e as errors } from './errors-deps.js';
-import { j as jsonParse, m as matchRequestUrl, a as prepareRequest, b as prepareResponse, c as getTimestamp, d as getStatusCodeColor } from './matchRequestUrl-deps.js';
+import { j as jsonParse, m as matchRequestUrl, b as prepareRequest, c as prepareResponse, d as getTimestamp, e as getStatusCodeColor, a as getCallFrame } from './getCallFrame-deps.js';
 
 function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
 
@@ -3143,6 +3143,7 @@ function parseQuery(query, definitionOperation = 'query') {
     };
 }
 function graphQLRequestHandler(expectedOperationType, expectedOperationName, mask, resolver) {
+    const callFrame = getCallFrame();
     return {
         resolver,
         parse(req) {
@@ -3214,6 +3215,17 @@ function graphQLRequestHandler(expectedOperationType, expectedOperationName, mas
             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,
+            };
+        },
     };
 }
 const createGraphQLScopedHandler = (expectedOperationType, mask) => {

package/lib/esm/index.js

@@ -4,8 +4,8 @@ import './errors-deps.js';
 export { i as context } from './index-deps.js';
 import { g as getPublicUrlFromRequest, i as isStringEqual } from './rest-deps.js';
 export { R as RESTMethods, r as rest, a as restContext } from './rest-deps.js';
-import { p as parseBody } from './matchRequestUrl-deps.js';
-export { m as matchRequestUrl } from './matchRequestUrl-deps.js';
+import { p as parseBody } from './getCallFrame-deps.js';
+export { m as matchRequestUrl } from './getCallFrame-deps.js';
 export { graphql, graphqlContext } from './graphql.js';
 
 /*! *****************************************************************************
@@ -685,6 +685,18 @@ function setupWorker(...requestHandlers) {
         resetHandlers(...nextHandlers) {
             context.requestHandlers = resetHandlers(requestHandlers, ...nextHandlers);
         },
+        printHandlers() {
+            context.requestHandlers.forEach((handler) => {
+                const meta = handler.getMetaInfo();
+                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.groupEnd();
+            });
+        },
     };
 }
 

package/lib/esm/rest-deps.js

@@ -1,6 +1,6 @@
 import { c as createCommonjsModule, b as commonjsGlobal, a as set, s as status, j as json, d as delay, f as fetch } from './fetch-deps.js';
 import { c as cookie, b as body, t as text, x as xml } from './xml-deps.js';
-import { g as getUrlByMask, m as matchRequestUrl, a as prepareRequest, b as prepareResponse, c as getTimestamp, d as getStatusCodeColor } from './matchRequestUrl-deps.js';
+import { g as getUrlByMask, a as getCallFrame, m as matchRequestUrl, b as prepareRequest, c as prepareResponse, d as getTimestamp, e as getStatusCodeColor } from './getCallFrame-deps.js';
 
 var punycode = createCommonjsModule(function (module, exports) {
 (function(root) {
@@ -1388,6 +1388,7 @@ const restContext = {
 const createRestHandler = (method) => {
     return (mask, resolver) => {
         const resolvedMask = getUrlByMask(mask);
+        const callFrame = getCallFrame();
         return {
             parse(req) {
                 // Match the request during parsing to prevent matching it twice
@@ -1438,6 +1439,14 @@ ${queryParams
                 console.log('Response', loggedResponse);
                 console.groupEnd();
             },
+            getMetaInfo() {
+                return {
+                    type: 'rest',
+                    header: `[rest] ${method} ${mask.toString()}`,
+                    mask,
+                    callFrame,
+                };
+            },
         };
     };
 };

package/lib/esm/rest.js

@@ -1,4 +1,4 @@
 import './fetch-deps.js';
 import './xml-deps.js';
 export { R as RESTMethods, r as rest, a as restContext } from './rest-deps.js';
-import './matchRequestUrl-deps.js';
+import './getCallFrame-deps.js';

package/lib/types/index.d.ts

@@ -3,7 +3,7 @@ export { setupWorker } from './setupWorker/setupWorker';
 export { SetupWorkerApi } from './setupWorker/glossary';
 export { response, defaultResponse, createResponseComposition, MockedResponse, ResponseTransformer, ResponseComposition, ResponseCompositionOptions, ResponseFunction, } from './response';
 export { context };
-export { MockedRequest, RequestHandler, RequestParams, RequestQuery, ResponseResolver, ResponseResolverReturnType, AsyncResponseResolverReturnType, defaultContext, } from './utils/handlers/requestHandler';
+export { defaultContext, MockedRequest, RequestHandler, RequestHandlerMetaInfo, RequestParams, RequestQuery, ResponseResolver, ResponseResolverReturnType, AsyncResponseResolverReturnType, } from './utils/handlers/requestHandler';
 export { rest, restContext, RESTMethods, ParsedRestRequest } from './rest';
 export { graphql, graphqlContext, GraphQLMockedRequest, GraphQLMockedContext, GraphQLRequestPayload, GraphQLResponseResolver, GraphQLRequestParsedResult, } from './graphql';
 export { matchRequestUrl } from './utils/matching/matchRequestUrl';

package/lib/types/node/glossary.d.ts

@@ -17,6 +17,10 @@ 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.
      */
     resetHandlers: (...nextHandlers: RequestHandlersList) => void;
+    /**
+     * Lists all active request handlers.
+     */
+    printHandlers: () => void;
     /**
      * Stops requests interception by restoring all augmented modules.
      */

package/lib/types/setupWorker/glossary.d.ts

@@ -73,4 +73,8 @@ export interface SetupWorkerApi {
      * Resets request handlers to the initial list given to the `setupWorker` call, or to the explicit next request handlers list, if given.
      */
     resetHandlers: (...nextHandlers: RequestHandlersList) => void;
+    /**
+     * Lists all active request handlers.
+     */
+    printHandlers: () => void;
 }

package/lib/types/utils/handlers/requestHandler.d.ts

@@ -1,5 +1,5 @@
 import { Headers } from 'headers-utils';
-import { ResponseWithSerializedHeaders } from '../../setupWorker/glossary';
+import { Mask, ResponseWithSerializedHeaders } from '../../setupWorker/glossary';
 import { ResponseComposition, MockedResponse } from '../../response';
 import { set } from '../../context/set';
 export declare const defaultContext: {
@@ -36,6 +36,13 @@ export declare type RequestParams = {
 export declare type ResponseResolverReturnType<R> = R | undefined | void;
 export declare type AsyncResponseResolverReturnType<R> = Promise<ResponseResolverReturnType<R>> | ResponseResolverReturnType<R>;
 export declare type ResponseResolver<RequestType = MockedRequest, ContextType = typeof defaultContext, BodyType = any> = (req: RequestType, res: ResponseComposition<BodyType>, context: ContextType) => AsyncResponseResolverReturnType<MockedResponse<BodyType>>;
+declare type RequestHandlerType = 'rest' | 'graphql';
+export interface RequestHandlerMetaInfo<Type = RequestHandlerType> {
+    type: Type;
+    header: string;
+    mask: Mask;
+    callFrame: string | undefined;
+}
 export interface RequestHandler<RequestType = MockedRequest, ContextType = typeof defaultContext, ParsedRequest = any, PublicRequest = RequestType, ResponseBodyType = any> {
     /**
      * Parses a captured request to retrieve additional
@@ -69,6 +76,11 @@ export interface RequestHandler<RequestType = MockedRequest, ContextType = typeo
      * when dealing with any subsequent matching requests.
      */
     shouldSkip?: boolean;
+    /**
+     * Returns request handler's meta information used
+     * when listing each current request handler.
+     */
+    getMetaInfo: () => RequestHandlerMetaInfo;
 }
 declare const _default: null;
 export default _default;

package/lib/types/utils/internal/getCallFrame.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Return the stack trace frame of a function's invocation.
+ */
+export declare function getCallFrame(): string | undefined;

package/lib/umd/index.js

@@ -2818,6 +2818,18 @@ If this message still persists after updating, please report an issue: https://g
           resetHandlers(...nextHandlers) {
               context.requestHandlers = resetHandlers(requestHandlers, ...nextHandlers);
           },
+          printHandlers() {
+              context.requestHandlers.forEach((handler) => {
+                  const meta = handler.getMetaInfo();
+                  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.groupEnd();
+              });
+          },
       };
   }
 
@@ -2969,6 +2981,31 @@ If this message still persists after updating, please report an issue: https://g
       return match(cleanMask, cleanRequestUrl);
   }
 
+  /**
+   * Return the stack trace frame of a function's invocation.
+   */
+  function getCallFrame() {
+      try {
+          const inspectionError = new Error();
+          inspectionError.name = 'Inspection Error';
+          throw inspectionError;
+      }
+      catch (error) {
+          const frames = error.stack.split('\n');
+          // Get the first frame that doesn't reference the library's internal trace.
+          // Assume that frame is the invocation frame.
+          const declarationFrame = frames.slice(1).find((frame) => {
+              return !/(node_modules)?\/lib\/(umd|esm)\//.test(frame);
+          });
+          if (!declarationFrame) {
+              return;
+          }
+          // Extract file reference from the stack frame.
+          const [, declarationPath] = declarationFrame.match(/\((.+?)\)$/) || [];
+          return declarationPath;
+      }
+  }
+
   (function (RESTMethods) {
       RESTMethods["HEAD"] = "HEAD";
       RESTMethods["GET"] = "GET";
@@ -2992,6 +3029,7 @@ If this message still persists after updating, please report an issue: https://g
   const createRestHandler = (method) => {
       return (mask, resolver) => {
           const resolvedMask = getUrlByMask(mask);
+          const callFrame = getCallFrame();
           return {
               parse(req) {
                   // Match the request during parsing to prevent matching it twice
@@ -3042,6 +3080,14 @@ ${queryParams
                   console.log('Response', loggedResponse);
                   console.groupEnd();
               },
+              getMetaInfo() {
+                  return {
+                      type: 'rest',
+                      header: `[rest] ${method} ${mask.toString()}`,
+                      mask,
+                      callFrame,
+                  };
+              },
           };
       };
   };
@@ -6196,6 +6242,7 @@ ${queryParams
       };
   }
   function graphQLRequestHandler(expectedOperationType, expectedOperationName, mask, resolver) {
+      const callFrame = getCallFrame();
       return {
           resolver,
           parse(req) {
@@ -6267,6 +6314,17 @@ ${queryParams
               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,
+              };
+          },
       };
   }
   const createGraphQLScopedHandler = (expectedOperationType, mask) => {