Bug: APIGatewayAuthorizerResponse cannot be used for Websocket $connect

[deuscapturus]

Expected Behaviour

the allow_route() and allow_all_routes() methods in APIGatewayAuthorizerResponse do not create a valid policy statement for a Websocket connection. These methods should work with websocket connections or some other Response class should be created for websocket responses.

Current Behaviour

Using this class to authorize a websocket connection with allow methods will always result in 403 Unauthorized

Code snippet

@event_source(data_class=APIGatewayAuthorizerRequestEvent)
def handler(event: APIGatewayAuthorizerRequestEvent, context: LambdaContext) -> dict:

    response = APIGatewayAuthorizerResponse(
        aws_account_id=event.parsed_arn.aws_account_id,
        api_id=event.parsed_arn.api_id,
        stage=event.parsed_arn.stage,
        region=event.parsed_arn.region,
        principal_id='ws-tut-user',
        context={"principalId": "ws-tut-user"},
        partition=event.parsed_arn.partition,
    )
   response.allow_all_routes()
   return response.asdict()

Results in resource ['arn:aws:execute-api:us-east-1:1234567891:111aaa222b/prod/*/*'] which doesn't match arn:aws:execute-api:us-east-1:1234567891:111aaa222b/prod/$connect and results in a 403 error.

Possible Solution

WORKAROUND

response._allow_routes.append({"resourceArn": event.method_arn})

Steps to Reproduce

_

Powertools for AWS Lambda (Python) version

3.4.0

AWS Lambda function runtime

3.12

Packaging format used

PyPi

Debugging logs

[boring-cyborg]

Thanks for opening your first issue here! We'll come back to you as soon as we can.
In the meantime, check out the #python channel on our Powertools for AWS Lambda Discord: Invite link

[leandrodamascena]

Hi @deuscapturus! Thanks for opening this issue.

Let me check the code to see what's going on, but based on your investigation, I see that the /prod/*/* route will not match /prod/$connect and so it will fail.

[leandrodamascena]

Hi @deuscapturus! We are working on this PR #6058 to add the new class APIGatewayAuthorizerResponseWebSocket to handle specifics of WebSocket events and solve the issue of when authorizing or denying routes.

I hope to have this available in the next release, which is expected on 11/02/2025.

[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.

[github-actions]

This is now released under 3.6.0 version!