https://github.com/evilkiwi/lamware
AWS Lambda Middleware design pattern
https://github.com/evilkiwi/lamware
async aws framework lambda middleware typescript
Last synced: 12 months ago
JSON representation
AWS Lambda Middleware design pattern
- Host: GitHub
- URL: https://github.com/evilkiwi/lamware
- Owner: evilkiwi
- License: gpl-3.0
- Created: 2022-03-22T01:54:12.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-28T12:07:17.000Z (almost 3 years ago)
- Last Synced: 2024-10-29T18:05:20.624Z (over 1 year ago)
- Topics: async, aws, framework, lambda, middleware, typescript
- Language: TypeScript
- Homepage: https://docs.evil.kiwi/lamware/
- Size: 2.81 MB
- Stars: 14
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
AWS Lambda Middleware Pattern (NodeJS)
[Lamware](https://github.com/evilkiwi/lamware) is a simple design pattern based on middleware for AWS Lambda. Lambda, like other Cloud Function platforms, is executed by a request - which could be from anything like a queue (SQS) to a HTTP request. Since Lambda focusses on business logic, setting things up before-hand can be quite tedious.
Using a middleware pattern means your function is slightly delayed in recieving the event whilst Lamware runs various logic to set things up (in parallel, where possible). For example, you could have middleware set up to do things like:
- Pull Secrets from Secrets Manager/external service
- Fetch JSON config from AppConfig
- Exit early if this was a Warming event from CloudWatch
- Automate some Tracing bootstrap
- Set-up some best practises (Like `callbackWaitsForEmptyEventLoop`)
## Installation
This package is available via NPM:
```bash
yarn add @lamware/core
# or
npm install @lamware/core
```
We maintain and ship various middlewares for public use - you can [install them too](https://github.com/evilkiwi/lamware/tree/master/packages)!
## Usage
We have [Documentation available here](https://docs.evil.kiwi/lamware), and you can check out the [`example` folder](https://github.com/evilkiwi/lamware/tree/master/example) for a fully-featured example with the AWS CDK stack to deploy it.
```typescript
import { powertoolsTracing } from '@lamware/powertools-tracing';
import { powertoolsLogger } from '@lamware/powertools-logger';
import type { APIGatewayProxyHandlerV2 } from 'aws-lambda';
import { doNotWait } from '@lamware/do-not-wait';
import { appconfig } from '@lamware/appconfig';
import { sentry } from '@lamware/sentry';
import { warmer } from '@lamware/warmer';
import { lamware } from '@lamware/core';
const { handler } = lamware>()
.use(doNotWait())
.use(powertoolsTracing({
serviceName: 'lamware-example',
}))
.use(powertoolsLogger({
serviceName: 'lamware-example',
logLevel: 'DEBUG',
}))
.use(appconfig<{ hello: string }>({
app: 'evilkiwi-lamware-example',
env: 'production',
config: 'production',
}))
.use(sentry({
config: {
dsn: 'https://d99b0b438475869385706e70157c5e05@o1080839.ingest.sentry.io/6270000',
},
}))
.use(warmer())
.execute(async ({ state }) => {
return {
statusCode: 200,
body: JSON.stringify({
hello: 'world',
appconfig: state.config,
}),
};
});
export { handler };
```