feat: Configurable unhealthiness status for beanstalk environments (#17)

Author: Justinon

src/deploy.ts

@@ -118,7 +118,7 @@ export async function deployToGroup(props: IDeployToGroupProps) {
       region: group.region,
     });
     await createAppVersionsForGroup(client, props);
-    // Must wait for envs to be healthy before issuing deployment
+    log.info(chalk.blue('Verifying environments are ready to receive deployment before initiating...'));
     await waitForGroupHealthiness({
       client,
       group,

src/helpers/Interfaces.ts

@@ -1,4 +1,4 @@
-import { S3Location } from '@aws-sdk/client-elastic-beanstalk';
+import { S3Location, EnvironmentHealthStatus } from '@aws-sdk/client-elastic-beanstalk';
 import log from 'loglevel';
 
 /**
@@ -65,6 +65,11 @@ export interface IHealthCheckProps {
    * @default 60000
    */
   readonly timeBetweenAttemptsMs: number;
+  /**
+   * Which statuses qualify a beanstalk environment as unhealthy.
+   * @default ['Severe', 'Degraded', 'Warning']
+   */
+  readonly unhealthyStatuses?: EnvironmentHealthStatus[];
 }
 
 /**

src/helpers/healthiness.ts

@@ -4,12 +4,13 @@ import {
   DescribeEnvironmentsCommandOutput,
   ElasticBeanstalkClient,
   EnvironmentDescription,
+  EnvironmentHealthStatus,
 } from '@aws-sdk/client-elastic-beanstalk';
 import log from 'loglevel';
 import { DBHealthinessCheckError } from './Errors';
 import { IBeanstalkEnvironment, IBeanstalkGroup, IHealthCheckProps } from './Interfaces';
 
-const AWS_EB_HEALTH_CHECK_UNHEALTHY_STATES = ['Severe', 'Degraded', 'Warning'];
+const AWS_EB_HEALTH_CHECK_UNHEALTHY_STATES: EnvironmentHealthStatus[] = ['Severe', 'Degraded', 'Warning'];
 
 interface IEnvironmentsByApp {
   [app: string]: IBeanstalkEnvironment[];
@@ -65,6 +66,7 @@ function groupEnvsByApp(envs: IBeanstalkEnvironment[]): IEnvironmentsByApp {
  */
 function getEnvironmentsHealth(
   envs: EnvironmentDescription[],
+  unhealthyStatuses: EnvironmentHealthStatus[],
   expectedVersionLabel?: string,
 ): IBeanstalkHealthStatuses {
   return envs.reduce(
@@ -75,7 +77,7 @@ function getEnvironmentsHealth(
           `Beanstalk status for '${envDesc.EnvironmentName}' could not be retrieved. Cannot proceed safely.`,
         );
       }
-      const isInHealthyState = !AWS_EB_HEALTH_CHECK_UNHEALTHY_STATES.includes(envDesc.HealthStatus);
+      const isInHealthyState = !unhealthyStatuses.includes(envDesc.HealthStatus as EnvironmentHealthStatus);
       if (envDesc.Status === 'Ready' && isInHealthyState) {
         if (!expectedVersionLabel) {
           previousValue.healthy.push({
@@ -136,6 +138,7 @@ async function getGroupHealth(props: IHealthCheckPropsPrivate): Promise<IBeansta
 
       const partitioned = getEnvironmentsHealth(
         resp.Environments,
+        props.unhealthyStatuses ?? AWS_EB_HEALTH_CHECK_UNHEALTHY_STATES,
         props.checkVersion ? props.group.versionProps.label : undefined,
       );
       statuses.healthy = [...statuses.healthy, ...partitioned.healthy];

test/deploy.test.ts

@@ -257,4 +257,59 @@ describe('Deployment to beanstalks in different apps', () => {
     const expectedCalls = 6;
     expect(ebMock.commandCalls(DescribeEnvironmentsCommand)).toHaveLength(expectedCalls);
   });
+
+  test('with custom unhealthyStatuses succeeds to become healthy after one retry attempt', async () => {
+    ebMock
+      .on(DescribeEnvironmentsCommand, {
+        ApplicationName: TEST_BEANSTALK_GROUP.environments[1].app,
+        EnvironmentNames: [TEST_BEANSTALK_GROUP.environments[1].name],
+      })
+      // Initial health check prior to deployment succeeds
+      .resolvesOnce({
+        Environments: [
+          {
+            EnvironmentName: TEST_BEANSTALK_GROUP.environments[1].name,
+            HealthStatus: 'Ok',
+            Status: 'Ready',
+            VersionLabel: 'OLD_VERSION',
+          },
+        ],
+      })
+      // Initial health check after deployment fails
+      .resolvesOnce({
+        Environments: [
+          {
+            EnvironmentName: TEST_BEANSTALK_GROUP.environments[1].name,
+            HealthStatus: 'Degraded',
+            Status: 'Updating',
+            VersionLabel: 'OLD_VERSION',
+          },
+        ],
+      })
+      // Second health check after deployment succeeds
+      .resolves({
+        Environments: [
+          {
+            EnvironmentName: TEST_BEANSTALK_GROUP.environments[1].name,
+            HealthStatus: 'Warning',
+            Status: 'Ready',
+            VersionLabel: TEST_BEANSTALK_GROUP.versionProps.label,
+          },
+        ],
+      });
+
+    expect(
+      await deployToGroup({
+        ...commonDeployProps,
+        postDeployHealthCheckProps: {
+          attempts: 3,
+          timeBetweenAttemptsMs: 0,
+          unhealthyStatuses: ['Severe'],
+        },
+      }),
+    ).not.toThrowError;
+    // 2 pre-deploy checks (one per Application), 4 post-deploy checks (one retry)
+    const expectedCalls = 6;
+    expect(ebMock.commandCalls(DescribeEnvironmentsCommand)).toHaveLength(expectedCalls);
+  });
 });