feat: re-write get all routes to use pagination (#1424)

rewrite get_all routes to use a pagination pattern to allow for better implementations of search, filter, and sorting on the frontend or by any client without fetching all the data. Additionally we added a CI check for running the Nuxt built to confirm that no TS errors were present. Finally, I had to remove the header support for the Shopping lists as the browser caching based off last_updated header was not allowing it to read recent updates due to how we're handling the updated_at property in the database with nested fields. This will have to be looked at in the future to reimplement. I'm unsure how many other routes have a similar issue. 

Co-authored-by: Hayden <64056131+hay-kot@users.noreply.github.com>

mealie/routes/groups/controller_cookbooks.py

@@ -9,6 +9,8 @@ from mealie.routes._base.mixins import HttpRepo
 from mealie.routes._base.routers import MealieCrudRoute
 from mealie.schema import mapper
 from mealie.schema.cookbook import CreateCookBook, ReadCookBook, RecipeCookBook, SaveCookBook, UpdateCookBook
+from mealie.schema.cookbook.cookbook import CookBookPagination
+from mealie.schema.response.pagination import PaginationQuery
 from mealie.services.event_bus_service.event_bus_service import EventBusService, EventSource
 from mealie.services.event_bus_service.message_types import EventTypes
 
@@ -38,11 +40,15 @@ class GroupCookbookController(BaseUserController):
             self.registered_exceptions,
         )
 
-    @router.get("", response_model=list[ReadCookBook])
-    def get_all(self):
-        items = self.repo.get_all()
-        items.sort(key=lambda x: x.position)
-        return items
+    @router.get("", response_model=CookBookPagination)
+    def get_all(self, q: PaginationQuery = Depends(PaginationQuery)):
+        response = self.repo.page_all(
+            pagination=q,
+            override=ReadCookBook,
+        )
+
+        response.set_pagination_guides(router.url_path_for("get_all"), q.dict())
+        return response
 
     @router.post("", response_model=ReadCookBook, status_code=201)
     def create_one(self, data: CreateCookBook):

mealie/routes/groups/controller_group_notifications.py

@@ -13,9 +13,10 @@ from mealie.schema.group.group_events import (
     GroupEventNotifierPrivate,
     GroupEventNotifierSave,
     GroupEventNotifierUpdate,
+    GroupEventPagination,
 )
 from mealie.schema.mapper import cast
