151d7c4f44
Whether somebody with no account may see something was being answered one feature at a time: a securesend_allow_guests setting, an enable flag per kiosk, and very nearly a third for guides - each with its own settings page, its own vocabulary and its own hand-written branch inside a route. Every one of them answered a permissions question, and this app already administers permissions per role. So a caller with no token is not nobody: they hold the seeded `guest` role. require_permission consults it when there is no identity, which is the entire mechanism. The role is seeded holding NOTHING, so an upgrade opens no door; a site opens one by ticking a box in the same grid it uses for every other role, and closes it the same way. Revocation is read on every request rather than cached, because taking guest access away is what somebody does the moment they realise what they opened, and it has to bite immediately. The redundant @jwt_required() above require_permission is gone from 184 routes. It was belt-and-braces before; now it is actively wrong, because it refuses a request with no token before the permission check can have an opinion, so a grant would appear to do nothing. What a guest may hold is bounded. Any .view or .read permission is grantable. A WRITE has to be blessed by whoever owns it, through the new get_guest_grantable_permissions hook (contract 0.21.0), and Secure Send is the only case that exists: sending a password to a vendor is the one write this product means to offer somebody who never signs in. Everything else is refused by the API and greyed out in the grid rather than warned about - a checkbox that quietly makes deleting an asset anonymous is not a warning anybody reads twice. A guest write records no creator: the trail says when and from where, never who, and that is the reason for the bar. GE-Enforce and Slides gained read permissions so they can be opened to guests without handing out the manage right. Their read routes accept either through require_any_permission, so nothing an existing manager could reach has moved. The navigation endpoint now returns only what the caller can actually reach. Without that a signed-out visitor gets a sidebar of the whole app where every link bounces off the login page, which reads as a broken site rather than as a closed door. A nav item may name several permissions; holding any one is enough, which is what GE-Enforce and Slides need now that a viewer and a manager hold different strings. Two things this found on the way: current_user is a LocalProxy, so `current_user is None` is False for a request with nobody behind it - harmless under a required JWT, an AttributeError the moment verification became optional. And an image pasted into a guide before its first save was never attached to it, so it was visible to editors and invisible to every reader; saving now attaches it, and `flask guides fix-images` repairs what is stored. The guides guest setting written earlier today is gone. Granting guides.view to the guest role replaces it, which is the point.
94 lines
4.3 KiB
Markdown
94 lines
4.3 KiB
Markdown
<!-- GENERATED by scripts/gen_project_map.py - do not edit by hand.
|
|
Regenerate with: venv/bin/python scripts/gen_project_map.py -->
|
|
|
|
# Project map
|
|
|
|
Derived from the code on every regeneration. If something here is wrong, the
|
|
code changed and the map was not regenerated - fix it by running the generator,
|
|
never by editing this file.
|
|
|
|
## Versions
|
|
|
|
| series | value | governed by |
|
|
|---|---|---|
|
|
| product `__version__` | `0.12.0` | ADR-007 |
|
|
| plugin contract `__contract_version__` | `0.21.0` | ADR-002 |
|
|
|
|
They move independently. A contract bump is not a release.
|
|
|
|
## Alembic chains (ADR-008)
|
|
|
|
Core runs with `flask db upgrade`; every plugin chain runs
|
|
with `flask plugin upgrade-all`. Both are needed on a deploy.
|
|
|
|
| chain | head |
|
|
|---|---|
|
|
| core | `7d34_singular_relationship_types` |
|
|
| backups | `backups0003clearlastseen` |
|
|
| computers | `computers0001anchor` |
|
|
| employees | `employees0002photo` |
|
|
| geenforce | `geenforce0004minlib` |
|
|
| guides | `guides0001baseline` |
|
|
| knowledgebase | `knowledgebase0001anchor` |
|
|
| machines | `machines0002rename` |
|
|
| measuringtools | `measuringtools0001baseline` |
|
|
| network | `network0003prefix` |
|
|
| notifications | `notifications0005boardorder` |
|
|
| printedparts | `printedparts0004txnrev` |
|
|
| printers | `printers0005observedqueues` |
|
|
| slides | `slides0001anchor` |
|
|
| tools | `tools0001securesend` |
|
|
| usb | `usb0002dropmachineid` |
|
|
| warranty | `warranty0002proof` |
|
|
|
|
## Bundled plugins (16)
|
|
|
|
| plugin | version | core_version | owns migrations |
|
|
|---|---|---|---|
|
|
| backups | 1.0.0 | >=0.16.0,<1.0.0 | yes |
|
|
| computers | 1.0.0 | >=0.20.0,<1.0.0 | yes |
|
|
| employees | 1.0.0 | >=0.1.0,<1.0.0 | yes |
|
|
| geenforce | 0.1.0 | >=0.18.0,<1.0.0 | yes |
|
|
| guides | 1.0.0 | >=0.1.0,<1.0.0 | yes |
|
|
| knowledgebase | 1.0.0 | >=0.1.0,<1.0.0 | yes |
|
|
| machines | 1.0.0 | >=0.20.0,<1.0.0 | yes |
|
|
| measuringtools | 1.0.0 | >=0.20.0,<1.0.0 | yes |
|
|
| network | 1.0.0 | >=0.20.0,<1.0.0 | yes |
|
|
| notifications | 1.0.0 | >=0.1.0,<1.0.0 | yes |
|
|
| printedparts | 0.1.0 | >=0.16.0,<1.0.0 | yes |
|
|
| printers | 1.0.0 | >=0.20.0,<1.0.0 | yes |
|
|
| slides | 2.0.0 | >=0.2.0,<1.0.0 | yes |
|
|
| tools | 1.0.0 | >=0.16.0,<1.0.0 | yes |
|
|
| usb | 1.0.0 | >=0.1.0,<1.0.0 | yes |
|
|
| warranty | 1.0.0 | >=0.2.0,<1.0.0 | yes |
|
|
|
|
Manifest-less directories under `plugins/` are core frontend surface and always ship: `applications`.
|
|
|
|
## Architecture decisions
|
|
|
|
| ADR | title | status |
|
|
|---|---|---|
|
|
| ADR-001-asset-as-platform-contract.md | ADR-001: Asset model is the platform contract | ACCEPTED |
|
|
| ADR-002-plugin-versioning.md | ADR-002: Plugin contract versioning | ACCEPTED |
|
|
| ADR-003-plugin-distribution.md | ADR-003: Plugin distribution model | ACCEPTED |
|
|
| ADR-004-deployment-topology.md | ADR-004: Deployment topology (per-site instances) | ACCEPTED |
|
|
| ADR-005-equipment-vs-measuringtools.md | ADR-005: Equipment plugin scope vs measuringtools plugin | ACCEPTED |
|
|
| ADR-006-collector-contract.md | ADR-006: Plugin collector contract pattern | ACCEPTED |
|
|
| ADR-007-product-versioning-and-releases.md | ADR-007: Product versioning and releases | ACCEPTED |
|
|
| ADR-008-plugin-migration-ownership.md | ADR-008: Plugin migration ownership (per-plugin chains from the cutover) | ACCEPTED |
|
|
| ADR-009-frontend-plugin-gating.md | ADR-009: Frontend plugin gating | ACCEPTED |
|
|
| ADR-010-frontend-plugin-hooks.md | ADR-010: Frontend plugin hook contract | ACCEPTED |
|
|
| ADR-011-machines-rename.md | ADR-011: Rename the equipment domain to machines; retype the models catalog with modeltypes | ACCEPTED |
|
|
| ADR-012-geenforce-manifest-ownership.md | ADR-012: GE-Enforce manifest ownership in shopdb | ACCEPTED |
|
|
| ADR-013-plugin-catalog-and-lean-builds.md | ADR-013: Plugin Catalog, Curated Shelf, and Lean Per-Site Builds | ACCEPTED |
|
|
| ADR-014-schema-lean-per-site.md | ADR-014: Schema-lean per-site builds (retire cross-plugin FKs, lift plugin tables) | ACCEPTED |
|
|
| ADR-015-site-specific-configuration.md | ADR-015: Where a site's own data is allowed to live | ACCEPTED |
|
|
| ADR-016-credential-delivery.md | ADR-016: Credential delivery to the fleet | ACCEPTED (decided; NOT yet implemented - |
|
|
| ADR-017-buildings-and-levels.md | ADR-017: Buildings and levels as the map model | ACCEPTED |
|
|
|
|
## Size
|
|
|
|
- test functions defined: **1413** (parametrised cases collect higher)
|
|
- documented API paths: **305** (`docs/openapi.json`, regenerate with `scripts/gen_openapi.py`)
|
|
|