@guardian/cdk 62.6.0 → 63.0.0

package/lib/riff-raff-yaml-file/deployments/update-parameters.d.ts

@@ -0,0 +1,3 @@
+import type { RiffRaffDeployment, RiffRaffDeploymentParameters, RiffRaffDeployments } from "../types";
+export declare function updateDeploymentParameters(allDeployments: RiffRaffDeployments, deploymentToUpdate: RiffRaffDeployment, additionalParametersToApply: RiffRaffDeploymentParameters): void;
+//# sourceMappingURL=update-parameters.d.ts.map

package/lib/riff-raff-yaml-file/deployments/update-parameters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-parameters.d.ts","sourceRoot":"","sources":["../../../src/riff-raff-yaml-file/deployments/update-parameters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,4BAA4B,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAEtG,wBAAgB,0BAA0B,CACxC,cAAc,EAAE,mBAAmB,EACnC,kBAAkB,EAAE,kBAAkB,EACtC,2BAA2B,EAAE,4BAA4B,QAc1D"}

package/lib/riff-raff-yaml-file/deployments/update-parameters.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateDeploymentParameters = void 0;
+function updateDeploymentParameters(allDeployments, deploymentToUpdate, additionalParametersToApply) {
+    const currentDeployment = allDeployments.get(deploymentToUpdate.name);
+    if (!currentDeployment) {
+        throw new Error(`Unable to find deployment ${deploymentToUpdate.name}`);
+    }
+    allDeployments.set(deploymentToUpdate.name, {
+        ...currentDeployment,
+        parameters: {
+            ...currentDeployment.parameters,
+            ...additionalParametersToApply,
+        },
+    });
+}
+exports.updateDeploymentParameters = updateDeploymentParameters;
+//# sourceMappingURL=update-parameters.js.map

package/lib/riff-raff-yaml-file/deployments/update-parameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-parameters.js","sourceRoot":"","sources":["../../../src/riff-raff-yaml-file/deployments/update-parameters.ts"],"names":[],"mappings":";;;AAEA,SAAgB,0BAA0B,CACxC,cAAmC,EACnC,kBAAsC,EACtC,2BAAyD;IAEzD,MAAM,iBAAiB,GAAG,cAAc,CAAC,GAAG,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IACtE,IAAI,CAAC,iBAAiB,EAAE;QACtB,MAAM,IAAI,KAAK,CAAC,6BAA6B,kBAAkB,CAAC,IAAI,EAAE,CAAC,CAAC;KACzE;IAED,cAAc,CAAC,GAAG,CAAC,kBAAkB,CAAC,IAAI,EAAE;QAC1C,GAAG,iBAAiB;QACpB,UAAU,EAAE;YACV,GAAG,iBAAiB,CAAC,UAAU;YAC/B,GAAG,2BAA2B;SAC/B;KACF,CAAC,CAAC;AACL,CAAC;AAjBD,gEAiBC","sourcesContent":["import type { RiffRaffDeployment, RiffRaffDeploymentParameters, RiffRaffDeployments } from \"../types\";\n\nexport function updateDeploymentParameters(\n  allDeployments: RiffRaffDeployments,\n  deploymentToUpdate: RiffRaffDeployment,\n  additionalParametersToApply: RiffRaffDeploymentParameters,\n) {\n  const currentDeployment = allDeployments.get(deploymentToUpdate.name);\n  if (!currentDeployment) {\n    throw new Error(`Unable to find deployment ${deploymentToUpdate.name}`);\n  }\n\n  allDeployments.set(deploymentToUpdate.name, {\n    ...currentDeployment,\n    parameters: {\n      ...currentDeployment.parameters,\n      ...additionalParametersToApply,\n    },\n  });\n}\n"]}

package/lib/riff-raff-yaml-file/group-by.d.ts

@@ -1,4 +1,8 @@
 import type { GuStack } from "../constructs/core";
-import type { GroupedCdkStacks } from "./types";
-export declare function groupByClassNameStackRegionStage(cdkStacks: GuStack[]): GroupedCdkStacks;
+import type { ClassName, Region, RiffRaffProjectName, StackTag, StageTag } from "./types";
+export declare function groupByClassName(cdkStacks: GuStack[]): Record<ClassName, GuStack[]>;
+export declare function groupByStackTag(cdkStacks: GuStack[]): Record<StackTag, GuStack[]>;
+export declare function groupByStageTag(cdkStacks: GuStack[]): Record<StageTag, GuStack[]>;
+export declare function groupByRegion(cdkStacks: GuStack[]): Record<Region, GuStack[]>;
+export declare function groupByRiffRaffProjectName(cdkStacks: GuStack[]): Record<RiffRaffProjectName, GuStack[]>;
 //# sourceMappingURL=group-by.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"group-by.d.ts","sourceRoot":"","sources":["../../src/riff-raff-yaml-file/group-by.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAElD,OAAO,KAAK,EAAa,gBAAgB,EAA8B,MAAM,SAAS,CAAC;AAkBvF,wBAAgB,gCAAgC,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,gBAAgB,CAoBvF"}
