bug: Nested Pydantic model are not included in AsyncAPI components/schemas (inplaced instead)

[legau]

Describe the bug
With AsyncAPI 3.0, when registering multiple handlers on the same publishers with some of the return types having nested Pydantic models inside them, these nested models are not defined correctly in the AsyncAPI spec resulting in an invalid state (the model referenced does not exist)

How to reproduce
Include source code:

class User(pydantic.BaseModel):
    class Email(pydantic.BaseModel):
        email: str

    email: Email
    name: str = ""
    id: int
    

broker = self.broker_class()

publisher = broker.publisher("test")

@publisher
def handle0(msg) -> User:
    ...


class Other(pydantic.BaseModel):
    id: int

@publisher
def handle1(msg) -> Other:
    ...

schema = self.get_spec(broker).to_jsonable()

payload = schema["components"]["schemas"]

assert "User" in payload
assert "Other" in payload

assert "Email" in payload # <-- Assert fails

Expected behavior
The AsyncAPI schema should be valid.

Environment
main branch / 0.6.0rc0

Additional context
I will try to find a workaround/bugfix for now

[Niccolum]

But why model inside model... Just use link without closure

[legau]

It is not the "closure" that makes it fail,

class Email(pydantic.BaseModel):
    email: str
class User(pydantic.BaseModel):
    email: Email
    name: str = ""
    id: int

also doesn't work.
Anyway this should work in any case, enclosed submodels are valid expressions

[Lancetnik]

@legau it doesn't look like a bug: Email model is just in-placed to User

{'schemas': {'Other': {'properties': {'id': {'title': 'Id',
                                                            'type': 'integer'}},
                                      'required': ['id'],
                                      'title': 'Other',
                                      'type': 'object'},
                            'User': {'$defs': {'Email': {'properties': {'email': {'title': 'Email',
                                                                                  'type': 'string'}},
                                                         'required': ['email'],
                                                         'title': 'Email',
                                                         'type': 'object'}},
                                     'properties': {'email': {'$ref': '#/components/schemas/Email'},
                                                    'id': {'title': 'Id',
                                                           'type': 'integer'},
                                                    'name': {'default': '',
                                                             'title': 'Name',
                                                             'type': 'string'}},
                                     'required': ['email', 'id'],
                                     'title': 'User',
                                     'type': 'object'}}},}

So, it looks more like improvement - to move out nested model to schemas: {} block

[legau]

Well the resulting schema is invalid and it doesn't behave the same in single or oneof sitation so it feels like a bug.

I have made a workaround if I just move all the $defs into the schemas block but I guess it's not a great way to do it. I don't see tests failing with this though, is there a case I could test against to only impact the nested Pydantic models ?

[Lancetnik]

I have made a workaround if I just move all the $defs into the schemas block but I guess it's not a great way to do it. I don't see tests failing with this though, is there a case I could test against to only impact the nested Pydantic models ?

Indeed, we used such behavior in 0.5.*, but looks like we lost in ion 0.6.0. I thought, that we have corresponding tests for such cases. Please, open a PR with your fix to discuss the problem closer

[Lancetnik]

Looks like these tests https://github.com/search?q=repo%3Aag2ai%2Ffaststream%20test_pydantic_model_mixed_regular&type=code should validate such behavior