From 5ddbcaa41a4952720feb22733d57a2c7507aa95a Mon Sep 17 00:00:00 2001 From: ks129 <45097959+ks129@users.noreply.github.com> Date: Wed, 2 Dec 2020 12:09:12 +0200 Subject: Move from PyMongo to Motor driver for asynchronous support --- backend/middleware.py | 4 ++-- backend/routes/auth/authorize.py | 2 +- backend/routes/forms/discover.py | 5 ++--- backend/routes/forms/index.py | 3 ++- backend/routes/forms/submit.py | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) (limited to 'backend') diff --git a/backend/middleware.py b/backend/middleware.py index cf46dc6..2267a9a 100644 --- a/backend/middleware.py +++ b/backend/middleware.py @@ -1,7 +1,7 @@ import typing as t -import pymongo import ssl +from motor.motor_asyncio import AsyncIOMotorClient from starlette.middleware.base import BaseHTTPMiddleware from starlette.requests import Request from starlette.responses import Response @@ -11,7 +11,7 @@ from backend.constants import DATABASE_URL, MONGO_DATABASE class DatabaseMiddleware(BaseHTTPMiddleware): async def dispatch(self, request: Request, call_next: t.Callable) -> Response: - client = pymongo.MongoClient( + client: AsyncIOMotorClient = AsyncIOMotorClient( DATABASE_URL, ssl_cert_reqs=ssl.CERT_NONE ) diff --git a/backend/routes/auth/authorize.py b/backend/routes/auth/authorize.py index 5de49f5..41c0a0b 100644 --- a/backend/routes/auth/authorize.py +++ b/backend/routes/auth/authorize.py @@ -25,7 +25,7 @@ class AuthorizeRoute(Route): bearer_token = await fetch_bearer_token(data["token"]) user_details = await fetch_user_details(bearer_token["access_token"]) - user_details["admin"] = request.state.db.admins.find_one( + user_details["admin"] = await request.state.db.admins.find_one( {"_id": user_details["id"]} ) is not None diff --git a/backend/routes/forms/discover.py b/backend/routes/forms/discover.py index ca36e93..f16faa4 100644 --- a/backend/routes/forms/discover.py +++ b/backend/routes/forms/discover.py @@ -17,10 +17,9 @@ class DiscoverableFormsList(Route): async def get(self, request: Request) -> JSONResponse: forms = [] + cursor = request.state.db.forms.find({"features": "DISCOVERABLE"}) - for form in request.state.db.forms.find({ - "features": "DISCOVERABLE" - }): + for form in await cursor.to_list(None): forms.append(form) return JSONResponse( diff --git a/backend/routes/forms/index.py b/backend/routes/forms/index.py index 183d5cc..41a3ccd 100644 --- a/backend/routes/forms/index.py +++ b/backend/routes/forms/index.py @@ -17,8 +17,9 @@ class FormsList(Route): async def get(self, request: Request) -> JSONResponse: forms = [] + cursor = request.state.db.forms.find() - for form in request.state.db.forms.find(): + for form in await cursor.to_list(None): forms.append(form) return JSONResponse( diff --git a/backend/routes/forms/submit.py b/backend/routes/forms/submit.py index f933367..a94a1c9 100644 --- a/backend/routes/forms/submit.py +++ b/backend/routes/forms/submit.py @@ -25,7 +25,7 @@ class SubmitForm(Route): async def post(self, request: Request) -> JSONResponse: data = await request.json() - if form := request.state.db.forms.find_one( + if form := await request.state.db.forms.find_one( {"_id": request.path_params["form_id"], "features": "OPEN"} ): response_obj = {} -- cgit v1.2.3 From baf067f5f2990d7bf954dfe410fbcd243c63152e Mon Sep 17 00:00:00 2001 From: ks129 <45097959+ks129@users.noreply.github.com> Date: Wed, 2 Dec 2020 12:11:57 +0200 Subject: Lock all forms showing to admins only --- backend/routes/forms/index.py | 2 ++ 1 file changed, 2 insertions(+) (limited to 'backend') diff --git a/backend/routes/forms/index.py b/backend/routes/forms/index.py index 41a3ccd..605f184 100644 --- a/backend/routes/forms/index.py +++ b/backend/routes/forms/index.py @@ -1,6 +1,7 @@ """ Return a list of all forms to authenticated users. """ +from starlette.authentication import requires from starlette.requests import Request from starlette.responses import JSONResponse @@ -15,6 +16,7 @@ class FormsList(Route): name = "forms_list" path = "/" + @requires(["authenticated", "admin"]) async def get(self, request: Request) -> JSONResponse: forms = [] cursor = request.state.db.forms.find() -- cgit v1.2.3 From 6e7ea2a30c2e1290c90fde67257fb2052d5a8ad3 Mon Sep 17 00:00:00 2001 From: ks129 <45097959+ks129@users.noreply.github.com> Date: Wed, 2 Dec 2020 13:12:45 +0200 Subject: Fix Question circular import and use cls instead self for validators --- backend/models/form.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'backend') diff --git a/backend/models/form.py b/backend/models/form.py index d0f0a3c..79d1d54 100644 --- a/backend/models/form.py +++ b/backend/models/form.py @@ -3,7 +3,7 @@ import typing as t from pydantic import BaseModel, Field, validator from backend.constants import FormFeatures -from backend.models import Question +from .question import Question class Form(BaseModel): @@ -14,7 +14,7 @@ class Form(BaseModel): questions: t.List[Question] @validator("features") - def validate_features(self, value: t.List[str]) -> t.Optional[t.List[str]]: + def validate_features(cls, value: t.List[str]) -> t.Optional[t.List[str]]: """Validates is all features in allowed list.""" # Uppercase everything to avoid mixed case in DB value = [v.upper() for v in value] -- cgit v1.2.3 From a47c49900c291f5d6f13411c780da8fbe2133718 Mon Sep 17 00:00:00 2001 From: ks129 <45097959+ks129@users.noreply.github.com> Date: Wed, 2 Dec 2020 13:13:10 +0200 Subject: Use cls instead self for Question model validators --- backend/models/question.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'backend') diff --git a/backend/models/question.py b/backend/models/question.py index 2324a47..22565fd 100644 --- a/backend/models/question.py +++ b/backend/models/question.py @@ -14,7 +14,7 @@ class Question(BaseModel): data: t.Dict[str, t.Any] @validator("type", pre=True) - def validate_question_type(self, value: str) -> t.Optional[str]: + def validate_question_type(cls, value: str) -> t.Optional[str]: """Checks if question type in currently allowed types list.""" value = value.lower() if value not in QUESTION_TYPES: @@ -27,19 +27,19 @@ class Question(BaseModel): @validator("data") def validate_question_data( - self, + cls, value: t.Dict[str, t.Any] ) -> t.Optional[t.Dict[str, t.Any]]: """Check does required data exists for question type and remove other data.""" # When question type don't need data, don't add anything to keep DB clean. - if self.type not in REQUIRED_QUESTION_TYPE_DATA: + if cls.type not in REQUIRED_QUESTION_TYPE_DATA: return {} # Required keys (and values) will be stored to here # to remove all unnecessary stuff result = {} - for key, data_type in REQUIRED_QUESTION_TYPE_DATA[self.type].items(): + for key, data_type in REQUIRED_QUESTION_TYPE_DATA[cls.type].items(): if key not in value: raise ValueError(f"Required question data key '{key}' not provided.") -- cgit v1.2.3 From a494835ee5b121e25b35889d7bd24ea4614ee2be Mon Sep 17 00:00:00 2001 From: ks129 <45097959+ks129@users.noreply.github.com> Date: Wed, 2 Dec 2020 13:14:48 +0200 Subject: Move MongoDB output to Form model and after convert it to dictionary We need to convert '_id' key to 'id'. --- backend/routes/forms/index.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'backend') diff --git a/backend/routes/forms/index.py b/backend/routes/forms/index.py index 605f184..f1df210 100644 --- a/backend/routes/forms/index.py +++ b/backend/routes/forms/index.py @@ -6,6 +6,7 @@ from starlette.requests import Request from starlette.responses import JSONResponse from backend.route import Route +from backend.models import Form class FormsList(Route): @@ -22,7 +23,10 @@ class FormsList(Route): cursor = request.state.db.forms.find() for form in await cursor.to_list(None): - forms.append(form) + forms.append(Form(**form)) # For converting _id to id + + # Covert them back to dictionaries + forms = [form.dict() for form in forms] return JSONResponse( forms -- cgit v1.2.3 From 16552df4c5862004f63a8d8a7c0f8e0dd16f8a0e Mon Sep 17 00:00:00 2001 From: ks129 <45097959+ks129@users.noreply.github.com> Date: Wed, 2 Dec 2020 14:14:57 +0200 Subject: Fix form features validation and allow passing ID as id not _id --- backend/models/form.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'backend') diff --git a/backend/models/form.py b/backend/models/form.py index 79d1d54..a8c5f92 100644 --- a/backend/models/form.py +++ b/backend/models/form.py @@ -13,12 +13,16 @@ class Form(BaseModel): features: t.List[str] questions: t.List[Question] + class Config: + allow_population_by_field_name = True + @validator("features") def validate_features(cls, value: t.List[str]) -> t.Optional[t.List[str]]: """Validates is all features in allowed list.""" # Uppercase everything to avoid mixed case in DB value = [v.upper() for v in value] - if not all(v in FormFeatures.__members__.values() for v in value): + allowed_values = list(v.value for v in FormFeatures.__members__.values()) + if not all(v in allowed_values for v in value): raise ValueError("Form features list contains one or more invalid values.") if FormFeatures.COLLECT_EMAIL in value and FormFeatures.REQUIRES_LOGIN not in value: # noqa -- cgit v1.2.3 From f04af89d8fc4e3ca45ecab83f39dd581c207d3cd Mon Sep 17 00:00:00 2001 From: ks129 <45097959+ks129@users.noreply.github.com> Date: Wed, 2 Dec 2020 14:15:26 +0200 Subject: Parse type and data in same validator and allow passing ID as id not _id --- backend/models/question.py | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) (limited to 'backend') diff --git a/backend/models/question.py b/backend/models/question.py index 22565fd..d6b4946 100644 --- a/backend/models/question.py +++ b/backend/models/question.py @@ -1,6 +1,6 @@ import typing as t -from pydantic import BaseModel, Field, validator +from pydantic import BaseModel, Field, root_validator, validator from backend.constants import QUESTION_TYPES, REQUIRED_QUESTION_TYPE_DATA @@ -13,6 +13,9 @@ class Question(BaseModel): type: str data: t.Dict[str, t.Any] + class Config: + allow_population_by_field_name = True + @validator("type", pre=True) def validate_question_type(cls, value: str) -> t.Optional[str]: """Checks if question type in currently allowed types list.""" @@ -25,30 +28,30 @@ class Question(BaseModel): return value - @validator("data") + @root_validator def validate_question_data( cls, value: t.Dict[str, t.Any] ) -> t.Optional[t.Dict[str, t.Any]]: """Check does required data exists for question type and remove other data.""" # When question type don't need data, don't add anything to keep DB clean. - if cls.type not in REQUIRED_QUESTION_TYPE_DATA: + if value.get("type") not in REQUIRED_QUESTION_TYPE_DATA: return {} # Required keys (and values) will be stored to here # to remove all unnecessary stuff result = {} - for key, data_type in REQUIRED_QUESTION_TYPE_DATA[cls.type].items(): - if key not in value: + for key, data_type in REQUIRED_QUESTION_TYPE_DATA[value.get("type")].items(): + if key not in value.get("data", {}): raise ValueError(f"Required question data key '{key}' not provided.") - if not isinstance(value[key], data_type): + if not isinstance(value["data"][key], data_type): raise ValueError( f"Question data key '{key}' expects {data_type.__name__}, " - f"got {type(value[key]).__name__} instead." + f"got {type(value['data'][key]).__name__} instead." ) - result[key] = value[key] + result[key] = value["data"][key] return result -- cgit v1.2.3 From 4736125395c9103bba10c78a1e97f7f99b343745 Mon Sep 17 00:00:00 2001 From: ks129 <45097959+ks129@users.noreply.github.com> Date: Wed, 2 Dec 2020 14:31:25 +0200 Subject: Fix question validator --- backend/models/question.py | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) (limited to 'backend') diff --git a/backend/models/question.py b/backend/models/question.py index d6b4946..1a012ff 100644 --- a/backend/models/question.py +++ b/backend/models/question.py @@ -36,11 +36,7 @@ class Question(BaseModel): """Check does required data exists for question type and remove other data.""" # When question type don't need data, don't add anything to keep DB clean. if value.get("type") not in REQUIRED_QUESTION_TYPE_DATA: - return {} - - # Required keys (and values) will be stored to here - # to remove all unnecessary stuff - result = {} + return value for key, data_type in REQUIRED_QUESTION_TYPE_DATA[value.get("type")].items(): if key not in value.get("data", {}): @@ -52,6 +48,4 @@ class Question(BaseModel): f"got {type(value['data'][key]).__name__} instead." ) - result[key] = value["data"][key] - - return result + return value -- cgit v1.2.3 From dbe8d21a826311a4ab9fa08f9d9b73def128c7fc Mon Sep 17 00:00:00 2001 From: ks129 <45097959+ks129@users.noreply.github.com> Date: Wed, 2 Dec 2020 15:24:15 +0200 Subject: Move data to Form and then back to dictionary for id converting --- backend/routes/forms/discover.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'backend') diff --git a/backend/routes/forms/discover.py b/backend/routes/forms/discover.py index f16faa4..af6066e 100644 --- a/backend/routes/forms/discover.py +++ b/backend/routes/forms/discover.py @@ -4,6 +4,7 @@ Return a list of all publicly discoverable forms to unauthenticated users. from starlette.requests import Request from starlette.responses import JSONResponse +from backend.models import Form from backend.route import Route @@ -19,8 +20,12 @@ class DiscoverableFormsList(Route): forms = [] cursor = request.state.db.forms.find({"features": "DISCOVERABLE"}) + # Parse it to Form and then back to dictionary + # to replace _id with id for form in await cursor.to_list(None): - forms.append(form) + forms.append(Form(**form)) + + forms = [form.dict() for form in forms] return JSONResponse( forms -- cgit v1.2.3 From ac1000cb101e69a44e69e3e7a4fbdeb595aa0e83 Mon Sep 17 00:00:00 2001 From: ks129 <45097959+ks129@users.noreply.github.com> Date: Wed, 2 Dec 2020 15:24:43 +0200 Subject: Create route for creating new forms --- backend/routes/forms/new.py | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 backend/routes/forms/new.py (limited to 'backend') diff --git a/backend/routes/forms/new.py b/backend/routes/forms/new.py new file mode 100644 index 0000000..ff39f12 --- /dev/null +++ b/backend/routes/forms/new.py @@ -0,0 +1,30 @@ +""" +Creates new form based on data provided. +""" +from pydantic import ValidationError +from starlette.authentication import requires +from starlette.requests import Request +from starlette.responses import JSONResponse + +from backend.models import Form +from backend.route import Route + + +class FormCreate(Route): + """ + Creates new form from JSON data. + """ + + name = "forms_create" + path = "/new" + + @requires(["authenticated", "admin"]) + async def post(self, request: Request) -> JSONResponse: + form_data = await request.json() + try: + form = Form(**form_data) + except ValidationError as e: + return JSONResponse(e.errors()) + + await request.state.db.forms.insert_one(form.dict(by_alias=True)) + return JSONResponse(form.dict()) -- cgit v1.2.3