Show the kiosk label prefix, and let a plugin declare the settings it owns
This commit is contained in:
@@ -114,6 +114,11 @@ class PluginManager:
|
||||
per-plugin migrations extend that chain. See ADR-008. Idempotent.
|
||||
"""
|
||||
results: Dict[str, str] = {}
|
||||
# Settings declared by a later plugin version reach an already-installed
|
||||
# site here. on_install/on_enable fire only on a state transition, so an
|
||||
# upgrade is the only moment left to seed them. Runs even with no
|
||||
# migration manager - it is independent of the Alembic chains.
|
||||
self.sync_all_plugin_settings()
|
||||
if not self.migration_manager:
|
||||
return results
|
||||
# Only ADOPTED plugins (those in the registry) get migrated. A plugin
|
||||
@@ -134,6 +139,50 @@ class PluginManager:
|
||||
results[name] = f'error: {ex}'
|
||||
return results
|
||||
|
||||
def sync_all_plugin_settings(self) -> int:
|
||||
"""Seed every enabled plugin's declared settings. Idempotent.
|
||||
|
||||
Returns the number of plugins whose settings were touched. Best-effort
|
||||
per plugin: one bad plugin must not abort a deploy's upgrade pass.
|
||||
"""
|
||||
touched = 0
|
||||
for name in list(self.registry.get_all().keys()):
|
||||
if not self.registry.is_enabled(name):
|
||||
continue
|
||||
try:
|
||||
plugin = self.loader.load_plugin(name, self._app, self._db)
|
||||
except Exception:
|
||||
logger.exception("Could not load %s to sync its settings", name)
|
||||
continue
|
||||
if plugin and self._seed_plugin_settings(plugin):
|
||||
touched += 1
|
||||
return touched
|
||||
|
||||
def get_declared_plugin_settings(self) -> Dict[str, dict]:
|
||||
"""Return {key: declared entry} across all loaded plugins.
|
||||
|
||||
The settings API uses this to file a first-time write under the owning
|
||||
plugin's category instead of a placeholder, and to decide which keys an
|
||||
unauthenticated caller may read.
|
||||
"""
|
||||
declared: Dict[str, dict] = {}
|
||||
for name, plugin in self.loader.get_all_loaded().items():
|
||||
try:
|
||||
entries = plugin.get_settings_defaults() or []
|
||||
except Exception:
|
||||
logger.exception("get_settings_defaults failed for %s", name)
|
||||
continue
|
||||
for entry in entries:
|
||||
key = entry.get('key')
|
||||
if key:
|
||||
declared[key] = entry
|
||||
return declared
|
||||
|
||||
def get_public_setting_keys(self) -> set:
|
||||
"""Setting keys plugins declare readable without authentication."""
|
||||
return {key for key, entry in self.get_declared_plugin_settings().items()
|
||||
if entry.get('public')}
|
||||
|
||||
def _register_plugin_components(self, plugin: BasePlugin) -> None:
|
||||
"""Register plugin's blueprint, models, CLI commands, etc."""
|
||||
# Register blueprint
|
||||
@@ -260,6 +309,7 @@ class PluginManager:
|
||||
if plugin:
|
||||
self._register_plugin_components(plugin)
|
||||
self._seed_plugin_permissions(plugin)
|
||||
self._seed_plugin_settings(plugin)
|
||||
plugin.on_install(self._app)
|
||||
|
||||
logger.info(f"Installed plugin: {name} v{manifest_version}")
|
||||
@@ -288,6 +338,58 @@ class PluginManager:
|
||||
"Seeded %d permission(s) for plugin %s",
|
||||
created, plugin.meta.name)
|
||||
|
||||
def _seed_plugin_settings(self, plugin: BasePlugin) -> bool:
|
||||
"""Idempotently create Setting rows for a plugin's declared settings.
|
||||
|
||||
Runs at install, at enable, and on `flask plugin upgrade-all`. Existing
|
||||
values are never overwritten - only missing rows are created, and a row
|
||||
whose category does not match the declaration is re-homed. That repair
|
||||
matters: before a key was declared, the first save created it under the
|
||||
settings API's placeholder category, where the owning plugin's settings
|
||||
page (which filters by category) could not see it again, so the value
|
||||
looked like it never saved.
|
||||
|
||||
Returns True if anything was created or repaired. Best-effort: a plugin
|
||||
that raises must not abort the lifecycle.
|
||||
"""
|
||||
try:
|
||||
entries = plugin.get_settings_defaults() or []
|
||||
except Exception:
|
||||
logger.exception(
|
||||
"get_settings_defaults failed for %s", plugin.meta.name)
|
||||
return False
|
||||
if not entries:
|
||||
return False
|
||||
from shopdb.core.models import Setting
|
||||
created = 0
|
||||
repaired = 0
|
||||
with self._app.app_context():
|
||||
for entry in entries:
|
||||
key = entry.get('key')
|
||||
if not key:
|
||||
continue
|
||||
setting = Setting.query.filter_by(key=key).first()
|
||||
if setting is None:
|
||||
self._db.session.add(Setting(
|
||||
key=key,
|
||||
value=entry.get('value', ''),
|
||||
valuetype=entry.get('valuetype', 'string'),
|
||||
category=entry.get('category', 'plugin'),
|
||||
description=entry.get('description'),
|
||||
))
|
||||
created += 1
|
||||
continue
|
||||
category = entry.get('category')
|
||||
if category and setting.category != category:
|
||||
setting.category = category
|
||||
repaired += 1
|
||||
if created or repaired:
|
||||
self._db.session.commit()
|
||||
logger.info(
|
||||
"Plugin %s settings: %d created, %d re-homed",
|
||||
plugin.meta.name, created, repaired)
|
||||
return bool(created or repaired)
|
||||
|
||||
def _is_core_tier(self, name: str) -> bool:
|
||||
"""True when the plugin's manifest marks it tier=core (mandatory).
|
||||
|
||||
@@ -406,6 +508,7 @@ class PluginManager:
|
||||
plugin = self.loader.load_plugin(name, self._app, self._db)
|
||||
if plugin:
|
||||
self._seed_plugin_permissions(plugin)
|
||||
self._seed_plugin_settings(plugin)
|
||||
plugin.on_enable(self._app)
|
||||
except Exception:
|
||||
logger.exception(f"on_enable hook failed for plugin {name}")
|
||||
|
||||
@@ -104,6 +104,28 @@ class BasePlugin(ABC):
|
||||
"""
|
||||
return []
|
||||
|
||||
def get_settings_defaults(self) -> List[Dict]:
|
||||
"""Declare the Setting rows this plugin owns.
|
||||
|
||||
The framework seeds these at install, at enable, and on every
|
||||
`flask plugin upgrade-all`, so a setting added in a later plugin
|
||||
version reaches a site that installed an earlier one. Declaring a key
|
||||
here is also what tells the settings API which category and type the
|
||||
key belongs to, so a save never has to invent one.
|
||||
|
||||
Each entry is a dict:
|
||||
key - the Setting key
|
||||
value - default value (string form)
|
||||
valuetype - 'string' | 'boolean' | 'integer' | 'json'
|
||||
category - grouping the plugin's settings page filters on
|
||||
description - what the setting does
|
||||
public - True if an UNAUTHENTICATED caller may read it (kiosk
|
||||
and print pages render before login); default False.
|
||||
Never mark a credential or an integration URL public.
|
||||
Return [] (default) if the plugin owns no settings.
|
||||
"""
|
||||
return []
|
||||
|
||||
def get_setting(self, key: str, default=None):
|
||||
"""Read a plugin-scoped setting from the core Setting store.
|
||||
|
||||
|
||||
@@ -869,7 +869,10 @@ def upgrade_all_plugins():
|
||||
Idempotent. Run this after `flask db upgrade` on every deploy and
|
||||
upgrade. It stamps each bundled plugin's anchor revision into
|
||||
alembic_version_<plugin> and applies any per-plugin migrations added
|
||||
after the ownership cutover (ADR-008). Safe to re-run at head.
|
||||
after the ownership cutover (ADR-008). It also seeds any settings a
|
||||
plugin declares (get_settings_defaults) that this site is missing, so a
|
||||
setting added in a later version reaches a site that installed earlier.
|
||||
Safe to re-run at head.
|
||||
"""
|
||||
pm = current_app.extensions.get('plugin_manager')
|
||||
if not pm:
|
||||
|
||||
Reference in New Issue
Block a user