msw 2.0.12 → 2.0.13

package/src/core/handlers/GraphQLHandler.test.ts

@@ -0,0 +1,820 @@
+/**
+ * @vitest-environment jsdom
+ */
+import { encodeBuffer } from '@mswjs/interceptors'
+import { OperationTypeNode, parse } from 'graphql'
+import {
+  GraphQLHandler,
+  GraphQLRequestBody,
+  GraphQLResolverExtras,
+  isDocumentNode,
+} from './GraphQLHandler'
+import { HttpResponse } from '../HttpResponse'
+import { ResponseResolver } from './RequestHandler'
+
+const resolver: ResponseResolver<GraphQLResolverExtras<{ userId: string }>> = ({
+  variables,
+}) => {
+  return HttpResponse.json({
+    data: {
+      user: {
+        id: variables.userId,
+      },
+    },
+  })
+}
+
+function createGetGraphQLRequest(
+  body: GraphQLRequestBody<any>,
+  graphqlEndpoint = 'https://example.com',
+) {
+  const requestUrl = new URL(graphqlEndpoint)
+  requestUrl.searchParams.set('query', body?.query)
+  requestUrl.searchParams.set('variables', JSON.stringify(body?.variables))
+  return new Request(requestUrl)
+}
+
+function createPostGraphQLRequest(
+  body: GraphQLRequestBody<any>,
+  graphqlEndpoint = 'https://example.com',
+) {
+  return new Request(new URL(graphqlEndpoint), {
+    method: 'POST',
+    headers: new Headers({ 'Content-Type': 'application/json' }),
+    body: encodeBuffer(JSON.stringify(body)),
+  })
+}
+
+const GET_USER = `
+  query GetUser {
+    user {
+      id
+    }
+  }
+`
+
+const LOGIN = `
+  mutation Login {
+    user {
+      id
+    }
+  }
+`
+
+describe('info', () => {
+  test('exposes request handler information for query', () => {
+    const handler = new GraphQLHandler(
+      OperationTypeNode.QUERY,
+      'GetUser',
+      '*',
+      resolver,
+    )
+
+    expect(handler.info.header).toEqual('query GetUser (origin: *)')
+    expect(handler.info.operationType).toEqual('query')
+    expect(handler.info.operationName).toEqual('GetUser')
+  })
+
+  test('exposes request handler information for mutation', () => {
+    const handler = new GraphQLHandler(
+      OperationTypeNode.MUTATION,
+      'Login',
+      '*',
+      resolver,
+    )
+
+    expect(handler.info.header).toEqual('mutation Login (origin: *)')
+    expect(handler.info.operationType).toEqual('mutation')
+    expect(handler.info.operationName).toEqual('Login')
+  })
+
+  test('parses a query operation name from a given DocumentNode', () => {
+    const node = parse(`
+      query GetUser {
+        user {
+          firstName
+        }
+      }
+    `)
+
+    const handler = new GraphQLHandler(
+      OperationTypeNode.QUERY,
+      node,
+      '*',
+      resolver,
+    )
+
+    expect(handler.info).toHaveProperty('header', 'query GetUser (origin: *)')
+    expect(handler.info).toHaveProperty('operationType', 'query')
+    expect(handler.info).toHaveProperty('operationName', 'GetUser')
+  })
+
+  test('parses a mutation operation name from a given DocumentNode', () => {
+    const node = parse(`
+      mutation Login {
+        user {
+          id
+        }
+      }
+    `)
+    const handler = new GraphQLHandler(
+      OperationTypeNode.MUTATION,
+      node,
+      '*',
+      resolver,
+    )
+
+    expect(handler.info).toHaveProperty('header', 'mutation Login (origin: *)')
+    expect(handler.info).toHaveProperty('operationType', 'mutation')
+    expect(handler.info).toHaveProperty('operationName', 'Login')
+  })
+
+  test('throws an exception given a DocumentNode with a mismatched operation type', () => {
+    const node = parse(`
+      mutation CreateUser {
+        user {
+          firstName
+        }
+      }
+    `)
+
+    expect(
+      () => new GraphQLHandler(OperationTypeNode.QUERY, node, '*', resolver),
+    ).toThrow(
+      'Failed to create a GraphQL handler: provided a DocumentNode with a mismatched operation type (expected "query", but got "mutation").',
+    )
+  })
+})
+
+describe('parse', () => {
+  describe('query', () => {
+    test('parses a query without variables (GET)', async () => {
+      const handler = new GraphQLHandler(
+        OperationTypeNode.QUERY,
+        'GetUser',
+        '*',
+        resolver,
+      )
+      const request = createGetGraphQLRequest({
+        query: GET_USER,
+      })
+
+      expect(await handler.parse({ request })).toEqual({
+        match: {
+          matches: true,
+          params: {
+            '0': 'https://example.com/',
+          },
+        },
+        operationType: 'query',
+        operationName: 'GetUser',
+        query: GET_USER,
+        variables: undefined,
+      })
+    })
+
+    test('parses a query with variables (GET)', async () => {
+      const handler = new GraphQLHandler(
+        OperationTypeNode.QUERY,
+        'GetUser',
+        '*',
+        resolver,
+      )
+      const request = createGetGraphQLRequest({
+        query: GET_USER,
+        variables: {
+          userId: 'abc-123',
+        },
+      })
+
+      expect(await handler.parse({ request })).toEqual({
+        match: {
+          matches: true,
+          params: {
+            '0': 'https://example.com/',
+          },
+        },
+        operationType: 'query',
+        operationName: 'GetUser',
+        query: GET_USER,
+        variables: {
+          userId: 'abc-123',
+        },
+      })
+    })
+
+    test('parses a query without variables (POST)', async () => {
+      const handler = new GraphQLHandler(
+        OperationTypeNode.QUERY,
+        'GetUser',
+        '*',
+        resolver,
+      )
+      const request = createPostGraphQLRequest({
+        query: GET_USER,
+      })
+
+      expect(await handler.parse({ request })).toEqual({
+        match: {
+          matches: true,
+          params: {
+            '0': 'https://example.com/',
+          },
+        },
+        operationType: 'query',
+        operationName: 'GetUser',
+        query: GET_USER,
+        variables: undefined,
+      })
+    })
+
+    test('parses a query with variables (POST)', async () => {
+      const handler = new GraphQLHandler(
+        OperationTypeNode.QUERY,
+        'GetUser',
+        '*',
+        resolver,
+      )
+      const request = createPostGraphQLRequest({
+        query: GET_USER,
+        variables: {
+          userId: 'abc-123',
+        },
+      })
+
+      expect(await handler.parse({ request })).toEqual({
+        match: {
+          matches: true,
+          params: {
+            '0': 'https://example.com/',
+          },
+        },
+        operationType: 'query',
+        operationName: 'GetUser',
+        query: GET_USER,
+        variables: {
+          userId: 'abc-123',
+        },
+      })
+    })
+  })
+
+  describe('mutation', () => {
+    test('parses a mutation without variables (GET)', async () => {
+      const handler = new GraphQLHandler(
+        OperationTypeNode.MUTATION,
+        'GetUser',
+        '*',
+        resolver,
+      )
+      const request = createGetGraphQLRequest({
+        query: LOGIN,
+      })
+
+      expect(await handler.parse({ request })).toEqual({
+        match: {
+          matches: true,
+          params: {
+            '0': 'https://example.com/',
+          },
+        },
+        operationType: 'mutation',
+        operationName: 'Login',
+        query: LOGIN,
+        variables: undefined,
+      })
+    })
+
+    test('parses a mutation with variables (GET)', async () => {
+      const handler = new GraphQLHandler(
+        OperationTypeNode.MUTATION,
+        'GetUser',
+        '*',
+        resolver,
+      )
+      const request = createGetGraphQLRequest({
+        query: LOGIN,
+        variables: {
+          userId: 'abc-123',
+        },
+      })
+
+      expect(await handler.parse({ request })).toEqual({
+        match: {
+          matches: true,
+          params: {
+            '0': 'https://example.com/',
+          },
+        },
+        operationType: 'mutation',
+        operationName: 'Login',
+        query: LOGIN,
+        variables: {
+          userId: 'abc-123',
+        },
+      })
+    })
+
+    test('parses a mutation without variables (POST)', async () => {
+      const handler = new GraphQLHandler(
+        OperationTypeNode.MUTATION,
+        'GetUser',
+        '*',
+        resolver,
+      )
+      const request = createPostGraphQLRequest({
+        query: LOGIN,
+      })
+
+      expect(await handler.parse({ request })).toEqual({
+        match: {
+          matches: true,
+          params: {
+            '0': 'https://example.com/',
+          },
+        },
+        operationType: 'mutation',
+        operationName: 'Login',
+        query: LOGIN,
+        variables: undefined,
+      })
+    })
+
+    test('parses a mutation with variables (POST)', async () => {
+      const handler = new GraphQLHandler(
+        OperationTypeNode.MUTATION,
+        'GetUser',
+        '*',
+        resolver,
+      )
+      const request = createPostGraphQLRequest({
+        query: LOGIN,
+        variables: {
+          userId: 'abc-123',
+        },
+      })
+
+      expect(await handler.parse({ request })).toEqual({
+        match: {
+          matches: true,
+          params: {
+            '0': 'https://example.com/',
+          },
+        },
+        operationType: 'mutation',
+        operationName: 'Login',
+        query: LOGIN,
+        variables: {
+          userId: 'abc-123',
+        },
+      })
+    })
+  })
+
+  describe('with endpoint configuration', () => {
+    test('parses the request and parses grapqhl properties from it when the graphql.link endpoint matches', async () => {
+      const handler = new GraphQLHandler(
+        OperationTypeNode.QUERY,
+        'GetUser',
+        'https://mswjs.com/graphql',
+        resolver,
+      )
+
+      await expect(
+        handler.parse({
+          request: createGetGraphQLRequest(
+            {
+              query: GET_USER,
+              variables: {
+                userId: 'abc-123',
+              },
+            },
+            'https://mswjs.com/graphql',
+          ),
+        }),
+      ).resolves.toEqual({
+        match: {
+          matches: true,
+          params: {},
+        },
+        operationType: 'query',
+        operationName: 'GetUser',
+        query: GET_USER,
+        variables: {
+          userId: 'abc-123',
+        },
+      })
+
+      await expect(
+        handler.parse({
+          request: createPostGraphQLRequest(
+            {
+              query: GET_USER,
+              variables: {
+                userId: 'abc-123',
+              },
+            },
+            'https://mswjs.com/graphql',
+          ),
+        }),
+      ).resolves.toEqual({
+        match: {
+          matches: true,
+          params: {},
+        },
+        operationType: 'query',
+        operationName: 'GetUser',
+        query: GET_USER,
+        variables: {
+          userId: 'abc-123',
+        },
+      })
+    })
+
+    test('parses a request but does not parse graphql properties from it graphql.link hostname does not match', async () => {
+      const handler = new GraphQLHandler(
+        OperationTypeNode.QUERY,
+        'GetUser',
+        'https://mswjs.com/graphql',
+        resolver,
+      )
+
+      await expect(
+        handler.parse({
+          request: createGetGraphQLRequest(
+            {
+              query: GET_USER,
+              variables: {
+                userId: 'abc-123',
+              },
+            },
+            'https://example.com/graphql',
+          ),
+        }),
+      ).resolves.toEqual({
+        match: {
+          matches: false,
+          params: {},
+        },
+      })
+
+      await expect(
+        handler.parse({
+          request: createPostGraphQLRequest(
+            {
+              query: GET_USER,
+              variables: {
+                userId: 'abc-123',
+              },
+            },
+            'https://example.com/graphql',
+          ),
+        }),
+      ).resolves.toEqual({
+        match: {
+          matches: false,
+          params: {},
+        },
+      })
+    })
+
+    test('parses a request but does not parse graphql properties from it graphql.link pathname does not match', async () => {
+      const handler = new GraphQLHandler(
+        OperationTypeNode.QUERY,
+        'GetUser',
+        'https://mswjs.com/graphql',
+        resolver,
+      )
+
+      await expect(
+        handler.parse({
+          request: createGetGraphQLRequest(
+            {
+              query: GET_USER,
+              variables: {
+                userId: 'abc-123',
+              },
+            },
+            'https://mswjs.com/some/other/endpoint',
+          ),
+        }),
+      ).resolves.toEqual({
+        match: {
+          matches: false,
+          params: {},
+        },
+      })
+
+      await expect(
+        handler.parse({
+          request: createPostGraphQLRequest(
+            {
+              query: GET_USER,
+              variables: {
+                userId: 'abc-123',
+              },
+            },
+            'https://mswjs.com/some/other/endpoint',
+          ),
+        }),
+      ).resolves.toEqual({
+        match: {
+          matches: false,
+          params: {},
+        },
+      })
+    })
+  })
+})
+
+describe('predicate', () => {
+  test('respects operation type', async () => {
+    const handler = new GraphQLHandler(
+      OperationTypeNode.QUERY,
+      'GetUser',
+      '*',
+      resolver,
+    )
+    const request = createPostGraphQLRequest({
+      query: GET_USER,
+    })
+    const alienRequest = createPostGraphQLRequest({
+      query: LOGIN,
+    })
+
+    expect(
+      handler.predicate({
+        request,
+        parsedResult: await handler.parse({ request }),
+      }),
+    ).toBe(true)
+    expect(
+      handler.predicate({
+        request: alienRequest,
+        parsedResult: await handler.parse({ request: alienRequest }),
+      }),
+    ).toBe(false)
+  })
+
+  test('respects operation name', async () => {
+    const handler = new GraphQLHandler(
+      OperationTypeNode.QUERY,
+      'GetUser',
+      '*',
+      resolver,
+    )
+    const request = createPostGraphQLRequest({
+      query: GET_USER,
+    })
+    const alienRequest = createPostGraphQLRequest({
+      query: `
+          query GetAllUsers {
+            user {
+              id
+            }
+          }
+        `,
+    })
+
+    expect(
+      handler.predicate({
+        request,
+        parsedResult: await handler.parse({ request }),
+      }),
+    ).toBe(true)
+    expect(
+      handler.predicate({
+        request: alienRequest,
+        parsedResult: await handler.parse({ request: alienRequest }),
+      }),
+    ).toBe(false)
+  })
+
+  test('allows anonymous GraphQL opertaions when using "all" expected operation type', async () => {
+    const handler = new GraphQLHandler('all', new RegExp('.*'), '*', resolver)
+    const request = createPostGraphQLRequest({
+      query: `
+        query {
+          anonymousQuery {
+            query
+            variables
+          }
+        }
+      `,
+    })
+
+    expect(
+      handler.predicate({
+        request,
+        parsedResult: await handler.parse({ request }),
+      }),
+    ).toBe(true)
+  })
+
+  test('respects custom endpoint', async () => {
+    const handler = new GraphQLHandler(
+      OperationTypeNode.QUERY,
+      'GetUser',
+      'https://api.github.com/graphql',
+      resolver,
+    )
+    const request = createPostGraphQLRequest(
+      {
+        query: GET_USER,
+      },
+      'https://api.github.com/graphql',
+    )
+    const alienRequest = createPostGraphQLRequest({
+      query: GET_USER,
+    })
+
+    expect(
+      handler.predicate({
+        request,
+        parsedResult: await handler.parse({ request }),
+      }),
+    ).toBe(true)
+    expect(
+      handler.predicate({
+        request: alienRequest,
+        parsedResult: await handler.parse({ request: alienRequest }),
+      }),
+    ).toBe(false)
+  })
+})
+
+describe('test', () => {
+  test('respects operation type', async () => {
+    const handler = new GraphQLHandler(
+      OperationTypeNode.QUERY,
+      'GetUser',
+      '*',
+      resolver,
+    )
+    const request = createPostGraphQLRequest({
+      query: GET_USER,
+    })
+    const alienRequest = createPostGraphQLRequest({
+      query: LOGIN,
+    })
+
+    expect(await handler.test({ request })).toBe(true)
+    expect(await handler.test({ request: alienRequest })).toBe(false)
+  })
+
+  test('respects operation name', async () => {
+    const handler = new GraphQLHandler(
+      OperationTypeNode.QUERY,
+      'GetUser',
+      '*',
+      resolver,
+    )
+    const request = createPostGraphQLRequest({
+      query: GET_USER,
+    })
+    const alienRequest = createPostGraphQLRequest({
+      query: `
+          query GetAllUsers {
+            user {
+              id
+            }
+          }
+        `,
+    })
+
+    expect(await handler.test({ request })).toBe(true)
+    expect(await handler.test({ request: alienRequest })).toBe(false)
+  })
+
+  test('respects custom endpoint', async () => {
+    const handler = new GraphQLHandler(
+      OperationTypeNode.QUERY,
+      'GetUser',
+      'https://api.github.com/graphql',
+      resolver,
+    )
+    const request = createPostGraphQLRequest(
+      {
+        query: GET_USER,
+      },
+      'https://api.github.com/graphql',
+    )
+    const alienRequest = createPostGraphQLRequest({
+      query: GET_USER,
+    })
+
+    expect(await handler.test({ request })).toBe(true)
+    expect(await handler.test({ request: alienRequest })).toBe(false)
+  })
+})
+
+describe('run', () => {
+  test('returns a mocked response given a matching query', async () => {
+    const handler = new GraphQLHandler(
+      OperationTypeNode.QUERY,
+      'GetUser',
+      '*',
+      resolver,
+    )
+    const request = createPostGraphQLRequest({
+      query: GET_USER,
+      variables: {
+        userId: 'abc-123',
+      },
+    })
+    const result = await handler.run({ request })
+
+    expect(result!.handler).toEqual(handler)
+    expect(result!.parsedResult).toEqual({
+      match: {
+        matches: true,
+        params: {
+          '0': 'https://example.com/',
+        },
+      },
+      operationType: 'query',
+      operationName: 'GetUser',
+      query: GET_USER,
+      variables: {
+        userId: 'abc-123',
+      },
+    })
+    expect(result!.request.method).toBe('POST')
+    expect(result!.request.url).toBe('https://example.com/')
+    expect(await result!.request.json()).toEqual({
+      query: GET_USER,
+      variables: { userId: 'abc-123' },
+    })
+    expect(result!.response?.status).toBe(200)
+    expect(result!.response?.statusText).toBe('OK')
+    expect(await result!.response?.json()).toEqual({
+      data: { user: { id: 'abc-123' } },
+    })
+  })
+
+  test('returns null given a non-matching query', async () => {
+    const handler = new GraphQLHandler(
+      OperationTypeNode.QUERY,
+      'GetUser',
+      '*',
+      resolver,
+    )
+    const request = createPostGraphQLRequest({
+      query: LOGIN,
+    })
+    const result = await handler.run({ request })
+
+    expect(result).toBeNull()
+  })
+})
+
+describe('isDocumentNode', () => {
+  it('returns true given a valid DocumentNode', () => {
+    const node = parse(`
+      query GetUser {
+        user {
+          login
+        }
+      }
+    `)
+
+    expect(isDocumentNode(node)).toEqual(true)
+  })
+
+  it('returns false given an arbitrary input', () => {
+    expect(isDocumentNode(null)).toEqual(false)
+    expect(isDocumentNode(undefined)).toEqual(false)
+    expect(isDocumentNode('')).toEqual(false)
+    expect(isDocumentNode('value')).toEqual(false)
+    expect(isDocumentNode(/value/)).toEqual(false)
+  })
+})
+
+describe('request', () => {
+  it('has parsed operationName', async () => {
+    const matchAllResolver = vi.fn()
+    const handler = new GraphQLHandler(
+      OperationTypeNode.QUERY,
+      /.*/,
+      '*',
+      matchAllResolver,
+    )
+    const request = createPostGraphQLRequest({
+      query: `
+          query GetAllUsers {
+            user {
+              id
+            }
+          }
+        `,
+    })
+
+    await handler.run({ request })
+
+    expect(matchAllResolver).toHaveBeenCalledTimes(1)
+    expect(matchAllResolver.mock.calls[0][0]).toHaveProperty(
+      'operationName',
+      'GetAllUsers',
+    )
+  })
+})