@digitraffic/common 2024.1.24-3 → 2024.3.11-1

package/src/aws/runtime/apikey.mts

@@ -1,9 +0,0 @@
-import {APIGateway} from "aws-sdk";
-
-export function getApiKeyFromAPIGateway(keyId: string): Promise<APIGateway.Types.ApiKey> {
-    const agw = new APIGateway();
-    return agw.getApiKey({
-        apiKey: keyId,
-        includeValue: true,
-    }).promise();
-}

package/src/aws/runtime/digitraffic-integration-response.mts

@@ -1,35 +0,0 @@
-import { IntegrationResponse } from "aws-cdk-lib/aws-apigateway";
-import { MediaType } from "../types/mediatypes.mjs";
-import {
-    getDeprecatedDefaultLambdaResponse,
-    RESPONSE_DEFAULT_LAMBDA,
-} from "../infra/api/response.mjs";
-
-export abstract class DigitrafficIntegrationResponse {
-    static ok(mediaType: MediaType, sunset?: string): IntegrationResponse {
-        return this.create("200", mediaType, sunset);
-    }
-
-    static badRequest(mediaType?: MediaType): IntegrationResponse {
-        return this.create("400", mediaType ?? MediaType.TEXT_PLAIN);
-    }
-
-    static notImplemented(mediaType?: MediaType): IntegrationResponse {
-        return this.create("501", mediaType ?? MediaType.TEXT_PLAIN);
-    }
-
-    static create(
-        statusCode: string,
-        mediaType: MediaType,
-        sunset?: string
-    ): IntegrationResponse {
-        return {
-            statusCode,
-            responseTemplates: {
-                [mediaType]: sunset
-                    ? getDeprecatedDefaultLambdaResponse(sunset)
-                    : RESPONSE_DEFAULT_LAMBDA,
-            },
-        };
-    }
-}

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

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

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

