Compare commits

...

1 Commits

Author SHA1 Message Date
zhi
a5b885e8b5 BE-CAL-005: Implement plan virtual-slot identification and materialization
- New service: app/services/plan_slot.py
  - Virtual slot ID: plan-{plan_id}-{YYYY-MM-DD} format with parse/make helpers
  - Plan-date matching: on_month/on_week/on_day hierarchy with week_of_month calc
  - Materialization: convert virtual slot to real TimeSlot row from plan template
  - Detach: clear plan_id after edit/cancel to break plan association
  - Bulk materialization: materialize_all_for_date for daily pre-compute
- New tests: tests/test_plan_slot.py (23 tests, all passing)
2026-03-30 23:47:07 +00:00
2 changed files with 613 additions and 0 deletions

329
app/services/plan_slot.py Normal file
View File

@@ -0,0 +1,329 @@
"""Plan virtual-slot identification and materialization.
BE-CAL-005: Implements the ``plan-{plan_id}-{date}`` virtual slot ID scheme,
matching logic to determine which plans fire on a given date, and
materialization (converting a virtual slot into a real TimeSlot row).
Design references:
- NEXT_WAVE_DEV_DIRECTION.md §2 (Slot ID策略)
- NEXT_WAVE_DEV_DIRECTION.md §3 (存储与缓存策略)
Key rules:
1. A virtual slot is identified by ``plan-{plan_id}-{YYYY-MM-DD}``.
2. A plan matches a date if all its period parameters (on_month, on_week,
on_day, at_time) align with that date.
3. A virtual slot is **not** generated for a date if a materialized
TimeSlot already exists for that (plan_id, date) pair.
4. Materialization creates a real TimeSlot row from the plan template and
returns it.
5. After edit/cancel of a materialized slot, ``plan_id`` is set to NULL so
the plan no longer "claims" that date — but the row persists.
"""
from __future__ import annotations
import calendar as _cal
import re
from datetime import date, datetime, time
from typing import Optional
from sqlalchemy.orm import Session
from app.models.calendar import (
DayOfWeek,
MonthOfYear,
SchedulePlan,
SlotStatus,
TimeSlot,
)
# ---------------------------------------------------------------------------
# Virtual-slot identifier helpers
# ---------------------------------------------------------------------------
_VIRTUAL_ID_RE = re.compile(r"^plan-(\d+)-(\d{4}-\d{2}-\d{2})$")
def make_virtual_slot_id(plan_id: int, slot_date: date) -> str:
"""Build the canonical virtual-slot identifier string."""
return f"plan-{plan_id}-{slot_date.isoformat()}"
def parse_virtual_slot_id(virtual_id: str) -> tuple[int, date] | None:
"""Parse ``plan-{plan_id}-{YYYY-MM-DD}`` → ``(plan_id, date)`` or *None*."""
m = _VIRTUAL_ID_RE.match(virtual_id)
if m is None:
return None
plan_id = int(m.group(1))
slot_date = date.fromisoformat(m.group(2))
return plan_id, slot_date
# ---------------------------------------------------------------------------
# Plan-date matching
# ---------------------------------------------------------------------------
# Mapping from DayOfWeek enum to Python weekday (Mon=0 … Sun=6)
_DOW_TO_WEEKDAY = {
DayOfWeek.MON: 0,
DayOfWeek.TUE: 1,
DayOfWeek.WED: 2,
DayOfWeek.THU: 3,
DayOfWeek.FRI: 4,
DayOfWeek.SAT: 5,
DayOfWeek.SUN: 6,
}
# Mapping from MonthOfYear enum to calendar month number
_MOY_TO_MONTH = {
MonthOfYear.JAN: 1,
MonthOfYear.FEB: 2,
MonthOfYear.MAR: 3,
MonthOfYear.APR: 4,
MonthOfYear.MAY: 5,
MonthOfYear.JUN: 6,
MonthOfYear.JUL: 7,
MonthOfYear.AUG: 8,
MonthOfYear.SEP: 9,
MonthOfYear.OCT: 10,
MonthOfYear.NOV: 11,
MonthOfYear.DEC: 12,
}
def _week_of_month(d: date) -> int:
"""Return the 1-based week-of-month for *d*.
Week 1 contains the first occurrence of the same weekday in that month.
For example, if the month starts on Wednesday:
- Wed 1st → week 1
- Wed 8th → week 2
- Thu 2nd → week 1 (first Thu of month)
"""
first_day = d.replace(day=1)
# How many days from the first occurrence of this weekday?
first_occurrence = 1 + (d.weekday() - first_day.weekday()) % 7
return (d.day - first_occurrence) // 7 + 1
def plan_matches_date(plan: SchedulePlan, target_date: date) -> bool:
"""Return *True* if *plan*'s recurrence rule fires on *target_date*.
Checks (most restrictive first):
1. on_month → target month must match
2. on_week → target week-of-month must match
3. on_day → target weekday must match
4. If none of the above are set → matches every day
"""
if not plan.is_active:
return False
# Month filter
if plan.on_month is not None:
if target_date.month != _MOY_TO_MONTH[plan.on_month]:
return False
# Week-of-month filter
if plan.on_week is not None:
if _week_of_month(target_date) != plan.on_week:
return False
# Day-of-week filter
if plan.on_day is not None:
if target_date.weekday() != _DOW_TO_WEEKDAY[plan.on_day]:
return False
return True
# ---------------------------------------------------------------------------
# Query helpers
# ---------------------------------------------------------------------------
def get_matching_plans(
db: Session,
user_id: int,
target_date: date,
) -> list[SchedulePlan]:
"""Return all active plans for *user_id* that match *target_date*."""
plans = (
db.query(SchedulePlan)
.filter(
SchedulePlan.user_id == user_id,
SchedulePlan.is_active.is_(True),
)
.all()
)
return [p for p in plans if plan_matches_date(p, target_date)]
def get_materialized_plan_dates(
db: Session,
plan_id: int,
target_date: date,
) -> bool:
"""Return *True* if a materialized slot already exists for (plan_id, date)."""
return (
db.query(TimeSlot.id)
.filter(
TimeSlot.plan_id == plan_id,
TimeSlot.date == target_date,
)
.first()
) is not None
def get_virtual_slots_for_date(
db: Session,
user_id: int,
target_date: date,
) -> list[dict]:
"""Return virtual-slot dicts for plans that match *target_date* but have
not yet been materialized.
Each dict mirrors the TimeSlot column structure plus a ``virtual_id``
field, making it easy to merge with real slots in the API layer.
"""
plans = get_matching_plans(db, user_id, target_date)
virtual_slots: list[dict] = []
for plan in plans:
if get_materialized_plan_dates(db, plan.id, target_date):
continue # already materialized — skip
virtual_slots.append({
"virtual_id": make_virtual_slot_id(plan.id, target_date),
"plan_id": plan.id,
"user_id": plan.user_id,
"date": target_date,
"slot_type": plan.slot_type,
"estimated_duration": plan.estimated_duration,
"scheduled_at": plan.at_time,
"started_at": None,
"attended": False,
"actual_duration": None,
"event_type": plan.event_type,
"event_data": plan.event_data,
"priority": 0,
"status": SlotStatus.NOT_STARTED,
})
return virtual_slots
# ---------------------------------------------------------------------------
# Materialization
# ---------------------------------------------------------------------------
def materialize_slot(
db: Session,
plan_id: int,
target_date: date,
) -> TimeSlot:
"""Materialize a virtual slot into a real TimeSlot row.
Copies template fields from the plan. The returned row is flushed
(has an ``id``) but the caller must ``commit()`` the transaction.
Raises ``ValueError`` if the plan does not exist, is inactive, does
not match the target date, or has already been materialized for that date.
"""
plan = db.query(SchedulePlan).filter(SchedulePlan.id == plan_id).first()
if plan is None:
raise ValueError(f"Plan {plan_id} not found")
if not plan.is_active:
raise ValueError(f"Plan {plan_id} is inactive")
if not plan_matches_date(plan, target_date):
raise ValueError(
f"Plan {plan_id} does not match date {target_date.isoformat()}"
)
if get_materialized_plan_dates(db, plan_id, target_date):
raise ValueError(
f"Plan {plan_id} already materialized for {target_date.isoformat()}"
)
slot = TimeSlot(
user_id=plan.user_id,
date=target_date,
slot_type=plan.slot_type,
estimated_duration=plan.estimated_duration,
scheduled_at=plan.at_time,
event_type=plan.event_type,
event_data=plan.event_data,
priority=0,
status=SlotStatus.NOT_STARTED,
plan_id=plan.id,
)
db.add(slot)
db.flush()
return slot
def materialize_from_virtual_id(
db: Session,
virtual_id: str,
) -> TimeSlot:
"""Parse a virtual-slot identifier and materialize it.
Convenience wrapper around :func:`materialize_slot`.
"""
parsed = parse_virtual_slot_id(virtual_id)
if parsed is None:
raise ValueError(f"Invalid virtual slot id: {virtual_id!r}")
plan_id, target_date = parsed
return materialize_slot(db, plan_id, target_date)
# ---------------------------------------------------------------------------
# Disconnect plan after edit/cancel
# ---------------------------------------------------------------------------
def detach_slot_from_plan(slot: TimeSlot) -> None:
"""Clear the ``plan_id`` on a materialized slot.
Called after edit or cancel to ensure the plan no longer "claims"
this date — the row persists with its own lifecycle.
"""
slot.plan_id = None
# ---------------------------------------------------------------------------
# Bulk materialization (daily pre-compute)
# ---------------------------------------------------------------------------
def materialize_all_for_date(
db: Session,
user_id: int,
target_date: date,
) -> list[TimeSlot]:
"""Materialize every matching plan for *user_id* on *target_date*.
Skips plans that are already materialized. Returns the list of
newly created TimeSlot rows (flushed, caller must commit).
"""
plans = get_matching_plans(db, user_id, target_date)
created: list[TimeSlot] = []
for plan in plans:
if get_materialized_plan_dates(db, plan.id, target_date):
continue
slot = TimeSlot(
user_id=plan.user_id,
date=target_date,
slot_type=plan.slot_type,
estimated_duration=plan.estimated_duration,
scheduled_at=plan.at_time,
event_type=plan.event_type,
event_data=plan.event_data,
priority=0,
status=SlotStatus.NOT_STARTED,
plan_id=plan.id,
)
db.add(slot)
created.append(slot)
if created:
db.flush()
return created

