Merge pull request #883 from rommapp/rom-fetch-perf

Improved performance of Rom DB fetch

backend/endpoints/responses/assets.py

@@ -31,7 +31,6 @@ class ScreenshotSchema(BaseAsset):
 class UploadedScreenshotsResponse(TypedDict):
     uploaded: int
     screenshots: list[ScreenshotSchema]
-    url_screenshots: list[str]
     merged_screenshots: list[str]
 
 

backend/endpoints/responses/rom.py

@@ -93,16 +93,8 @@ class RomSchema(BaseModel):
 
     multi: bool
     files: list[str]
-    url_screenshots: list[str]
-    merged_screenshots: list[str]
     full_path: str
 
-    sibling_roms: list["RomSchema"] = Field(default_factory=list)
-    user_saves: list[SaveSchema] = Field(default_factory=list)
-    user_states: list[StateSchema] = Field(default_factory=list)
-    user_screenshots: list[ScreenshotSchema] = Field(default_factory=list)
-    user_notes: list[RomNoteSchema] = Field(default_factory=list)
-
     class Config:
         from_attributes = True
 
@@ -119,8 +111,17 @@ def sort_comparator(self) -> str:
             .lower()
         )
 
+
+class DetailedRomSchema(RomSchema):
+    merged_screenshots: list[str]
+    sibling_roms: list["RomSchema"] = Field(default_factory=list)
+    user_saves: list[SaveSchema] = Field(default_factory=list)
+    user_states: list[StateSchema] = Field(default_factory=list)
+    user_screenshots: list[ScreenshotSchema] = Field(default_factory=list)
+    user_notes: list[RomNoteSchema] = Field(default_factory=list)
+
     @classmethod
-    def from_orm_with_request(cls, db_rom: Rom, request: Request) -> "RomSchema":
+    def from_orm_with_request(cls, db_rom: Rom, request: Request) -> "DetailedRomSchema":
         rom = cls.model_validate(db_rom)
         user_id = request.user.id
 

backend/endpoints/responses/search.py

@@ -9,4 +9,3 @@ class SearchRomSchema(BaseModel):
     summary: str
     igdb_url_cover: str = ""
     moby_url_cover: str = ""
-    url_screenshots: list[str]

backend/endpoints/rom.py

@@ -10,6 +10,7 @@
     AddRomsResponse,
     CustomStreamingResponse,
     RomSchema,
+    DetailedRomSchema,
     RomNoteSchema,
 )
 from exceptions.fs_exceptions import RomAlreadyExistsException
@@ -119,17 +120,17 @@ def get_roms(
     "/roms/{id}",
     [] if DISABLE_DOWNLOAD_ENDPOINT_AUTH else ["roms.read"],
 )
-def get_rom(request: Request, id: int) -> RomSchema:
+def get_rom(request: Request, id: int) -> DetailedRomSchema:
     """Get rom endpoint
 
     Args:
         request (Request): Fastapi Request object
         id (int): Rom internal id
 
     Returns:
-        RomSchema: Rom stored in the database
+        DetailedRomSchema: Rom stored in the database
     """
-    return RomSchema.from_orm_with_request(db_rom_handler.get_roms(id), request)
+    return DetailedRomSchema.from_orm_with_request(db_rom_handler.get_roms(id), request)
 
 
 @protected_route(
@@ -248,7 +249,7 @@ async def update_rom(
     rename_as_igdb: bool = False,
     remove_cover: bool = False,
     artwork: Optional[UploadFile] = File(None),
-) -> RomSchema:
+) -> DetailedRomSchema:
     """Update rom endpoint
 
     Args:
@@ -261,7 +262,7 @@ async def update_rom(
         HTTPException: If a rom already have that name when enabling the rename_as_igdb flag
 
     Returns:
-        RomSchema: Rom stored in the database
+        DetailedRomSchema: Rom stored in the database
     """
 
     data = await request.form()
