feat(BatchMiddleware): Completely rewritten batch logic as middleware

BREAKING CHANGE: You should update config if you use request batching
relay-tools · Mar 12, 2017 · b903597 · b903597
1 parent 963e746
commit b903597
Show file tree

Hide file tree

Showing 10 changed files with 461 additions and 256 deletions.
diff --git a/README.md b/README.md
@@ -7,43 +7,64 @@ ReactRelayNetworkLayer
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
 The `ReactRelayNetworkLayer` is a [Relay Network Layer](https://facebook.github.io/relay/docs/guides-network-layer.html)
-with query batching and middleware support.
+with various middlewares which can manipulate requests/responses on the fly (change auth headers, request url or perform some fallback if request fails), batch several relay request by timeout into one http request.
 
-This NetworkLayer solves the following problems:
-- If your app is making enough individual queries to be a performance problem on first page load
-- If your app needs to manipulate requests/responses on the fly - change auth headers, request url or perform some fallback if request fails
+`ReactRelayNetworkLayer` can be used in browser, react-native or node server for rendering. Under the hood this module uses global `fetch` method. So if your client is too old, please import explicitly proper polyfill to your code (eg. `whatwg-fetch`, `node-fetch` or `fetch-everywhere`).
 
-Can be used in browser, react-native or node server for rendering. Under the hood this module uses global `fetch` method. So if your client is too old, please import explicitly proper polyfill to your code (eg. `whatwg-fetch`, `node-fetch` or `fetch-everywhere`).
+### Migrating from v1 to v2
+In v2 was completely rewritten batch logic as middleware. All other parts stay unaffected. So if you use request batching, you should change your config:
+```diff
+import Relay from 'react-relay';
+import {
+  RelayNetworkLayer,
+  urlMiddleware,
++  batchMiddleware,
+} from 'react-relay-network-layer';
+
+Relay.injectNetworkLayer(new RelayNetworkLayer([
++  batchMiddleware({
++    batchUrl: (req) => '/graphql/batch',
++  }),
+  urlMiddleware({
+    url: (req) => '/graphql',
+-    batchUrl: (req) => '/graphql/batch',
+  }),
+- ], { disableBatchQuery: false }));
++ ]));
+```
 
-Available middlewares:
-- **custom inline middleware** - [see example](https://github.com/nodkz/react-relay-network-layer#example-of-injecting-networklayer-with-middlewares-on-the-client-side) below where added `credentials` and `headers` to the `fetch` method.
-  - `next => req => { /* your modification of 'req' object */ return next(req); }` .
-- **url** - for manipulating fetch `url` on fly via thunk. Options:
-  - `url` - string or function(req) for single request (default: `/graphql`)
-  - `batchUrl` -  string or function(req) for batch request, server must be prepared for such requests (default: `/graphql/batch`)
-- **retry** - for request retry if the initial request fails. Options:
+### Available middlewares:
+- **your custom inline middleware** - [see example](https://github.com/nodkz/react-relay-network-layer#example-of-injecting-networklayer-with-middlewares-on-the-client-side) below where added `credentials` and `headers` to the `fetch` method.
+  - `next => req => { /* your modification of 'req' object */ return next(req); }`
+- **urlMiddleware** - for manipulating fetch `url` on fly via thunk.
+  - `url` - string or function(req) for single request (default: `/graphql`)  
+- **batchMiddleware** - gather some period of time relay-requests and sends it as one http-request
+  - `batchUrl` - string or function(requestMap). Url of the server endpoint for batch request execution (default: `/graphql/batch`)
+  - `batchTimeout` - integer in milliseconds, period of time for gathering multiple requests before sending them to the server (default: `0`)
+  - `allowMutations` - by default batching disabled for mutations, you may enable it passing `true` (default: `false`)
+- **retryMiddleware** - for request retry if the initial request fails.
   - `fetchTimeout` - number in milliseconds that defines in how much time will request timeout after it has been sent to the server (default: `15000`).
   - `retryDelays` - array of millisecond that defines the values on which retries are based on (default: `[1000, 3000]`).
   - `statusCodes` - array of response status codes which will fire up retryMiddleware (default: `status < 200 or status > 300`).
   - `allowMutations` - by default retries disabled for mutations, you may allow process retries for them passing `true` (default: `false`)
   - `forceRetry` - function(cb, delay), when request is delayed for next retry, middleware will call this function and pass to it a callback and delay time. When you call this callback, middleware will proceed request immediately (default: `false`).
-- **auth** - for adding auth token, and refreshing it if gets 401 response from server. Options:
+- **authMiddleware** - for adding auth token, and refreshing it if gets 401 response from server.
   - `token` - string or function(req) which returns token. If function is provided, then it will be called for every request (so you may change tokens on fly).
   - `tokenRefreshPromise`: - function(req, err) which must return promise with new token, called only if server returns 401 status code and this function is provided.
   - `allowEmptyToken` - allow made a request without Authorization header if token is empty (default: `false`).
   - `prefix` - prefix before token (default: `'Bearer '`).
   - `header` - name of the HTTP header to pass the token in (default: `'Authorization'`).
   - If you use `auth` middleware with `retry`, `retry` must be used before `auth`. Eg. if token expired when retries apply, then `retry` can call `auth` middleware again.
-- **logger** - for logging requests and responses. Options:
+- **loggerMiddleware** - for logging requests and responses.
   - `logger` - log function (default: `console.log.bind(console, '[RELAY-NETWORK]')`)
   - If you use `Relay@^0.9.0` you may turn on relay's internal [extended mutation debugger](https://twitter.com/steveluscher/status/738101549591732225). For this you should open browser console and type `__DEV__=true`. With webpack you may use `webpack.BannerPlugin('__DEV__=true;', {raw: true})` or `webpack.DefinePlugin({__DEV__: true})`.
   - If you use `Relay@^0.8.0` you may turn on [internal Relay requests debugger](https://cloud.githubusercontent.com/assets/1946920/15735688/688ccabe-28bc-11e6-82e2-db644eb698b0.png): `import RelayNetworkDebug from 'react-relay/lib/RelayNetworkDebug';  RelayNetworkDebug.init();`
-- **perf** - simple time measure for network request. Options:
+- **perfMiddleware** - simple time measure for network request.
   - `logger` - log function (default: `console.log.bind(console, '[RELAY-NETWORK]')`)
-- **gqErrors** - display `errors` data to console from graphql response. If you want see stackTrace for errors, you should provide `formatError` to `express-graphql` (see example below where `graphqlServer` accept `formatError` function). Options:
+- **gqErrorsMiddleware** - display `errors` data to console from graphql response. If you want see stackTrace for errors, you should provide `formatError` to `express-graphql` (see example below where `graphqlServer` accept `formatError` function).
   - `logger` - log function (default: `console.error.bind(console)`)
   - `prefix` - prefix message (default: `[RELAY-NETWORK] GRAPHQL SERVER ERROR:`)
-- **defer** - _experimental_ Right now `deferMiddleware()` just set `defer` as supported option for Relay. So this middleware allow to community play with `defer()` in cases, which was [described by @wincent](https://github.com/facebook/relay/issues/288#issuecomment-199510058).
+- **deferMiddleware** - _experimental_ Right now `deferMiddleware()` just set `defer` as supported option for Relay. So this middleware allow to community play with `defer()` in cases, which was [described by @wincent](https://github.com/facebook/relay/issues/288#issuecomment-199510058).
 
 [CHANGELOG](https://github.com/nodkz/react-relay-network-layer/blob/master/CHANGELOG.md)
 
@@ -56,88 +77,30 @@ OR
 npm install react-relay-network-layer --save
 ```
 
-
-Part 1: Batching several requests into one
-==========================================
-
-Joseph Savona [wrote](https://github.com/facebook/relay/issues/1058#issuecomment-213592051): For legacy reasons, Relay splits "plural" root queries into individual queries. In general we want to diff each root value separately, since different fields may be missing for different root values.
-
-Also if you use [react-relay-router](https://github.com/relay-tools/react-router-relay) and have multiple root queries in one route pass, you may notice that default network layer will produce several http requests.
-
-So for avoiding multiple http-requests, the `ReactRelayNetworkLayer` is the right way to combine it in single http-request.
-
-### Example how to enable batching
-#### ...on server
-Firstly, you should prepare **server** to proceed the batch request:
-
-```js
-import express from 'express';
-import graphqlHTTP from 'express-graphql';
-import { graphqlBatchHTTPWrapper } from 'react-relay-network-layer';
-import bodyParser from 'body-parser';
-import myGraphqlSchema from './graphqlSchema';
-
-const port = 3000;
-const server = express();
-
-// setup standart `graphqlHTTP` express-middleware
-const graphqlServer = graphqlHTTP({
-  schema: myGraphqlSchema,
-  formatError: (error) => ({ // better errors for development. `stack` used in `gqErrors` middleware
-    message: error.message,
-    stack: process.env.NODE_ENV === 'development' ? error.stack.split('\n') : null,
-  }),
-});
-
-// declare route for batch query
-server.use('/graphql/batch',
-  bodyParser.json(),
-  graphqlBatchHTTPWrapper(graphqlServer)
-);
-
-// declare standard graphql route
-server.use('/graphql',
-  graphqlServer
-);
-
-server.listen(port, () => {
-  console.log(`The server is running at http://localhost:${port}/`);
-});
-```
-[More complex example](https://github.com/nodkz/react-relay-network-layer/blob/master/examples/dataLoaderPerBatchRequest.js) of how you can use a single [DataLoader](https://github.com/facebook/dataloader) for all (batched) queries within a one HTTP-request.
-
-If you are on Koa@2, [koa-graphql-batch](https://github.com/mattecapu/koa-graphql-batch) provides the same functionality as `graphqlBatchHTTPWrapper` (see its docs for usage example).
-
-#### ...on client
-And right after server side ready to accept batch queries, you may enable batching on the **client**:
-
-```js
-Relay.injectNetworkLayer(new RelayNetworkLayer([
-  urlMiddleware({
-    url: '/graphql',
-    batchUrl: '/graphql/batch', // <--- route for batch queries
-  }),
-], { disableBatchQuery: false })); // <--- set to FALSE, or may remove `disableBatchQuery` option at all
-```
-
-### How batching works internally
-Internally batching in NetworkLayer prepare list of queries `[ {id, query, variables}, ...]` sends it to server. And server returns list of responces `[ {id, payload}, ...]`, (where `id` is the same value as client requested for identifying which data goes with which query, and `payload` is standard response of GraphQL server: `{ data, error }`).
-
-
-Part 2: Middlewares
-====================
+Middlewares
+===========
 ### Example of injecting NetworkLayer with middlewares on the **client side**.
 ```js
 import Relay from 'react-relay';
 import {
-  RelayNetworkLayer, retryMiddleware, urlMiddleware, authMiddleware, loggerMiddleware,
-  perfMiddleware, gqErrorsMiddleware
+  RelayNetworkLayer,
+  urlMiddleware,
+  batchMiddleware,
+  loggerMiddleware,
+  gqErrorsMiddleware,
+  perfMiddleware,
+  retryMiddleware,
+  authMiddleware,
 } from 'react-relay-network-layer';
 
 Relay.injectNetworkLayer(new RelayNetworkLayer([
   urlMiddleware({
     url: (req) => '/graphql',
   }),
+  batchMiddleware({
+    batchUrl: (reqestMap) => '/graphql/batch',
+    batchTimeout: 10,
+  }),
   loggerMiddleware(),
   gqErrorsMiddleware(),
   perfMiddleware(),
@@ -176,7 +139,7 @@ Relay.injectNetworkLayer(new RelayNetworkLayer([
     req.credentials = 'same-origin'; // provide CORS policy to XHR request in fetch method
     return next(req);
   }
-], { disableBatchQuery: true }));
+]));
 ```
 
 ### How middlewares work internally
@@ -220,6 +183,72 @@ Middlewares use LIFO (last in, first out) stack. Or simply put - use `compose` f
  - chain to `resPromise.then(res => res.json())` and pass this promise for resolving/rejecting Relay requests.
 
 
+Batching several requests into one
+==================================
+
+Joseph Savona [wrote](https://github.com/facebook/relay/issues/1058#issuecomment-213592051): For legacy reasons, Relay splits "plural" root queries into individual queries. In general we want to diff each root value separately, since different fields may be missing for different root values.
+
+Also if you use [react-relay-router](https://github.com/relay-tools/react-router-relay) and have multiple root queries in one route pass, you may notice that default network layer will produce several http requests.
+
+So for avoiding multiple http-requests, the `ReactRelayNetworkLayer` is the right way to combine it in single http-request.
+
+### Example how to enable batching
+#### ...on server
+Firstly, you should prepare **server** to proceed the batch request:
+
+```js
+import express from 'express';
+import graphqlHTTP from 'express-graphql';
+import { graphqlBatchHTTPWrapper } from 'react-relay-network-layer';
+import bodyParser from 'body-parser';
+import myGraphqlSchema from './graphqlSchema';
+
+const port = 3000;
+const server = express();
+
+// setup standart `graphqlHTTP` express-middleware
+const graphqlServer = graphqlHTTP({
+  schema: myGraphqlSchema,
+  formatError: (error) => ({ // better errors for development. `stack` used in `gqErrors` middleware
+    message: error.message,
+    stack: process.env.NODE_ENV === 'development' ? error.stack.split('\n') : null,
+  }),
+});
+
+// declare route for batch query
+server.use('/graphql/batch',
+  bodyParser.json(),
+  graphqlBatchHTTPWrapper(graphqlServer)
+);
+
+// declare standard graphql route
+server.use('/graphql',
+  graphqlServer
+);
+
+server.listen(port, () => {
+  console.log(`The server is running at http://localhost:${port}/`);
+});
+```
+[More complex example](https://github.com/nodkz/react-relay-network-layer/blob/master/examples/dataLoaderPerBatchRequest.js) of how you can use a single [DataLoader](https://github.com/facebook/dataloader) for all (batched) queries within a one HTTP-request.
+
+If you are on Koa@2, [koa-graphql-batch](https://github.com/mattecapu/koa-graphql-batch) provides the same functionality as `graphqlBatchHTTPWrapper` (see its docs for usage example).
+
+#### ...on client
+And right after server side ready to accept batch queries, you may enable batching on the **client**:
+
+```js
+Relay.injectNetworkLayer(new RelayNetworkLayer([
+  batchMiddleware({
+    batchUrl: '/graphql/batch', // <--- route for batch queries
+  }),
+]));
+```
+
+### How batching works internally
+Internally batching in NetworkLayer prepare list of queries `[ {id, query, variables}, ...]` sends it to server. And server returns list of responces `[ {id, payload}, ...]`, (where `id` is the same value as client requested for identifying which data goes with which query, and `payload` is standard response of GraphQL server: `{ data, error }`).
+
+
 Recommended modules
 ==========
 - **[babel-plugin-transform-relay-hot](https://github.com/nodkz/babel-plugin-transform-relay-hot)** - Babel 6 plugin for transforming `Relay.QL` tagged templates via the GraphQL json schema file. Each time when schema file was changed, the wrapper updates instance of standard `babelRelayPlugin` with new schema without completely restarting dev server.

diff --git a/src/index.js b/src/index.js
@@ -1,15 +1,18 @@
 import RelayNetworkLayer from './relayNetworkLayer';
+import batchMiddleware from './middleware/batch';
 import retryMiddleware from './middleware/retry';
 import urlMiddleware from './middleware/url';
 import authMiddleware from './middleware/auth';
 import perfMiddleware from './middleware/perf';
 import loggerMiddleware from './middleware/logger';
 import gqErrorsMiddleware from './middleware/gqErrors';
 import deferMiddleware from './middleware/defer';
-import graphqlBatchHTTPWrapper from './express-middleware/graphqlBatchHTTPWrapper';
+import graphqlBatchHTTPWrapper
+  from './express-middleware/graphqlBatchHTTPWrapper';
 
 export {
   RelayNetworkLayer,
+  batchMiddleware,
   retryMiddleware,
   urlMiddleware,
   authMiddleware,