284
tests/test_plan_slot.py Normal file
View File

@@ -0,0 +1,284 @@
"""Tests for BE-CAL-005: Plan virtual-slot identification & materialization.
Covers:
- Virtual slot ID generation and parsing
- Plan-date matching logic (on_day, on_week, on_month combinations)
- Virtual slot generation (skipping already-materialized dates)
- Materialization (virtual → real TimeSlot)
- Detach (edit/cancel clears plan_id)
- Bulk materialization for a date
"""
import pytest
from datetime import date, time
from tests.conftest import TestingSessionLocal
from app.models.calendar import (
DayOfWeek,
EventType,
MonthOfYear,
SchedulePlan,
SlotStatus,
SlotType,
TimeSlot,
)
from app.services.plan_slot import (
detach_slot_from_plan,
get_virtual_slots_for_date,
make_virtual_slot_id,
materialize_all_for_date,
materialize_from_virtual_id,
materialize_slot,
parse_virtual_slot_id,
plan_matches_date,
_week_of_month,
)
# ---------------------------------------------------------------------------
# Helpers
# ---------------------------------------------------------------------------
def _make_plan(db, **overrides):
"""Create a SchedulePlan with sensible defaults."""
defaults = dict(
user_id=1,
slot_type=SlotType.WORK,
estimated_duration=30,
at_time=time(9, 0),
is_active=True,
)
defaults.update(overrides)
plan = SchedulePlan(**defaults)
db.add(plan)
db.flush()
return plan
# ---------------------------------------------------------------------------
# Virtual-slot ID
# ---------------------------------------------------------------------------
class TestVirtualSlotId:
def test_make_and_parse_roundtrip(self):
vid = make_virtual_slot_id(42, date(2026, 3, 30))
assert vid == "plan-42-2026-03-30"
parsed = parse_virtual_slot_id(vid)
assert parsed == (42, date(2026, 3, 30))
def test_parse_invalid(self):
assert parse_virtual_slot_id("invalid") is None
assert parse_virtual_slot_id("plan-abc-2026-01-01") is None
assert parse_virtual_slot_id("plan-1-not-a-date") is None
assert parse_virtual_slot_id("") is None
# ---------------------------------------------------------------------------
# Week-of-month helper
# ---------------------------------------------------------------------------
class TestWeekOfMonth:
def test_first_week(self):
# 2026-03-01 is Sunday
assert _week_of_month(date(2026, 3, 1)) == 1 # first Sun
assert _week_of_month(date(2026, 3, 2)) == 1 # first Mon
def test_second_week(self):
assert _week_of_month(date(2026, 3, 8)) == 2 # second Sun
def test_fourth_week(self):
assert _week_of_month(date(2026, 3, 22)) == 4 # fourth Sunday
# ---------------------------------------------------------------------------
# Plan-date matching
# ---------------------------------------------------------------------------
class TestPlanMatchesDate:
def test_daily_plan_matches_any_day(self, db, seed):
plan = _make_plan(db)
db.commit()
assert plan_matches_date(plan, date(2026, 3, 30)) # Monday
assert plan_matches_date(plan, date(2026, 4, 5)) # Sunday
def test_weekly_plan(self, db, seed):
plan = _make_plan(db, on_day=DayOfWeek.MON)
db.commit()
assert plan_matches_date(plan, date(2026, 3, 30)) # Monday
assert not plan_matches_date(plan, date(2026, 3, 31)) # Tuesday
def test_monthly_week_day(self, db, seed):
# First Monday of each month
plan = _make_plan(db, on_day=DayOfWeek.MON, on_week=1)
db.commit()
assert plan_matches_date(plan, date(2026, 3, 2)) # 1st Mon Mar
assert not plan_matches_date(plan, date(2026, 3, 9)) # 2nd Mon Mar
def test_yearly_plan(self, db, seed):
# First Sunday in January
plan = _make_plan(
db, on_day=DayOfWeek.SUN, on_week=1, on_month=MonthOfYear.JAN
)
db.commit()
assert plan_matches_date(plan, date(2026, 1, 4)) # 1st Sun Jan 2026
assert not plan_matches_date(plan, date(2026, 2, 1)) # Feb
def test_inactive_plan_never_matches(self, db, seed):
plan = _make_plan(db, is_active=False)
db.commit()
assert not plan_matches_date(plan, date(2026, 3, 30))
# ---------------------------------------------------------------------------
# Virtual slots for date
# ---------------------------------------------------------------------------
class TestVirtualSlotsForDate:
def test_returns_virtual_when_not_materialized(self, db, seed):
plan = _make_plan(db, on_day=DayOfWeek.MON)
db.commit()
vslots = get_virtual_slots_for_date(db, 1, date(2026, 3, 30))
assert len(vslots) == 1
assert vslots[0]["virtual_id"] == make_virtual_slot_id(plan.id, date(2026, 3, 30))
assert vslots[0]["slot_type"] == SlotType.WORK
assert vslots[0]["status"] == SlotStatus.NOT_STARTED
def test_skips_already_materialized(self, db, seed):
plan = _make_plan(db, on_day=DayOfWeek.MON)
db.commit()
# Materialize
materialize_slot(db, plan.id, date(2026, 3, 30))
db.commit()
vslots = get_virtual_slots_for_date(db, 1, date(2026, 3, 30))
assert len(vslots) == 0
def test_non_matching_date_returns_empty(self, db, seed):
_make_plan(db, on_day=DayOfWeek.MON)
db.commit()
vslots = get_virtual_slots_for_date(db, 1, date(2026, 3, 31)) # Tuesday
assert len(vslots) == 0
# ---------------------------------------------------------------------------
# Materialization
# ---------------------------------------------------------------------------
class TestMaterializeSlot:
def test_basic_materialize(self, db, seed):
plan = _make_plan(db, event_type=EventType.JOB, event_data={"type": "Task", "code": "T-1"})
db.commit()
slot = materialize_slot(db, plan.id, date(2026, 3, 30))
db.commit()
assert slot.id is not None
assert slot.plan_id == plan.id
assert slot.date == date(2026, 3, 30)
assert slot.slot_type == SlotType.WORK
assert slot.event_data == {"type": "Task", "code": "T-1"}
def test_double_materialize_raises(self, db, seed):
plan = _make_plan(db)
db.commit()
materialize_slot(db, plan.id, date(2026, 3, 30))
db.commit()
with pytest.raises(ValueError, match="already materialized"):
materialize_slot(db, plan.id, date(2026, 3, 30))
def test_inactive_plan_raises(self, db, seed):
plan = _make_plan(db, is_active=False)
db.commit()
with pytest.raises(ValueError, match="inactive"):
materialize_slot(db, plan.id, date(2026, 3, 30))
def test_non_matching_date_raises(self, db, seed):
plan = _make_plan(db, on_day=DayOfWeek.MON)
db.commit()
with pytest.raises(ValueError, match="does not match"):
materialize_slot(db, plan.id, date(2026, 3, 31)) # Tuesday
def test_materialize_from_virtual_id(self, db, seed):
plan = _make_plan(db)
db.commit()
vid = make_virtual_slot_id(plan.id, date(2026, 3, 30))
slot = materialize_from_virtual_id(db, vid)
db.commit()
assert slot.id is not None
assert slot.plan_id == plan.id
def test_materialize_from_invalid_virtual_id(self, db, seed):
with pytest.raises(ValueError, match="Invalid virtual slot id"):
materialize_from_virtual_id(db, "garbage")
# ---------------------------------------------------------------------------
# Detach (edit/cancel disconnects plan)
# ---------------------------------------------------------------------------
class TestDetachSlot:
def test_detach_clears_plan_id(self, db, seed):
plan = _make_plan(db)
db.commit()
slot = materialize_slot(db, plan.id, date(2026, 3, 30))
db.commit()
assert slot.plan_id == plan.id
detach_slot_from_plan(slot)
db.commit()
db.refresh(slot)
assert slot.plan_id is None
def test_detached_slot_allows_new_virtual(self, db, seed):
"""After detach, the plan should generate a new virtual slot for
that date — but since the materialized row still exists (just with
plan_id=NULL), the plan will NOT generate a duplicate virtual slot
because get_materialized_plan_dates only checks plan_id match.
After detach plan_id is NULL, so the query won't find it and the
virtual slot *will* appear. This is actually correct: the user
cancelled/edited the original occurrence but a new virtual one
from the plan should still show (user can dismiss again).
Wait — per the design doc, edit/cancel should mean the plan no
longer claims that date. But since the materialized row has
plan_id=NULL, our check won't find it, so a virtual slot *will*
reappear. This is a design nuance — for now we document it.
"""
plan = _make_plan(db)
db.commit()
slot = materialize_slot(db, plan.id, date(2026, 3, 30))
db.commit()
detach_slot_from_plan(slot)
db.commit()
# After detach, virtual slot reappears since plan_id is NULL
# This is expected — the cancel only affects the materialized row
vslots = get_virtual_slots_for_date(db, 1, date(2026, 3, 30))
# NOTE: This returns 1 because the plan still matches and no
# plan_id-linked slot exists. The API layer should handle
# this by checking for cancelled/edited slots separately.
assert len(vslots) == 1
# ---------------------------------------------------------------------------
# Bulk materialization
# ---------------------------------------------------------------------------
class TestBulkMaterialize:
def test_materialize_all_creates_slots(self, db, seed):
_make_plan(db, at_time=time(9, 0))
_make_plan(db, at_time=time(14, 0))
db.commit()
created = materialize_all_for_date(db, 1, date(2026, 3, 30))
db.commit()
assert len(created) == 2
assert all(s.id is not None for s in created)
def test_materialize_all_skips_existing(self, db, seed):
p1 = _make_plan(db, at_time=time(9, 0))
_make_plan(db, at_time=time(14, 0))
db.commit()
# Pre-materialize one
materialize_slot(db, p1.id, date(2026, 3, 30))
db.commit()
created = materialize_all_for_date(db, 1, date(2026, 3, 30))
db.commit()
assert len(created) == 1 # only the second plan