Merge pull request #1659 from happylinks/batchMax

BatchMaxQueries
apollographql · Jun 20, 2017 · 8b72ee2 · 8b72ee2
2 parents 42d120b + a8ecb34
commit 8b72ee2
Show file tree

Hide file tree

Showing 6 changed files with 253 additions and 8 deletions.
diff --git a/AUTHORS b/AUTHORS
@@ -70,3 +70,4 @@ Miroslav Simulcik <simulcik.miro@gmail.com>
 Stephen Potter <me@stevepotter.me>
 Michaël De Boey <info@michaeldeboey.be>
 Andreas Bergenwall <abergenw@gmail.com>
+Michiel Westerbeek <happylinks@gmail.com>
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ### vNEXT
 
 - `batchInterval` now has a default value of 10 ms [PR #1793](https://github.com/apollographql/apollo-client/pull/1793)
+- Added `batchMax` to allow you to limit the amount of queries in one batch. [PR #1659](https://github.com/apollographql/apollo-client/pull/1659)
 
 ### 1.4.2
 - Improved error messages for writeToStore, readFragment and writeFragment [PR #1766](https://github.com/apollographql/apollo-client/pull/1766), [PR #1722](https://github.com/apollographql/apollo-client/pull/1722)

diff --git a/src/transport/batchedNetworkInterface.ts b/src/transport/batchedNetworkInterface.ts
@@ -46,15 +46,30 @@ export class HTTPBatchedNetworkInterface extends BaseNetworkInterface {
   public _afterwares: BatchAfterwareInterface[];
   private batcher: QueryBatcher;
 
-  constructor(uri: string, batchInterval: number = 10, fetchOpts: RequestInit) {
+  constructor({
+    uri,
+    batchInterval = 10,
+    batchMax = 0,
+    fetchOpts,
+  }: {
+    uri: string,
+    batchInterval?: number,
+    batchMax?: number,
+    fetchOpts: RequestInit,
+  }) {
     super(uri, fetchOpts);
 
     if (typeof batchInterval !== 'number') {
       throw new Error(`batchInterval must be a number, got ${batchInterval}`);
     }
 
+    if (typeof batchMax !== 'number') {
+      throw new Error(`batchMax must be a number, got ${batchMax}`);
+    }
+
     this.batcher = new QueryBatcher({
       batchInterval: batchInterval,
+      batchMax: batchMax,
       batchFetchFunction: this.batchQuery.bind(this),
     });
   }
@@ -217,13 +232,19 @@ export class HTTPBatchedNetworkInterface extends BaseNetworkInterface {
 
 export interface BatchingNetworkInterfaceOptions {
   uri: string;
-  batchInterval: number;
+  batchInterval?: number;
+  batchMax?: number;
   opts?: RequestInit;
 }
 
 export function createBatchingNetworkInterface(options: BatchingNetworkInterfaceOptions): HTTPNetworkInterface {
   if (! options) {
     throw new Error('You must pass an options argument to createNetworkInterface.');
   }
-  return new HTTPBatchedNetworkInterface(options.uri, options.batchInterval, options.opts || {});
+  return new HTTPBatchedNetworkInterface({
+    uri: options.uri,
+    batchInterval: options.batchInterval,
+    batchMax: options.batchMax,
+    fetchOpts: options.opts || {},
+  });
 }
diff --git a/src/transport/batching.ts b/src/transport/batching.ts
@@ -24,20 +24,24 @@ export class QueryBatcher {
   // Queue on which the QueryBatcher will operate on a per-tick basis.
   public queuedRequests: QueryFetchRequest[] = [];
 
-  private batchInterval: Number;
+  private batchInterval: number;
+  private batchMax: number;
 
   //This function is called to the queries in the queue to the server.
   private batchFetchFunction: (request: Request[]) => Promise<ExecutionResult[]>;
 
   constructor({
     batchInterval,
+    batchMax = 0,
     batchFetchFunction,
   }: {
     batchInterval: number,
+    batchMax?: number,
     batchFetchFunction: (request: Request[]) => Promise<ExecutionResult[]>,
   }) {
     this.queuedRequests = [];
     this.batchInterval = batchInterval;
+    this.batchMax = batchMax;
     this.batchFetchFunction = batchFetchFunction;
   }
 
@@ -56,6 +60,11 @@ export class QueryBatcher {
       this.scheduleQueueConsumption();
     }
 
+    // When amount of requests reaches `batchMax`, trigger the queue consumption without waiting on the `batchInterval`.
+    if (this.queuedRequests.length === this.batchMax) {
+        this.consumeQueue();
+    }
+
     return fetchRequest.promise;
   }
 
@@ -76,6 +85,7 @@ export class QueryBatcher {
     });
 
     this.queuedRequests = [];
+
     const batchedPromise = this.batchFetchFunction(requests);
 
     batchedPromise.then((results) => {
@@ -87,12 +97,15 @@ export class QueryBatcher {
         rejecters[index](error);
       });
     });
+
     return promises;
   }
 
   private scheduleQueueConsumption(): void {
     setTimeout(() => {
-      this.consumeQueue();
+      if (this.queuedRequests.length) {
+        this.consumeQueue();
+      }
     }, this.batchInterval);
   }
 }
diff --git a/test/batchedNetworkInterface.ts b/test/batchedNetworkInterface.ts
@@ -47,7 +47,11 @@ describe('HTTPBatchedNetworkInterface', () => {
     opts?: RequestInit,
   }) => {
     const url = 'http://fake.com/graphql';
-    const batchedNetworkInterface = new HTTPBatchedNetworkInterface(url, 10, opts);
+    const batchedNetworkInterface = new HTTPBatchedNetworkInterface({
+      uri: url,
+      batchInterval: 10,
+      fetchOpts: opts,
+    });
 
     batchedNetworkInterface.use(middlewares);
     batchedNetworkInterface.useAfter(afterwares);
@@ -113,7 +117,11 @@ describe('HTTPBatchedNetworkInterface', () => {
   it('should construct itself correctly', () => {
     const url = 'http://notreal.com/graphql';
     const opts = {};
-    const batchedNetworkInterface = new HTTPBatchedNetworkInterface(url, 10, opts);
+    const batchedNetworkInterface = new HTTPBatchedNetworkInterface({
+      uri: url,
+      batchInterval: 10,
+      fetchOpts: opts,
+    });
     assert(batchedNetworkInterface);
     assert.equal(batchedNetworkInterface._uri, url);
     assert.deepEqual(batchedNetworkInterface._opts, opts);
@@ -124,7 +132,10 @@ describe('HTTPBatchedNetworkInterface', () => {
   it('should have a default value of 10ms for batchInterval', () => {
     const url = 'http://notreal.com/graphql';
     const opts = {};
-    const batchedNetworkInterface = new HTTPBatchedNetworkInterface(url, undefined, opts);
+    const batchedNetworkInterface = new HTTPBatchedNetworkInterface({
+      uri: url,
+      fetchOpts: opts,
+    });
     const queryBatcher = batchedNetworkInterface['batcher'];
     assert.equal(queryBatcher['batchInterval'], 10);
   });

diff --git a/test/client.ts b/test/client.ts
@@ -2201,6 +2201,204 @@ describe('client', () => {
     });
   });
 
+  it('should limit the amount of queries in a batch according to the batchMax value', (done) => {
+    const authorQuery = gql`
+      query {
+        author {
+          firstName
+        }
+      }`;
+    const authorResult = {
+      data: {
+        author: {
+          firstName: 'John',
+        },
+      },
+    };
+    const personQuery = gql`
+      query {
+        person {
+          name
+        }
+      }`;
+    const personResult = {
+      data: {
+        person: {
+          name: 'Jane Smith',
+        },
+      },
+    };
+
+    const url = 'http://not-a-real-url.com';
+
+    const networkInterface = createBatchingNetworkInterface({
+      uri: url,
+      batchInterval: 5,
+      batchMax: 2,
+      opts: {},
+    });
+
+    const oldFetch = fetch;
+    fetch = createMockFetch({
+      url,
+      opts: {
+        body: JSON.stringify([
+          { query: print(authorQuery) },
+          { query: print(personQuery) },
+        ]),
+        headers: {
+          Accept: '*/*',
+          'Content-Type': 'application/json',
+        },
+        method: 'POST',
+      },
+      result: createMockedIResponse([authorResult, personResult]),
+    }, {
+      url,
+      opts: {
+        body: JSON.stringify([
+          { query: print(authorQuery) },
+          { query: print(personQuery) },
+        ]),
+        headers: {
+          Accept: '*/*',
+          'Content-Type': 'application/json',
+        },
+        method: 'POST',
+      },
+      result: createMockedIResponse([authorResult, personResult]),
+    }, {
+      url,
+      opts: {
+        body: JSON.stringify([
+          { query: print(authorQuery) },
+        ]),
+        headers: {
+          Accept: '*/*',
+          'Content-Type': 'application/json',
+        },
+        method: 'POST',
+      },
+      result: createMockedIResponse([authorResult]),
+    });
+
+    Promise.all([
+      networkInterface.query({ query: authorQuery }),
+      networkInterface.query({ query: personQuery }),
+      networkInterface.query({ query: authorQuery }),
+      networkInterface.query({ query: personQuery }),
+      networkInterface.query({ query: authorQuery }),
+    ]).then((results) => {
+      assert.deepEqual<[
+        ExecutionResult,
+        ExecutionResult,
+        ExecutionResult,
+        ExecutionResult,
+        ExecutionResult
+      ]>(results, [
+        authorResult,
+        personResult,
+        authorResult,
+        personResult,
+        authorResult,
+      ]);
+      fetch = oldFetch;
+      done();
+    }).catch( e => {
+      console.error(e);
+    });
+
+  });
+
+  it('should not limit the amount of queries in a batch when batchMax is not set', (done) => {
+    const authorQuery = gql`
+      query {
+        author {
+          firstName
+        }
+      }`;
+    const authorResult = {
+      data: {
+        author: {
+          firstName: 'John',
+        },
+      },
+    };
+    const personQuery = gql`
+      query {
+        person {
+          name
+        }
+      }`;
+    const personResult = {
+      data: {
+        person: {
+          name: 'Jane Smith',
+        },
+      },
+    };
+
+    const url = 'http://not-a-real-url.com';
+
+    const networkInterface = createBatchingNetworkInterface({
+      uri: url,
+      batchInterval: 5,
+      opts: {},
+    });
+
+    const oldFetch = fetch;
+    fetch = createMockFetch({
+      url,
+      opts: {
+        body: JSON.stringify([
+          { query: print(authorQuery) },
+          { query: print(personQuery) },
+          { query: print(authorQuery) },
+          { query: print(personQuery) },
+          { query: print(authorQuery) },
+        ]),
+        headers: {
+          Accept: '*/*',
+          'Content-Type': 'application/json',
+        },
+        method: 'POST',
+      },
+      result: createMockedIResponse([
+        authorResult,
+        personResult,
+        authorResult,
+        personResult,
+        authorResult,
+      ]),
+    });
+
+    Promise.all([
+      networkInterface.query({ query: authorQuery }),
+      networkInterface.query({ query: personQuery }),
+      networkInterface.query({ query: authorQuery }),
+      networkInterface.query({ query: personQuery }),
+      networkInterface.query({ query: authorQuery }),
+    ]).then((results) => {
+     assert.deepEqual<[
+        ExecutionResult,
+        ExecutionResult,
+        ExecutionResult,
+        ExecutionResult,
+        ExecutionResult
+      ]>(results, [
+        authorResult,
+        personResult,
+        authorResult,
+        personResult,
+        authorResult,
+      ]);
+      fetch = oldFetch;
+      done();
+    }).catch( e => {
+      console.error(e);
+    });
+  });
+
   it('should enable dev tools logging', () => {
     const query = gql`
       query people {