Feature request: Export APIGatewayEventRequestContext schema

[martinnj-adsk]

Use case

If you have a custom authorizer lambda that adds context to an API Gateway Event, the event won't be valid if using APIGatewayProxyEventSchema, as the authorizer key is now invalid. Exporting the schema will allow me to extend it, and then define my authorizer context manually.

Solution/User Experience

Export APIGatewayEventRequestContext schema.

Powertools for AWS Lambda (TypeScript) version

2.10.0

AWS Lambda function runtime

20.x

Alternative solutions

Acknowledgment

• This feature request meets Powertools for AWS Lambda (TypeScript) Tenets
• Should this be considered in other Powertools for AWS Lambda languages? i.e. Python, Java, and .NET

Future readers

Please react with 👍 and your use case to help us understand customer demand.

[dreamorosi]

Hi @martinnj-adsk, apologies for the delay.

I have tried to reproduce the behavior you described and I am not able to make the validation fail even when adding context.

I have two functions, one authorizer:

export const handler = async (event) => {
  return {
    principalId: 'user',
    policyDocument: {
      Version: '2012-10-17',
      Statement: [
        {
          Action: 'execute-api:Invoke',
          Effect: 'Allow',
          Resource: event.methodArn,
        },
      ],
    },
    context: {
      foo: 'bar',
    },
  }
}

and an API:

import { APIGatewayProxyEventSchema } from '@aws-lambda-powertools/parser/schemas/api-gateway';

export const handler = async (event) => {
  try {
    const parsed = APIGatewayProxyEventSchema.parse(event);

    console.log(parsed.requestContext.authorizer);

    return {
      statusCode: 200,
    }
  } catch (error) {
    console.error(error);
    return {
      statusCode: 400,
      body: JSON.stringify({
        message: 'Invalid request',
      }),
    };
  }
}

When making a request, the parsing in the API function passes and the log looks like this:

{ principalId: 'user', integrationLatency: 0, foo: 'bar' }

This is because the schemas are not set to .strict().

With that said, I agree that we should export the APIGatewayEventRequestContext so that you can extend the schema and actually type the requestContext.authorizer object with your own context keys.

[github-actions]

⚠️ COMMENT VISIBILITY WARNING ⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.