graphql-http 1.6.0 → 1.7.0

package/lib/audits/server.js

@@ -16,7 +16,9 @@ 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 () => {
+        (0, utils_1.audit)(
+        // TODO: convert to MUST after watershed
+        'SHOULD 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(), {
@@ -38,7 +40,9 @@ function serverAudits(opts) {
             (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 () => {
+        (0, utils_1.audit)(
+        // TODO: convert to MUST after watershed
+        'SHOULD 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(), {
@@ -49,30 +53,61 @@ function serverAudits(opts) {
             (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 () => {
+        (0, utils_1.audit)(
+        // TODO: convert to MUST after watershed
+        'SHOULD 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 () => {
+        (0, utils_1.audit)('MUST use utf-8 encoding when responding', 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');
+            // has charset set to utf-8
+            try {
+                (0, utils_1.assert)('Content-Type header', res.headers.get('content-type')).toContain('charset=utf-8');
+                return;
+            }
+            catch (_a) {
+                // noop, continue
+            }
+            // has no charset specified
+            (0, utils_1.assert)('Content-Type header', res.headers.get('content-type')).notToContain('charset');
+            // and the content is utf-8 encoded
+            try {
+                const decoder = new TextDecoder('utf-8');
+                const decoded = decoder.decode(await res.arrayBuffer());
+                (0, utils_1.assert)('UTF-8 decoded body', decoded).toBe('{"data":{"__typename":"Query"}}');
+            }
+            catch (_b) {
+                throw 'Body is not UTF-8 encoded';
+            }
+        }),
+        (0, utils_1.audit)('MUST accept utf-8 encoding', async () => {
+            const url = new URL(opts.url);
+            url.searchParams.set('query', '{ __typename }');
+            const res = await fetchFn(url.toString(), {
+                headers: {
+                    'content-type': 'application/json; charset=utf-8',
+                },
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+            (0, utils_1.assert)('Content-Type header', res.headers.get('content-type')).toContain('utf-8');
         }),
-        (0, utils_1.audit)('MUST accept only utf-8 charset', async () => {
+        (0, utils_1.audit)('MUST assume utf-8 if encoding is unspecified', 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',
+                    'content-type': 'application/json',
                 },
             });
-            (0, utils_1.assert)('Status code', res.status).toBe(406);
-            (0, utils_1.assert)('Accept header', res.headers.get('accept')).toContain('charset=utf-8');
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+            (0, utils_1.assert)('Content-Type header', res.headers.get('content-type')).toContain('utf-8');
         }),
         // Request
         (0, utils_1.audit)('MUST accept POST requests', async () => {
@@ -106,7 +141,7 @@ function serverAudits(opts) {
                 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.assert)('Status code', res.status).toBeLessThanOrEqual(499);
         }),
         (0, utils_1.audit)('MUST accept application/json POST requests', async () => {
             const res = await fetchFn(opts.url, {
@@ -124,7 +159,9 @@ function serverAudits(opts) {
             (0, utils_1.assert)('Status code', res.status).toBe(400);
         }),
         // Request Parameters
-        (0, utils_1.audit)('MUST require the {query} parameter', async () => {
+        (0, utils_1.audit)(
+        // TODO: convert to MUST after watershed
+        'SHOULD use 400 status code on missing {query} parameter when accepting application/graphql-response+json', async () => {
             const res = await fetchFn(opts.url, {
                 method: 'POST',
                 headers: {
@@ -135,7 +172,21 @@ function serverAudits(opts) {
             });
             (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 () => {
+        (0, utils_1.audit)('SHOULD use 200 status code with errors field on missing {query} parameter when accepting application/json', async () => {
+            const res = await fetchFn(opts.url, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json',
+                    accept: 'application/json',
+                },
+                body: JSON.stringify({ notquery: '{ __typename }' }),
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+            (0, utils_1.assert)('Execution result', await (0, utils_1.assertBodyAsExecutionResult)(res)).toHaveProperty('errors');
+        }),
+        ...[{ obj: 'ect' }, 0, false, ['array']].map((invalid) => (0, utils_1.audit)(
+        // TODO: convert to MUST after watershed
+        `SHOULD use 400 status code on ${(0, utils_1.extendedTypeof)(invalid)} {query} parameter when accepting application/graphql-response+json`, async () => {
             const res = await fetchFn(opts.url, {
                 method: 'POST',
                 headers: {
@@ -148,7 +199,23 @@ function serverAudits(opts) {
             });
             (0, utils_1.assert)('Status code', res.status).toBe(400);
         })),
-        (0, utils_1.audit)('MUST accept a string for the {query} parameter', async () => {
+        ...[{ obj: 'ect' }, 0, false, ['array']].map((invalid) => (0, utils_1.audit)(`SHOULD use 200 status code with errors field on ${(0, utils_1.extendedTypeof)(invalid)} {query} parameter when accepting application/json`, async () => {
+            const res = await fetchFn(opts.url, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json',
+                    accept: 'application/json',
+                },
+                body: JSON.stringify({
+                    query: invalid,
+                }),
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+            (0, utils_1.assert)('Execution result', await (0, utils_1.assertBodyAsExecutionResult)(res)).toHaveProperty('errors');
+        })),
+        (0, utils_1.audit)(
+        // TODO: convert to MUST after watershed
+        'SHOULD allow string {query} parameter when accepting application/graphql-response+json', async () => {
             const res = await fetchFn(opts.url, {
                 method: 'POST',
                 headers: {
@@ -161,7 +228,23 @@ function serverAudits(opts) {
             });
             (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 () => {
+        (0, utils_1.audit)('MUST allow string {query} parameter when accepting application/json', async () => {
+            const res = await fetchFn(opts.url, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json',
+                    accept: 'application/json',
+                },
+                body: JSON.stringify({
+                    query: '{ __typename }',
+                }),
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+            (0, utils_1.assert)('Execution result', await (0, utils_1.assertBodyAsExecutionResult)(res)).notToHaveProperty('errors');
+        }),
+        ...[{ obj: 'ect' }, 0, false, ['array']].map((invalid) => (0, utils_1.audit)(
+        // TODO: convert to MUST after watershed
+        `SHOULD use 400 status code on ${(0, utils_1.extendedTypeof)(invalid)} {operationName} parameter when accepting application/graphql-response+json`, async () => {
             const res = await fetchFn(opts.url, {
                 method: 'POST',
                 headers: {
@@ -175,7 +258,24 @@ function serverAudits(opts) {
             });
             (0, utils_1.assert)('Status code', res.status).toBe(400);
         })),
-        (0, utils_1.audit)('MUST accept a string for the {operationName} parameter', async () => {
+        ...[{ obj: 'ect' }, 0, false, ['array']].map((invalid) => (0, utils_1.audit)(`SHOULD use 200 status code with errors field on ${(0, utils_1.extendedTypeof)(invalid)} {operationName} parameter when accepting application/json`, async () => {
+            const res = await fetchFn(opts.url, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json',
+                    accept: 'application/json',
+                },
+                body: JSON.stringify({
+                    operationName: invalid,
+                    query: '{ __typename }',
+                }),
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+            (0, utils_1.assert)('Execution result', await (0, utils_1.assertBodyAsExecutionResult)(res)).toHaveProperty('errors');
+        })),
+        (0, utils_1.audit)(
+        // TODO: convert to MUST after watershed
+        'SHOULD allow string {operationName} parameter when accepting application/graphql-response+json', async () => {
             const res = await fetchFn(opts.url, {
                 method: 'POST',
                 headers: {
@@ -189,7 +289,24 @@ function serverAudits(opts) {
             });
             (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 () => {
+        (0, utils_1.audit)('MUST allow string {operationName} parameter when accepting application/json', async () => {
+            const res = await fetchFn(opts.url, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json',
+                    accept: 'application/json',
+                },
+                body: JSON.stringify({
+                    operationName: 'Query',
+                    query: 'query Query { __typename }',
+                }),
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+            (0, utils_1.assert)('Execution result', await (0, utils_1.assertBodyAsExecutionResult)(res)).notToHaveProperty('errors');
+        }),
+        ...['string', 0, false, ['array']].map((invalid) => (0, utils_1.audit)(
+        // TODO: convert to MUST after watershed
+        `SHOULD use 400 status code on ${(0, utils_1.extendedTypeof)(invalid)} {variables} parameter when accepting application/graphql-response+json`, async () => {
             const res = await fetchFn(opts.url, {
                 method: 'POST',
                 headers: {
@@ -203,7 +320,24 @@ function serverAudits(opts) {
             });
             (0, utils_1.assert)('Status code', res.status).toBe(400);
         })),
-        (0, utils_1.audit)('MUST accept a map for the {variables} parameter', async () => {
+        ...['string', 0, false, ['array']].map((invalid) => (0, utils_1.audit)(`SHOULD use 200 status code with errors field on ${(0, utils_1.extendedTypeof)(invalid)} {variables} parameter when accepting application/json`, async () => {
+            const res = await fetchFn(opts.url, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json',
+                    accept: 'application/json',
+                },
+                body: JSON.stringify({
+                    query: '{ __typename }',
+                    variables: invalid,
+                }),
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+            (0, utils_1.assert)('Execution result', await (0, utils_1.assertBodyAsExecutionResult)(res)).toHaveProperty('errors');
+        })),
+        (0, utils_1.audit)(
+        // TODO: convert to MUST after watershed
+        'SHOULD allow map {variables} parameter when accepting application/graphql-response+json', async () => {
             const res = await fetchFn(opts.url, {
                 method: 'POST',
                 headers: {
@@ -216,21 +350,52 @@ function serverAudits(opts) {
                 }),
             });
             (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 () => {
+        (0, utils_1.audit)('MUST allow map {variables} parameter when accepting application/json', async () => {
+            const res = await fetchFn(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.assert)('Status code', res.status).toBe(200);
+            (0, utils_1.assert)('Execution result', await (0, utils_1.assertBodyAsExecutionResult)(res)).notToHaveProperty('errors');
+        }),
+        (0, utils_1.audit)(
+        // TODO: convert to MUST after watershed
+        'SHOULD allow URL-encoded JSON string {variables} parameter in GETs when accepting application/graphql-response+json', 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',
+                headers: {
+                    accept: 'application/graphql-response+json',
+                },
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+        }),
+        (0, utils_1.audit)('MUST allow URL-encoded JSON string {variables} parameter in GETs when accepting application/json', 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',
+                headers: {
+                    accept: 'application/json',
+                },
             });
             (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.assert)('Execution result', await (0, utils_1.assertBodyAsExecutionResult)(res)).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 () => {
+        ...['string', 0, false, ['array']].map((invalid) => (0, utils_1.audit)(
+        // TODO: convert to MUST after watershed
+        `SHOULD use 400 status code on ${(0, utils_1.extendedTypeof)(invalid)} {extensions} parameter when accepting application/graphql-response+json`, async () => {
             const res = await fetchFn(opts.url, {
                 method: 'POST',
                 headers: {
@@ -244,7 +409,24 @@ function serverAudits(opts) {
             });
             (0, utils_1.assert)('Status code', res.status).toBe(400);
         })),
-        (0, utils_1.audit)('MUST accept a map for the {extensions} parameter', async () => {
+        ...['string', 0, false, ['array']].map((invalid) => (0, utils_1.audit)(`SHOULD use 200 status code with errors field on ${(0, utils_1.extendedTypeof)(invalid)} {extensions} parameter when accepting application/json`, async () => {
+            const res = await fetchFn(opts.url, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json',
+                    accept: 'application/json',
+                },
+                body: JSON.stringify({
+                    query: '{ __typename }',
+                    extensions: invalid,
+                }),
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+            (0, utils_1.assert)('Execution result', await (0, utils_1.assertBodyAsExecutionResult)(res)).toHaveProperty('errors');
+        })),
+        (0, utils_1.audit)(
+        // TODO: convert to MUST after watershed
+        'SHOULD allow map {extensions} parameter when accepting application/graphql-response+json', async () => {
             const res = await fetchFn(opts.url, {
                 method: 'POST',
                 headers: {
@@ -258,6 +440,21 @@ function serverAudits(opts) {
             });
             (0, utils_1.assert)('Status code', res.status).toBe(200);
         }),
+        (0, utils_1.audit)('MUST allow map {extensions} parameter when accepting application/json', async () => {
+            const res = await fetchFn(opts.url, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json',
+                    accept: 'application/json',
+                },
+                body: JSON.stringify({
+                    query: '{ __typename }',
+                    extensions: { some: 'value' },
+                }),
+            });
+            (0, utils_1.assert)('Status code', res.status).toBe(200);
+            (0, utils_1.assert)('Execution result', await (0, utils_1.assertBodyAsExecutionResult)(res)).notToHaveProperty('errors');
+        }),
         // 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 () => {
@@ -299,7 +496,9 @@ function serverAudits(opts) {
             (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 () => {
+        (0, utils_1.audit)(
+        // TODO: convert to MUST after watershed
+        'SHOULD 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: {
@@ -331,9 +530,11 @@ function serverAudits(opts) {
                 },
                 body: '{ "not a JSON',
             });
-            (0, utils_1.assert)('Data entry', (await res.json()).data).toBe(undefined);
+            (0, utils_1.assert)('Data entry', (await (0, utils_1.assertBodyAsExecutionResult)(res)).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 () => {
+        (0, utils_1.audit)(
+        // TODO: convert to MUST after watershed
+        'SHOULD 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(), {
@@ -359,9 +560,11 @@ function serverAudits(opts) {
                 method: 'GET',
                 headers: { accept: 'application/graphql-response+json' },
             });
-            (0, utils_1.assert)('Data entry', (await res.json()).data).toBe(undefined);
+            (0, utils_1.assert)('Data entry', (await (0, utils_1.assertBodyAsExecutionResult)(res)).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 () => {
+        (0, utils_1.audit)(
+        // TODO: convert to MUST after watershed
+        'SHOULD 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(), {
@@ -387,9 +590,11 @@ function serverAudits(opts) {
                 method: 'GET',
                 headers: { accept: 'application/graphql-response+json' },
             });
-            (0, utils_1.assert)('Data entry', (await res.json()).data).toBe(undefined);
+            (0, utils_1.assert)('Data entry', (await (0, utils_1.assertBodyAsExecutionResult)(res)).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 () => {
+        (0, utils_1.audit)(
+        // TODO: convert to MUST after watershed
+        'SHOULD 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(), {
@@ -415,7 +620,7 @@ function serverAudits(opts) {
                 method: 'GET',
                 headers: { accept: 'application/graphql-response+json' },
             });
-            (0, utils_1.assert)('Data entry', (await res.json()).data).toBe(undefined);
+            (0, utils_1.assert)('Data entry', (await (0, utils_1.assertBodyAsExecutionResult)(res)).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'),