graphql-yoga
Version:
436 lines (435 loc) • 18.3 kB
JavaScript
import { print, parse, validate, specifiedRules, } from 'graphql';
import { normalizedExecutor } from '@graphql-tools/executor';
import { envelop, useEngine, useExtendContext, useLogger, useMaskedErrors, } from '@envelop/core';
import { useValidationCache } from '@envelop/validation-cache';
import { useParserCache } from '@envelop/parser-cache';
import { createFetch } from '@whatwg-node/fetch';
import { createServerAdapter } from '@whatwg-node/server';
import { processRequest as processGraphQLParams, processResult, } from './process-request.js';
import { defaultYogaLogger, titleBold } from './logger.js';
import { useCORS } from './plugins/useCORS.js';
import { useHealthCheck } from './plugins/useHealthCheck.js';
import { useGraphiQL, } from './plugins/useGraphiQL.js';
import { useRequestParser } from './plugins/useRequestParser.js';
import { isGETRequest, parseGETRequest } from './plugins/requestParser/GET.js';
import { isPOSTJsonRequest, parsePOSTJsonRequest, } from './plugins/requestParser/POSTJson.js';
import { isPOSTMultipartRequest, parsePOSTMultipartRequest, } from './plugins/requestParser/POSTMultipart.js';
import { isPOSTGraphQLStringRequest, parsePOSTGraphQLStringRequest, } from './plugins/requestParser/POSTGraphQLString.js';
import { useResultProcessor } from './plugins/useResultProcessor.js';
import { processRegularResult } from './plugins/resultProcessor/regular.js';
import { processPushResult } from './plugins/resultProcessor/push.js';
import { processMultipartResult } from './plugins/resultProcessor/multipart.js';
import { isPOSTFormUrlEncodedRequest, parsePOSTFormUrlEncodedRequest, } from './plugins/requestParser/POSTFormUrlEncoded.js';
import { handleError } from './error.js';
import { useCheckMethodForGraphQL } from './plugins/requestValidation/useCheckMethodForGraphQL.js';
import { useCheckGraphQLQueryParams } from './plugins/requestValidation/useCheckGraphQLQueryParams.js';
import { useHTTPValidationError } from './plugins/requestValidation/useHTTPValidationError.js';
import { usePreventMutationViaGET } from './plugins/requestValidation/usePreventMutationViaGET.js';
import { useUnhandledRoute } from './plugins/useUnhandledRoute.js';
import { yogaDefaultFormatError } from './utils/yoga-default-format-error.js';
import { useSchema } from './plugins/useSchema.js';
import { useLimitBatching } from './plugins/requestValidation/useLimitBatching.js';
import { OverlappingFieldsCanBeMergedRule } from './validations/overlapping-fields-can-be-merged.js';
import { DeferStreamDirectiveOnRootFieldRule } from './validations/defer-stream-directive-on-root-field.js';
import { DeferStreamDirectiveLabelRule } from './validations/defer-stream-directive-label.js';
import { StreamDirectiveOnListFieldRule } from './validations/stream-directive-on-list-field.js';
/**
* Base class that can be extended to create a GraphQL server with any HTTP server framework.
* @internal
*/
export class YogaServer {
constructor(options) {
this.handle = async (request, serverContext) => {
try {
const response = await this.getResponse(request, serverContext);
for (const onResponseHook of this.onResponseHooks) {
await onResponseHook({
request,
response,
serverContext,
});
}
return response;
}
catch (e) {
this.logger.error(e);
return new this.fetchAPI.Response('Internal Server Error', {
status: 500,
});
}
};
this.id = options?.id ?? 'yoga';
this.fetchAPI =
options?.fetchAPI ??
createFetch({
useNodeFetch: true,
});
const logger = options?.logging != null ? options.logging : true;
this.logger =
typeof logger === 'boolean'
? logger === true
? defaultYogaLogger
: {
/* eslint-disable */
debug: () => { },
error: () => { },
warn: () => { },
info: () => { },
/* eslint-enable */
}
: logger;
this.maskedErrorsOpts =
options?.maskedErrors === false
? null
: {
maskError: (error, message) => yogaDefaultFormatError({
error,
message,
isDev: this.maskedErrorsOpts?.isDev ?? false,
}),
errorMessage: 'Unexpected error.',
...(typeof options?.maskedErrors === 'object'
? options.maskedErrors
: {}),
};
const maskedErrors = this.maskedErrorsOpts != null ? this.maskedErrorsOpts : null;
let batchingLimit = 0;
if (options?.batching) {
if (typeof options.batching === 'boolean') {
batchingLimit = 10;
}
else {
batchingLimit = options.batching.limit ?? 10;
}
}
this.graphqlEndpoint = options?.graphqlEndpoint || '/graphql';
const graphqlEndpoint = this.graphqlEndpoint;
this.plugins = [
useEngine({
parse,
validate,
execute: normalizedExecutor,
subscribe: normalizedExecutor,
specifiedRules: [
...specifiedRules.filter(
// We do not want to use the default one cause it does not account for `@defer` and `@stream`
({ name }) => !['OverlappingFieldsCanBeMergedRule'].includes(name)),
OverlappingFieldsCanBeMergedRule,
DeferStreamDirectiveOnRootFieldRule,
DeferStreamDirectiveLabelRule,
StreamDirectiveOnListFieldRule,
],
}),
// Use the schema provided by the user
!!options?.schema && useSchema(options.schema),
// Performance things
options?.parserCache !== false &&
useParserCache(typeof options?.parserCache === 'object'
? options.parserCache
: undefined),
options?.validationCache !== false &&
useValidationCache({
cache: typeof options?.validationCache === 'object'
? options.validationCache
: undefined,
}),
// Log events - useful for debugging purposes
logger !== false &&
useLogger({
skipIntrospection: true,
logFn: (eventName, events) => {
switch (eventName) {
case 'execute-start':
case 'subscribe-start':
this.logger.debug(titleBold('Execution start'));
// eslint-disable-next-line no-case-declarations
const {
// the `params` might be missing in cases where the user provided
// malformed context to getEnveloped (like `yoga.getEnveloped({})`)
params: { query, operationName, variables, extensions } = {}, } = events.args.contextValue;
this.logger.debug(titleBold('Received GraphQL operation:'));
this.logger.debug({
query,
operationName,
variables,
extensions,
});
break;
case 'execute-end':
case 'subscribe-end':
this.logger.debug(titleBold('Execution end'));
this.logger.debug({
result: events.result,
});
break;
}
},
}),
options?.context != null &&
useExtendContext((initialContext) => {
if (options?.context) {
if (typeof options.context === 'function') {
return options.context(initialContext);
}
return options.context;
}
return {};
}),
// Middlewares before processing the incoming HTTP request
useHealthCheck({
id: this.id,
logger: this.logger,
endpoint: options?.healthCheckEndpoint,
}),
options?.cors !== false && useCORS(options?.cors),
options?.graphiql !== false &&
useGraphiQL({
graphqlEndpoint: this.graphqlEndpoint,
options: options?.graphiql,
render: options?.renderGraphiQL,
logger: this.logger,
}),
// Middlewares before the GraphQL execution
useCheckMethodForGraphQL(),
useRequestParser({
match: isGETRequest,
parse: parseGETRequest,
}),
useRequestParser({
match: isPOSTJsonRequest,
parse: parsePOSTJsonRequest,
}),
options?.multipart !== false &&
useRequestParser({
match: isPOSTMultipartRequest,
parse: parsePOSTMultipartRequest,
}),
useRequestParser({
match: isPOSTGraphQLStringRequest,
parse: parsePOSTGraphQLStringRequest,
}),
useRequestParser({
match: isPOSTFormUrlEncodedRequest,
parse: parsePOSTFormUrlEncodedRequest,
}),
// Middlewares after the GraphQL execution
useResultProcessor({
mediaTypes: ['multipart/mixed'],
processResult: processMultipartResult,
}),
useResultProcessor({
mediaTypes: ['text/event-stream'],
processResult: processPushResult,
}),
useResultProcessor({
mediaTypes: ['application/graphql-response+json', 'application/json'],
processResult: processRegularResult,
}),
...(options?.plugins ?? []),
useLimitBatching(batchingLimit),
useCheckGraphQLQueryParams(),
useUnhandledRoute({
graphqlEndpoint,
showLandingPage: options?.landingPage ?? true,
}),
// We make sure that the user doesn't send a mutation with GET
usePreventMutationViaGET(),
// To make sure those are called at the end
{
onPluginInit({ addPlugin }) {
if (maskedErrors) {
addPlugin(useMaskedErrors(maskedErrors));
}
addPlugin(
// We handle validation errors at the end
useHTTPValidationError());
},
},
];
this.getEnveloped = envelop({
plugins: this.plugins,
});
this.onRequestHooks = [];
this.onRequestParseHooks = [];
this.onParamsHooks = [];
this.onResultProcessHooks = [];
this.onResponseHooks = [];
for (const plugin of this.plugins) {
if (plugin) {
if (plugin.onRequest) {
this.onRequestHooks.push(plugin.onRequest);
}
if (plugin.onRequestParse) {
this.onRequestParseHooks.push(plugin.onRequestParse);
}
if (plugin.onParams) {
this.onParamsHooks.push(plugin.onParams);
}
if (plugin.onResultProcess) {
this.onResultProcessHooks.push(plugin.onResultProcess);
}
if (plugin.onResponse) {
this.onResponseHooks.push(plugin.onResponse);
}
}
}
}
async getResultForParams({ params, request, },
// eslint-disable-next-line @typescript-eslint/ban-types
...args) {
try {
let result;
for (const onParamsHook of this.onParamsHooks) {
await onParamsHook({
params,
request,
setParams(newParams) {
params = newParams;
},
setResult(newResult) {
result = newResult;
},
fetchAPI: this.fetchAPI,
});
}
if (result == null) {
const serverContext = args[0];
const initialContext = {
...serverContext,
request,
params,
};
const enveloped = this.getEnveloped(initialContext);
this.logger.debug(`Processing GraphQL Parameters`);
result = await processGraphQLParams({
params,
enveloped,
});
}
return result;
}
catch (error) {
const errors = handleError(error, this.maskedErrorsOpts);
const result = {
errors,
};
return result;
}
}
async getResponse(request, serverContext) {
const url = new URL(request.url, 'http://localhost');
for (const onRequestHook of this.onRequestHooks) {
let response;
await onRequestHook({
request,
serverContext,
fetchAPI: this.fetchAPI,
url,
endResponse(newResponse) {
response = newResponse;
},
});
if (response) {
return response;
}
}
let requestParser;
const onRequestParseDoneList = [];
let result;
try {
for (const onRequestParse of this.onRequestParseHooks) {
const onRequestParseResult = await onRequestParse({
request,
requestParser,
serverContext,
setRequestParser(parser) {
requestParser = parser;
},
});
if (onRequestParseResult?.onRequestParseDone != null) {
onRequestParseDoneList.push(onRequestParseResult.onRequestParseDone);
}
}
this.logger.debug(`Parsing request to extract GraphQL parameters`);
if (!requestParser) {
return new this.fetchAPI.Response('Request is not valid', {
status: 400,
statusText: 'Bad Request',
});
}
let requestParserResult = await requestParser(request);
for (const onRequestParseDone of onRequestParseDoneList) {
await onRequestParseDone({
requestParserResult,
setRequestParserResult(newParams) {
requestParserResult = newParams;
},
});
}
result = (await (Array.isArray(requestParserResult)
? Promise.all(requestParserResult.map((params) => this.getResultForParams({
params,
request,
}, serverContext)))
: this.getResultForParams({
params: requestParserResult,
request,
}, serverContext)));
}
catch (error) {
const errors = handleError(error, this.maskedErrorsOpts);
result = {
errors,
};
}
const response = await processResult({
request,
result,
fetchAPI: this.fetchAPI,
onResultProcessHooks: this.onResultProcessHooks,
});
return response;
}
/**
* Testing utility to mock http request for GraphQL endpoint
*
*
* Example - Test a simple query
* ```ts
* const { response, executionResult } = await yoga.inject({
* document: "query { ping }",
* })
* expect(response.status).toBe(200)
* expect(executionResult.data.ping).toBe('pong')
* ```
**/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
async inject({ document, variables, operationName, headers, serverContext, }) {
const request = new this.fetchAPI.Request('http://localhost' + this.graphqlEndpoint, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
...headers,
},
body: JSON.stringify({
query: document &&
(typeof document === 'string' ? document : print(document)),
variables,
operationName,
}),
});
const response = await this.handle(request, serverContext);
let executionResult = null;
if (response.headers.get('content-type') === 'application/json') {
executionResult = await response.json();
}
return {
response,
executionResult,
};
}
}
export function createYoga(options) {
const server = new YogaServer(options);
return createServerAdapter(server, server.fetchAPI.Request);
}