Issue #115, make poll delay configurable in Beanstalk deployment task

aws · Oct 23, 2018 · cdba472 · cdba472
1 parent 91b3bed
commit cdba472
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
-### 1.1.7 (TBD)
+### 1.1.7 (2018-10-24)
 
 * Fixed issue #112, shell task not initialized correctly when a role-based credential endpoint was used.
+* Issue #115, added option to the Elastic Beanstalk deployment task allowing configuration of event polling frequency  during deployment. The default (and minimum) delay is 5 seconds. Users can now specify a custom delay of up to 5 minutes (300 seconds) to help avoid throttling errors from the service when multiple deployments are in progress, all polling for events.
 
 ### 1.1.6 (2018-10-01)
 

diff --git a/Tasks/BeanstalkDeployApplication/helpers/DeployApplicationTaskOperations.ts b/Tasks/BeanstalkDeployApplication/helpers/DeployApplicationTaskOperations.ts
@@ -69,7 +69,10 @@ export class TaskOperations {
                                      this.taskParameters.description,
                                      this.taskParameters.applicationType === TaskParameters.applicationTypeExistingVersion);
 
-        await this.waitForDeploymentCompletion(this.taskParameters.applicationName, this.taskParameters.environmentName, startingEventDate);
+        await this.waitForDeploymentCompletion(this.taskParameters.applicationName,
+                                               this.taskParameters.environmentName,
+                                               startingEventDate,
+                                               this.taskParameters.eventPollingDelay);
 
         if (this.taskParameters.outputVariable) {
             console.log(tl.loc('SettingOutputVariable', this.taskParameters.outputVariable, versionLabel));
@@ -137,7 +140,8 @@ export class TaskOperations {
 
     private async waitForDeploymentCompletion(applicationName: string,
                                               environmentName: string,
-                                              startingEventDate: Date): Promise<void> {
+                                              startingEventDate: Date,
+                                              eventPollDelay: number): Promise<void> {
 
         const requestEnvironment: Beanstalk.DescribeEnvironmentsMessage = {
             ApplicationName: applicationName,
@@ -153,12 +157,15 @@ export class TaskOperations {
         let lastPrintedEventDate = startingEventDate;
 
         console.log(tl.loc('WaitingForDeployment'));
+        console.log(tl.loc('ConfiguredEventPollDelay', eventPollDelay));
+
         console.log(tl.loc('EventsComing'));
 
         let success = true;
         let environment: Beanstalk.EnvironmentDescription;
         do {
-            await this.sleep(5000);
+            tl.debug(`...event poll sleep for ${eventPollDelay}s`);
+            await this.sleep(eventPollDelay * 1000);
 
             const responseEnvironments = await this.beanstalkClient.describeEnvironments(requestEnvironment).promise();
             if (responseEnvironments.Environments.length === 0) {

diff --git a/Tasks/BeanstalkDeployApplication/helpers/DeployApplicationTaskParameters.ts b/Tasks/BeanstalkDeployApplication/helpers/DeployApplicationTaskParameters.ts
@@ -14,9 +14,13 @@ export class TaskParameters extends AWSTaskParametersBase {
     // options for applicationType
     public static readonly applicationTypeAspNet: string = 'aspnet';
     public static readonly applicationTypeAspNetCoreForWindows: string = 'aspnetCoreWindows';
+
     public static readonly applicationTypeS3Archive: string = 's3';
     public static readonly applicationTypeExistingVersion: string = 'version';
 
+    public static readonly defaultEventPollingDelay: number = 5; // seconds
+    public static readonly maxEventPollingDelay: number = 300; // seconds, 5 mins
+
     public applicationName: string;
     public environmentName: string;
     public applicationType: string;
@@ -28,6 +32,7 @@ export class TaskParameters extends AWSTaskParametersBase {
     public description: string;
 
     public outputVariable: string;
+    public eventPollingDelay: number = TaskParameters.defaultEventPollingDelay;
 
     constructor() {
         super();
@@ -62,6 +67,22 @@ export class TaskParameters extends AWSTaskParametersBase {
             this.versionLabel = tl.getInput('versionLabel', this.applicationType === TaskParameters.applicationTypeExistingVersion);
             this.description = tl.getInput('description', false);
             this.outputVariable = tl.getInput('outputVariable', false);
+            const pollDelay = tl.getInput('eventPollingDelay', false);
+            if (pollDelay) {
+                try {
+                    const pollDelayValue = parseInt(pollDelay, 10);
+                    if (pollDelayValue >= TaskParameters.defaultEventPollingDelay && pollDelayValue <= TaskParameters.maxEventPollingDelay) {
+                        this.eventPollingDelay = pollDelayValue;
+                    } else {
+                        throw new Error();
+                    }
+                } catch {
+                    console.log(tl.loc('InvalidEventPollDelay',
+                                       pollDelay,
+                                       TaskParameters.defaultEventPollingDelay,
+                                       TaskParameters.maxEventPollingDelay));
+                }
+            }
         } catch (error) {
             throw new Error(error.message);
         }

diff --git a/Tasks/BeanstalkDeployApplication/task.json b/Tasks/BeanstalkDeployApplication/task.json
@@ -126,7 +126,7 @@
             "type": "string",
             "required": false,
             "defaultValue": "",
-            "helpMarkDown": "Optional description of the version"
+            "helpMarkDown": "Optional description of the version."
         },
         {
             "name": "outputVariable",
@@ -136,6 +136,14 @@
             "helpMarkDown": "The name of the variable that will contain the version label of the new application revision.",
             "required": false
         },
+        {
+            "name": "eventPollingDelay",
+            "type": "string",
+            "label": "Event poll delay (seconds)",
+            "defaultValue": "5",
+            "helpMarkDown": "The time, in seconds, to wait between calls to retrieve the latest events from the deployment to the environment.",
+            "required": false
+        },
         {
             "name": "logRequest",
             "type": "boolean",
@@ -188,6 +196,8 @@
         "SettingOutputVariable": "Setting output variable %s with the version label %s",
         "ApplicationExistsQueryError": "DescribeApplications: error %s returned querying for existence of application %s",
         "EnvironmentExistsQueryError": "DescribeEnvironments: error %s thrown querying for existence of environment %s for application %s",
+        "InvalidEventPollDelay": "Event polling delay setting of %s is invalid (minimum %s seconds, maximum %s seconds) - task will use minimum poll delay by default",
+        "ConfiguredEventPollDelay": "Task configured to wait %s seconds between queries for deployment events",
         "TaskCompleted": "Deployment to application %s completed"
     }
 }