534f179ee6
main was 16 days and 259 commits behind the line the product is actually built on, at contract 0.30.0 against 0.35.0, with no per-PC credential code at all. It was neither current nor curated - just stale. This brings it forward and, at the same time, makes it mean something: main is what a receiving site installs, and nothing else. WHAT IT CARRIES. Twelve plugins - backups, computers, endpoints, guides, knowledgebase, machines, network, notifications, printers, slides, tools, warranty - plus applications, which is manifest-less core and always ships. The only manifest dependency inside that set is endpoints on computers, and both are in it, so the closure is self-contained. WHAT IT DOES NOT. employees, geenforce, measuringtools, printedparts and usb stay on the site line. So do the Windows installer tree, the VM rehearsal helpers, the agent tooling config, one site's data loader, the internal audit and findings records, and the planner spreadsheet. 1,135 tracked files against 1,438. A REMOVAL THAT BREAKS THE APP IS NOT A REMOVAL, and two nearly shipped: deploy/site-profile-universal.json still named all seventeen plugins. It is the file docs/DEPLOY.md tells a site to provision from, so a fresh install would have failed at `flask plugin apply-profile` with PluginError - the first thing a receiving site does, broken by the branch meant to serve them. It now names the twelve that exist, and its comment says the two must agree. agent/ was never refreshed. Whoever populated this branch copied shopdb/, plugins/, frontend/ and tests/ from the site line and left the agent tree at its September state: 22 C# and PowerShell sources missing, including AgentCredentials, EnrollmentService, AgentHttpFactory and the fleet-alert client, plus one file the site line had deleted still present. The old tree is internally consistent, so it compiles, and nothing in CI builds it - every gate was green over a server that speaks enrollment and per-PC credentials to a bundled agent source that cannot. Resynced whole. DECISIONS THIS ENCODES, rather than defers: - The plugin-authoring lab builds printedparts, whose manifest depends on employees, so it could not stay. The lab remains on the site line and main ships no build-along tutorial. That is a real loss for an adopting developer and is recorded here rather than discovered later. - Recognition, Training and Recertification notifications are no longer seeded. Each splits one notification into a card per employee and renders a photo, which needs a plugin this branch does not bundle. Seeding them would offer an author a type that cannot resolve anybody. A site that installs employees gets them from that plugin's own seed. - Windows/IIS is documented as the legacy path throughout, and the README leads with Docker, because that is what a receiving site gets. The API description is regenerated for THIS branch - 347 paths and 483 operations, down from 415 and 573 - so the published contract describes what is here rather than what the site line serves. docs/CONFIG.md lost the two measuring-tool label keys the code no longer declares, which two lanes had decided opposite ways. Suite: 3124 passed, 6 skipped. Naming and style gates pass. The docs gates run rather than skip, and every index line count is derived from the file it names.
76 lines
3.8 KiB
Markdown
76 lines
3.8 KiB
Markdown
<!-- docmeta
|
|
purpose: explanation
|
|
audience: developer
|
|
status: current
|
|
summary: Why the equipment domain was renamed to machines and machinetypes became modeltypes.
|
|
loadwith: none
|
|
-->
|
|
|
|
# ADR-011: Rename the equipment domain to machines; retype the models catalog with modeltypes
|
|
|
|
- **Status:** ACCEPTED
|
|
- **Date:** 2026-07-11
|
|
- **Deciders:** ShopDB maintainers
|
|
- **Relates to:** ADR-005 (equipment vs measuringtools scope), ADR-008 (plugin migration ownership)
|
|
|
|
## Context
|
|
|
|
ADR-005 split the old "equipment" concept: gage-lab instruments moved to the
|
|
measuringtools plugin, leaving the equipment plugin holding exactly one thing -
|
|
shop-floor machines (lathes, mills, CMMs, grinders, furnaces). The UI, the
|
|
routes (`/machines`), the frontend view folder (`views/machines/`), and even
|
|
the data vocabulary (asset numbers headed "MACHINE #") already said machines.
|
|
Only the code identity still said equipment: the plugin name, the API prefix,
|
|
the `equipment`/`equipmenttypes` tables, and the `assettype='equipment'` data
|
|
value. Every future contributor would pay a small permanent translation tax.
|
|
|
|
A display-label-only swap was shipped first (2026-07-11) and immediately showed
|
|
the dissonance: UI Machines over code equipment forever.
|
|
|
|
Separately, the legacy `machinetypes` table survived the Machine-model
|
|
retirement for one real reason: it types the vendor **models catalog**
|
|
(`models.machinetypeid`, 95 of 127 models) with fine-grained, cross-category
|
|
types (Lathe, Switch, Laser Printer). Its name was a misnomer - it never typed
|
|
machines specifically - and it squatted on the name the machines plugin's
|
|
subtype table wants.
|
|
|
|
The economics favor doing this now and never again: the plugin contract is
|
|
pre-1.0 (breaking changes are cheap per ADR-002), no sister site has adopted
|
|
yet, there is no production instance, and the test suite plus CI give the
|
|
strongest safety net the project has had.
|
|
|
|
## Decision
|
|
|
|
Rename the domain in one coordinated pass:
|
|
|
|
| Current | New | Rationale |
|
|
|---|---|---|
|
|
| `plugins/equipment/`, `/api/equipment`, `equipment.*` perms | `plugins/machines/`, `/api/machines`, `machines.*` | plugin identity matches the domain |
|
|
| `equipment` table, `equipmentid` | `machines`, `machineid` | main entity |
|
|
| `equipmenttypes`, `equipmenttypeid`, `equipmenttype` | `machinetypes`, `machinetypeid`, `machinetype` | subtypes take the freed name |
|
|
| legacy `machinetypes`, `models.machinetypeid` | `modeltypes`, `models.modeltypeid` | role-accurate: it types the models catalog, losslessly (no collapse to the 4 asset types) |
|
|
| `assettypes.assettype = 'equipment'` (data) | `'machine'` | the string compare sites flip with it |
|
|
|
|
Migration placement follows ADR-008: the modeltypes rename and the data flips
|
|
land in the core chain (core tables, core data); the plugin table renames land
|
|
in the machines plugin's own chain, idempotently guarded so fresh installs
|
|
(whose core chain still creates the old names at `7c04`) rename on first
|
|
`flask plugin upgrade-all`. The `alembic_version_equipment` version table is
|
|
renamed to `alembic_version_machines` by the core migration so the plugin chain
|
|
resumes seamlessly on existing installs. The plugin registry auto-migrates an
|
|
`equipment` key to `machines` on load.
|
|
|
|
Historical migrations and accepted ADRs are not rewritten; old ids and ADR-005
|
|
wording remain as history.
|
|
|
|
## Consequences
|
|
|
|
- Upgrading instances run `flask db upgrade` then `flask plugin upgrade-all`,
|
|
same as every deploy; both migrations are idempotent.
|
|
- `/api/equipment` and `equipmentApi` cease to exist - a breaking change made
|
|
while there is nobody to break. After contract 1.0 this class of rename
|
|
would be a major-version event; this is the last cheap moment.
|
|
- The "Machine Types" settings card becomes "Model Types" and finally says
|
|
what it does; the machines plugin's subtype card owns the machine-types name.
|
|
- Contributors stop translating between UI vocabulary and code vocabulary.
|