Papercuts we're currently prioritizing

[whardier]

Need to add proper ContextManager typing via typing.ContrxtManager in several places.

Currently overriding single_metric (-> ContextManager[SingleMetric]) and noticed several other areas where this needs done as well.

Also be nice if there was a proper DummySubSegment type returned for tracing provider.in_subsegment to avoid including types from aws modules to cast.

Expected Behavior

Have rich type annotations along for the ride when using context managers.

Current Behavior

Need to self annotate.

Possible Solution

Add in proper type annotation to some or all of the context manager decorated functions.

[heitorlessa]

Thanks a lot for raising this @whardier ! I was about to create a list of papercuts we'd like to address, these being two of them.

The SubSegment typing is the most elaborate one, I need one full day to create and refactor a few things, including having an easy way to unit test your application with a Fake Tracer Provider.

[heitorlessa]

When you have a moment, could you help us by enumerating some of them like the SingleMetric ctx manager?

I'm gonna rename this to top papercuts so we can tackle them accordingly as many as possible

[heitorlessa]

List of papercuts we're currently prioritizing based on their impact

High impact

• Docs: Integrate API ref docs and make it easier to search for exceptions
• Docs: Change Testing your code docs section to reflect how customers would have to test their code (Batch and Event Handler being good examples to follow)
• Docs: Create an Unit Test section to bring together how to test the various tools we provide to ease discoverability
• Quickstart template: Update template to provide a monolithic and micro-function deployment option following the new Router feature
• End-to-end tests: Create stack and mechanism to run e2e tests on merge
  • This will give us confidence we can remove boto3 (>90% of package size) for Lambda Layers/SAR App

Medium impact

• Feature: Expose Lambda Env Vars to prevent additional hops to the documentation
• Docs: Test Powertools as-is in ARM arch, and document it
  • Dependency on SAM CLI issue being merged and released
• Logger: Provide autocomplete custom date formats (ISO8601) for datefmt field

Low impact

• Tracer: Typing SubSegment and Context Manager
• Tracer: Expose a context manager to trace a block of code instead of suggesting an escape hatch

Maintenance impact

Non-customer facing but that needs to be addressed at some point

• Batch: Improve maintainability of batch processing functional tests (it should be easier to create tests)
• Idempotency: Consider refactoring test setup, potentially DynamoDB Local for functional (not integration)

Completed

• Docs: API Gateway sample layout
• Parser: Typing on model subclassing
• Parser: Typing when using envelope
• Event Handler: BaseProxyEvent missing overload to match Proxy Type Request Context
• Tracer: Typing provider when none is passed
• Metrics: Typing SingleMetric context manager
• Tracer: Add method to ignore certain hostname/URLs to be traced
• Docs: Update public Slack invite with new link as the previous one expired
• Event Handler: Do not throw exception if json_body doesn't have JSON but return None
• MyPy: Address all MyPy errors and enable MyPy at CI level

[elliottyates]

A thought: it took me a few moments and tries to get unit testing working for some features (e.g. #706). One suggestion might be a dedicated area of the docs for unit testing, instead of hunting down the solutions for each feature.

[michaelbrewer]

Another one :)

• chore(deps): support arm64 when developing locally #862

[michaelbrewer]

Docs PR:

• docs(apigateway): fix sample layout provided #864

[whardier]

single_metric PR:

• fix(metrics): explicit type to single_metric ctx manager #865

[michaelbrewer]

yet another one that @heitorlessa found:

• fix(event-sources): Pass authorizer data to APIGatewayEventAuthorizer #897

[heitorlessa]

Need to create an issue for it

Another one: Idempotency doesn't support serialization of data classes - both input (idempotency key) and return... it could be easily solved by inspecting if it's a dataclass, then using asdict(). asdict() is infamous for having a performance hit on deeply nested dataclasses, so we'll need to mention in the docs.

[heitorlessa]

• Internal papercut: Improve maintainability of batch processing functional tests (it should be easier to create tests)
• Internal papercut: Improve maintainability of Idempotency functional tests

[michaelbrewer]

We could already fixes, but definitely fits into this theme:

• fix(idempotency): include decorated fn name in hash #869

[michaelbrewer]

Another one: Idempotency doesn't support serialization of data classes - both input (idempotency key) and return... it could be easily solved by inspecting if it's a dataclass, then using asdict(). asdict() is infamous for having a performance hit on deeply nested dataclasses, so we'll need to mention in the docs.

@heitorlessa see

• feat(idempotency): support dataclasses & pydantic models payloads #908

[michaelbrewer]

@heitorlessa - these 2 are ready to be reviewed and merged

• feat(tracer): ignore tracing for certain hostname(s) or url(s) #910
• feat(idempotency): support dataclasses & pydantic models payloads #908

[michaelbrewer]

Sorry @heitorlessa a papercut fix caused another paper cut :P

• fix(apigateway): support @app.not_found() syntax & housekeeping #926

[michaelbrewer]

Some typos and code clean up for data classes:

• - fix(data-classes): docstring typos and clean up #937

[heitorlessa]

I'm locking this issue and will split them up into individual issues. We've accidentally got sidetracked in not tackling the actual top papercuts and started addressing new ones.

[heitorlessa]

Resolving in favour of #1009 so we can keep it clean