spec-compliant GET support

packages/apollo-link-batch-http/CHANGELOG.md

@@ -1,6 +1,7 @@
 ### vNext
 - share logic with apollo-link-http through apollo-link-http-core [PR#364](https://github.com/apollographql/apollo-link/pull/364)
 - remove apollo-fetch [PR#364](https://github.com/apollographql/apollo-link/pull/364)
+- GET is no longer supported for batching (it never worked anyway) [PR#490](https://github.com/apollographql/apollo-link/pull/490)
 
 ### 1.0.5
 - ApolloLink upgrade

packages/apollo-link-batch-http/README.md

@@ -29,7 +29,7 @@ http options follow the same structure as the
 * `credentials`: a string representing the credentials policy you want for the
   fetch call
 * `fetchOptions`: any overrides of the fetch options argument to pass to the
-  fetch call
+  fetch call. Note that you cannot use batching with the GET HTTP method.
 
 The batching options indicate how operations are batched together, the size of
 batches, and the maximum time a batch will wait before automatically being sent
@@ -89,32 +89,15 @@ The batch http link handles errors on a per batch basis with the same semantics
 
 <h2 id="custom">Custom fetching</h2>
 
-You can use the `fetch` option when creating an http-link to do a lot of custom networking. This is useful if you want to modify the request based on the headers calculated, send the request as a 'GET' via a query string, or calculate the uri based on the operation:
-
-<h3 id="get-request">Sending a GET request</h3>
-
-```js
-const customFetch = (uri, options) => {
-  const { body, ...newOptions } = options;
-  // turn the object into a query string, try `object-to-querystring` package
-  const queryString = objectToQuery(JSON.parse(body));
-  requestedString = uri + queryString;
-  return fetch(requestedString, newOptions);
-};
-const link = createBatchHttpLink({
-  uri: "data",
-  fetchOptions: { method: "GET" },
-  fetch: customFetch
-});
-```
+You can use the `fetch` option when creating an http-link to do a lot of custom networking. This is useful if you want to modify the request based on the calculated headers or calculate the uri based on the operation:
 
 <h3 id="custom-auth">Custom auth</h3>
 
 ```js
 const customFetch = (uri, options) => {
   const { header } = Hawk.client.header(
     "http://example.com:8000/resource/1?b=1&a=2",
-    "GET",
+    "POST",
     { credentials: credentials, ext: "some-app-data" }
   );
   options.headers.Authorization = header;

packages/apollo-link-batch-http/package.json

@@ -43,7 +43,7 @@
   "dependencies": {
     "apollo-link": "^1.1.0",
     "apollo-link-batch": "^1.0.5",
-    "apollo-link-http-common": "^0.1.0"
+    "apollo-link-http-common": "^0.2.0"
   },
   "peerDependencies": {
     "graphql": "^0.11.0 || ^0.12.3 || ^0.13.0"

packages/apollo-link-batch-http/src/batchHttpLink.ts

@@ -1,6 +1,12 @@
-import { ApolloLink, Operation, FetchResult, Observable } from 'apollo-link';
 import {
-  serializeFetchBody,
+  ApolloLink,
+  Operation,
+  FetchResult,
+  Observable,
+  fromError,
+} from 'apollo-link';
+import {
+  serializeFetchParameter,
   selectURI,
   parseAndCheckHttpResponse,
   checkFetcher,
@@ -102,12 +108,17 @@ export class BatchHttpLink extends ApolloLink {
       const body = optsAndBody.map(({ body }) => body);
       const options = optsAndBody[0].options;
 
+      // There's no spec for using GET with batches.
+      if (options.method === 'GET') {
+        return fromError<FetchResult[]>(
+          new Error('apollo-link-batch-http does not support GET requests'),
+        );
+      }
+
       try {
-        (options as any).body = serializeFetchBody(body);
+        (options as any).body = serializeFetchParameter(body, 'Payload');
       } catch (parseError) {
-        return new Observable<FetchResult[]>(observer => {
-          observer.error(parseError);
-        });
+        return fromError<FetchResult[]>(parseError);
       }
 
       const { controller, signal } = createSignalIfSupported();

packages/apollo-link-http-common/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Change log
+
+### v0.2.0
+- rename serializeFetchBody to serializeFetchParameter and take a label argument

packages/apollo-link-http-common/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apollo-link-http-common",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description":
     "Http utilities for Apollo Link shared across all links using http",
   "main": "./lib/bundle.umd.js",

packages/apollo-link-http-common/src/__tests__/index.ts

@@ -7,7 +7,7 @@ import {
   checkFetcher,
   selectHttpOptionsAndBody,
   selectURI,
-  serializeFetchBody,
+  serializeFetchParameter,
   fallbackHttpConfig,
 } from '../index';
 
@@ -191,19 +191,19 @@ describe('Common Http functions', () => {
     });
   });
 
-  describe('serializeFetchBody', () => {
+  describe('serializeFetchParameter', () => {
     it('throws a parse error on an unparsable body', () => {
       const b = {};
       const a = { b };
       (b as any).a = a;
 
-      expect(() => serializeFetchBody(b)).toThrow();
+      expect(() => serializeFetchParameter(b, 'Label')).toThrow(/Label/);
     });
 
     it('returns a correctly parsed body', () => {
       const body = { no: 'thing' };
 
-      expect(serializeFetchBody(body)).toEqual('{"no":"thing"}');
+      expect(serializeFetchParameter(body, 'Label')).toEqual('{"no":"thing"}');
     });
   });
 

packages/apollo-link-http-common/src/index.ts

@@ -44,6 +44,14 @@ export interface UriFunction {
   (operation: Operation): string;
 }
 
+// The body of a GraphQL-over-HTTP-POST request.
+export interface Body {
+  query?: string;
+  operationName?: string;
+  variables?: Record<string, any>;
+  extensions?: Record<string, any>;
+}
+
 export interface HttpOptions {
   /**
    * The URI to use when fetching operations.
@@ -220,7 +228,7 @@ export const selectHttpOptionsAndBody = (
 
   //The body depends on the http options
   const { operationName, extensions, variables, query } = operation;
-  const body = { operationName, variables };
+  const body: Body = { operationName, variables };
 
   if (http.includeExtensions) (body as any).extensions = extensions;
 
@@ -233,18 +241,18 @@ export const selectHttpOptionsAndBody = (
   };
 };
 
-export const serializeFetchBody = body => {
-  let serializedBody;
+export const serializeFetchParameter = (p, label) => {
+  let serialized;
   try {
-    serializedBody = JSON.stringify(body);
+    serialized = JSON.stringify(p);
   } catch (e) {
     const parseError = new Error(
-      `Network request failed. Payload is not serializable: ${e.message}`,
+      `Network request failed. ${label} is not serializable: ${e.message}`,
     ) as ClientParseError;
     parseError.parseError = e;
     throw parseError;
   }
-  return serializedBody;
+  return serialized;
 };
 
 //selects "/graphql" by default

packages/apollo-link-http/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ### vNEXT
 - move logic to apollo-link-http-core [PR#364](https://github.com/apollographql/apollo-link/pull/364)
+- follow the spec properly for GET requests [PR#490](https://github.com/apollographql/apollo-link/pull/490)
 
 ### 1.3.3
 - ApolloLink upgrade

packages/apollo-link-http/README.md

@@ -10,7 +10,7 @@ Link ecosystem and how to use this link with libraries like Apollo Client and
 graphql-tools, or as a standalone client.
 
 The http link is a terminating link that fetches GraphQL results from a GraphQL
-endpoint over an http connection. The http link support both POST and GET
+endpoint over an http connection. The http link supports both POST and GET
 requests with the ability change the http options on a per query basis. This
 can be used for authentication, persisted queries, dynamic uris, and other
 granular updates.
@@ -42,7 +42,9 @@ The HTTP Link relies on having `fetch` present in your runtime environment. If y
 
 <h2 id="context">Context</h2>
 
-The Http Link uses the `headers` field on the context to allow passing headers to the HTTP request. It also supports the `credentials` field for defining credentials policy, `uri` for changing the endpoint dynamically, and `fetchOptions` to allow generic fetch overrides (i.e. method: "GET"). These options will override the same key if passed when creating the the link.
+The Http Link uses the `headers` field on the context to allow passing headers to the HTTP request. It also supports the `credentials` field for defining credentials policy, `uri` for changing the endpoint dynamically, and `fetchOptions` to allow generic fetch overrides (i.e. `method: "GET"`). These options will override the same key if passed when creating the the link.
+
+Note that if you set `fetchOptions.method` to `GET`, the http link will follow the [standard GraphQL HTTP GET encoding](http://graphql.org/learn/serving-over-http/#get-request): the query, variables, operation name, and extensions will be passed as query parameters rather than in the HTTP request body.
 
 This link also attaches the response from the `fetch` operation on the context as `response` so you can access it from within another link.
 
@@ -146,32 +148,15 @@ All error types inherit the `name`, `message`, and nullable `stack` properties f
 
 <h2 id="custom">Custom fetching</h2>
 
-You can use the `fetch` option when creating an http-link to do a lot of custom networking. This is useful if you want to modify the request based on the headers calculated, send the request as a 'GET' via a query string, or calculate the uri based on the operation:
-
-<h3 id="get-request">Sending a GET request</h3>
-
-```js
-const customFetch = (uri, options) => {
-  const { body, ...newOptions } = options;
-  // turn the object into a query string, try `object-to-querystring` package
-  const queryString = objectToQuery(JSON.parse(body));
-  requestedString = uri + queryString;
-  return fetch(requestedString, newOptions);
-};
-const link = createHttpLink({
-  uri: "data",
-  fetchOptions: { method: "GET" },
-  fetch: customFetch
-});
-```
+You can use the `fetch` option when creating an http-link to do a lot of custom networking. This is useful if you want to modify the request based on the calculated headers  or calculate the uri based on the operation:
 
 <h3 id="custom-auth">Custom auth</h3>
 
 ```js
 const customFetch = (uri, options) => {
   const { header } = Hawk.client.header(
     "http://example.com:8000/resource/1?b=1&a=2",
-    "GET",
+    "POST",
     { credentials: credentials, ext: "some-app-data" }
   );
   options.headers.Authorization = header;

packages/apollo-link-http/package.json

@@ -43,7 +43,7 @@
   },
   "dependencies": {
     "apollo-link": "^1.1.0",
-    "apollo-link-http-common": "^0.1.0"
+    "apollo-link-http-common": "^0.2.0"
   },
   "peerDependencies": {
     "graphql": "^0.11.0 || ^0.12.0 || ^0.13.0"