@digitraffic/common 2024.1.24-3 → 2024.3.11-1

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

@@ -1,98 +0,0 @@
-import { Role } from "aws-cdk-lib/aws-iam";
-import { ISecret } from "aws-cdk-lib/aws-secretsmanager";
-import { CfnCanary } from "aws-cdk-lib/aws-synthetics";
-import { LambdaEnvironment } from "../stack/lambda-configs.mjs";
-import { DigitrafficRestApi } from "../stack/rest_apis.mjs";
-import { DigitrafficStack } from "../stack/stack.mjs";
-import { DigitrafficCanary } from "./canary.mjs";
-import { ENV_API_KEY, ENV_HOSTNAME, ENV_SECRET } from "./canary-keys.mjs";
-import { CanaryParameters } from "./canary-parameters.mjs";
-
-export interface UrlCanaryParameters extends CanaryParameters {
-    readonly hostname: string;
-    readonly apiKeyId: string;
-    readonly inVpc?: boolean;
-}
-
-export class UrlCanary extends DigitrafficCanary {
-    constructor(
-        stack: DigitrafficStack,
-        role: Role,
-        params: UrlCanaryParameters,
-        secret?: ISecret
-    ) {
-        const canaryName = `${params.name}-url`;
-        const environmentVariables: LambdaEnvironment = {};
-        environmentVariables[ENV_HOSTNAME] = params.hostname;
-
-        if (params.secret) {
-            environmentVariables[ENV_SECRET] = params.secret;
-        }
-
-        if (params.apiKeyId) {
-            environmentVariables[ENV_API_KEY] = params.apiKeyId;
-        }
-
-        if (secret) {
-            secret.grantRead(role);
-        }
-
-        // 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>,
-        secret?: ISecret
-    ): UrlCanary {
-        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,
-            secret
-        );
-    }
-
-    static getApiKey(publicApi: DigitrafficRestApi): string | undefined {
-        const apiKeys = publicApi.apiKeyIds;
-
-        if (apiKeys.length > 1) {
-            console.info("rest api has more than one api key");
-        }
-
-        if (apiKeys.length === 0) {
-            console.info("rest api has no api keys");
-            return undefined;
-        }
-
-        // always use first api key
-        return publicApi.apiKeyIds[0];
-    }
-}

package/src/aws/infra/canaries/url-checker.mts