@@ -375,7 +376,7 @@ async def update_rom(
 
     db_rom_handler.update_rom(id, cleaned_data)
 
-    return db_rom_handler.get_roms(id)
+    return DetailedRomSchema.from_orm_with_request(db_rom_handler.get_roms(id), request)
 
 
 @protected_route(router.post, "/roms/delete", ["roms.write"])

backend/endpoints/screenshots.py

@@ -55,6 +55,5 @@ def add_screenshots(
     return {
         "uploaded": len(screenshots),
         "screenshots": [s for s in rom.screenshots if s.user_id == current_user.id],
-        "url_screenshots": rom.url_screenshots,
         "merged_screenshots": rom.merged_screenshots,
     }

backend/endpoints/search.py

@@ -97,7 +97,6 @@ async def search_rom(
                 "summary": "",
                 "igdb_url_cover": "",
                 "moby_url_cover": "",
-                "url_screenshots": [],
             },
             **item,
         }

backend/endpoints/tests/test_rom.py

@@ -1,4 +1,3 @@
-import json
 from fastapi.testclient import TestClient
 from unittest.mock import patch
 
@@ -45,12 +44,6 @@ def test_update_rom(rename_file_mock, get_rom_by_id_mock, access_token, rom):
             "file_name": "Metroid Prime Remastered.zip",
             "summary": "summary test",
             "url_cover": "https://images.igdb.com/igdb/image/upload/t_cover_big/co2l7z.jpg",
-            "url_screenshots": json.dumps(
-                [
-                    "https://images.igdb.com/igdb/image/upload/t_original/qhiqlmwvvuaqxxn4cxlr.jpg",
-                    "https://images.igdb.com/igdb/image/upload/t_original/kqkixazzsokqgoxmuish.jpg",
-                ]
-            ),
             "genres": '[{"id": 5, "name": "Shooter"}, {"id": 8, "name": "Platform"}, {"id": 31, "name": "Adventure"}]',
             "franchises": '[{"id": 756, "name": "Metroid"}]',
             "collections": '[{"id": 243, "name": "Metroid"}, {"id": 6240, "name": "Metroid Prime"}]',

backend/models/rom.py

@@ -17,6 +17,9 @@
     DateTime,
     func,
     UniqueConstraint,
+    select,
+    and_,
+    or_,
 )
 from sqlalchemy.orm import Mapped, relationship
 
@@ -108,14 +111,17 @@ def merged_screenshots(self) -> list[str]:
     def get_sibling_roms(self) -> list["Rom"]:
         from handler.database import db_rom_handler
 
-        if not self.igdb_id:
-            return []
-
         with db_rom_handler.session.begin() as session:
             return session.scalars(
-                db_rom_handler.get_roms(platform_id=self.platform_id).filter(
-                    Rom.id != self.id,
-                    Rom.igdb_id == self.igdb_id,
+                select(Rom).where(
+                    and_(
+                        Rom.platform_id == self.platform_id,
+                        Rom.id != self.id,
+                        or_(
+                            and_(Rom.igdb_id == self.igdb_id, Rom.igdb_id != None),  # noqa
+                            and_(Rom.moby_id == self.moby_id, Rom.moby_id != None),  # noqa
+                        ),
+                    )
                 )
             ).all()
 

frontend/src/App.vue

@@ -7,7 +7,7 @@ import socket from "@/services/socket";
 import storeConfig from "@/stores/config";
 import storeGalleryFilter from "@/stores/galleryFilter";
 import storeHeartbeat from "@/stores/heartbeat";
-import storeRoms, { type Rom } from "@/stores/roms";
+import storeRoms, { type SimpleRom } from "@/stores/roms";
 import storePlatforms from "@/stores/platforms";
 import storeAuth from "@/stores/auth";
 import storeScanning from "@/stores/scanning";
@@ -42,7 +42,7 @@ socket.on(
   }
 );
 
-socket.on("scan:scanning_rom", (rom: Rom) => {
+socket.on("scan:scanning_rom", (rom: SimpleRom) => {
   scanningStore.set(true);
   if (romsStore.platformID === rom.platform_id) {
     romsStore.add([rom]);