ge-aerospace/shopdb-flask
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

contract 0.18.0: one name per display role, the kiosk's own

Browse Source 
Core called the roles dashboard / lobby / partskiosk. The kiosks call them
Dashboard / Lobby / 3DPrintRoom, which are the literal contents of
C:\Enrollment\display-type.txt, read by the GE-Enforce dispatcher to pick a
target. Two vocabularies for three kiosks, each with its own copy of the same
route map.

That is not cosmetic. A display reporting its own type sends what its file
says, so it could report a role core would not accept, and core could store
'partskiosk', a value no dispatcher would ever match. The enforcement report
column would have shown one vocabulary from the device and the other from the
DashboardDefault fallback, in the same column.

The machine's file wins, because that is what a person edits. DISPLAY_ROLE_PATHS
takes the kiosk spelling and the display scope now uses that dict rather than
holding a second one, so the two cannot drift again. normalize_display_role
resolves any casing and the retired 'partskiosk' forward; the dispatcher already
matched its map case-insensitively and the server now agrees with it.

Nothing is turned away over a capital: the API accepts any spelling and stores
the canonical one, displaypath resolves through the normalizer so rows written
before this keep working, and the settings dropdown canonicalises on open so an
old value does not render as a blank select.

A reported subtype is normalised on the way in, but an UNRECOGNISED one is kept
verbatim. That is a kiosk with a typo in its file or a role nobody declared, and
both are worth seeing in the fleet table rather than blanked or guessed at.

Contract bumped for the added names. DashboardDefault is finally listed in
__all__ too - 0.17.0 put it on the surface and never exported it.
This commit is contained in:
cproudlock
2026-08-13 09:28:26 -04:00
parent 9336577abe
commit 20a95013ad
12 changed files with 307 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
shopdb/__init__.py
View File

@@ -42,7 +42,13 @@ from .plugins import plugin_manager
# first-time write under the declared category, and lets a plugin mark a key
# readable without auth for pages that run logged out. Additive optional hook,
# minor bump.
__contract_version__ = '0.17.0'
# 0.18.0: added DISPLAY_ROLES, DISPLAY_ROLE_PATHS and normalize_display_role
# beside DashboardDefault (which 0.17.0 imported but never listed in __all__).
# The role vocabulary is now the kiosk's own - Dashboard / Lobby / 3DPrintRoom,
# the literal values of C:\Enrollment\display-type.txt - so a plugin holding its
# own copy of that map (geenforce did) can read core's instead of drifting from
# it. Additive names on the import surface, minor bump.
__contract_version__ = '0.18.0'
# Product release version (see ADR-007). The product version and the
# plugin-contract version above are distinct series with independent

13
shopdb/api/__init__.py
View File

