feat: timeline event for mealplans (#2050)

* added related user to mealplans

* made timeline event message actually optional

* added task to create events for mealplan recipes

* replaced fk constraint ops with bulk ops

* fixed event creation and adjusted query range

* indentation is hard

* added missing recipe id query filter

* added tests

tests/unit_tests/services_tests/backup_v2_tests/test_alchemy_exporter.py

@@ -4,7 +4,7 @@ from mealie.core.config import get_app_settings
 from mealie.services.backups_v2.alchemy_exporter import AlchemyExporter
 
 ALEMBIC_VERSIONS = [
-    {"version_num": "167eb69066ad"},
+    {"version_num": "165d943c64ee"},
 ]
 
 

tests/unit_tests/services_tests/scheduler/tasks/test_create_timeline_events.py

@@ -0,0 +1,186 @@
+from datetime import date, datetime, timedelta
+
+from fastapi.testclient import TestClient
+from pydantic import UUID4
+
+from mealie.schema.meal_plan.new_meal import CreatePlanEntry
+from mealie.schema.recipe.recipe import RecipeSummary
+from mealie.services.scheduler.tasks.create_timeline_events import (
+    create_mealplan_timeline_events,
+)
+from tests import utils
+from tests.utils import api_routes
+from tests.utils.factories import random_int, random_string
+from tests.utils.fixture_schemas import TestUser
+
+
+def test_no_mealplans():
+    # make sure this task runs successfully even if it doesn't do anything
+    create_mealplan_timeline_events()
+
+
+def test_new_mealplan_event(api_client: TestClient, unique_user: TestUser):
+    recipe_name = random_string(length=25)
+    response = api_client.post(api_routes.recipes, json={"name": recipe_name}, headers=unique_user.token)
+    assert response.status_code == 201
+
+    response = api_client.get(api_routes.recipes_slug(recipe_name), headers=unique_user.token)
+    recipe = RecipeSummary.parse_obj(response.json())
+    recipe_id = recipe.id
+    assert recipe.last_made is None
+
+    # store the number of events, so we can compare later
+    response = api_client.get(api_routes.recipes_slug_timeline_events(recipe_name), headers=unique_user.token)
+    response_json = response.json()
+    initial_event_count = len(response_json["items"])
+
+    new_plan = CreatePlanEntry(date=date.today(), entry_type="dinner", recipe_id=recipe_id).dict(by_alias=True)
+    new_plan["date"] = date.today().isoformat()
+    new_plan["recipeId"] = str(recipe_id)
+
+    response = api_client.post(api_routes.groups_mealplans, json=new_plan, headers=unique_user.token)
+    assert response.status_code == 201
+
+    # run the task and check to make sure a new event was created from the mealplan
+    create_mealplan_timeline_events()
+
+    params = {"page": "1", "perPage": "-1", "orderBy": "created_at", "orderDirection": "desc"}
+    response = api_client.get(
+        api_routes.recipes_slug_timeline_events(recipe_name), headers=unique_user.token, params=params
+    )
+    response_json = response.json()
+    assert len(response_json["items"]) == initial_event_count + 1
+
+    # make sure the mealplan entry type is in the subject
+    event = response_json["items"][0]
+    assert new_plan["entryType"].lower() in event["subject"].lower()
+
+    # make sure the recipe's last made date was updated
+    response = api_client.get(api_routes.recipes_slug(recipe_name), headers=unique_user.token)
+    recipe = RecipeSummary.parse_obj(response.json())
+    assert recipe.last_made.date() == date.today()  # type: ignore
+
+
+def test_new_mealplan_event_duplicates(api_client: TestClient, unique_user: TestUser):
+    recipe_name = random_string(length=25)
+    response = api_client.post(api_routes.recipes, json={"name": recipe_name}, headers=unique_user.token)
+    assert response.status_code == 201
+
+    response = api_client.get(api_routes.recipes_slug(recipe_name), headers=unique_user.token)
+    recipe = RecipeSummary.parse_obj(response.json())
+    recipe_id = recipe.id
+
+    # store the number of events, so we can compare later
+    response = api_client.get(api_routes.recipes_slug_timeline_events(recipe_name), headers=unique_user.token)
+    response_json = response.json()
+    initial_event_count = len(response_json["items"])
+
+    new_plan = CreatePlanEntry(date=date.today(), entry_type="dinner", recipe_id=recipe_id).dict(by_alias=True)
+    new_plan["date"] = date.today().isoformat()
+    new_plan["recipeId"] = str(recipe_id)
+
+    response = api_client.post(api_routes.groups_mealplans, json=new_plan, headers=unique_user.token)
+    assert response.status_code == 201
+
+    # run the task multiple times and make sure we only create one event
+    for _ in range(3):
+        create_mealplan_timeline_events()
+
+    params = {"page": "1", "perPage": "-1", "orderBy": "created_at", "orderDirection": "desc"}
+    response = api_client.get(
+        api_routes.recipes_slug_timeline_events(recipe_name), headers=unique_user.token, params=params
+    )
+    response_json = response.json()
+    assert len(response_json["items"]) == initial_event_count + 1
+
+
+def test_new_mealplan_events_with_multiple_recipes(api_client: TestClient, unique_user: TestUser):
+    recipes: list[RecipeSummary] = []
+    for _ in range(3):
+        recipe_name = random_string(length=25)
+        response = api_client.post(api_routes.recipes, json={"name": recipe_name}, headers=unique_user.token)
+        assert response.status_code == 201
+
+        response = api_client.get(api_routes.recipes_slug(recipe_name), headers=unique_user.token)
+        recipes.append(RecipeSummary.parse_obj(response.json()))
+
+    # store the number of events, so we can compare later
+    response = api_client.get(api_routes.recipes_slug_timeline_events(str(recipes[0].slug)), headers=unique_user.token)
+    response_json = response.json()
+    initial_event_count = len(response_json["items"])
+
+    # create a few mealplans for each recipe
+    mealplan_count_by_recipe_id: dict[UUID4, int] = {}
+    for recipe in recipes:
+        mealplan_count_by_recipe_id[recipe.id] = 0  # type: ignore
+        for _ in range(random_int(1, 5)):
+            new_plan = CreatePlanEntry(date=date.today(), entry_type="dinner", recipe_id=str(recipe.id)).dict(
+                by_alias=True
+            )
+            new_plan["date"] = date.today().isoformat()
+            new_plan["recipeId"] = str(recipe.id)
+
+            response = api_client.post(api_routes.groups_mealplans, json=new_plan, headers=unique_user.token)
+            assert response.status_code == 201
+            mealplan_count_by_recipe_id[recipe.id] += 1  # type: ignore
+
+    # run the task once and make sure the event counts are correct
+    create_mealplan_timeline_events()
+
+    for recipe in recipes:
+        target_count = initial_event_count + mealplan_count_by_recipe_id[recipe.id]  # type: ignore
+        params = {"page": "1", "perPage": "-1", "orderBy": "created_at", "orderDirection": "desc"}
+        response = api_client.get(
+            api_routes.recipes_slug_timeline_events(recipe.slug), headers=unique_user.token, params=params
+        )
+        response_json = response.json()
+        assert len(response_json["items"]) == target_count
+
+    # run the task a few more times and confirm the counts are the same
+    for _ in range(3):
+        create_mealplan_timeline_events()
+
+    for recipe in recipes:
+        target_count = initial_event_count + mealplan_count_by_recipe_id[recipe.id]  # type: ignore
+        params = {
+            "page": "1",
+            "perPage": "-1",
+            "orderBy": "created_at",
+            "orderDirection": "desc",
+        }
+        response = api_client.get(
+            api_routes.recipes_slug_timeline_events(recipe.slug), headers=unique_user.token, params=params
+        )
+        response_json = response.json()
+        assert len(response_json["items"]) == target_count
+
+
+def test_preserve_future_made_date(api_client: TestClient, unique_user: TestUser):
+    recipe_name = random_string(length=25)
+    response = api_client.post(api_routes.recipes, json={"name": recipe_name}, headers=unique_user.token)
+    assert response.status_code == 201
+
+    response = api_client.get(api_routes.recipes_slug(recipe_name), headers=unique_user.token)
+    recipe = RecipeSummary.parse_obj(response.json())
+    recipe_id = str(recipe.id)
+
+    future_dt = datetime.now() + timedelta(days=random_int(1, 10))
+    recipe.last_made = future_dt
+    response = api_client.put(
+        api_routes.recipes_slug(recipe.slug), json=utils.jsonify(recipe), headers=unique_user.token
+    )
+    assert response.status_code == 200
+
+    new_plan = CreatePlanEntry(date=date.today(), entry_type="dinner", recipe_id=recipe_id).dict(by_alias=True)
+    new_plan["date"] = date.today().isoformat()
+    new_plan["recipeId"] = str(recipe_id)
+
+    response = api_client.post(api_routes.groups_mealplans, json=new_plan, headers=unique_user.token)
+    assert response.status_code == 201
+
+    # run the task and make sure the recipe's last made date was not updated
+    create_mealplan_timeline_events()
+
+    response = api_client.get(api_routes.recipes_slug(recipe_name), headers=unique_user.token)
+    recipe = RecipeSummary.parse_obj(response.json())
+    assert recipe.last_made == future_dt