-from mealie.schema.query import GetAll
+from mealie.schema.response.pagination import PaginationQuery
 from mealie.services.event_bus_service.event_bus_service import EventBusService
 
 router = APIRouter(
@@ -41,9 +42,15 @@ class GroupEventsNotifierController(BaseUserController):
     def mixins(self) -> HttpRepo:
         return HttpRepo(self.repo, self.deps.logger, self.registered_exceptions, "An unexpected error occurred.")
 
-    @router.get("", response_model=list[GroupEventNotifierOut])
-    def get_all(self, q: GetAll = Depends(GetAll)):
-        return self.repo.get_all(start=q.start, limit=q.limit)
+    @router.get("", response_model=GroupEventPagination)
+    def get_all(self, q: PaginationQuery = Depends(PaginationQuery)):
+        response = self.repo.page_all(
+            pagination=q,
+            override=GroupEventNotifierOut,
+        )
+
+        response.set_pagination_guides(router.url_path_for("get_all"), q.dict())
+        return response
 
     @router.post("", response_model=GroupEventNotifierOut, status_code=201)
     def create_one(self, data: GroupEventNotifierCreate):

mealie/routes/groups/controller_labels.py

@@ -14,8 +14,9 @@ from mealie.schema.labels import (
     MultiPurposeLabelSummary,
     MultiPurposeLabelUpdate,
 )
+from mealie.schema.labels.multi_purpose_label import MultiPurposeLabelPagination
 from mealie.schema.mapper import cast
-from mealie.schema.query import GetAll
+from mealie.schema.response.pagination import PaginationQuery
 
 router = APIRouter(prefix="/groups/labels", tags=["Group: Multi Purpose Labels"], route_class=MealieCrudRoute)
 
@@ -36,9 +37,15 @@ class MultiPurposeLabelsController(BaseUserController):
     def mixins(self) -> HttpRepo:
         return HttpRepo(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=MultiPurposeLabelSummary)
+    @router.get("", response_model=MultiPurposeLabelPagination)
+    def get_all(self, q: PaginationQuery = Depends(PaginationQuery)):
+        response = self.repo.page_all(
+            pagination=q,
+            override=MultiPurposeLabelSummary,
+        )
+
+        response.set_pagination_guides(router.url_path_for("get_all"), q.dict())
+        return response
 
     @router.post("", response_model=MultiPurposeLabelOut)
     def create_one(self, data: MultiPurposeLabelCreate):

mealie/routes/groups/controller_mealplan_rules.py

@@ -1,5 +1,6 @@
 from functools import cached_property
 
+from fastapi import Depends
 from pydantic import UUID4
 
 from mealie.routes._base.base_controllers import BaseUserController
@@ -7,7 +8,8 @@ from mealie.routes._base.controller import controller
 from mealie.routes._base.mixins import HttpRepo
 from mealie.routes._base.routers import UserAPIRouter
 from mealie.schema import mapper
-from mealie.schema.meal_plan.plan_rules import PlanRulesCreate, PlanRulesOut, PlanRulesSave
+from mealie.schema.meal_plan.plan_rules import PlanRulesCreate, PlanRulesOut, PlanRulesPagination, PlanRulesSave
+from mealie.schema.response.pagination import PaginationQuery
 
 router = UserAPIRouter(prefix="/groups/mealplans/rules", tags=["Groups: Mealplan Rules"])
 
@@ -22,9 +24,15 @@ class GroupMealplanConfigController(BaseUserController):
     def mixins(self):
         return HttpRepo[PlanRulesCreate, PlanRulesOut, PlanRulesOut](self.repo, self.deps.logger)
 
-    @router.get("", response_model=list[PlanRulesOut])
-    def get_all(self):
-        return self.repo.get_all(override=PlanRulesOut)
+    @router.get("", response_model=PlanRulesPagination)
+    def get_all(self, q: PaginationQuery = Depends(PaginationQuery)):
+        response = self.repo.page_all(
+            pagination=q,
+            override=PlanRulesOut,
+        )
+
+        response.set_pagination_guides(router.url_path_for("get_all"), q.dict())
+        return response
 
     @router.post("", response_model=PlanRulesOut, status_code=201)
     def create_one(self, data: PlanRulesCreate):

mealie/routes/groups/controller_shopping_lists.py

@@ -6,27 +6,25 @@ from pydantic import UUID4
 from mealie.routes._base.base_controllers import BaseUserController
 from mealie.routes._base.controller import controller
 from mealie.routes._base.mixins import HttpRepo
-from mealie.routes._base.routers import MealieCrudRoute
 from mealie.schema.group.group_shopping_list import (
     ShoppingListCreate,
     ShoppingListItemCreate,
     ShoppingListItemOut,
     ShoppingListItemUpdate,
     ShoppingListOut,
+    ShoppingListPagination,
     ShoppingListSave,
     ShoppingListSummary,
     ShoppingListUpdate,
 )
 from mealie.schema.mapper import cast
-from mealie.schema.query import GetAll
+from mealie.schema.response.pagination import PaginationQuery
 from mealie.schema.response.responses import SuccessResponse
 from mealie.services.event_bus_service.event_bus_service import EventBusService, EventSource
 from mealie.services.event_bus_service.message_types import EventTypes
 from mealie.services.group_services.shopping_lists import ShoppingListService
 
-item_router = APIRouter(
-    prefix="/groups/shopping/items", tags=["Group: Shopping List Items"], route_class=MealieCrudRoute
-)
+item_router = APIRouter(prefix="/groups/shopping/items", tags=["Group: Shopping List Items"])
 
 
 @controller(item_router)
@@ -98,7 +96,6 @@ class ShoppingListItemController(BaseUserController):
 
         return shopping_list_item
 
-    @item_router.head("/{item_id}", response_model=ShoppingListItemOut)
     @item_router.get("/{item_id}", response_model=ShoppingListItemOut)
     def get_one(self, item_id: UUID4):
         return self.mixins.get_one(item_id)
@@ -148,7 +145,7 @@ class ShoppingListItemController(BaseUserController):
         return shopping_list_item
 
 
-router = APIRouter(prefix="/groups/shopping/lists", tags=["Group: Shopping Lists"], route_class=MealieCrudRoute)
+router = APIRouter(prefix="/groups/shopping/lists", tags=["Group: Shopping Lists"])
 
 
 @controller(router)
@@ -170,9 +167,15 @@ class ShoppingListController(BaseUserController):
     def mixins(self) -> HttpRepo[ShoppingListCreate, ShoppingListOut, ShoppingListSave]:
         return HttpRepo(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=ShoppingListSummary)
+    @router.get("", response_model=ShoppingListPagination)
+    def get_all(self, q: PaginationQuery = Depends(PaginationQuery)):
+        response = self.repo.page_all(
+            pagination=q,
+            override=ShoppingListSummary,
+        )
+
+        response.set_pagination_guides(router.url_path_for("get_all"), q.dict())
+        return response
 
     @router.post("", response_model=ShoppingListOut, status_code=201)
     def create_one(self, data: ShoppingListCreate):
@@ -193,7 +196,6 @@ class ShoppingListController(BaseUserController):
 
         return val
 
-    @router.head("/{item_id}", response_model=ShoppingListOut)
     @router.get("/{item_id}", response_model=ShoppingListOut)
     def get_one(self, item_id: UUID4):
         return self.mixins.get_one(item_id)

mealie/routes/groups/controller_webhooks.py

@@ -7,8 +7,8 @@ from mealie.routes._base.base_controllers import BaseUserController
 from mealie.routes._base.controller import controller
 from mealie.routes._base.mixins import HttpRepo
 from mealie.schema import mapper
-from mealie.schema.group.webhook import CreateWebhook, ReadWebhook, SaveWebhook
-from mealie.schema.query import GetAll
+from mealie.schema.group.webhook import CreateWebhook, ReadWebhook, SaveWebhook, WebhookPagination
+from mealie.schema.response.pagination import PaginationQuery
 
 router = APIRouter(prefix="/groups/webhooks", tags=["Groups: Webhooks"])
 
@@ -23,9 +23,15 @@ class ReadWebhookController(BaseUserController):
     def mixins(self) -> HttpRepo:
         return HttpRepo[CreateWebhook, SaveWebhook, CreateWebhook](self.repo, self.deps.logger)
 
-    @router.get("", response_model=list[ReadWebhook])
-    def get_all(self, q: GetAll = Depends(GetAll)):
-        return self.repo.get_all(start=q.start, limit=q.limit, override=ReadWebhook)
+    @router.get("", response_model=WebhookPagination)
+    def get_all(self, q: PaginationQuery = Depends(PaginationQuery)):
+        response = self.repo.page_all(
+            pagination=q,
+            override=ReadWebhook,
+        )
+
+        response.set_pagination_guides(router.url_path_for("get_all"), q.dict())
+        return response
 
     @router.post("", response_model=ReadWebhook, status_code=201)
     def create_one(self, data: CreateWebhook):