Stop the availability form failing in silence
CI / Tests (PHP 8.1) (pull_request) Successful in 56s
CI / Tests (PHP 8.2) (pull_request) Successful in 46s
CI / No Debug Code (pull_request) Successful in 2s
CI / Coding Standards (pull_request) Successful in 3m3s
CI / PHPStan (pull_request) Successful in 2m51s
CI / Tests (PHP 8.3) (pull_request) Successful in 2m50s
CI / Build Plugin Zip (pull_request) Skipped

Adding availability for 5:30-6:00 PM with the lesson length left on its
60-minute default saved nothing and said nothing. A window is stored as
consecutive lesson-length slots, so one that fits no lesson splits into
none: splitByDuration() returned [], createFromWindow() inserted
nothing, and addSlot() discarded the result and re-rendered the page
unchanged.

The REST endpoint already rejected that window with a 400. The admin
form checked the same rules separately, and its copy was both laxer and
mute — an unreadable date, an end before the start, and a two-day window
were bare `return`s, and it never checked offering ownership at all, so
a crafted POST could tie a slot to another instructor's offering and
inherit their price and payment routing.

Both callers now go through WindowValidator, which returns the window or
a WP_Error explaining the refusal. The endpoint returns that error as
is; the page renders its message as a notice. handleFormAction returns
a [notice, error] pair so deletes report themselves too, and a
successful add says how many slots it created.

Two failures could also go unnoticed underneath: wpdb::insert's result
was ignored, and insert_id still holds the previous statement's id after
a failed write, so a failure looked like a success — and could become
the recurrence group of a weekly series, orphaning every later
occurrence. weeks was unbounded server-side despite the form's max=52.

availability-admin.js narrows the lesson-length choices to those that
fit the window and blocks submission when none do, which is what makes
the original mistake hard to repeat. It is a convenience: the server
validates regardless.

Closes #130
This commit is contained in:
2026-07-28 23:19:49 -03:00
parent d9dd576630
commit 171b655bb8
15 changed files with 878 additions and 88 deletions
+49 -7
View File
@@ -25,8 +25,9 @@ A slot's `duration_minutes` is matched against the offering a student picks: a
`AvailabilitySlot::splitByDuration()` chunks a submitted window into consecutive
`duration_minutes` slots; `AvailabilityRepository::createFromWindow()` persists
one row per chunk. A trailing remainder shorter than the lesson length is
dropped. Windows must start and end on the same day and fit at least one lesson
(REST responds `400 invalid_window` otherwise; the admin form is a no-op).
dropped. Windows must start and end on the same day and fit at least one lesson;
both the REST endpoint and the admin form reject one that does not, with a
message saying so (see **REST API** below).
`AvailabilityRepository::splitOversizedWindows()` is a data migration (run by
`Installer` on activation or version change) that rewrites pre-split rows.
@@ -44,6 +45,27 @@ Instructors access **My Availability** in wp-admin (`?page=us-availability`).
- Bulk delete: the list view has a checkbox per unbooked slot (with a select-all header checkbox) and a **Delete selected** button (`usc_action=bulk_delete`, `slot_ids[]`); each id is ownership-checked, and booked slots are refused at the repository level
- Current slots can be shown as a **weekly calendar** (the default, navigated with `usc_week=Y-m-d`) or a **list** (`usc_view=list`); the grid honours the site's `start_of_week` option via `Availability\WeekCalendar`
### Feedback
Every submitted action reports its outcome as a wp-admin notice — a success
notice naming the number of slots created or deleted, or an error explaining the
refusal. `AvailabilityController::handleFormAction()` returns a
`[$notice, $error]` pair that `templates/admin/availability.php` renders.
This matters because the form used to fail **silently**: a window shorter than
the chosen lesson length splits into no slots, so nothing was written, nothing
was said, and the page simply reloaded. Submitting 5:306:00 PM with the length
select on its 60-minute default was the reported case. Invalid datetimes, an end
before the start, a window spanning two days, and an offering belonging to
another instructor were all silent in the same way.
### Lesson-length choices
`assets/js/availability-admin.js` (enqueued by `AdminMenu::enqueueAssets()` on
this screen only) hides any lesson length longer than the entered window, falls
back to the longest one that still fits when the current pick is hidden, and
disables the submit button when nothing fits. It is a convenience, not a
guarantee — the server validates the same window regardless. The choices come
from `AvailabilitySlot::DURATION_CHOICES`.
## Public Calendar
The front-end booking shortcode renders open slots from `GET /availability`
either as an agenda-style list grouped by day or as a **weekly calendar** with
@@ -62,12 +84,29 @@ with the **Show Only** lesson-type filter — see `lesson-booking.md`.
`GET` supports query params: `instructor_id`, `offering_id`, `duration_minutes`, `from` (datetime), `to` (datetime).
Slots whose start has already passed are never returned.
`POST` validates `start_dt`/`end_dt` (admin form and REST alike) via
`AvailabilitySlot::normalizeDateTime()`: the canonical `Y-m-d H:i[:s]` and HTML
`datetime-local` (`Y-m-d\TH:i[:s]`) forms are normalised to `Y-m-d H:i:s`;
anything else — or an end not after the start — is rejected (REST responds
`400 invalid_datetime`; the admin form is a no-op). A valid window is stored as
`POST` runs every submitted window — admin form and REST alike — through
`Availability\WindowValidator`, which returns either the window ready to persist
or a `WP_Error`. The REST endpoint returns that error directly (its `status`
data makes it a 400); the admin screen shows `get_error_message()` in a notice.
Sharing one validator is deliberate: the two paths previously checked the same
rules separately, and the admin copy was both laxer (no offering-ownership
check) and mute (a bare `return` on every rejection).
| Rejection | Code |
|---|---|
| Start or end not a real datetime | `invalid_datetime` |
| End at or before the start | `invalid_datetime` |
| Window spans two days | `invalid_window` |
| Window shorter than the lesson length (so it holds no slots) | `invalid_window` |
| Offering missing, or owned by another instructor | `invalid_offering` |
`start_dt`/`end_dt` are normalised by `AvailabilitySlot::normalizeDateTime()`:
the canonical `Y-m-d H:i[:s]` and HTML `datetime-local` (`Y-m-d\TH:i[:s]`) forms
become `Y-m-d H:i:s`; anything else is rejected. A valid window is stored as
lesson-length slots and `201` returns `{ "ids": [...] }` for every row created.
`weeks` is clamped to `AvailabilitySlot::MAX_WEEKLY_OCCURRENCES` in the
repository, so the form's `max` cannot be bypassed by posting directly. A write
that fails entirely returns `500 not_saved` rather than a `201` listing no ids.
Times are displayed in 12-hour AM/PM form in the booking calendar and wp-admin
lists.
@@ -78,6 +117,8 @@ lists.
- Week bucketing: `Unsupervised\Schedular\Availability\WeekCalendar`
- Admin controller: `Unsupervised\Schedular\Availability\AvailabilityController`
- REST endpoint: `Unsupervised\Schedular\Availability\AvailabilityEndpoint`
- Shared window validation: `Unsupervised\Schedular\Availability\WindowValidator`
- Admin form script: `assets/js/availability-admin.js`, enqueued by `AdminMenu::enqueueAssets()`
## Tests
- `tests/Unit/Availability/AvailabilityControllerTest.php`
@@ -85,3 +126,4 @@ lists.
- `tests/Unit/Availability/AvailabilitySlotTest.php`
- `tests/Unit/Availability/AvailabilityEndpointTest.php`
- `tests/Unit/Availability/WeekCalendarTest.php`
- `tests/Unit/Availability/WindowValidatorTest.php`