Files
mcp-nextcloud/nextcloud_mcp_server/vector/webhook_parser.py
T
Chris CoutinhoandClaude Opus 4.7 fdcbd7bd3f feat(webhooks): add Deck card sync preset with vector indexing
Nextcloud Deck PR #7910 added IWebhookCompatibleEvent to CardCreated/
Updated/DeletedEvent and BoardUpdatedEvent, so Deck can finally emit
real-time webhooks via core's webhook_listeners app. Wire this into
the existing preset → parser → DocumentTask pipeline that already
backs Notes / Calendar / Tables / Forms / Files sync.

- Add deck_sync preset (app=deck, 4 events) and drop the stale
  "Deck does not support webhooks" comment.
- Teach webhook_parser to convert Deck card events into
  DocumentTask(doc_type=deck_card, operation=index|delete) with
  stack_id metadata. BoardUpdatedEvent logs delivery at INFO and
  returns None — the polling scanner reconciles affected cards.
- Cover three new unit tests for the deck create/delete/board-update
  paths plus symmetric fail-open tests for missing card.id /
  node.id in _parse_deck_event and _parse_file_event.

The astrolabe admin UI auto-discovers the new preset via
filter_presets_by_installed_apps(); no astrolabe-side wiring is
required for it to appear in the Webhook Management card grid.

Note: requires Deck ≥1.18.x (where PR #7910 lands); the preset is
hidden when the Deck app isn't installed.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-21 09:03:59 +02:00

148 lines
5.0 KiB
Python

"""Parse Nextcloud webhook payloads into DocumentTask objects.
Maps Nextcloud webhook events to vector-sync DocumentTasks. The handler at
``/webhooks/nextcloud`` calls :func:`extract_document_task` and forwards any
non-None result to the same processor send-stream the scanner uses.
Currently scoped to file (note) events and Deck card events. Calendar /
Tables events fall through to ``None`` for now; those parsers can be added
in follow-up changes.
See ADR-010 for the design and ``webhook-testing-findings.md`` for real
captured payloads.
"""
import logging
import re
from nextcloud_mcp_server.vector.scanner import DocumentTask
logger = logging.getLogger(__name__)
_FILE_EVENT_CREATED = "OCP\\Files\\Events\\Node\\NodeCreatedEvent"
_FILE_EVENT_WRITTEN = "OCP\\Files\\Events\\Node\\NodeWrittenEvent"
_FILE_EVENT_BEFORE_DELETED = "OCP\\Files\\Events\\Node\\BeforeNodeDeletedEvent"
_DECK_EVENT_CARD_CREATED = "OCA\\Deck\\Event\\CardCreatedEvent"
_DECK_EVENT_CARD_UPDATED = "OCA\\Deck\\Event\\CardUpdatedEvent"
_DECK_EVENT_CARD_DELETED = "OCA\\Deck\\Event\\CardDeletedEvent"
_DECK_EVENT_BOARD_UPDATED = "OCA\\Deck\\Event\\BoardUpdatedEvent"
_DECK_CARD_EVENTS = frozenset(
{
_DECK_EVENT_CARD_CREATED,
_DECK_EVENT_CARD_UPDATED,
_DECK_EVENT_CARD_DELETED,
}
)
# Matches paths inside any user's Notes folder ending in .md, e.g.
# "/admin/files/Notes/Sub/Note.md" or "/alice/files/Notes/foo.md".
_NOTES_PATH_RE = re.compile(r"^/[^/]+/files/Notes/.+\.md$")
def extract_document_task(payload: dict) -> DocumentTask | None:
"""Convert a Nextcloud webhook payload into a DocumentTask.
Returns None for any event we don't (yet) handle, or any event whose
target isn't a markdown file under a user's Notes folder. Callers should
treat None as "ignored" — not an error.
"""
try:
event = payload["event"]
event_class = event["class"]
user_id = payload["user"]["uid"]
time = int(payload.get("time", 0) or 0)
except (KeyError, TypeError, ValueError):
logger.debug("Webhook payload has missing or malformed envelope fields")
return None
if event_class in (
_FILE_EVENT_CREATED,
_FILE_EVENT_WRITTEN,
_FILE_EVENT_BEFORE_DELETED,
):
return _parse_file_event(event_class, event, user_id, time)
if event_class in _DECK_CARD_EVENTS or event_class == _DECK_EVENT_BOARD_UPDATED:
return _parse_deck_event(event_class, event, user_id, time)
logger.debug("Ignoring webhook for unsupported event: %s", event_class)
return None
def _parse_file_event(
event_class: str, event: dict, user_id: str, time: int
) -> DocumentTask | None:
node = event.get("node") or {}
path = node.get("path", "")
node_id = node.get("id")
if not _NOTES_PATH_RE.match(path):
# Not a note file — could be a parent folder, an unrelated file, etc.
return None
if node_id is None:
# BeforeNodeDeletedEvent should still carry node.id; if it doesn't
# we can't address the Qdrant points to delete. Skip rather than
# guess — the polling scanner will catch up via its grace period.
logger.warning(
"Webhook %s for note %s missing node.id; falling back to scanner",
event_class,
path,
)
return None
operation = "delete" if event_class == _FILE_EVENT_BEFORE_DELETED else "index"
return DocumentTask(
user_id=user_id,
doc_id=str(node_id),
doc_type="note",
operation=operation,
modified_at=time,
)
def _parse_deck_event(
event_class: str, event: dict, user_id: str, time: int
) -> DocumentTask | None:
# BoardUpdatedEvent carries only ``boardId`` — there's no card identifier to
# index. Log delivery so we can confirm webhook arrival in the receiver
# logs, and let the polling scanner reconcile the affected cards.
if event_class == _DECK_EVENT_BOARD_UPDATED:
board_id = event.get("boardId")
logger.info(
"Deck board %s updated; polling scanner will reconcile cards",
board_id,
)
return None
card = event.get("card") or {}
card_id = card.get("id")
stack_id = card.get("stackId")
if card_id is None:
# Without an id we can't address Qdrant points; the polling scanner
# will pick the change up on its next pass.
logger.warning(
"Webhook %s missing card.id; falling back to scanner",
event_class,
)
return None
operation = "delete" if event_class == _DECK_EVENT_CARD_DELETED else "index"
# board_id is not part of the Card payload — processor.py falls back to
# iterating boards/stacks if it's missing, so we pass stack_id only.
metadata = {"stack_id": stack_id} if stack_id is not None else None
return DocumentTask(
user_id=user_id,
doc_id=str(card_id),
doc_type="deck_card",
operation=operation,
modified_at=time,
metadata=metadata,
)