Add the get_permissions plugin hook (contract 0.10.0)
All checks were successful
CI / backend (push) Successful in 1m20s
CI / naming (push) Successful in 2s
CI / frontend (push) Successful in 8s

Plugins declare their own RBAC permissions instead of core accumulating
them: 36 permissions moved out of the core catalog into the 9 owning
plugins (core keeps the 19 its own blueprints enforce). The catalog is
resolved dynamically (core + enabled plugins) and feeds the roles grid,
the token scope picker and ceiling, and flask seed permissions;
installing or enabling a plugin seeds its permissions automatically. A
disabled plugin drops out of the assignable catalog while existing role
links keep working. New plugins - bundled or external - now bring their
permissions with zero core edits.

781 tests pass; live-verified with a machines.edit-scoped token.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
cproudlock
2026-07-12 09:29:55 -04:00
parent 12175169e4
commit 7dfbe7bf8a
22 changed files with 439 additions and 90 deletions

View File

@@ -220,11 +220,35 @@ class PluginManager:
plugin = self.loader.load_plugin(name, self._app, self._db)
if plugin:
self._register_plugin_components(plugin)
self._seed_plugin_permissions(plugin)
plugin.on_install(self._app)
logger.info(f"Installed plugin: {name} v{manifest_version}")
return True
def _seed_plugin_permissions(self, plugin: BasePlugin) -> None:
"""Idempotently create Permission rows for a plugin's declared perms.
Runs at install and enable so a fresh plugin's RBAC permissions exist
without a separate `flask seed permissions` pass. Best-effort: a plugin
that raises must not abort the lifecycle."""
try:
entries = plugin.get_permissions() or []
except Exception:
logger.exception(
"get_permissions failed for %s", plugin.meta.name)
return
if not entries:
return
from shopdb.core.models import Permission
with self._app.app_context():
created = Permission.seed_entries(entries)
if created:
self._db.session.commit()
logger.info(
"Seeded %d permission(s) for plugin %s",
created, plugin.meta.name)
def uninstall_plugin(self, name: str, remove_data: bool = False) -> bool:
"""
Uninstall a plugin.
@@ -305,6 +329,7 @@ class PluginManager:
try:
plugin = self.loader.load_plugin(name, self._app, self._db)
if plugin:
self._seed_plugin_permissions(plugin)
plugin.on_enable(self._app)
except Exception:
logger.exception(f"on_enable hook failed for plugin {name}")

View File

@@ -209,6 +209,40 @@ class BasePlugin(ABC):
"""
return []
def get_permissions(self) -> List:
"""
Return the RBAC permissions this plugin owns.
Each entry is a (name, description, category) tuple, matching the core
permission catalog shape (dicts with those keys are also accepted):
[
('machines.view', 'View machines', 'machines'),
('machines.create', 'Create machines', 'machines'),
('machines.edit', 'Edit machines', 'machines'),
('machines.delete', 'Delete machines', 'machines'),
]
A plugin owns the permission names its own routes enforce via
require_permission; core no longer accumulates them. The names must
follow the naming convention (lowercase dotted, e.g. `machines.edit`).
Consumed by full_permission_catalog(): core permissions plus every
ENABLED plugin's get_permissions(). That catalog backs `flask seed
permissions`, the role-management grid (GET /api/users/permissions),
and API-token scope validation. Plugin install/enable also seeds the
plugin's own permissions idempotently.
Disabled plugins are skipped by the catalog, so their permissions are
no longer offered for new scope grants or new role assignments. The
Permission ROWS already in the database are NOT deleted, so roles that
already reference them keep working until an admin edits the role. A
broken plugin is isolated in prod and re-raised in dev/test.
Return [] (the default) if the plugin needs no permissions.
"""
return []
def get_reports(self) -> List[Dict]:
"""
Return report card definitions for the Reports hub.