@@ -1,388 +0,0 @@
-import { IncomingMessage, RequestOptions } from "http";
-import { Asserter } from "../../../test/asserter.mjs";
-
-// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-var-requires
-import synthetics from "Synthetics";
-import zlib from "zlib";
-import { MediaType } from "../../types/mediatypes.mjs";
-import { getApiKeyFromAPIGateway } from "../../runtime/apikey.mjs";
-import { FeatureCollection } from "geojson";
-import { isValidGeoJson } from "../../../utils/geometry.mjs";
-import { getEnvVariable } from "../../../utils/utils.mjs";
-import { ENV_API_KEY, ENV_HOSTNAME } from "./canary-keys.mjs";
-import { logger } from "../../runtime/dt-logger-default.mjs";
-import { logException } from "../../../utils/logging.mjs";
-
-export const API_KEY_HEADER = "x-api-key";
-
-const baseHeaders = {
-    "Digitraffic-User": "internal-digitraffic-canary",
-    "Accept-Encoding": "gzip",
-    Accept: "*/*",
-} as Record<string, string>;
-
-type CheckerFunction = (Res: IncomingMessage) => Promise<void>;
-type JsonCheckerFunction<T> = (
-    json: T,
-    body: string,
-    message: IncomingMessage
-) => Promise<void>;
-
-export class UrlChecker {
-    private readonly requestOptions: RequestOptions;
-
-    constructor(hostname: string, apiKey?: string) {
-        const headers = { ...baseHeaders };
-
-        if (apiKey) {
-            headers[API_KEY_HEADER] = apiKey;
-        }
-
-        this.requestOptions = {
-            hostname,
-            method: "GET",
-            protocol: "https:",
-            headers,
-        };
-
-        synthetics.getConfiguration().disableRequestMetrics();
-
-        synthetics
-            .getConfiguration()
-            .withIncludeRequestBody(false)
-            .withIncludeRequestHeaders(false)
-            .withIncludeResponseBody(false)
-            .withIncludeResponseHeaders(false)
-            .withFailedCanaryMetric(true);
-    }
-
-    static create(hostname: string, apiKeyId: string): Promise<UrlChecker> {
-        return getApiKeyFromAPIGateway(apiKeyId).then((apiKey) => {
-            return new UrlChecker(hostname, apiKey.value);
-        });
-    }
-
-    static createV2(): Promise<UrlChecker> {
-        return this.create(
-            getEnvVariable(ENV_HOSTNAME),
-            getEnvVariable(ENV_API_KEY)
-        );
-    }
-
-    expectStatus<T>(
-        statusCode: number,
-        url: string,
-        callback: JsonCheckerFunction<T>
-    ): Promise<void> {
-        const requestOptions = {
-            ...this.requestOptions,
-            ...{
-                path: url,
-            },
-        };
-
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-return
-        return synthetics.executeHttpStep(
-            `Verify ${statusCode} for ${url.replace(/auth=.*/, "")}`,
-            requestOptions,
-            callback
-        );
-    }
-
-    expect200<T>(
-        url: string,
-        ...callbacks: JsonCheckerFunction<T>[]
-    ): Promise<void> {
-        const callback = async (
-            json: T,
-            body: string,
-            res: IncomingMessage
-        ) => {
-            await Promise.allSettled(callbacks.map((c) => c(json, body, res)));
-        };
-
-        return this.expectStatus(200, url, callback);
-    }
-
-    expect404(url: string): Promise<void> {
-        const requestOptions = {
-            ...this.requestOptions,
-            ...{
-                path: url,
-            },
-        };
-
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-return
-        return synthetics.executeHttpStep(
-            `Verify 404 for ${url}`,
-            requestOptions,
-            validateStatusCodeAndContentType(404, MediaType.TEXT_PLAIN)
-        );
-    }
-
-    expect400(url: string): Promise<void> {
-        const requestOptions = {
-            ...this.requestOptions,
-            ...{
-                path: url,
-            },
-        };
-
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-return
-        return synthetics.executeHttpStep(
-            `Verify 400 for ${url}`,
-            requestOptions,
-            validateStatusCodeAndContentType(400, MediaType.TEXT_PLAIN)
-        );
-    }
-
-    expect403WithoutApiKey(url: string, mediaType?: MediaType): Promise<void> {
-        if (
-            // eslint-disable-next-line @typescript-eslint/prefer-optional-chain
-            !this.requestOptions.headers ||
-            !this.requestOptions.headers[API_KEY_HEADER]
-        ) {
-            logger.error({
-                method: "UrlChecker.expect403WithoutApiKey",
-                message: "No Api-key defined",
-            });
-        }
-
-        const requestOptions = {
-            ...this.requestOptions,
-            ...{
-                path: url,
-                headers: baseHeaders,
-            },
-        };
-
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-return
-        return synthetics.executeHttpStep(
-            `Verify 403 for ${url}`,
-            requestOptions,
-            validateStatusCodeAndContentType(
-                403,
-                mediaType ?? MediaType.APPLICATION_JSON
-            )
-        );
-    }
-
-    done(): string {
-        return "Canary successful";
-    }
-}
-
-async function getResponseBody(response: IncomingMessage): Promise<string> {
-    const body = await getBodyFromResponse(response);
-
-    if (response.headers["content-encoding"] === "gzip") {
-        try {
-            return zlib.gunzipSync(body).toString();
-        } catch (e) {
-            logException(logger, e);
-        }
-    }
-
-    return body.toString();
-}
-
-function getBodyFromResponse(response: IncomingMessage): Promise<string> {
-    return new Promise((resolve: (value: string) => void) => {
-        const buffers: Buffer[] = [];
-
-        response.on("data", (data: Buffer) => {
-            buffers.push(data);
-        });
-
-        response.on("end", () => {
-            resolve(Buffer.concat(buffers).toString());
-        });
-    });
-}
-
-/**
- * Returns function, that validates that the status code and content-type from response are the given values
- * @param statusCode
- * @param contentType
- */
-function validateStatusCodeAndContentType(
-    statusCode: number,
-    contentType: MediaType
-): (Res: IncomingMessage) => Promise<void> {
-    return (res: IncomingMessage) => {
-        return new Promise((resolve) => {
-            if (res.statusCode !== statusCode) {
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                throw new Error(`${res.statusCode!} ${res.statusMessage!}`);
-            }
-
-            if (res.headers["content-type"] !== contentType) {
-                throw new Error(
-                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                    `Wrong content-type ${res.headers["content-type"]!}`
-                );
-            }
-
-            resolve();
-        });
-    };
-}
-
-// DEPRECATED
-export class ResponseChecker {
-    private readonly contentType;
-    private checkCors = true;
-
-    constructor(contentType: string) {
-        this.contentType = contentType;
-    }
-
-    static forJson(): ResponseChecker {
-        return new ResponseChecker(MediaType.APPLICATION_JSON);
-    }
-
-    static forCSV(): ResponseChecker {
-        return new ResponseChecker(MediaType.TEXT_CSV);
-    }
-
-    static forGeojson(): ResponseChecker {
-        return new ResponseChecker(MediaType.APPLICATION_GEOJSON);
-    }
-
-    static forJpeg(): ResponseChecker {
-        return new ResponseChecker(MediaType.IMAGE_JPEG);
-    }
-
-    check(): CheckerFunction {
-        return this.responseChecker(() => {
-            // no need to do anything
-        });
-    }
-
-    checkJson<T>(
-        fn: (json: T, body: string, res: IncomingMessage) => void
-    ): CheckerFunction {
-        return this.responseChecker((body: string, res: IncomingMessage) => {
-            fn(JSON.parse(body) as unknown as T, body, res);
-        });
-    }
-
-    responseChecker(
-        fn: (body: string, res: IncomingMessage) => void
-    ): CheckerFunction {
-        return async (res: IncomingMessage): Promise<void> => {
-            if (!res.statusCode) {
-                throw new Error("statusCode missing");
-            }
-
-            if (res.statusCode < 200 || res.statusCode > 299) {
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                throw new Error(`${res.statusCode} ${res.statusMessage!}`);
-            }
-
-            if (this.checkCors && !res.headers["access-control-allow-origin"]) {
-                throw new Error("CORS missing");
-            }
-
-            if (res.headers["content-type"] !== this.contentType) {
-                throw new Error(
-                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                    `Wrong content-type ${res.headers["content-type"]!}`
-                );
-            }
-
-            const body = await getResponseBody(res);
-
-            fn(body, res);
-        };
-    }
-}
-
-export class ContentChecker {
-    static checkJson<T>(
-        fn: (json: T, body: string, res: IncomingMessage) => void
-    ): CheckerFunction {
-        return async (res: IncomingMessage): Promise<void> => {
-            const body = await getResponseBody(res);
-
-            fn(JSON.parse(body) as unknown as T, body, res);
-        };
-    }
-
-    static checkResponse(
-        fn: (body: string, res: IncomingMessage) => void
-    ): CheckerFunction {
-        return async (res: IncomingMessage): Promise<void> => {
-            const body = await getResponseBody(res);
-
-            fn(body, res);
-        };
-    }
-}
-
-export class ContentTypeChecker {
-    static checkContentType(contentType: MediaType): CheckerFunction {
-        return (res: IncomingMessage) => {
-            if (!res.statusCode) {
-                throw new Error("statusCode missing");
-            }
-
-            if (res.statusCode < 200 || res.statusCode > 299) {
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                throw new Error(`${res.statusCode} ${res.statusMessage!}`);
-            }
-
-            if (!res.headers["access-control-allow-origin"]) {
-                throw new Error("CORS missing");
-            }
-
-            if (res.headers["content-type"] !== contentType) {
-                throw new Error(
-                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                    `Wrong content-type ${res.headers["content-type"]!}`
-                );
-            }
-
-            return Promise.resolve();
-        };
-    }
-}
-
-export class GeoJsonChecker {
-    static validFeatureCollection(
-        fn?: (json: FeatureCollection) => void
-    ): CheckerFunction {
-        return ResponseChecker.forGeojson().checkJson(
-            (json: FeatureCollection) => {
-                Asserter.assertEquals(json.type, "FeatureCollection");
-                Asserter.assertTrue(isValidGeoJson(json));
-
-                if (fn) {
-                    fn(json);
-                }
-            }
-        );
-    }
-}
-
-export class HeaderChecker {
-    static checkHeaderExists(headerName: string): CheckerFunction {
-        return (res: IncomingMessage) => {
-            if (!res.headers[headerName]) {
-                throw new Error("Missing header: " + headerName);
-            }
-
-            return Promise.resolve();
-        };
-    }
-
-    static checkHeaderMissing(headerName: string): CheckerFunction {
-        return (res: IncomingMessage) => {
-            if (res.headers[headerName]) {
-                throw new Error("Header should not exist: " + headerName);
-            }
-
-            return Promise.resolve();
-        };
-    }
-}

