feat(adaptor): Enhance AWS Lambda Event Handling and Interface

[watany-dev]

fixed #1620

To provide full access to the Event, which is the input for AWS Lambda, the following modifications have been made:

1. Review of the Event

• Confirmed that having API Gateway versions 1.0 and 2.0 is sufficient after reviewing the specifications. The official documentation states that the Event for the traditional Lambda URL is same to version 2.0.

  • APIgw event
  • Lambda URL event

• Added missing properties in the Event Interface.

• Renamed the externally exported LambdaFunctionUrlRequestContext to ApiGatewayRequestContextV2 for name alignment with Event.

  • This is a breaking change, so concurrently using the old name's copied Type for a certain period might be beneficial.

2. Access to the Event

• Defined as export type LambdaEvent = APIGatewayProxyEvent | APIGatewayProxyEventV2 and exported in the index.
  • Allows users to specify using Bindings.

3. Discontinuation of requestContext (Not Yet Implemented)

• Currently obtained as follows, which is cumbersome as it requires users to choose between v1 and v2 for the request context.

import { Hono } from 'hono'
import type { ApiGatewayRequestContext } from 'hono/aws-lambda'
import { handle } from 'hono/aws-lambda'

type Bindings = {
  requestContext: ApiGatewayRequestContext 
}

const app = new Hono<{ Bindings: Bindings }>()

app.get('/custom-context/', (c) => {
  const lambdaContext = c.env.requestContext
  return c.json(lambdaContext)
})

export const handler = handle(app)

With access to the event now available, this can be rewritten simply. Also, the internal unnecessary logic getRequestContext(event) can be removed.

import { Hono } from 'hono'
// import type { ApiGatewayRequestContext } from 'hono/aws-lambda'
import type { LambdaEvent } from 'hono/aws-lambda'
import { handle } from 'hono/aws-lambda'

type Bindings = {
  event: LambdaEvent 
//   requestContext: ApiGatewayRequestContext 
}

const app = new Hono<{ Bindings: Bindings }>()

app.get('/custom-context/', (c) => {
//   const lambdaContext = c.env.requestContext
  const lambdaContext = c.env.event.requestContext
  return c.json(lambdaContext)
})

export const handler = handle(app)

If the removal of requestContext is approved, a comment like "Remove in Hono V4" can be added.

Author should do the followings, if applicable

• Add tests
• Run tests
• yarn denoify to generate files for Deno

[yusukebe]

Hi @watany-dev

I'll review this later. It will be merged into a "next" branch because this will be new feature.

[yusukebe]

Hi @watany-dev !

Could you fix the conflict? After fixing it, I'll merge this into a "next" branch for the v3.11.0.

[watany-dev]

@yusukebe
Thanks. I fixed it.

[yusukebe]

@watany-dev

Sorry, one thing.

This is a breaking change, so concurrently using the old name's copied Type for a certain period might be beneficial.

I think we should do that. Let's make LambdaFunctionUrlRequestContext available and mark it as deprecated.

[watany-dev]

@yusukebe
Yes, I was able to indicate the deprecation to the user.

[watany-dev]

After fully supporting the API Gateway V1 event, we found that the traditional support for ALB was no longer possible. Therefore, we have defined a new schema.

[yusukebe]

Hi @watany-dev

Sorry for the late reply. I am sick in bed right now. Will review when I'm better. Thanks.

[yusukebe]

LGTM!

[yusukebe]

@watany-dev

I'm back. This great! Let's go with it.

[yusukebe]

Hi @watany-dev

I'll release the new version v3.11.0 soon. If there are any descriptions on the website that need updating, could you please create a PR for them?

[watany-dev]

@yusukebe
OK! I wrote this Update
honojs/website#172

[yusukebe]

@watany-dev

Thanks!