Validation-Inconsistency on REST-API

[dschro-1993]

Expected Behaviour

Hey Guys, when I create a BaseModel like this

class Foo(BaseModel):
  AccountId: str = Field(pattern=r"^\d{12}$")

And create an Instance of it like this:

foo = Foo(AccountId="12345678901a")

you will see the following exception:

...should match pattern '^\d{12}$' [type=pattern_mismatch, input_value='12345678901a', input_type=str]

If I let the APIGatewayRestResolver do the validation implicitly:

api = event_handler.APIGatewayRestResolver(
  enable_validation = True
)

And pass a payload to the endpoint like:

{"AccountId": "12345678901a"}

it is accepted/valid...do you know why that is?
When min_length and max_length is used for validation only, I see the expected behaviour...
But pattern seems to be skipped/iqnored when validation is done implicitly.
Any help is appreciated.

Current Behaviour

APIGatewayRestResolver should return same Exception and 422 when payload does not match pattern.

Code snippet

see above

Possible Solution

No response

Steps to Reproduce

see above

Powertools for AWS Lambda (Python) version

latest

AWS Lambda function runtime

3.12

Debugging logs

No response

[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

[rubenfonseca]

Hi @dschro-1993 can you show me your api handler code that uses Foo?

[dschro-1993]

Handler:

from aws_lambda_powertools import event_handler

# ...router-imports...

api = event_handler.APIGatewayRestResolver(
  enable_validation = True
)

api.include_router(...)

def entrypoint(request: dict, context: dict) -> dict:
  return api.resolve(
    request,
    context,
  )

Router:

from aws_lambda_powertools.event_handler.api_gateway import Router

from models import Foo

router = Router()

@router.post("/foo")
def create(foo: Foo) -> dict:
  """Foo Create-Request"""
  # ...

Model:

class Foo(BaseModel):
  AccountId: str = Field(pattern=r"^\d{12}$")

[rubenfonseca]

Can you please tell me which Pydantic version are you using?

I've just deployed this code for a test:

from aws_lambda_powertools import Logger
from aws_lambda_powertools.event_handler import (
    APIGatewayRestResolver,
)
from aws_lambda_powertools.event_handler.api_gateway import Router
from pydantic import Field, BaseModel

logger = Logger()


class Foo(BaseModel):
    AccountId: str = Field(pattern=r"^\d{12}$")


router = Router()


@router.post(
    "/foo",
)
def helloworld(foo: Foo) -> dict:
    logger.info("Hello, World!", foo=foo)
    return {"accountId": foo.AccountId}


app = APIGatewayRestResolver(enable_validation=True)
app.include_router(router)


@logger.inject_lambda_context
def lambda_handler(event, context):
    return app.resolve(event, context)

A request with a wrong body failed:

But a request with a good body succeeded:

[dschro-1993]

I use the Powertools lambda layer arm64 in its latest version:
https://docs.powertools.aws.dev/lambda/python/latest/#lambda-layer

# ...
resource "aws_lambda_function" "foo" {
  #...
  layers = [
    "arn:aws:lambda:${data.aws_region.current.name}:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:68"
  ]
}

[dschro-1993]

Oh damn, that layer is built upon Pydantic v1, correct? So I would have to bundle v2 on my own if I want to see v2 behaviour in my lambda?

[rubenfonseca]

Let me try locally with v1 first to understand if this is the cause of problem

[rubenfonseca]

Got it, with Pydantic v1 you have to use regex instead of pattern! Just tested it and it works :D

We have an issue collecting interest for a managed Layer that includes Pydantic v2. Can you add your +1 there?

If this solves your problem, let me know if we can close this issue :)