feat: add support for API extras on shopping lists, shopping list items, and food data (#1619)

* added api extras to other tables
genericized api extras model from recipes
added extras column to ingredient foods
added extras column to shopping lists
added extras column to shopping list items

* updated alembic version test

* made mypy happy

* added TODO on test that does nothing

* added extras tests for lists, items, and foods

* added docs for new extras

* modified alembic versions to eliminate branching

tests/integration_tests/user_group_tests/test_group_shopping_list_items.py

@@ -1,6 +1,7 @@
 import random
 from uuid import uuid4
 
+import pytest
 from fastapi.testclient import TestClient
 from pydantic import UUID4
 
@@ -14,10 +15,12 @@ class Routes:
     shopping = "/api/groups/shopping"
     items = shopping + "/items"
 
-    def item(item_id: str) -> str:
+    @staticmethod
+    def item(item_id: str | UUID4) -> str:
         return f"{Routes.items}/{item_id}"
 
-    def shopping_list(list_id: str) -> str:
+    @staticmethod
+    def shopping_list(list_id: str | UUID4) -> str:
         return f"{Routes.shopping}/lists/{list_id}"
 
 
@@ -162,9 +165,9 @@ def test_shopping_list_items_update_many_reorder(
     response = api_client.get(Routes.shopping_list(list_with_items.id), headers=unique_user.token)
     response_list = utils.assert_derserialize(response, 200)
 
-    for i, item in enumerate(response_list["listItems"]):
-        assert item["position"] == i
-        assert item["id"] == str(list_items[i].id)
+    for i, item_data in enumerate(response_list["listItems"]):
+        assert item_data["position"] == i
+        assert item_data["id"] == str(list_items[i].id)
 
 
 def test_shopping_list_items_update_many_consolidates_common_items(
@@ -194,6 +197,7 @@ def test_shopping_list_items_update_many_consolidates_common_items(
     assert response_list["listItems"][0]["note"] == master_note
 
 
+@pytest.mark.skip("TODO: Implement")
 def test_shopping_list_items_update_many_remove_recipe_with_other_items(
     api_client: TestClient,
     unique_user: TestUser,
@@ -201,3 +205,38 @@ def test_shopping_list_items_update_many_remove_recipe_with_other_items(
 ) -> None:
     # list_items = list_with_items.list_items
     pass
+
+
+def test_shopping_list_item_extras(
+    api_client: TestClient, unique_user: TestUser, shopping_list: ShoppingListOut
+) -> None:
+    key_str_1 = random_string()
+    val_str_1 = random_string()
+
+    key_str_2 = random_string()
+    val_str_2 = random_string()
+
+    # create an item with extras
+    new_item_data = create_item(shopping_list.id)
+    new_item_data["extras"] = {key_str_1: val_str_1}
+
+    response = api_client.post(Routes.items, json=new_item_data, headers=unique_user.token)
+    item_as_json = utils.assert_derserialize(response, 201)
+
+    # make sure the extra persists
+    extras = item_as_json["extras"]
+    assert key_str_1 in extras
+    assert extras[key_str_1] == val_str_1
+
+    # add more extras to the item
+    item_as_json["extras"][key_str_2] = val_str_2
+
+    response = api_client.put(Routes.item(item_as_json["id"]), json=item_as_json, headers=unique_user.token)
+    item_as_json = utils.assert_derserialize(response, 200)
+
+    # make sure both the new extra and original extra persist
+    extras = item_as_json["extras"]
+    assert key_str_1 in extras
+    assert key_str_2 in extras
+    assert extras[key_str_1] == val_str_1
+    assert extras[key_str_2] == val_str_2

tests/integration_tests/user_group_tests/test_group_shopping_lists.py

@@ -1,6 +1,7 @@
 import random
 
 from fastapi.testclient import TestClient
+from pydantic import UUID4
 
 from mealie.schema.group.group_shopping_list import ShoppingListOut
 from mealie.schema.recipe.recipe import Recipe
@@ -12,17 +13,19 @@ from tests.utils.fixture_schemas import TestUser
 class Routes:
     base = "/api/groups/shopping/lists"
 
-    def item(item_id: str) -> str:
+    @staticmethod
+    def item(item_id: str | UUID4) -> str:
         return f"{Routes.base}/{item_id}"
 
-    def add_recipe(item_id: str, recipe_id: str) -> str:
+    @staticmethod
+    def add_recipe(item_id: str | UUID4, recipe_id: str | UUID4) -> str:
         return f"{Routes.item(item_id)}/recipe/{recipe_id}"
 
 
 def test_shopping_lists_get_all(api_client: TestClient, unique_user: TestUser, shopping_lists: list[ShoppingListOut]):
-    all_lists = api_client.get(Routes.base, headers=unique_user.token)
-    assert all_lists.status_code == 200
-    all_lists = all_lists.json()["items"]
+    response = api_client.get(Routes.base, headers=unique_user.token)
+    assert response.status_code == 200
+    all_lists = response.json()["items"]
 
     assert len(all_lists) == len(shopping_lists)
 
@@ -199,3 +202,39 @@ def test_shopping_lists_remove_recipe_multiple_quantity(
     refs = as_json["recipeReferences"]
     assert len(refs) == 1
     assert refs[0]["recipeId"] == str(recipe.id)
+
+
+def test_shopping_list_extras(
+    api_client: TestClient,
+    unique_user: TestUser,
+):
+    key_str_1 = random_string()
+    val_str_1 = random_string()
+
+    key_str_2 = random_string()
+    val_str_2 = random_string()
+
+    # create a list with extras
+    new_list_data: dict = {"name": random_string()}
+    new_list_data["extras"] = {key_str_1: val_str_1}
+
+    response = api_client.post(Routes.base, json=new_list_data, headers=unique_user.token)
+    list_as_json = utils.assert_derserialize(response, 201)
+
+    # make sure the extra persists
+    extras = list_as_json["extras"]
+    assert key_str_1 in extras
+    assert extras[key_str_1] == val_str_1
+
+    # add more extras to the list
+    list_as_json["extras"][key_str_2] = val_str_2
+
+    response = api_client.put(Routes.item(list_as_json["id"]), json=list_as_json, headers=unique_user.token)
+    list_as_json = utils.assert_derserialize(response, 200)
+
+    # make sure both the new extra and original extra persist
+    extras = list_as_json["extras"]
+    assert key_str_1 in extras
+    assert key_str_2 in extras
+    assert extras[key_str_1] == val_str_1
+    assert extras[key_str_2] == val_str_2