package/src/aws/infra/documentation.mts

@@ -1,142 +0,0 @@
-import { Construct } from "constructs";
-import { CfnDocumentationPart, Resource } from "aws-cdk-lib/aws-apigateway";
-
-// Documentation parts are objects that describe an API Gateway API or parts of an API
-// https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html
-
-/**
- * Add description to a query parameter
- * @param name query parameter name
- * @param description query parameter description
- * @param resource REST API resource
- * @param stack CloudFormation stack
- *
- * @deprecated Use DigitrafficRestApi.documentResource
- */
-export function addQueryParameterDescription(
-    name: string,
-    description: string,
-    resource: Resource,
-    stack: Construct
-) {
-    new CfnDocumentationPart(stack, `${name}Documentation`, {
-        restApiId: resource.api.restApiId,
-        location: {
-            type: "QUERY_PARAMETER",
-            name,
-            path: resource.path,
-        },
-        properties: JSON.stringify({ description }),
-    });
-}
-
-/**
- * Add a documentation part to a method
- * @param methodDescription
- * @param documentationProperties
- * @param resource REST API resource
- * @param stack CloudFormation stack
- */
-export function addDocumentation(
-    methodDescription: string,
-    documentationProperties: object,
-    resource: Resource,
-    stack: Construct
-) {
-    new CfnDocumentationPart(stack, `${methodDescription}Documentation`, {
-        restApiId: resource.api.restApiId,
-        location: {
-            type: "METHOD",
-            path: resource.path,
-        },
-        properties: JSON.stringify(documentationProperties),
-    });
-}
-
-/**
- * Adds OpenAPI tags to an API method
- * @param methodDescription Description of API method
- * @param tags OpenAPI tags
- * @param resource REST API resource
- * @param stack CloudFormation stack
- */
-export function addTags(
-    methodDescription: string,
-    tags: string[],
-    resource: Resource,
-    stack: Construct
-) {
-    addDocumentation(methodDescription, { tags }, resource, stack);
-}
-
-/**
- * Adds OpenAPI tags and a method summary to an API method
- *
- * @deprecated Use DigitrafficRestApi.documentResource
- *
- * @param methodDescription Description of API method
- * @param tags OpenAPI tags
- * @param summary OpenAPI summary
- * @param resource REST API resource
- * @param stack CloudFormation stack
- */
-export function addTagsAndSummary(
-    methodDescription: string,
-    tags: string[],
-    summary: string,
-    resource: Resource,
-    stack: Construct
-) {
-    addDocumentation(methodDescription, { tags, summary }, resource, stack);
-}
-
-export interface DocumentationProperties {
-    description?: string;
-    tags?: string[];
-    summary?: string;
-    deprecated?: boolean;
-}
-
-export class DocumentationPart {
-    readonly parameterName: string;
-    readonly type: string;
-    readonly documentationProperties: DocumentationProperties;
-
-    private constructor(
-        parameterName: string,
-        documentationProperties: DocumentationProperties,
-        type: string
-    ) {
-        this.parameterName = parameterName;
-        this.documentationProperties = documentationProperties;
-        this.type = type;
-    }
-
-    deprecated(note: string): this {
-        // deprecated is not supported ATM: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-known-issues.html
-        this.documentationProperties.deprecated = true;
-        this.documentationProperties.summary += ". " + note;
-
-        return this;
-    }
-
-    static queryParameter(parameterName: string, description: string) {
-        return new DocumentationPart(
-            parameterName,
-            { description },
-            "QUERY_PARAMETER"
-        );
-    }
-
-    static pathParameter(parameterName: string, description: string) {
-        return new DocumentationPart(
-            parameterName,
-            { description },
-            "PATH_PARAMETER"
-        );
-    }
-
-    static method(tags: string[], name: string, summary: string) {
-        return new DocumentationPart(name, { tags, summary }, "METHOD");
-    }
-}

