fix: route function parameter aliasing

Author: eadwinCode

ellar/common/params/args/request_model.py

@@ -72,7 +72,7 @@ def build_body_field(self) -> None:
             _fields_required, _body_param_class = [], {}
             for f in _body_resolvers_model_fields:
                 f.field_info.embed = True  # type:ignore[attr-defined]
-                body_model_field.__fields__[f.alias or f.name] = f
+                body_model_field.__fields__[f.name] = f
                 _fields_required.append(f.required)
                 _body_param_class[
                     getattr(f.field_info, "media_type", "application/json")

tests/test_routing/test_body_union_schema.py

@@ -7,7 +7,7 @@
 from ellar.openapi import OpenAPIDocumentBuilder
 from ellar.testing import Test
 
-from .sample import Item, OtherItem
+from .sample import Item, OtherItem, Product
 
 tm = Test.create_test_module()
 
@@ -24,8 +24,15 @@ def embed_qty(qty: Body[int, Body.P(12, embed=True)]):
     return {"qty": qty}
 
 
+@post("/items/alias")
+def alias_qty(qty: Body[int, Body.P(12, embed=True, alias="aliasQty")]):
+    return {"qty": qty}
+
+
 app = tm.create_application()
 app.router.append(save_union_body_and_embedded_body)
+app.router.append(embed_qty)
+app.router.append(alias_qty)
 
 client = tm.get_test_client()
 
@@ -68,7 +75,75 @@ def embed_qty(qty: Body[int, Body.P(12, embed=True)]):
                     },
                 },
             }
-        }
+        },
+        "/items/alias": {
+            "post": {
+                "operationId": "alias_qty_items_alias_post",
+                "requestBody": {
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/components/schemas/body_alias_qty_items_alias_post"
+                            }
+                        }
+                    }
+                },
+                "responses": {
+                    "200": {
+                        "description": "Successful Response",
+                        "content": {
+                            "application/json": {
+                                "schema": {"title": "Response Model", "type": "object"}
+                            }
+                        },
+                    },
+                    "422": {
+                        "description": "Validation Error",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/HTTPValidationError"
+                                }
+                            }
+                        },
+                    },
+                },
+            }
+        },
+        "/items/embed": {
+            "post": {
+                "operationId": "embed_qty_items_embed_post",
+                "requestBody": {
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/components/schemas/body_embed_qty_items_embed_post"
+                            }
+                        }
+                    }
+                },
+                "responses": {
+                    "200": {
+                        "description": "Successful Response",
+                        "content": {
+                            "application/json": {
+                                "schema": {"title": "Response Model", "type": "object"}
+                            }
+                        },
+                    },
+                    "422": {
+                        "description": "Validation Error",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/HTTPValidationError"
+                                }
+                            }
+                        },
+                    },
+                },
+            }
+        },
     },
     "components": {
         "schemas": {
@@ -109,6 +184,30 @@ def embed_qty(qty: Body[int, Body.P(12, embed=True)]):
                     "type": {"title": "Error Type", "type": "string"},
                 },
             },
