Add uploadFilesConcurrency option (defaults to Infinity) to throttle source files upload (#67)

* Add es6-promise-pool

* Limit concurrent files upload requests to 10

* Make uploadFilesConcurrency an option that defaults to Infinity

Author: jpreynat

README.md

@@ -38,7 +38,7 @@ var config = {
      organization: 'your-organization-name',
      project: 'your-project-name',
      apiKey: process.env.SENTRY_API_KEY,
-     
+
      // Release version name/hash is required
      release: process.env.GIT_SHA
    })
@@ -98,7 +98,7 @@ var config = {
   ]
 }
 ```
-  
+
 - `releaseBody`: Object or function that returns the body that will be sent to Sentry. Defaults to sending the version and projects (which is sufficient to create a basic new release in Sentry).
   - The function is given two arguments: `version` and `projects`. `version` is the result of the `release` object (string or function output); `projects` is the `project` configuration parameter (converted to an array if a single string is provided).
   - The most common use case for overriding this field is Sentry's [release commits](https://docs.sentry.io/learn/releases/#releases-are-better-with-commits) feature. To use this, define `releaseBody` per the example below (providing the most recent commit hash through whatever means works best for your build setup). See the Sentry documentation for more details and options.
@@ -108,7 +108,7 @@ var config = {
   plugins: [
     new SentryPlugin({
       releaseBody: function(version, projects) {
-        return { 
+        return {
           version,
           projects,
           refs: [{
@@ -136,6 +136,8 @@ var config = {
 - `uploadFileRequestOptions`: Object of options or function returning object of options passed through to the underlying `request` call on file uploading; see the [request library documentation](https://github.com/request/request#requestoptions-callback) for available options.
   - If a function is provided, it is given one argument: req, an object of options (including url, auth, and body) that the plugin is sending to the underlying request call. (This is useful if you want to configure the request dynamically based on request data such as the filename.)
 
+- `uploadFilesConcurrency`: Number of maximum concurrent uploads of source files to the Sentry API. Use this when the number of source files to upload to Sentry is high and you encounter the `RequestError: Error: getaddrinfo ENOTFOUND sentry.io sentry.io:443` error.
+
 ### What is a `release`?
 
 A [release](https://docs.sentry.io/learn/releases/) is a concept that Sentry uses to attach source maps to a known version of your code. The plugin creates one for you, but you need to provide a "name" for a particular version of your code, which is just a string. Sentry can then use the release to record that an error was found in a specific known version of your code. Releases are also used to "version" your source maps -- source maps are uploaded to a specific release, and when a raw JavaScript error is reported, the release reported with the error is used to locate and apply the correct source maps.
@@ -148,7 +150,7 @@ A git commit hash is very useful for releases - it is a string that defines a pa
 new SentryPlugin({
   // ...
   release: function() {
-    // Note: this is just an example, it depends on your deployment pipeline 
+    // Note: this is just an example, it depends on your deployment pipeline
     return process.env.SOURCE_VERSION;
   }
 });

package.json

@@ -36,6 +36,7 @@
     ]
   },
   "dependencies": {
+    "es6-promise-pool": "^2.5.0",
     "request": "^2.85.0",
     "request-promise": "^4.2.2"
   },

src/index.js

@@ -1,12 +1,14 @@
 import request from 'request-promise'
 import fs from 'fs'
+import PromisePool from 'es6-promise-pool'
 
 const BASE_SENTRY_URL = 'https://sentry.io/api/0'
 
 const DEFAULT_INCLUDE = /\.js$|\.map$/
 const DEFAULT_TRANSFORM = filename => `~/${filename}`
 const DEFAULT_DELETE_REGEX = /\.map$/
 const DEFAULT_BODY_TRANSFORM = (version, projects) => ({ version, projects })
+const DEFAULT_UPLOAD_FILES_CONCURRENCY = Infinity
 
 module.exports = class SentryPlugin {
   constructor(options) {
@@ -71,6 +73,8 @@ module.exports = class SentryPlugin {
 
     this.deleteAfterCompile = options.deleteAfterCompile
     this.deleteRegex = options.deleteRegex || DEFAULT_DELETE_REGEX
+    this.uploadFilesConcurrency =
+      options.uploadFilesConcurrency || DEFAULT_UPLOAD_FILES_CONCURRENCY
   }
 
   apply(compiler) {
@@ -191,7 +195,15 @@ module.exports = class SentryPlugin {
   }
 
   uploadFiles(files) {
-    return Promise.all(files.map(this.uploadFile.bind(this)))
+    const pool = new PromisePool(() => {
+      const file = files.pop()
+      if (!file) {
+        return null
+      }
+
+      return this.uploadFile(file)
+    }, this.uploadFilesConcurrency)
+    return pool.start()
   }
 
   uploadFile({ path, name }) {

yarn.lock

@@ -1619,6 +1619,10 @@ es-to-primitive@^1.1.1:
     is-date-object "^1.0.1"
     is-symbol "^1.0.1"
 
+es6-promise-pool@^2.5.0:
+  version "2.5.0"
+  resolved "https://registry.yarnpkg.com/es6-promise-pool/-/es6-promise-pool-2.5.0.tgz#147c612b36b47f105027f9d2bf54a598a99d9ccb"
+
 escape-string-regexp@^1.0.2, escape-string-regexp@^1.0.5:
   version "1.0.5"
   resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4"