fogfish / aws-cdk-pure Goto Github PK

Purely Functional and high-order cloud components with AWS CDK

License: MIT License

TypeScript 96.49% Makefile 1.01% JavaScript 2.50%

aws-cdk aws higher-order-component hoc cloud-component infrastructure pure-functional typescript iaac infrastructure-as-code

aws-cdk-pure's Introduction

aws-cdk-pure

The library is a toolkit for development of high-order and purely functional components with AWS CDK.

Inspiration

The purely functional extension to AWS CDK and has been inspired by the following posts

aws-cdk-pure is an utility for design and development of purely functional and higher-order components. You know React Hooks! Think of it as hooks for your cloud infrastructure.

Getting Started

This repository implements TypeScript libraries for cloud development. Please see its details and guidelines in corresponding README.md files

aws-cdk-pure - a core part of the toolkit. It defines types and functional primitives required for hight-order components development. It maintain a slim dependencies towards other library, only @aws-cdk/core is used.
aws-cdk-pure-hoc - implements reusable purely functional high-order components. These components are building blocks and design patterns for your cloud infrastructure.

How To Contribute

The library is MIT licensed and accepts contributions via GitHub pull requests:

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Added some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

The development requires TypeScript and AWS CDK

npm install -g typescript ts-node aws-cdk

git clone https://github.com/fogfish/aws-cdk-pure
cd aws-cdk-pure

## cd either to pure or hoc folder

npm install
npm run test
npm run lint
npm run build

License

aws-cdk-pure's People

Contributors

Stargazers

Watchers

Forkers

erupare ssun3 volkanunsal ssheff mjraadi-sentia laveen777

aws-cdk-pure's Issues

Escape Hatches in pure functional way

https://docs.aws.amazon.com/cdk/latest/guide/cfn_layer.html

Often it is required to Modifying the AWS CloudFormation Resource behind AWS Constructs.
The library should introduce a pure functional way to make it.

Throw if name is empty

Leaving the name empty is a frequent source of bugs and errors, since I use lambda functions, and forget to add the name field. e.g.

pure.join(scope, cloud.stack(() => ({})))

Would it be possible to create an invariant to check the name field? And even better would be if I can skip the empty lambda altogether:

pure.join(scope, cloud.stack('MyStack'))

It would remove a lot of boilerplate.

Cannot pass props to `root`

I need to pass env to the root stack, but I can't because pure.root doesn't take props as an argument.

New stack combinator

As a developer
I want to give a name and pass parameters to cdk.Stack
So that single application delivers immutable green/blue variants of same stack

With current API, you do

const app = new cdk.App()
const stack = new cdk.Stack(app, `xxx-${vsn}`, {
  env: {
    account: process.env.CDK_DEFAULT_ACCOUNT,
    region: process.env.CDK_DEFAULT_REGION
  }
})
pure.join(stack, MyComponent)
app.synth()

I'd like to make it

const Stack = (): cdk.StackProps => ({ env: {} })
const stack = pure.iaac(cdk.Stack)(Stack).effect(x => pure.join(x, MyComponent))
const app = new cdk.App()
pure.join(app, stack)

add `join` operator to `IPure<T>`

The lib supports stack construction using following syntax

const app = new cdk.App()
const stack = (): cdk.StackProps => ({})
pure.iaac(cdk.Stack)(stack)
  .effect(x => {
    pure.join(x, RestApi)
    pure.join(x, LogGroup)
    pure.join(x, CodeBuildEvents)
  })
app.synth()

The code become cleaner if join is part of IPure

pure.iaac(cdk.Stack)(stack)
  .join(RestApi)
  .join(LogGroup)
  .join(CodeBuildEvents)