feat: Add rate limiting features

Author: trodrigues

lib/contentful.js

@@ -5,9 +5,12 @@
  * @see ContentfulClientAPI
  */
 
+import defaults from 'lodash/defaults'
 import assign from 'lodash/assign'
+import cloneDeep from 'lodash/cloneDeep'
 import version from '../version'
 import createHttpClient from 'contentful-sdk-core/create-http-client'
+import wrapHttpClient from 'contentful-sdk-core/wrap-http-client'
 import createContentfulApi from './create-contentful-api'
 import createLinkResolver from './create-link-resolver'
 
@@ -23,6 +26,10 @@ import createLinkResolver from './create-link-resolver'
  * @prop {string=} params.host - API host (default: cdn.contentful.com). Also usable with preview.contentful.com.
  * @prop {Object=} params.agent - Optional Node.js HTTP agent for proxying (see <a href="https://nodejs.org/api/http.html#http_class_http_agent">Node.js docs</a> and <a href="https://www.npmjs.com/package/https-proxy-agent">https-proxy-agent</a>)
  * @prop {Object=} params.headers - Optional additional headers
+ * @prop {number=} params.concurrency - Number of allowed concurrent requests. Changing this value is not recommended. (default: 6)
+ * @prop {number=} params.delay - Delay in milliseconds for waiting after hitting the allowed number of concurrent requests. Changing this value is not recommended. (default: 1000)
+ * @prop {number=} params.maxRetries - Maximum number of retries when a 429 is received (default: 5)
+ * @prop {boolean=} params.retryOnTooManyRequests - If we should retry on 429s (default: true)
  * @returns {ContentfulClientAPI.ClientAPI}
  * @example
  * const client = contentful.createClient({
@@ -31,6 +38,13 @@ import createLinkResolver from './create-link-resolver'
  * })
  */
 export default function createClient (axios, params) {
+  params = defaults(cloneDeep(params), {
+    rateLimit: 9,
+    rateLimitPeriod: 1000,
+    maxRetries: 5,
+    retryOnTooManyRequests: true
+  })
+
   if (!params.accessToken) {
     throw new TypeError('Expected parameter accessToken')
   }
@@ -49,7 +63,13 @@ export default function createClient (axios, params) {
     'X-Contentful-User-Agent': 'contentful.js/' + version
   })
 
-  const http = createHttpClient(axios, params)
+  const http = wrapHttpClient(createHttpClient(axios, params), {
+    concurrency: params.rateLimit,
+    delay: params.rateLimitPeriod,
+    maxRetries: params.maxRetries,
+    retryOnTooManyRequests: params.retryOnTooManyRequests
+  })
+
   return createContentfulApi({
     http: http,
     shouldLinksResolve: shouldLinksResolve

package.json

@@ -51,7 +51,7 @@
   ],
   "dependencies": {
     "babel-runtime": "^6.3.19",
-    "contentful-sdk-core": "^2.2.2",
+    "contentful-sdk-core": "^2.3.0",
     "json-stringify-safe": "^5.0.1",
     "lodash": "^4.2.0"
   },