@@ -1,184 +0,0 @@
-import { Writable } from "stream";
-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
- * @see {@link DtLogger}
- */
-export interface LoggerConfiguration {
-    /** Name of the lambda */
-    lambdaName?: string;
-    /** The file name where the logging occurs */
-    fileName?: string;
-    /** The lambda runtime environment */
-    runTime?: string;
-    /** Custom end point to write the logs to */
-    writeStream?: Writable;
-}
-
-interface LoggableTypeInternal extends LoggableType {
-    level: LOG_LEVEL;
-}
-
-/**
- * CustomParams allows to add keys prefixed with `custom` keyword to be added to an
- * object.
- */
-export interface CustomParams {
-    /** do not log your apikey! */
-    customApikey?: never;
-    /** do not log your apikey! */
-    customApiKey?: never;
-    [key: `custom${Capitalize<string>}Count`]: number;
-
-    [key: `custom${Capitalize<string>}`]:
-        | string
-        | number
-        | bigint
-        | boolean
-        | Date
-        | null
-        | undefined;
-}
-
-/**
- * Digitraffic logging object.
- *
- * `method` property is the only required propetry. {@link CustomParams} can be added by
- * prefixin the property with keyword `custom`. The prefix is removed before writing to
- * logging end point.
- *
- * @see {@link CustomParams}
- */
-export interface LoggableType extends CustomParams {
-    /** Name of the method logging the message */
-    method: LoggerMethodType;
-    /** Message to log, optional */
-    message?: string;
-    /** Type of message, optional */
-    type?: string;
-    /** Stack trace, optional */
-    stack?: string | undefined;
-    /** Amount of time some operation took in milliseconds, optional */
-    tookMs?: number;
-    /** Pass error object, which will be stringified before logging */
-    error?: unknown;
-}
-
-/**
- * Helper class for json-logging.
- *
- * Logged line will include:
- * * log-level
- * * lambdaName (taken from process environment)
- * * runtime (taken from process environment)
- * * the actual message (as json or as string)
- */
-export class DtLogger {
-    readonly lambdaName?: string;
-    readonly runtime?: string;
-
-    readonly writeStream: Writable;
-
-    /**
-     * Create a new Logger instance.
-     * @constructor
-     * @param {LoggerConfiguration?} [config] - Accepts configuration options @see {@link LoggerConfiguration}
-     */
-    constructor(config?: LoggerConfiguration) {
-        this.lambdaName =
-            config?.lambdaName ?? process.env.AWS_LAMBDA_FUNCTION_NAME;
-        this.runtime = config?.runTime ?? process.env.AWS_EXECUTION_ENV;
-        this.writeStream = config?.writeStream ?? process.stdout;
-    }
-
-    /**
-     * Log given message with level DEBUG.  This will not be forwarded to centralized logging system!.
-     *
-     * @param message anything
-     * @see {@link LoggableType}
-     * @see {@link DtLogger.log}
-     */
-    debug(message: unknown): void {
-        const logMessage = {
-            message,
-            level: "DEBUG",
-            lambdaName: this.lambdaName,
-            runtime: this.runtime,
-        };
-
-        this.writeStream.write(JSON.stringify(logMessage) + "\n");
-    }
-
-    /**
-     * Log given message with level INFO
-     *
-     * @param message Json-object to log
-     * @see {@link LoggableType}
-     * @see {@link DtLogger.log}
-     */
-    info(message: LoggableType): void {
-        this.log({ ...message, level: "INFO" });
-    }
-
-    /**
-     * Log given message with level WARN
-     *
-     * @param message Json-object to log
-     * @see {@link LoggableType}
-     * @see {@link DtLogger.log}
-     */
-    warn(message: LoggableType): void {
-        this.log({ ...message, level: "WARN" });
-    }
-    /**
-     * Log given message with level INFO
-     *
-     * @param message Json-object to log
-     * @see {@link LoggableType}
-     * @see {@link DtLogger.log}
-     */
-    error(message: LoggableType): void {
-        this.log({
-            ...message,
-            level: "ERROR",
-        });
-    }
-
-    /**
-     * Log message with given log level.
-     *
-     * Some metadata is also added to the message:
-     * * runtime     - can be configured with constructor or inferred from environment
-     * * lambdaName  - can be configured with constructor or inferred from environment
-     *
-     * @param message Json-object to log
-     * @see {@link LoggableType}
-     */
-    private log(message: LoggableTypeInternal): void {
-        const error = message.error
-            ? typeof message.error === "string"
-                ? message.error
-                : JSON.stringify(message.error)
-            : undefined;
-
-        const logMessage = {
-            ...removePrefix("custom", message),
-            error,
-            lambdaName: this.lambdaName,
-            runtime: this.runtime,
-        };
-
-        this.writeStream.write(JSON.stringify(logMessage) + "\n");
-    }
-}
-
-function removePrefix(prefix: string, loggable: LoggableType) {
-    return _.mapKeys(loggable, (_index, key: string) =>
-        key.startsWith(prefix) ? _.lowerFirst(key.replace(prefix, "")) : key
-    );
-}

package/src/aws/runtime/environment.mts

@@ -1,22 +0,0 @@
-export enum EnvKeys {
-    AWS_REGION = "AWS_REGION",
-    SECRET_ID = "SECRET_ID",
-    SECRET_OVERRIDE_AWS_REGION = "SECRET_OVERRIDE_AWS_REGION",
-}
-
-/**
- * @deprecated Use digitraffic/common/utils/utils#getEnvVariable
- */
-export function envValue(key: string, defaultValue?: string): string {
-    const value = process.env[key];
-
-    if (value == null) {
-        if (defaultValue) {
-            return defaultValue;
-        }
-
-        throw new Error(`Missing environment value ${key}`);
-    }
-
-    return value;
-}

package/src/aws/runtime/messaging.mts

