Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
613 lines
28 KiB
Plaintext
613 lines
28 KiB
Plaintext
"use strict";
|
|
/**
|
|
*
|
|
* audit/server
|
|
*
|
|
*/
|
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
exports.auditServer = exports.serverAudits = void 0;
|
|
const utils_1 = require("./utils");
|
|
/**
|
|
* List of server audits required to check GraphQL over HTTP spec conformance.
|
|
*
|
|
* @category Audits
|
|
*/
|
|
function serverAudits(opts) {
|
|
const fetchFn = (opts.fetchFn || fetch);
|
|
return [
|
|
// Media Types
|
|
(0, utils_1.audit)(
|
|
// TODO: convert to MUST after watershed
|
|
'22EB', 'SHOULD accept application/graphql-response+json and match the content-type', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/graphql-response+json',
|
|
},
|
|
body: JSON.stringify({ query: '{ __typename }' }),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
(0, utils_1.ressert)(res)
|
|
.header('content-type')
|
|
.toContain('application/graphql-response+json');
|
|
}),
|
|
(0, utils_1.audit)('4655', 'MUST accept application/json and match the content-type', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/json',
|
|
},
|
|
body: JSON.stringify({ query: '{ __typename }' }),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
(0, utils_1.ressert)(res).header('content-type').toContain('application/json');
|
|
}),
|
|
(0, utils_1.audit)('47DE', 'SHOULD accept */* and use application/json for the content-type', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: '*/*',
|
|
},
|
|
body: JSON.stringify({ query: '{ __typename }' }),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
(0, utils_1.ressert)(res).header('content-type').toContain('application/json');
|
|
}),
|
|
(0, utils_1.audit)('80D8', 'SHOULD assume application/json content-type when accept is missing', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
},
|
|
body: JSON.stringify({ query: '{ __typename }' }),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
(0, utils_1.ressert)(res).header('content-type').toContain('application/json');
|
|
}),
|
|
(0, utils_1.audit)('82A3', 'MUST use utf-8 encoding when responding', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
},
|
|
body: JSON.stringify({ query: '{ __typename }' }),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
try {
|
|
const decoder = new TextDecoder('utf-8');
|
|
decoder.decode(await res.arrayBuffer());
|
|
}
|
|
catch (_a) {
|
|
throw new utils_1.AuditError(res, 'Response body is not UTF-8 encoded');
|
|
}
|
|
}),
|
|
(0, utils_1.audit)('BF61', 'MUST accept utf-8 encoded request', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json; charset=utf-8',
|
|
},
|
|
body: JSON.stringify({
|
|
query: '{ __type(name: "Run🏃Swim🏊") { name } }',
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
}),
|
|
(0, utils_1.audit)('78D5', 'MUST assume utf-8 in request if encoding is unspecified', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
},
|
|
body: JSON.stringify({ query: '{ __typename }' }),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
}),
|
|
// Request
|
|
(0, utils_1.audit)('2C94', 'MUST accept POST requests', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: { 'content-type': 'application/json' },
|
|
body: JSON.stringify({ query: '{ __typename }' }),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
}),
|
|
(0, utils_1.audit)('5A70', 'MAY accept application/x-www-form-urlencoded formatted GET requests', async () => {
|
|
const url = new URL(await getUrl(opts.url));
|
|
url.searchParams.set('query', '{ __typename }');
|
|
const res = await fetchFn(url.toString());
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
}),
|
|
// Request GET
|
|
// TODO: this is a MUST if the server supports GET requests
|
|
(0, utils_1.audit)('9C48', 'MAY NOT allow executing mutations on GET requests', async () => {
|
|
const url = new URL(await getUrl(opts.url));
|
|
url.searchParams.set('query', 'mutation { __typename }');
|
|
const res = await fetchFn(url.toString(), {
|
|
headers: {
|
|
accept: 'application/graphql-response+json',
|
|
},
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBeBetween(400, 499);
|
|
}),
|
|
// Request POST
|
|
(0, utils_1.audit)('9ABE', 'MAY respond with 4xx status code if content-type is not supplied on POST requests', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBeBetween(400, 499);
|
|
}),
|
|
(0, utils_1.audit)('03D4', 'MUST accept application/json POST requests', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: { 'content-type': 'application/json' },
|
|
body: JSON.stringify({ query: '{ __typename }' }),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
}),
|
|
(0, utils_1.audit)('A5BF', 'MAY use 400 status code when request body is missing on POST', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: { 'content-type': 'application/json' },
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(400);
|
|
}),
|
|
// Request Parameters
|
|
(0, utils_1.audit)('423L', 'MAY use 400 status code on missing {query} parameter', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/graphql-response+json',
|
|
},
|
|
body: JSON.stringify({ notquery: '{ __typename }' }),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(400);
|
|
}),
|
|
...[{ obj: 'ect' }, 0, false, ['array']].map((invalid, index) => (0, utils_1.audit)(`LKJ${index}`, `MAY use 400 status code on ${(0, utils_1.extendedTypeof)(invalid)} {query} parameter`, async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
},
|
|
body: JSON.stringify({
|
|
query: invalid,
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(400);
|
|
})),
|
|
(0, utils_1.audit)(
|
|
// TODO: convert to MUST after watershed
|
|
'34A2', 'SHOULD allow string {query} parameter when accepting application/graphql-response+json', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/graphql-response+json',
|
|
},
|
|
body: JSON.stringify({
|
|
query: '{ __typename }',
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
}),
|
|
(0, utils_1.audit)('13EE', 'MUST allow string {query} parameter when accepting application/json', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/json',
|
|
},
|
|
body: JSON.stringify({
|
|
query: '{ __typename }',
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
await (0, utils_1.ressert)(res).bodyAsExecutionResult.notToHaveProperty('errors');
|
|
}),
|
|
...[{ obj: 'ect' }, 0, false, ['array']].map((invalid, index) => (0, utils_1.audit)(`6C0${index}`, `MAY use 400 status code on ${(0, utils_1.extendedTypeof)(invalid)} {operationName} parameter`, async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
},
|
|
body: JSON.stringify({
|
|
operationName: invalid,
|
|
query: '{ __typename }',
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(400);
|
|
})),
|
|
(0, utils_1.audit)(
|
|
// TODO: convert to MUST after watershed
|
|
'8161', 'SHOULD allow string {operationName} parameter when accepting application/graphql-response+json', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/graphql-response+json',
|
|
},
|
|
body: JSON.stringify({
|
|
operationName: 'Query',
|
|
query: 'query Query { __typename }',
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
}),
|
|
(0, utils_1.audit)('B8B3', 'MUST allow string {operationName} parameter when accepting application/json', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/json',
|
|
},
|
|
body: JSON.stringify({
|
|
operationName: 'Query',
|
|
query: 'query Query { __typename }',
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
await (0, utils_1.ressert)(res).bodyAsExecutionResult.notToHaveProperty('errors');
|
|
}),
|
|
...['variables', 'operationName', 'extensions'].flatMap((parameter, index) => [
|
|
(0, utils_1.audit)(`94B${index}`,
|
|
// TODO: convert to MUST after watershed
|
|
`SHOULD allow null {${parameter}} parameter when accepting application/graphql-response+json`, async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/graphql-response+json',
|
|
},
|
|
body: JSON.stringify({
|
|
query: '{ __typename }',
|
|
[parameter]: null,
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
await (0, utils_1.ressert)(res).bodyAsExecutionResult.notToHaveProperty('errors');
|
|
}),
|
|
(0, utils_1.audit)(`022${index}`, `MUST allow null {${parameter}} parameter when accepting application/json`, async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/json',
|
|
},
|
|
body: JSON.stringify({
|
|
query: '{ __typename }',
|
|
[parameter]: null,
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
await (0, utils_1.ressert)(res).bodyAsExecutionResult.notToHaveProperty('errors');
|
|
}),
|
|
]),
|
|
...['string', 0, false, ['array']].map((invalid, index) => (0, utils_1.audit)(`476${index}`, `MAY use 400 status code on ${(0, utils_1.extendedTypeof)(invalid)} {variables} parameter`, async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
},
|
|
body: JSON.stringify({
|
|
query: '{ __typename }',
|
|
variables: invalid,
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(400);
|
|
})),
|
|
(0, utils_1.audit)(
|
|
// TODO: convert to MUST after watershed
|
|
'2EA1', 'SHOULD allow map {variables} parameter when accepting application/graphql-response+json', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/graphql-response+json',
|
|
},
|
|
body: JSON.stringify({
|
|
query: 'query Type($name: String!) { __type(name: $name) { name } }',
|
|
variables: { name: 'sometype' },
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
}),
|
|
(0, utils_1.audit)('28B9', 'MUST allow map {variables} parameter when accepting application/json', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/json',
|
|
},
|
|
body: JSON.stringify({
|
|
query: 'query Type($name: String!) { __type(name: $name) { name } }',
|
|
variables: { name: 'sometype' },
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
await (0, utils_1.ressert)(res).bodyAsExecutionResult.notToHaveProperty('errors');
|
|
}),
|
|
(0, utils_1.audit)('D6D5', 'MAY allow URL-encoded JSON string {variables} parameter in GETs when accepting application/graphql-response+json', async () => {
|
|
const url = new URL(await getUrl(opts.url));
|
|
url.searchParams.set('query', 'query Type($name: String!) { __type(name: $name) { name } }');
|
|
url.searchParams.set('variables', JSON.stringify({ name: 'sometype' }));
|
|
const res = await fetchFn(url.toString(), {
|
|
method: 'GET',
|
|
headers: {
|
|
accept: 'application/graphql-response+json',
|
|
},
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
}),
|
|
(0, utils_1.audit)('6A70', 'MAY allow URL-encoded JSON string {variables} parameter in GETs when accepting application/json', async () => {
|
|
const url = new URL(await getUrl(opts.url));
|
|
url.searchParams.set('query', 'query Type($name: String!) { __type(name: $name) { name } }');
|
|
url.searchParams.set('variables', JSON.stringify({ name: 'sometype' }));
|
|
const res = await fetchFn(url.toString(), {
|
|
method: 'GET',
|
|
headers: {
|
|
accept: 'application/json',
|
|
},
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
await (0, utils_1.ressert)(res).bodyAsExecutionResult.notToHaveProperty('errors');
|
|
}),
|
|
...['string', 0, false, ['array']].map((invalid, index) => (0, utils_1.audit)(`58B${index}`,
|
|
// TODO: convert to MUST after watershed
|
|
`MAY use 400 status code on ${(0, utils_1.extendedTypeof)(invalid)} {extensions} parameter`, async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
},
|
|
body: JSON.stringify({
|
|
query: '{ __typename }',
|
|
extensions: invalid,
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(400);
|
|
})),
|
|
(0, utils_1.audit)(
|
|
// TODO: convert to MUST after watershed
|
|
'428F', 'SHOULD allow map {extensions} parameter when accepting application/graphql-response+json', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/graphql-response+json',
|
|
},
|
|
body: JSON.stringify({
|
|
query: '{ __typename }',
|
|
extensions: { some: 'value' },
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
}),
|
|
(0, utils_1.audit)('1B7A', 'MUST allow map {extensions} parameter when accepting application/json', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/json',
|
|
},
|
|
body: JSON.stringify({
|
|
query: '{ __typename }',
|
|
extensions: { some: 'value' },
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
await (0, utils_1.ressert)(res).bodyAsExecutionResult.notToHaveProperty('errors');
|
|
}),
|
|
(0, utils_1.audit)('B6DC', 'MAY use 4xx or 5xx status codes on JSON parsing failure', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
},
|
|
body: '{ "not a JSON',
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBeBetween(400, 499);
|
|
}),
|
|
(0, utils_1.audit)('BCF8', 'MAY use 400 status code on JSON parsing failure', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
},
|
|
body: '{ "not a JSON',
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(400);
|
|
}),
|
|
(0, utils_1.audit)('8764', 'MAY use 4xx or 5xx status codes if parameters are invalid', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
},
|
|
body: JSON.stringify({
|
|
qeury /* typo */: '{ __typename }',
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBeBetween(400, 599);
|
|
}),
|
|
(0, utils_1.audit)('3E3A', 'MAY use 400 status code if parameters are invalid', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
},
|
|
body: JSON.stringify({
|
|
qeury: /* typo */ '{ __typename }',
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(400);
|
|
}),
|
|
// TODO: audit('39AA', 'MUST accept a map for the {extensions} parameter'),
|
|
// Response application/json
|
|
(0, utils_1.audit)('572B', 'SHOULD use 200 status code on document parsing failure when accepting application/json', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/json',
|
|
},
|
|
body: JSON.stringify({ query: '{' }),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
}),
|
|
(0, utils_1.audit)('FDE2', 'SHOULD use 200 status code on document validation failure when accepting application/json', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/json',
|
|
},
|
|
body: JSON.stringify({
|
|
query: '{ 8f31403dfe404bccbb0e835f2629c6a7 }', // making sure the field doesnt exist
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
}),
|
|
(0, utils_1.audit)('7B9B', 'SHOULD use a status code of 200 on variable coercion failure when accepting application/json', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/json',
|
|
},
|
|
body: JSON.stringify({
|
|
query: 'query CoerceFailure($id: ID!){ __typename }',
|
|
variables: { id: null },
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(200);
|
|
}),
|
|
// Response application/graphql-response+json
|
|
(0, utils_1.audit)(
|
|
// TODO: convert to MUST after watershed
|
|
'865D', 'SHOULD use 4xx or 5xx status codes on document parsing failure when accepting application/graphql-response+json', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/graphql-response+json',
|
|
},
|
|
body: JSON.stringify({
|
|
query: '{',
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBeBetween(400, 599);
|
|
}),
|
|
(0, utils_1.audit)('556A', 'SHOULD use 400 status code on document parsing failure when accepting application/graphql-response+json', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/graphql-response+json',
|
|
},
|
|
body: JSON.stringify({
|
|
query: '{',
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(400);
|
|
}),
|
|
(0, utils_1.audit)('D586', 'SHOULD not contain the data entry on document parsing failure when accepting application/graphql-response+json', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/graphql-response+json',
|
|
},
|
|
body: JSON.stringify({
|
|
query: '{',
|
|
}),
|
|
});
|
|
await (0, utils_1.ressert)(res).bodyAsExecutionResult.data.toBe(undefined);
|
|
}),
|
|
(0, utils_1.audit)(
|
|
// TODO: convert to MUST after watershed
|
|
'51FE', 'SHOULD use 4xx or 5xx status codes on document validation failure when accepting application/graphql-response+json', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/graphql-response+json',
|
|
},
|
|
body: JSON.stringify({
|
|
query: '{ 8f31403dfe404bccbb0e835f2629c6a7 }', // making sure the field doesnt exist
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBeBetween(400, 599);
|
|
}),
|
|
(0, utils_1.audit)('74FF', 'SHOULD use 400 status code on document validation failure when accepting application/graphql-response+json', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/graphql-response+json',
|
|
},
|
|
body: JSON.stringify({
|
|
query: '{ 8f31403dfe404bccbb0e835f2629c6a7 }', // making sure the field doesnt exist
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(400);
|
|
}),
|
|
(0, utils_1.audit)('5E5B', 'SHOULD not contain the data entry on document validation failure when accepting application/graphql-response+json', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/graphql-response+json',
|
|
},
|
|
body: JSON.stringify({
|
|
query: '{ 8f31403dfe404bccbb0e835f2629c6a7 }', // making sure the field doesnt exist
|
|
}),
|
|
});
|
|
await (0, utils_1.ressert)(res).bodyAsExecutionResult.data.toBe(undefined);
|
|
}),
|
|
(0, utils_1.audit)('86EE', 'SHOULD use a status code of 400 on variable coercion failure when accepting application/graphql-response+json', async () => {
|
|
const res = await fetchFn(await getUrl(opts.url), {
|
|
method: 'POST',
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
accept: 'application/graphql-response+json',
|
|
},
|
|
body: JSON.stringify({
|
|
query: 'query CoerceFailure($id: ID!){ __typename }',
|
|
variables: { id: null },
|
|
}),
|
|
});
|
|
(0, utils_1.ressert)(res).status.toBe(400);
|
|
}),
|
|
// TODO: how to fail and have the data entry?
|
|
// audit('EE52', 'MUST use 2xx status code if response contains the data entry and it is not null when accepting application/graphql-response+json'),
|
|
// TODO: how to make an unauthorized request?
|
|
// https://graphql.github.io/graphql-over-http/draft/#sel-EANNNDTAAEVBAAqqc
|
|
// audit('BC58', 'SHOULD use 401 or 403 status codes when the request is not permitted')
|
|
];
|
|
}
|
|
exports.serverAudits = serverAudits;
|
|
/**
|
|
* Performs the full list of server audits required for GraphQL over HTTP spec conformance.
|
|
*
|
|
* Please consult the `AuditResult` for more information.
|
|
*
|
|
* @category Audits
|
|
*/
|
|
async function auditServer(opts) {
|
|
const audits = serverAudits(opts);
|
|
// audit tests will throw only on fatal errors, tests are contained within the AuditResult
|
|
return await Promise.all(audits.map(({ fn }) => fn()));
|
|
}
|
|
exports.auditServer = auditServer;
|
|
/** @private */
|
|
async function getUrl(url) {
|
|
if (typeof url === 'function') {
|
|
return await url();
|
|
}
|
|
return url;
|
|
}
|