@digitraffic/common 2023.6.19-1 → 2023.8.10-1

package/dist/aws/infra/canaries/canary-role.d.ts

@@ -2,5 +2,13 @@ import { Role } from "aws-cdk-lib/aws-iam";
 import { Construct } from "constructs";
 export declare class DigitrafficCanaryRole extends Role {
     constructor(stack: Construct, canaryName: string);
+    /**
+     * Provides permissions to access resources within a VPC.
+     */
     withDatabaseAccess(): this;
+    /**
+     * Same as withDatabaseAccess() - renamed to avoid confusion if used with UrlCanary.
+     * A UrlCanary needs these permissions to e.g. access a private API Gateway endpoint in a VPC.
+     */
+    withVpcAccess(): this;
 }

package/dist/aws/infra/canaries/canary-role.js

@@ -32,6 +32,9 @@ class DigitrafficCanaryRole extends aws_iam_1.Role {
         this.addToPolicy(new aws_iam_1.PolicyStatement(BASE_POLICY_STATEMENT_PROPS));
         this.addToPolicy(new aws_iam_1.PolicyStatement(CLOUDWATCH_STATEMENT_PROPS));
     }
+    /**
+     * Provides permissions to access resources within a VPC.
+     */
     withDatabaseAccess() {
         // Won't work :(
         // this.addToPolicy(new PolicyStatement(DB_STATEMENT_PROPS));
@@ -39,6 +42,14 @@ class DigitrafficCanaryRole extends aws_iam_1.Role {
         this.addManagedPolicy(aws_iam_1.ManagedPolicy.fromAwsManagedPolicyName("service-role/AWSLambdaVPCAccessExecutionRole"));
         return this;
     }
+    /**
+     * Same as withDatabaseAccess() - renamed to avoid confusion if used with UrlCanary.
+     * A UrlCanary needs these permissions to e.g. access a private API Gateway endpoint in a VPC.
+     */
+    withVpcAccess() {
+        this.addManagedPolicy(aws_iam_1.ManagedPolicy.fromAwsManagedPolicyName("service-role/AWSLambdaVPCAccessExecutionRole"));
+        return this;
+    }
 }
 exports.DigitrafficCanaryRole = DigitrafficCanaryRole;
 //# sourceMappingURL=canary-role.js.map

package/dist/aws/infra/canaries/canary.js

