+ CloudFormation Custom Response event response handling for the middy framework, the stylish Node.js middleware engine for AWS Lambda
+
+
+ 
+
+
+
+
+
+
+
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+
+
+
+
+ 
+
+
+ 
You can read the documentation at: https://middy.js.org/docs/middleware/cloudformation-response
+
+
diff --git a/packages/cloudformation-response/__benchmarks__/index.js b/packages/cloudformation-response/__benchmarks__/index.js
new file mode 100644
index 000000000..42c8ee848
--- /dev/null
+++ b/packages/cloudformation-response/__benchmarks__/index.js
@@ -0,0 +1,27 @@
+import { Bench } from 'tinybench'
+import middy from '../../core/index.js'
+import middleware from '../index.js'
+
+const bench = new Bench({ time: 1_000 })
+
+const context = {
+ getRemainingTimeInMillis: () => 30000
+}
+const setupHandler = () => {
+ const baseHandler = () => {}
+ return middy(baseHandler).use(middleware())
+}
+
+const coldHandler = setupHandler()
+
+const event = {}
+await bench
+ .add('without cache', async () => {
+ try {
+ await coldHandler(event, context)
+ } catch (e) {}
+ })
+
+ .run()
+
+console.table(bench.table())
diff --git a/packages/cloudformation-response/__tests__/fuzz.js b/packages/cloudformation-response/__tests__/fuzz.js
new file mode 100644
index 000000000..b39db8e3c
--- /dev/null
+++ b/packages/cloudformation-response/__tests__/fuzz.js
@@ -0,0 +1,23 @@
+import { test } from 'node:test'
+import fc from 'fast-check'
+import middy from '../../core/index.js'
+import middleware from '../index.js'
+
+const handler = middy((event) => event).use(middleware())
+const context = {
+ getRemainingTimeInMillis: () => 1000
+}
+
+test('fuzz `event` w/ `object`', async () => {
+ fc.assert(
+ fc.asyncProperty(fc.object(), async (event) => {
+ await handler(event, context)
+ }),
+ {
+ numRuns: 100_000,
+ verbose: 2,
+
+ examples: []
+ }
+ )
+})
diff --git a/packages/cloudformation-response/__tests__/index.js b/packages/cloudformation-response/__tests__/index.js
new file mode 100644
index 000000000..d91de9526
--- /dev/null
+++ b/packages/cloudformation-response/__tests__/index.js
@@ -0,0 +1,88 @@
+import { test } from 'node:test'
+import { deepEqual } from 'node:assert/strict'
+
+import middy from '../../core/index.js'
+
+import cloudformationResponse from '../index.js'
+
+const defaultEvent = {
+ RequestType: 'Create',
+ RequestId: 'RequestId',
+ LogicalResourceId: 'LogicalResourceId',
+ StackId: 'StackId'
+}
+const context = {
+ getRemainingTimeInMillis: () => 1000
+}
+
+test('It should return SUCCESS when empty response', async (t) => {
+ const handler = middy((event, context) => {})
+
+ handler.use(cloudformationResponse())
+
+ const event = defaultEvent
+ const response = await handler(event, context)
+ deepEqual(response, {
+ Status: 'SUCCESS',
+ RequestId: 'RequestId',
+ LogicalResourceId: 'LogicalResourceId',
+ StackId: 'StackId'
+ })
+})
+
+test('It should return SUCCESS when empty object', async (t) => {
+ const handler = middy((event, context) => {
+ return {}
+ })
+
+ handler.use(cloudformationResponse())
+
+ const event = defaultEvent
+ const response = await handler(event, context)
+ deepEqual(response, {
+ Status: 'SUCCESS',
+ RequestId: 'RequestId',
+ LogicalResourceId: 'LogicalResourceId',
+ StackId: 'StackId'
+ })
+})
+
+test('It should return FAILURE when error thrown', async (t) => {
+ const handler = middy((event, context) => {
+ throw new Error('Internal Error')
+ })
+
+ handler.use(cloudformationResponse())
+
+ const event = defaultEvent
+ const response = await handler(event, context)
+ deepEqual(response, {
+ Status: 'FAILED',
+ Reason: 'Internal Error',
+ RequestId: 'RequestId',
+ LogicalResourceId: 'LogicalResourceId',
+ StackId: 'StackId'
+ })
+})
+
+test('It should not override response values', async (t) => {
+ const handler = middy((event, context) => {
+ return {
+ Status: 'FAILED',
+ RequestId: 'RequestId*',
+ LogicalResourceId: 'LogicalResourceId*',
+ StackId: 'StackId*'
+ }
+ })
+
+ handler.use(cloudformationResponse())
+
+ const event = defaultEvent
+ const response = await handler(event, context)
+ deepEqual(response, {
+ Status: 'FAILED',
+ RequestId: 'RequestId*',
+ LogicalResourceId: 'LogicalResourceId*',
+ StackId: 'StackId*'
+ })
+})
diff --git a/packages/cloudformation-response/index.d.ts b/packages/cloudformation-response/index.d.ts
new file mode 100644
index 000000000..95d6904ee
--- /dev/null
+++ b/packages/cloudformation-response/index.d.ts
@@ -0,0 +1,5 @@
+import middy from '@middy/core'
+
+declare function cloudformationResponse (): middy.MiddlewareObj
+
+export default cloudformationResponse
diff --git a/packages/cloudformation-response/index.js b/packages/cloudformation-response/index.js
new file mode 100644
index 000000000..7f6f5ca55
--- /dev/null
+++ b/packages/cloudformation-response/index.js
@@ -0,0 +1,25 @@
+const cloudformationCustomResourceMiddleware = () => {
+ const cloudformationCustomResourceMiddlewareAfter = (request) => {
+ let { response } = request
+ response ??= {}
+ response.Status ??= 'SUCCESS'
+ response.RequestId ??= request.event.RequestId
+ response.LogicalResourceId ??= request.event.LogicalResourceId
+ response.StackId ??= request.event.StackId
+ request.response = response
+ }
+ const cloudformationCustomResourceMiddlewareOnError = (request) => {
+ const response = {
+ Status: 'FAILED',
+ Reason: request.error.message
+ }
+ request.response = response
+ cloudformationCustomResourceMiddlewareAfter(request)
+ }
+ return {
+ after: cloudformationCustomResourceMiddlewareAfter,
+ onError: cloudformationCustomResourceMiddlewareOnError
+ }
+}
+
+export default cloudformationCustomResourceMiddleware
diff --git a/packages/cloudformation-response/index.test-d.ts b/packages/cloudformation-response/index.test-d.ts
new file mode 100644
index 000000000..b9d16f8af
--- /dev/null
+++ b/packages/cloudformation-response/index.test-d.ts
@@ -0,0 +1,8 @@
+import { expectType } from 'tsd'
+import middy from '@middy/core'
+
+import cloudformationResponse from '.'
+
+// use with default options
+const middleware = cloudformationResponse()
+expectType
+ CloudFormation Custom Response router for the middy framework, the stylish Node.js middleware engine for AWS Lambda
+
+
+ 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
You can read the documentation at: https://middy.js.org/docs/routers/cloudformation-router
+
+
diff --git a/packages/cloudformation-router/__benchmarks__/index.js b/packages/cloudformation-router/__benchmarks__/index.js
new file mode 100644
index 000000000..42c8ee848
--- /dev/null
+++ b/packages/cloudformation-router/__benchmarks__/index.js
@@ -0,0 +1,27 @@
+import { Bench } from 'tinybench'
+import middy from '../../core/index.js'
+import middleware from '../index.js'
+
+const bench = new Bench({ time: 1_000 })
+
+const context = {
+ getRemainingTimeInMillis: () => 30000
+}
+const setupHandler = () => {
+ const baseHandler = () => {}
+ return middy(baseHandler).use(middleware())
+}
+
+const coldHandler = setupHandler()
+
+const event = {}
+await bench
+ .add('without cache', async () => {
+ try {
+ await coldHandler(event, context)
+ } catch (e) {}
+ })
+
+ .run()
+
+console.table(bench.table())
diff --git a/packages/cloudformation-router/__tests__/fuzz.js b/packages/cloudformation-router/__tests__/fuzz.js
new file mode 100644
index 000000000..fc1f4b07e
--- /dev/null
+++ b/packages/cloudformation-router/__tests__/fuzz.js
@@ -0,0 +1,56 @@
+import { test } from 'node:test'
+import fc from 'fast-check'
+import middy from '../../core/index.js'
+import router from '../index.js'
+
+const handler = middy(router())
+const context = {
+ getRemainingTimeInMillis: () => 1000
+}
+
+test('fuzz `event` w/ `object`', async () => {
+ fc.assert(
+ fc.asyncProperty(fc.object(), async (event) => {
+ try {
+ await handler(event, context)
+ } catch (e) {
+ if (e.cause?.package !== '@middy/cloudformation-router') {
+ throw e
+ }
+ }
+ }),
+ {
+ numRuns: 100_000,
+ verbose: 2,
+
+ examples: []
+ }
+ )
+})
+
+test('fuzz `event` w/ `record`', async () => {
+ fc.assert(
+ fc.asyncProperty(
+ fc.record({
+ RequestType: fc.string(),
+ RequestId: fc.string(),
+ LogicalResourceId: fc.string(),
+ StackId: fc.string()
+ }),
+ async (event) => {
+ try {
+ await handler(event, context)
+ } catch (e) {
+ if (e.cause?.package !== '@middy/cloudformation-router') {
+ throw e
+ }
+ }
+ }
+ ),
+ {
+ numRuns: 100_000,
+ verbose: 2,
+ examples: [[{ requestContext: { routeKey: 'valueOf' } }]]
+ }
+ )
+})
diff --git a/packages/cloudformation-router/__tests__/index.js b/packages/cloudformation-router/__tests__/index.js
new file mode 100644
index 000000000..4af8adfd2
--- /dev/null
+++ b/packages/cloudformation-router/__tests__/index.js
@@ -0,0 +1,117 @@
+import { test } from 'node:test'
+import { ok, equal } from 'node:assert/strict'
+import middy from '../../core/index.js'
+import cloudformationRouter from '../index.js'
+
+// const event = {}
+const context = {
+ getRemainingTimeInMillis: () => 1000
+}
+
+// Types of routes
+test('It should route to a static route', async (t) => {
+ const event = {
+ RequestType: 'Create'
+ }
+ const handler = cloudformationRouter([
+ {
+ requestType: 'Create',
+ handler: () => true
+ }
+ ])
+ const response = await handler(event, context)
+ ok(response)
+})
+
+test('It should thrown FAILURE when route not found', async (t) => {
+ const event = {
+ RequestType: 'Update'
+ }
+ const handler = cloudformationRouter([
+ {
+ requestType: 'Create',
+ handler: () => true
+ }
+ ])
+ try {
+ await handler(event, context)
+ } catch (e) {
+ equal(e.message, 'Route does not exist')
+ }
+})
+
+test('It should thrown FAILURE when route not found, using notFoundResponse', async (t) => {
+ const event = {
+ RequestType: 'Update'
+ }
+ const handler = cloudformationRouter({
+ routes: [
+ {
+ requestType: 'Create',
+ handler: () => true
+ }
+ ],
+ notFoundResponse: (args) => {
+ return {
+ Status: 'SUCCESS'
+ }
+ }
+ })
+ const res = await handler(event, context)
+
+ equal(res.Status, 'SUCCESS')
+})
+
+// with middleware
+test('It should run middleware that are part of route handler', async (t) => {
+ const event = {
+ RequestType: 'Create'
+ }
+ const handler = cloudformationRouter([
+ {
+ requestType: 'Create',
+ handler: middy(() => false).after((request) => {
+ request.response = true
+ })
+ }
+ ])
+ const response = await handler(event, context)
+ ok(response)
+})
+
+test('It should middleware part of router', async (t) => {
+ const event = {
+ RequestType: 'Create'
+ }
+ const handler = middy(
+ cloudformationRouter([
+ {
+ requestType: 'Create',
+ handler: () => false
+ }
+ ])
+ ).after((request) => {
+ request.response = true
+ })
+ const response = await handler(event, context)
+ ok(response)
+})
+
+// Errors
+
+test('It should throw when not a cloudformation event', async (t) => {
+ const event = {
+ path: '/'
+ }
+ const handler = cloudformationRouter([
+ {
+ requestType: 'Create',
+ handler: () => true
+ }
+ ])
+ try {
+ await handler(event, context)
+ } catch (e) {
+ equal(e.message, 'Unknown CloudFormation Custom Response event format')
+ }
+})
diff --git a/packages/cloudformation-router/index.d.ts b/packages/cloudformation-router/index.d.ts
new file mode 100644
index 000000000..84bf5af25
--- /dev/null
+++ b/packages/cloudformation-router/index.d.ts
@@ -0,0 +1,13 @@
+import middy from '@middy/core'
+import { CloudFormationCustomResourceHandler } from 'aws-lambda'
+
+interface Route