@guardian/cdk 61.5.2 → 61.6.0

package/lib/experimental/patterns/ec2-app.d.ts

@@ -1,8 +1,10 @@
 import type { IAspect } from "aws-cdk-lib";
 import { CfnParameter, Duration } from "aws-cdk-lib";
+import { UpdatePolicy } from "aws-cdk-lib/aws-autoscaling";
 import type { IConstruct } from "constructs";
 import { GuAutoScalingGroup } from "../../constructs/autoscaling";
 import type { GuStack } from "../../constructs/core";
+import type { GuApplicationTargetGroup } from "../../constructs/loadbalancing";
 import type { GuEc2AppProps } from "../../patterns";
 import { GuEc2App } from "../../patterns";
 interface AutoScalingRollingUpdateDurations {
@@ -16,6 +18,26 @@ interface AutoScalingRollingUpdateDurations {
     buffer: Duration;
 }
 export declare const RollingUpdateDurations: AutoScalingRollingUpdateDurations;
+/**
+ * Ensures the `AutoScalingRollingUpdate` of an AutoScaling Group has a `PauseTime` matching the healthcheck grace period.
+ * It also ensures the `CreationPolicy` resource signal `Timeout` matches the healthcheck grace period.
+ *
+ * @internal
+ *
+ * @privateRemarks
+ * The ASG healthcheck grace period is hard-coded by {@link GuEc2App}.
+ * Customisation of this value is performed via an escape hatch.
+ * An `Aspect` is the only way to observe any customisation.
+ *
+ * TODO Expose the healthcheck grace period as a property on {@link GuEc2App} and remove this `Aspect`.
+ */
+export declare class GuAutoScalingRollingUpdateTimeoutExperimental implements IAspect {
+    readonly stack: GuStack;
+    private static instance;
+    private constructor();
+    static getInstance(stack: GuStack): GuAutoScalingRollingUpdateTimeoutExperimental;
+    visit(construct: IConstruct): void;
+}
 /**
  * An `Aspect` that adjusts the properties of an AutoScaling Group using an `AutoScalingRollingUpdate` update policy.
  *
@@ -36,12 +58,12 @@ export declare const RollingUpdateDurations: AutoScalingRollingUpdateDurations;
  *
  * @see https://github.com/guardian/testing-asg-rolling-update
  */
-export declare class HorizontallyScalingDeploymentProperties implements IAspect {
+export declare class GuHorizontallyScalingDeploymentPropertiesExperimental implements IAspect {
     readonly stack: GuStack;
     readonly asgToParamMap: Map<string, CfnParameter>;
     private static instance;
     private constructor();
-    static getInstance(stack: GuStack): HorizontallyScalingDeploymentProperties;
+    static getInstance(stack: GuStack): GuHorizontallyScalingDeploymentPropertiesExperimental;
     visit(construct: IConstruct): void;
 }
 export declare function getAsgRollingUpdateCfnParameterName(autoScalingGroup: GuAutoScalingGroup): string;
@@ -55,6 +77,49 @@ export interface GuEc2AppExperimentalProps extends Omit<GuEc2AppProps, "updatePo
      */
     buildIdentifier: string;
 }
+/**
+ * Configures the rolling update policy for the autoscaling group.
+ *
+ * Most applications should not need to instantiate this class directly as this policy is set by GuEc2AppExperimental.
+ *
+ * If you need to use this class for a service other than MAPI, please speak to DevX about your use-case first.
+ */
+export declare class GuRollingUpdatePolicyExperimental {
+    static getPolicy(maximumInstances: number, minimumInstances?: number): UpdatePolicy;
+}
+export interface GuRoleForRollingUpdateExperimentalProps {
+    autoScalingGroup: GuAutoScalingGroup;
+}
+/**
+ * Grants the role associated with your autoscaling group the necessary permissions for the rolling update deployment
+ * mechanism.
+ *
+ * Most applications should not need to instantiate this class directly as these permission changes are granted
+ * by GuEc2AppExperimental.
+ *
+ * If you need to use this class for a service other than MAPI, please speak to DevX about your use-case first.
+ */
+export declare class GuRoleForRollingUpdateExperimental {
+    constructor(scope: GuStack, props: GuRoleForRollingUpdateExperimentalProps);
+}
+export interface GuUserDataForRollingUpdateExperimentalProps {
+    autoScalingGroup: GuAutoScalingGroup;
+    targetGroup: GuApplicationTargetGroup;
+    applicationPort: number;
+    buildIdentifier: string;
+}
+/**
+ * Modifies the user-data script (which runs whenever an instance is launched) to make it compatible with the new
+ * rolling update deployment mechanism.
+ *
+ * Most applications should not need to instantiate this class directly as these user-data changes are already made
+ * by GuEc2AppExperimental.
+ *
+ * If you need to use this class for a service other than MAPI, please speak to DevX about your use-case first.
+ */
+export declare class GuUserDataForRollingUpdateExperimental {
+    constructor(scope: GuStack, props: GuUserDataForRollingUpdateExperimentalProps);
+}
 /**
  * An experimental pattern to instantiate an EC2 application that is updated entirely via CloudFormation.
  * It sets the update policy of the `AWS::AutoScaling::AutoScalingGroup` to `AutoScalingRollingUpdate`.

package/lib/experimental/patterns/ec2-app.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ec2-app.d.ts","sourceRoot":"","sources":["../../../src/experimental/patterns/ec2-app.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAW,YAAY,EAAE,QAAQ,EAAQ,MAAM,aAAa,CAAC;AAIpE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG1C,UAAU,iCAAiC;IACzC;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;CAClB;AAED,eAAO,MAAM,sBAAsB,EAAE,iCAGpC,CAAC;AA+DF;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,qBAAa,uCAAwC,YAAW,OAAO;IACrE,SAAgB,KAAK,EAAE,OAAO,CAAC;IAC/B,SAAgB,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACzD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAsD;IAE7E,OAAO;WAKO,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,uCAAuC;IAQ3E,KAAK,CAAC,SAAS,EAAE,UAAU;CA+DnC;AAED,wBAAgB,mCAAmC,CAAC,gBAAgB,EAAE,kBAAkB,UAGvF;AA8CD,MAAM,WAAW,yBAA0B,SAAQ,IAAI,CAAC,aAAa,EAAE,cAAc,CAAC;IACpF;;;;;;OAMG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAAa,oBAAqB,SAAQ,QAAQ;gBACpC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,yBAAyB;CA+F7D"}
+{"version":3,"file":"ec2-app.d.ts","sourceRoot":"","sources":["../../../src/experimental/patterns/ec2-app.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAW,YAAY,EAAE,QAAQ,EAAQ,MAAM,aAAa,CAAC;AACpE,OAAO,EAAyD,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAGlH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAC/E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG1C,UAAU,iCAAiC;IACzC;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;CAClB;AAED,eAAO,MAAM,sBAAsB,EAAE,iCAGpC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,qBAAa,6CAA8C,YAAW,OAAO;IAC3E,SAAgB,KAAK,EAAE,OAAO,CAAC;IAC/B,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA4D;IAEnF,OAAO;WAIO,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,6CAA6C;IAOjF,KAAK,CAAC,SAAS,EAAE,UAAU;CA+BnC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,qDAAsD,YAAW,OAAO;IACnF,SAAgB,KAAK,EAAE,OAAO,CAAC;IAC/B,SAAgB,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACzD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAoE;IAE3F,OAAO;WAKO,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,qDAAqD;IAQzF,KAAK,CAAC,SAAS,EAAE,UAAU;CA+DnC;AAED,wBAAgB,mCAAmC,CAAC,gBAAgB,EAAE,kBAAkB,UAGvF;AA8CD,MAAM,WAAW,yBAA0B,SAAQ,IAAI,CAAC,aAAa,EAAE,cAAc,CAAC;IACpF;;;;;;OAMG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;;;;;GAMG;AACH,qBAAa,iCAAiC;IAC5C,MAAM,CAAC,SAAS,CAAC,gBAAgB,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,MAAM;CAgBrE;AAED,MAAM,WAAW,uCAAuC;IACtD,gBAAgB,EAAE,kBAAkB,CAAC;CACtC;AAED;;;;;;;;GAQG;AACH,qBAAa,kCAAkC;gBACjC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,uCAAuC;CAU3E;AAED,MAAM,WAAW,2CAA2C;IAC1D,gBAAgB,EAAE,kBAAkB,CAAC;IACrC,WAAW,EAAE,wBAAwB,CAAC;IACtC,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;;;;;;;GAQG;AACH,qBAAa,sCAAsC;gBACrC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,2CAA2C;CAkD/E;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAAa,oBAAqB,SAAQ,QAAQ;gBACpC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,yBAAyB;CAsC7D"}

package/lib/experimental/patterns/ec2-app.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GuEc2AppExperimental = exports.getAsgRollingUpdateCfnParameterName = exports.HorizontallyScalingDeploymentProperties = exports.RollingUpdateDurations = void 0;
+exports.GuEc2AppExperimental = exports.GuUserDataForRollingUpdateExperimental = exports.GuRoleForRollingUpdateExperimental = exports.GuRollingUpdatePolicyExperimental = exports.getAsgRollingUpdateCfnParameterName = exports.GuHorizontallyScalingDeploymentPropertiesExperimental = exports.GuAutoScalingRollingUpdateTimeoutExperimental = exports.RollingUpdateDurations = void 0;
 const aws_cdk_lib_1 = require("aws-cdk-lib");
 const aws_autoscaling_1 = require("aws-cdk-lib/aws-autoscaling");
 const aws_iam_1 = require("aws-cdk-lib/aws-iam");
@@ -25,13 +25,13 @@ exports.RollingUpdateDurations = {
  *
  * TODO Expose the healthcheck grace period as a property on {@link GuEc2App} and remove this `Aspect`.
  */
-class AutoScalingRollingUpdateTimeout {
+class GuAutoScalingRollingUpdateTimeoutExperimental {
     constructor(scope) {
         this.stack = scope;
     }
     static getInstance(stack) {
         if (!this.instance || !(0, singleton_1.isSingletonPresentInStack)(stack, this.instance)) {
-            this.instance = new AutoScalingRollingUpdateTimeout(stack);
+            this.instance = new GuAutoScalingRollingUpdateTimeoutExperimental(stack);
         }
         return this.instance;
     }
@@ -63,6 +63,7 @@ class AutoScalingRollingUpdateTimeout {
         }
     }
 }
+exports.GuAutoScalingRollingUpdateTimeoutExperimental = GuAutoScalingRollingUpdateTimeoutExperimental;
 /**
  * An `Aspect` that adjusts the properties of an AutoScaling Group using an `AutoScalingRollingUpdate` update policy.
  *
@@ -83,15 +84,14 @@ class AutoScalingRollingUpdateTimeout {
  *
  * @see https://github.com/guardian/testing-asg-rolling-update
  */
-// eslint-disable-next-line custom-rules/experimental-classes -- this class is not indented for public use
-class HorizontallyScalingDeploymentProperties {
+class GuHorizontallyScalingDeploymentPropertiesExperimental {
     constructor(scope) {
         this.stack = scope;
         this.asgToParamMap = new Map();
     }
     static getInstance(stack) {
         if (!this.instance || !(0, singleton_1.isSingletonPresentInStack)(stack, this.instance)) {
-            this.instance = new HorizontallyScalingDeploymentProperties(stack);
+            this.instance = new GuHorizontallyScalingDeploymentPropertiesExperimental(stack);
         }
         return this.instance;
     }
@@ -146,7 +146,7 @@ class HorizontallyScalingDeploymentProperties {
         }
     }
 }
-exports.HorizontallyScalingDeploymentProperties = HorizontallyScalingDeploymentProperties;
+exports.GuHorizontallyScalingDeploymentPropertiesExperimental = GuHorizontallyScalingDeploymentPropertiesExperimental;
 function getAsgRollingUpdateCfnParameterName(autoScalingGroup) {
     const { app } = autoScalingGroup;
     return `MinInstancesInServiceFor${app.replaceAll("-", "")}`;
@@ -189,6 +189,106 @@ class AsgRollingUpdatePolicy extends aws_iam_1.Policy {
         return this.instance;
     }
 }
+/**
+ * Configures the rolling update policy for the autoscaling group.
+ *
+ * Most applications should not need to instantiate this class directly as this policy is set by GuEc2AppExperimental.
+ *
+ * If you need to use this class for a service other than MAPI, please speak to DevX about your use-case first.
+ */
+class GuRollingUpdatePolicyExperimental {
+    static getPolicy(maximumInstances, minimumInstances) {
+        return aws_autoscaling_1.UpdatePolicy.rollingUpdate({
+            maxBatchSize: maximumInstances,
+            minInstancesInService: minimumInstances,
+            minSuccessPercentage: 100,
+            waitOnResourceSignals: true,
+            /*
+            If a scale-in event fires during an `AutoScalingRollingUpdate` operation, the update could fail and rollback.
+            For this reason, we suspend the `AlarmNotification` process, else availability of a service cannot be guaranteed.
+            Consequently, services cannot scale-out during deployments.
+            If AWS ever supports suspending scale-out and scale-in independently, we should allow scale-out.
+             */
+            suspendProcesses: [aws_autoscaling_1.ScalingProcess.ALARM_NOTIFICATION],
+            // Note: there is also an important property called pauseTime, but this is set via an Aspect.
+        });
+    }
+}
+exports.GuRollingUpdatePolicyExperimental = GuRollingUpdatePolicyExperimental;
+/**
+ * Grants the role associated with your autoscaling group the necessary permissions for the rolling update deployment
+ * mechanism.
+ *
+ * Most applications should not need to instantiate this class directly as these permission changes are granted
+ * by GuEc2AppExperimental.
+ *
+ * If you need to use this class for a service other than MAPI, please speak to DevX about your use-case first.
+ */
+class GuRoleForRollingUpdateExperimental {
+    constructor(scope, props) {
+        const policy = AsgRollingUpdatePolicy.getInstance(scope);
+        policy.attachToRole(props.autoScalingGroup.role);
+        // Create the Policy with necessary permissions first.
+        // Then create the ASG that requires the permissions.
+        const cfnPolicy = policy.node.defaultChild;
+        const cfnAutoScalingGroup = props.autoScalingGroup.node.defaultChild;
+        cfnAutoScalingGroup.addDependency(cfnPolicy);
+    }
+}
+exports.GuRoleForRollingUpdateExperimental = GuRoleForRollingUpdateExperimental;
+/**
+ * Modifies the user-data script (which runs whenever an instance is launched) to make it compatible with the new
+ * rolling update deployment mechanism.
+ *
+ * Most applications should not need to instantiate this class directly as these user-data changes are already made
+ * by GuEc2AppExperimental.
+ *
+ * If you need to use this class for a service other than MAPI, please speak to DevX about your use-case first.
+ */
+class GuUserDataForRollingUpdateExperimental {
+    constructor(scope, props) {
+        const { region, stackId } = scope;
+        const { autoScalingGroup, targetGroup, applicationPort, buildIdentifier } = props;
+        const cfnAutoScalingGroup = autoScalingGroup.node.defaultChild;
+        /*
+          `aws` is available via AMIgo baked AMIs.
+          See https://github.com/guardian/amigo/tree/main/roles/aws-tools.
+           */
+        autoScalingGroup.userData.addCommands(`# ${GuEc2AppExperimental.name} UserData Start`, `
+      TOKEN=$(curl -X PUT "http://169.254.169.254/latest/api/token" -H "X-aws-ec2-metadata-token-ttl-seconds: 21600")
+      INSTANCE_ID=$(curl -H "X-aws-ec2-metadata-token: $TOKEN" "http://169.254.169.254/latest/meta-data/instance-id")
+
+      STATE=$(aws elbv2 describe-target-health \
+        --target-group-arn ${targetGroup.targetGroupArn} \
+        --region ${region} \
+        --targets Id=$INSTANCE_ID,Port=${applicationPort} \
+        --query "TargetHealthDescriptions[0].TargetHealth.State")
+
+      until [ "$STATE" == "\\"healthy\\"" ]; do
+        echo "Instance running build ${buildIdentifier} not yet healthy within target group. Current state $STATE. Sleeping..."
+        sleep ${exports.RollingUpdateDurations.sleep.toSeconds()}
+        STATE=$(aws elbv2 describe-target-health \
+          --target-group-arn ${targetGroup.targetGroupArn} \
+          --region ${region} \
+          --targets Id=$INSTANCE_ID,Port=${applicationPort} \
+          --query "TargetHealthDescriptions[0].TargetHealth.State")
+      done
+
+      echo "Instance running build ${buildIdentifier} is healthy in target group."
+      `, `# ${GuEc2AppExperimental.name} UserData End`);
+        autoScalingGroup.userData.addOnExitCommands(`
+        cfn-signal --stack ${stackId} \
+          --resource ${cfnAutoScalingGroup.logicalId} \
+          --region ${region} \
+          --exit-code $exitCode || echo 'Failed to send Cloudformation Signal'
+        `);
+        // If https://github.com/guardian/devx-logs is used, this tag will be added as a marker to logs in Central ELK.
+        aws_cdk_lib_1.Tags.of(autoScalingGroup.instanceLaunchTemplate).add(constants_1.MetadataKeys.BUILD_IDENTIFIER, buildIdentifier, {
+            applyToLaunchedInstances: true,
+        });
+    }
+}
+exports.GuUserDataForRollingUpdateExperimental = GuUserDataForRollingUpdateExperimental;
 /**
  * An experimental pattern to instantiate an EC2 application that is updated entirely via CloudFormation.
  * It sets the update policy of the `AWS::AutoScaling::AutoScalingGroup` to `AutoScalingRollingUpdate`.
@@ -227,27 +327,16 @@ class GuEc2AppExperimental extends patterns_1.GuEc2App {
     constructor(scope, props) {
         const { minimumInstances, maximumInstances = minimumInstances * 2 } = props.scaling;
         const { applicationPort, buildIdentifier } = props;
-        const { region, stackId } = scope;
         super(scope, {
             ...props,
-            updatePolicy: aws_autoscaling_1.UpdatePolicy.rollingUpdate({
-                maxBatchSize: maximumInstances,
-                minInstancesInService: minimumInstances,
-                minSuccessPercentage: 100,
-                waitOnResourceSignals: true,
-                /*
-                If a scale-in event fires during an `AutoScalingRollingUpdate` operation, the update could fail and rollback.
-                For this reason, we suspend the `AlarmNotification` process, else availability of a service cannot be guaranteed.
-                Consequently, services cannot scale-out during deployments.
-                If AWS ever supports suspending scale-out and scale-in independently, we should allow scale-out.
-                 */
-                suspendProcesses: [aws_autoscaling_1.ScalingProcess.ALARM_NOTIFICATION],
-            }),
+            // Note: if the service uses horizontal scaling, minimumInstances is overridden by an Aspect (to prevent accidental scale downs!)
+            updatePolicy: GuRollingUpdatePolicyExperimental.getPolicy(maximumInstances, minimumInstances),
         });
         const { autoScalingGroup, targetGroup } = this;
