@digitraffic/common 2023.9.13-1 → 2023.10.11-1

package/README.md

@@ -2,6 +2,13 @@
 
 This is a place for common utilities and classes that can be used in other cdk-projects.
 
+## How to build
+
+Use `npm` to build the code i.e.
+
+    npm run build
+    npm run test
+
 ## How to use
 
 In package.json dependencies:

package/dist/aws/infra/sqs-queue.js

@@ -48,7 +48,7 @@ class DigitrafficDLQueue {
         });
         const dlqFunctionName = `${dlqName}-Function`;
         const lambda = monitoredfunction_1.MonitoredFunction.create(stack, dlqFunctionName, {
-            runtime: aws_lambda_1.Runtime.NODEJS_14_X,
+            runtime: aws_lambda_1.Runtime.NODEJS_16_X,
             logRetention: aws_logs_1.RetentionDays.ONE_YEAR,
             functionName: dlqFunctionName,
             code: getDlqCode(dlqBucket.bucketName),

package/dist/aws/infra/stacks/db-proxy-stack.d.ts

@@ -15,7 +15,10 @@ export interface ProxyConfiguration {
  */
 export declare class DbProxyStack extends Stack {
     readonly isc: InfraStackConfiguration;
+    static PROXY_READER_EXPORT_NAME: string;
+    static PROXY_WRITER_EXPORT_NAME: string;
     constructor(scope: Construct, id: string, isc: InfraStackConfiguration, configuration: ProxyConfiguration);
+    setOutputs(proxy: DatabaseProxy): void;
     createProxy(vpc: IVpc, secret: ISecret, configuration: ProxyConfiguration): DatabaseProxy;
     createProxyEndpoints(vpc: IVpc, proxy: DatabaseProxy, securityGroupId: string): CfnDBProxyEndpoint;
 }

package/dist/aws/infra/stacks/db-proxy-stack.js

@@ -28,6 +28,12 @@ class DbProxyStack extends core_1.Stack {
         const readerEndpoint = this.createProxyEndpoints(vpc, proxy, configuration.securityGroupId);
         (0, parameters_1.createParameter)(this, "proxy.reader", readerEndpoint.attrEndpoint);
         (0, parameters_1.createParameter)(this, "proxy.writer", proxy.endpoint);
+        this.setOutputs(proxy);
+    }
+    setOutputs(proxy) {
+        // if only one instance, then there is no reader-endpoint
+        (0, import_util_1.exportValue)(this, this.isc.environmentName, DbProxyStack.PROXY_READER_EXPORT_NAME, proxy.endpoint);
+        (0, import_util_1.exportValue)(this, this.isc.environmentName, DbProxyStack.PROXY_WRITER_EXPORT_NAME, proxy.endpoint);
     }
     createProxy(vpc, secret, configuration) {
         const proxyId = `${this.isc.environmentName}-proxy`;
@@ -66,4 +72,6 @@ class DbProxyStack extends core_1.Stack {
     }
 }
 exports.DbProxyStack = DbProxyStack;
+DbProxyStack.PROXY_READER_EXPORT_NAME = "db-reader-endpoint";
+DbProxyStack.PROXY_WRITER_EXPORT_NAME = "db-writer-endpoint";
 //# sourceMappingURL=db-proxy-stack.js.map

package/dist/aws/infra/stacks/db-stack.d.ts

@@ -6,6 +6,7 @@ import { InfraStackConfiguration } from "./intra-stack-configuration";
 import { Stack } from "aws-cdk-lib/core";
 export interface DbConfiguration {
     readonly cluster?: ClusterConfiguration;
+    readonly clusterImport?: ClusterImportConfiguration;
     readonly customParameterGroups: AuroraPostgresEngineVersion[];
     readonly workmem?: number;
     /** superuser username and password are fetched from this secret, using keys
@@ -23,6 +24,10 @@ export interface ClusterConfiguration {
     readonly dbVersion: AuroraPostgresEngineVersion;
     readonly storageEncrypted?: boolean;
 }
+export interface ClusterImportConfiguration {
+    readonly clusterReadEndpoint: string;
+    readonly clusterWriteEndpoint: string;
+}
 /**
  * Stack that creates DatabaseCluster.
  *
@@ -39,7 +44,7 @@ export declare class DbStack extends Stack {
     static CLUSTER_WRITE_ENDPOINT_EXPORT_NAME: string;
     clusterIdentifier: string;
     constructor(scope: Construct, id: string, isc: InfraStackConfiguration, configuration: DbConfiguration);
-    createParamaterGroups(customVersions: AuroraPostgresEngineVersion[], workmem: number): IParameterGroup[];
+    createParameterGroups(customVersions: AuroraPostgresEngineVersion[], workmem: number): IParameterGroup[];
     createClusterParameters(secretArn: string, clusterConfiguration: ClusterConfiguration, instanceName: string, vpc: IVpc, securityGroup: ISecurityGroup, parameterGroup: IParameterGroup): DatabaseClusterProps;
     createAuroraCluster(isc: InfraStackConfiguration, configuration: DbConfiguration, clusterConfiguration: ClusterConfiguration, parameterGroups: IParameterGroup[]): DatabaseCluster;
 }

package/dist/aws/infra/stacks/db-stack.js

@@ -22,7 +22,11 @@ class DbStack extends core_1.Stack {
             env: isc.env,
         });
         this.clusterIdentifier = "";
-        const parameterGroups = this.createParamaterGroups(configuration.customParameterGroups, configuration.workmem ?? 524288);
+        const parameterGroups = this.createParameterGroups(configuration.customParameterGroups, configuration.workmem ?? 524288);
+        if ((configuration.cluster && configuration.clusterImport) ||
+            (!configuration.cluster && !configuration.clusterImport)) {
+            throw new Error("Configure either cluster or clusterImport");
+        }
         // create cluster if this is wanted, should do it only once
         if (configuration.cluster) {
             const cluster = this.createAuroraCluster(isc, configuration, configuration.cluster, parameterGroups);
@@ -34,18 +38,28 @@ class DbStack extends core_1.Stack {
             (0, parameters_1.createParameter)(this, "cluster.identifier", cluster.clusterIdentifier);
             this.clusterIdentifier = cluster.clusterIdentifier;
         }
+        if (configuration.clusterImport) {
+            (0, parameters_1.createParameter)(this, "cluster.reader", configuration.clusterImport.clusterReadEndpoint);
+            (0, parameters_1.createParameter)(this, "cluster.writer", configuration.clusterImport.clusterWriteEndpoint);
+        }
     }
-    createParamaterGroups(customVersions, workmem) {
-        return customVersions.map((version) => new aws_rds_1.ParameterGroup(this, `parameter-group-${version.auroraPostgresMajorVersion}`, {
-            engine: aws_rds_1.DatabaseClusterEngine.auroraPostgres({
-                version,
-            }),
-            parameters: {
-                "pg_stat_statements.track": "ALL",
-                random_page_cost: "1",
-                work_mem: workmem.toString(),
-            },
-        }));
+    createParameterGroups(customVersions, workmem) {
+        return customVersions.map((version) => {
+            const pg = new aws_rds_1.ParameterGroup(this, `parameter-group-${version.auroraPostgresMajorVersion}`, {
+                engine: aws_rds_1.DatabaseClusterEngine.auroraPostgres({
+                    version,
+                }),
+                parameters: {
+                    "pg_stat_statements.track": "ALL",
+                    random_page_cost: "1",
+                    work_mem: workmem.toString(),
+                },
+            });
+            // create both cluster parameter group and instance parameter group
+            pg.bindToCluster({});
+            pg.bindToInstance({});
+            return pg;
+        });
     }
     createClusterParameters(secretArn, clusterConfiguration, instanceName, vpc, securityGroup, parameterGroup) {
         const secret = aws_secretsmanager_1.Secret.fromSecretCompleteArn(this, "DBSecret", secretArn);

package/dist/aws/runtime/dt-logger-default.d.ts

@@ -1,4 +1,8 @@
 import { DtLogger } from "./dt-logger";
+/**
+ * You can use this for method name definition to match DtLogger LoggableType.method parameter.
+ */
+export type { LoggerMethodType } from "./dt-logger";
 /**
  * You can use this for your logging needs or create one locally and configure it as you wish.
  */

package/dist/aws/runtime/dt-logger.d.ts

@@ -2,6 +2,7 @@
 import { Writable } from "stream";
 /** Logging level */
 export type LOG_LEVEL = "DEBUG" | "INFO" | "WARN" | "ERROR";
+export type LoggerMethodType = `${string}.${string}`;
 /**
  * Configuration object for configuring the Digitraffic logging utility
  * @see {@link DtLogger}
@@ -39,7 +40,7 @@ export interface CustomParams {
  */
 export interface LoggableType extends CustomParams {
     /** Name of the method logging the message */
-    method: `${string}.${string}`;
+    method: LoggerMethodType;
     /** Message to log, optional */
     message?: string;
     /** Type of message, optional */

package/dist/utils/retry.js

@@ -15,6 +15,7 @@ var RetryLogError;
  */
 exports.timeoutFunctions = (function () {
     return {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
         noTimeout: (retryCount) => {
             return 0;
         },
@@ -40,6 +41,7 @@ exports.retryPredicates = (function () {
             }
             return false;
         },
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
         alwaysRetry: (error) => {
             return true;
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitraffic/common",
-  "version": "2023.9.13-1",
+  "version": "2023.10.11-1",
   "description": "",
   "repository": {
     "type": "git",

package/src/aws/infra/sqs-queue.ts

@@ -61,7 +61,7 @@ export class DigitrafficDLQueue {
 
         const dlqFunctionName = `${dlqName}-Function`;
         const lambda = MonitoredFunction.create(stack, dlqFunctionName, {
-            runtime: Runtime.NODEJS_14_X,
+            runtime: Runtime.NODEJS_16_X,
             logRetention: RetentionDays.ONE_YEAR,
             functionName: dlqFunctionName,
             code: getDlqCode(dlqBucket.bucketName),

package/src/aws/infra/stacks/db-proxy-stack.ts

@@ -9,7 +9,7 @@ import { ISecret, Secret } from "aws-cdk-lib/aws-secretsmanager";
 import { IVpc, SecurityGroup } from "aws-cdk-lib/aws-ec2";
 import { InfraStackConfiguration } from "./intra-stack-configuration";
 import { DbStack } from "./db-stack";
-import { importVpc } from "../import-util";
+import { exportValue, importVpc } from "../import-util";
 import { createParameter } from "../stack/parameters";
 import { Stack, Duration } from "aws-cdk-lib/core";
 import { Construct } from "constructs/lib/construct";
@@ -27,6 +27,9 @@ export interface ProxyConfiguration {
 export class DbProxyStack extends Stack {
     readonly isc: InfraStackConfiguration;
 
+    public static PROXY_READER_EXPORT_NAME = "db-reader-endpoint";
+    public static PROXY_WRITER_EXPORT_NAME = "db-writer-endpoint";
+
     constructor(
         scope: Construct,
         id: string,
@@ -57,6 +60,24 @@ export class DbProxyStack extends Stack {
 
         createParameter(this, "proxy.reader", readerEndpoint.attrEndpoint);
         createParameter(this, "proxy.writer", proxy.endpoint);
+
+        this.setOutputs(proxy);
+    }
+
+    setOutputs(proxy: DatabaseProxy) {
+        // if only one instance, then there is no reader-endpoint
+        exportValue(
+            this,
+            this.isc.environmentName,
+            DbProxyStack.PROXY_READER_EXPORT_NAME,
+            proxy.endpoint
+        );
+        exportValue(
+            this,
+            this.isc.environmentName,
+            DbProxyStack.PROXY_WRITER_EXPORT_NAME,
+            proxy.endpoint
+        );
     }
 
     createProxy(vpc: IVpc, secret: ISecret, configuration: ProxyConfiguration) {

package/src/aws/infra/stacks/db-stack.ts

@@ -26,6 +26,8 @@ import { createParameter } from "../stack/parameters";
 
 export interface DbConfiguration {
     readonly cluster?: ClusterConfiguration;
+    readonly clusterImport?: ClusterImportConfiguration;
+
     readonly customParameterGroups: AuroraPostgresEngineVersion[];
     readonly workmem?: number; // default 524288, 512MiB
 
@@ -47,6 +49,11 @@ export interface ClusterConfiguration {
     readonly storageEncrypted?: boolean; /// default true
 }
 
+export interface ClusterImportConfiguration {
+    readonly clusterReadEndpoint: string;
+    readonly clusterWriteEndpoint: string;
+}
+
 /**
  * Stack that creates DatabaseCluster.
  *
@@ -78,11 +85,18 @@ export class DbStack extends Stack {
             env: isc.env,
         });
 
-        const parameterGroups = this.createParamaterGroups(
+        const parameterGroups = this.createParameterGroups(
             configuration.customParameterGroups,
             configuration.workmem ?? 524288
         );
 
+        if (
+            (configuration.cluster && configuration.clusterImport) ||
+            (!configuration.cluster && !configuration.clusterImport)
+        ) {
+            throw new Error("Configure either cluster or clusterImport");
+        }
+
         // create cluster if this is wanted, should do it only once
         if (configuration.cluster) {
             const cluster = this.createAuroraCluster(
@@ -131,29 +145,47 @@ export class DbStack extends Stack {
 
             this.clusterIdentifier = cluster.clusterIdentifier;
         }
+
+        if (configuration.clusterImport) {
+            createParameter(
+                this,
+                "cluster.reader",
+                configuration.clusterImport.clusterReadEndpoint
+            );
+            createParameter(
+                this,
+                "cluster.writer",
+                configuration.clusterImport.clusterWriteEndpoint
+            );
+        }
     }
 
-    createParamaterGroups(
+    createParameterGroups(
         customVersions: AuroraPostgresEngineVersion[],
         workmem: number
     ): IParameterGroup[] {
-        return customVersions.map(
-            (version: AuroraPostgresEngineVersion) =>
-                new ParameterGroup(
-                    this,
-                    `parameter-group-${version.auroraPostgresMajorVersion}`,
-                    {
-                        engine: DatabaseClusterEngine.auroraPostgres({
-                            version,
-                        }),
-                        parameters: {
-                            "pg_stat_statements.track": "ALL",
-                            random_page_cost: "1",
-                            work_mem: workmem.toString(),
-                        },
-                    }
-                )
-        );
+        return customVersions.map((version: AuroraPostgresEngineVersion) => {
+            const pg = new ParameterGroup(
+                this,
+                `parameter-group-${version.auroraPostgresMajorVersion}`,
+                {
+                    engine: DatabaseClusterEngine.auroraPostgres({
+                        version,
+                    }),
+                    parameters: {
+                        "pg_stat_statements.track": "ALL",
+                        random_page_cost: "1",
+                        work_mem: workmem.toString(),
+                    },
+                }
+            );
+
+            // create both cluster parameter group and instance parameter group
+            pg.bindToCluster({});
+            pg.bindToInstance({});
+
+            return pg;
+        });
     }
 
     createClusterParameters(

package/src/aws/runtime/dt-logger-default.ts

@@ -1,5 +1,10 @@
 import { DtLogger } from "./dt-logger";
 
+/**
+ * You can use this for method name definition to match DtLogger LoggableType.method parameter.
+ */
+export type { LoggerMethodType } from "./dt-logger";
+
 /**
  * You can use this for your logging needs or create one locally and configure it as you wish.
  */

package/src/aws/runtime/dt-logger.ts

@@ -3,6 +3,7 @@ import _ from "lodash";
 
 /** Logging level */
 export type LOG_LEVEL = "DEBUG" | "INFO" | "WARN" | "ERROR";
+export type LoggerMethodType = `${string}.${string}`;
 
 /**
  * Configuration object for configuring the Digitraffic logging utility
@@ -55,7 +56,7 @@ export interface CustomParams {
  */
 export interface LoggableType extends CustomParams {
     /** Name of the method logging the message */
-    method: `${string}.${string}`;
+    method: LoggerMethodType;
     /** Message to log, optional */
     message?: string;
     /** Type of message, optional */

package/src/utils/retry.ts

@@ -16,6 +16,7 @@ export type RetryPredicate = (error: unknown) => boolean;
  */
 export const timeoutFunctions = (function () {
     return {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
         noTimeout: (retryCount: number): number => {
             return 0;
         },
@@ -42,6 +43,7 @@ export const retryPredicates = (function () {
             }
             return false;
         },
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
         alwaysRetry: (error: unknown): boolean => {
             return true;
         },