almebic migrations and items filters in get endpoint

Author: jrmcauliffe00

backend/app/alembic/versions/bc408f47ce8b_add_metadata_fields_to_item.py

@@ -0,0 +1,53 @@
+"""Add metadata fields to Item
+
+Revision ID: bc408f47ce8b
+Revises: 1a31ce608336
+Create Date: 2025-06-16 19:13:48.082374
+
+"""
+from alembic import op
+import sqlalchemy as sa
+import sqlmodel.sql.sqltypes
+
+
+# revision identifiers, used by Alembic.
+revision = 'bc408f47ce8b'
+down_revision = '1a31ce608336'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('item', sa.Column('location', sqlmodel.sql.sqltypes.AutoString(length=255), nullable=True))
+    op.add_column('item', sa.Column('price', sqlmodel.sql.sqltypes.AutoString(length=255), nullable=True))
+    op.add_column('item', sa.Column('difficulty', sqlmodel.sql.sqltypes.AutoString(length=255), nullable=True))
+    op.add_column('item', sa.Column('type', sqlmodel.sql.sqltypes.AutoString(length=255), nullable=True))
+    op.add_column('item', sa.Column('category', sqlmodel.sql.sqltypes.AutoString(length=255), nullable=True))
+    op.add_column('item', sa.Column('tags', sa.ARRAY(sa.String()), nullable=True))
+    op.add_column('item', sa.Column('link', sqlmodel.sql.sqltypes.AutoString(length=255), nullable=True))
+    op.add_column('item', sa.Column('picture', sqlmodel.sql.sqltypes.AutoString(length=255), nullable=True))
+    op.add_column('item', sa.Column('in_featured', sa.Boolean(), nullable=False))
+    op.add_column('item', sa.Column('rating', sa.Float(), nullable=True))
+    op.add_column('item', sa.Column('tries', sa.Integer(), nullable=True))
+    op.add_column('item', sa.Column('favorites', sa.Integer(), nullable=True))
+    op.add_column('item', sa.Column('duration', sa.Interval(), nullable=True))
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column('item', 'favorites')
+    op.drop_column('item', 'tries')
+    op.drop_column('item', 'rating')
+    op.drop_column('item', 'in_featured')
+    op.drop_column('item', 'picture')
+    op.drop_column('item', 'link')
+    op.drop_column('item', 'tags')
+    op.drop_column('item', 'category')
+    op.drop_column('item', 'type')
+    op.drop_column('item', 'difficulty')
+    op.drop_column('item', 'price')
+    op.drop_column('item', 'location')
+    op.drop_column('item', 'duration')
+    # ### end Alembic commands ###

backend/app/alembic/versions/f77762e21457_add_column_to_item_model.py

@@ -0,0 +1,29 @@
+"""Add column to item model
+
+Revision ID: f77762e21457
+Revises: bc408f47ce8b
+Create Date: 2025-06-25 14:30:07.278621
+
+"""
+from alembic import op
+import sqlalchemy as sa
+import sqlmodel.sql.sqltypes
+
+
+# revision identifiers, used by Alembic.
+revision = 'f77762e21457'
+down_revision = 'bc408f47ce8b'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('item', sa.Column('duration', sa.Interval(), nullable=True))
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column('item', 'duration')
+    # ### end Alembic commands ###

backend/app/api/routes/items.py

@@ -1,11 +1,13 @@
 import uuid
+import datetime
 from typing import Any
 
 from fastapi import APIRouter, HTTPException
+from pydantic import BaseModel
 from sqlmodel import func, select
 
 from app.api.deps import CurrentUser, SessionDep
-from app.models import Item, ItemCreate, ItemPublic, ItemsPublic, ItemUpdate, Message
+from app.models import Item, ItemBase, ItemCreate, ItemPublic, ItemsPublic, ItemUpdate, Message
 from app.openfga.fgaMiddleware import check_user_has_relation, create_fga_tuple, delete_fga_tuple, initialize_fga_client
 from app.openfga.fgaMiddleware import check_user_has_permission
 from openfga_sdk.client.models.tuple import ClientTuple
