c5ec8f368c
- Prisma: Booking.totalPriceCents (parsed from the order webhook's total_price string), populated in booking.server.ts so "revenue by method" is real data, not a placeholder. - app/services/dashboard.server.ts: pure aggregation over injected booking data (CLAUDE.md — no DB calls in the math) — bucketByLocalDate (each booking grouped under its own location's local calendar day, not a shared UTC day), revenueByMethod (confirmed/fulfilled only), utilizationByDateLocation (booked vs. summed SlotTemplate capacity for that weekday, capped at 100%), upcomingFulfillments, and a CSV writer/formatter with proper quote-escaping. - /app/dashboard: filterable (date range, location, method, status) view with revenue-by-method cards, a capacity-utilization list (color-coded by load), an upcoming-fulfillments table with one-click confirmed->fulfilled/no_show status transitions, and a full by-day booking list. - /app/dashboard/export: a resource route (loader only, no component) streaming the same filtered bookings as a downloadable CSV — kept separate from the dashboard route specifically so it can import dashboard.server.ts freely without the client-bundling constraint the main route has to respect (see below). Fixed the same class of server/client bundling bug from the Phase 5 commit before it could ship, this time by construction: dashboard.server.ts's aggregation functions are called only inside app.dashboard.tsx's `loader`, never referenced by the default-exported component (which only reads useLoaderData() output) — verified this holds by actually running `npm run build`, not just tsc/vitest, which both stay silent about this class of error. Also hit (and fixed) the same "loader Dates arrive as strings on the client" issue from Phase 1: swapped DateTime.fromJSDate for DateTime.fromISO in the two places the component formats a booking's slotStart. Verified: lint, typecheck, 102 unit tests (+16 new for dashboard.server.ts, +2 new for totalPriceCents parsing), 18 integration tests, both builds, and a live script exercising the full aggregation pipeline (revenue exclusion of cancelled bookings, utilization math, CSV output) against the Postgres container. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
90 lines
4.7 KiB
Markdown
90 lines
4.7 KiB
Markdown
# Delivery Date & Time
|
|
|
|
Shopify app: scheduling for Shipping / Local Delivery / Store Pickup, with
|
|
date-time slots, capacity intelligence, and **all-plan checkout enforcement**
|
|
via Cart/Checkout Validation Functions.
|
|
|
|
Read **[PRODUCT_STRATEGY.md](./PRODUCT_STRATEGY.md)** (why) and
|
|
**[IMPLEMENTATION_PLAN.md](./IMPLEMENTATION_PLAN.md)** (how, phased build
|
|
order) before making changes. [CLAUDE.md](./CLAUDE.md) holds the
|
|
non-negotiables for AI-assisted work in this repo.
|
|
|
|
## Getting started
|
|
|
|
```sh
|
|
npm install
|
|
cp .env.example .env # fill in Shopify app credentials after linking
|
|
docker compose up -d # local Postgres (5433) + Redis (6380)
|
|
npx prisma migrate dev
|
|
npm run dev # shopify app dev — requires `shopify auth login` first
|
|
```
|
|
|
|
Dev uses Postgres, same as prod, since the schema relies on Prisma enums and
|
|
(from Phase 5 on) array fields that SQLite can't express. `npm run worker`
|
|
runs the BullMQ worker (jobs/worker.ts) once Phase 4 makes it do anything.
|
|
|
|
## Commands
|
|
|
|
| Command | Purpose |
|
|
|---|---|
|
|
| `npm run dev` | `shopify app dev` — local dev against a dev store |
|
|
| `npm test` | Vitest unit tests |
|
|
| `npm run test:e2e` | Playwright E2E |
|
|
| `npm run lint` / `npm run typecheck` | ESLint / `tsc --noEmit` |
|
|
| `npx prisma migrate dev` | DB migrations |
|
|
| `npm run deploy` | `shopify app deploy` — deploy extensions/functions |
|
|
| `npm run worker` | BullMQ worker (hold-expiry, notifications) |
|
|
| `npm run test:integration` | Redis/Postgres-backed tests (slot-hold concurrency, booking flow) — needs `docker compose up -d` |
|
|
| `npm run test:functions` | Real WASM build + `function-runner` tests for both Shopify Functions, against fixtures |
|
|
| `npm run typegen:functions` | Regenerate `extensions/*/generated/api.ts` from each Function's `schema.graphql` + `.graphql` query (also runs automatically before `npm run typecheck`) |
|
|
|
|
## Before public launch
|
|
|
|
The 3 mandatory GDPR compliance webhooks (`customers/data_request`,
|
|
`customers/redact`, `shop/redact`) are commented out in `shopify.app.toml`
|
|
— Shopify refuses to push them until the org requests and is granted
|
|
**Protected customer data access** in the Partner Dashboard (Apps → this
|
|
app → API access → Protected customer data), which is a manual
|
|
questionnaire/approval step. The handlers already exist and are fully
|
|
wired (`app/routes/webhooks.customers.*.tsx`, `webhooks.shop.redact.tsx`) —
|
|
once that access is granted, uncomment the three `[[webhooks.subscriptions]]`
|
|
blocks near the bottom of the webhooks section. **Required before any
|
|
public launch or Built-for-Shopify submission** — don't ship without it.
|
|
|
|
## Status
|
|
|
|
Phase 0 (scaffold & CI) through Phase 6 (ops/dispatch dashboard) are
|
|
complete. See §6 of `IMPLEMENTATION_PLAN.md` for the phased build order and
|
|
acceptance criteria — next up is Phase 7 (POS + Checkout UI extensions).
|
|
|
|
Phase 5's Google Maps / geocoding features (pickup-location map in the
|
|
widget, radius-zone eligibility, address auto-geocoding on Save Location)
|
|
are only live if `GOOGLE_MAPS_API_KEY` is set — either as an env var for
|
|
server-side geocoding, or as the "Google Maps API key" block setting in the
|
|
theme editor for the storefront map. Without a key, everything else in
|
|
Phase 5 (postal-code zones, distance-band rates, delivery-density
|
|
thresholds) still works — those don't need Maps at all.
|
|
|
|
The storefront widget's TypeScript source lives in `widget-src/datetime-widget/`,
|
|
**not** inside `extensions/datetime-widget/` — a Theme App Extension's
|
|
directory may only contain `assets`, `blocks`, `snippets`, and `locales`
|
|
(the CLI hard-rejects anything else, e.g. a `src/` folder, with "Only
|
|
assets, blocks, snippets, locales directories are allowed"). Editing the
|
|
widget? Run `npm run build:widget` to bundle it into
|
|
`extensions/datetime-widget/assets/datetime-widget.js` — it also runs
|
|
automatically before `npm run dev` / `npm run deploy`.
|
|
|
|
**Functions are JavaScript, not Rust** (`extensions/validation-slot/`,
|
|
`extensions/delivery-customization/`) — no Rust toolchain was available in
|
|
the environment that built Phase 4, and `IMPLEMENTATION_PLAN.md` §1
|
|
explicitly allows JS as a fallback. Both were generated with
|
|
`shopify app generate extension` (once a real Partner login was available)
|
|
and their business logic (`src/evaluate.js` in each) is verified two ways:
|
|
plain Vitest unit tests at the repo root (`npm test`) and real
|
|
`function-runner` fixture tests that compile actual WASM
|
|
(`npm run test:functions`, also in CI). `extensions/*/generated/` and
|
|
`extensions/*/dist/` aren't committed (matching the CLI's own
|
|
`.gitignore` for these extensions) — `npm run typegen:functions`
|
|
regenerates the types from the committed `schema.graphql`, and building
|
|
runs automatically as part of `npm run dev` / `test:functions`.
|