chore: fix tests and add MSW license requestHandler file

Author: alessbell

.prettierignore

@@ -1,2 +1,3 @@
 pnpm-lock.yaml
-.storybook/public/mockServiceWorker.js
+.storybook/public/mockServiceWorker.js
+__generated__

.storybook/stories/ApolloClient.stories.ts

@@ -4,7 +4,7 @@ import {
   ApolloApp,
   ApolloAppWithDefer as AppWithDefer,
 } from "./components/apollo-client/ApolloComponent.js";
-import { handler } from "../../src/__tests__/mocks/handlers.js";
+import { graphQLHandler } from "../../src/__tests__/mocks/handlers.js";
 
 export default {
   title: "Example/Apollo Client",
@@ -13,7 +13,7 @@ export default {
     layout: "centered",
     msw: {
       handlers: {
-        graphql: handler,
+        graphql: graphQLHandler,
       },
     },
   },

.storybook/stories/Relay.stories.ts

@@ -4,7 +4,7 @@ import {
   RelayApp,
   RelayAppWithDefer as AppWithDefer,
 } from "./components/relay/RelayComponent.js";
-import { handler } from "../../src/__tests__/mocks/handlers.js";
+import { graphQLHandler } from "../../src/__tests__/mocks/handlers.js";
 
 export default {
   title: "Example/Relay",
@@ -13,7 +13,7 @@ export default {
     layout: "centered",
     msw: {
       handlers: {
-        graphql: handler,
+        graphql: graphQLHandler,
       },
     },
   },

jest.config.cjs

@@ -18,7 +18,11 @@ module.exports = {
   testEnvironmentOptions: {
     customExportConditions: [""],
   },
-  collectCoverageFrom: ["src/**/*.ts", "!src/__tests__/**/*.ts"],
+  collectCoverageFrom: [
+    "src/**/*.ts",
+    "!src/__tests__/**/*.ts",
+    "!src/requestHandler.ts",
+  ],
   coverageReporters: ["html", "json-summary", "text", "text-summary"],
   reporters: ["default", ["jest-junit", { outputDirectory: "coverage" }]],
   transform: {

package.json

@@ -126,7 +126,8 @@
     "@graphql-tools/utils": "^10.3.2",
     "@types/statuses": "^2.0.5",
     "graphql-tag": "^2.12.6",
-    "is-node-process": "^1.2.0"
+    "is-node-process": "^1.2.0",
+    "outvariant": "^1.4.3"
   },
   "peerDependencies": {
     "graphql": "^15.0.0 || ^16.0.0",

pnpm-lock.yaml

@@ -180,11 +180,13 @@ describe("integration tests with github schema", () => {
       githubTypeDefs,
       {
         IssueConnection: {
+          // @ts-expect-error need better TS-fu to accept a deep partial of
+          // whatever the resolver type returns here
           edges: (_parent, _args, _context, info) => {
             return Array(parseInt(info.variableValues.last as string))
               .fill(null)
               .map((_item, idx) => ({
-                // cursor: "2",
+                cursor: "2",
                 node: {
                   title: `Some issue ${idx}`,
                   url: `https://github.com/foo-bar/issues/${idx}`,
@@ -232,10 +234,8 @@ describe("integration tests with github schema", () => {
         variables: { owner: "octocat", name: "Hello World", last: "5" },
       });
 
-      if (data) {
-        // console.log(data.repository.issues.edges);
-      }
       if (!data) return null;
+
       return (
         <ul>
           {data.repository.issues.edges.map((item) => (

src/__tests__/handlers.test.tsx

@@ -1,19 +1,8 @@
 import { gql } from "graphql-tag";
 import { execute } from "@graphql-tools/executor";
 import { isNodeProcess } from "is-node-process";
-import {
-  type ExecutionResult,
-  type GraphQLSchema,
-  type DocumentNode,
-} from "graphql";
-import {
-  HttpResponse,
-  graphql,
-  delay as mswDelay,
-  type GraphQLQuery,
-  type GraphQLVariables,
-  type ResponseResolver,
-} from "msw";
+import type { GraphQLSchema, DocumentNode } from "graphql";
+import { HttpResponse, delay as mswDelay, type ResponseResolver } from "msw";
 import type {
   InitialIncrementalExecutionResult,
   SingularExecutionResult,
@@ -53,9 +42,7 @@ type DocumentResolversWithOptions<TResolvers> = {
   mocks?: IMocks<TResolvers>;
 } & DelayOptions;
 
-type Resolvers<TResolvers> =
-  | Partial<TResolvers>
-  | ((store: IMockStore) => Partial<TResolvers>);
+type Resolvers<TResolvers> = TResolvers | ((store: IMockStore) => TResolvers);
 
 type SchemaWithOptions<TResolvers> = {
   schema: GraphQLSchema;
@@ -81,9 +68,7 @@ function createHandler<TResolvers>(
 
 function createSchemaWithDefaultMocks<TResolvers>(
   typeDefs: DocumentNode,
-  resolvers?:
-    | Partial<TResolvers>
-    | ((store: IMockStore) => Partial<TResolvers>),
+  resolvers?: TResolvers | ((store: IMockStore) => TResolvers),
   mocks?: IMocks<TResolvers>,
 ) {
   const executableSchema = makeExecutableSchema({ typeDefs });
@@ -104,7 +89,7 @@ function createSchemaWithDefaultMocks<TResolvers>(
       (resolvers ?? {}) as Maybe<
         IResolvers<{ __typename?: string | undefined }, unknown>
       >,
-    ]) as Partial<TResolvers>,
+    ]) as TResolvers,
     preserveResolvers: true,
   });
 }
@@ -207,9 +192,7 @@ function createHandlerFromSchema<TResolvers>(
   const requestHandler = createCustomRequestHandler();
 
   return Object.assign(
-    requestHandler<
-      ExecutionResult<Record<string, unknown>, Record<string, unknown>>
-    >(async ({ query, variables, operationName }) => {
+    requestHandler(async ({ query, variables, operationName }) => {
       const document = gql(query as string);
       const hasDeferOrStream = hasDirectives(["defer", "stream"], document);
 
@@ -291,12 +274,8 @@ function createHandlerFromSchema<TResolvers>(
 }
 
 const createCustomRequestHandler = () => {
-  return <
-    Query extends GraphQLQuery = GraphQLQuery,
-    Variables extends GraphQLVariables = GraphQLVariables,
-  >(
-    resolver: ResponseResolver,
-  ) => new CustomRequestHandler("all", new RegExp(".*"), "*", resolver);
+  return (resolver: ResponseResolver) =>
+    new CustomRequestHandler("all", new RegExp(".*"), "*", resolver);
 };
 
 export { createHandler, createHandlerFromSchema, createSchemaWithDefaultMocks };

src/handlers.ts

@@ -1,4 +1,5 @@
 import statuses from "@bundled-es-modules/statuses";
+import { format } from "outvariant";
 
 import {
   GraphQLHandler,
@@ -7,6 +8,21 @@ import {
   type ParsedGraphQLRequest,
 } from "msw";
 
+// These utilities are taken wholesale from MSW, as they're not exported from
+// the package, in order to build an augmented version of MSW's
+// graphql.operation catchall request handler class.
+
+// MIT License
+
+// Copyright (c) 2018–present Artem Zakharchenko
+
+// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+// From https://github.com/mswjs/msw/blob/63b78315cdbe8435f9e6ec627022d67fa38a9703/src/core/handlers/GraphQLHandler.ts#L35
 export type GraphQLRequestParsedResult = {
   match: Match;
   cookies: Record<string, string>;
@@ -107,13 +123,26 @@ export function getStatusCodeColor(status: number): StatusCodeColor {
   return StatusCodeColor.Danger;
 }
 
+const LIBRARY_PREFIX = "[MSW]";
+
+/**
+ * Formats a given message by appending the library's prefix string.
+ */
+function formatMessage(message: string, ...positionals: any[]): string {
+  const interpolatedMessage = format(message, ...positionals);
+  return `${LIBRARY_PREFIX} ${interpolatedMessage}`;
+}
+
+const devUtils = {
+  formatMessage,
+};
+
 export class CustomRequestHandler extends GraphQLHandler {
   override async log(args: {
     request: Request;
     response: Response;
     parsedResult: GraphQLRequestParsedResult;
   }) {
-    // can expose some methods for digging into the mock schema?
     const loggedRequest = await serializeRequest(args.request);
     const loggedResponse = await serializeResponse(args.response);
     const statusColor = getStatusCodeColor(loggedResponse.status);
@@ -122,9 +151,11 @@ export class CustomRequestHandler extends GraphQLHandler {
       : `anonymous ${args.parsedResult.operationType}`;
 
     console.groupCollapsed(
-      `${getTimestamp()} ${requestInfo} (%c${loggedResponse.status} ${
-        loggedResponse.statusText
-      }%c)`,
+      devUtils.formatMessage(
+        `${getTimestamp()} ${requestInfo} (%c${loggedResponse.status} ${
+          loggedResponse.statusText
+        }%c)`,
+      ),
       `color:${statusColor}`,
       "color:inherit",
     );

src/requestHandler.ts

@@ -8,9 +8,6 @@ import {
   isScalarType,
   visit,
   BREAK,
-  GraphQLScalarType,
-  Kind,
-  GraphQLError,
 } from "graphql";
 
 function hasDirectives(names: string[], root: ASTNode, all?: boolean) {