@gradientedge/cdk-utils-aws 2.6.0 → 2.8.0

package/dist/src/common/stack.d.ts

@@ -59,12 +59,26 @@ export declare class CommonStack extends Stack {
      * - Primary use is to have layered config in separate files to enable easier maintenance and readability
      */
     protected determineExtraContexts(): void;
+    /**
+     * @summary Method to determine region cdk contexts apart from the main cdk.json
+     * - Region is resolved from `region` CDK context
+     * - Loads `{regionContextPath}/{region}.json` if present
+     * - Primary use is to have layered config for each region in separate files
+     */
+    protected determineRegionContexts(): void;
     /**
      * @summary Method to determine extra cdk stage contexts apart from the main cdk.json
      * - Sets the properties from the extra stage contexts into cdk node context
      * - Primary use is to have layered config for each environment which is injected into the context
      */
     protected determineStageContexts(): void;
+    /**
+     * @summary Method to determine stage-region cdk contexts for environment and region-specific overrides
+     * - Loads `{stageRegionContextPath}/{stage}.{region}.json` if present
+     * - Has the highest priority in the configuration hierarchy
+     * - Primary use is to override config for a specific stage+region combination (e.g., prd.eu-west-1.json)
+     */
+    protected determineStageRegionContexts(): void;
     /**
      * @summary Determine the fully qualified domain name based on domainName & subDomain
      */

package/dist/src/common/stack.js

@@ -36,8 +36,12 @@ export class CommonStack extends Stack {
         super(parent, name, props);
         /* determine extra cdk contexts */
         this.determineExtraContexts();
+        /* determine region cdk contexts */
+        this.determineRegionContexts();
         /* determine extra cdk stage contexts */
         this.determineStageContexts();
+        /* determine stage-region cdk contexts */
+        this.determineStageRegionContexts();
         this.props = this.determineConstructProps(props);
         /* initialise the construct */
         this.construct = new CommonConstruct(this, 'cdk-utils', this.props);
@@ -98,6 +102,41 @@ export class CommonStack extends Stack {
             });
         });
     }
+    /**
+     * @summary Method to determine region cdk contexts apart from the main cdk.json
+     * - Region is resolved from `region` CDK context
+     * - Loads `{regionContextPath}/{region}.json` if present
+     * - Primary use is to have layered config for each region in separate files
+     */
+    determineRegionContexts() {
+        const region = this.node.tryGetContext('region');
+        const regionContextPath = this.node.tryGetContext('regionContextPath');
+        const debug = this.node.tryGetContext('debug');
+        if (!region || !regionContextPath) {
+            if (debug)
+                console.debug(`No region context provided. Using default context properties from cdk.json`);
+            return;
+        }
+        const regionContextFilePath = path.join(appRoot.path, regionContextPath, `${region}.json`);
+        /* alert default context usage when region config is missing */
+        if (!fs.existsSync(regionContextFilePath)) {
+            if (debug)
+                console.debug(`Region context properties unavailable in path:${regionContextFilePath}`);
+            if (debug)
+                console.debug(`Using default context properties for ${region} region`);
+            return;
+        }
+        /* read the region properties */
+        const regionContextPropsBuffer = fs.readFileSync(regionContextFilePath);
+        if (debug)
+            console.debug(`Adding region contexts provided in ${regionContextFilePath}`);
+        /* parse as JSON properties */
+        const regionContextProps = JSON.parse(regionContextPropsBuffer.toString('utf-8'));
+        /* set each of the property into the cdk node context */
+        _.keys(regionContextProps).forEach((propKey) => {
+            this.node.setContext(propKey, regionContextProps[propKey]);
+        });
+    }
     /**
      * @summary Method to determine extra cdk stage contexts apart from the main cdk.json
      * - Sets the properties from the extra stage contexts into cdk node context
@@ -105,7 +144,7 @@ export class CommonStack extends Stack {
      */
     determineStageContexts() {
         const stage = this.node.tryGetContext('stage');
-        const stageContextPath = this.node.tryGetContext('stageContextPath') || 'cdkEnv';
+        const stageContextPath = this.node.tryGetContext('stageContextPath') || 'cdk-env';
         const stageContextFilePath = path.join(appRoot.path, stageContextPath, `${stage}.json`);
         const debug = this.node.tryGetContext('debug');
         if (isDevStage(stage)) {
@@ -138,6 +177,40 @@ export class CommonStack extends Stack {
             }
         });
     }
+    /**
+     * @summary Method to determine stage-region cdk contexts for environment and region-specific overrides
+     * - Loads `{stageRegionContextPath}/{stage}.{region}.json` if present
+     * - Has the highest priority in the configuration hierarchy
+     * - Primary use is to override config for a specific stage+region combination (e.g., prd.eu-west-1.json)
+     */
+    determineStageRegionContexts() {
+        const stage = this.node.tryGetContext('stage');
+        const region = this.node.tryGetContext('region');
+        const stageRegionContextPath = this.node.tryGetContext('stageRegionContextPath');
+        const debug = this.node.tryGetContext('debug');
+        if (!stage || !region || !stageRegionContextPath) {
+            if (debug)
+                console.debug(`No stage-region context provided. Using default context properties from cdk.json`);
+            return;
+        }
+        const stageRegionContextFilePath = path.join(appRoot.path, stageRegionContextPath, `${stage}.${region}.json`);
+        /* gracefully skip when stage-region config is missing */
+        if (!fs.existsSync(stageRegionContextFilePath)) {
+            if (debug)
+                console.debug(`Stage-region context properties unavailable in path:${stageRegionContextFilePath}`);
+            return;
+        }
+        /* read the stage-region properties */
+        const stageRegionContextPropsBuffer = fs.readFileSync(stageRegionContextFilePath);
+        if (debug)
+            console.debug(`Adding stage-region contexts provided in ${stageRegionContextFilePath}`);
+        /* parse as JSON properties */
+        const stageRegionContextProps = JSON.parse(stageRegionContextPropsBuffer.toString('utf-8'));
+        /* set each of the property into the cdk node context */
+        _.keys(stageRegionContextProps).forEach((propKey) => {
+            this.node.setContext(propKey, stageRegionContextProps[propKey]);
+        });
+    }
     /**
      * @summary Determine the fully qualified domain name based on domainName & subDomain
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils-aws",
-  "version": "2.6.0",
+  "version": "2.8.0",
   "description": "AWS CDK utilities for @gradientedge/cdk-utils",
   "type": "module",
   "main": "dist/src/index.js",
@@ -14,17 +14,17 @@
     "dist/src/"
   ],
   "dependencies": {
-    "@aws-sdk/client-secrets-manager": "3.1045.0",
-    "@aws-sdk/credential-providers": "3.1045.0",
+    "@aws-sdk/client-secrets-manager": "3.1048.0",
+    "@aws-sdk/credential-providers": "3.1048.0",
     "@aws-sdk/types": "3.973.8",
     "@types/lodash": "4.17.24",
     "app-root-path": "3.1.0",
-    "aws-cdk-lib": "2.253.1",
+    "aws-cdk-lib": "2.254.0",
     "lodash": "4.18.1",
     "constructs": "10.6.0",
     "moment": "2.30.1",
     "uuid": "14.0.0",
-    "@gradientedge/cdk-utils-common": "2.3.0"
+    "@gradientedge/cdk-utils-common": "2.4.0"
   },
   "keywords": [
     "gradientedge",