@@ -7,7 +7,7 @@ const canary_alarm_1 = require("./canary-alarm");
 class DigitrafficCanary extends aws_synthetics_alpha_1.Canary {
     constructor(scope, canaryName, role, params, environmentVariables) {
         super(scope, canaryName, {
-            runtime: aws_synthetics_alpha_1.Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_8,
+            runtime: aws_synthetics_alpha_1.Runtime.SYNTHETICS_NODEJS_PUPPETEER_4_0,
             role,
             test: aws_synthetics_alpha_1.Test.custom({
                 code: new aws_synthetics_alpha_1.AssetCode("dist", {

package/dist/aws/infra/canaries/url-canary.d.ts

@@ -1,16 +1,16 @@
-import { Construct } from "constructs";
-import { CanaryParameters } from "./canary-parameters";
 import { Role } from "aws-cdk-lib/aws-iam";
-import { DigitrafficCanary } from "./canary";
 import { ISecret } from "aws-cdk-lib/aws-secretsmanager";
-import { DigitrafficStack } from "../stack/stack";
 import { DigitrafficRestApi } from "../stack/rest_apis";
+import { DigitrafficStack } from "../stack/stack";
+import { DigitrafficCanary } from "./canary";
+import { CanaryParameters } from "./canary-parameters";
 export interface UrlCanaryParameters extends CanaryParameters {
     readonly hostname: string;
-    readonly apiKeyId?: string;
+    readonly apiKeyId: string;
+    readonly inVpc?: boolean;
 }
 export declare class UrlCanary extends DigitrafficCanary {
-    constructor(stack: Construct, role: Role, params: UrlCanaryParameters, secret?: ISecret);
-    static create(stack: DigitrafficStack, role: Role, publicApi: DigitrafficRestApi, params: Partial<UrlCanaryParameters>): UrlCanary;
+    constructor(stack: DigitrafficStack, role: Role, params: UrlCanaryParameters, secret?: ISecret);
+    static create(stack: DigitrafficStack, role: Role, publicApi: DigitrafficRestApi, params: Partial<UrlCanaryParameters>, secret?: ISecret): UrlCanary;
     static getApiKey(publicApi: DigitrafficRestApi): string | undefined;
 }

package/dist/aws/infra/canaries/url-canary.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UrlCanary = void 0;
+const aws_synthetics_1 = require("aws-cdk-lib/aws-synthetics");
 const canary_1 = require("./canary");
 const canary_keys_1 = require("./canary-keys");
 class UrlCanary extends canary_1.DigitrafficCanary {
@@ -19,17 +20,28 @@ class UrlCanary extends canary_1.DigitrafficCanary {
         }
         // the handler code is defined at the actual project using this
         super(stack, canaryName, role, params, environmentVariables);
+        if (params.inVpc && this.node.defaultChild instanceof aws_synthetics_1.CfnCanary) {
+            const subnetIds = stack.vpc === undefined
+                ? []
+                : stack.vpc.privateSubnets.map((subnet) => subnet.subnetId);
+            const securityGroupIds = stack.lambdaDbSg === undefined
+                ? []
+                : [stack.lambdaDbSg.securityGroupId];
+            this.node.defaultChild.vpcConfig = {
+                vpcId: stack.vpc?.vpcId,
+                securityGroupIds,
+                subnetIds,
+            };
+        }
     }
-    static create(stack, role, publicApi, params) {
+    static create(stack, role, publicApi, params, secret) {
         return new UrlCanary(stack, role, {
-            ...{
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                handler: `${params.name}.handler`,
-                hostname: publicApi.hostname(),
-                apiKeyId: this.getApiKey(publicApi),
-            },
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            handler: `${params.name}.handler`,
+            hostname: publicApi.hostname(),
+            apiKeyId: this.getApiKey(publicApi),
             ...params,
-        });
+        }, secret);
     }
     static getApiKey(publicApi) {
         const apiKeys = publicApi.apiKeyIds;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitraffic/common",
-  "version": "2023.6.19-1",
+  "version": "2023.8.10-1",
   "description": "",
   "repository": {
     "type": "git",
@@ -17,41 +17,41 @@
     "src/**/*.ts"
   ],
   "peerDependencies": {
-    "@aws-cdk/aws-synthetics-alpha": "^2.78.0-alpha.0",
+    "@aws-cdk/aws-synthetics-alpha": "^2.85.0-alpha.0",
     "@types/geojson": "^7946.0.10",
-    "aws-cdk-lib": "^2.78.0",
-    "aws-sdk": "^2.1374.0",
+    "aws-cdk-lib": "^2.85.0",
+    "aws-sdk": "^2.1405.0",
     "axios": "^1.2.6",
     "change-case": "^4.1.2",
     "constructs": "^10.2.17",
     "date-fns-tz": "~2.0.0",
-    "date-fns": "~2.29.3",
+    "date-fns": "~2.30.0",
     "etag": "^1.8.1",
     "geojson-validation": "^1.0.2",
     "node-ttl": "^0.2.0",
     "pg-native": "^3.0.1",
-    "pg-promise": "^11.0.0"
+    "pg-promise": "^11.5.0"
   },
   "devDependencies": {
-    "@aws-cdk/aws-synthetics-alpha": "2.78.0-alpha.0",
-    "@types/aws-lambda": "~8.10.115",
+    "@aws-cdk/aws-synthetics-alpha": "2.85.0-alpha.0",
+    "@types/aws-lambda": "~8.10.119",
     "@types/geojson": "^7946.0.10",
     "@types/etag": "^1.8.1",
-    "@types/jest": "^29.5.1",
+    "@types/jest": "^29.5.2",
     "@types/lodash": "^4.14.195",
     "@types/node": "18.15.13",
     "@types/ramda": "~0.29.1",
     "@types/sinon": "10.0.15",
-    "@typescript-eslint/eslint-plugin": "~5.59.5",
-    "@typescript-eslint/parser": "^5.59.5",
-    "aws-cdk-lib": "~2.78.0",
-    "aws-sdk": "~2.1374.0",
+    "@typescript-eslint/eslint-plugin": "~5.60.1",
+    "@typescript-eslint/parser": "^5.60.1",
+    "aws-cdk-lib": "~2.85.0",
+    "aws-sdk": "~2.1405.0",
     "axios": "^1.3.6",
     "change-case": "^4.1.2",
-    "constructs": "10.2.17",
+    "constructs": "10.2.61",
     "date-fns-tz": "~2.0.0",
-    "date-fns": "~2.29.3",
-    "eslint": "~8.40.0",
+    "date-fns": "~2.30.0",
+    "eslint": "~8.43.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-deprecation": "~1.4.1",
     "etag": "^1.8.1",
@@ -63,11 +63,11 @@
     "lodash": "^4.17.21",
     "node-ttl": "^0.2.0",
     "pg-native": "^3.0.1",
-    "pg-promise": "^11.4.3",
+    "pg-promise": "^11.5.0",
     "prettier": "^2.8.8",
     "ramda": "~0.29.0",
     "rimraf": "^5.0.1",
-    "sinon": "15.1.0",
+    "sinon": "15.2.0",
     "ts-jest": "^29.1.0",
     "typescript": "~4.9.5",
     "velocityjs": "2.0.6"

package/src/aws/infra/canaries/canary-role.ts

@@ -43,6 +43,9 @@ export class DigitrafficCanaryRole extends Role {
         this.addToPolicy(new PolicyStatement(CLOUDWATCH_STATEMENT_PROPS));
     }
 
+    /**
+     * Provides permissions to access resources within a VPC.
+     */
     withDatabaseAccess(): this {
         // Won't work :(
         // this.addToPolicy(new PolicyStatement(DB_STATEMENT_PROPS));
@@ -54,4 +57,17 @@ export class DigitrafficCanaryRole extends Role {
         );
         return this;
     }
+
+    /**
+     * Same as withDatabaseAccess() - renamed to avoid confusion if used with UrlCanary.
+     * A UrlCanary needs these permissions to e.g. access a private API Gateway endpoint in a VPC.
+     */
+    withVpcAccess(): this {
+        this.addManagedPolicy(
+            ManagedPolicy.fromAwsManagedPolicyName(
+                "service-role/AWSLambdaVPCAccessExecutionRole"
+            )
+        );
+        return this;
+    }
 }

package/src/aws/infra/canaries/canary.ts

@@ -21,7 +21,7 @@ export class DigitrafficCanary extends Canary {
         environmentVariables: LambdaEnvironment
     ) {
         super(scope, canaryName, {
-            runtime: Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_8,
+            runtime: Runtime.SYNTHETICS_NODEJS_PUPPETEER_4_0,
             role,
             test: Test.custom({
                 code: new AssetCode("dist", {

package/src/aws/infra/canaries/url-canary.ts

@@ -1,21 +1,22 @@
-import { Construct } from "constructs";
-import { CanaryParameters } from "./canary-parameters";
 import { Role } from "aws-cdk-lib/aws-iam";
-import { DigitrafficCanary } from "./canary";
 import { ISecret } from "aws-cdk-lib/aws-secretsmanager";
-import { DigitrafficStack } from "../stack/stack";
+import { CfnCanary } from "aws-cdk-lib/aws-synthetics";
 import { LambdaEnvironment } from "../stack/lambda-configs";
 import { DigitrafficRestApi } from "../stack/rest_apis";
+import { DigitrafficStack } from "../stack/stack";
+import { DigitrafficCanary } from "./canary";
 import { ENV_API_KEY, ENV_HOSTNAME, ENV_SECRET } from "./canary-keys";
+import { CanaryParameters } from "./canary-parameters";
 
 export interface UrlCanaryParameters extends CanaryParameters {
     readonly hostname: string;
-    readonly apiKeyId?: string;
+    readonly apiKeyId: string;
+    readonly inVpc?: boolean;
 }
 
 export class UrlCanary extends DigitrafficCanary {
     constructor(
-        stack: Construct,
+        stack: DigitrafficStack,
         role: Role,
         params: UrlCanaryParameters,
         secret?: ISecret
@@ -38,23 +39,45 @@ export class UrlCanary extends DigitrafficCanary {
 
         // the handler code is defined at the actual project using this
         super(stack, canaryName, role, params, environmentVariables);
+
+        if (params.inVpc && this.node.defaultChild instanceof CfnCanary) {
+            const subnetIds =
+                stack.vpc === undefined
+                    ? []
+                    : stack.vpc.privateSubnets.map((subnet) => subnet.subnetId);
+
+            const securityGroupIds =
+                stack.lambdaDbSg === undefined
+                    ? []
+                    : [stack.lambdaDbSg.securityGroupId];
+
+            this.node.defaultChild.vpcConfig = {
+                vpcId: stack.vpc?.vpcId,
+                securityGroupIds,
+                subnetIds,
+            };
+        }
     }
 
     static create(
         stack: DigitrafficStack,
         role: Role,
         publicApi: DigitrafficRestApi,
-        params: Partial<UrlCanaryParameters>
+        params: Partial<UrlCanaryParameters>,
+        secret?: ISecret
     ): UrlCanary {
-        return new UrlCanary(stack, role, {
-            ...{
+        return new UrlCanary(
+            stack,
+            role,
+            {
                 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                 handler: `${params.name!}.handler`,
                 hostname: publicApi.hostname(),
                 apiKeyId: this.getApiKey(publicApi),
-            },
-            ...params,
-        } as UrlCanaryParameters);
+                ...params,
+            } as UrlCanaryParameters,
+            secret
+        );
     }
 
     static getApiKey(publicApi: DigitrafficRestApi): string | undefined {