@@ -1,26 +0,0 @@
-import {SNS} from "aws-sdk";
-
-/**
- * Utility function for publishing SNS messages.
- * Made because using *await* with AWS APIs doesn't require calling promise() but nothing works if it isn't called.
- * Retries a single time in case of failure.
- * @param message
- * @param topicArn
- * @param sns
- */
-export async function snsPublish(message: string, topicArn: string, sns: SNS) {
-    const publishParams = {
-        Message: message,
-        TopicArn: topicArn,
-    };
-    try {
-        await sns.publish(publishParams).promise();
-    } catch (error) {
-        console.error('method=snsPublish error, retrying', error);
-        try {
-            await sns.publish(publishParams).promise();
-        } catch (e2) {
-            console.error('method=snsPublish error after retry', e2);
-        }
-    }
-}

package/src/aws/runtime/s3.mts

@@ -1,44 +0,0 @@
-import {S3} from "aws-sdk";
-
-export async function uploadToS3<Body extends S3.Body | undefined>(
-    bucketName: string,
-    body: Body,
-    objectName: string,
-    cannedAcl?: string,
-    contentType?: string,
-) {
-
-    const s3 = new S3();
-    try {
-        await doUpload(
-            s3, bucketName, body, objectName, cannedAcl, contentType,
-        );
-    } catch (error) {
-        console.warn('method=uploadToS3 retrying upload to bucket %s', bucketName);
-        try {
-            await doUpload(
-                s3, bucketName, body, objectName, cannedAcl, contentType,
-            );
-        } catch (e2) {
-            console.error('method=uploadToS3 failed retrying upload to bucket %s', bucketName);
-        }
-    }
-}
-
-function doUpload<Body extends S3.Body | undefined>(
-    s3: S3,
-    bucketName: string,
-    body: Body,
-    filename: string,
-    cannedAcl?: string,
-    contentType?: string,
-) {
-
-    return s3.upload({
-        Bucket: bucketName,
-        Body: body,
-        Key: filename,
-        ACL: cannedAcl,
-        ContentType: contentType,
-    }).promise();
-}

package/src/aws/runtime/secrets/dbsecret.mts

@@ -1,31 +0,0 @@
-import { GenericSecret } from "./secret.mjs";
-
-export enum RdsProxySecretKey {
-    username = "username",
-    password = "password",
-    proxy_host = "proxy_host",
-    proxy_ro_host = "proxy_ro_host",
-}
-
-export enum RdsSecretKey {
-    username = "username",
-    password = "password",
-    host = "host",
-    ro_host = "ro_host",
-}
-
-export type RdsProxySecret = Record<RdsProxySecretKey, string>;
-export type RdsSecret = Record<RdsSecretKey, string>;
-
-export function checkExpectedSecretKeys<Secret extends GenericSecret>(
-    keys: string[],
-    secret: Secret
-) {
-    const missingKeys = keys.filter((key) => !(key in secret));
-    if (missingKeys.length) {
-        console.error(
-            `method=checkExpectedSecretKeys secret didn't contain the key(s) ${missingKeys.toString()}`
-        );
-        throw new Error("Expected keys were not found");
-    }
-}

package/src/aws/runtime/secrets/node-ttl.d.mts

@@ -1,12 +0,0 @@
-declare module 'node-ttl' {
-  class Ttl {
-    constructor({
-      ttl: number
-                })
-    push: (key: string, value: unknown) => boolean
-
-    get: <T>(key: string) => T
-  }
-
-  export=Ttl
-};

package/src/aws/runtime/secrets/proxy-holder.mts

@@ -1,34 +0,0 @@
-import { SecretHolder } from "./secret-holder.mjs";
-import { RdsProxySecretKey, RdsProxySecret } from "./dbsecret.mjs";
-import { getEnvVariable } from "../../../utils/utils.mjs";
-import { DatabaseEnvironmentKeys } from "../../../database/database.mjs";
-
-const RDS_PROXY_SECRET_KEYS = Object.values(RdsProxySecretKey);
-
-/**
- * Holds credentials for RDS Proxy access.
- */
-export class ProxyHolder {
-    private readonly secretHolder;
-
-    constructor(secretId: string) {
-        this.secretHolder = new SecretHolder<RdsProxySecret>(
-            secretId,
-            "",
-            RDS_PROXY_SECRET_KEYS
-        );
-    }
-
-    static create() {
-        return new ProxyHolder(getEnvVariable("SECRET_ID"));
-    }
-
-    public async setCredentials() {
-        const secret = await this.secretHolder.get();
-
-        process.env[DatabaseEnvironmentKeys.DB_USER] = secret.username;
-        process.env[DatabaseEnvironmentKeys.DB_PASS] = secret.password;
-        process.env[DatabaseEnvironmentKeys.DB_URI] = secret.proxy_host;
-        process.env[DatabaseEnvironmentKeys.DB_RO_URI] = secret.proxy_ro_host;
-    }
-}

