[GraphQL] Init Strawberry gql. (#33)

* start configure strawberry

* feat: fix errors.

* feat:  init strawberry logic and architecture

* fix: CI errors

Pipfile

@@ -36,6 +36,7 @@ marshmallow-sqlalchemy = "*"
 apispec = "*"
 chardet = "*"
 charset-normalizer = "*"
+strawberry-graphql = {extras = ["debug-server"], version = "*"}
 
 [dev-packages]
 

src/__init__.py

@@ -22,6 +22,7 @@
 from apispec.ext.marshmallow import MarshmallowPlugin
 from apispec_webframeworks.flask import FlaskPlugin
 
+
 db: SQLAlchemy = SQLAlchemy()
 plugins = [
     FlaskPlugin(),
@@ -63,12 +64,14 @@ def register_blueprints(app: Flask):
     from src.blueprints.formations import formations
     from src.blueprints.utils import utils
     from src.blueprints.legal.views import legal
+    from src.blueprints.graphql import graphql
 
     app.register_blueprint(utils)
     app.register_blueprint(auth)
     app.register_blueprint(legal)
     app.register_blueprint(favoris)
     app.register_blueprint(formations)
+    app.register_blueprint(graphql)
 
 
 def _set_log_levels():

src/api/favoris/favori_resolver.py

@@ -0,0 +1,13 @@
+import strawberry
+
+from src.business_logic.favoris.get_favoris import get_favoris_by_user_id
+from src.business_logic.formation.scrap.types import FormationsWithTotal
+
+# https://strawberry.rocks/docs/integrations/flask#options
+
+
+@strawberry.type
+class FavorisResolver:
+    get_favoris_by_user_id: FormationsWithTotal = strawberry.field(
+        resolver=get_favoris_by_user_id
+    )

src/api/formation/formation_resolver.py

@@ -0,0 +1,12 @@
+from src.business_logic.formation.get_formation_details import (
+    FormationDetails,
+    get_formation_by_id,
+)
+import strawberry
+
+
+@strawberry.type
+class FormationResolver:
+    get_formation_by_id: FormationDetails = strawberry.field(
+        resolver=get_formation_by_id
+    )

src/api/schema.py

@@ -0,0 +1,22 @@
+from src.api.favoris.favori_resolver import FavorisResolver
+from src.api.formation.formation_resolver import FormationResolver
+import strawberry
+
+from strawberry.tools import merge_types
+from strawberry.extensions import QueryDepthLimiter
+from strawberry.extensions import MaxTokensLimiter
+from strawberry.extensions import MaxAliasesLimiter
+
+types: tuple = (FormationResolver, FavorisResolver)
+
+Queries = merge_types("Queries", types)
+
+schema = strawberry.Schema(
+    query=Queries,
+    extensions=[
+        QueryDepthLimiter(max_depth=10),
+        MaxTokensLimiter(max_token_count=1000),
+        MaxAliasesLimiter(max_alias_count=15),
+    ],
+)
+# https://strawberry.rocks/docs/guides/tools

src/blueprints/graphql.py

@@ -0,0 +1,12 @@
+from flask import Blueprint, Response
+from strawberry.flask.views import GraphQLView
+
+from src.api.schema import schema
+
+graphql = Blueprint("graphql", __name__, url_prefix="/api/graphql")
+
+
+@graphql.route("/", methods=["POST", "GET"])
+def gql() -> tuple[Response, int]:
+    view = GraphQLView.as_view("graphql_view", schema=schema)
+    return view()

src/business_logic/favoris/get_favoris.py

@@ -1,9 +1,8 @@
+from src import db
 from src.business_logic.formation.scrap.types import (
     FormationIsFavorite,
     FormationsWithTotal,
 )
-
-from src import db
 from src.models.formation import Formation
 from src.models.user_favori import UserFavori
 

src/business_logic/formation/get_formation_details.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-from datetime import date
+from datetime import date, datetime
 import json
 from typing import Any, Optional
 from src.business_logic.formation.exceptions import ProcessFormationException
@@ -15,10 +15,14 @@
     ContinuationOfStudies,
     process_continuation_studies,
 )
+import strawberry
+
+DATE_FORMAT = "%d/%m/%Y"
 
 
 @dataclass
-class Formation:
+@strawberry.type
+class FormationDetails:
     id: str
     exceptions: Optional[ParcourSupExpectations]
     duree: str
@@ -29,7 +33,7 @@ class Formation:
     type: str
     jobs: Optional[list[Job]]
     continuation_studies: Optional[ContinuationOfStudies]
-    updated_at: date
+    updated_at: Optional[date]
 
 
 def _filter_by_link(formations: list[dict[str, Any]], for_id: str) -> dict[str, Any]:
@@ -45,7 +49,7 @@ def _read_json_formation(for_id: str) -> Optional[dict[str, Any]]:
     return result if len(result) > 0 else None
 
 
-def _process_formation(for_id: str) -> Formation:
+def _process_formation(for_id: str) -> FormationDetails:
     formation = _read_json_formation(for_id)
 
     if formation:
@@ -60,16 +64,17 @@ def _process_formation(for_id: str) -> Formation:
         certificat = formation["nature_certificat"]["libelle_nature_certificat"]
         sigle = formation["sigle"] if formation["sigle"] else None
         type_sigle = formation["type_Formation"]["type_formation_sigle"]
-
         metier = formation["metiers_formation"]["metier"]
         jobs = process_jobs(metier if metier else None)
 
         poursuite_etudes = formation["poursuites_etudes"]
         continuation_studies = process_continuation_studies(
             poursuite_etudes if poursuite_etudes else None
         )
-        updated_at = formation["modification_date"]
-        return Formation(
+        updated_at = datetime.strptime(
+            formation["modification_date"], DATE_FORMAT
+        ).date()
+        return FormationDetails(
             id=identifiant,
             exceptions=exceptions,
             duree=duree,
@@ -84,10 +89,10 @@ def _process_formation(for_id: str) -> Formation:
         )
 
 
-def get_formation_by_id(for_id: str) -> Formation:
+def get_formation_by_id(for_id: str) -> FormationDetails:
     try:
         return _process_formation(for_id)
     except Exception as e:
         raise ProcessFormationException(
-            "Error during formation processing : " + e
+            "Error during formation processing : " + str(e)
         ) from e

src/business_logic/formation/job/get_job_by_formation.py

@@ -1,7 +1,9 @@
 from dataclasses import dataclass
+import strawberry
 
 
 @dataclass
+@strawberry.type
 class Job:
     id: str
     libelle: str

src/business_logic/formation/parcoursup/helper/html_parser.py

@@ -2,14 +2,18 @@
 from typing import Optional
 from bs4 import BeautifulSoup
 
+import strawberry
+
 
 @dataclass
+@strawberry.type
 class Expectation:
     title: str
     sub_expectations: Optional[list[str]] = field(default_factory=list)
 
 
 @dataclass
+@strawberry.type
 class ParcourSupExpectations:
     title: str
     expectations: list[Expectation]
@@ -57,7 +61,6 @@ def _extract_expectations(self) -> list[Expectation]:
 
         if current_expectation:
             self.__expectations.append(current_expectation)
-
         return self.__expectations
 
     def _extract_title(self) -> str:
@@ -67,4 +70,4 @@ def parse_html(self) -> ParcourSupExpectations:
         title = self._extract_title()
         expectations = self._extract_expectations()
 
-        return ParcourSupExpectations(title, expectations)
+        return ParcourSupExpectations(title=title, expectations=expectations)

src/business_logic/formation/scrap/types.py

@@ -1,21 +1,26 @@
 from dataclasses import dataclass
 
+import strawberry
+
 from src.models.formation import Formation
 
 
 @dataclass
+@strawberry.type
 class Facet:
     key: str
     doc_count: int
 
 
 @dataclass
+@strawberry.type
 class FormationIsFavorite:
     formation: Formation
     is_favorite: bool
 
 
 @dataclass
+@strawberry.type
 class FormationsWithTotal:
     total: int
     formations: list[Formation | FormationIsFavorite]

src/business_logic/formation/study/get_continuation_of_study.py

@@ -1,7 +1,10 @@
 from dataclasses import dataclass, field
 from typing import Optional
 
+import strawberry
 
+
+@strawberry.type
 @dataclass
 class ContinuationOfStudies:
     title: str = ""

src/models/base_model.py

@@ -1,14 +1,17 @@
+from datetime import date
+
+import strawberry
 from sqlalchemy import Column, DateTime, func
 from sqlalchemy.ext.declarative import declarative_base
 
-
 Model = declarative_base(name="Model")
 
 
+@strawberry.type
 class BaseModel(Model):
-    __abstract__: bool = True
-    created_at = Column(DateTime, nullable=False, default=func.now())
-    updated_at = Column(
+    __abstract__ = True
+    created_at: date = Column(DateTime, nullable=False, default=func.now())
+    updated_at: date = Column(
         DateTime, nullable=False, default=func.now(), onupdate=func.now()
     )
 

src/models/formation.py

@@ -1,6 +1,8 @@
 import uuid
 
+import strawberry
 from sqlalchemy import Column, Integer, String, Text
+
 from src.models.base_model import BaseModel
 from src.models.helpers.UUIDType import UUIDType
 
@@ -11,19 +13,20 @@ def default_uuid5():
     return uuid.uuid5(namespace, name)
 
 
+@strawberry.type
 class Formation(BaseModel):
     __tablename__ = "formation"
 
-    id = Column(
+    id: uuid.UUID = Column(
         UUIDType,
         default=default_uuid5,
         primary_key=True,
     )
-    code_nsf = Column(Integer, nullable=False)
-    type = Column(String(255), nullable=False)
-    libelle = Column(String(255), nullable=False)
-    tutelle = Column(String(255), nullable=False)
-    url = Column(String(255), nullable=False, unique=True)
-    domain = Column(Text, nullable=False)
-    niveau_de_sortie = Column(String(255), nullable=False)
-    duree = Column(String(255), nullable=False)
+    code_nsf: int = Column(Integer, nullable=False)
+    type: str = Column(String(255), nullable=False)
+    libelle: str = Column(String(255), nullable=False)
+    tutelle: str = Column(String(255), nullable=False)
+    url: str = Column(String(255), nullable=False, unique=True)
+    domain: str = Column(Text, nullable=False)
+    niveau_de_sortie: str = Column(String(255), nullable=False)
+    duree: str = Column(String(255), nullable=False)

src/models/user.py

@@ -1,28 +1,24 @@
-from dataclasses import dataclass
+from typing import Optional
 
+import strawberry
 from sqlalchemy import Column, Integer, String, Text
-from src.models.base_model import BaseModel
-from src.models.user_favori import UserFavori
 from sqlalchemy.orm import relationship
 
+from src.models.base_model import BaseModel
+from src.models.user_favori import UserFavori
 
 # Create User row
 
 
-@dataclass
+@strawberry.type
 class User(BaseModel):
     __tablename__ = "user"
 
-    id: int
-    username: str
-    email: str
-    profile_pic_url: str
-
-    id = Column(Integer, primary_key=True)
-    username = Column(String(80), unique=True, nullable=False)
-    email = Column(String(200), unique=True, nullable=False)
+    id: int = Column(Integer, primary_key=True)
+    username: str = Column(String(80), unique=True, nullable=False)
+    email: str = Column(String(200), unique=True, nullable=False)
     password = Column(Text(), nullable=False)
-    profile_pic_url = Column(Text)
+    profile_pic_url: Optional[str] = Column(Text)
 
     favoris = relationship(
         "UserFavori",