fix: Fix issue with strip_prefixes

[BVMiko]

Issue #, if available: #646

Description of changes:

After removing path prefixes, allow an empty path to return "/" so that it will match a normal routing rule.

Checklist

• Meet tenets criteria
• Update tests
• Update docs
• PR title follows conventional commit semantics

Breaking change checklist

RFC issue #:

• Migration process documented
• Implement warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

[michaelbrewer]

@BVMiko - Nice catch!

Could you add a test case? Something like:

def test_api_gateway_request_path_equals_strip_prefix():
    # GIVEN a strip_prefix matches the request path
    app = ApiGatewayResolver(strip_prefixes=["/foo"])
    event = {"httpMethod": "GET", "path": "/foo"}

    @app.get("/")
    def base():
        return {}

    # WHEN calling the event handler
    # WITH a route "/"
    result = app(event, {})

    # THEN process event correctly
    assert result["statusCode"] == 200
    assert result["headers"]["Content-Type"] == content_types.APPLICATION_JSON

Regarding for the fix, i guess it could also default to "" over "/", but i would defer that to @heitorlessa

[michaelbrewer]

@BVMiko - FYI, Heitor will be about for 5 weeks. How critical would a fix for this be?

[BVMiko]

For now I have a workaround in place which can remain until this issue is resolved:

app = ApiGatewayResolver(strip_prefixes=["/foo"])

@app.get("/")
def base():
    return {}

def lambda_handler(event, context):
    if event['path'] == '/foo':
        event['path'] = '/foo/'
    return app.resolve(event, context)

[codecov-commenter]

Codecov Report

Merging #647 (a8857e0) into develop (c8cf3ba) will decrease coverage by 0.04%.
The diff coverage is 0.00%.

@@             Coverage Diff             @@
##           develop     #647      +/-   ##
===========================================
- Coverage    99.97%   99.93%   -0.05%     
===========================================
  Files          116      116              
  Lines         4846     4821      -25     
  Branches       265      266       +1     
===========================================
- Hits          4845     4818      -27     
- Misses           0        1       +1     
- Partials         1        2       +1     

Impacted Files	Coverage Δ
aws_lambda_powertools/event_handler/api_gateway.py	99.00% <0.00%> (-1.00%)	⬇️
aws_lambda_powertools/logging/logger.py	100.00% <0.00%> (ø)
aws_lambda_powertools/tracing/tracer.py	100.00% <0.00%> (ø)
aws_lambda_powertools/metrics/metrics.py	100.00% <0.00%> (ø)
aws_lambda_powertools/logging/formatter.py	100.00% <0.00%> (ø)
aws_lambda_powertools/utilities/batch/base.py	100.00% <0.00%> (ø)
aws_lambda_powertools/shared/jmespath_utils.py	100.00% <0.00%> (ø)
...ws_lambda_powertools/middleware_factory/factory.py	100.00% <0.00%> (ø)
...s_lambda_powertools/utilities/parser/models/sns.py	100.00% <0.00%> (ø)
..._lambda_powertools/utilities/feature_flags/base.py	100.00% <0.00%> (ø)
... and 5 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c8cf3ba...a8857e0. Read the comment docs.

[michaelbrewer]

@BVMiko - Nice catch!

Could you add a test case? Something like:

def test_api_gateway_request_path_equals_strip_prefix():
    # GIVEN a strip_prefix matches the request path
    app = ApiGatewayResolver(strip_prefixes=["/foo"])
    event = {"httpMethod": "GET", "path": "/foo"}

    @app.get("/")
    def base():
        return {}

    # WHEN calling the event handler
    # WITH a route "/"
    result = app(event, {})

    # THEN process event correctly
    assert result["statusCode"] == 200
    assert result["headers"]["Content-Type"] == content_types.APPLICATION_JSON

Regarding for the fix, i guess it could also default to "" over "/", but i would defer that to @heitorlessa

@BVMiko - would you be able to include a test like this into the api gateway handler test suite?

[BVMiko]

@michaelbrewer: The test has been added

[michaelbrewer]

LGTM thanks @BVMiko

[boring-cyborg]

Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience!