now body is embed, add tests coverage

Author: mahenzon

fastapi_jsonapi/api.py

@@ -14,7 +14,7 @@
     Union,
 )
 
-from fastapi import APIRouter, Path, Query, Request, status
+from fastapi import APIRouter, Body, Path, Query, Request, status
 from pydantic import BaseModel as PydanticBaseModel
 
 from fastapi_jsonapi.data_typing import TypeModel
@@ -118,8 +118,18 @@ def __init__(
             schema_in_post=schema_in_post,
             schema_in_patch=schema_in_patch,
         )
+        # we need to save post_data and patch_data
+        # and set dependency `data` as `embed=True`
+        # because if there's more than one Body dependency,
+        # FastAPI makes them all `embed=True` and validation breaks!
+        # doc url
+        # https://fastapi.tiangolo.com/tutorial/body-multiple-params/#embed-a-single-body-parameter
+        # code:
+        # https://github.com/tiangolo/fastapi/blob/831b5d5402a65ee9f415670f4116522c8e874ed3/fastapi/dependencies/utils.py#L768
         self.schema_in_post = dto.schema_in_post
+        self.schema_in_post_data = dto.schema_in_post_data
         self.schema_in_patch = dto.schema_in_patch
+        self.schema_in_patch_data = dto.schema_in_patch_data
         self.detail_response_schema = dto.detail_response_schema
         self.list_response_schema = dto.list_response_schema
 
@@ -486,16 +496,21 @@ def _create_post_resource_list_view(self):
 
         :return:
         """
-        schema_in = self.schema_in_post
+        # `data` as embed Body param
+        schema_in = self.schema_in_post_data
 
-        async def wrapper(request: Request, data_create: schema_in, **extra_view_deps):
+        async def wrapper(
+            request: Request,
+            data: schema_in = Body(embed=True),
+            **extra_view_deps,
+        ):
             resource = self.list_view_resource(
                 request=request,
                 jsonapi=self,
             )
 
             response = await resource.handle_post_resource_list(
-                data_create=data_create.data,
+                data_create=data,
                 **extra_view_deps,
             )
             return response
@@ -576,11 +591,12 @@ def _create_patch_resource_detail_view(self):
 
         :return:
         """
-        schema_in = self.schema_in_patch
+        # `data` as embed Body param
+        schema_in = self.schema_in_patch_data
 
         async def wrapper(
             request: Request,
-            data_update: schema_in,
+            data: schema_in = Body(embed=True),
             obj_id: str = Path(...),
             **extra_view_deps,
         ):
@@ -592,7 +608,7 @@ async def wrapper(
             # TODO: pass obj_id as kwarg (get name from DetailView class)
             response = await resource.handle_update_resource(
                 obj_id=obj_id,
-                data_update=data_update.data,
+                data_update=data,
                 **extra_view_deps,
             )
             return response

fastapi_jsonapi/schema_builder.py

@@ -83,7 +83,9 @@ def included_schemas_list(self) -> List[Type[JSONAPIObjectSchema]]:
 @dataclass(frozen=True)
 class BuiltSchemasDTO:
     schema_in_post: Type[BaseJSONAPIDataInSchema]
+    schema_in_post_data: Type[BaseJSONAPIItemInSchema]
     schema_in_patch: Type[BaseJSONAPIDataInSchema]
+    schema_in_patch_data: Type[BaseJSONAPIItemInSchema]
     detail_response_schema: Type[JSONAPIResultDetailSchema]
     list_response_schema: Type[JSONAPIResultListSchema]
 
@@ -150,21 +152,23 @@ def create_schemas(
         if any(schema_in_patch is cmp_schema for cmp_schema in [schema, schema_in_post]):
             schema_name_in_patch_suffix = "InPatch"
 
-        schemas_in_post = self.build_schema_in(
+        schema_in_post, schema_in_post_data = self.build_schema_in(
             schema_in=schema_in_post,
             schema_name_suffix=schema_name_in_post_suffix,
             non_optional_relationships=True,
         )
 
-        schemas_in_patch = self.build_schema_in(
+        schema_in_patch, schema_in_patch_data = self.build_schema_in(
             schema_in=schema_in_patch,
             schema_name_suffix=schema_name_in_patch_suffix,
             id_field_required=True,
         )
 
         return BuiltSchemasDTO(
-            schema_in_post=schemas_in_post,
-            schema_in_patch=schemas_in_patch,
+            schema_in_post=schema_in_post,
+            schema_in_post_data=schema_in_post_data,
+            schema_in_patch=schema_in_patch,
+            schema_in_patch_data=schema_in_patch_data,
             list_response_schema=self._create_schemas_objects_list(schema),
             detail_response_schema=self._create_schemas_object_detail(schema),
         )
@@ -175,7 +179,7 @@ def build_schema_in(
         schema_name_suffix: str = "",
         non_optional_relationships: bool = False,
         id_field_required: bool = False,
-    ) -> Type[BaseJSONAPIDataInSchema]:
+    ) -> Tuple[Type[BaseJSONAPIDataInSchema], Type[BaseJSONAPIItemInSchema]]:
         base_schema_name = schema_in.__name__.removesuffix("Schema") + schema_name_suffix
 
         dto = self._get_info_from_schema_for_building(
@@ -202,7 +206,7 @@ def build_schema_in(
             __base__=BaseJSONAPIDataInSchema,
         )
 
-        return wrapped_object_jsonapi_schema
+        return wrapped_object_jsonapi_schema, object_jsonapi_schema
 
     def _build_schema(
         self,

tests/conftest.py

@@ -46,6 +46,9 @@
     workplace_1,
     workplace_2,
 )
+from tests.fixtures.user import (  # noqa
+    user_attributes,
+)
 from tests.fixtures.views import (  # noqa
     DetailViewBaseGeneric,
     ListViewBaseGeneric,

tests/fixtures/app.py

@@ -1,9 +1,8 @@
 from pathlib import Path
 from typing import Type
 
-import uvicorn
+import pytest
 from fastapi import APIRouter, FastAPI
-from pytest import fixture  # noqa PT013
 
 from fastapi_jsonapi import RoutersJSONAPI, init
 from fastapi_jsonapi.atomic import AtomicOperations
@@ -172,30 +171,18 @@ def add_routers(app_plain: FastAPI):
     return app_plain
 
 
-@fixture(scope="session")
+@pytest.fixture(scope="session")
 def app_plain() -> FastAPI:
     return build_app_plain()
 
 
-@fixture(scope="session")
+@pytest.fixture(scope="session")
 def app(app_plain: FastAPI):
     add_routers(app_plain)
 
     return app_plain
 
 
-if __name__ == "__main__":
-    fastapi_app = build_app_plain()
-    add_routers(fastapi_app)
-    uvicorn.run(
-        "asgi:app",
-        host="0.0.0.0",
-        port=8082,
-        reload=True,
-        app_dir=str(CURRENT_DIR),
-    )
-
-
 def build_app_custom(
     model,
     schema,

tests/fixtures/user.py

@@ -0,0 +1,13 @@
+import pytest
+
+from tests.misc.utils import fake
+from tests.schemas import UserAttributesBaseSchema
+
+
+@pytest.fixture()
+def user_attributes():
+    user_attributes = UserAttributesBaseSchema(
+        name=fake.name(),
+        age=fake.pyint(),
+    )
+    return user_attributes