my-aws-sandbox

TD/TR

This is my sandbox AWS Serverless stack.

I'm sorry I haven't updated for a long time. Now that CDK v2 is available and my stack has a lot of customization, I don't see time to update it. Maybe in the future!

Big Picture

Limitations

This is a single repository stack. In one place, as a single CDK deployment, we are creating everything needed to deliver a working application.

AWS vendor locked-in

AWS

CDK
Lambda
API Gateway
DynamoDB
X-RAY
CloudWatch

TypeScript

prettier (clean code)
eslint (perfect code)
jest (tested)
ajv (validated data structures)

thanks

🍺🍺🍺 for Oskar Dudycz for the template to the project:

Github Action configuration
node.js configuration (prettier, eslint, tsconfig)

Build

npm install
npm run build

This will install the necessary CDK, then this example's dependencies, and then build your TypeScript files and CloudFormation template.

Deploy

Prerequisites

npm install -g aws-cdk

Deployment needed commands

npm run deploy

npx cdk deploy --profile name-of-the-profile

Development

CDK

Add new resources

Extend the CdkResources class with new item based on the convention
Implement resources instance for CdkResources with new item name
use generateResourceName function to generate the resource name based on the convention

Enable traceability for each resource:

for RestApi
for lambda please use lambdaFactory helper to generate CDK lambda with all needed setup

Automatic tests

For now, we support a humao.rest-client with VS code HTTP tests. Please remember for automatic and manual test -> to not spam PROD environment use automatic-test for *requestId header.

Decisions log

use the github markdown emoji markup to show type for decision

Emoji	Short description
☁️	Deployment
🎁	Development
🔨	Architecture decisions

Decision	Description	Timeframe
☁️ vendor locked-in	The solution is locked-in in the AWS Cloud - we don't want to build Multi Cloud solution.	21.03.2021 PR1
🔨 Typescript	Typescript is awesome ❤️ language for microservices (Typesafe and for small size of the repositories is maintainable). Very fast for prototyping and delivering simple solution.	21.03.2021 PR1
☁️ CDK	We can define deployment with the Typescript language and forget about YAML or JSON.	21.03.2021 PR1
☁️ github actions	I want to try github actions as build server to CI. For now we don't want to publish stack to AWS.	23.03.2021 PR3
🎁 eslint	Code can be verify for standard issues connected with JavaScript based on static analyze from eslint.	23.03.2021 PR4
🎁 prettier	We can keep same formatting.	23.03.2021 PR4
🔨 ajv	We want to validate json schema (and only schema for AWS Lambada incoming event) ajv is very simple validation library	23.03.2021 PR7
👨 manual testing	We want to use humao.rest-client and VS code to make the HTTP requests the API GW	31.03.2021 PR7
🎁 webpack	We want to publish lambda Typescript code as JavaScript with webpack	31.03.2021 PR7
🎁 ts-loader	To load dependencies we want to use ts-loaded based on examples	31.03.2021 PR7
☁️ X-RAY	We want to see the trace for each action in the system. The best option is to use AWS X-RAY.	21.03.2021 PR1
🔨 node-lambda-log	We want to try a library for logging, not sure if this is a best library. Will see...	03.04.2021 PR7
🔨 kebab case	We want to use kebab case for files and folders convention.	03.04.2021 PR7
🔨 pascal case	For Typescript class names.	03.04.2021 PR7
🔨 testing	We want to use `jest` library. Based on the friends recommendation this is the best and awesome test library on the javascript market	03.04.2021 PR7
☁️ DynamoDB	The context for demo service is users. To minimize latency to 80% cases (read by key) the best fit is use DynamoDB storage. We want to replicate data to all needed regions, so the DynamoDB connection helper calls always local DB instance	07.04.2021 PR7
📚 cfn-diagram as doc for CDK	We want to document AWS Stack with diagram based on the CDK	31.03.2021 PR9
🔨 database validation	We decided to use `DynamoDB` so we don't have any control about stored data (required are key and indexed fields). We want to be sure that data returned by the endpoint are valid, so we put the same ajv validation to the entities.	08.04.2021 PR14
🔨 lambda architecture	We decided to focus on the lambda implementation as proxy integration with API Gateway. All helpers and custom error with error (exception high level handler) are focused to deliver data as Lambda Proxy Integration.	13.04.2021 PR14
☁️ CDK resource names and id's	CDK resources should have id generated by `generateResourceName` helper and autogenerated name. Use `CdkResources` interface to define all needed AWS objects.	14.04.2021 PR14
🔨 delivering features	Push to develop branch is forbidden. Use PR with squash commits to keep clean main branch	16.04.2021 PR1
☁️ Event-Driven Architecture	I really don't like coupling! To build lousily coupled architecture in the cloud we can use EventBridge. Check dedicated Event-Driven-Architecture paragraf.	04.05.2021 PR22
🔨 lambda architecture	We decided to remove N-Layer architecure - code should be simple.	25.06.2022 PR14

Architecture

☁️

Event Driven Architecture

Event Bus

At first - find the best messaging system for you. Use AWS link. My solution is focused and vendor-locked with AWS.
Is important to have a possibility to add more than one event target.

To deliver lousily coupled architecture the best option is to use the EventBridge:

relatively cheap
max 5 targets

Outbox pattern

One source of truth for the data (users table).
Process data only persisted in the database (Start payment process, etc.)

Lambda

KISS

Code should be simple:

easy to read
easy to maintain
easy to test (less code to cover)
easy to rewrite ;)
easy to remove

Lambda to handle API Gateway request

The lambda is written as simple as possible. This is a microservice, so logic should be so 'easy' and hope in this can be migrated without any refactoring into hexagonal architecture.
On the picture there is a flow inside the lambda. There is a Service Layer with the dedicated model from the Lambda event. All in one service validate data and store it in the database.

helpers

dynamodb-factory

creates the document client for DynamoDB
wrap client with X-RAY

function dynamoClient(region?: string): DynamoDB.DocumentClient

CDK

how-to-use

install or update on the environment

npm install -g aws-cdk@latest

cdk-helpers

lambdaFactory

returns Function with default values
based on the convention uses handler: 'index.handler'

webpack

Handlers located in handlers folder, each in a dedicated folder with the name as index.ts. Use npm run build to make the deployment handler for CDK.

development configuration

    mode: "development",
    optimization: {
        minimize: false,
        usedExports: true,
    },

production configuration

 mode: 'production',

check the lambda package size

enable plugin

    plugins: [
        new BundleAnalyzerPlugin()
    ],

License

mjendza/aws-sandbox

ErrorLooks like something went wrong!

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors 3

Uh oh!

Languages

Error
Looks like something went wrong!

Packages