+{"version":3,"file":"group-by.d.ts","sourceRoot":"","sources":["../../src/riff-raff-yaml-file/group-by.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAElD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,mBAAmB,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAG1F,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,SAAS,EAAE,OAAO,EAAE,CAAC,CAEnF;AAED,wBAAgB,eAAe,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC,CAEjF;AAED,wBAAgB,eAAe,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC,CAEjF;AAED,wBAAgB,aAAa,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAE7E;AAED,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,mBAAmB,EAAE,OAAO,EAAE,CAAC,CAEvG"}

package/lib/riff-raff-yaml-file/group-by.js

@@ -1,30 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.groupByClassNameStackRegionStage = void 0;
+exports.groupByRiffRaffProjectName = exports.groupByRegion = exports.groupByStageTag = exports.groupByStackTag = exports.groupByClassName = void 0;
 const array_1 = require("../utils/array");
+const types_1 = require("./types");
 function groupByClassName(cdkStacks) {
     return (0, array_1.groupBy)(cdkStacks, (stack) => stack.constructor.name);
 }
+exports.groupByClassName = groupByClassName;
 function groupByStackTag(cdkStacks) {
     return (0, array_1.groupBy)(cdkStacks, ({ stack }) => stack);
 }
+exports.groupByStackTag = groupByStackTag;
 function groupByStageTag(cdkStacks) {
     return (0, array_1.groupBy)(cdkStacks, ({ stage }) => stage);
 }
+exports.groupByStageTag = groupByStageTag;
 function groupByRegion(cdkStacks) {
     return (0, array_1.groupBy)(cdkStacks, ({ region }) => region);
 }
-function groupByClassNameStackRegionStage(cdkStacks) {
-    return Object.entries(groupByClassName(cdkStacks)).reduce((accClassName, [className, stacksGroupedByClassName]) => ({
-        ...accClassName,
-        [className]: Object.entries(groupByStackTag(stacksGroupedByClassName)).reduce((accStackTag, [stackTag, stacksGroupedByStackTag]) => ({
-            ...accStackTag,
-            [stackTag]: Object.entries(groupByRegion(stacksGroupedByStackTag)).reduce((accRegion, [region, stacksGroupedByRegion]) => ({
-                ...accRegion,
-                [region]: groupByStageTag(stacksGroupedByRegion),
-            }), {}),
-        }), {}),
-    }), {});
+exports.groupByRegion = groupByRegion;
+function groupByRiffRaffProjectName(cdkStacks) {
+    return (0, array_1.groupBy)(cdkStacks, (_) => _.riffRaffProjectName ?? types_1.UnknownRiffRaffProjectName);
 }
-exports.groupByClassNameStackRegionStage = groupByClassNameStackRegionStage;
+exports.groupByRiffRaffProjectName = groupByRiffRaffProjectName;
 //# sourceMappingURL=group-by.js.map

package/lib/riff-raff-yaml-file/group-by.js.map

@@ -1 +1 @@
-{"version":3,"file":"group-by.js","sourceRoot":"","sources":["../../src/riff-raff-yaml-file/group-by.ts"],"names":[],"mappings":";;;AACA,0CAAyC;AAGzC,SAAS,gBAAgB,CAAC,SAAoB;IAC5C,OAAO,IAAA,eAAO,EAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;AAC/D,CAAC;AAED,SAAS,eAAe,CAAC,SAAoB;IAC3C,OAAO,IAAA,eAAO,EAAC,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,eAAe,CAAC,SAAoB;IAC3C,OAAO,IAAA,eAAO,EAAC,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,aAAa,CAAC,SAAoB;IACzC,OAAO,IAAA,eAAO,EAAC,SAAS,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC;AACpD,CAAC;AAED,SAAgB,gCAAgC,CAAC,SAAoB;IACnE,OAAO,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CACvD,CAAC,YAAY,EAAE,CAAC,SAAS,EAAE,wBAAwB,CAAC,EAAE,EAAE,CAAC,CAAC;QACxD,GAAG,YAAY;QACf,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,wBAAwB,CAAC,CAAC,CAAC,MAAM,CAC3E,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,uBAAuB,CAAC,EAAE,EAAE,CAAC,CAAC;YACrD,GAAG,WAAW;YACd,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC,CAAC,MAAM,CACvE,CAAC,SAAS,EAAE,CAAC,MAAM,EAAE,qBAAqB,CAAC,EAAE,EAAE,CAAC,CAAC;gBAC/C,GAAG,SAAS;gBACZ,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC,qBAAqB,CAAC;aACjD,CAAC,EACF,EAAE,CACH;SACF,CAAC,EACF,EAAE,CACH;KACF,CAAC,EACF,EAAE,CACH,CAAC;AACJ,CAAC;AApBD,4EAoBC","sourcesContent":["import type { GuStack } from \"../constructs/core\";\nimport { groupBy } from \"../utils/array\";\nimport type { ClassName, GroupedCdkStacks, Region, StackTag, StageTag } from \"./types\";\n\nfunction groupByClassName(cdkStacks: GuStack[]): Record<ClassName, GuStack[]> {\n  return groupBy(cdkStacks, (stack) => stack.constructor.name);\n}\n\nfunction groupByStackTag(cdkStacks: GuStack[]): Record<StackTag, GuStack[]> {\n  return groupBy(cdkStacks, ({ stack }) => stack);\n}\n\nfunction groupByStageTag(cdkStacks: GuStack[]): Record<StageTag, GuStack[]> {\n  return groupBy(cdkStacks, ({ stage }) => stage);\n}\n\nfunction groupByRegion(cdkStacks: GuStack[]): Record<Region, GuStack[]> {\n  return groupBy(cdkStacks, ({ region }) => region);\n}\n\nexport function groupByClassNameStackRegionStage(cdkStacks: GuStack[]): GroupedCdkStacks {\n  return Object.entries(groupByClassName(cdkStacks)).reduce(\n    (accClassName, [className, stacksGroupedByClassName]) => ({\n      ...accClassName,\n      [className]: Object.entries(groupByStackTag(stacksGroupedByClassName)).reduce(\n        (accStackTag, [stackTag, stacksGroupedByStackTag]) => ({\n          ...accStackTag,\n          [stackTag]: Object.entries(groupByRegion(stacksGroupedByStackTag)).reduce(\n            (accRegion, [region, stacksGroupedByRegion]) => ({\n              ...accRegion,\n              [region]: groupByStageTag(stacksGroupedByRegion),\n            }),\n            {},\n          ),\n        }),\n        {},\n      ),\n    }),\n    {},\n  );\n}\n"]}
+{"version":3,"file":"group-by.js","sourceRoot":"","sources":["../../src/riff-raff-yaml-file/group-by.ts"],"names":[],"mappings":";;;AACA,0CAAyC;AAEzC,mCAAqD;AAErD,SAAgB,gBAAgB,CAAC,SAAoB;IACnD,OAAO,IAAA,eAAO,EAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;AAC/D,CAAC;AAFD,4CAEC;AAED,SAAgB,eAAe,CAAC,SAAoB;IAClD,OAAO,IAAA,eAAO,EAAC,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;AAClD,CAAC;AAFD,0CAEC;AAED,SAAgB,eAAe,CAAC,SAAoB;IAClD,OAAO,IAAA,eAAO,EAAC,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;AAClD,CAAC;AAFD,0CAEC;AAED,SAAgB,aAAa,CAAC,SAAoB;IAChD,OAAO,IAAA,eAAO,EAAC,SAAS,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC;AACpD,CAAC;AAFD,sCAEC;AAED,SAAgB,0BAA0B,CAAC,SAAoB;IAC7D,OAAO,IAAA,eAAO,EAAC,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,mBAAmB,IAAI,kCAA0B,CAAC,CAAC;AACxF,CAAC;AAFD,gEAEC","sourcesContent":["import type { GuStack } from \"../constructs/core\";\nimport { groupBy } from \"../utils/array\";\nimport type { ClassName, Region, RiffRaffProjectName, StackTag, StageTag } from \"./types\";\nimport { UnknownRiffRaffProjectName } from \"./types\";\n\nexport function groupByClassName(cdkStacks: GuStack[]): Record<ClassName, GuStack[]> {\n  return groupBy(cdkStacks, (stack) => stack.constructor.name);\n}\n\nexport function groupByStackTag(cdkStacks: GuStack[]): Record<StackTag, GuStack[]> {\n  return groupBy(cdkStacks, ({ stack }) => stack);\n}\n\nexport function groupByStageTag(cdkStacks: GuStack[]): Record<StageTag, GuStack[]> {\n  return groupBy(cdkStacks, ({ stage }) => stage);\n}\n\nexport function groupByRegion(cdkStacks: GuStack[]): Record<Region, GuStack[]> {\n  return groupBy(cdkStacks, ({ region }) => region);\n}\n\nexport function groupByRiffRaffProjectName(cdkStacks: GuStack[]): Record<RiffRaffProjectName, GuStack[]> {\n  return groupBy(cdkStacks, (_) => _.riffRaffProjectName ?? UnknownRiffRaffProjectName);\n}\n"]}

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

@@ -1,5 +1,5 @@
 import type { App } from "aws-cdk-lib";
-import type { RiffRaffYaml } from "./types";
+import type { RiffRaffProjectName, RiffRaffYaml } from "./types";
 /**
  * A class that creates a `riff-raff.yaml` file.
  *
@@ -44,93 +44,28 @@ import type { RiffRaffYaml } from "./types";
  * @see https://riffraff.gutools.co.uk/docs/magenta-lib/types
  */
 export declare class RiffRaffYamlFile {
-    private readonly allCdkStacks;
-    private readonly allStackTags;
-    private readonly allStageTags;
-    private readonly allRegions;
     private readonly outdir;
     /**
-     * The `riff-raff.yaml` file as an object.
+     * A mapping between a Riff-Raff project and `riff-raff.yaml` content as an object.
      *
      * It is useful for specifying additional deployment types that GuCDK does not support.
      * Consider raising an issue or pull request if you think it should be supported.
      *
-     * In most cases, you shouldn't need to access this.
-     * No validation is performed on the parameters you provide, so you might get deployment errors.
-     *
      * @see https://riffraff.gutools.co.uk/docs/magenta-lib/types
      */
-    readonly riffRaffYaml: RiffRaffYaml;
-    private isCdkStackPresent;
-    /**
-     * Check there are the appropriate number of `GuStack`s.
-     * Expect to find an instance for each combination of `stack`, and `stage`.
-     *
-     * If not valid, a message is logged describing what is missing to aid debugging.
-     *
-     * Given the following:
-     *
-     * ```ts
-     * const app = new App();
-     *
-     * class MyApplicationStack extends GuStack { }
-     *
-     * new MyApplicationStack(app, "App-CODE-deploy", {
-     *   env: {
-     *     region: "eu-west-1",
-     *   },
-     *   stack: "deploy",
-     *   stage: "CODE"
-     * });
-     *
-     * new MyApplicationStack(app, "App-PROD-media-service", {
-     *   env: {
-     *     region: "eu-west-1",
-     *   },
-     *   stack: "media-service",
-     *   stage: "PROD",
-     * });
-     *
-     * new MyApplicationStack(app, "App-PROD-deploy", {
-     *   env: {
-     *     region: "eu-west-1",
-     *   },
-     *   stack: "deploy",
-     *   stage: "PROD"
-     * });
-     * ```
-     *
-     * This will log a message like this, where ❌ denotes something missing,
-     * specifically there is no `CODE` template for `media-service`.
-     *
-     * ```log
-     * Unable to produce a working riff-raff.yaml file; missing 1 definitions (details below)
-     *
-     * ┌───────────────┬──────┬──────┐
-     * │    (index)    │ CODE │ PROD │
-     * ├───────────────┼──────┼──────┤
-     * │    deploy     │ '✅' │ '✅' │
-     * │ media-service │ '❌' │ '✅' │
-     * └───────────────┴──────┴──────┘
-     * ```
-     *
-     * @private
-     */
-    private validateStacksInApp;
-    private validateAllRegionsAreResolved;
-    private getLambdas;
-    private getAutoScalingGroups;
-    private getGuStackDependencies;
+    readonly configuration: Map<RiffRaffProjectName, RiffRaffYaml>;
     constructor(app: App);
     /**
-     * The `riff-raff.yaml` file as a string.
+     * A `riff-raff.yaml` file as a string.
      * Useful for testing.
+     *
+     * @param riffRaffProjectName which project to convert to YAML. Defaults to {@link UnknownRiffRaffProjectName} - any {@link GuStack} without an explicit `riffRaffProjectName` property.
      */
-    toYAML(): string;
+    toYAML(riffRaffProjectName?: RiffRaffProjectName): string;
     /**
-     * Write the `riff-raff.yaml` file to disk.
-     * It'll be located with the CFN JSON templates generated by `cdk synth`.
+     * Write the `riff-raff.yaml` file(s) to disk, located in the same directory as the CFN JSON templates generated by `cdk synth`.
      */
     synth(): void;
 }
+export declare function validateRiffRaffYamlDirectory(basePath: string, riffRaffProjectName: RiffRaffProjectName): string;
 //# sourceMappingURL=index.d.ts.map

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;IAgGpB;;;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;AAuBvC,OAAO,KAAK,EAMV,mBAAmB,EACnB,YAAY,EAGb,MAAM,SAAS,CAAC;AA+BjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAEhC;;;;;;;OAOG;IACH,SAAgB,aAAa,EAAE,GAAG,CAAC,mBAAmB,EAAE,YAAY,CAAC,CAAC;gBAG1D,GAAG,EAAE,GAAG;IA6IpB;;;;;OAKG;IACH,MAAM,CAAC,mBAAmB,GAAE,mBAAgD,GAAG,MAAM;IAuBrF;;OAEG;IACH,KAAK,IAAI,IAAI;CAed;AAED,wBAAgB,6BAA6B,CAAC,QAAQ,EAAE,MAAM,EAAE,mBAAmB,EAAE,mBAAmB,GAAG,MAAM,CAahH"}

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

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RiffRaffYamlFile = void 0;
+exports.validateRiffRaffYamlDirectory = exports.RiffRaffYamlFile = void 0;
 const fs_1 = require("fs");
 const path_1 = __importDefault(require("path"));
 const aws_cdk_lib_1 = require("aws-cdk-lib");
@@ -15,7 +15,24 @@ const ec2_app_1 = require("../experimental/patterns/ec2-app");
 const autoscaling_2 = require("./deployments/autoscaling");
 const cloudformation_1 = require("./deployments/cloudformation");
 const lambda_2 = require("./deployments/lambda");
+const update_parameters_1 = require("./deployments/update-parameters");
 const group_by_1 = require("./group-by");
+const types_1 = require("./types");
+function validateAllRegionsAreResolved(regions) {
+    const unresolved = regions.filter((region) => aws_cdk_lib_1.Token.isUnresolved(region));
+    if (unresolved.length !== 0) {
+        throw new Error(`Unable to produce a working riff-raff.yaml file; all stacks must have an explicit region set`);
+    }
+}
+function getLambdas(cdkStack) {
+    return cdkStack.node.findAll().filter((_) => _ instanceof lambda_1.GuLambdaFunction);
+}
+function getAutoScalingGroups(cdkStack) {
+    return cdkStack.node.findAll().filter((_) => _ instanceof autoscaling_1.GuAutoScalingGroup);
+}
+function getGuStackDependencies(cdkStack) {
+    return cdkStack.dependencies.filter((_) => _ instanceof core_1.GuStack);
+}
 /**
  * A class that creates a `riff-raff.yaml` file.
  *
@@ -60,183 +77,117 @@ const group_by_1 = require("./group-by");
  * @see https://riffraff.gutools.co.uk/docs/magenta-lib/types
  */
 class RiffRaffYamlFile {
-    isCdkStackPresent(expectedStack, expectedStage) {
-        const matches = this.allCdkStacks.find((cdkStack) => {
-            const { stack, stage } = cdkStack;
-            return stack === expectedStack && stage === expectedStage;
-        });
-        return !!matches;
-    }
-    /**
-     * Check there are the appropriate number of `GuStack`s.
-     * Expect to find an instance for each combination of `stack`, and `stage`.
-     *
-     * If not valid, a message is logged describing what is missing to aid debugging.
-     *
-     * Given the following:
-     *
-     * ```ts
-     * const app = new App();
-     *
-     * class MyApplicationStack extends GuStack { }
-     *
-     * new MyApplicationStack(app, "App-CODE-deploy", {
-     *   env: {
-     *     region: "eu-west-1",
-     *   },
-     *   stack: "deploy",
-     *   stage: "CODE"
-     * });
-     *
-     * new MyApplicationStack(app, "App-PROD-media-service", {
-     *   env: {
-     *     region: "eu-west-1",
-     *   },
-     *   stack: "media-service",
-     *   stage: "PROD",
-     * });
-     *
-     * new MyApplicationStack(app, "App-PROD-deploy", {
-     *   env: {
-     *     region: "eu-west-1",
-     *   },
-     *   stack: "deploy",
-     *   stage: "PROD"
-     * });
-     * ```
-     *
-     * This will log a message like this, where ❌ denotes something missing,
-     * specifically there is no `CODE` template for `media-service`.
-     *
-     * ```log
-     * Unable to produce a working riff-raff.yaml file; missing 1 definitions (details below)
-     *
-     * ┌───────────────┬──────┬──────┐
-     * │    (index)    │ CODE │ PROD │
-     * ├───────────────┼──────┼──────┤
-     * │    deploy     │ '✅' │ '✅' │
-     * │ media-service │ '❌' │ '✅' │
-     * └───────────────┴──────┴──────┘
-     * ```
-     *
-     * @private
-     */
-    validateStacksInApp() {
-        const { allStackTags, allStageTags } = this;
-        const checks = allStackTags.reduce((accStackTag, stackTag) => {
-            return {
-                ...accStackTag,
-                [stackTag]: allStageTags.reduce((accStageTag, stageTag) => {
-                    return {
-                        ...accStageTag,
-                        [stageTag]: this.isCdkStackPresent(stackTag, stageTag) ? "✅" : "❌",
-                    };
-                }, {}),
-            };
-        }, {});
-        const missingDefinitions = Object.values(checks).flatMap((groupedByStackTag) => {
-            return Object.values(groupedByStackTag).filter((_) => _ === "❌");
-        });
-        if (missingDefinitions.length > 0) {
-            const message = `Unable to produce a working riff-raff.yaml file; missing ${missingDefinitions.length} definitions`;
-            console.log(`${message} (details below)`);
-            console.table(checks);
-            throw new Error(message);
-        }
-    }
-    validateAllRegionsAreResolved() {
-        const unresolved = this.allRegions.filter((region) => aws_cdk_lib_1.Token.isUnresolved(region));
-        if (unresolved.length !== 0) {
-            throw new Error(`Unable to produce a working riff-raff.yaml file; all stacks must have an explicit region set`);
-        }
-    }
-    getLambdas(cdkStack) {
-        return cdkStack.node.findAll().filter((_) => _ instanceof lambda_1.GuLambdaFunction);
-    }
-    getAutoScalingGroups(cdkStack) {
-        return cdkStack.node.findAll().filter((_) => _ instanceof autoscaling_1.GuAutoScalingGroup);
-    }
-    getGuStackDependencies(cdkStack) {
-        return cdkStack.dependencies.filter((_) => _ instanceof core_1.GuStack);
-    }
     // eslint-disable-next-line custom-rules/valid-constructors -- this needs to sit above GuStack on the cdk tree
     constructor(app) {
-        this.allCdkStacks = app.node.findAll().filter((_) => _ instanceof core_1.GuStack);
-        const allowedStages = new Set(this.allCdkStacks.map(({ stage }) => stage));
-        this.allStageTags = Array.from(allowedStages);
-        this.allStackTags = Array.from(new Set(this.allCdkStacks.map(({ stack }) => stack)));
-        this.allRegions = Array.from(new Set(this.allCdkStacks.map(({ region }) => region)));
-        this.validateStacksInApp();
-        this.validateAllRegionsAreResolved();
+        const allCdkStacks = app.node.findAll().filter((_) => _ instanceof core_1.GuStack);
+        const allRegions = Array.from(new Set(allCdkStacks.map((_) => _.region)));
+        validateAllRegionsAreResolved(allRegions);
         this.outdir = app.outdir;
-        const deployments = new Map();
-        const groupedStacks = (0, group_by_1.groupByClassNameStackRegionStage)(this.allCdkStacks);
-        Object.values(groupedStacks).forEach((stackTagGroup) => {
-            Object.values(stackTagGroup).forEach((regionGroup) => {
-                Object.values(regionGroup).forEach((stageGroup) => {
-                    const stacks = Object.values(stageGroup).flat();
-                    // The items in `stacks` only differ by stage, so we can just use the first item in the list.
-                    const [stack] = stacks;
-                    if (!stack) {
-                        throw new Error("Unable to produce a working riff-raff.yaml file; there are no stacks!");
-                    }
-                    const lambdas = this.getLambdas(stack);
-                    const autoscalingGroups = this.getAutoScalingGroups(stack);
-                    const artifactUploads = [
-                        lambdas.filter((_) => !_.withoutArtifactUpload).map(lambda_2.uploadLambdaArtifact),
-                        autoscalingGroups.map(autoscaling_2.uploadAutoscalingArtifact),
-                    ].flat();
-                    artifactUploads.forEach(({ name, props }) => deployments.set(name, props));
-                    const parentStacks = this.getGuStackDependencies(stack).map((x) => (0, cloudformation_1.cloudFormationDeployment)([x], [], this.outdir));
-                    const cfnDeployment = (0, cloudformation_1.cloudFormationDeployment)(stacks, [...artifactUploads, ...parentStacks], this.outdir);
-                    deployments.set(cfnDeployment.name, cfnDeployment.props);
-                    const lambdasWithoutAnAlias = lambdas.filter((lambda) => lambda.alias === undefined);
-                    // If the Lambda has an alias it is using versioning. When using versioning, there is no need for Riff-Raff
-                    // to modify the unpublished version of the function
-                    lambdasWithoutAnAlias.forEach((lambda) => {
-                        const lambdaDeployment = (0, lambda_2.updateLambdaDeployment)(lambda, cfnDeployment);
-                        deployments.set(lambdaDeployment.name, lambdaDeployment.props);
-                    });
-                    /*
-                    Instances in an ASG with an `AutoScalingRollingUpdate` update policy are rotated via CloudFormation.
-                    Therefore, they do not need to also perform an `autoscaling` deployment via Riff-Raff.
-                     */
-                    const legacyAutoscalingGroups = autoscalingGroups.filter((asg) => {
-                        const { cfnOptions } = asg.node.defaultChild;
-                        const { updatePolicy } = cfnOptions;
-                        return updatePolicy?.autoScalingRollingUpdate === undefined;
-                    });
-                    legacyAutoscalingGroups.forEach((asg) => {
-                        const asgDeployment = (0, autoscaling_2.autoscalingDeployment)(asg, cfnDeployment);
-                        deployments.set(asgDeployment.name, asgDeployment.props);
-                    });
-                    const amiParametersToTags = (0, cloudformation_1.getAmiParameters)(autoscalingGroups);
-                    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, {
-                        ...cfnDeployment.props,
-                        parameters: {
-                            ...cfnDeployment.props.parameters,
-                            // only add the `amiParametersToTags` property if there are some
-                            ...(autoscalingGroups.length > 0 && { amiParametersToTags }),
-                            // only add the `minInstancesInServiceParameters` property if there are some
-                            ...(minInServiceAsgs.length > 0 && { minInstancesInServiceParameters }),
-                        },
+        const configuration = new Map();
+        const missingStacks = [];
+        Object.entries((0, group_by_1.groupByRiffRaffProjectName)(allCdkStacks)).forEach(([riffRaffProjectName, stacksGroupedByRiffRaffProject]) => {
+            const allowedStages = new Set(stacksGroupedByRiffRaffProject.map((_) => _.stage));
+            const requiredStages = Array.from(allowedStages);
+            const deployments = new Map();
+            Object.entries((0, group_by_1.groupByClassName)(stacksGroupedByRiffRaffProject)).forEach(([className, stacksGroupedByClassName]) => {
+                Object.entries((0, group_by_1.groupByStackTag)(stacksGroupedByClassName)).forEach(([stackTag, stacksGroupedByStackTag]) => {
+                    Object.entries((0, group_by_1.groupByRegion)(stacksGroupedByStackTag)).forEach(([region, stacksGroupedByRegion]) => {
+                        const stacks = Object.values((0, group_by_1.groupByStageTag)(stacksGroupedByRegion)).flat();
+                        requiredStages.forEach((requiredStage) => {
+                            if (!stacks.find(({ stage }) => stage === requiredStage)) {
+                                missingStacks.push({
+                                    riffRaffProjectName,
+                                    className,
+                                    region,
+                                    stack: stackTag,
+                                    stage: requiredStage,
+                                });
+                            }
+                        });
+                        // The items in `stacks` only differ by stage, so we can just use the first item in the list.
+                        const [stack] = stacks;
+                        if (!stack) {
+                            throw new Error("Unable to produce a working riff-raff.yaml file; there are no stacks!");
+                        }
+                        const lambdas = getLambdas(stack);
+                        const autoscalingGroups = getAutoScalingGroups(stack);
+                        const artifactUploads = [
+                            lambdas.filter((_) => !_.withoutArtifactUpload).map(lambda_2.uploadLambdaArtifact),
+                            autoscalingGroups.map(autoscaling_2.uploadAutoscalingArtifact),
+                        ].flat();
+                        artifactUploads.forEach(({ name, props }) => deployments.set(name, props));
+                        const parentStacks = getGuStackDependencies(stack).map((x) => (0, cloudformation_1.cloudFormationDeployment)([x], [], this.outdir));
+                        const cfnDeployment = (0, cloudformation_1.cloudFormationDeployment)(stacks, [...artifactUploads, ...parentStacks], this.outdir);
+                        deployments.set(cfnDeployment.name, cfnDeployment.props);
+                        const lambdasWithoutAnAlias = lambdas.filter((lambda) => lambda.alias === undefined);
+                        // If the Lambda has an alias it is using versioning. When using versioning, there is no need for Riff-Raff
+                        // to modify the unpublished version of the function
+                        lambdasWithoutAnAlias.forEach((lambda) => {
+                            const lambdaDeployment = (0, lambda_2.updateLambdaDeployment)(lambda, cfnDeployment);
+                            deployments.set(lambdaDeployment.name, lambdaDeployment.props);
+                        });
+                        /*
+                        Instances in an ASG with an `AutoScalingRollingUpdate` update policy are rotated via CloudFormation.
+                        Therefore, they do not need to also perform an `autoscaling` deployment via Riff-Raff.
+                        */
+                        const legacyAutoscalingGroups = autoscalingGroups.filter((asg) => {
+                            const { cfnOptions } = asg.node.defaultChild;
+                            const { updatePolicy } = cfnOptions;
+                            return updatePolicy?.autoScalingRollingUpdate === undefined;
+                        });
+                        legacyAutoscalingGroups.forEach((asg) => {
+                            const asgDeployment = (0, autoscaling_2.autoscalingDeployment)(asg, cfnDeployment);
+                            deployments.set(asgDeployment.name, asgDeployment.props);
+                        });
+                        // only add the `amiParametersToTags` property if there are some ASGs in the stack
+                        if (autoscalingGroups.length > 0) {
+                            (0, update_parameters_1.updateDeploymentParameters)(deployments, cfnDeployment, {
+                                amiParametersToTags: (0, cloudformation_1.getAmiParameters)(autoscalingGroups),
+                            });
+                        }
+                        /*
+                        At this point, `stacks` is a collection of similar `GuStack`s that differ only by their `stage`.
+                        We're about to add `minInstancesInServiceParameters` to assist Riff-Raff when deploying ASGs with scaling policies.
+                        This is driven by the presence of conditionally added CFN Parameters.
+                        To support the possibility of there being a scaling policy in PROD but not CODE, look at all the CFN Parameters in `stacks`.
+                         */
+                        const minInstancesInServiceParameters = stacks
+                            .flatMap((stack) => Object.values(stack.parameters))
+                            .filter((_) => _ instanceof ec2_app_1.GuAsgMinInstancesInServiceParameterExperimental)
+                            .reduce((acc, item) => {
+                            if (!acc.has(item.node.id)) {
+                                acc.set(item.node.id, item);
+                            }
+                            return acc;
+                        }, new Map());
+                        /**
+                         * Only add the `minInstancesInServiceParameters` property if there are some ASGs affected by {@link GuHorizontallyScalingDeploymentPropertiesExperimental}.
+                         */
+                        if (minInstancesInServiceParameters.size > 0) {
+                            (0, update_parameters_1.updateDeploymentParameters)(deployments, cfnDeployment, {
+                                minInstancesInServiceParameters: (0, cloudformation_1.getMinInstancesInServiceParameters)(minInstancesInServiceParameters),
+                            });
+                        }
                     });
                 });
             });
+            configuration.set(riffRaffProjectName, { allowedStages, deployments });
         });
-        this.riffRaffYaml = {
-            allowedStages,
-            deployments,
-        };
+        if (missingStacks.length > 0) {
+            const message = `Unable to produce a working riff-raff.yaml file; missing ${missingStacks.length} definitions`;
+            console.log(`${message} (details below)`);
+            console.table(missingStacks);
+            throw new Error(message);
+        }
+        this.configuration = configuration;
     }
     /**
-     * The `riff-raff.yaml` file as a string.
+     * A `riff-raff.yaml` file as a string.
      * Useful for testing.
+     *
+     * @param riffRaffProjectName which project to convert to YAML. Defaults to {@link UnknownRiffRaffProjectName} - any {@link GuStack} without an explicit `riffRaffProjectName` property.
      */
-    toYAML() {
+    toYAML(riffRaffProjectName = types_1.UnknownRiffRaffProjectName) {
         // Add support for ES6 Set and Map. See https://github.com/nodeca/js-yaml/issues/436.
         const replacer = (_key, value) => {
             if (value instanceof Set) {
@@ -249,16 +200,38 @@ class RiffRaffYamlFile {
             }
             return value;
         };
-        return (0, js_yaml_1.dump)(this.riffRaffYaml, { replacer });
+        const content = this.configuration.get(riffRaffProjectName);
+        if (!content) {
+            throw new Error(`No Riff-Raff project found with name: ${riffRaffProjectName}`);
+        }
+        return (0, js_yaml_1.dump)(content, { replacer });
     }
     /**
-     * Write the `riff-raff.yaml` file to disk.
-     * It'll be located with the CFN JSON templates generated by `cdk synth`.
+     * Write the `riff-raff.yaml` file(s) to disk, located in the same directory as the CFN JSON templates generated by `cdk synth`.
      */
     synth() {
-        const outPath = path_1.default.join(this.outdir, "riff-raff.yaml");
-        (0, fs_1.writeFileSync)(outPath, this.toYAML());
+        this.configuration.forEach((_, riffRaffProjectName) => {
+            const targetDirectory = riffRaffProjectName === types_1.UnknownRiffRaffProjectName
+                ? this.outdir
+                : validateRiffRaffYamlDirectory(this.outdir, riffRaffProjectName);
+            if (!(0, fs_1.existsSync)(targetDirectory)) {
+                (0, fs_1.mkdirSync)(targetDirectory, { recursive: true });
+            }
+            const outPath = path_1.default.join(targetDirectory, "riff-raff.yaml");
+            (0, fs_1.writeFileSync)(outPath, this.toYAML(riffRaffProjectName));
+        });
     }
 }
 exports.RiffRaffYamlFile = RiffRaffYamlFile;
+function validateRiffRaffYamlDirectory(basePath, riffRaffProjectName) {
+    const resolvedBase = path_1.default.resolve(basePath);
+    const resolvedPath = path_1.default.resolve(basePath, riffRaffProjectName);
+    const relativePath = path_1.default.relative(resolvedBase, resolvedPath);
+    const isOutside = relativePath === ".." || relativePath.startsWith(`..${path_1.default.sep}`) || path_1.default.isAbsolute(relativePath);
+    if (isOutside) {
+        throw new Error(`Directory traversal detected: '${riffRaffProjectName}' would create a directory outside of ${basePath} (riffRaffProjectName=${riffRaffProjectName}, resolvedPath='${resolvedPath}', resolvedBase='${resolvedBase}')`);
+    }
+    return resolvedPath;
+}
+exports.validateRiffRaffYamlDirectory = validateRiffRaffYamlDirectory;
 //# sourceMappingURL=index.js.map