-        const { userData, role } = autoScalingGroup;
         const cfnAutoScalingGroup = autoScalingGroup.node.defaultChild;
+        // Note: if the service uses horizontal scaling, this property is unset by an Aspect (to prevent accidental scale downs!)
         cfnAutoScalingGroup.desiredCapacity = minimumInstances.toString();
+        // This is used when an ASG is first created; it is not needed to support the new deployment mechanism
         cfnAutoScalingGroup.cfnOptions.creationPolicy = {
             autoScalingCreationPolicy: {
                 minSuccessfulInstancesPercent: 100,
@@ -256,51 +345,16 @@ class GuEc2AppExperimental extends patterns_1.GuEc2App {
                 count: minimumInstances,
             },
         };
-        const policy = AsgRollingUpdatePolicy.getInstance(scope);
-        policy.attachToRole(role);
-        // Create the Policy with necessary permissions first.
-        // Then create the ASG that requires the permissions.
-        const cfnPolicy = policy.node.defaultChild;
-        cfnAutoScalingGroup.addDependency(cfnPolicy);
-        /*
-        `aws` is available via AMIgo baked AMIs.
-        See https://github.com/guardian/amigo/tree/main/roles/aws-tools.
-         */
-        userData.addCommands(`# ${GuEc2AppExperimental.name} UserData Start`, `
-      TOKEN=$(curl -X PUT "http://169.254.169.254/latest/api/token" -H "X-aws-ec2-metadata-token-ttl-seconds: 21600")
-      INSTANCE_ID=$(curl -H "X-aws-ec2-metadata-token: $TOKEN" "http://169.254.169.254/latest/meta-data/instance-id")
-
-      STATE=$(aws elbv2 describe-target-health \
-        --target-group-arn ${targetGroup.targetGroupArn} \
-        --region ${region} \
-        --targets Id=$INSTANCE_ID,Port=${applicationPort} \
-        --query "TargetHealthDescriptions[0].TargetHealth.State")
-
-      until [ "$STATE" == "\\"healthy\\"" ]; do
-        echo "Instance running build ${buildIdentifier} not yet healthy within target group. Current state $STATE. Sleeping..."
-        sleep ${exports.RollingUpdateDurations.sleep.toSeconds()}
-        STATE=$(aws elbv2 describe-target-health \
-          --target-group-arn ${targetGroup.targetGroupArn} \
-          --region ${region} \
-          --targets Id=$INSTANCE_ID,Port=${applicationPort} \
-          --query "TargetHealthDescriptions[0].TargetHealth.State")
-      done
-
-      echo "Instance running build ${buildIdentifier} is healthy in target group."
-      `, `# ${GuEc2AppExperimental.name} UserData End`);
-        userData.addOnExitCommands(`
-        cfn-signal --stack ${stackId} \
-          --resource ${cfnAutoScalingGroup.logicalId} \
-          --region ${region} \
-          --exit-code $exitCode || echo 'Failed to send Cloudformation Signal'
-        `);
-        // If https://github.com/guardian/devx-logs is used, this tag will be added as a marker to logs in Central ELK.
-        aws_cdk_lib_1.Tags.of(autoScalingGroup.instanceLaunchTemplate).add(constants_1.MetadataKeys.BUILD_IDENTIFIER, buildIdentifier, {
-            applyToLaunchedInstances: true,
+        new GuRoleForRollingUpdateExperimental(scope, { autoScalingGroup });
+        new GuUserDataForRollingUpdateExperimental(scope, {
+            autoScalingGroup,
+            targetGroup,
+            applicationPort,
+            buildIdentifier,
         });
         // TODO Once out of experimental, instantiate these `Aspect`s directly in `GuStack`.
-        aws_cdk_lib_1.Aspects.of(scope).add(AutoScalingRollingUpdateTimeout.getInstance(scope));
-        aws_cdk_lib_1.Aspects.of(scope).add(HorizontallyScalingDeploymentProperties.getInstance(scope));
+        aws_cdk_lib_1.Aspects.of(scope).add(GuAutoScalingRollingUpdateTimeoutExperimental.getInstance(scope));
+        aws_cdk_lib_1.Aspects.of(scope).add(GuHorizontallyScalingDeploymentPropertiesExperimental.getInstance(scope));
     }
 }
 exports.GuEc2AppExperimental = GuEc2AppExperimental;

package/lib/experimental/patterns/ec2-app.js.map

@@ -1 +1 @@
-{"version":3,"file":"ec2-app.js","sourceRoot":"","sources":["../../../src/experimental/patterns/ec2-app.ts"],"names":[],"mappings":";;;AACA,6CAAoE;AACpE,iEAAkH;AAElH,iDAAsE;AAEtE,+CAA+C;AAC/C,8DAAkE;AAGlE,6CAA0C;AAC1C,qDAAkE;AAcrD,QAAA,sBAAsB,GAAsC;IACvE,KAAK,EAAE,sBAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1B,MAAM,EAAE,sBAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;CAC5B,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,+BAA+B;IAInC,YAAoB,KAAc;QAChC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,KAAc;QACtC,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAA,qCAAyB,EAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE;YACtE,IAAI,CAAC,QAAQ,GAAG,IAAI,+BAA+B,CAAC,KAAK,CAAC,CAAC;SAC5D;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,SAAqB;QAChC,IAAI,SAAS,YAAY,qCAAmB,EAAE;YAC5C,MAAM,oBAAoB,GAAG,SAAS,CAAC,UAAU,CAAC,YAAY,EAAE,wBAAwB,CAAC;YACzF,MAAM,qBAAqB,GAAG,SAAS,CAAC,UAAU,CAAC,cAAc,CAAC;YAElE,IAAI,CAAC,SAAS,CAAC,sBAAsB,EAAE;gBACrC,MAAM,IAAI,KAAK,CAAC,8DAA8D,SAAS,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;aACrG;YAED,MAAM,oBAAoB,GAAG,SAAS,CAAC,sBAAsB,GAAG,8BAAsB,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YAE1G,IAAI,oBAAoB,EAAE;gBACxB,SAAS,CAAC,UAAU,CAAC,YAAY,GAAG;oBAClC,wBAAwB,EAAE;wBACxB,GAAG,oBAAoB;wBACvB,SAAS,EAAE,sBAAQ,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,WAAW,EAAE;qBAChE;iBACF,CAAC;aACH;YAED,IAAI,qBAAqB,EAAE;gBACzB,SAAS,CAAC,UAAU,CAAC,cAAc,GAAG;oBACpC,GAAG,qBAAqB;oBACxB,cAAc,EAAE;wBACd,GAAG,qBAAqB,CAAC,cAAc;wBACvC,OAAO,EAAE,sBAAQ,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,WAAW,EAAE;qBAC9D;iBACF,CAAC;aACH;SACF;IACH,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,0GAA0G;AAC1G,MAAa,uCAAuC;IAKlD,YAAoB,KAAc;QAChC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,EAAE,CAAC;IACjC,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,KAAc;QACtC,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAA,qCAAyB,EAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE;YACtE,IAAI,CAAC,QAAQ,GAAG,IAAI,uCAAuC,CAAC,KAAK,CAAC,CAAC;SACpE;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,SAAqB;QAChC,IAAI,SAAS,YAAY,kCAAgB,EAAE;YACzC,MAAM,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC;YAC3B,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;YAE9B;;;;;;;;;;;;;eAaG;YACH,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAA2B,EAAE,CAAC,CAAC,YAAY,gCAAkB,CAAC,CAAC;YAEtG,IAAI,CAAC,gBAAgB,EAAE;gBACrB,MAAM,IAAI,KAAK,CACb,iFAAiF,IAAI,wDAAwD,CAC9I,CAAC;aACH;YAED,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,IAAI,CAAC,YAAmC,CAAC;YACtF,MAAM,oBAAoB,GAAG,mBAAmB,CAAC,UAAU,CAAC,YAAY,EAAE,wBAAwB,CAAC;YAEnG,IAAI,oBAAoB,EAAE;gBACxB;;;;mBAIG;gBACH,mBAAmB,CAAC,eAAe,GAAG,SAAS,CAAC;gBAEhD,MAAM,SAAS,GAAG,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;gBAE3C,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;oBACtC,MAAM,gBAAgB,GAAG,mCAAmC,CAAC,gBAAgB,CAAC,CAAC;oBAC/E,IAAI,CAAC,aAAa,CAAC,GAAG,CACpB,SAAS,EACT,IAAI,0BAAY,CAAC,IAAI,CAAC,KAAK,EAAE,gBAAgB,EAAE;wBAC7C,IAAI,EAAE,QAAQ;wBACd,OAAO,EAAE,QAAQ,CAAC,mBAAmB,CAAC,OAAO,CAAC;wBAC9C,QAAQ,EAAE,QAAQ,CAAC,mBAAmB,CAAC,OAAO,CAAC,GAAG,CAAC;qBACpD,CAAC,CACH,CAAC;iBACH;gBAED,MAAM,qBAAqB,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,SAAS,CAAE,CAAC;gBAEjE,mBAAmB,CAAC,UAAU,CAAC,YAAY,GAAG;oBAC5C,wBAAwB,EAAE;wBACxB,GAAG,oBAAoB;wBACvB,qBAAqB,EAAE,qBAAqB,CAAC,aAAa;qBAC3D;iBACF,CAAC;aACH;SACF;IACH,CAAC;CACF;AAjFD,0FAiFC;AAED,SAAgB,mCAAmC,CAAC,gBAAoC;IACtF,MAAM,EAAE,GAAG,EAAE,GAAG,gBAAgB,CAAC;IACjC,OAAO,2BAA2B,GAAG,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,CAAC;AAC9D,CAAC;AAHD,kFAGC;AAED;;;;;GAKG;AACH,MAAM,sBAAuB,SAAQ,gBAAM;IAGzC,YAAoB,KAAc;QAChC,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;QAE1B,KAAK,CAAC,KAAK,EAAE,wBAAwB,EAAE;YACrC,UAAU,EAAE;gBACV,uCAAuC;gBACvC,IAAI,yBAAe,CAAC;oBAClB,OAAO,EAAE,CAAC,+BAA+B,CAAC;oBAC1C,MAAM,EAAE,gBAAM,CAAC,KAAK;oBACpB,SAAS,EAAE,CAAC,OAAO,CAAC;iBACrB,CAAC;gBAEF;;;;mBAIG;gBACH,IAAI,yBAAe,CAAC;oBAClB,OAAO,EAAE,CAAC,2CAA2C,CAAC;oBACtD,MAAM,EAAE,gBAAM,CAAC,KAAK;oBACpB,SAAS,EAAE,CAAC,GAAG,CAAC;iBACjB,CAAC;aACH;SACF,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,KAAc;QACtC,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAA,qCAAyB,EAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE;YACtE,IAAI,CAAC,QAAQ,GAAG,IAAI,sBAAsB,CAAC,KAAK,CAAC,CAAC;SACnD;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;CACF;AAaD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAa,oBAAqB,SAAQ,mBAAQ;IAChD,YAAY,KAAc,EAAE,KAAgC;QAC1D,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,gBAAgB,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC;QACpF,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,GAAG,KAAK,CAAC;QACnD,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;QAElC,KAAK,CAAC,KAAK,EAAE;YACX,GAAG,KAAK;YACR,YAAY,EAAE,8BAAY,CAAC,aAAa,CAAC;gBACvC,YAAY,EAAE,gBAAgB;gBAC9B,qBAAqB,EAAE,gBAAgB;gBACvC,oBAAoB,EAAE,GAAG;gBACzB,qBAAqB,EAAE,IAAI;gBAE3B;;;;;mBAKG;gBACH,gBAAgB,EAAE,CAAC,gCAAc,CAAC,kBAAkB,CAAC;aACtD,CAAC;SACH,CAAC,CAAC;QAEH,MAAM,EAAE,gBAAgB,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;QAC/C,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,gBAAgB,CAAC;QAC5C,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,IAAI,CAAC,YAAmC,CAAC;QAEtF,mBAAmB,CAAC,eAAe,GAAG,gBAAgB,CAAC,QAAQ,EAAE,CAAC;QAElE,mBAAmB,CAAC,UAAU,CAAC,cAAc,GAAG;YAC9C,yBAAyB,EAAE;gBACzB,6BAA6B,EAAE,GAAG;aACnC;YACD,cAAc,EAAE;gBACd,KAAK,EAAE,gBAAgB;aACxB;SACF,CAAC;QAEF,MAAM,MAAM,GAAG,sBAAsB,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACzD,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAE1B,sDAAsD;QACtD,qDAAqD;QACrD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,YAAyB,CAAC;QACxD,mBAAmB,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QAE7C;;;WAGG;QACH,QAAQ,CAAC,WAAW,CAClB,KAAK,oBAAoB,CAAC,IAAI,iBAAiB,EAC/C;;;;;6BAKuB,WAAW,CAAC,cAAc;mBACpC,MAAM;yCACgB,eAAe;;;;uCAIjB,eAAe;gBACtC,8BAAsB,CAAC,KAAK,CAAC,SAAS,EAAE;;+BAEzB,WAAW,CAAC,cAAc;qBACpC,MAAM;2CACgB,eAAe;;;;qCAIrB,eAAe;OAC7C,EACD,KAAK,oBAAoB,CAAC,IAAI,eAAe,CAC9C,CAAC;QAEF,QAAQ,CAAC,iBAAiB,CACxB;6BACuB,OAAO;uBACb,mBAAmB,CAAC,SAAS;qBAC/B,MAAM;;SAElB,CACJ,CAAC;QAEF,+GAA+G;QAC/G,kBAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,sBAAsB,CAAC,CAAC,GAAG,CAAC,wBAAY,CAAC,gBAAgB,EAAE,eAAe,EAAE;YACnG,wBAAwB,EAAE,IAAI;SAC/B,CAAC,CAAC;QAEH,oFAAoF;QACpF,qBAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,+BAA+B,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1E,qBAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,uCAAuC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;IACpF,CAAC;CACF;AAhGD,oDAgGC","sourcesContent":["import type { IAspect } from \"aws-cdk-lib\";\nimport { Aspects, CfnParameter, Duration, Tags } from \"aws-cdk-lib\";\nimport { CfnAutoScalingGroup, CfnScalingPolicy, ScalingProcess, UpdatePolicy } from \"aws-cdk-lib/aws-autoscaling\";\nimport type { CfnPolicy } from \"aws-cdk-lib/aws-iam\";\nimport { Effect, Policy, PolicyStatement } from \"aws-cdk-lib/aws-iam\";\nimport type { IConstruct } from \"constructs\";\nimport { MetadataKeys } from \"../../constants\";\nimport { GuAutoScalingGroup } from \"../../constructs/autoscaling\";\nimport type { GuStack } from \"../../constructs/core\";\nimport type { GuEc2AppProps } from \"../../patterns\";\nimport { GuEc2App } from \"../../patterns\";\nimport { isSingletonPresentInStack } from \"../../utils/singleton\";\n\ninterface AutoScalingRollingUpdateDurations {\n  /**\n   * The time between each check of an instance's health within the target group.\n   */\n  sleep: Duration;\n\n  /**\n   * Additional time to cover the time spent polling an instance's health within the target group before sending the CloudFormation signal.\n   */\n  buffer: Duration;\n}\n\nexport const RollingUpdateDurations: AutoScalingRollingUpdateDurations = {\n  sleep: Duration.seconds(5),\n  buffer: Duration.minutes(1),\n};\n\n/**\n * Ensures the `AutoScalingRollingUpdate` of an AutoScaling Group has a `PauseTime` matching the healthcheck grace period.\n * It also ensures the `CreationPolicy` resource signal `Timeout` matches the healthcheck grace period.\n *\n * @internal\n *\n * @privateRemarks\n * The ASG healthcheck grace period is hard-coded by {@link GuEc2App}.\n * Customisation of this value is performed via an escape hatch.\n * An `Aspect` is the only way to observe any customisation.\n *\n * TODO Expose the healthcheck grace period as a property on {@link GuEc2App} and remove this `Aspect`.\n */\nclass AutoScalingRollingUpdateTimeout implements IAspect {\n  public readonly stack: GuStack;\n  private static instance: AutoScalingRollingUpdateTimeout | undefined;\n\n  private constructor(scope: GuStack) {\n    this.stack = scope;\n  }\n\n  public static getInstance(stack: GuStack): AutoScalingRollingUpdateTimeout {\n    if (!this.instance || !isSingletonPresentInStack(stack, this.instance)) {\n      this.instance = new AutoScalingRollingUpdateTimeout(stack);\n    }\n    return this.instance;\n  }\n\n  public visit(construct: IConstruct) {\n    if (construct instanceof CfnAutoScalingGroup) {\n      const currentRollingUpdate = construct.cfnOptions.updatePolicy?.autoScalingRollingUpdate;\n      const currentCreationPolicy = construct.cfnOptions.creationPolicy;\n\n      if (!construct.healthCheckGracePeriod) {\n        throw new Error(`The healthcheck grace period not set for autoscaling group ${construct.node.id}.`);\n      }\n\n      const signalTimeoutSeconds = construct.healthCheckGracePeriod + RollingUpdateDurations.buffer.toSeconds();\n\n      if (currentRollingUpdate) {\n        construct.cfnOptions.updatePolicy = {\n          autoScalingRollingUpdate: {\n            ...currentRollingUpdate,\n            pauseTime: Duration.seconds(signalTimeoutSeconds).toIsoString(),\n          },\n        };\n      }\n\n      if (currentCreationPolicy) {\n        construct.cfnOptions.creationPolicy = {\n          ...currentCreationPolicy,\n          resourceSignal: {\n            ...currentCreationPolicy.resourceSignal,\n            timeout: Duration.seconds(signalTimeoutSeconds).toIsoString(),\n          },\n        };\n      }\n    }\n  }\n}\n\n/**\n * An `Aspect` that adjusts the properties of an AutoScaling Group using an `AutoScalingRollingUpdate` update policy.\n *\n * It'll unset the `DesiredCapacity` of the ASG as a rolling update sets `Desired` back to the template version,\n * undoing any changes that a scale-out event may have done.\n * Having `DesiredCapacity` unset ensures the service remains at-capacity at all times.\n *\n * It'll also make the `MinInstancesInService` property dynamic via a CFN Parameter that Riff-Raff will set.\n * The value depends on the current capacity of the ASG:\n *  - If the service is running normally, it'll be set to the `MinSize` capacity\n *  - If the service is partially scaled, it'll be set to the current `DesiredCapacity`\n *  - If the service is fully scaled, it'll be set to (at least) `MaxSize` - 1\n *\n * @privateRemarks\n * - Temporarily implemented as a singleton to ensure only one instance is added to a stack,\n *   else multiple attempts to add the same CFN Parameter will be made and fail.\n * - Once out of experimental, instantiate this `Aspect` directly in {@link GuStack}.\n *\n * @see https://github.com/guardian/testing-asg-rolling-update\n */\n// eslint-disable-next-line custom-rules/experimental-classes -- this class is not indented for public use\nexport class HorizontallyScalingDeploymentProperties implements IAspect {\n  public readonly stack: GuStack;\n  public readonly asgToParamMap: Map<string, CfnParameter>;\n  private static instance: HorizontallyScalingDeploymentProperties | undefined;\n\n  private constructor(scope: GuStack) {\n    this.stack = scope;\n    this.asgToParamMap = new Map();\n  }\n\n  public static getInstance(stack: GuStack): HorizontallyScalingDeploymentProperties {\n    if (!this.instance || !isSingletonPresentInStack(stack, this.instance)) {\n      this.instance = new HorizontallyScalingDeploymentProperties(stack);\n    }\n\n    return this.instance;\n  }\n\n  public visit(construct: IConstruct) {\n    if (construct instanceof CfnScalingPolicy) {\n      const { node } = construct;\n      const { scopes, path } = node;\n\n      /*\n      Requiring a `CfnScalingPolicy` to be created in the scope of a `GuAutoScalingGroup`\n      is the most reliable way to associate the two together.\n\n      Though the `autoScalingGroupName` property is passed to a `CfnScalingPolicy` when instantiating,\n      this does not create a concrete link as AWS CDK sets the value to be the ASG's `Ref`.\n      That is, it is a `Token` until it is synthesised.\n      This is even if the ASG has an explicit name set.\n\n      See also:\n        - https://docs.aws.amazon.com/cdk/v2/guide/tokens.html\n        - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup-return-values\n        - https://github.com/aws/aws-cdk/blob/f6b649d47f8bc30ca741fbb7a4852d51e8275002/packages/aws-cdk-lib/aws-autoscaling/lib/auto-scaling-group.ts#L1560\n       */\n      const autoScalingGroup = scopes.find((_): _ is GuAutoScalingGroup => _ instanceof GuAutoScalingGroup);\n\n      if (!autoScalingGroup) {\n        throw new Error(\n          `Failed to detect the autoscaling group relating to the scaling policy on path ${path}. Was it created in the scope of a GuAutoScalingGroup?`,\n        );\n      }\n\n      const cfnAutoScalingGroup = autoScalingGroup.node.defaultChild as CfnAutoScalingGroup;\n      const currentRollingUpdate = cfnAutoScalingGroup.cfnOptions.updatePolicy?.autoScalingRollingUpdate;\n\n      if (currentRollingUpdate) {\n        /*\n        An autoscaling group that horizontally scales should not explicitly set `Desired`,\n        as a rolling update will set the current `Desired` back to the template version,\n        undoing any changes that a scale-out event may have done.\n         */\n        cfnAutoScalingGroup.desiredCapacity = undefined;\n\n        const asgNodeId = autoScalingGroup.node.id;\n\n        if (!this.asgToParamMap.has(asgNodeId)) {\n          const cfnParameterName = getAsgRollingUpdateCfnParameterName(autoScalingGroup);\n          this.asgToParamMap.set(\n            asgNodeId,\n            new CfnParameter(this.stack, cfnParameterName, {\n              type: \"Number\",\n              default: parseInt(cfnAutoScalingGroup.minSize),\n              maxValue: parseInt(cfnAutoScalingGroup.maxSize) - 1,\n            }),\n          );\n        }\n\n        const minInstancesInService = this.asgToParamMap.get(asgNodeId)!;\n\n        cfnAutoScalingGroup.cfnOptions.updatePolicy = {\n          autoScalingRollingUpdate: {\n            ...currentRollingUpdate,\n            minInstancesInService: minInstancesInService.valueAsNumber,\n          },\n        };\n      }\n    }\n  }\n}\n\nexport function getAsgRollingUpdateCfnParameterName(autoScalingGroup: GuAutoScalingGroup) {\n  const { app } = autoScalingGroup;\n  return `MinInstancesInServiceFor${app.replaceAll(\"-\", \"\")}`;\n}\n\n/**\n * An IAM Policy allowing the sending of a CloudFormation signal.\n *\n * @privateRemarks\n * Implemented as a singleton as the resources can only be tightened at most to the CloudFormation stack.\n */\nclass AsgRollingUpdatePolicy extends Policy {\n  private static instance: AsgRollingUpdatePolicy | undefined;\n\n  private constructor(scope: GuStack) {\n    const { stackId } = scope;\n\n    super(scope, \"AsgRollingUpdatePolicy\", {\n      statements: [\n        // Allow usage of command `cfn-signal`.\n        new PolicyStatement({\n          actions: [\"cloudformation:SignalResource\"],\n          effect: Effect.ALLOW,\n          resources: [stackId],\n        }),\n\n        /*\n        Allow usage of command `aws elbv2 describe-target-health`.\n        AWS Elastic Load Balancing does not support resource based policies, so the resource has to be `*` (any) here.\n        See https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html\n         */\n        new PolicyStatement({\n          actions: [\"elasticloadbalancing:DescribeTargetHealth\"],\n          effect: Effect.ALLOW,\n          resources: [\"*\"],\n        }),\n      ],\n    });\n  }\n\n  public static getInstance(stack: GuStack): AsgRollingUpdatePolicy {\n    if (!this.instance || !isSingletonPresentInStack(stack, this.instance)) {\n      this.instance = new AsgRollingUpdatePolicy(stack);\n    }\n\n    return this.instance;\n  }\n}\n\nexport interface GuEc2AppExperimentalProps extends Omit<GuEc2AppProps, \"updatePolicy\"> {\n  /**\n   * Which application build to run.\n   * This will typically match the build number provided by CI.\n   *\n   * @example\n   * process.env.GITHUB_RUN_NUMBER\n   */\n  buildIdentifier: string;\n}\n\n/**\n * An experimental pattern to instantiate an EC2 application that is updated entirely via CloudFormation.\n * It sets the update policy of the `AWS::AutoScaling::AutoScalingGroup` to `AutoScalingRollingUpdate`.\n * When a CloudFormation update is applied, the current instances in the ASG will be replaced.\n *\n * This pattern also updates the User Data, running some commands AFTER yours.\n * These changes are wrapped in start and end marking comments.\n *\n * This pattern does not enable for scaling events to trigger _during_ a deployment\n * as during testing it was found that scale-in events during deployment led to unpredictable service availability.\n *\n * If a deployment fails, for example when the healthcheck fails, CloudFormation will automatically rollback the changes.\n * This improves on the behaviour of Riff-Raff's `autoscaling` deployment which requires manual intervention on deployment failure.\n *\n * To update the application's code, a CloudFormation update must be triggered.\n * The best way to do this is to include the build number in the application artifact.\n * TODO test User Data includes a build number.\n *\n * @remarks\n * - The rate at which instances are replaced are conditional based on how scaled up the service is.\n *   The more an application is scaled, the longer it'll take to deploy.\n * - It is not necessary to use the `autoscaling` Riff-Raff deployment type in conjunction with this.\n *   Doing so won't break anything, however it'll lengthen the deployment time as instances will be rotated twice.\n *   Please remove it from any manually created `riff-raff.yaml` file.\n * - Your application should include a build number in its filename.\n *   This value will change across builds, and therefore create a CloudFormation template difference to be deployed.\n * - Requires the AWS CLI and `cfn-signal` binaries to be available on the instance, and on the `PATH`.\n *   AMIgo adds these via the `aws-tools` role.\n *\n * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-rollingupdate\n * @see https://github.com/guardian/testing-asg-rolling-update\n *\n * @experimental\n */\nexport class GuEc2AppExperimental extends GuEc2App {\n  constructor(scope: GuStack, props: GuEc2AppExperimentalProps) {\n    const { minimumInstances, maximumInstances = minimumInstances * 2 } = props.scaling;\n    const { applicationPort, buildIdentifier } = props;\n    const { region, stackId } = scope;\n\n    super(scope, {\n      ...props,\n      updatePolicy: UpdatePolicy.rollingUpdate({\n        maxBatchSize: maximumInstances,\n        minInstancesInService: minimumInstances,\n        minSuccessPercentage: 100,\n        waitOnResourceSignals: true,\n\n        /*\n        If a scale-in event fires during an `AutoScalingRollingUpdate` operation, the update could fail and rollback.\n        For this reason, we suspend the `AlarmNotification` process, else availability of a service cannot be guaranteed.\n        Consequently, services cannot scale-out during deployments.\n        If AWS ever supports suspending scale-out and scale-in independently, we should allow scale-out.\n         */\n        suspendProcesses: [ScalingProcess.ALARM_NOTIFICATION],\n      }),\n    });\n\n    const { autoScalingGroup, targetGroup } = this;\n    const { userData, role } = autoScalingGroup;\n    const cfnAutoScalingGroup = autoScalingGroup.node.defaultChild as CfnAutoScalingGroup;\n\n    cfnAutoScalingGroup.desiredCapacity = minimumInstances.toString();\n\n    cfnAutoScalingGroup.cfnOptions.creationPolicy = {\n      autoScalingCreationPolicy: {\n        minSuccessfulInstancesPercent: 100,\n      },\n      resourceSignal: {\n        count: minimumInstances,\n      },\n    };\n\n    const policy = AsgRollingUpdatePolicy.getInstance(scope);\n    policy.attachToRole(role);\n\n    // Create the Policy with necessary permissions first.\n    // Then create the ASG that requires the permissions.\n    const cfnPolicy = policy.node.defaultChild as CfnPolicy;\n    cfnAutoScalingGroup.addDependency(cfnPolicy);\n\n    /*\n    `aws` is available via AMIgo baked AMIs.\n    See https://github.com/guardian/amigo/tree/main/roles/aws-tools.\n     */\n    userData.addCommands(\n      `# ${GuEc2AppExperimental.name} UserData Start`,\n      `\n      TOKEN=$(curl -X PUT \"http://169.254.169.254/latest/api/token\" -H \"X-aws-ec2-metadata-token-ttl-seconds: 21600\")\n      INSTANCE_ID=$(curl -H \"X-aws-ec2-metadata-token: $TOKEN\" \"http://169.254.169.254/latest/meta-data/instance-id\")\n\n      STATE=$(aws elbv2 describe-target-health \\\n        --target-group-arn ${targetGroup.targetGroupArn} \\\n        --region ${region} \\\n        --targets Id=$INSTANCE_ID,Port=${applicationPort} \\\n        --query \"TargetHealthDescriptions[0].TargetHealth.State\")\n\n      until [ \"$STATE\" == \"\\\\\"healthy\\\\\"\" ]; do\n        echo \"Instance running build ${buildIdentifier} not yet healthy within target group. Current state $STATE. Sleeping...\"\n        sleep ${RollingUpdateDurations.sleep.toSeconds()}\n        STATE=$(aws elbv2 describe-target-health \\\n          --target-group-arn ${targetGroup.targetGroupArn} \\\n          --region ${region} \\\n          --targets Id=$INSTANCE_ID,Port=${applicationPort} \\\n          --query \"TargetHealthDescriptions[0].TargetHealth.State\")\n      done\n\n      echo \"Instance running build ${buildIdentifier} is healthy in target group.\"\n      `,\n      `# ${GuEc2AppExperimental.name} UserData End`,\n    );\n\n    userData.addOnExitCommands(\n      `\n        cfn-signal --stack ${stackId} \\\n          --resource ${cfnAutoScalingGroup.logicalId} \\\n          --region ${region} \\\n          --exit-code $exitCode || echo 'Failed to send Cloudformation Signal'\n        `,\n    );\n\n    // If https://github.com/guardian/devx-logs is used, this tag will be added as a marker to logs in Central ELK.\n    Tags.of(autoScalingGroup.instanceLaunchTemplate).add(MetadataKeys.BUILD_IDENTIFIER, buildIdentifier, {\n      applyToLaunchedInstances: true,\n    });\n\n    // TODO Once out of experimental, instantiate these `Aspect`s directly in `GuStack`.\n    Aspects.of(scope).add(AutoScalingRollingUpdateTimeout.getInstance(scope));\n    Aspects.of(scope).add(HorizontallyScalingDeploymentProperties.getInstance(scope));\n  }\n}\n"]}
+{"version":3,"file":"ec2-app.js","sourceRoot":"","sources":["../../../src/experimental/patterns/ec2-app.ts"],"names":[],"mappings":";;;AACA,6CAAoE;AACpE,iEAAkH;AAElH,iDAAsE;AAEtE,+CAA+C;AAC/C,8DAAkE;AAIlE,6CAA0C;AAC1C,qDAAkE;AAcrD,QAAA,sBAAsB,GAAsC;IACvE,KAAK,EAAE,sBAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1B,MAAM,EAAE,sBAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;CAC5B,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAa,6CAA6C;IAIxD,YAAoB,KAAc;QAChC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,KAAc;QACtC,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAA,qCAAyB,EAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE;YACtE,IAAI,CAAC,QAAQ,GAAG,IAAI,6CAA6C,CAAC,KAAK,CAAC,CAAC;SAC1E;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,SAAqB;QAChC,IAAI,SAAS,YAAY,qCAAmB,EAAE;YAC5C,MAAM,oBAAoB,GAAG,SAAS,CAAC,UAAU,CAAC,YAAY,EAAE,wBAAwB,CAAC;YACzF,MAAM,qBAAqB,GAAG,SAAS,CAAC,UAAU,CAAC,cAAc,CAAC;YAElE,IAAI,CAAC,SAAS,CAAC,sBAAsB,EAAE;gBACrC,MAAM,IAAI,KAAK,CAAC,8DAA8D,SAAS,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;aACrG;YAED,MAAM,oBAAoB,GAAG,SAAS,CAAC,sBAAsB,GAAG,8BAAsB,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YAE1G,IAAI,oBAAoB,EAAE;gBACxB,SAAS,CAAC,UAAU,CAAC,YAAY,GAAG;oBAClC,wBAAwB,EAAE;wBACxB,GAAG,oBAAoB;wBACvB,SAAS,EAAE,sBAAQ,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,WAAW,EAAE;qBAChE;iBACF,CAAC;aACH;YAED,IAAI,qBAAqB,EAAE;gBACzB,SAAS,CAAC,UAAU,CAAC,cAAc,GAAG;oBACpC,GAAG,qBAAqB;oBACxB,cAAc,EAAE;wBACd,GAAG,qBAAqB,CAAC,cAAc;wBACvC,OAAO,EAAE,sBAAQ,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,WAAW,EAAE;qBAC9D;iBACF,CAAC;aACH;SACF;IACH,CAAC;CACF;AA9CD,sGA8CC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAa,qDAAqD;IAKhE,YAAoB,KAAc;QAChC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,EAAE,CAAC;IACjC,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,KAAc;QACtC,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAA,qCAAyB,EAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE;YACtE,IAAI,CAAC,QAAQ,GAAG,IAAI,qDAAqD,CAAC,KAAK,CAAC,CAAC;SAClF;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,SAAqB;QAChC,IAAI,SAAS,YAAY,kCAAgB,EAAE;YACzC,MAAM,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC;YAC3B,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;YAE9B;;;;;;;;;;;;;eAaG;YACH,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAA2B,EAAE,CAAC,CAAC,YAAY,gCAAkB,CAAC,CAAC;YAEtG,IAAI,CAAC,gBAAgB,EAAE;gBACrB,MAAM,IAAI,KAAK,CACb,iFAAiF,IAAI,wDAAwD,CAC9I,CAAC;aACH;YAED,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,IAAI,CAAC,YAAmC,CAAC;YACtF,MAAM,oBAAoB,GAAG,mBAAmB,CAAC,UAAU,CAAC,YAAY,EAAE,wBAAwB,CAAC;YAEnG,IAAI,oBAAoB,EAAE;gBACxB;;;;mBAIG;gBACH,mBAAmB,CAAC,eAAe,GAAG,SAAS,CAAC;gBAEhD,MAAM,SAAS,GAAG,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;gBAE3C,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;oBACtC,MAAM,gBAAgB,GAAG,mCAAmC,CAAC,gBAAgB,CAAC,CAAC;oBAC/E,IAAI,CAAC,aAAa,CAAC,GAAG,CACpB,SAAS,EACT,IAAI,0BAAY,CAAC,IAAI,CAAC,KAAK,EAAE,gBAAgB,EAAE;wBAC7C,IAAI,EAAE,QAAQ;wBACd,OAAO,EAAE,QAAQ,CAAC,mBAAmB,CAAC,OAAO,CAAC;wBAC9C,QAAQ,EAAE,QAAQ,CAAC,mBAAmB,CAAC,OAAO,CAAC,GAAG,CAAC;qBACpD,CAAC,CACH,CAAC;iBACH;gBAED,MAAM,qBAAqB,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,SAAS,CAAE,CAAC;gBAEjE,mBAAmB,CAAC,UAAU,CAAC,YAAY,GAAG;oBAC5C,wBAAwB,EAAE;wBACxB,GAAG,oBAAoB;wBACvB,qBAAqB,EAAE,qBAAqB,CAAC,aAAa;qBAC3D;iBACF,CAAC;aACH;SACF;IACH,CAAC;CACF;AAjFD,sHAiFC;AAED,SAAgB,mCAAmC,CAAC,gBAAoC;IACtF,MAAM,EAAE,GAAG,EAAE,GAAG,gBAAgB,CAAC;IACjC,OAAO,2BAA2B,GAAG,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,CAAC;AAC9D,CAAC;AAHD,kFAGC;AAED;;;;;GAKG;AACH,MAAM,sBAAuB,SAAQ,gBAAM;IAGzC,YAAoB,KAAc;QAChC,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;QAE1B,KAAK,CAAC,KAAK,EAAE,wBAAwB,EAAE;YACrC,UAAU,EAAE;gBACV,uCAAuC;gBACvC,IAAI,yBAAe,CAAC;oBAClB,OAAO,EAAE,CAAC,+BAA+B,CAAC;oBAC1C,MAAM,EAAE,gBAAM,CAAC,KAAK;oBACpB,SAAS,EAAE,CAAC,OAAO,CAAC;iBACrB,CAAC;gBAEF;;;;mBAIG;gBACH,IAAI,yBAAe,CAAC;oBAClB,OAAO,EAAE,CAAC,2CAA2C,CAAC;oBACtD,MAAM,EAAE,gBAAM,CAAC,KAAK;oBACpB,SAAS,EAAE,CAAC,GAAG,CAAC;iBACjB,CAAC;aACH;SACF,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,KAAc;QACtC,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAA,qCAAyB,EAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE;YACtE,IAAI,CAAC,QAAQ,GAAG,IAAI,sBAAsB,CAAC,KAAK,CAAC,CAAC;SACnD;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;CACF;AAaD;;;;;;GAMG;AACH,MAAa,iCAAiC;IAC5C,MAAM,CAAC,SAAS,CAAC,gBAAwB,EAAE,gBAAyB;QAClE,OAAO,8BAAY,CAAC,aAAa,CAAC;YAChC,YAAY,EAAE,gBAAgB;YAC9B,qBAAqB,EAAE,gBAAgB;YACvC,oBAAoB,EAAE,GAAG;YACzB,qBAAqB,EAAE,IAAI;YAC3B;;;;;eAKG;YACH,gBAAgB,EAAE,CAAC,gCAAc,CAAC,kBAAkB,CAAC;YACrD,6FAA6F;SAC9F,CAAC,CAAC;IACL,CAAC;CACF;AAjBD,8EAiBC;AAMD;;;;;;;;GAQG;AACH,MAAa,kCAAkC;IAC7C,YAAY,KAAc,EAAE,KAA8C;QACxE,MAAM,MAAM,GAAG,sBAAsB,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACzD,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAEjD,sDAAsD;QACtD,qDAAqD;QACrD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,YAAyB,CAAC;QACxD,MAAM,mBAAmB,GAAG,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,YAAmC,CAAC;QAC5F,mBAAmB,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAC/C,CAAC;CACF;AAXD,gFAWC;AASD;;;;;;;;GAQG;AACH,MAAa,sCAAsC;IACjD,YAAY,KAAc,EAAE,KAAkD;QAC5E,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;QAClC,MAAM,EAAE,gBAAgB,EAAE,WAAW,EAAE,eAAe,EAAE,eAAe,EAAE,GAAG,KAAK,CAAC;QAClF,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,IAAI,CAAC,YAAmC,CAAC;QAEtF;;;aAGK;QACL,gBAAgB,CAAC,QAAQ,CAAC,WAAW,CACnC,KAAK,oBAAoB,CAAC,IAAI,iBAAiB,EAC/C;;;;;6BAKuB,WAAW,CAAC,cAAc;mBACpC,MAAM;yCACgB,eAAe;;;;uCAIjB,eAAe;gBACtC,8BAAsB,CAAC,KAAK,CAAC,SAAS,EAAE;;+BAEzB,WAAW,CAAC,cAAc;qBACpC,MAAM;2CACgB,eAAe;;;;qCAIrB,eAAe;OAC7C,EACD,KAAK,oBAAoB,CAAC,IAAI,eAAe,CAC9C,CAAC;QAEF,gBAAgB,CAAC,QAAQ,CAAC,iBAAiB,CACzC;6BACuB,OAAO;uBACb,mBAAmB,CAAC,SAAS;qBAC/B,MAAM;;SAElB,CACJ,CAAC;QAEF,+GAA+G;QAC/G,kBAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,sBAAsB,CAAC,CAAC,GAAG,CAAC,wBAAY,CAAC,gBAAgB,EAAE,eAAe,EAAE;YACnG,wBAAwB,EAAE,IAAI;SAC/B,CAAC,CAAC;IACL,CAAC;CACF;AAnDD,wFAmDC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAa,oBAAqB,SAAQ,mBAAQ;IAChD,YAAY,KAAc,EAAE,KAAgC;QAC1D,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,gBAAgB,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC;QACpF,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,GAAG,KAAK,CAAC;QAEnD,KAAK,CAAC,KAAK,EAAE;YACX,GAAG,KAAK;YACR,iIAAiI;YACjI,YAAY,EAAE,iCAAiC,CAAC,SAAS,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;SAC9F,CAAC,CAAC;QAEH,MAAM,EAAE,gBAAgB,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;QAC/C,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,IAAI,CAAC,YAAmC,CAAC;QAEtF,yHAAyH;QACzH,mBAAmB,CAAC,eAAe,GAAG,gBAAgB,CAAC,QAAQ,EAAE,CAAC;QAElE,sGAAsG;QACtG,mBAAmB,CAAC,UAAU,CAAC,cAAc,GAAG;YAC9C,yBAAyB,EAAE;gBACzB,6BAA6B,EAAE,GAAG;aACnC;YACD,cAAc,EAAE;gBACd,KAAK,EAAE,gBAAgB;aACxB;SACF,CAAC;QAEF,IAAI,kCAAkC,CAAC,KAAK,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC;QACpE,IAAI,sCAAsC,CAAC,KAAK,EAAE;YAChD,gBAAgB;YAChB,WAAW;YACX,eAAe;YACf,eAAe;SAChB,CAAC,CAAC;QAEH,oFAAoF;QACpF,qBAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,6CAA6C,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;QACxF,qBAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,qDAAqD,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;IAClG,CAAC;CACF;AAvCD,oDAuCC","sourcesContent":["import type { IAspect } from \"aws-cdk-lib\";\nimport { Aspects, CfnParameter, Duration, Tags } from \"aws-cdk-lib\";\nimport { CfnAutoScalingGroup, CfnScalingPolicy, ScalingProcess, UpdatePolicy } from \"aws-cdk-lib/aws-autoscaling\";\nimport type { CfnPolicy } from \"aws-cdk-lib/aws-iam\";\nimport { Effect, Policy, PolicyStatement } from \"aws-cdk-lib/aws-iam\";\nimport type { IConstruct } from \"constructs\";\nimport { MetadataKeys } from \"../../constants\";\nimport { GuAutoScalingGroup } from \"../../constructs/autoscaling\";\nimport type { GuStack } from \"../../constructs/core\";\nimport type { GuApplicationTargetGroup } from \"../../constructs/loadbalancing\";\nimport type { GuEc2AppProps } from \"../../patterns\";\nimport { GuEc2App } from \"../../patterns\";\nimport { isSingletonPresentInStack } from \"../../utils/singleton\";\n\ninterface AutoScalingRollingUpdateDurations {\n  /**\n   * The time between each check of an instance's health within the target group.\n   */\n  sleep: Duration;\n\n  /**\n   * Additional time to cover the time spent polling an instance's health within the target group before sending the CloudFormation signal.\n   */\n  buffer: Duration;\n}\n\nexport const RollingUpdateDurations: AutoScalingRollingUpdateDurations = {\n  sleep: Duration.seconds(5),\n  buffer: Duration.minutes(1),\n};\n\n/**\n * Ensures the `AutoScalingRollingUpdate` of an AutoScaling Group has a `PauseTime` matching the healthcheck grace period.\n * It also ensures the `CreationPolicy` resource signal `Timeout` matches the healthcheck grace period.\n *\n * @internal\n *\n * @privateRemarks\n * The ASG healthcheck grace period is hard-coded by {@link GuEc2App}.\n * Customisation of this value is performed via an escape hatch.\n * An `Aspect` is the only way to observe any customisation.\n *\n * TODO Expose the healthcheck grace period as a property on {@link GuEc2App} and remove this `Aspect`.\n */\nexport class GuAutoScalingRollingUpdateTimeoutExperimental implements IAspect {\n  public readonly stack: GuStack;\n  private static instance: GuAutoScalingRollingUpdateTimeoutExperimental | undefined;\n\n  private constructor(scope: GuStack) {\n    this.stack = scope;\n  }\n\n  public static getInstance(stack: GuStack): GuAutoScalingRollingUpdateTimeoutExperimental {\n    if (!this.instance || !isSingletonPresentInStack(stack, this.instance)) {\n      this.instance = new GuAutoScalingRollingUpdateTimeoutExperimental(stack);\n    }\n    return this.instance;\n  }\n\n  public visit(construct: IConstruct) {\n    if (construct instanceof CfnAutoScalingGroup) {\n      const currentRollingUpdate = construct.cfnOptions.updatePolicy?.autoScalingRollingUpdate;\n      const currentCreationPolicy = construct.cfnOptions.creationPolicy;\n\n      if (!construct.healthCheckGracePeriod) {\n        throw new Error(`The healthcheck grace period not set for autoscaling group ${construct.node.id}.`);\n      }\n\n      const signalTimeoutSeconds = construct.healthCheckGracePeriod + RollingUpdateDurations.buffer.toSeconds();\n\n      if (currentRollingUpdate) {\n        construct.cfnOptions.updatePolicy = {\n          autoScalingRollingUpdate: {\n            ...currentRollingUpdate,\n            pauseTime: Duration.seconds(signalTimeoutSeconds).toIsoString(),\n          },\n        };\n      }\n\n      if (currentCreationPolicy) {\n        construct.cfnOptions.creationPolicy = {\n          ...currentCreationPolicy,\n          resourceSignal: {\n            ...currentCreationPolicy.resourceSignal,\n            timeout: Duration.seconds(signalTimeoutSeconds).toIsoString(),\n          },\n        };\n      }\n    }\n  }\n}\n\n/**\n * An `Aspect` that adjusts the properties of an AutoScaling Group using an `AutoScalingRollingUpdate` update policy.\n *\n * It'll unset the `DesiredCapacity` of the ASG as a rolling update sets `Desired` back to the template version,\n * undoing any changes that a scale-out event may have done.\n * Having `DesiredCapacity` unset ensures the service remains at-capacity at all times.\n *\n * It'll also make the `MinInstancesInService` property dynamic via a CFN Parameter that Riff-Raff will set.\n * The value depends on the current capacity of the ASG:\n *  - If the service is running normally, it'll be set to the `MinSize` capacity\n *  - If the service is partially scaled, it'll be set to the current `DesiredCapacity`\n *  - If the service is fully scaled, it'll be set to (at least) `MaxSize` - 1\n *\n * @privateRemarks\n * - Temporarily implemented as a singleton to ensure only one instance is added to a stack,\n *   else multiple attempts to add the same CFN Parameter will be made and fail.\n * - Once out of experimental, instantiate this `Aspect` directly in {@link GuStack}.\n *\n * @see https://github.com/guardian/testing-asg-rolling-update\n */\nexport class GuHorizontallyScalingDeploymentPropertiesExperimental implements IAspect {\n  public readonly stack: GuStack;\n  public readonly asgToParamMap: Map<string, CfnParameter>;\n  private static instance: GuHorizontallyScalingDeploymentPropertiesExperimental | undefined;\n\n  private constructor(scope: GuStack) {\n    this.stack = scope;\n    this.asgToParamMap = new Map();\n  }\n\n  public static getInstance(stack: GuStack): GuHorizontallyScalingDeploymentPropertiesExperimental {\n    if (!this.instance || !isSingletonPresentInStack(stack, this.instance)) {\n      this.instance = new GuHorizontallyScalingDeploymentPropertiesExperimental(stack);\n    }\n\n    return this.instance;\n  }\n\n  public visit(construct: IConstruct) {\n    if (construct instanceof CfnScalingPolicy) {\n      const { node } = construct;\n      const { scopes, path } = node;\n\n      /*\n      Requiring a `CfnScalingPolicy` to be created in the scope of a `GuAutoScalingGroup`\n      is the most reliable way to associate the two together.\n\n      Though the `autoScalingGroupName` property is passed to a `CfnScalingPolicy` when instantiating,\n      this does not create a concrete link as AWS CDK sets the value to be the ASG's `Ref`.\n      That is, it is a `Token` until it is synthesised.\n      This is even if the ASG has an explicit name set.\n\n      See also:\n        - https://docs.aws.amazon.com/cdk/v2/guide/tokens.html\n        - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup-return-values\n        - https://github.com/aws/aws-cdk/blob/f6b649d47f8bc30ca741fbb7a4852d51e8275002/packages/aws-cdk-lib/aws-autoscaling/lib/auto-scaling-group.ts#L1560\n       */\n      const autoScalingGroup = scopes.find((_): _ is GuAutoScalingGroup => _ instanceof GuAutoScalingGroup);\n\n      if (!autoScalingGroup) {\n        throw new Error(\n          `Failed to detect the autoscaling group relating to the scaling policy on path ${path}. Was it created in the scope of a GuAutoScalingGroup?`,\n        );\n      }\n\n      const cfnAutoScalingGroup = autoScalingGroup.node.defaultChild as CfnAutoScalingGroup;\n      const currentRollingUpdate = cfnAutoScalingGroup.cfnOptions.updatePolicy?.autoScalingRollingUpdate;\n\n      if (currentRollingUpdate) {\n        /*\n        An autoscaling group that horizontally scales should not explicitly set `Desired`,\n        as a rolling update will set the current `Desired` back to the template version,\n        undoing any changes that a scale-out event may have done.\n         */\n        cfnAutoScalingGroup.desiredCapacity = undefined;\n\n        const asgNodeId = autoScalingGroup.node.id;\n\n        if (!this.asgToParamMap.has(asgNodeId)) {\n          const cfnParameterName = getAsgRollingUpdateCfnParameterName(autoScalingGroup);\n          this.asgToParamMap.set(\n            asgNodeId,\n            new CfnParameter(this.stack, cfnParameterName, {\n              type: \"Number\",\n              default: parseInt(cfnAutoScalingGroup.minSize),\n              maxValue: parseInt(cfnAutoScalingGroup.maxSize) - 1,\n            }),\n          );\n        }\n\n        const minInstancesInService = this.asgToParamMap.get(asgNodeId)!;\n\n        cfnAutoScalingGroup.cfnOptions.updatePolicy = {\n          autoScalingRollingUpdate: {\n            ...currentRollingUpdate,\n            minInstancesInService: minInstancesInService.valueAsNumber,\n          },\n        };\n      }\n    }\n  }\n}\n\nexport function getAsgRollingUpdateCfnParameterName(autoScalingGroup: GuAutoScalingGroup) {\n  const { app } = autoScalingGroup;\n  return `MinInstancesInServiceFor${app.replaceAll(\"-\", \"\")}`;\n}\n\n/**\n * An IAM Policy allowing the sending of a CloudFormation signal.\n *\n * @privateRemarks\n * Implemented as a singleton as the resources can only be tightened at most to the CloudFormation stack.\n */\nclass AsgRollingUpdatePolicy extends Policy {\n  private static instance: AsgRollingUpdatePolicy | undefined;\n\n  private constructor(scope: GuStack) {\n    const { stackId } = scope;\n\n    super(scope, \"AsgRollingUpdatePolicy\", {\n      statements: [\n        // Allow usage of command `cfn-signal`.\n        new PolicyStatement({\n          actions: [\"cloudformation:SignalResource\"],\n          effect: Effect.ALLOW,\n          resources: [stackId],\n        }),\n\n        /*\n        Allow usage of command `aws elbv2 describe-target-health`.\n        AWS Elastic Load Balancing does not support resource based policies, so the resource has to be `*` (any) here.\n        See https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html\n         */\n        new PolicyStatement({\n          actions: [\"elasticloadbalancing:DescribeTargetHealth\"],\n          effect: Effect.ALLOW,\n          resources: [\"*\"],\n        }),\n      ],\n    });\n  }\n\n  public static getInstance(stack: GuStack): AsgRollingUpdatePolicy {\n    if (!this.instance || !isSingletonPresentInStack(stack, this.instance)) {\n      this.instance = new AsgRollingUpdatePolicy(stack);\n    }\n\n    return this.instance;\n  }\n}\n\nexport interface GuEc2AppExperimentalProps extends Omit<GuEc2AppProps, \"updatePolicy\"> {\n  /**\n   * Which application build to run.\n   * This will typically match the build number provided by CI.\n   *\n   * @example\n   * process.env.GITHUB_RUN_NUMBER\n   */\n  buildIdentifier: string;\n}\n\n/**\n * Configures the rolling update policy for the autoscaling group.\n *\n * Most applications should not need to instantiate this class directly as this policy is set by GuEc2AppExperimental.\n *\n * If you need to use this class for a service other than MAPI, please speak to DevX about your use-case first.\n */\nexport class GuRollingUpdatePolicyExperimental {\n  static getPolicy(maximumInstances: number, minimumInstances?: number) {\n    return UpdatePolicy.rollingUpdate({\n      maxBatchSize: maximumInstances,\n      minInstancesInService: minimumInstances,\n      minSuccessPercentage: 100,\n      waitOnResourceSignals: true,\n      /*\n      If a scale-in event fires during an `AutoScalingRollingUpdate` operation, the update could fail and rollback.\n      For this reason, we suspend the `AlarmNotification` process, else availability of a service cannot be guaranteed.\n      Consequently, services cannot scale-out during deployments.\n      If AWS ever supports suspending scale-out and scale-in independently, we should allow scale-out.\n       */\n      suspendProcesses: [ScalingProcess.ALARM_NOTIFICATION],\n      // Note: there is also an important property called pauseTime, but this is set via an Aspect.\n    });\n  }\n}\n\nexport interface GuRoleForRollingUpdateExperimentalProps {\n  autoScalingGroup: GuAutoScalingGroup;\n}\n\n/**\n * Grants the role associated with your autoscaling group the necessary permissions for the rolling update deployment\n * mechanism.\n *\n * Most applications should not need to instantiate this class directly as these permission changes are granted\n * by GuEc2AppExperimental.\n *\n * If you need to use this class for a service other than MAPI, please speak to DevX about your use-case first.\n */\nexport class GuRoleForRollingUpdateExperimental {\n  constructor(scope: GuStack, props: GuRoleForRollingUpdateExperimentalProps) {\n    const policy = AsgRollingUpdatePolicy.getInstance(scope);\n    policy.attachToRole(props.autoScalingGroup.role);\n\n    // Create the Policy with necessary permissions first.\n    // Then create the ASG that requires the permissions.\n    const cfnPolicy = policy.node.defaultChild as CfnPolicy;\n    const cfnAutoScalingGroup = props.autoScalingGroup.node.defaultChild as CfnAutoScalingGroup;\n    cfnAutoScalingGroup.addDependency(cfnPolicy);\n  }\n}\n\nexport interface GuUserDataForRollingUpdateExperimentalProps {\n  autoScalingGroup: GuAutoScalingGroup;\n  targetGroup: GuApplicationTargetGroup;\n  applicationPort: number;\n  buildIdentifier: string;\n}\n\n/**\n * Modifies the user-data script (which runs whenever an instance is launched) to make it compatible with the new\n * rolling update deployment mechanism.\n *\n * Most applications should not need to instantiate this class directly as these user-data changes are already made\n * by GuEc2AppExperimental.\n *\n * If you need to use this class for a service other than MAPI, please speak to DevX about your use-case first.\n */\nexport class GuUserDataForRollingUpdateExperimental {\n  constructor(scope: GuStack, props: GuUserDataForRollingUpdateExperimentalProps) {\n    const { region, stackId } = scope;\n    const { autoScalingGroup, targetGroup, applicationPort, buildIdentifier } = props;\n    const cfnAutoScalingGroup = autoScalingGroup.node.defaultChild as CfnAutoScalingGroup;\n\n    /*\n      `aws` is available via AMIgo baked AMIs.\n      See https://github.com/guardian/amigo/tree/main/roles/aws-tools.\n       */\n    autoScalingGroup.userData.addCommands(\n      `# ${GuEc2AppExperimental.name} UserData Start`,\n      `\n      TOKEN=$(curl -X PUT \"http://169.254.169.254/latest/api/token\" -H \"X-aws-ec2-metadata-token-ttl-seconds: 21600\")\n      INSTANCE_ID=$(curl -H \"X-aws-ec2-metadata-token: $TOKEN\" \"http://169.254.169.254/latest/meta-data/instance-id\")\n\n      STATE=$(aws elbv2 describe-target-health \\\n        --target-group-arn ${targetGroup.targetGroupArn} \\\n        --region ${region} \\\n        --targets Id=$INSTANCE_ID,Port=${applicationPort} \\\n        --query \"TargetHealthDescriptions[0].TargetHealth.State\")\n\n      until [ \"$STATE\" == \"\\\\\"healthy\\\\\"\" ]; do\n        echo \"Instance running build ${buildIdentifier} not yet healthy within target group. Current state $STATE. Sleeping...\"\n        sleep ${RollingUpdateDurations.sleep.toSeconds()}\n        STATE=$(aws elbv2 describe-target-health \\\n          --target-group-arn ${targetGroup.targetGroupArn} \\\n          --region ${region} \\\n          --targets Id=$INSTANCE_ID,Port=${applicationPort} \\\n          --query \"TargetHealthDescriptions[0].TargetHealth.State\")\n      done\n\n      echo \"Instance running build ${buildIdentifier} is healthy in target group.\"\n      `,\n      `# ${GuEc2AppExperimental.name} UserData End`,\n    );\n\n    autoScalingGroup.userData.addOnExitCommands(\n      `\n        cfn-signal --stack ${stackId} \\\n          --resource ${cfnAutoScalingGroup.logicalId} \\\n          --region ${region} \\\n          --exit-code $exitCode || echo 'Failed to send Cloudformation Signal'\n        `,\n    );\n\n    // If https://github.com/guardian/devx-logs is used, this tag will be added as a marker to logs in Central ELK.\n    Tags.of(autoScalingGroup.instanceLaunchTemplate).add(MetadataKeys.BUILD_IDENTIFIER, buildIdentifier, {\n      applyToLaunchedInstances: true,\n    });\n  }\n}\n\n/**\n * An experimental pattern to instantiate an EC2 application that is updated entirely via CloudFormation.\n * It sets the update policy of the `AWS::AutoScaling::AutoScalingGroup` to `AutoScalingRollingUpdate`.\n * When a CloudFormation update is applied, the current instances in the ASG will be replaced.\n *\n * This pattern also updates the User Data, running some commands AFTER yours.\n * These changes are wrapped in start and end marking comments.\n *\n * This pattern does not enable for scaling events to trigger _during_ a deployment\n * as during testing it was found that scale-in events during deployment led to unpredictable service availability.\n *\n * If a deployment fails, for example when the healthcheck fails, CloudFormation will automatically rollback the changes.\n * This improves on the behaviour of Riff-Raff's `autoscaling` deployment which requires manual intervention on deployment failure.\n *\n * To update the application's code, a CloudFormation update must be triggered.\n * The best way to do this is to include the build number in the application artifact.\n * TODO test User Data includes a build number.\n *\n * @remarks\n * - The rate at which instances are replaced are conditional based on how scaled up the service is.\n *   The more an application is scaled, the longer it'll take to deploy.\n * - It is not necessary to use the `autoscaling` Riff-Raff deployment type in conjunction with this.\n *   Doing so won't break anything, however it'll lengthen the deployment time as instances will be rotated twice.\n *   Please remove it from any manually created `riff-raff.yaml` file.\n * - Your application should include a build number in its filename.\n *   This value will change across builds, and therefore create a CloudFormation template difference to be deployed.\n * - Requires the AWS CLI and `cfn-signal` binaries to be available on the instance, and on the `PATH`.\n *   AMIgo adds these via the `aws-tools` role.\n *\n * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-rollingupdate\n * @see https://github.com/guardian/testing-asg-rolling-update\n *\n * @experimental\n */\nexport class GuEc2AppExperimental extends GuEc2App {\n  constructor(scope: GuStack, props: GuEc2AppExperimentalProps) {\n    const { minimumInstances, maximumInstances = minimumInstances * 2 } = props.scaling;\n    const { applicationPort, buildIdentifier } = props;\n\n    super(scope, {\n      ...props,\n      // Note: if the service uses horizontal scaling, minimumInstances is overridden by an Aspect (to prevent accidental scale downs!)\n      updatePolicy: GuRollingUpdatePolicyExperimental.getPolicy(maximumInstances, minimumInstances),\n    });\n\n    const { autoScalingGroup, targetGroup } = this;\n    const cfnAutoScalingGroup = autoScalingGroup.node.defaultChild as CfnAutoScalingGroup;\n\n    // Note: if the service uses horizontal scaling, this property is unset by an Aspect (to prevent accidental scale downs!)\n    cfnAutoScalingGroup.desiredCapacity = minimumInstances.toString();\n\n    // This is used when an ASG is first created; it is not needed to support the new deployment mechanism\n    cfnAutoScalingGroup.cfnOptions.creationPolicy = {\n      autoScalingCreationPolicy: {\n        minSuccessfulInstancesPercent: 100,\n      },\n      resourceSignal: {\n        count: minimumInstances,\n      },\n    };\n\n    new GuRoleForRollingUpdateExperimental(scope, { autoScalingGroup });\n    new GuUserDataForRollingUpdateExperimental(scope, {\n      autoScalingGroup,\n      targetGroup,\n      applicationPort,\n      buildIdentifier,\n    });\n\n    // TODO Once out of experimental, instantiate these `Aspect`s directly in `GuStack`.\n    Aspects.of(scope).add(GuAutoScalingRollingUpdateTimeoutExperimental.getInstance(scope));\n    Aspects.of(scope).add(GuHorizontallyScalingDeploymentPropertiesExperimental.getInstance(scope));\n  }\n}\n"]}

package/lib/riff-raff-yaml-file/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/riff-raff-yaml-file/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAgBvC,OAAO,KAAK,EAMV,YAAY,EAGb,MAAM,SAAS,CAAC;AAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAY;IACzC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAa;IAC1C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAa;IAC1C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAW;IACtC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAEhC;;;;;;;;;;OAUG;IACH,SAAgB,YAAY,EAAE,YAAY,CAAC;IAE3C,OAAO,CAAC,iBAAiB;IASzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACH,OAAO,CAAC,mBAAmB;IAiC3B,OAAO,CAAC,6BAA6B;IAQrC,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,oBAAoB;IAI5B,OAAO,CAAC,sBAAsB;gBAKlB,GAAG,EAAE,GAAG;IA+FpB;;;OAGG;IACH,MAAM,IAAI,MAAM;IAiBhB;;;OAGG;IACH,KAAK,IAAI,IAAI;CAId"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/riff-raff-yaml-file/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAgBvC,OAAO,KAAK,EAMV,YAAY,EAGb,MAAM,SAAS,CAAC;AAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAY;IACzC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAa;IAC1C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAa;IAC1C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAW;IACtC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAEhC;;;;;;;;;;OAUG;IACH,SAAgB,YAAY,EAAE,YAAY,CAAC;IAE3C,OAAO,CAAC,iBAAiB;IASzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACH,OAAO,CAAC,mBAAmB;IAiC3B,OAAO,CAAC,6BAA6B;IAQrC,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,oBAAoB;IAI5B,OAAO,CAAC,sBAAsB;gBAKlB,GAAG,EAAE,GAAG;IAgGpB;;;OAGG;IACH,MAAM,IAAI,MAAM;IAiBhB;;;OAGG;IACH,KAAK,IAAI,IAAI;CAId"}

