Digitraffic-common

This is a place for common utilities and classes that can be used in other cdk-projects.

Setup

Initialize the project scripts by running the following command. This only needs to be done once, after cloning or pulling the repository for the first time. It will install/reinstall lefthook git hooks.

pnpm run setup

After that approve esbuild:

pnpm approve-builds

And then run again the setup.

How to build

Use pnpm to build the code i.e.

pnpm install
pnpm run build
pnpm run test
pnpm run test --test-path-pattern 'dt-logger.test'
pnpm run test:watch
pnpm run test:watch --test-path-pattern 'dt-logger.test'

Format code

pnpm run format:package-json # Format package.json
pnpm run format:check # Checks all files
pnpm run format:check-staged # Checks stagged files
pnpm run format:fix # Format all files
pnpm run format:fix-staged # Formats stagged files

Update deps

To update all dependencies to the latest versions allowed by your semver ranges:

pnpm up

If you want to ignore the version ranges in package.json and install the absolute latest versions:

pnpm up --latest

How to use

In package.json dependencies:

"dependencies": {
  "@digitraffic/common": "*",
}

In code:

import {DigitrafficStack, StackConfiguration} from "@digitraffic/common/dist/aws/infra/stack/stack";

DigitrafficStack

If you extend your stack from DigitrafficStack you get many benefits:

• Secret, VPC, Sg & alarmTopics automatically
• Stack validation with StackCheckingAspect
• Easier configuration with StackConfiguration

If you do not need those things, you should not use DigitrafficStack.

StackConfiguration

Some commonly used parameters is predefined configuration. You can write configuration for your environments once and use across cdk-projects.

StackCheckingAspect

Uses cdk aspects to do some sanity checking for your cdk stack:

• Stack naming check(Test/Prod in name)
• Function configuration(memory, timeout, runtime, reservedConcurrency)
• Tags, must have Solution tag defined
• S3 Buckets, no public access
• Api Gateway resource casing(kebabCase and snake_case)
• Queue encrypting
• LogGroup Retention

You can use StackCheckingAspect for any stack, DigitrafficStack does it automatically, but you can call it manually:

Aspects.of(this).add(StackCheckingAspect.create(this));

Any resource can be whitelisted by giving it as a parameter or in the StackConfiguration

FunctionBuilder

FunctionBuilder allows you to make lambdas with alarms on memory usage and timeouts.

By default, the created function has access to database, but this can of course be controlled.

Creating lambda is easy:

const lambda = FunctionBuilder.create(stack, "get-metadata")
  .withTimeout(Duration.seconds(2))
  .build();

See the documentation for more information.