- POST `/api/v1/households/{householdSlug}/meals/{mealId}/consumed` marks a meal consumed within the household; validates timezone on provided `consumedDate`; clears outstanding meal requests only within that household.
- Tests: `tests/test_meals_consumed_v2.py` validates scoping (requests cleared in same household, unaffected in other household). PASS.
- POST `/api/v1/households/{householdSlug}/shopping/current/meals/me` requests a meal under the household scope; visible only within that household in GET current.
- DELETE `/api/v1/households/{householdSlug}/shopping/current/meals/{mealId}` unrequests the meal (scoped) and returns `{ ok: true }`.
- Tests: `tests/test_shopping_request_meal_v2.py` validates request/unrequest isolation across households. PASS.
This document has been validated against the current codebase (v1) to ensure the plan captures all required changes. It starts with a concise baseline of what exists today, then details the v2 multi-tenancy/auth refactor with concrete, file-scoped steps and acceptance criteria.
- GET `/api/v1/meals/upcoming?from&to` → upcoming unconsumed meals in range; bulk loads participants, recipes, extra ingredients.
- GET `/api/v1/meals/{id}` → meal with participants/recipes/extra ingredients.
- POST `/api/v1/meals` → validate meal, insert participants, recipes, extra ingredients; sets `Location` header.
- PUT `/api/v1/meals/{id}` → validate/update and return current state.
- POST `/api/v1/meals/{id}/consumed` (auth required) → marks consumed; requires timezone in `consumed_date` if provided; removes any shopping requests for the meal.
- DELETE `/api/v1/meals/{id}` (auth required) → soft-delete meal via shopping cleanup then update.
- Shopping (`api/shopping.py`)
- GET `/api/v1/shopping/current` → aggregate of outstanding ingredient requests (no auth), requested meals, purchased items, plus lookup maps (`meals`, `recipes`, `ingredients`, and any referenced purchased lists). Outward storeName enum uses `"home"` for internal empty string.
- GET `/api/v1/shopping/{listId}` → purchased shopping list + lookups; 404 if not found.
- POST `/api/v1/shopping` (auth required) → purchase list with items; validates invariants in repository; returns full list + lookups. Missing/invalid cookie maps to 401 (special-case).
- GET `/api/v1/shopping/current/me/ingredients` (auth required) → outstanding ingredient requests for me (personId from cookie).
- POST `/api/v1/shopping/current/me/ingredients` (auth required) → sync my ingredient requests (add missing, remove extra). Matches existing entries by `id` or `line`.
- POST `/api/v1/shopping/current/meals/me` (auth required) → request a meal; 404 if meal not found; prevents duplicates.
- DELETE `/api/v1/shopping/current/meals/{mealId}` (auth required) → unrequest a meal; 404 if meal not found.
### 0.3 Data model (SQLite, created by `db.create()`)
- Person(id PK, name UNIQUE)
- Recipe(id PK, name, link, serves, image_urls TEXT JSON, based_on_recipe FK, date_created, created_by_id FK NOT NULL, date_hidden, hidden_by_id FK)
- ProblemDetails content-type returned for 400/404/422.
- Pagination: `cursor` is treated leniently (invalid → start). `prevCursor` is computed by a DB helper; `total` is non-null integer.
- Recipe creation requires ≥1 ingredient; soft-deletes older version when updating.
- Meals validation (`api.meals.validate_meal`):
- Must have ≥1 chef, ≥1 cleanup, ≥1 consumer.
- Must have either at least one recipe or at least one extra ingredient.
- No duplicate participants by role.
- Each MealRecipe.servings must be > 0.
- POST `{id}` and body.id must match for update.
- Shopping invariants (`shopping.repository`):
- Purchase requires `purchased_by_id` and ≥1 item.
- Requests: exactly one of (ingredient|meal); person required; ingredient requests must have valid ingredient id (or be inserted when syncing); meal request must not already exist; purchased meal auto-updates `purchase_date` and clears requests when all meal ingredients are covered by list items.
v2 household-scoped API is complete and v1 has been removed from the app. Tests have been migrated to v2 equivalents or disabled when purely legacy. OpenAPI reflects JWT bearer and household scoping.
Refactor the backend from a single-tenant architecture to a robust, multi-tenant system based on "Households". This requires evolving the data model to enforce data isolation, overhauling the authentication system to support standard credential types, and introducing an invitation mechanism for household management. This plan is adapted to the existing codebase.
## 2. Core Concepts & Data Model
- **Data Isolation**: All primary resources (`recipes`, `meals`, `shopping_lists`, etc.) MUST be strictly scoped to a `household_id`. No API endpoint should ever return data from a household the authenticated user does not belong to.
- **User vs. Person**: The existing `persons` table and `Person` model will be replaced by a `users` table and a `HouseholdMember` link table.
- **Authentication**: Replace the prototype `user_id` cookie with a standard JWT-based system.
### New & Modified Data Models
- **`households`** (New Table):
-`id`: Primary Key
-`name`: `TEXT NOT NULL`
-`slug`: `TEXT NOT NULL UNIQUE`
- **`users`** (New Table, replaces `persons`):
-`id`: Primary Key
-`email`: `TEXT NOT NULL UNIQUE`
-`display_name`: `TEXT NOT NULL`
-`profile_photo_url`: `TEXT`
- **`household_members`** (New Table):
-`user_id`: FK to `users.id`
-`household_id`: FK to `households.id`
-`role`: `TEXT NOT NULL` (e.g., 'admin', 'member')
-`PRIMARY KEY (user_id, household_id)`
- **`local_credentials`** (New Table):
-`user_id`: PK, FK to `users.id`
-`hashed_password`: `TEXT NOT NULL`
- **`oauth_credentials`** (New Table):
-`user_id`: FK to `users.id`
-`provider`: `TEXT NOT NULL` (e.g., 'google')
-`provider_user_id`: `TEXT NOT NULL`
-`PRIMARY KEY (provider, provider_user_id)`
- **`household_invitations`** (New Table):
-`id`: Primary Key
-`household_id`: FK to `households.id`
-`email`: `TEXT NOT NULL`
-`invited_by_user_id`: FK to `users.id`
-`token`: `TEXT NOT NULL UNIQUE`
-`expires_at`: `DATETIME NOT NULL`
-`status`: `TEXT NOT NULL` ('pending', 'accepted', 'expired')
## 3. API & Logic Changes
### 3.1. Authentication API
- **Refactor `api/auth.py`**:
- Replace existing login/refresh logic with JWT-based authentication.
- **`POST /api/v1/auth/register`**: Body `{ email, password, displayName }`. Creates `User` and `LocalCredentials`. Returns JWT.
- **`POST /api/v1/auth/google`**: Body `{ token }`. Validates Google ID token, finds/creates `User` and `OAuthCredentials`. Returns JWT.
- **JWT Structure**: Payload must contain `user_id`. Use short-lived access tokens with a long-lived refresh token stored in an `HttpOnly` cookie.
Notes from v1 baseline to carry forward:
- Replace the `user_id` cookie dependency (`cookie_person`) with `get_current_user` (JWT) and update all protected endpoints in: `api/recipes.py`, `api/meals.py`, `api/shopping.py`.
- Preserve RFC7807 error semantics and the existing OpenAPI augmentation in `api/openapi.py`. The special-case 401 mapping for POST `/api/v1/shopping` will become unnecessary—JWT middleware should standardize 401/403.
### 3.2. Household & Tenancy API
- **Create `api/households.py`**:
- **`GET /api/v1/users/me/households`**: (Auth: JWT) Returns a list of the user's households.
- **`POST /api/v1/households`**: (Auth: JWT) Body `{ name }`. Creates a `Household` and adds the user as the first 'admin' member.
- **Household-Scoped Routes**:
- All data-related routes must be prefixed: `/api/v1/households/{householdSlug}/...`.
- **Create a new dependency in `api/deps.py`**: `get_household_from_slug` will:
1. Take `householdSlug` from the path.
2. Verify the authenticated user (from JWT) is a member of that household.
3. Raise `HTTPException(403, "Forbidden")` if not a member.
4. Return the `household` object (or just `household_id`) for use in endpoints.
Impact on existing routes (exact files to refactor):
-`api/recipes.py`, `api/meals.py`, `api/shopping.py`, `api/products.py` → move under `APIRouter(prefix="/api/v1/households/{householdSlug}")` or mount via a `household_router` in `main.py`.
- Repository functions must accept `household_id` and filter by it in all SELECT/INSERT/UPDATE. See `meals.repository`, `recipes.repository`, `ingredients.repository`, `shopping.repository`, `products.repository`.
-`persons` is replaced by `users + household_members`. Endpoints that currently return `Person` should instead resolve household-scoped `User` references.
- **Bootstrap Update**: Modify `db.py` so that a fresh database bootstrap (`db.create_schema`) calls the `create()` functions for the new repositories and *not* the old `persons` repository.
- ✅ **Indices/Constraints**: Enforced unique `Household.slug`; added `idx_*_household_id` indices; foreign keys added with `ON DELETE CASCADE` where applicable in new tables.
- ✅ **Acceptance (initial)**: Added `tests/test_migration_households.py` covering: new tables exist, `household_id` columns exist, default household created, and data porting from `Person` to `User` and `HouseholdMember`. Full test suite passes.
- Pending follow-ups for this step:
- Add composite indices `(household_id, id)` where high-cardinality pagination will benefit.
- Extend migration to add FK constraints from tenant tables to `Household(id)` where safe.
- Plan and implement data backfill for cross-table references once `users` replace `persons` in code.
-`POST /api/v1/households/{householdSlug}/meals/{id}/consumed` marks consumed with optional `consumedDate` (requires timezone if provided); removes outstanding meal requests; all operations scoped to household.
-`POST /api/v1/households/{householdSlug}/meals` creates a meal (scoped) with Location header; reuses v1 validation (≥1 chef, ≥1 cleanup, ≥1 consumer; ≥1 recipe or ≥1 extra ingredient).
-`PUT /api/v1/households/{householdSlug}/meals/{id}` updates a meal (scoped), enforcing URL/body ID match and validation; returns updated state.
-`DELETE /api/v1/households/{householdSlug}/meals/{id}` soft-deletes a meal (scoped) after removing outstanding requests in that household.
- GET `/api/v1/households/{householdSlug}/shopping/current` (scoped aggregate).
- GET `/api/v1/households/{householdSlug}/shopping/{listId}` returning purchased list + lookups scoped to household; cross-household returns 404.
- POST `/api/v1/households/{householdSlug}/shopping` to purchase list items scoped to household; validates invariants and updates outstanding requests.
- Scoped helpers in `shopping/repository.py` and `shopping/__init__.py` filter by `household_id` (find items, load list, purchased ingredients, and purchase_scoped).
- Notes: Normalized Ingredient.preparation to allow NULLs from DB (treated as empty string) to avoid 422 in v2 responses; set purchased_by_id in scoped purchase from JWT user.
- Tests: `tests/test_meals_write_v2.py` verifies create/update/delete flows under household scope; all v2 scoping tests PASS.
- **Acceptance**: The same queries as v1, when run under different household slugs and users, return isolated data sets; cross-household access yields 403. Achieved.
- ⏳ Email Delivery: Stub only. Pending adding an email sender utility/service and persistence of delivery state.
- **Acceptance**: Admins can invite by email; invite accept adds user to household; listing households shows membership with roles. (Met for API behavior; email sending pending.)
- Implemented: JWT auth v2 with refresh cookie; household domains and membership; invitations; full household scoping across recipes/meals/shopping; OpenAPI augmentation with bearerAuth and 403; RFC7807 preserved; tests green.
- DTO alignment: Meals use MemberRef { id, displayName } (no Person in outward schema). MemberRef consolidated in `api/dtos.py`. Shopping DTOs/mappers consolidated in `api/shopping_models.py`.
- Unauthenticated → 401 (JWT), not 422 (replace the v1 cookie-missing 422/401 hybrid behavior).
- Not a member of household → 403 with ProblemDetails.
- Validation stays 400 with ProblemDetails (e.g., meal validation failures; recipe without ingredients; shopping invariants).
-`422` reserved for request model validation errors.
---
## 7. Rollout & Migration Plan
- Phase A: Introduce `users` alongside `persons`; dual-write in migration; add JWT while keeping cookie for limited time (behind feature flag) if needed.
- Phase B: Add households and backfill default household; gate routes to household prefix with a migration shim for old clients if necessary.
- Phase C: Remove cookie auth and `persons` package; require JWT everywhere; finalize OpenAPI to v2.
Data migration acceptance:
- All existing data appears under a default household and is accessible to the migrated user accounts.
---
## 8. Acceptance Criteria (v2)
- Authentication: JWT bearer with register/login/google flows; refresh via HttpOnly cookie; `get_current_user` dependency replaced everywhere.
- Tenancy: All read/write queries filter by `household_id`; cross-household access returns 403; invitation flow works.
- API parity: v1 behavior preserved aside from auth/paths; ProblemDetails and pagination semantics intact; Location headers set on creates.
- OpenAPI: Security scheme is JWT; household path param present; arrays required and enums normalized; 400/404/422 standardized; 403 added on household routes.