@@ -15,40 +17,97 @@
 
 @router.get("/", response_model=ItemsPublic)
 def read_items(
-    session: SessionDep, current_user: CurrentUser, skip: int = 0, limit: int = 100, get_completed: bool = False
+    session: SessionDep,
+    current_user: CurrentUser,
+    skip: int = 0,
+    limit: int = 100,
+    get_completed: bool = False,
+    get_owned: bool = False,
+    title: str | None = None,
+    description: str | None = None,
+    location: str | None = None,
+    price: str | None = None,
+    difficulty: str | None = None,
+    type: str | None = None,
+    category: str | None = None,
+    tags: list[str] | None = None,
+    link: str | None = None,
+    picture: str | None = None,
+    in_featured: bool | None = None,
+    rating: float | None = None,
+    tries: int | None = None,
+    favorites: int | None = None,
+    duration: datetime.timedelta | None = None,
 ) -> Any:
     """
     Retrieve items.
     """
     fga_client = initialize_fga_client()
 
-    if current_user.is_superuser:
-        count_statement = select(func.count()).select_from(Item)
-        count = session.exec(count_statement).one()
-        statement = select(Item).offset(skip).limit(limit)
-        items = session.exec(statement).all()
+    # Database filters
+    if title or description or location or price or difficulty or type or category or tags or link or picture or in_featured or rating or tries or favorites or duration:
+        query = select(Item)
+        # instead of appending to filters, we can use a where builder results = session.exec(query).all()
+        if title:
+            query = query.where(Item.title == title)
+        if description:
+            query = query.where(Item.description == description)
+        if location:
+            query = query.where(Item.location == location)
+        if price:
+            query = query.where(Item.price == price)
+        if difficulty:
+            query = query.where(Item.difficulty == difficulty)
+        if type:
+            query = query.where(Item.type == type)
+        if category:
+            query = query.where(Item.category == category)
+        if tags:
+            query = query.where(Item.tags == tags)
+        if link:
+            query = query.where(Item.link == link)
+        if picture:
+            query = query.where(Item.picture == picture)
+        if in_featured:
+            query = query.where(Item.in_featured == in_featured)
+        if rating:
+            query = query.where(Item.rating == rating)
+        if tries:
+            query = query.where(Item.tries == tries)
+        if favorites:
+            query = query.where(Item.favorites == favorites)
+        if duration:
+            query = query.where(Item.duration == duration)
+
+        query = query.offset(skip).limit(limit)
+        items = session.exec(query).all()
+        count = len(items)
     else:
-        count_statement = (
-            select(func.count())
-            .select_from(Item)
-            # .where(Item.owner_id == current_user.id) # only returns items that the user owns
-        )
-        count = session.exec(count_statement).one()
+        # get all items
+        count = session.exec(select(func.count()).select_from(Item)).one()
         statement = (
             select(Item)
-            # .where(Item.owner_id == current_user.id)
             .offset(skip)
             .limit(limit)
         )
         items = session.exec(statement).all()
+
+    # FGA filters
+    if get_owned:
+        item_ids = check_user_has_relation(fga_client, relation="owner", user=f"{current_user.email}")
+        if len(item_ids) == 0:
+            return ItemsPublic(data=[], count=0)
+        else:
+            # filter items to only those that match the item_ids
+            items = [item for item in items if str(item.id) in item_ids]
 
     if get_completed:
         item_ids = check_user_has_relation(fga_client, relation="completed", user=f"{current_user.email}")
         if len(item_ids) == 0:
             return ItemsPublic(data=[], count=0)
         else:
             # get those items with those ids
-            items = [session.get(Item, id) for id in item_ids]
+            items = [item for item in items if str(item.id) in item_ids]
 
     return ItemsPublic(data=[ItemPublic.model_validate(item) for item in items], count=count)
 
@@ -150,3 +209,4 @@ async def delete_item(
     delete_fga_tuple(fga_client, [ClientTuple(user=f"user:{current_user.id}", relation="owner", object=f"item:{id}")])
 
     return Message(message="Item deleted successfully")
+