Michael Genson fe17922bb8
Feature: Global Timeline (#2265)
* extended query filter to accept nested tables

* decoupled timeline api from recipe slug

* modified frontend to use simplified events api

* fixed nested loop index ghosting

* updated existing tests

* gave mypy a snack

* added tests for nested queries

* fixed "last made" render error

* decoupled recipe timeline from dialog

* removed unused props

* tweaked recipe get_all to accept ids

* created group global timeline
added new timeline page to sidebar
reformatted the recipe timeline
added vertical option to recipe card mobile

* extracted timeline item into its own component

* fixed apploader centering

* added paginated scrolling to recipe timeline

* added sort direction config
fixed infinite scroll on dialog
fixed hasMore var not resetting during instantiation

* added sort direction to user preferences

* updated API docs with new query filter feature

* better error tracing

* fix for recipe not found response

* simplified recipe crud route for slug/id
added test for fetching by slug/id

* made query filter UUID validation clearer

* moved timeline menu option below shopping lists

---------

Co-authored-by: Hayden <64056131+hay-kot@users.noreply.github.com>
2023-04-25 09:46:00 -08:00

271 lines
9.8 KiB
Python

import time
from collections import defaultdict
from random import randint
from urllib.parse import parse_qsl, urlsplit
import pytest
from fastapi.testclient import TestClient
from humps import camelize
from mealie.repos.repository_factory import AllRepositories
from mealie.repos.repository_units import RepositoryUnit
from mealie.schema.recipe.recipe_ingredient import IngredientUnit, SaveIngredientUnit
from mealie.schema.response.pagination import PaginationQuery
from mealie.services.seeder.seeder_service import SeederService
from tests.utils import api_routes
from tests.utils.factories import random_int, random_string
from tests.utils.fixture_schemas import TestUser
def test_repository_pagination(database: AllRepositories, unique_user: TestUser):
group = database.groups.get_one(unique_user.group_id)
assert group
seeder = SeederService(database, None, group) # type: ignore
seeder.seed_foods("en-US")
foods_repo = database.ingredient_foods.by_group(unique_user.group_id) # type: ignore
query = PaginationQuery(
page=1,
order_by="id",
per_page=10,
)
seen = []
for _ in range(10):
results = foods_repo.page_all(query)
assert len(results.items) == 10
for result in results.items:
assert result.id not in seen
seen += [result.id for result in results.items]
query.page += 1
results = foods_repo.page_all(query)
for result in results.items:
assert result.id not in seen
def test_pagination_response_and_metadata(database: AllRepositories, unique_user: TestUser):
group = database.groups.get_one(unique_user.group_id)
assert group
seeder = SeederService(database, None, group) # type: ignore
seeder.seed_foods("en-US")
foods_repo = database.ingredient_foods.by_group(unique_user.group_id) # type: ignore
# this should get all results
query = PaginationQuery(
page=1,
per_page=-1,
)
all_results = foods_repo.page_all(query)
assert all_results.total == len(all_results.items)
# this should get the last page of results
query = PaginationQuery(
page=-1,
per_page=1,
)
last_page_of_results = foods_repo.page_all(query)
assert last_page_of_results.page == last_page_of_results.total_pages
assert last_page_of_results.items[-1] == all_results.items[-1]
def test_pagination_guides(database: AllRepositories, unique_user: TestUser):
group = database.groups.get_one(unique_user.group_id)
assert group
seeder = SeederService(database, None, group) # type: ignore
seeder.seed_foods("en-US")
foods_repo = database.ingredient_foods.by_group(unique_user.group_id) # type: ignore
foods_route = (
"/foods" # this doesn't actually have to be accurate, it's just a placeholder to test for query params
)
query = PaginationQuery(page=1, per_page=1)
first_page_of_results = foods_repo.page_all(query)
first_page_of_results.set_pagination_guides(foods_route, query.dict())
assert first_page_of_results.next is not None
assert first_page_of_results.previous is None
query = PaginationQuery(page=-1, per_page=1)
last_page_of_results = foods_repo.page_all(query)
last_page_of_results.set_pagination_guides(foods_route, query.dict())
assert last_page_of_results.next is None
assert last_page_of_results.previous is not None
random_page = randint(2, first_page_of_results.total_pages - 1)
query = PaginationQuery(page=random_page, per_page=1, filter_string="createdAt>2021-02-22")
random_page_of_results = foods_repo.page_all(query)
random_page_of_results.set_pagination_guides(foods_route, query.dict())
next_params: dict = dict(parse_qsl(urlsplit(random_page_of_results.next).query)) # type: ignore
assert int(next_params["page"]) == random_page + 1
prev_params: dict = dict(parse_qsl(urlsplit(random_page_of_results.previous).query)) # type: ignore
assert int(prev_params["page"]) == random_page - 1
source_params = camelize(query.dict())
for source_param in source_params:
assert source_param in next_params
assert source_param in prev_params
@pytest.fixture(scope="function")
def query_units(database: AllRepositories, unique_user: TestUser):
unit_1 = database.ingredient_units.create(
SaveIngredientUnit(name="test unit 1", group_id=unique_user.group_id, use_abbreviation=True)
)
# wait a moment so we can test datetime filters
time.sleep(0.25)
unit_2 = database.ingredient_units.create(
SaveIngredientUnit(name="test unit 2", group_id=unique_user.group_id, use_abbreviation=False)
)
# wait a moment so we can test datetime filters
time.sleep(0.25)
unit_3 = database.ingredient_units.create(
SaveIngredientUnit(name="test unit 3", group_id=unique_user.group_id, use_abbreviation=False)
)
unit_ids = [unit.id for unit in [unit_1, unit_2, unit_3]]
units_repo = database.ingredient_units.by_group(unique_user.group_id) # type: ignore
# make sure we can get all of our test units
query = PaginationQuery(page=1, per_page=-1)
all_units = units_repo.page_all(query).items
assert len(all_units) == 3
for unit in all_units:
assert unit.id in unit_ids
yield units_repo, unit_1, unit_2, unit_3
for unit_id in unit_ids:
units_repo.delete(unit_id)
def test_pagination_filter_basic(query_units: tuple[RepositoryUnit, IngredientUnit, IngredientUnit, IngredientUnit]):
units_repo = query_units[0]
unit_2 = query_units[2]
query = PaginationQuery(page=1, per_page=-1, query_filter='name="test unit 2"')
unit_results = units_repo.page_all(query).items
assert len(unit_results) == 1
assert unit_results[0].id == unit_2.id
def test_pagination_filter_datetimes(
query_units: tuple[RepositoryUnit, IngredientUnit, IngredientUnit, IngredientUnit]
):
units_repo = query_units[0]
unit_1 = query_units[1]
unit_2 = query_units[2]
dt = unit_2.created_at.isoformat() # type: ignore
query = PaginationQuery(page=1, per_page=-1, query_filter=f'createdAt>="{dt}"')
unit_results = units_repo.page_all(query).items
assert len(unit_results) == 2
assert unit_1.id not in [unit.id for unit in unit_results]
def test_pagination_filter_booleans(query_units: tuple[RepositoryUnit, IngredientUnit, IngredientUnit, IngredientUnit]):
units_repo = query_units[0]
unit_1 = query_units[1]
query = PaginationQuery(page=1, per_page=-1, query_filter="useAbbreviation=true")
unit_results = units_repo.page_all(query).items
assert len(unit_results) == 1
assert unit_results[0].id == unit_1.id
def test_pagination_filter_advanced(query_units: tuple[RepositoryUnit, IngredientUnit, IngredientUnit, IngredientUnit]):
units_repo = query_units[0]
unit_3 = query_units[3]
dt = str(unit_3.created_at.isoformat()) # type: ignore
qf = f'name="test unit 1" OR (useAbbreviation=f AND (name="test unit 2" OR createdAt > "{dt}"))'
query = PaginationQuery(page=1, per_page=-1, query_filter=qf)
unit_results = units_repo.page_all(query).items
assert len(unit_results) == 2
assert unit_3.id not in [unit.id for unit in unit_results]
@pytest.mark.parametrize(
"qf",
[
pytest.param('(name="test name" AND useAbbreviation=f))', id="unbalanced parenthesis"),
pytest.param('id="this is not a valid UUID"', id="invalid UUID"),
pytest.param('createdAt="this is not a valid datetime format"', id="invalid datetime format"),
pytest.param('badAttribute="test value"', id="invalid attribute"),
pytest.param('group.badAttribute="test value"', id="bad nested attribute"),
pytest.param('group.preferences.badAttribute="test value"', id="bad double nested attribute"),
],
)
def test_malformed_query_filters(api_client: TestClient, unique_user: TestUser, qf: str):
# verify that improper queries throw 400 errors
route = "/api/units"
response = api_client.get(route, params={"queryFilter": qf}, headers=unique_user.token)
assert response.status_code == 400
def test_pagination_filter_nested(api_client: TestClient, user_tuple: list[TestUser]):
# create a few recipes for each user
slugs: defaultdict[int, list[str]] = defaultdict(list)
for i, user in enumerate(user_tuple):
for _ in range(random_int(3, 5)):
slug: str = random_string()
response = api_client.post(api_routes.recipes, json={"name": slug}, headers=user.token)
assert response.status_code == 201
slugs[i].append(slug)
# query recipes with a nested user filter
recipe_ids: defaultdict[int, list[str]] = defaultdict(list)
for i, user in enumerate(user_tuple):
params = {"page": 1, "perPage": -1, "queryFilter": f'user.id="{user.user_id}"'}
response = api_client.get(api_routes.recipes, params=params, headers=user.token)
assert response.status_code == 200
recipes_data: list[dict] = response.json()["items"]
assert recipes_data
for recipe_data in recipes_data:
slug = recipe_data["slug"]
assert slug in slugs[i]
assert slug not in slugs[(i + 1) % len(user_tuple)]
recipe_ids[i].append(recipe_data["id"])
# query timeline events with a double nested recipe.user filter
for i, user in enumerate(user_tuple):
params = {"page": 1, "perPage": -1, "queryFilter": f'recipe.user.id="{user.user_id}"'}
response = api_client.get(api_routes.recipes_timeline_events, params=params, headers=user.token)
assert response.status_code == 200
events_data: list[dict] = response.json()["items"]
assert events_data
for event_data in events_data:
recipe_id = event_data["recipeId"]
assert recipe_id in recipe_ids[i]
assert recipe_id not in recipe_ids[(i + 1) % len(user_tuple)]