package/lib/riff-raff-yaml-file/index.js

@@ -211,7 +211,7 @@ class RiffRaffYamlFile {
                         deployments.set(asgDeployment.name, asgDeployment.props);
                     });
                     const amiParametersToTags = (0, cloudformation_1.getAmiParameters)(autoscalingGroups);
-                    const minInServiceParamMap = ec2_app_1.HorizontallyScalingDeploymentProperties.getInstance(stack).asgToParamMap;
+                    const minInServiceParamMap = ec2_app_1.GuHorizontallyScalingDeploymentPropertiesExperimental.getInstance(stack).asgToParamMap;
                     const minInServiceAsgs = autoscalingGroups.filter((asg) => minInServiceParamMap.has(asg.node.id));
                     const minInstancesInServiceParameters = (0, cloudformation_1.getMinInstancesInServiceParameters)(minInServiceAsgs);
                     deployments.set(cfnDeployment.name, {

package/lib/riff-raff-yaml-file/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/riff-raff-yaml-file/index.ts"],"names":[],"mappings":";;;;;;AAAA,2BAAmC;AACnC,gDAAwB;AAExB,6CAAoC;AAEpC,qCAA+B;AAC/B,2DAA+D;AAC/D,6CAA6C;AAC7C,iDAAwD;AACxD,8DAA2F;AAC3F,2DAA6F;AAC7F,iEAIsC;AACtC,iDAAoF;AACpF,yCAA8D;AAY9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAa,gBAAgB;IAoBnB,iBAAiB,CAAC,aAAuB,EAAE,aAAuB;QACxE,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YAClD,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,QAAQ,CAAC;YAClC,OAAO,KAAK,KAAK,aAAa,IAAI,KAAK,KAAK,aAAa,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,CAAC,OAAO,CAAC;IACnB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACK,mBAAmB;QAKzB,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;QAE5C,MAAM,MAAM,GAAkB,YAAY,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,QAAQ,EAAE,EAAE;YAC1E,OAAO;gBACL,GAAG,WAAW;gBACd,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,QAAQ,EAAE,EAAE;oBACxD,OAAO;wBACL,GAAG,WAAW;wBACd,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG;qBACnE,CAAC;gBACJ,CAAC,EAAE,EAAE,CAAC;aACP,CAAC;QACJ,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,MAAM,kBAAkB,GAA4B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,iBAAiB,EAAE,EAAE;YACtG,OAAO,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;QAEH,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE;YACjC,MAAM,OAAO,GAAG,4DAA4D,kBAAkB,CAAC,MAAM,cAAc,CAAC;YAEpH,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,kBAAkB,CAAC,CAAC;YAC1C,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAEtB,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;SAC1B;IACH,CAAC;IAEO,6BAA6B;QACnC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,mBAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;QAElF,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,8FAA8F,CAAC,CAAC;SACjH;IACH,CAAC;IAEO,UAAU,CAAC,QAAiB;QAClC,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,yBAAgB,CAAuB,CAAC;IACpG,CAAC;IAEO,oBAAoB,CAAC,QAAiB;QAC5C,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,gCAAkB,CAAyB,CAAC;IACxG,CAAC;IAEO,sBAAsB,CAAC,QAAiB;QAC9C,OAAO,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,cAAO,CAAc,CAAC;IAChF,CAAC;IAED,8GAA8G;IAC9G,YAAY,GAAQ;QAClB,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,cAAO,CAAc,CAAC;QACxF,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QAC3E,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC9C,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACrF,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAErF,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,IAAI,CAAC,6BAA6B,EAAE,CAAC;QAErC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QAEzB,MAAM,WAAW,GAAG,IAAI,GAAG,EAAmD,CAAC;QAE/E,MAAM,aAAa,GAAqB,IAAA,2CAAgC,EAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAE5F,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;YACrD,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;gBACnD,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;oBAChD,MAAM,MAAM,GAAc,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,CAAC;oBAE3D,6FAA6F;oBAC7F,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC;oBAEvB,IAAI,CAAC,KAAK,EAAE;wBACV,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;qBAC1F;oBAED,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;oBACvC,MAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;oBAE3D,MAAM,eAAe,GAAyB;wBAC5C,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,GAAG,CAAC,6BAAoB,CAAC;wBACzE,iBAAiB,CAAC,GAAG,CAAC,uCAAyB,CAAC;qBACjD,CAAC,IAAI,EAAE,CAAC;oBACT,eAAe,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;oBAE3E,MAAM,YAAY,GAAyB,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CACtF,IAAA,yCAAwB,EAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,CAC/C,CAAC;oBAEF,MAAM,aAAa,GAAG,IAAA,yCAAwB,EAAC,MAAM,EAAE,CAAC,GAAG,eAAe,EAAE,GAAG,YAAY,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;oBAC3G,WAAW,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;oBAEzD,MAAM,qBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;oBACrF,2GAA2G;oBAC3G,oDAAoD;oBACpD,qBAAqB,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;wBACvC,MAAM,gBAAgB,GAAG,IAAA,+BAAsB,EAAC,MAAM,EAAE,aAAa,CAAC,CAAC;wBACvE,WAAW,CAAC,GAAG,CAAC,gBAAgB,CAAC,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC;oBACjE,CAAC,CAAC,CAAC;oBAEH;;;uBAGG;oBACH,MAAM,uBAAuB,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;wBAC/D,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,YAAmC,CAAC;wBACpE,MAAM,EAAE,YAAY,EAAE,GAAG,UAAU,CAAC;wBACpC,OAAO,YAAY,EAAE,wBAAwB,KAAK,SAAS,CAAC;oBAC9D,CAAC,CAAC,CAAC;oBAEH,uBAAuB,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;wBACtC,MAAM,aAAa,GAAG,IAAA,mCAAqB,EAAC,GAAG,EAAE,aAAa,CAAC,CAAC;wBAChE,WAAW,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;oBAC3D,CAAC,CAAC,CAAC;oBAEH,MAAM,mBAAmB,GAAG,IAAA,iCAAgB,EAAC,iBAAiB,CAAC,CAAC;oBAEhE,MAAM,oBAAoB,GAAG,iDAAuC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC;oBACtG,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;oBAClG,MAAM,+BAA+B,GAAG,IAAA,mDAAkC,EAAC,gBAAgB,CAAC,CAAC;oBAE7F,WAAW,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE;wBAClC,GAAG,aAAa,CAAC,KAAK;wBACtB,UAAU,EAAE;4BACV,GAAG,aAAa,CAAC,KAAK,CAAC,UAAU;4BAEjC,gEAAgE;4BAChE,GAAG,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,mBAAmB,EAAE,CAAC;4BAE5D,4EAA4E;4BAC5E,GAAG,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,+BAA+B,EAAE,CAAC;yBACxE;qBACF,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,GAAG;YAClB,aAAa;YACb,WAAW;SACZ,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,MAAM;QACJ,qFAAqF;QACrF,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,KAAc,EAAE,EAAE;YAChD,IAAI,KAAK,YAAY,GAAG,EAAE;gBACxB,iGAAiG;gBACjG,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aAC1B;YACD,IAAI,KAAK,YAAY,GAAG,EAAE;gBACxB,iGAAiG;gBACjG,OAAO,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;aAClC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QAEF,OAAO,IAAA,cAAI,EAAC,IAAI,CAAC,YAAY,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,MAAM,OAAO,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QACzD,IAAA,kBAAa,EAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACxC,CAAC;CACF;AArQD,4CAqQC","sourcesContent":["import { writeFileSync } from \"fs\";\nimport path from \"path\";\nimport type { App } from \"aws-cdk-lib\";\nimport { Token } from \"aws-cdk-lib\";\nimport type { CfnAutoScalingGroup } from \"aws-cdk-lib/aws-autoscaling\";\nimport { dump } from \"js-yaml\";\nimport { GuAutoScalingGroup } from \"../constructs/autoscaling\";\nimport { GuStack } from \"../constructs/core\";\nimport { GuLambdaFunction } from \"../constructs/lambda\";\nimport { HorizontallyScalingDeploymentProperties } from \"../experimental/patterns/ec2-app\";\nimport { autoscalingDeployment, uploadAutoscalingArtifact } from \"./deployments/autoscaling\";\nimport {\n  cloudFormationDeployment,\n  getAmiParameters,\n  getMinInstancesInServiceParameters,\n} from \"./deployments/cloudformation\";\nimport { updateLambdaDeployment, uploadLambdaArtifact } from \"./deployments/lambda\";\nimport { groupByClassNameStackRegionStage } from \"./group-by\";\nimport type {\n  GroupedCdkStacks,\n  Region,\n  RiffRaffDeployment,\n  RiffRaffDeploymentName,\n  RiffRaffDeploymentProps,\n  RiffRaffYaml,\n  StackTag,\n  StageTag,\n} from \"./types\";\n\n/**\n * A class that creates a `riff-raff.yaml` file.\n *\n * Rather than using this directly, prefer to use [[`GuRoot`]] instead.\n *\n * Supports:\n *   - Multiple CloudFormation stacks\n *   - Multiple regions\n *   - Lambda applications\n *   - EC2 (autoscaling) applications\n *\n * For lambda applications, 3 deployments will be defined:\n *   1. Lambda upload (`aws-lambda`, `action: [uploadLambda]`)\n *   2. CloudFormation deploy (`cloud-formation`)\n *   3. Lambda update (`aws-lambda`, `action: [updateLambda]`)\n *\n * For EC2 applications, 3 deployments will be defined:\n *   1. Artifact upload (`autoscaling`, `action: [uploadArtifacts]`)\n *  2. CloudFormation deploy (`cloud-formation`)\n *   3. Autoscaling deploy (`autoscaling`, `action: [deploy]`)\n *\n * It assumes a Riff-Raff bundle structure as follows:\n *\n * ```\n * .\n * ├── cdk.out\n * │   └── MyApplication.template.json\n * ├── my-application\n * │   └── my-application.deb\n * └── my-lambda\n *     └── my-lambda.zip\n * ```\n *\n * That is, all CloudFormation templates are in a `cdk.out` directory, and there is a directory per app.\n * Application artifact(s) are in the app directory.\n *\n * NOTE: The file extension is decided by you, the above file tree is used for illustration purposes.\n *\n * NOTE: Resources will be looked up by tags (Stack, Stage, App). Ensure your CFN stack is tagged appropriately!\n *\n * @see https://riffraff.gutools.co.uk/docs/reference/riff-raff.yaml.md\n * @see https://riffraff.gutools.co.uk/docs/magenta-lib/types\n */\nexport class RiffRaffYamlFile {\n  private readonly allCdkStacks: GuStack[];\n  private readonly allStackTags: StackTag[];\n  private readonly allStageTags: StageTag[];\n  private readonly allRegions: Region[];\n  private readonly outdir: string;\n\n  /**\n   * The `riff-raff.yaml` file as an object.\n   *\n   * It is useful for specifying additional deployment types that GuCDK does not support.\n   * Consider raising an issue or pull request if you think it should be supported.\n   *\n   * In most cases, you shouldn't need to access this.\n   * No validation is performed on the parameters you provide, so you might get deployment errors.\n   *\n   * @see https://riffraff.gutools.co.uk/docs/magenta-lib/types\n   */\n  public readonly riffRaffYaml: RiffRaffYaml;\n\n  private isCdkStackPresent(expectedStack: StackTag, expectedStage: StageTag): boolean {\n    const matches = this.allCdkStacks.find((cdkStack) => {\n      const { stack, stage } = cdkStack;\n      return stack === expectedStack && stage === expectedStage;\n    });\n\n    return !!matches;\n  }\n\n  /**\n   * Check there are the appropriate number of `GuStack`s.\n   * Expect to find an instance for each combination of `stack`, and `stage`.\n   *\n   * If not valid, a message is logged describing what is missing to aid debugging.\n   *\n   * Given the following:\n   *\n   * ```ts\n   * const app = new App();\n   *\n   * class MyApplicationStack extends GuStack { }\n   *\n   * new MyApplicationStack(app, \"App-CODE-deploy\", {\n   *   env: {\n   *     region: \"eu-west-1\",\n   *   },\n   *   stack: \"deploy\",\n   *   stage: \"CODE\"\n   * });\n   *\n   * new MyApplicationStack(app, \"App-PROD-media-service\", {\n   *   env: {\n   *     region: \"eu-west-1\",\n   *   },\n   *   stack: \"media-service\",\n   *   stage: \"PROD\",\n   * });\n   *\n   * new MyApplicationStack(app, \"App-PROD-deploy\", {\n   *   env: {\n   *     region: \"eu-west-1\",\n   *   },\n   *   stack: \"deploy\",\n   *   stage: \"PROD\"\n   * });\n   * ```\n   *\n   * This will log a message like this, where ❌ denotes something missing,\n   * specifically there is no `CODE` template for `media-service`.\n   *\n   * ```log\n   * Unable to produce a working riff-raff.yaml file; missing 1 definitions (details below)\n   *\n   * ┌───────────────┬──────┬──────┐\n   * │    (index)    │ CODE │ PROD │\n   * ├───────────────┼──────┼──────┤\n   * │    deploy     │ '✅' │ '✅' │\n   * │ media-service │ '❌' │ '✅' │\n   * └───────────────┴──────┴──────┘\n   * ```\n   *\n   * @private\n   */\n  private validateStacksInApp(): void {\n    type Found = \"✅\";\n    type NotFound = \"❌\";\n    type AppValidation = Record<StackTag, Record<StageTag, Found | NotFound>>;\n\n    const { allStackTags, allStageTags } = this;\n\n    const checks: AppValidation = allStackTags.reduce((accStackTag, stackTag) => {\n      return {\n        ...accStackTag,\n        [stackTag]: allStageTags.reduce((accStageTag, stageTag) => {\n          return {\n            ...accStageTag,\n            [stageTag]: this.isCdkStackPresent(stackTag, stageTag) ? \"✅\" : \"❌\",\n          };\n        }, {}),\n      };\n    }, {});\n\n    const missingDefinitions: Array<Found | NotFound> = Object.values(checks).flatMap((groupedByStackTag) => {\n      return Object.values(groupedByStackTag).filter((_) => _ === \"❌\");\n    });\n\n    if (missingDefinitions.length > 0) {\n      const message = `Unable to produce a working riff-raff.yaml file; missing ${missingDefinitions.length} definitions`;\n\n      console.log(`${message} (details below)`);\n      console.table(checks);\n\n      throw new Error(message);\n    }\n  }\n\n  private validateAllRegionsAreResolved(): void {\n    const unresolved = this.allRegions.filter((region) => Token.isUnresolved(region));\n\n    if (unresolved.length !== 0) {\n      throw new Error(`Unable to produce a working riff-raff.yaml file; all stacks must have an explicit region set`);\n    }\n  }\n\n  private getLambdas(cdkStack: GuStack): GuLambdaFunction[] {\n    return cdkStack.node.findAll().filter((_) => _ instanceof GuLambdaFunction) as GuLambdaFunction[];\n  }\n\n  private getAutoScalingGroups(cdkStack: GuStack): GuAutoScalingGroup[] {\n    return cdkStack.node.findAll().filter((_) => _ instanceof GuAutoScalingGroup) as GuAutoScalingGroup[];\n  }\n\n  private getGuStackDependencies(cdkStack: GuStack): GuStack[] {\n    return cdkStack.dependencies.filter((_) => _ instanceof GuStack) as GuStack[];\n  }\n\n  // eslint-disable-next-line custom-rules/valid-constructors -- this needs to sit above GuStack on the cdk tree\n  constructor(app: App) {\n    this.allCdkStacks = app.node.findAll().filter((_) => _ instanceof GuStack) as GuStack[];\n    const allowedStages = new Set(this.allCdkStacks.map(({ stage }) => stage));\n    this.allStageTags = Array.from(allowedStages);\n    this.allStackTags = Array.from(new Set(this.allCdkStacks.map(({ stack }) => stack)));\n    this.allRegions = Array.from(new Set(this.allCdkStacks.map(({ region }) => region)));\n\n    this.validateStacksInApp();\n    this.validateAllRegionsAreResolved();\n\n    this.outdir = app.outdir;\n\n    const deployments = new Map<RiffRaffDeploymentName, RiffRaffDeploymentProps>();\n\n    const groupedStacks: GroupedCdkStacks = groupByClassNameStackRegionStage(this.allCdkStacks);\n\n    Object.values(groupedStacks).forEach((stackTagGroup) => {\n      Object.values(stackTagGroup).forEach((regionGroup) => {\n        Object.values(regionGroup).forEach((stageGroup) => {\n          const stacks: GuStack[] = Object.values(stageGroup).flat();\n\n          // The items in `stacks` only differ by stage, so we can just use the first item in the list.\n          const [stack] = stacks;\n\n          if (!stack) {\n            throw new Error(\"Unable to produce a working riff-raff.yaml file; there are no stacks!\");\n          }\n\n          const lambdas = this.getLambdas(stack);\n          const autoscalingGroups = this.getAutoScalingGroups(stack);\n\n          const artifactUploads: RiffRaffDeployment[] = [\n            lambdas.filter((_) => !_.withoutArtifactUpload).map(uploadLambdaArtifact),\n            autoscalingGroups.map(uploadAutoscalingArtifact),\n          ].flat();\n          artifactUploads.forEach(({ name, props }) => deployments.set(name, props));\n\n          const parentStacks: RiffRaffDeployment[] = this.getGuStackDependencies(stack).map((x) =>\n            cloudFormationDeployment([x], [], this.outdir),\n          );\n\n          const cfnDeployment = cloudFormationDeployment(stacks, [...artifactUploads, ...parentStacks], this.outdir);\n          deployments.set(cfnDeployment.name, cfnDeployment.props);\n\n          const lambdasWithoutAnAlias = lambdas.filter((lambda) => lambda.alias === undefined);\n          // If the Lambda has an alias it is using versioning. When using versioning, there is no need for Riff-Raff\n          // to modify the unpublished version of the function\n          lambdasWithoutAnAlias.forEach((lambda) => {\n            const lambdaDeployment = updateLambdaDeployment(lambda, cfnDeployment);\n            deployments.set(lambdaDeployment.name, lambdaDeployment.props);\n          });\n\n          /*\n          Instances in an ASG with an `AutoScalingRollingUpdate` update policy are rotated via CloudFormation.\n          Therefore, they do not need to also perform an `autoscaling` deployment via Riff-Raff.\n           */\n          const legacyAutoscalingGroups = autoscalingGroups.filter((asg) => {\n            const { cfnOptions } = asg.node.defaultChild as CfnAutoScalingGroup;\n            const { updatePolicy } = cfnOptions;\n            return updatePolicy?.autoScalingRollingUpdate === undefined;\n          });\n\n          legacyAutoscalingGroups.forEach((asg) => {\n            const asgDeployment = autoscalingDeployment(asg, cfnDeployment);\n            deployments.set(asgDeployment.name, asgDeployment.props);\n          });\n\n          const amiParametersToTags = getAmiParameters(autoscalingGroups);\n\n          const minInServiceParamMap = HorizontallyScalingDeploymentProperties.getInstance(stack).asgToParamMap;\n          const minInServiceAsgs = autoscalingGroups.filter((asg) => minInServiceParamMap.has(asg.node.id));\n          const minInstancesInServiceParameters = getMinInstancesInServiceParameters(minInServiceAsgs);\n\n          deployments.set(cfnDeployment.name, {\n            ...cfnDeployment.props,\n            parameters: {\n              ...cfnDeployment.props.parameters,\n\n              // only add the `amiParametersToTags` property if there are some\n              ...(autoscalingGroups.length > 0 && { amiParametersToTags }),\n\n              // only add the `minInstancesInServiceParameters` property if there are some\n              ...(minInServiceAsgs.length > 0 && { minInstancesInServiceParameters }),\n            },\n          });\n        });\n      });\n    });\n\n    this.riffRaffYaml = {\n      allowedStages,\n      deployments,\n    };\n  }\n\n  /**\n   * The `riff-raff.yaml` file as a string.\n   * Useful for testing.\n   */\n  toYAML(): string {\n    // Add support for ES6 Set and Map. See https://github.com/nodeca/js-yaml/issues/436.\n    const replacer = (_key: string, value: unknown) => {\n      if (value instanceof Set) {\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-return -- this is how `js-yaml` is typed\n        return Array.from(value);\n      }\n      if (value instanceof Map) {\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-return -- this is how `js-yaml` is typed\n        return Object.fromEntries(value);\n      }\n      return value;\n    };\n\n    return dump(this.riffRaffYaml, { replacer });\n  }\n\n  /**\n   * Write the `riff-raff.yaml` file to disk.\n   * It'll be located with the CFN JSON templates generated by `cdk synth`.\n   */\n  synth(): void {\n    const outPath = path.join(this.outdir, \"riff-raff.yaml\");\n    writeFileSync(outPath, this.toYAML());\n  }\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/riff-raff-yaml-file/index.ts"],"names":[],"mappings":";;;;;;AAAA,2BAAmC;AACnC,gDAAwB;AAExB,6CAAoC;AAEpC,qCAA+B;AAC/B,2DAA+D;AAC/D,6CAA6C;AAC7C,iDAAwD;AACxD,8DAAyG;AACzG,2DAA6F;AAC7F,iEAIsC;AACtC,iDAAoF;AACpF,yCAA8D;AAY9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAa,gBAAgB;IAoBnB,iBAAiB,CAAC,aAAuB,EAAE,aAAuB;QACxE,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YAClD,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,QAAQ,CAAC;YAClC,OAAO,KAAK,KAAK,aAAa,IAAI,KAAK,KAAK,aAAa,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,CAAC,OAAO,CAAC;IACnB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACK,mBAAmB;QAKzB,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;QAE5C,MAAM,MAAM,GAAkB,YAAY,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,QAAQ,EAAE,EAAE;YAC1E,OAAO;gBACL,GAAG,WAAW;gBACd,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,QAAQ,EAAE,EAAE;oBACxD,OAAO;wBACL,GAAG,WAAW;wBACd,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG;qBACnE,CAAC;gBACJ,CAAC,EAAE,EAAE,CAAC;aACP,CAAC;QACJ,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,MAAM,kBAAkB,GAA4B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,iBAAiB,EAAE,EAAE;YACtG,OAAO,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;QAEH,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE;YACjC,MAAM,OAAO,GAAG,4DAA4D,kBAAkB,CAAC,MAAM,cAAc,CAAC;YAEpH,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,kBAAkB,CAAC,CAAC;YAC1C,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAEtB,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;SAC1B;IACH,CAAC;IAEO,6BAA6B;QACnC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,mBAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;QAElF,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,8FAA8F,CAAC,CAAC;SACjH;IACH,CAAC;IAEO,UAAU,CAAC,QAAiB;QAClC,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,yBAAgB,CAAuB,CAAC;IACpG,CAAC;IAEO,oBAAoB,CAAC,QAAiB;QAC5C,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,gCAAkB,CAAyB,CAAC;IACxG,CAAC;IAEO,sBAAsB,CAAC,QAAiB;QAC9C,OAAO,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,cAAO,CAAc,CAAC;IAChF,CAAC;IAED,8GAA8G;IAC9G,YAAY,GAAQ;QAClB,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,cAAO,CAAc,CAAC;QACxF,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QAC3E,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC9C,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACrF,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAErF,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,IAAI,CAAC,6BAA6B,EAAE,CAAC;QAErC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QAEzB,MAAM,WAAW,GAAG,IAAI,GAAG,EAAmD,CAAC;QAE/E,MAAM,aAAa,GAAqB,IAAA,2CAAgC,EAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAE5F,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;YACrD,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;gBACnD,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;oBAChD,MAAM,MAAM,GAAc,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,CAAC;oBAE3D,6FAA6F;oBAC7F,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC;oBAEvB,IAAI,CAAC,KAAK,EAAE;wBACV,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;qBAC1F;oBAED,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;oBACvC,MAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;oBAE3D,MAAM,eAAe,GAAyB;wBAC5C,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,GAAG,CAAC,6BAAoB,CAAC;wBACzE,iBAAiB,CAAC,GAAG,CAAC,uCAAyB,CAAC;qBACjD,CAAC,IAAI,EAAE,CAAC;oBACT,eAAe,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;oBAE3E,MAAM,YAAY,GAAyB,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CACtF,IAAA,yCAAwB,EAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,CAC/C,CAAC;oBAEF,MAAM,aAAa,GAAG,IAAA,yCAAwB,EAAC,MAAM,EAAE,CAAC,GAAG,eAAe,EAAE,GAAG,YAAY,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;oBAC3G,WAAW,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;oBAEzD,MAAM,qBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;oBACrF,2GAA2G;oBAC3G,oDAAoD;oBACpD,qBAAqB,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;wBACvC,MAAM,gBAAgB,GAAG,IAAA,+BAAsB,EAAC,MAAM,EAAE,aAAa,CAAC,CAAC;wBACvE,WAAW,CAAC,GAAG,CAAC,gBAAgB,CAAC,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC;oBACjE,CAAC,CAAC,CAAC;oBAEH;;;uBAGG;oBACH,MAAM,uBAAuB,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;wBAC/D,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,YAAmC,CAAC;wBACpE,MAAM,EAAE,YAAY,EAAE,GAAG,UAAU,CAAC;wBACpC,OAAO,YAAY,EAAE,wBAAwB,KAAK,SAAS,CAAC;oBAC9D,CAAC,CAAC,CAAC;oBAEH,uBAAuB,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;wBACtC,MAAM,aAAa,GAAG,IAAA,mCAAqB,EAAC,GAAG,EAAE,aAAa,CAAC,CAAC;wBAChE,WAAW,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;oBAC3D,CAAC,CAAC,CAAC;oBAEH,MAAM,mBAAmB,GAAG,IAAA,iCAAgB,EAAC,iBAAiB,CAAC,CAAC;oBAEhE,MAAM,oBAAoB,GACxB,+DAAqD,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC;oBACzF,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;oBAClG,MAAM,+BAA+B,GAAG,IAAA,mDAAkC,EAAC,gBAAgB,CAAC,CAAC;oBAE7F,WAAW,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE;wBAClC,GAAG,aAAa,CAAC,KAAK;wBACtB,UAAU,EAAE;4BACV,GAAG,aAAa,CAAC,KAAK,CAAC,UAAU;4BAEjC,gEAAgE;4BAChE,GAAG,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,mBAAmB,EAAE,CAAC;4BAE5D,4EAA4E;4BAC5E,GAAG,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,+BAA+B,EAAE,CAAC;yBACxE;qBACF,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,GAAG;YAClB,aAAa;YACb,WAAW;SACZ,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,MAAM;QACJ,qFAAqF;QACrF,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,KAAc,EAAE,EAAE;YAChD,IAAI,KAAK,YAAY,GAAG,EAAE;gBACxB,iGAAiG;gBACjG,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aAC1B;YACD,IAAI,KAAK,YAAY,GAAG,EAAE;gBACxB,iGAAiG;gBACjG,OAAO,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;aAClC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QAEF,OAAO,IAAA,cAAI,EAAC,IAAI,CAAC,YAAY,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,MAAM,OAAO,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QACzD,IAAA,kBAAa,EAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACxC,CAAC;CACF;AAtQD,4CAsQC","sourcesContent":["import { writeFileSync } from \"fs\";\nimport path from \"path\";\nimport type { App } from \"aws-cdk-lib\";\nimport { Token } from \"aws-cdk-lib\";\nimport type { CfnAutoScalingGroup } from \"aws-cdk-lib/aws-autoscaling\";\nimport { dump } from \"js-yaml\";\nimport { GuAutoScalingGroup } from \"../constructs/autoscaling\";\nimport { GuStack } from \"../constructs/core\";\nimport { GuLambdaFunction } from \"../constructs/lambda\";\nimport { GuHorizontallyScalingDeploymentPropertiesExperimental } from \"../experimental/patterns/ec2-app\";\nimport { autoscalingDeployment, uploadAutoscalingArtifact } from \"./deployments/autoscaling\";\nimport {\n  cloudFormationDeployment,\n  getAmiParameters,\n  getMinInstancesInServiceParameters,\n} from \"./deployments/cloudformation\";\nimport { updateLambdaDeployment, uploadLambdaArtifact } from \"./deployments/lambda\";\nimport { groupByClassNameStackRegionStage } from \"./group-by\";\nimport type {\n  GroupedCdkStacks,\n  Region,\n  RiffRaffDeployment,\n  RiffRaffDeploymentName,\n  RiffRaffDeploymentProps,\n  RiffRaffYaml,\n  StackTag,\n  StageTag,\n} from \"./types\";\n\n/**\n * A class that creates a `riff-raff.yaml` file.\n *\n * Rather than using this directly, prefer to use [[`GuRoot`]] instead.\n *\n * Supports:\n *   - Multiple CloudFormation stacks\n *   - Multiple regions\n *   - Lambda applications\n *   - EC2 (autoscaling) applications\n *\n * For lambda applications, 3 deployments will be defined:\n *   1. Lambda upload (`aws-lambda`, `action: [uploadLambda]`)\n *   2. CloudFormation deploy (`cloud-formation`)\n *   3. Lambda update (`aws-lambda`, `action: [updateLambda]`)\n *\n * For EC2 applications, 3 deployments will be defined:\n *   1. Artifact upload (`autoscaling`, `action: [uploadArtifacts]`)\n *  2. CloudFormation deploy (`cloud-formation`)\n *   3. Autoscaling deploy (`autoscaling`, `action: [deploy]`)\n *\n * It assumes a Riff-Raff bundle structure as follows:\n *\n * ```\n * .\n * ├── cdk.out\n * │   └── MyApplication.template.json\n * ├── my-application\n * │   └── my-application.deb\n * └── my-lambda\n *     └── my-lambda.zip\n * ```\n *\n * That is, all CloudFormation templates are in a `cdk.out` directory, and there is a directory per app.\n * Application artifact(s) are in the app directory.\n *\n * NOTE: The file extension is decided by you, the above file tree is used for illustration purposes.\n *\n * NOTE: Resources will be looked up by tags (Stack, Stage, App). Ensure your CFN stack is tagged appropriately!\n *\n * @see https://riffraff.gutools.co.uk/docs/reference/riff-raff.yaml.md\n * @see https://riffraff.gutools.co.uk/docs/magenta-lib/types\n */\nexport class RiffRaffYamlFile {\n  private readonly allCdkStacks: GuStack[];\n  private readonly allStackTags: StackTag[];\n  private readonly allStageTags: StageTag[];\n  private readonly allRegions: Region[];\n  private readonly outdir: string;\n\n  /**\n   * The `riff-raff.yaml` file as an object.\n   *\n   * It is useful for specifying additional deployment types that GuCDK does not support.\n   * Consider raising an issue or pull request if you think it should be supported.\n   *\n   * In most cases, you shouldn't need to access this.\n   * No validation is performed on the parameters you provide, so you might get deployment errors.\n   *\n   * @see https://riffraff.gutools.co.uk/docs/magenta-lib/types\n   */\n  public readonly riffRaffYaml: RiffRaffYaml;\n\n  private isCdkStackPresent(expectedStack: StackTag, expectedStage: StageTag): boolean {\n    const matches = this.allCdkStacks.find((cdkStack) => {\n      const { stack, stage } = cdkStack;\n      return stack === expectedStack && stage === expectedStage;\n    });\n\n    return !!matches;\n  }\n\n  /**\n   * Check there are the appropriate number of `GuStack`s.\n   * Expect to find an instance for each combination of `stack`, and `stage`.\n   *\n   * If not valid, a message is logged describing what is missing to aid debugging.\n   *\n   * Given the following:\n   *\n   * ```ts\n   * const app = new App();\n   *\n   * class MyApplicationStack extends GuStack { }\n   *\n   * new MyApplicationStack(app, \"App-CODE-deploy\", {\n   *   env: {\n   *     region: \"eu-west-1\",\n   *   },\n   *   stack: \"deploy\",\n   *   stage: \"CODE\"\n   * });\n   *\n   * new MyApplicationStack(app, \"App-PROD-media-service\", {\n   *   env: {\n   *     region: \"eu-west-1\",\n   *   },\n   *   stack: \"media-service\",\n   *   stage: \"PROD\",\n   * });\n   *\n   * new MyApplicationStack(app, \"App-PROD-deploy\", {\n   *   env: {\n   *     region: \"eu-west-1\",\n   *   },\n   *   stack: \"deploy\",\n   *   stage: \"PROD\"\n   * });\n   * ```\n   *\n   * This will log a message like this, where ❌ denotes something missing,\n   * specifically there is no `CODE` template for `media-service`.\n   *\n   * ```log\n   * Unable to produce a working riff-raff.yaml file; missing 1 definitions (details below)\n   *\n   * ┌───────────────┬──────┬──────┐\n   * │    (index)    │ CODE │ PROD │\n   * ├───────────────┼──────┼──────┤\n   * │    deploy     │ '✅' │ '✅' │\n   * │ media-service │ '❌' │ '✅' │\n   * └───────────────┴──────┴──────┘\n   * ```\n   *\n   * @private\n   */\n  private validateStacksInApp(): void {\n    type Found = \"✅\";\n    type NotFound = \"❌\";\n    type AppValidation = Record<StackTag, Record<StageTag, Found | NotFound>>;\n\n    const { allStackTags, allStageTags } = this;\n\n    const checks: AppValidation = allStackTags.reduce((accStackTag, stackTag) => {\n      return {\n        ...accStackTag,\n        [stackTag]: allStageTags.reduce((accStageTag, stageTag) => {\n          return {\n            ...accStageTag,\n            [stageTag]: this.isCdkStackPresent(stackTag, stageTag) ? \"✅\" : \"❌\",\n          };\n        }, {}),\n      };\n    }, {});\n\n    const missingDefinitions: Array<Found | NotFound> = Object.values(checks).flatMap((groupedByStackTag) => {\n      return Object.values(groupedByStackTag).filter((_) => _ === \"❌\");\n    });\n\n    if (missingDefinitions.length > 0) {\n      const message = `Unable to produce a working riff-raff.yaml file; missing ${missingDefinitions.length} definitions`;\n\n      console.log(`${message} (details below)`);\n      console.table(checks);\n\n      throw new Error(message);\n    }\n  }\n\n  private validateAllRegionsAreResolved(): void {\n    const unresolved = this.allRegions.filter((region) => Token.isUnresolved(region));\n\n    if (unresolved.length !== 0) {\n      throw new Error(`Unable to produce a working riff-raff.yaml file; all stacks must have an explicit region set`);\n    }\n  }\n\n  private getLambdas(cdkStack: GuStack): GuLambdaFunction[] {\n    return cdkStack.node.findAll().filter((_) => _ instanceof GuLambdaFunction) as GuLambdaFunction[];\n  }\n\n  private getAutoScalingGroups(cdkStack: GuStack): GuAutoScalingGroup[] {\n    return cdkStack.node.findAll().filter((_) => _ instanceof GuAutoScalingGroup) as GuAutoScalingGroup[];\n  }\n\n  private getGuStackDependencies(cdkStack: GuStack): GuStack[] {\n    return cdkStack.dependencies.filter((_) => _ instanceof GuStack) as GuStack[];\n  }\n\n  // eslint-disable-next-line custom-rules/valid-constructors -- this needs to sit above GuStack on the cdk tree\n  constructor(app: App) {\n    this.allCdkStacks = app.node.findAll().filter((_) => _ instanceof GuStack) as GuStack[];\n    const allowedStages = new Set(this.allCdkStacks.map(({ stage }) => stage));\n    this.allStageTags = Array.from(allowedStages);\n    this.allStackTags = Array.from(new Set(this.allCdkStacks.map(({ stack }) => stack)));\n    this.allRegions = Array.from(new Set(this.allCdkStacks.map(({ region }) => region)));\n\n    this.validateStacksInApp();\n    this.validateAllRegionsAreResolved();\n\n    this.outdir = app.outdir;\n\n    const deployments = new Map<RiffRaffDeploymentName, RiffRaffDeploymentProps>();\n\n    const groupedStacks: GroupedCdkStacks = groupByClassNameStackRegionStage(this.allCdkStacks);\n\n    Object.values(groupedStacks).forEach((stackTagGroup) => {\n      Object.values(stackTagGroup).forEach((regionGroup) => {\n        Object.values(regionGroup).forEach((stageGroup) => {\n          const stacks: GuStack[] = Object.values(stageGroup).flat();\n\n          // The items in `stacks` only differ by stage, so we can just use the first item in the list.\n          const [stack] = stacks;\n\n          if (!stack) {\n            throw new Error(\"Unable to produce a working riff-raff.yaml file; there are no stacks!\");\n          }\n\n          const lambdas = this.getLambdas(stack);\n          const autoscalingGroups = this.getAutoScalingGroups(stack);\n\n          const artifactUploads: RiffRaffDeployment[] = [\n            lambdas.filter((_) => !_.withoutArtifactUpload).map(uploadLambdaArtifact),\n            autoscalingGroups.map(uploadAutoscalingArtifact),\n          ].flat();\n          artifactUploads.forEach(({ name, props }) => deployments.set(name, props));\n\n          const parentStacks: RiffRaffDeployment[] = this.getGuStackDependencies(stack).map((x) =>\n            cloudFormationDeployment([x], [], this.outdir),\n          );\n\n          const cfnDeployment = cloudFormationDeployment(stacks, [...artifactUploads, ...parentStacks], this.outdir);\n          deployments.set(cfnDeployment.name, cfnDeployment.props);\n\n          const lambdasWithoutAnAlias = lambdas.filter((lambda) => lambda.alias === undefined);\n          // If the Lambda has an alias it is using versioning. When using versioning, there is no need for Riff-Raff\n          // to modify the unpublished version of the function\n          lambdasWithoutAnAlias.forEach((lambda) => {\n            const lambdaDeployment = updateLambdaDeployment(lambda, cfnDeployment);\n            deployments.set(lambdaDeployment.name, lambdaDeployment.props);\n          });\n\n          /*\n          Instances in an ASG with an `AutoScalingRollingUpdate` update policy are rotated via CloudFormation.\n          Therefore, they do not need to also perform an `autoscaling` deployment via Riff-Raff.\n           */\n          const legacyAutoscalingGroups = autoscalingGroups.filter((asg) => {\n            const { cfnOptions } = asg.node.defaultChild as CfnAutoScalingGroup;\n            const { updatePolicy } = cfnOptions;\n            return updatePolicy?.autoScalingRollingUpdate === undefined;\n          });\n\n          legacyAutoscalingGroups.forEach((asg) => {\n            const asgDeployment = autoscalingDeployment(asg, cfnDeployment);\n            deployments.set(asgDeployment.name, asgDeployment.props);\n          });\n\n          const amiParametersToTags = getAmiParameters(autoscalingGroups);\n\n          const minInServiceParamMap =\n            GuHorizontallyScalingDeploymentPropertiesExperimental.getInstance(stack).asgToParamMap;\n          const minInServiceAsgs = autoscalingGroups.filter((asg) => minInServiceParamMap.has(asg.node.id));\n          const minInstancesInServiceParameters = getMinInstancesInServiceParameters(minInServiceAsgs);\n\n          deployments.set(cfnDeployment.name, {\n            ...cfnDeployment.props,\n            parameters: {\n              ...cfnDeployment.props.parameters,\n\n              // only add the `amiParametersToTags` property if there are some\n              ...(autoscalingGroups.length > 0 && { amiParametersToTags }),\n\n              // only add the `minInstancesInServiceParameters` property if there are some\n              ...(minInServiceAsgs.length > 0 && { minInstancesInServiceParameters }),\n            },\n          });\n        });\n      });\n    });\n\n    this.riffRaffYaml = {\n      allowedStages,\n      deployments,\n    };\n  }\n\n  /**\n   * The `riff-raff.yaml` file as a string.\n   * Useful for testing.\n   */\n  toYAML(): string {\n    // Add support for ES6 Set and Map. See https://github.com/nodeca/js-yaml/issues/436.\n    const replacer = (_key: string, value: unknown) => {\n      if (value instanceof Set) {\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-return -- this is how `js-yaml` is typed\n        return Array.from(value);\n      }\n      if (value instanceof Map) {\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-return -- this is how `js-yaml` is typed\n        return Object.fromEntries(value);\n      }\n      return value;\n    };\n\n    return dump(this.riffRaffYaml, { replacer });\n  }\n\n  /**\n   * Write the `riff-raff.yaml` file to disk.\n   * It'll be located with the CFN JSON templates generated by `cdk synth`.\n   */\n  synth(): void {\n    const outPath = path.join(this.outdir, \"riff-raff.yaml\");\n    writeFileSync(outPath, this.toYAML());\n  }\n}\n"]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@guardian/cdk",
   "description": "Generic Guardian flavoured AWS CDK components",
-  "version": "61.5.2",
+  "version": "61.6.0",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [