Migration 0003: projects, aliases, renumbers, units, packets and every child table, change orders, assets, documents, ITPs, station limits, department weld flag. Policy package: Principal, PacketState, Action rules, custody, preconditions, CO hold, order of checks, can/blocked/holder on reads. docs/POLICY.md with the tightenings table for Seth. Write pipeline: FOR UPDATE, CAS on status and dept, If-Match row versions, server-assigned numbers, field CAS, version bump, packet log, audit, NOTIFY, signatures, IT reasons, filed lock and HMAC seal. API: /api/packets (header, transitions, work orders, pages, docs, move, remove, BOM, shorts, welds, heat tags, heat table, stage, checklist, clock, warehouse stage, Q.C., change orders, log, seal), /api/projects, /api/units, /api/assets, /_blob. Frontend: Clerical home, projects and units, packet page with pdf.js and QR codes, hand draft, heat map, send to warehouse, department or Q.C. Tests: policy matrix, API, concurrency, schema, projects; Playwright Clerical draft scenario. Verified on docker-1 with the CI stack and the Samba DC. Co-Authored-By: Claude Fable 5.1 <[email protected]>
107 lines
7.2 KiB
Markdown
107 lines
7.2 KiB
Markdown
# Packet Station
|
|
|
|
Digital job packets for the PESCO shop floor. A packet moves through each department on screen instead of on paper. VISUAL releases the work and Packet Station builds the packet with the drawing from M-Files at the rev the job pull calls. Clerical checks anything flagged. Warehouse pulls parts and records heat numbers, MTRs and shorts. A supervisor assigns a station and welder. The station logs welds on the weld map, works the checklist and runs the timer. The supervisor sends it to Q.C. Q.C. inspects, accepts or rejects, and adds reports. Clerical closes the job in VISUAL, exports the manufacturing data book PDF and files it. A change in VISUAL to a packet already in the shop goes to Clerical as a change order before it reaches the shop.
|
|
|
|
This repo is the rebuild of Packet Station as a server application: Docker Compose on `docker-1`, PostgreSQL 16, a Python server that enforces every rule, a worker for the VISUAL feed and M-Files drawing lookups, and a React frontend as a pure client. Sign-in is PESCO's Active Directory. VISUAL is read through VisualKit and M-Files through MFilesKit, read-only.
|
|
|
|
## Status
|
|
|
|
**Rebuild in progress. Phase 2 done: core domain, policy engine, packet API, Clerical screen.**
|
|
|
|
People can sign in, set up projects and units, make hand drafts, attach a drawing, and send a packet to the warehouse, a department or Q.C. Every packet write goes through the server policy. The warehouse, shop and Q.C. screens are still placeholders; their API exists. The old build on `M:\Production\Packet Station` stays the live system until go-live. The new system starts empty; nothing is migrated from M:.
|
|
|
|
| Area | Exists yet? |
|
|
|---|---|
|
|
| Repo, docs, CLAUDE.md | Yes (phase 0) |
|
|
| Image, compose, CI, `doctor`, migration runner, security headers, build version endpoint | Yes (phase 0, image and stack verified on docker-1) |
|
|
| Sign-in (AD password, PIN on registered devices), sessions, lock screen, Account settings, Admin shell, audit, SSE | Yes (phase 1, verified against the Samba DC in the CI stack on docker-1) |
|
|
| Schema, policy engine, packet API, projects and units, assets, Clerical screen, packet page | Yes (phase 2, verified against PostgreSQL and the Samba DC in the CI stack on docker-1) |
|
|
| VISUAL feed and drawings | No (phase 3) |
|
|
| Warehouse, shop, Q.C., close and file, PDFs | API only (phase 2); screens in phases 4 to 7 |
|
|
| Project Management, Admin, notifications, backups | No (phases 8 and 9) |
|
|
| Regression bench and go-live | No (phase 10) |
|
|
|
|
## Phases
|
|
|
|
The full plan is in [docs/PLAN.md](docs/PLAN.md).
|
|
|
|
| Phase | What it delivers |
|
|
|---|---|
|
|
| 0 | Skeleton: repo, docs, Dockerfile, compose, CI, `packetstation doctor`, migration runner, headers and CSP. |
|
|
| 1 | Identity: AD sign-in, sessions, optional PIN, devices, signatures, audit, SSE, frontend shell and theme. |
|
|
| 2 | Core domain: schema, policy engine in Python, packet API, Clerical screen, packet page. |
|
|
| 3 | VISUAL feed and M-Files drawings in the worker, change orders, Clerical "From VISUAL" panel. |
|
|
| 4 | Warehouse: task board, pull table, heats, MTRs, shorts, upload pipeline. |
|
|
| 5 | Shop: supervisor and stall screens, weld map, heat table, timer, change-order verification. |
|
|
| 6 | Q.C.: inspection, accept and reject, Q.C. documents, digital ITP. |
|
|
| 7 | Close and file, HMAC seals, server-side PDFs (data book, traveler, ITP, prints, stamps). |
|
|
| 8 | Project Management screen, find bar, list view, presence. |
|
|
| 9 | Admin completion, AD reconcile, integrity job, notifications, backups and restore. |
|
|
| 10 | Regression bench, hardening, go-live and paper-fallback docs. |
|
|
|
|
## Folder map
|
|
|
|
```
|
|
CLAUDE.md README.md CHANGELOG.md pyproject.toml Dockerfile .env.example
|
|
docs/ the brief, the plan, security, deploy, feed, policy, schema, go-live, paper fallback
|
|
server/packetstation/ the Python package: app, worker, CLI, migrations, policy, domain, feed, drawings, PDFs
|
|
frontend/ Vite + React + TypeScript client
|
|
tests/ server tests (pytest), e2e scenarios (Playwright), synthetic fixture generator
|
|
deploy/ compose files (base, NPM overlay, CI overlay), PostgreSQL init, Samba AD for CI
|
|
docker/ the image entrypoint
|
|
scripts/ host backup and restore scripts, systemd timer
|
|
.gitea/workflows/ CI
|
|
```
|
|
|
|
Not in git: `.env`, `tests/fixtures/local/`, `reference/`, `recordings/`. Real job data stays out of git and CI.
|
|
|
|
## How to run
|
|
|
|
Developer machine:
|
|
|
|
```bash
|
|
python -m venv .venv
|
|
.venv\Scripts\python -m pip install -e ".[dev]"
|
|
.venv\Scripts\python -m pytest
|
|
cd frontend && npm ci && npm run build
|
|
packetstation doctor
|
|
```
|
|
|
|
`visualkit` and `mfileskit` install from PESCO's Gitea index with `--index-url`. Everything else installs from public PyPI in a separate step. See [docs/DEPLOY.md](docs/DEPLOY.md).
|
|
|
|
Test stack on `docker-1`:
|
|
|
|
```bash
|
|
docker compose -p packetstation-test --env-file /etc/packetstation/test/stack.env \
|
|
-f deploy/compose.yaml -f deploy/compose.proxy.yaml up -d
|
|
```
|
|
|
|
Phase 2 adds `/api/projects`, `/api/units`, `/api/packets` (header, transitions, work orders, pages, documents, BOM, shorts, welds, heat tags, heat table, stage, checklist, clock, warehouse stage, Q.C., change orders, log, seal), `/api/assets` and `/_blob/{id}`. Every packet read carries `can`, `blocked` and `holder` from the policy. See [docs/POLICY.md](docs/POLICY.md) and [docs/SCHEMA.md](docs/SCHEMA.md).
|
|
|
|
The `packetstation` command has `doctor`, `migrate`, `app`, `worker`, `ad-groups --list` (the 50 AD group names the app expects) and `ad-refresh` (create or refresh the users from the groups' members).
|
|
|
|
CI stack with the Samba domain controller and the Playwright scenario, on a Docker host:
|
|
|
|
```bash
|
|
deploy/ci/make-secrets.sh
|
|
docker compose -p packetstation-ci --env-file deploy/ci/ci.env -f deploy/compose.yaml -f deploy/compose.ci.yaml up -d --build --wait
|
|
docker compose -p packetstation-ci --env-file deploy/ci/ci.env -f deploy/compose.yaml -f deploy/compose.ci.yaml --profile e2e run --rm playwright
|
|
docker compose -p packetstation-ci --env-file deploy/ci/ci.env -f deploy/compose.yaml -f deploy/compose.ci.yaml down -v
|
|
```
|
|
|
|
Server tests that need PostgreSQL run when `TEST_PG_SUPERUSER_URL` is set; the ones that need the domain controller run when the `TEST_LDAP_*` variables and `TEST_DC_USERS_FILE` are set. See [deploy/samba/README.md](deploy/samba/README.md).
|
|
|
|
## Docs
|
|
|
|
- [docs/BRIEF.md](docs/BRIEF.md): the brief this rebuild follows.
|
|
- [docs/PLAN.md](docs/PLAN.md): the approved phased plan and open questions.
|
|
- [docs/SECURITY.md](docs/SECURITY.md): old layers and where they live now, the new controls, the requirement ID table.
|
|
- [docs/DEPLOY.md](docs/DEPLOY.md): host, stacks, secrets, NPM proxy host, doctor, backups.
|
|
- [docs/FEED.md](docs/FEED.md): the VISUAL feed and drawing jobs (phase 3).
|
|
- [docs/POLICY.md](docs/POLICY.md): who may do what, the preconditions, the order of checks, concurrency, and the tightenings against the old build.
|
|
- [docs/SCHEMA.md](docs/SCHEMA.md): the database schema (phases 1 and 2; phase 3 adds the caches).
|
|
- [docs/GO-LIVE.md](docs/GO-LIVE.md): go-live procedure (phase 10).
|
|
- [docs/PAPER-FALLBACK.md](docs/PAPER-FALLBACK.md): what the shop does when the server is down (phase 10).
|
|
- [CHANGELOG.md](CHANGELOG.md): what changed.
|
|
- [CLAUDE.md](CLAUDE.md): rules for Claude Code sessions in this repo.
|