package/src/aws/infra/import-util.mts

@@ -1,57 +0,0 @@
-import { IVpc, Vpc } from "aws-cdk-lib/aws-ec2";
-import { CfnOutput, Fn, Stack } from "aws-cdk-lib";
-import { Construct } from "constructs";
-
-export class OldStackImports {
-    public static AURORAINSTANCE_SG_IMPORT_NAME = "AuroraSG";
-    public static RDSPROXY_SG_IMPORT_NAME = "RDSProxySG";
-}
-
-/**
- * Import VPC from other stack outputs
- */
-export function importVpc(scope: Construct, environmentName: string): IVpc {
-    const vpcId = importValue(environmentName, "VPCID");
-    const privateSubnetIds = [
-        importValue(environmentName, "digitrafficprivateASubnet"),
-        importValue(environmentName, "digitrafficprivateBSubnet"),
-    ];
-    const availabilityZones = ["euw1-az1", "euw1-az2"];
-
-    // VPC reference construction requires vpcId and availability zones
-    // private subnets are used in Lambda configuration
-    return Vpc.fromVpcAttributes(scope, "vpc", {
-        vpcId,
-        privateSubnetIds,
-        availabilityZones,
-    });
-}
-
-/**
- * Import value from other stack output.  Stack outputs are named with
- * digitraffic-${environmentName}-${name} pattern and this function takes care of it
- */
-export function importValue(environmentName: string, name: string): string {
-    return Fn.importValue(outputName(environmentName, name));
-}
-
-/**
- * Export value as stack output.  Use same naming pattern as importValue.
- */
-export function exportValue(
-    stack: Stack,
-    environmentName: string,
-    name: string,
-    value: string
-) {
-    const exportName = outputName(environmentName, name);
-
-    new CfnOutput(stack, exportName, {
-        exportName,
-        value,
-    });
-}
-
-export function outputName(environmentName: string, name: string): string {
-    return `digitraffic-${environmentName}-${name}`;
-}