Files

cproudlock 534f179ee6 Make main the lean product a site receives

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.

2026-09-19 11:24:40 -04:00

2.1 KiB

Raw Blame History

Restore Simulation (FOR DEVELOPER USE ONLY)

simulate-restore.sh is a developer diagnostic that proves the backup/restore pair round-trips the live database. It is NOT an operator tool and NOT part of the shipped feature. It mutates a live database on purpose - never run it against production or anything you cannot disturb.

Testing cadence

Before merging any change to scripts/backup/*.sh, docker-compose.backup.yml, or shopdb/core/api/shopdbbackups.py.
Before cutting a release that touches the backup/restore surface.
After a schema migration that adds or drops tables (new table archetype).
Ad hoc when investigating a restore-fidelity concern.

What it does

Requests a backup through the real .backup-requested sentinel.
Fingerprints every base table with CHECKSUM TABLE (the restore target).
Quiesces the api service, mutates the table archetypes:
- core standalone (vendor rename, setting flip)
- consumable ledger (modelsupplies.quantityonhand bump)
Requests a restore through the real .restore-requested sentinel.
Re-fingerprints and asserts every table returned to backup-time state.
Writes simulate-restore-results.txt next to the script.

Testing parameters

Stack must be up with the backup profile: docker compose -f docker-compose.yml -f docker-compose.backup.yml --profile backup up -d
Run from git bash on the host: bash scripts/backup/simulate-restore.sh
Coverage: all BASE TABLE rows in shopdb_flask (110+ tables), one pass.

Expected drift (NOT failures)

apitokens: the app rewrites token last-used continuously; restore is correct at backup time.
Endpoint-agent tables (computers, endpointstates, endpointevents, endpointapplications): external fleet agents keep writing after restore and cannot be quiesced from here.
Asset ROW deletion is not permitted in a live/CMMC environment (RESTRICT + compliance). The cascade edge is reported informationally only. A missing or corrupted asset is still fully restored because the dump drops and recreates the table - restore fidelity does not depend on a live delete.

2.1 KiB Raw Blame History