feat: ✨ (WIP) base-shoppinglist infra (#911)

* feat: ✨ base-shoppinglist infra (WIP)

* add type checker

* implement controllers

* apply router fixes

* add checked section hide/animation

* add label support

* formatting

* fix overflow images

* add experimental banner

* fix #912 word break issue

* remove any type errors

* bump dependencies

* remove templates

* fix build errors

* bump node version

* fix template literal

mealie/routes/__init__.py

@@ -1,21 +1,6 @@
 from fastapi import APIRouter
 
-from . import (
-    admin,
-    app,
-    auth,
-    categories,
-    comments,
-    groups,
-    parser,
-    recipe,
-    shared,
-    shopping_lists,
-    tags,
-    tools,
-    unit_and_foods,
-    users,
-)
+from . import admin, app, auth, categories, comments, groups, parser, recipe, shared, tags, tools, unit_and_foods, users
 
 router = APIRouter(prefix="/api")
 
@@ -31,5 +16,4 @@ router.include_router(unit_and_foods.router)
 router.include_router(tools.router)
 router.include_router(categories.router)
 router.include_router(tags.router)
-router.include_router(shopping_lists.router)
 router.include_router(admin.router)

mealie/routes/_base/controller.py

@@ -0,0 +1,182 @@
+"""
+This file contains code taken from fastapi-utils project. The code is licensed under the MIT license.
+
+See their repository for details -> https://github.com/dmontagu/fastapi-utils
+"""
+import inspect
+from typing import Any, Callable, List, Tuple, Type, TypeVar, Union, cast, get_type_hints
+
+from fastapi import APIRouter, Depends
+from fastapi.routing import APIRoute
+from pydantic.typing import is_classvar
+from starlette.routing import Route, WebSocketRoute
+
+T = TypeVar("T")
+
+CBV_CLASS_KEY = "__cbv_class__"
+INCLUDE_INIT_PARAMS_KEY = "__include_init_params__"
+RETURN_TYPES_FUNC_KEY = "__return_types_func__"
+
+
+def controller(router: APIRouter, *urls: str) -> Callable[[Type[T]], Type[T]]:
+    """
+    This function returns a decorator that converts the decorated into a class-based view for the provided router.
+    Any methods of the decorated class that are decorated as endpoints using the router provided to this function
+    will become endpoints in the router. The first positional argument to the methods (typically `self`)
+    will be populated with an instance created using FastAPI's dependency-injection.
+    For more detail, review the documentation at
+    https://fastapi-utils.davidmontague.xyz/user-guide/class-based-views/#the-cbv-decorator
+    """
+
+    def decorator(cls: Type[T]) -> Type[T]:
+        # Define cls as cbv class exclusively when using the decorator
+        return _cbv(router, cls, *urls)
+
+    return decorator
+
+
+def _cbv(router: APIRouter, cls: Type[T], *urls: str, instance: Any = None) -> Type[T]:
+    """
+    Replaces any methods of the provided class `cls` that are endpoints of routes in `router` with updated
+    function calls that will properly inject an instance of `cls`.
+    """
+    _init_cbv(cls, instance)
+    _register_endpoints(router, cls, *urls)
+    return cls
+
+
+def _init_cbv(cls: Type[Any], instance: Any = None) -> None:
+    """
+    Idempotently modifies the provided `cls`, performing the following modifications:
+    * The `__init__` function is updated to set any class-annotated dependencies as instance attributes
+    * The `__signature__` attribute is updated to indicate to FastAPI what arguments should be passed to the initializer
+    """
+    if getattr(cls, CBV_CLASS_KEY, False):  # pragma: no cover
+        return  # Already initialized
+    old_init: Callable[..., Any] = cls.__init__
+    old_signature = inspect.signature(old_init)
+    old_parameters = list(old_signature.parameters.values())[1:]  # drop `self` parameter
+    new_parameters = [
+        x for x in old_parameters if x.kind not in (inspect.Parameter.VAR_POSITIONAL, inspect.Parameter.VAR_KEYWORD)
+    ]
+
+    dependency_names: List[str] = []
+    for name, hint in get_type_hints(cls).items():
+        if is_classvar(hint):
+            continue
+        parameter_kwargs = {"default": getattr(cls, name, Ellipsis)}
+        dependency_names.append(name)
+        new_parameters.append(
+            inspect.Parameter(name=name, kind=inspect.Parameter.KEYWORD_ONLY, annotation=hint, **parameter_kwargs)
+        )
+    new_signature = inspect.Signature(())
+    if not instance or hasattr(cls, INCLUDE_INIT_PARAMS_KEY):
+        new_signature = old_signature.replace(parameters=new_parameters)
+
+    def new_init(self: Any, *args: Any, **kwargs: Any) -> None:
+        for dep_name in dependency_names:
+            dep_value = kwargs.pop(dep_name)
+            setattr(self, dep_name, dep_value)
+        if instance and not hasattr(cls, INCLUDE_INIT_PARAMS_KEY):
+            self.__class__ = instance.__class__
+            self.__dict__ = instance.__dict__
+        else:
+            old_init(self, *args, **kwargs)
+
+    setattr(cls, "__signature__", new_signature)
+    setattr(cls, "__init__", new_init)
+    setattr(cls, CBV_CLASS_KEY, True)
+
+
+def _register_endpoints(router: APIRouter, cls: Type[Any], *urls: str) -> None:
+    cbv_router = APIRouter()
+    function_members = inspect.getmembers(cls, inspect.isfunction)
+    for url in urls:
+        _allocate_routes_by_method_name(router, url, function_members)
+    router_roles = []
+    for route in router.routes:
+        assert isinstance(route, APIRoute)
+        route_methods: Any = route.methods
+        cast(Tuple[Any], route_methods)
+        router_roles.append((route.path, tuple(route_methods)))
+
+    if len(set(router_roles)) != len(router_roles):
+        raise Exception("An identical route role has been implemented more then once")
+
+    numbered_routes_by_endpoint = {
+        route.endpoint: (i, route)
+        for i, route in enumerate(router.routes)
+        if isinstance(route, (Route, WebSocketRoute))
+    }
+
+    prefix_length = len(router.prefix)
+    routes_to_append: List[Tuple[int, Union[Route, WebSocketRoute]]] = []
+    for _, func in function_members:
+        index_route = numbered_routes_by_endpoint.get(func)
+
+        if index_route is None:
+            continue
+
+        _, route = index_route
+        route.path = route.path[prefix_length:]
+        routes_to_append.append(index_route)
+        router.routes.remove(route)
+
+        _update_cbv_route_endpoint_signature(cls, route)
+    routes_to_append.sort(key=lambda x: x[0])
+
+    cbv_router.routes = [route for _, route in routes_to_append]
+
+    # In order to use a "" as a router and utilize the prefix in the original router
+    # we need to create an intermediate prefix variable to hold the prefix and pass it
+    # into the original router when using "include_router" after we reeset the original
+    # prefix. This limits the original routers usability to only the controller.
+    #
+    # This is sort of a hack and causes unexpected behavior. I'm unsure of a better solution.
+    cbv_prefix = router.prefix
+    router.prefix = ""
+    router.include_router(cbv_router, prefix=cbv_prefix)
+
+
+def _allocate_routes_by_method_name(router: APIRouter, url: str, function_members: List[Tuple[str, Any]]) -> None:
+    # sourcery skip: merge-nested-ifs
+    existing_routes_endpoints: List[Tuple[Any, str]] = [
+        (route.endpoint, route.path) for route in router.routes if isinstance(route, APIRoute)
+    ]
+    for name, func in function_members:
+        if hasattr(router, name) and not name.startswith("__") and not name.endswith("__"):
+            if (func, url) not in existing_routes_endpoints:
+                response_model = None
+                responses = None
+                kwargs = {}
+                status_code = 200
+                return_types_func = getattr(func, RETURN_TYPES_FUNC_KEY, None)
+                if return_types_func:
+                    response_model, status_code, responses, kwargs = return_types_func()
+
+                api_resource = router.api_route(
+                    url,
+                    methods=[name.capitalize()],
+                    response_model=response_model,
+                    status_code=status_code,
+                    responses=responses,
+                    **kwargs,
+                )
+                api_resource(func)
+
+
+def _update_cbv_route_endpoint_signature(cls: Type[Any], route: Union[Route, WebSocketRoute]) -> None:
+    """
+    Fixes the endpoint signature for a cbv route to ensure FastAPI performs dependency injection properly.
+    """
+    old_endpoint = route.endpoint
+    old_signature = inspect.signature(old_endpoint)
+    old_parameters: List[inspect.Parameter] = list(old_signature.parameters.values())
+    old_first_parameter = old_parameters[0]
+    new_first_parameter = old_first_parameter.replace(default=Depends(cls))
+    new_parameters = [new_first_parameter] + [
+        parameter.replace(kind=inspect.Parameter.KEYWORD_ONLY) for parameter in old_parameters[1:]
+    ]
+
+    new_signature = old_signature.replace(parameters=new_parameters)
+    setattr(route.endpoint, "__signature__", new_signature)

mealie/routes/_base/dependencies.py

@@ -0,0 +1,58 @@
+from __future__ import annotations
+
+from functools import cached_property
+from logging import Logger
+
+from fastapi import Depends
+from sqlalchemy.orm import Session
+
+from mealie.core.config import get_app_dirs, get_app_settings
+from mealie.core.dependencies.dependencies import get_admin_user, get_current_user
+from mealie.core.root_logger import get_logger
+from mealie.core.settings.directories import AppDirectories
+from mealie.core.settings.settings import AppSettings
+from mealie.db.db_setup import generate_session
+from mealie.lang import AbstractLocaleProvider, get_locale_provider
+from mealie.repos import AllRepositories
+from mealie.schema.user.user import PrivateUser
+
+
+def _get_logger() -> Logger:
+    return get_logger()
+
+
+class SharedDependencies:
+    session: Session
+    t: AbstractLocaleProvider
+    logger: Logger
+    acting_user: PrivateUser | None
+
+    def __init__(self, session: Session, acting_user: PrivateUser | None) -> None:
+        self.t = get_locale_provider()
+        self.logger = _get_logger()
+        self.session = session
+        self.acting_user = acting_user
+
+    @classmethod
+    def user(
+        cls, session: Session = Depends(generate_session), user: PrivateUser = Depends(get_current_user)
+    ) -> "SharedDependencies":
+        return cls(session, user)
+
+    @classmethod
+    def admin(
+        cls, session: Session = Depends(generate_session), admin: PrivateUser = Depends(get_admin_user)
+    ) -> "SharedDependencies":
+        return cls(session, admin)
+
+    @cached_property
+    def settings(self) -> AppSettings:
+        return get_app_settings()
+
+    @cached_property
+    def folders(self) -> AppDirectories:
+        return get_app_dirs()
+
+    @cached_property
+    def repos(self) -> AllRepositories:
+        return AllRepositories(self.session)

mealie/routes/_base/mixins.py

@@ -0,0 +1,109 @@
+from __future__ import annotations
+
+from logging import Logger
+from typing import Callable, Type
+
+from fastapi import HTTPException, status
+
+from mealie.repos.repository_generic import RepositoryGeneric
+from mealie.schema.response import ErrorResponse
+
+
+class CrudMixins:
+    repo: RepositoryGeneric
+    exception_msgs: Callable[[Type[Exception]], str] | None
+    default_message: str = "An unexpected error occurred."
+
+    def __init__(
+        self,
+        repo: RepositoryGeneric,
+        logger: Logger,
+        exception_msgs: Callable[[Type[Exception]], str] = None,
+        default_message: str = None,
+    ) -> None:
+        """
+        The CrudMixins class is a mixin class that provides a common set of methods for CRUD operations.
+        This class is inteded to be used in a composition pattern where a class has a mixin property. For example:
+
+        ```
+        class MyClass:
+            def __init(self repo, logger):
+                self.mixins = CrudMixins(repo, logger)
+        ```
+
+        """
+        self.repo = repo
+        self.logger = logger
+        self.exception_msgs = exception_msgs
+
+        if default_message:
+            self.default_message = default_message
+
+    def set_default_message(self, default_msg: str) -> "CrudMixins":
+        """
+        Use this method to set a lookup function for exception messages. When an exception is raised, and
+        no custom message is set, the default message will be used.
+
+        IMPORTANT! The function returns the same instance of the CrudMixins class, so you can chain calls.
+        """
+        self.default_msg = default_msg
+        return self
+
+    def get_exception_message(self, ext: Exception) -> str:
+        if self.exception_msgs:
+            return self.exception_msgs(type(ext))
+        return self.default_message
+
+    def handle_exception(self, ex: Exception) -> None:
+        # Cleanup
+        self.logger.exception(ex)
+        self.repo.session.rollback()
+
+        # Respond
+        msg = self.get_exception_message(ex)
+
+        raise HTTPException(
+            status.HTTP_400_BAD_REQUEST,
+            detail=ErrorResponse.respond(message=msg, exception=str(ex)),
+        )
+
+    def create_one(self, data):
+        item = None
+        try:
+            item = self.repo.create(data)
+        except Exception as ex:
+            self.handle_exception(ex)
+
+        return item
+
+    def update_one(self, data, item_id):
+        item = self.repo.get(item_id)
+
+        if not item:
+            return
+
+        try:
+            item = self.repo.update(item.id, data)  # type: ignore
+        except Exception as ex:
+            self.handle_exception(ex)
+
+        return item
+
+    def patch_one(self, data, item_id) -> None:
+        self.repo.get(item_id)
+
+        try:
+            self.repo.patch(item_id, data.dict(exclude_unset=True, exclude_defaults=True))
+        except Exception as ex:
+            self.handle_exception(ex)
+
+    def delete_one(self, item_id):
+        item = self.repo.get(item_id)
+        self.logger.info(f"Deleting item with id {item}")
+
+        try:
+            item = self.repo.delete(item)
+        except Exception as ex:
+            self.handle_exception(ex)
+
+        return item

mealie/routes/groups/__init__.py

@@ -8,7 +8,7 @@ from mealie.services.group_services import CookbookService, WebhookService
 from mealie.services.group_services.meal_service import MealService
 from mealie.services.group_services.reports_service import GroupReportService
 
-from . import categories, invitations, migrations, preferences, self_service
+from . import categories, invitations, labels, migrations, preferences, self_service, shopping_lists
 
 router = APIRouter()
 
@@ -20,18 +20,18 @@ cookbook_router = RouterFactory(service=CookbookService, prefix="/groups/cookboo
 
 
 @router.get("/groups/mealplans/today", tags=["Groups: Mealplans"])
-def get_todays_meals(m_service: MealService = Depends(MealService.private)):
-    return m_service.get_today()
+def get_todays_meals(ms: MealService = Depends(MealService.private)):
+    return ms.get_today()
 
 
 meal_plan_router = RouterFactory(service=MealService, prefix="/groups/mealplans", tags=["Groups: Mealplans"])
 
 
 @meal_plan_router.get("")
-def get_all(start: date = None, limit: date = None, m_service: MealService = Depends(MealService.private)):
+def get_all(start: date = None, limit: date = None, ms: MealService = Depends(MealService.private)):
     start = start or date.today() - timedelta(days=999)
     limit = limit or date.today() + timedelta(days=999)
-    return m_service.get_slice(start, limit)
+    return ms.get_slice(start, limit)
 
 
 router.include_router(cookbook_router)
@@ -47,9 +47,12 @@ report_router = RouterFactory(service=GroupReportService, prefix="/groups/report
 
 @report_router.get("")
 def get_all_reports(
-    report_type: ReportCategory = None, gm_service: GroupReportService = Depends(GroupReportService.private)
+    report_type: ReportCategory = None,
+    gs: GroupReportService = Depends(GroupReportService.private),
 ):
-    return gm_service._get_all(report_type)
+    return gs._get_all(report_type)
 
 
 router.include_router(report_router)
+router.include_router(shopping_lists.router)
+router.include_router(labels.router)

mealie/routes/groups/labels.py

@@ -0,0 +1,71 @@
+from functools import cached_property
+from sqlite3 import IntegrityError
+from typing import Type
+
+from fastapi import APIRouter, Depends
+from pydantic import UUID4
+
+from mealie.routes._base.controller import controller
+from mealie.routes._base.dependencies import SharedDependencies
+from mealie.routes._base.mixins import CrudMixins
+from mealie.schema.labels import (
+    MultiPurposeLabelCreate,
+    MultiPurposeLabelOut,
+    MultiPurposeLabelSave,
+    MultiPurposeLabelSummary,
+    MultiPurposeLabelUpdate,
+)
+from mealie.schema.mapper import cast
+from mealie.schema.query import GetAll
+from mealie.services.group_services.shopping_lists import ShoppingListService
+
+router = APIRouter(prefix="/groups/labels", tags=["Group: Multi Purpose Labels"])
+
+
+@controller(router)
+class ShoppingListRoutes:
+    deps: SharedDependencies = Depends(SharedDependencies.user)
+    service: ShoppingListService = Depends(ShoppingListService.private)
+
+    @cached_property
+    def repo(self):
+        if not self.deps.acting_user:
+            raise Exception("No user is logged in.")
+
+        return self.deps.repos.group_multi_purpose_labels.by_group(self.deps.acting_user.group_id)
+
+    def registered_exceptions(self, ex: Type[Exception]) -> str:
+        registered = {
+            Exception: "An unexpected error occurred.",
+            IntegrityError: "An unexpected error occurred.",
+        }
+
+        return registered.get(ex, "An unexpected error occurred.")
+
+    # =======================================================================
+    # CRUD Operations
+
+    @property
+    def mixins(self) -> CrudMixins:
+        return CrudMixins(self.repo, self.deps.logger, self.registered_exceptions, "An unexpected error occurred.")
+
+    @router.get("", response_model=list[MultiPurposeLabelSummary])
+    def get_all(self, q: GetAll = Depends(GetAll)):
+        return self.repo.get_all(start=q.start, limit=q.limit, override_schema=MultiPurposeLabelSummary)
+
+    @router.post("", response_model=MultiPurposeLabelOut)
+    def create_one(self, data: MultiPurposeLabelCreate):
+        save_data = cast(data, MultiPurposeLabelSave, group_id=self.deps.acting_user.group_id)
+        return self.mixins.create_one(save_data)
+
+    @router.get("/{item_id}", response_model=MultiPurposeLabelOut)
+    def get_one(self, item_id: UUID4):
+        return self.repo.get_one(item_id)
+
+    @router.put("/{item_id}", response_model=MultiPurposeLabelOut)
+    def update_one(self, item_id: UUID4, data: MultiPurposeLabelUpdate):
+        return self.mixins.update_one(data, item_id)
+
+    @router.delete("/{item_id}", response_model=MultiPurposeLabelOut)
+    def delete_one(self, item_id: UUID4):
+        return self.mixins.delete_one(item_id)  # type: ignore

mealie/routes/groups/shopping_lists.py

@@ -0,0 +1,82 @@
+from functools import cached_property
+from sqlite3 import IntegrityError
+from typing import Type
+
+from fastapi import APIRouter, Depends
+from pydantic import UUID4
+
+from mealie.routes._base.controller import controller
+from mealie.routes._base.dependencies import SharedDependencies
+from mealie.routes._base.mixins import CrudMixins
+from mealie.schema.group.group_shopping_list import (
+    ShoppingListCreate,
+    ShoppingListOut,
+    ShoppingListSave,
+    ShoppingListSummary,
+    ShoppingListUpdate,
+)
+from mealie.schema.mapper import cast
+from mealie.schema.query import GetAll
+from mealie.services.group_services.shopping_lists import ShoppingListService
+
+router = APIRouter(prefix="/groups/shopping/lists", tags=["Group: Shopping Lists"])
+
+
+@controller(router)
+class ShoppingListRoutes:
+    deps: SharedDependencies = Depends(SharedDependencies.user)
+    service: ShoppingListService = Depends(ShoppingListService.private)
+
+    @cached_property
+    def repo(self):
+        if not self.deps.acting_user:
+            raise Exception("No user is logged in.")
+
+        return self.deps.repos.group_shopping_lists.by_group(self.deps.acting_user.group_id)
+
+    def registered_exceptions(self, ex: Type[Exception]) -> str:
+        registered = {
+            Exception: "An unexpected error occurred.",
+            IntegrityError: "An unexpected error occurred.",
+        }
+
+        return registered.get(ex, "An unexpected error occurred.")
+
+    # =======================================================================
+    # CRUD Operations
+
+    @property
+    def mixins(self) -> CrudMixins:
+        return CrudMixins(self.repo, self.deps.logger, self.registered_exceptions, "An unexpected error occurred.")
+
+    @router.get("", response_model=list[ShoppingListSummary])
+    def get_all(self, q: GetAll = Depends(GetAll)):
+        return self.repo.get_all(start=q.start, limit=q.limit, override_schema=ShoppingListSummary)
+
+    @router.post("", response_model=ShoppingListOut)
+    def create_one(self, data: ShoppingListCreate):
+        save_data = cast(data, ShoppingListSave, group_id=self.deps.acting_user.group_id)
+        return self.mixins.create_one(save_data)
+
+    @router.get("/{item_id}", response_model=ShoppingListOut)
+    def get_one(self, item_id: UUID4):
+        return self.repo.get_one(item_id)
+
+    @router.put("/{item_id}", response_model=ShoppingListOut)
+    def update_one(self, item_id: UUID4, data: ShoppingListUpdate):
+        return self.mixins.update_one(data, item_id)
+
+    @router.delete("/{item_id}", response_model=ShoppingListOut)
+    def delete_one(self, item_id: UUID4):
+        return self.mixins.delete_one(item_id)  # type: ignore
+
+    # =======================================================================
+    # Other Operations
+
+    @router.post("/{item_id}/recipe/{recipe_id}", response_model=ShoppingListOut)
+    def add_recipe_ingredients_to_list(self, item_id: UUID4, recipe_id: int):
+        return self.service.add_recipe_ingredients_to_list(item_id, recipe_id)
+
+    @router.delete("/{item_id}/recipe/{recipe_id}", response_model=ShoppingListOut)
+    def remove_recipe_ingredients_from_list(self, item_id: UUID4, recipe_id: int):
+        return self.service.remove_recipe_ingredients_from_list(item_id, recipe_id)

mealie/routes/shopping_lists/__init__.py

@@ -1,45 +0,0 @@
-from fastapi import Depends
-from sqlalchemy.orm.session import Session
-
-from mealie.core.dependencies import get_current_user
-from mealie.db.db_setup import generate_session
-from mealie.repos.all_repositories import get_repositories
-from mealie.routes.routers import UserAPIRouter
-from mealie.schema.meal_plan import ShoppingListIn, ShoppingListOut
-from mealie.schema.user import PrivateUser
-
-router = UserAPIRouter(prefix="/shopping-lists", tags=["Shopping Lists: CRUD"])
-
-
-@router.post("", response_model=ShoppingListOut)
-async def create_shopping_list(
-    list_in: ShoppingListIn,
-    current_user: PrivateUser = Depends(get_current_user),
-    session: Session = Depends(generate_session),
-):
-    """Create Shopping List in the Database"""
-    db = get_repositories(session)
-    list_in.group = current_user.group
-
-    return db.shopping_lists.create(list_in)
-
-
-@router.get("/{id}", response_model=ShoppingListOut)
-async def get_shopping_list(id: int, session: Session = Depends(generate_session)):
-    """Get Shopping List from the Database"""
-    db = get_repositories(session)
-    return db.shopping_lists.get(id)
-
-
-@router.put("/{id}", response_model=ShoppingListOut)
-async def update_shopping_list(id: int, new_data: ShoppingListIn, session: Session = Depends(generate_session)):
-    """Update Shopping List in the Database"""
-    db = get_repositories(session)
-    return db.shopping_lists.update(id, new_data)
-
-
-@router.delete("/{id}")
-async def delete_shopping_list(id: int, session: Session = Depends(generate_session)):
-    """Delete Shopping List from the Database"""
-    db = get_repositories(session)
-    return db.shopping_lists.delete(id)