Event Handler: API Gateway current_event doesn't show all properties

[heitorlessa]

When trying to access request_context when using either API Gateway v1 or v2 we can't have type hinting due to ALB being different - both inherit from BaseProxyEvent.

Overloading the internal method _to_proxy_event with all potential returns, even with Literal[ProxyEventType.APIGatewayProxyEvent] didn't seem to yield any result, as MyPy and Intelisense continues to think it's a BaseProxyEvent.

Need a deeper understanding of MyPy and type invariants to potentially solve this.

from aws_lambda_powertools.event_handler.api_gateway import ApiGatewayResolver

app = ApiGatewayResolver()


@app.get("/test")
def test_it():
	# this should autocomplete when not using ALB as the ProxyType argument in ApiGatewayResolver
	app.current_event.request_context.identity.account_id 
    ...


def handler(event, context):
    app.resolve(event, context)


app({}, None)

[heitorlessa]

Forgot the instance variable had an explicit type of BaseProxyEvent hence why overloading didn't potentially work... shall try again at some point -- current_event: BaseProxyEvent

[michaelbrewer]

@heitorlessa any suggestions on how to implement this on Python? I am not sure how generics would work on Python.

Another option would be to add properties that cast to the preferred type app.current_alb_event, app.current_rest_event and app.current_http_event?

[heitorlessa]

Because we have a parameter that indicates which Proxy Type to use, we can use function overloading from typing to indicate the return type will be different based on the params received.

I'm considering to have an entire release just focused on MyPy stuff as more and more customers are raising issues on typing that could've been prevented, then enable MyPy at CI level -- it's a good thing, we just need a focused release or else other higher priorities will take place.

After the next release I'll write a plan for this on all areas we need. MyPy and Integ test for runtime botocore are my top concerns now

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[heitorlessa]

Dumping it here for posterity.

None of the techniques I tried worked due to being late-bound: Dynamically inject properties, Create BaseProxyEvent at runtime, Use generic to propagate, etc.

The closest I've got working is using an Union of all Proxy Event types -- auto-completion works as expected, but it shows attributes that might not be there leading to an AttributeError.

Late bound issue

As the class variable defines the type upfront, static analysis cannot evaluate what is the correct event as it's only resolved when a request is received:

class BaseRouter(ABC):
    current_event: ProxyEventTypes  # Union[APIGatewayProxyEvent, APIGatewayProxyEventV2, ALBEvent]
    lambda_context: LambdaContext
    ...

from aws_lambda_powertools.event_handler.api_gateway import ApiGatewayResolver
from aws_lambda_powertools.utilities.data_classes.api_gateway_proxy_event import APIGatewayProxyEvent

app = ApiGatewayResolver()

@app.get
def hello():
    request: APIGatewayProxyEvent = app.current_event  # explicit type annotation works
    request = app.current_event.route_key  # leads to an AttributeError despite auto-completion as it's a API GW V1 event
    return request.get_header_value(name="X-Id", default_value="Blah")

Next steps

Three potential solutions in my head now:

1. Create a separate class for each type of event, update the docs (ApiGatewayV1Resolver, etc.)
2. Refactor the class instance that was created as part of Router's implementation, use a proper attribute or property w/ setter, so we can propagate the type correctly. Reason: Doesn't solve the late-bound issue.
3. Keep Union type, explicitly call out in the docs that it's best to use type annotation to have precise types -- Cons: Potential AttributeError and possibly methods that might not exist (need to check) Reason: Too easy to get it wrong, catching every AttributeError can decrease performance too.

cc @cakepietoast @mploski as I need some brainstorming.