lukasandClaude Opus 4.8
4e077f1a37
Backend foundation for the plugin platform (SPEC §11), Phases 1-3.
Phase 1 — SDK + loader:
- app/plugins/types.py: frozen Plugin/UiManifest/Slot/Page/JobSpec contract.
- app/plugins/sdk.py: sdk(name) facade — the only app.* import allowed for plugins
(scoped session, plugin.{name}.* publish, blob, outbox, settings, SSRF http_get, KV, enqueue).
- app/plugins/loader.py: entry-point discovery (webmail.plugins), hook forwarding
(API + worker), router mounting at /api/plugins/{name}, ui-manifest aggregation.
- plugin_kv core table (migration 0013) + GET /api/plugins/ui-manifest.
Phase 2 — non-removable core plugins + DB-enforced privacy:
- builtin flag (calendar/contacts will be builtin=True; uninstall refuses them).
- RLS per-user isolation on plg_* tables: least-privilege webmail_plugin role
(migration 0014), plugin_session(user_id) sets LOCAL ROLE + app.current_user_id,
rls.enable_rls() (ENABLE+FORCE RLS + USING/WITH CHECK policy). Mail untouched.
- Per-plugin Alembic runner (shared env, dedicated version table) + install/uninstall
--drop-data CLI; skeleton fixture proves install -> run -> uninstall --drop-data
leaves zero residue (§12 M3 acceptance).
Phase 3 — plugin jobs (§11.2):
- JobSpec registered as arq function plg.{plugin}.{func} + cron (5-field parser);
singleton=True guarded by a per-(plugin,user) Redis lock; wired onto the shared
interactive worker.
Gates: ruff, mypy --strict (94 files + tests), full suite 326 passed. RLS isolation,
migration round-trip, and singleton lock covered by tests.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Rcj3TpydMTzTSmU7kunzf8
64 lines
2.3 KiB
Python
64 lines
2.3 KiB
Python
"""Namespaced key/value store handed to plugins (SPEC §11 ``plugin_kv``).
|
|
|
|
A :class:`PluginKv` is bound to one (plugin, user_id) slice of the core
|
|
``plugin_kv`` table; values are arbitrary JSON. This is the light-state store
|
|
every plugin gets — heavy plugins use their own ``plg_``-prefixed tables (§11.1).
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import uuid
|
|
from typing import Any
|
|
|
|
from sqlalchemy import delete, select
|
|
from sqlalchemy.dialects.postgresql import insert as pg_insert
|
|
|
|
from app.db import session_scope
|
|
from app.models import PluginKv
|
|
|
|
|
|
class PluginKvStore:
|
|
"""CRUD over one plugin's per-user KV slice. Instantiate via ``sdk.kv(user_id)``."""
|
|
|
|
def __init__(self, plugin: str, user_id: uuid.UUID) -> None:
|
|
self._plugin = plugin
|
|
self._user_id = user_id
|
|
|
|
async def get(self, key: str, default: Any = None) -> Any:
|
|
async with session_scope() as session:
|
|
row = await session.get(PluginKv, (self._plugin, self._user_id, key))
|
|
return row.value if row is not None else default
|
|
|
|
async def set(self, key: str, value: Any) -> None:
|
|
"""Upsert ``key`` -> ``value`` (JSON-serialisable)."""
|
|
stmt = (
|
|
pg_insert(PluginKv)
|
|
.values(plugin=self._plugin, user_id=self._user_id, key=key, value=value)
|
|
.on_conflict_do_update(
|
|
index_elements=[PluginKv.plugin, PluginKv.user_id, PluginKv.key],
|
|
set_={"value": value},
|
|
)
|
|
)
|
|
async with session_scope() as session:
|
|
await session.execute(stmt)
|
|
|
|
async def delete(self, key: str) -> None:
|
|
async with session_scope() as session:
|
|
await session.execute(
|
|
delete(PluginKv).where(
|
|
PluginKv.plugin == self._plugin,
|
|
PluginKv.user_id == self._user_id,
|
|
PluginKv.key == key,
|
|
)
|
|
)
|
|
|
|
async def items(self) -> dict[str, Any]:
|
|
"""Return every key/value in this plugin+user slice."""
|
|
async with session_scope() as session:
|
|
rows = await session.execute(
|
|
select(PluginKv.key, PluginKv.value).where(
|
|
PluginKv.plugin == self._plugin, PluginKv.user_id == self._user_id
|
|
)
|
|
)
|
|
return dict(rows.all()) # type: ignore[arg-type]
|