+            "body_alias_qty_items_alias_post": {
+                "title": "body_alias_qty_items_alias_post",
+                "type": "object",
+                "properties": {
+                    "aliasQty": {
+                        "title": "Aliasqty",
+                        "type": "integer",
+                        "default": 12,
+                        "include_in_schema": True,
+                    }
+                },
+            },
+            "body_embed_qty_items_embed_post": {
+                "title": "body_embed_qty_items_embed_post",
+                "type": "object",
+                "properties": {
+                    "qty": {
+                        "title": "Qty",
+                        "type": "integer",
+                        "default": 12,
+                        "include_in_schema": True,
+                    }
+                },
+            },
             "body_save_union_body_and_embedded_body_items__post": {
                 "title": "body_save_union_body_and_embedded_body_items__post",
                 "required": ["item"],
@@ -154,14 +253,36 @@ def test_post_item():
 
 
 def test_embed_body():
+    response = client.post("/items/embed", json={"qty": 232})
+    assert response.status_code == 200, response.text
+    assert response.json() == {"qty": 232}
+
+
+def test_embed_and_alias_body():
+    response = client.post("/items/alias", json={"aliasQty": 232})
+    assert response.status_code == 200, response.text
+    assert response.json() == {"qty": 232}
+
+
+def test_alias_with_more_body():
+    @post("/product")
+    async def create_item(
+        product: "Product" = Body(alias="item"), qty: int = Body(alias="aliasQty")
+    ):  # just to test get_typed_annotation in ellar.common.params.args.base
+        return {"item": product, "aliasQty": qty}
+
     _tm = Test.create_test_module()
     _app = _tm.create_application()
-    _app.router.append(embed_qty)
+    _app.router.append(create_item)
 
     _client = _tm.get_test_client()
-    response = _client.post("/items/embed", json={"qty": 232})
-    assert response.status_code == 200, response.text
-    assert response.json() == {"qty": 232}
+
+    body = {
+        "item": {"name": "Foo", "description": "Some description", "price": 5.5},
+        "aliasQty": 234,
+    }
+    response = _client.post("/product", json=body)
+    assert response.json() == body
 
 
 @patch.object(Request, "body")

tests/test_routing/test_cookie_schema.py

@@ -28,10 +28,51 @@ def cookie_params_mixed_schema(
     return {"filters": filters.dict(), "data": data.dict()}
 
 
+@router.post("/cookie-alias")
+def cookie_with_alias(
+    request: Inject[Request],
+    qty: Cookie[str, Cookie.P(alias="aliasQty")],
+):
+    return {"aliasQty": qty}
+
+
 tm = Test.create_test_module(routers=(router,))
 app = tm.create_application()
 
 
+def test_cookie_with_alias():
+    client = tm.get_test_client()
+    response = client.post(
+        "/cookie-alias",
+        json={},
+        cookies={
+            "aliasQty": "234",
+        },
+    )
+
+    assert response.json() == {
+        "aliasQty": "234",
+    }
+
+    response = client.post(
+        "/cookie-alias",
+        cookies={
+            "qty": "234",
+        },
+    )
+    assert response.status_code == 422
+    json = response.json()
+    assert json == {
+        "detail": [
+            {
+                "loc": ["cookie", "aliasQty"],
+                "msg": "none is not an allowed value",
+                "type": "type_error.none.not_allowed",
+            }
+        ]
+    }
+
+
 def test_cookie_request():
     client = tm.get_test_client()
     response = client.get(

tests/test_routing/test_form_schema.py

@@ -19,6 +19,14 @@ def form_params_schema(
     return filters.dict()
 
 
+@mr.post("/form-alias")
+def form_with_alias(
+    request: Inject[Request],
+    qty: int = Form(..., alias="aliasQty"),
+):
+    return {"aliasQty": qty}
+
+
 test_module = Test.create_test_module(routers=(mr,))
 app = test_module.create_application()
 
@@ -49,6 +57,37 @@ def test_request():
     }
 
 
+def test_form_with_alias():
+    client = test_module.get_test_client()
+    response = client.post(
+        "/form-alias",
+        data={
+            "aliasQty": 234,
+        },
+    )
+    assert response.json() == {
+        "aliasQty": 234,
+    }
+
+    response = client.post(
+        "/form-alias",
+        data={
+            "qty": 234,
+        },
+    )
+    assert response.status_code == 422
+    json = response.json()
+    assert json == {
+        "detail": [
+            {
+                "loc": ["body", "aliasQty"],
+                "msg": "value is not a valid integer",
+                "type": "type_error.integer",
+            }
+        ]
+    }
+
+
 def test_schema():
     document = serialize_object(OpenAPIDocumentBuilder().build_document(app))
     params = document["paths"]["/form-schema"]["post"]["requestBody"]

tests/test_routing/test_formparsers.py

@@ -33,7 +33,7 @@ async def form_upload_single_case_1(test: UploadFile = File()):
 
 @router.post("/mixed")
 async def form_upload_single_case_2(
-    test1: UploadFile = File(), test2: UploadFile = File()
+    test1: UploadFile = File(alias="test_alias"), test2: UploadFile = File()
 ):
     content1 = await test1.read()
     content2 = await test2.read()
@@ -143,7 +143,7 @@ def test_multipart_request_multiple_files(tmpdir):
     client = tm.get_test_client()
     with open(path1, "rb") as f1, open(path2, "rb") as f2:
         response = client.post(
-            "/mixed", files={"test1": f1, "test2": ("test2.txt", f2, "text/plain")}
+            "/mixed", files={"test_alias": f1, "test2": ("test2.txt", f2, "text/plain")}
         )
         assert response.json() == {
             "test1": {