Skip to content

fix(handler): Don't export makeResponse, getAcceptableMediaType or isResponse #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 6, 2023
Merged

fix(handler): Don't export makeResponse, getAcceptableMediaType or isResponse #98

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cb9dd8b
unexport makeResponse and getAcceptableMediaType
enisdenjo Jul 5, 2023
b87a4ef
gendocs
enisdenjo Jul 5, 2023
cc25948
unexport isResponse too
enisdenjo Jul 6, 2023
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
unexport makeResponse and getAcceptableMediaType
  • Loading branch information
@enisdenjo
enisdenjo committed Jul 6, 2023
commit cb9dd8ba94cf48afe6b33ecb80c27abbf62363cc
86 changes: 34 additions & 52 deletions src/handler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -437,7 +437,37 @@ export function createHandler<
];
}

const acceptedMediaType = getAcceptableMediaType(getHeader(req, 'accept'));
let acceptedMediaType: AcceptableMediaType | null = null;
const accepts = (getHeader(req, 'accept') || '*/*')
.replace(/\s/g, '')
.toLowerCase()
.split(',');
for (const accept of accepts) {
// accept-charset became obsolete, shouldnt be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Charset)
// TODO: handle the weight parameter "q"
const [mediaType, ...params] = accept.split(';');
const charset =
params?.find((param) => param.includes('charset=')) || 'charset=utf8'; // utf-8 is assumed when not specified;

if (
mediaType === 'application/graphql-response+json' &&
charset === 'charset=utf8'
) {
acceptedMediaType = 'application/graphql-response+json';
break;
}

// application/json should be the default until watershed
if (
(mediaType === 'application/json' ||
mediaType === 'application/*' ||
mediaType === '*/*') &&
charset === 'charset=utf8'
) {
acceptedMediaType = 'application/json';
break;
}
}
if (!acceptedMediaType) {
return [
null,
Expand Down Expand Up @@ -670,57 +700,11 @@ export function createHandler<
};
}

/**
* Request's Media-Type that the server accepts.
*
* @category Server
*/
export type AcceptableMediaType =
/** Request's Media-Type that the server accepted. */
type AcceptableMediaType =
| 'application/graphql-response+json'
| 'application/json';

/**
* Inspects the request and detects the appropriate/acceptable Media-Type
* looking at the `Accept` header while complying with the GraphQL over HTTP spec.
*
* @category Server
*/
export function getAcceptableMediaType(
acceptHeader: string | null | undefined,
): AcceptableMediaType | null {
let acceptedMediaType: AcceptableMediaType | null = null;
const accepts = (acceptHeader || '*/*')
.replace(/\s/g, '')
.toLowerCase()
.split(',');
for (const accept of accepts) {
// accept-charset became obsolete, shouldnt be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Charset)
// TODO: handle the weight parameter "q"
const [mediaType, ...params] = accept.split(';');
const charset =
params?.find((param) => param.includes('charset=')) || 'charset=utf8'; // utf-8 is assumed when not specified;

if (
mediaType === 'application/graphql-response+json' &&
charset === 'charset=utf8'
) {
acceptedMediaType = 'application/graphql-response+json';
break;
}

if (
(mediaType === 'application/json' ||
mediaType === 'application/*' ||
mediaType === '*/*') &&
charset === 'charset=utf8'
) {
acceptedMediaType = 'application/json';
break;
}
}
return acceptedMediaType;
}

/**
* Creates an appropriate GraphQL over HTTP response following the provided arguments.
*
Expand All @@ -731,10 +715,8 @@ export function getAcceptableMediaType(
*
* If the first argument is an `Error`, the operation will be treated as a bad request responding with `400: Bad Request` and the
* error will be present in the `ExecutionResult` style.
*
* @category Server
*/
export function makeResponse(
function makeResponse(
resultOrErrors:
| Readonly<ExecutionResult>
| Readonly<GraphQLError[]>
Expand Down