feat: bulk update issues and network concurrency limit

UpHabit · Sep 24, 2019 · 2bebfd4 · 2bebfd4
1 parent fd99acf
commit 2bebfd4
Show file tree

Hide file tree

Showing 6 changed files with 3,651 additions and 71 deletions.
diff --git a/README.md b/README.md
@@ -60,5 +60,8 @@ interface Config {
   // defaults to `v${version}` which results in a version that is named like `v1.0.0`
   // ex: `Semantic Release v${version}` results in `Semantic Release v1.0.0`
   releaseNameTemplate?: string;
+
+  // The number of maximum parallel network calls
+  networkConcurrency?: number;
 }
 ```
diff --git a/lib/success.ts b/lib/success.ts
@@ -1,5 +1,6 @@
 import JiraClient, { Version } from 'jira-connector';
 import * as _ from 'lodash';
+import pLimit from 'p-limit';
 
 import { makeClient } from './jira';
 import { GenerateNotesContext, PluginConfig } from './types';
@@ -62,6 +63,39 @@ async function findOrCreateVersion(config: PluginConfig, context: GenerateNotesC
   return newVersion;
 }
 
+async function editIssueFixVersions(config: PluginConfig, context: GenerateNotesContext, jira: JiraClient, newVersionName: string, releaseVersionId: string, issueKey: string): Promise<void> {
+  try {
+    context.logger.info(`Adding issue ${issueKey} to '${newVersionName}'`);
+    if (!config.dryRun) {
+      await jira.issue.editIssue({
+        issueKey,
+        issue: {
+          update: {
+            fixVersions: [{
+              add: { id: releaseVersionId },
+            }],
+          },
+        },
+      });
+    }
+  } catch (err) {
+    const allowedStatusCodes = [400, 404];
+    let { statusCode } = err;
+    if (typeof err === 'string') {
+      try {
+        err = JSON.parse(err);
+        statusCode = statusCode || err.statusCode;
+      } catch (err) {
+          // it's not json :shrug:
+      }
+    }
+    if (allowedStatusCodes.indexOf(statusCode) === -1) {
+      throw err;
+    }
+    context.logger.error(`Unable to update issue ${issueKey} statusCode: ${statusCode}`);
+  }
+}
+
 export async function success(config: PluginConfig, context: GenerateNotesContext): Promise<void> {
   const tickets = getTickets(config, context);
 
@@ -77,37 +111,13 @@ export async function success(config: PluginConfig, context: GenerateNotesContex
   const project = await jira.project.getProject({ projectIdOrKey: config.projectId });
   const releaseVersion = await findOrCreateVersion(config, context, jira, project.id, newVersionName);
 
-  for (const issueKey of tickets) {
-    try {
-      context.logger.info(`Adding issue ${issueKey} to '${newVersionName}'`);
-      if (!config.dryRun) {
-        await jira.issue.editIssue({
-          issueKey,
-          issue: {
-            update: {
-              fixVersions: [{
-                add: { id: releaseVersion.id },
-              }],
-            },
-          },
-        });
-      }
-    } catch (err) {
-      const allowedStatusCodes = [400, 404];
-      let { statusCode } = err;
-      if (typeof err === 'string') {
-        try {
-          err = JSON.parse(err);
-          statusCode = statusCode || err.statusCode;
-        } catch (err) {
-          // it's not json :shrug:
-        }
-      }
-      if (allowedStatusCodes.indexOf(statusCode) === -1) {
-        throw err;
-      }
-      context.logger.error(`Unable to update issue ${issueKey} statusCode: ${statusCode}`);
-    }
-  }
+  const concurrentLimit = pLimit(config.networkConcurrency || 10);
+
+  const edits = tickets.map(issueKey =>
+    concurrentLimit(() =>
+      editIssueFixVersions(config, context, jira, newVersionName, releaseVersion.id, issueKey),
+    ),
+  );
 
+  await Promise.all(edits);
 }
diff --git a/lib/types.ts b/lib/types.ts
@@ -61,4 +61,5 @@ export interface PluginConfig extends BaseConfig {
   projectId: string;
   releaseNameTemplate?: string;
   jiraHost: string;
+  networkConcurrency?: number;
 }
diff --git a/lib/verifyConditions.ts b/lib/verifyConditions.ts
@@ -4,6 +4,8 @@ import { makeClient } from './jira';
 import { PluginConfig, PluginContext } from './types';
 
 export async function verifyConditions(config: PluginConfig, context: PluginContext): Promise<void> {
+  const { networkConcurrency } = config;
+
   if (typeof config.jiraHost !== 'string') {
     throw new SemanticReleaseError(`config.jiraHost must be a string`);
   }
@@ -40,6 +42,10 @@ export async function verifyConditions(config: PluginConfig, context: PluginCont
     }
   }
 
+  if (networkConcurrency && (typeof networkConcurrency !== 'number' || networkConcurrency < 1)) {
+    throw new SemanticReleaseError(`config.networkConcurrency must be an number greater than 0`);
+  }
+
   if (!context.env.JIRA_AUTH) {
     throw new SemanticReleaseError(`JIRA_AUTH must be a string`);
   }

diff --git a/package.json b/package.json
@@ -15,6 +15,7 @@
     "@semantic-release/error": "^2.2.0",
     "jira-connector": "^2.16.0",
     "lodash": "^4.17.11",
+    "p-limit": "^2.2.1",
     "tslib": "^1.9.2"
   },
   "devDependencies": {