package/src/aws/runtime/secrets/rds-holder.mts

@@ -1,34 +0,0 @@
-import { SecretHolder } from "./secret-holder.mjs";
-import { RdsSecret, RdsSecretKey } from "./dbsecret.mjs";
-import { getEnvVariable } from "../../../utils/utils.mjs";
-import { DatabaseEnvironmentKeys } from "../../../database/database.mjs";
-
-const RDS_SECRET_KEYS = Object.values(RdsSecretKey);
-
-/**
- * Holds credentials for RDS access.
- */
-export class RdsHolder {
-    private readonly secretHolder;
-
-    constructor(secretId: string) {
-        this.secretHolder = new SecretHolder<RdsSecret>(
-            secretId,
-            "",
-            RDS_SECRET_KEYS
-        );
-    }
-
-    static create() {
-        return new RdsHolder(getEnvVariable("SECRET_ID"));
-    }
-
-    public async setCredentials() {
-        const secret = await this.secretHolder.get();
-
-        process.env[DatabaseEnvironmentKeys.DB_USER] = secret.username;
-        process.env[DatabaseEnvironmentKeys.DB_PASS] = secret.password;
-        process.env[DatabaseEnvironmentKeys.DB_URI] = secret.host;
-        process.env[DatabaseEnvironmentKeys.DB_RO_URI] = secret.ro_host;
-    }
-}

package/src/aws/runtime/secrets/secret-holder.mts

@@ -1,106 +0,0 @@
-import { GenericSecret, getSecret } from "./secret.mjs";
-import { checkExpectedSecretKeys } from "./dbsecret.mjs";
-import { getEnvVariable } from "../../../utils/utils.mjs";
-import { logger } from "../dt-logger-default.mjs";
-
-import NodeTtl from "node-ttl";
-
-const DEFAULT_PREFIX = "";
-const DEFAULT_SECRET_KEY = "SECRET";
-const DEFAULT_CONFIGURATION = {
-    ttl: 5 * 60, // timeout secrets in 5 minutes
-};
-
-/**
- * Utility class for getting secrets from Secret Manager.
- * Supports prefix for secrets, checking of expected keys and ttl-configuration.
- *
- * By default, secrets are cached for 5 minutes and then reread from the Secrets Manager(This can be overridden with configuration).
- *
- * Supports setting the database environment paramaters from the secret too.
- *
- * If you want secret manager to get values from different region than the lambda runtime is running, you can override this by
- * setting the region with utils setSecretOverideAwsRegionEnv method.
- *
- */
-export class SecretHolder<Secret extends GenericSecret> {
-    private readonly secretId: string;
-    private readonly prefix: string;
-    private readonly expectedKeys: string[];
-
-    private readonly secretCache;
-
-    constructor(
-        secretId: string,
-        prefix = "",
-        expectedKeys: string[] = [],
-        configuration = DEFAULT_CONFIGURATION
-    ) {
-        this.secretId = secretId;
-        this.prefix = prefix;
-        this.expectedKeys = expectedKeys;
-
-        // eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call
-        this.secretCache = new NodeTtl(configuration);
-    }
-
-    private async initSecret() {
-        const secretValue = await getSecret<Secret>(this.secretId);
-
-        logger.info({
-            method: "SecretHolder.initSecret",
-            message: "Refreshing secret " + this.secretId,
-        });
-
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
-        this.secretCache.push(DEFAULT_SECRET_KEY, secretValue);
-    }
-
-    public static create<S extends GenericSecret>(
-        prefix = DEFAULT_PREFIX,
-        expectedKeys: string[] = []
-    ) {
-        return new SecretHolder<S>(
-            getEnvVariable("SECRET_ID"),
-            prefix,
-            expectedKeys
-        );
-    }
-
-    public async get(): Promise<Secret> {
-        const secret = await this.getSecret<Secret>();
-        const parsedSecret =
-            this.prefix === DEFAULT_PREFIX
-                ? secret
-                : this.parseSecret(secret, `${this.prefix}.`);
-
-        if (this.expectedKeys.length > 0) {
-            checkExpectedSecretKeys(this.expectedKeys, parsedSecret);
-        }
-
-        return parsedSecret;
-    }
-
-    private parseSecret(secret: GenericSecret, prefix: string): Secret {
-        const parsed: GenericSecret = {};
-        const skip = prefix.length;
-
-        for (const key in secret) {
-            if (key.startsWith(prefix)) {
-                parsed[key.substring(skip)] = secret[key];
-            }
-        }
-
-        return parsed as unknown as Secret;
-    }
-
-    private async getSecret<S>(): Promise<S> {
-        const secret: S | undefined = this.secretCache.get(DEFAULT_SECRET_KEY);
-
-        if (!secret) {
-            await this.initSecret();
-        }
-
-        return secret ?? (this.secretCache.get(DEFAULT_SECRET_KEY));
-    }
-}

