graphql-http 1.3.0 → 1.6.0

package/lib/audits/server.js

@@ -0,0 +1,440 @@
+"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)('MUST accept application/graphql-response+json and match the content-type', async () => {
+            const url = new URL(opts.url);
+            url.searchParams.set('query', '{ __typename }');
+            const res = await fetchFn(url.toString(), {
+                headers: {
+                    accept: 'application/graphql-response+json',
+                },
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+            (0, utils_1.assert)('Content-Type header', res.headers.get('content-type')).toContain('application/graphql-response+json');
+        }),
+        (0, utils_1.audit)('MUST accept application/json and match the content-type', async () => {
+            const url = new URL(opts.url);
+            url.searchParams.set('query', '{ __typename }');
+            const res = await fetchFn(url.toString(), {
+                headers: {
+                    accept: 'application/json',
+                },
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+            (0, utils_1.assert)('Content-Type header', res.headers.get('content-type')).toContain('application/json');
+        }),
+        (0, utils_1.audit)('MUST accept */* and use application/graphql-response+json for the content-type', async () => {
+            const url = new URL(opts.url);
+            url.searchParams.set('query', '{ __typename }');
+            const res = await fetchFn(url.toString(), {
+                headers: {
+                    accept: '*/*',
+                },
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+            (0, utils_1.assert)('Content-Type header', res.headers.get('content-type')).toContain('application/graphql-response+json');
+        }),
+        (0, utils_1.audit)('MUST assume application/graphql-response+json content-type when accept is missing', async () => {
+            const url = new URL(opts.url);
+            url.searchParams.set('query', '{ __typename }');
+            const res = await fetchFn(url.toString());
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+            (0, utils_1.assert)('Content-Type header', res.headers.get('content-type')).toContain('application/graphql-response+json');
+        }),
+        (0, utils_1.audit)('MUST use utf-8 charset in response', async () => {
+            const url = new URL(opts.url);
+            url.searchParams.set('query', '{ __typename }');
+            const res = await fetchFn(url.toString());
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+            (0, utils_1.assert)('Content-Type header', res.headers.get('content-type')).toContain('charset=utf-8');
+        }),
+        (0, utils_1.audit)('MUST accept only utf-8 charset', async () => {
+            const url = new URL(opts.url);
+            url.searchParams.set('query', '{ __typename }');
+            const res = await fetchFn(url.toString(), {
+                headers: {
+                    accept: 'application/graphql-response+json; charset=iso-8859-1',
+                },
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(406);
+            (0, utils_1.assert)('Accept header', res.headers.get('accept')).toContain('charset=utf-8');
+        }),
+        // Request
+        (0, utils_1.audit)('MUST accept POST requests', async () => {
+            const res = await fetchFn(opts.url, {
+                method: 'POST',
+                headers: { 'content-type': 'application/json' },
+                body: JSON.stringify({ query: '{ __typename }' }),
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+        }),
+        (0, utils_1.audit)('MAY accept application/x-www-form-urlencoded formatted GET requests', async () => {
+            const url = new URL(opts.url);
+            url.searchParams.set('query', '{ __typename }');
+            const res = await fetchFn(url.toString());
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+        }),
+        // Request GET
+        (0, utils_1.audit)('MUST NOT allow executing mutations on GET requests', async () => {
+            const url = new URL(opts.url);
+            url.searchParams.set('query', 'mutation { __typename }');
+            const res = await fetchFn(url.toString(), {
+                headers: {
+                    accept: 'application/graphql-response+json',
+                },
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(405);
+        }),
+        // Request POST
+        (0, utils_1.audit)('SHOULD respond with 4xx status code if content-type is not supplied on POST requests', async () => {
+            const res = await fetchFn(opts.url, {
+                method: 'POST',
+            });
+            (0, utils_1.assert)('Status code', res.status).toBeGreaterThanOrEqual(400);
+            (0, utils_1.assert)('Status code', res.status).toBeLessThanOrEqual(599);
+        }),
+        (0, utils_1.audit)('MUST accept application/json POST requests', async () => {
+            const res = await fetchFn(opts.url, {
+                method: 'POST',
+                headers: { 'content-type': 'application/json' },
+                body: JSON.stringify({ query: '{ __typename }' }),
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+        }),
+        (0, utils_1.audit)('MUST require a request body on POST', async () => {
+            const res = await fetchFn(opts.url, {
+                method: 'POST',
+                headers: { 'content-type': 'application/json' },
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(400);
+        }),
+        // Request Parameters
+        (0, utils_1.audit)('MUST require the {query} parameter', async () => {
+            const res = await fetchFn(opts.url, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json',
+                    accept: 'application/graphql-response+json',
+                },
+                body: JSON.stringify({ notquery: '{ __typename }' }),
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(400);
+        }),
+        ...[{ obj: 'ect' }, 0, false, ['array']].map((invalid) => (0, utils_1.audit)(`MUST NOT allow ${(0, utils_1.extendedTypeof)(invalid)} for the {query} parameter`, async () => {
+            const res = await fetchFn(opts.url, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json',
+                    accept: 'application/graphql-response+json',
+                },
+                body: JSON.stringify({
+                    query: invalid,
+                }),
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(400);
+        })),
+        (0, utils_1.audit)('MUST accept a string for the {query} parameter', async () => {
+            const res = await fetchFn(opts.url, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json',
+                    accept: 'application/graphql-response+json',
+                },
+                body: JSON.stringify({
+                    query: '{ __typename }',
+                }),
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+        }),
+        ...[{ obj: 'ect' }, 0, false, ['array']].map((invalid) => (0, utils_1.audit)(`MUST NOT allow ${(0, utils_1.extendedTypeof)(invalid)} for the {operationName} parameter`, async () => {
+            const res = await fetchFn(opts.url, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json',
+                    accept: 'application/graphql-response+json',
+                },
+                body: JSON.stringify({
+                    operationName: invalid,
+                    query: '{ __typename }',
+                }),
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(400);
+        })),
+        (0, utils_1.audit)('MUST accept a string for the {operationName} parameter', async () => {
+            const res = await fetchFn(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.assert)('Status code', res.status).toBe(200);
+        }),
+        ...['string', 0, false, ['array']].map((invalid) => (0, utils_1.audit)(`MUST NOT allow ${(0, utils_1.extendedTypeof)(invalid)} for the {variables} parameter`, async () => {
+            const res = await fetchFn(opts.url, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json',
+                    accept: 'application/graphql-response+json',
+                },
+                body: JSON.stringify({
+                    query: '{ __typename }',
+                    variables: invalid,
+                }),
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(400);
+        })),
+        (0, utils_1.audit)('MUST accept a map for the {variables} parameter', async () => {
+            const res = await fetchFn(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.assert)('Status code', res.status).toBe(200);
+            const result = (await res.json());
+            (0, utils_1.assert)('Execution result', result).notToHaveProperty('errors');
+        }),
+        (0, utils_1.audit)('MUST accept a URL-encoded JSON string for the {variables} parameter in GETs', async () => {
+            const url = new URL(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',
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+            const result = (await res.json());
+            (0, utils_1.assert)('Execution result', result).notToHaveProperty('errors');
+        }),
+        ...['string', 0, false, ['array']].map((invalid) => (0, utils_1.audit)(`MUST NOT allow ${(0, utils_1.extendedTypeof)(invalid)} for the {extensions} parameter`, async () => {
+            const res = await fetchFn(opts.url, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json',
+                    accept: 'application/graphql-response+json',
+                },
+                body: JSON.stringify({
+                    query: '{ __typename }',
+                    extensions: invalid,
+                }),
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(400);
+        })),
+        (0, utils_1.audit)('MUST accept a map for the {extensions} parameter', async () => {
+            const res = await fetchFn(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.assert)('Status code', res.status).toBe(200);
+        }),
+        // TODO: audit('MUST accept a map for the {extensions} parameter'),
+        // Response application/json
+        (0, utils_1.audit)('SHOULD use 200 status code on JSON parsing failure when accepting application/json', async () => {
+            const res = await fetchFn(opts.url, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json',
+                    accept: 'application/json',
+                },
+                body: '{ "not a JSON',
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+        }),
+        (0, utils_1.audit)('SHOULD use 200 status code if parameters are invalid when accepting application/json', async () => {
+            const url = new URL(opts.url);
+            url.searchParams.set('qeury' /* typo */, '{ __typename }');
+            const res = await fetchFn(url.toString(), {
+                method: 'GET',
+                headers: { accept: 'application/json' },
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+        }),
+        (0, utils_1.audit)('SHOULD use 200 status code on document parsing failure when accepting application/json', async () => {
+            const url = new URL(opts.url);
+            url.searchParams.set('query', '{');
+            const res = await fetchFn(url.toString(), {
+                method: 'GET',
+                headers: { accept: 'application/json' },
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+        }),
+        (0, utils_1.audit)('SHOULD use 200 status code on document validation failure when accepting application/json', async () => {
+            const url = new URL(opts.url);
+            url.searchParams.set('query', '{ 8f31403dfe404bccbb0e835f2629c6a7 }'); // making sure the field doesnt exist
+            const res = await fetchFn(url.toString(), {
+                method: 'GET',
+                headers: { accept: 'application/json' },
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+        }),
+        // Response application/graphql-response+json
+        (0, utils_1.audit)('MUST use 4xx or 5xx status codes on JSON parsing failure when accepting application/graphql-response+json', async () => {
+            const res = await fetchFn(opts.url, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json',
+                    accept: 'application/graphql-response+json',
+                },
+                body: '{ "not a JSON',
+            });
+            (0, utils_1.assert)('Status code', res.status).toBeGreaterThanOrEqual(400);
+            (0, utils_1.assert)('Status code', res.status).toBeLessThanOrEqual(599);
+        }),
+        (0, utils_1.audit)('SHOULD use 400 status code on JSON parsing failure when accepting application/graphql-response+json', async () => {
+            const res = await fetchFn(opts.url, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json',
+                    accept: 'application/graphql-response+json',
+                },
+                body: '{ "not a JSON',
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(400);
+        }),
+        (0, utils_1.audit)('SHOULD not contain the data entry on JSON parsing failure when accepting application/graphql-response+json', async () => {
+            const res = await fetchFn(opts.url, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json',
+                    accept: 'application/graphql-response+json',
+                },
+                body: '{ "not a JSON',
+            });
+            (0, utils_1.assert)('Data entry', (await res.json()).data).toBe(undefined);
+        }),
+        (0, utils_1.audit)('MUST use 4xx or 5xx status codes if parameters are invalid when accepting application/graphql-response+json', async () => {
+            const url = new URL(opts.url);
+            url.searchParams.set('qeury' /* typo */, '{ __typename }');
+            const res = await fetchFn(url.toString(), {
+                method: 'GET',
+                headers: { accept: 'application/graphql-response+json' },
+            });
+            (0, utils_1.assert)('Status code', res.status).toBeGreaterThanOrEqual(400);
+            (0, utils_1.assert)('Status code', res.status).toBeLessThanOrEqual(599);
+        }),
+        (0, utils_1.audit)('SHOULD use 400 status code if parameters are invalid when accepting application/graphql-response+json', async () => {
+            const url = new URL(opts.url);
+            url.searchParams.set('qeury' /* typo */, '{ __typename }');
+            const res = await fetchFn(url.toString(), {
+                method: 'GET',
+                headers: { accept: 'application/graphql-response+json' },
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(400);
+        }),
+        (0, utils_1.audit)('SHOULD not contain the data entry if parameters are invalid when accepting application/graphql-response+json', async () => {
+            const url = new URL(opts.url);
+            url.searchParams.set('qeury' /* typo */, '{ __typename }');
+            const res = await fetchFn(url.toString(), {
+                method: 'GET',
+                headers: { accept: 'application/graphql-response+json' },
+            });
+            (0, utils_1.assert)('Data entry', (await res.json()).data).toBe(undefined);
+        }),
+        (0, utils_1.audit)('MUST use 4xx or 5xx status codes on document parsing failure when accepting application/graphql-response+json', async () => {
+            const url = new URL(opts.url);
+            url.searchParams.set('query', '{');
+            const res = await fetchFn(url.toString(), {
+                method: 'GET',
+                headers: { accept: 'application/graphql-response+json' },
+            });
+            (0, utils_1.assert)('Status code', res.status).toBeGreaterThanOrEqual(400);
+            (0, utils_1.assert)('Status code', res.status).toBeLessThanOrEqual(599);
+        }),
+        (0, utils_1.audit)('SHOULD use 400 status code on document parsing failure when accepting application/graphql-response+json', async () => {
+            const url = new URL(opts.url);
+            url.searchParams.set('query', '{');
+            const res = await fetchFn(url.toString(), {
+                method: 'GET',
+                headers: { accept: 'application/graphql-response+json' },
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(400);
+        }),
+        (0, utils_1.audit)('SHOULD not contain the data entry on document parsing failure when accepting application/graphql-response+json', async () => {
+            const url = new URL(opts.url);
+            url.searchParams.set('query', '{');
+            const res = await fetchFn(url.toString(), {
+                method: 'GET',
+                headers: { accept: 'application/graphql-response+json' },
+            });
+            (0, utils_1.assert)('Data entry', (await res.json()).data).toBe(undefined);
+        }),
+        (0, utils_1.audit)('MUST use 4xx or 5xx status codes on document validation failure when accepting application/graphql-response+json', async () => {
+            const url = new URL(opts.url);
+            url.searchParams.set('query', '{ 8f31403dfe404bccbb0e835f2629c6a7 }'); // making sure the field doesnt exist
+            const res = await fetchFn(url.toString(), {
+                method: 'GET',
+                headers: { accept: 'application/graphql-response+json' },
+            });
+            (0, utils_1.assert)('Status code', res.status).toBeGreaterThanOrEqual(400);
+            (0, utils_1.assert)('Status code', res.status).toBeLessThanOrEqual(599);
+        }),
+        (0, utils_1.audit)('SHOULD use 400 status code on document validation failure when accepting application/graphql-response+json', async () => {
+            const url = new URL(opts.url);
+            url.searchParams.set('query', '{ 8f31403dfe404bccbb0e835f2629c6a7 }'); // making sure the field doesnt exist
+            const res = await fetchFn(url.toString(), {
+                method: 'GET',
+                headers: { accept: 'application/graphql-response+json' },
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(400);
+        }),
+        (0, utils_1.audit)('SHOULD not contain the data entry on document validation failure when accepting application/graphql-response+json', async () => {
+            const url = new URL(opts.url);
+            url.searchParams.set('query', '{ 8f31403dfe404bccbb0e835f2629c6a7 }'); // making sure the field doesnt exist
+            const res = await fetchFn(url.toString(), {
+                method: 'GET',
+                headers: { accept: 'application/graphql-response+json' },
+            });
+            (0, utils_1.assert)('Data entry', (await res.json()).data).toBe(undefined);
+        }),
+        // TODO: how to fail and have the data entry?
+        // audit('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('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;