@@ -51,7 +51,12 @@ from shopdb.core.models import (
# Display-role mapping (which kiosk shows which surface). On the surface
# because a plugin reporting on displays has no other way to name what a
# display IS - the role lives in core, not in any plugin.
from shopdb.core.models.dashboarddefault import DashboardDefault
from shopdb.core.models.dashboarddefault import (
DashboardDefault,
DISPLAY_ROLES,
DISPLAY_ROLE_PATHS,
normalize_display_role,
)
# Response + pagination helpers for plugin API blueprints
from shopdb.utils.responses import (
@@ -259,6 +264,12 @@ __all__ = [
'OperatingSystem',
'AssetRelationship',
'RelationshipType',
# Display roles. The role vocabulary is the kiosk's own, so a plugin that
# reads a reported display type resolves it the same way core does.
'DashboardDefault',
'DISPLAY_ROLES',
'DISPLAY_ROLE_PATHS',
'normalize_display_role',
# Response + pagination helpers
'success_response',
'error_response',

21
shopdb/core/api/dashboarddefaults.py
View File

@@ -9,7 +9,8 @@ from flask_jwt_extended import jwt_required
from shopdb.extensions import db
from shopdb.core.models import DashboardDefault, BusinessUnit, AuditLog
from shopdb.core.models.dashboarddefault import DISPLAY_ROLES, DISPLAY_ROLE_PATHS
from shopdb.core.models.dashboarddefault import (
DISPLAY_ROLES, DISPLAY_ROLE_PATHS, normalize_display_role)
from shopdb.utils.responses import success_response, error_response, ErrorCodes
from shopdb.utils.authz import require_role
@@ -117,17 +118,19 @@ def create_default():
data = request.get_json() or {}
fqdn = (data.get('fqdn') or '').strip().lower() or None
ipaddress = (data.get('ipaddress') or '').strip() or None
role = (data.get('displayrole') or 'dashboard').strip()
# Accept any casing and the retired spellings, store the canonical one, so a
# caller matching the kiosk's own file is never turned away over a capital.
role = normalize_display_role(data.get('displayrole') or 'Dashboard')
businessunitid = data.get('businessunitid')
if not fqdn and not ipaddress:
return error_response(ErrorCodes.VALIDATION_ERROR,
'fqdn or ipaddress is required')
if role not in DISPLAY_ROLES:
if not role:
return error_response(ErrorCodes.VALIDATION_ERROR,
f'displayrole must be one of {", ".join(DISPLAY_ROLES)}')
# Only the dashboard role needs a business unit (location).
if role == 'dashboard':
# Only the Dashboard role needs a business unit (location).
if role == 'Dashboard':
if not businessunitid:
return error_response(ErrorCodes.VALIDATION_ERROR,
'a location is required for the dashboard role')
@@ -167,8 +170,8 @@ def update_default(default_id):
data = request.get_json() or {}
if 'displayrole' in data:
role = (data.get('displayrole') or '').strip()
if role not in DISPLAY_ROLES:
role = normalize_display_role(data.get('displayrole'))
if not role:
return error_response(ErrorCodes.VALIDATION_ERROR,
f'displayrole must be one of {", ".join(DISPLAY_ROLES)}')
default.displayrole = role
@@ -187,8 +190,8 @@ def update_default(default_id):
if not default.fqdn and not default.ipaddress:
return error_response(ErrorCodes.VALIDATION_ERROR,
'fqdn or ipaddress is required')
# Non-dashboard roles carry no location; dashboard needs one.
if default.displayrole != 'dashboard':
# Non-Dashboard roles carry no location; Dashboard needs one.
if normalize_display_role(default.displayrole) != 'Dashboard':
default.businessunitid = None
elif not default.businessunitid:
return error_response(ErrorCodes.VALIDATION_ERROR,

49
shopdb/core/models/dashboarddefault.py
View File

@@ -9,15 +9,46 @@ lookups the kiosks call at launch.
from shopdb.extensions import db
from .base import BaseModel
# Display role -> the frontend kiosk path it maps to. Kept here so the API and
# any consumer resolve a role to a URL the same way.
# Display role -> the frontend kiosk path it maps to. THE one place a role is
# named, and the reason the names look like this: these are the literal values a
# person types into C:\Enrollment\display-type.txt on the kiosk itself, which the
# GE-Enforce dispatcher reads to pick a target. Two vocabularies used to exist -
# core said 'partskiosk' where the kiosk said '3DPrintRoom' - so a display could
# report a role core could not store and core could store a role no kiosk would
# ever match. The machine's own file wins, because that is what a person edits.
DISPLAY_ROLE_PATHS = {
'dashboard': '/shopfloor',
'lobby': '/tv',
'partskiosk': '/parts-kiosk',
'Dashboard': '/shopfloor',
'Lobby': '/tv',
'3DPrintRoom': '/parts-kiosk',
}
DISPLAY_ROLES = tuple(DISPLAY_ROLE_PATHS.keys())
# Retired spellings -> canonical. 'partskiosk' is what core called the 3D print
# room before the vocabularies were merged; rows and API callers still carry it.
LEGACY_DISPLAY_ROLES = {
'partskiosk': '3DPrintRoom',
}
def normalize_display_role(value):
"""Canonical role for any spelling, or None if it names no role.
Case-insensitive on purpose. The authoritative value is one line of a text
file edited by hand on the kiosk, so 'lobby', 'Lobby' and 'LOBBY' all arrive
in practice; the dispatcher already matches its own map case-insensitively
(-ieq) and this keeps the server agreeing with it. Retired spellings map
forward. Returns None rather than guessing, so an unrecognised value can be
stored verbatim and SEEN rather than silently rewritten to a wrong role.
"""
text = (value or '').strip()
if not text:
return None
lowered = text.lower()
for role in DISPLAY_ROLES:
if role.lower() == lowered:
return role
return LEGACY_DISPLAY_ROLES.get(lowered)
# GE device naming: a PC's DNS name is 'F' + its BIOS serial under the device
# domain, e.g. FABC1234.device.geaerospace.net. The domain is a setting so other
# sites can point elsewhere; the collector already reports the serial, so the
@@ -52,8 +83,8 @@ class DashboardDefault(BaseModel):
# not depend on innodb_large_prefix; FQDNs (F<serial>.<domain>) fit easily.
fqdn = db.Column(db.String(191), unique=True, nullable=True, index=True)
ipaddress = db.Column(db.String(50), unique=True, nullable=True)
# Which display the mapping drives. Only the dashboard role uses businessunitid.
displayrole = db.Column(db.String(20), nullable=False, default='dashboard')
# Which display the mapping drives. Only the Dashboard role uses businessunitid.
displayrole = db.Column(db.String(20), nullable=False, default='Dashboard')
businessunitid = db.Column(
db.Integer,
db.ForeignKey('businessunits.businessunitid'),
@@ -65,7 +96,9 @@ class DashboardDefault(BaseModel):
@property
def displaypath(self):
return DISPLAY_ROLE_PATHS.get(self.displayrole)
# Resolve through the normalizer so a legacy or oddly-cased stored value
# still finds its path instead of silently returning None.
return DISPLAY_ROLE_PATHS.get(normalize_display_role(self.displayrole))
def __repr__(self):
return f"<DashboardDefault {self.fqdn or self.ipaddress} -> {self.displayrole}>"