package/src/aws/runtime/secrets/secret.mts

@@ -1,58 +0,0 @@
-import { SecretsManager } from "aws-sdk";
-import { getEnvVariable, getEnvVariableOrElse } from "../../../utils/utils.mjs";
-import { EnvKeys } from "../environment.mjs";
-
-// SECRET_OVERRIDE_AWS_REGION might not have been set before import of
-// secret, so we need to lazy initialize SecretsManager
-let smClient: SecretsManager | undefined;
-function getSmClient(): SecretsManager {
-    if (!smClient) {
-        smClient = new SecretsManager({
-            region: getEnvVariableOrElse<string>(
-                EnvKeys.SECRET_OVERRIDE_AWS_REGION, // this is override secret region
-                getEnvVariable(EnvKeys.AWS_REGION)
-            ),
-        });
-    }
-    return smClient;
-}
-
-export type GenericSecret = Record<string, string>;
-
-export async function getSecret<Secret>(
-    secretId: string,
-    prefix = ""
-): Promise<Secret> {
-    const secretObj = await getSmClient()
-        .getSecretValue({
-            SecretId: secretId,
-        })
-        .promise();
-
-    if (!secretObj.SecretString) {
-        throw new Error("No secret found!");
-    }
-
-    const secret: GenericSecret | Secret = JSON.parse(
-        secretObj.SecretString
-    ) as unknown as GenericSecret | Secret;
-
-    if (!prefix) {
-        return secret as Secret;
-    }
-
-    return parseSecret(secret as GenericSecret, `${prefix}.`);
-}
-
-function parseSecret<Secret>(secret: GenericSecret, prefix: string): Secret {
-    const parsed: GenericSecret = {};
-    const skip = prefix.length;
-
-    for (const key in secret) {
-        if (key.startsWith(prefix)) {
-            parsed[key.substring(skip)] = secret[key];
-        }
-    }
-
-    return parsed as unknown as Secret;
-}

package/src/aws/types/errors.mts

@@ -1,14 +0,0 @@
-// DEPRECATED, remove these!
-export const NOT_FOUND_MESSAGE = "NOT_FOUND";
-export const ERROR_MESSAGE = "ERROR";
-export const OK_MESSAGE = "OK";
-export const BAD_REQUEST_MESSAGE = "BAD REQUEST";
-
-export class ValidationError extends Error {
-    statusCode: number;
-
-    constructor(statusCode: number, body: string) {
-        super(body);
-        this.statusCode = statusCode;
-    }
-}