Files
Chris CoutinhoandClaude Opus 4.8 1322e5aba0 feat(vector): index files in real time on vector-index tag changes
Tagging an existing file/folder emits only OCP\SystemTag\MapperEvent — never a
Node*Event — so tagged PDFs were previously only picked up by the hourly
scanner. Subscribe to the tag event and reconcile membership so adding/removing
the `vector-index` tag (re)indexes in near-real time.

- webhook_presets: add OCP\SystemTag\MapperEvent to the files_sync preset
  (NC 32+, where MapperEvent gained getWebhookSerializable(); harmless on older
  servers — it just never fires).
- webhook_parser: parse MapperEvent (objectType=files) into a path-less file
  "reconcile" task. The payload carries only a fileid + tagIds (no name/path),
  so assign and unassign both collapse to a reconcile.
- processor._reconcile_tag_event: resolve the fileid against the user's current
  vector-index PDFs (find_files_by_tag). Present -> index with the resolved
  path/etag; absent -> flip to delete. Naturally handles "an unrelated tag
  changed" and a tagged folder's own fileid (no-op; the scanner still expands
  folders to descendants).
- Unit tests for the parser branch and the reconcile.

The matching admin-UI preset change ships separately in the astrolabe app repo.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-05 16:20:05 +02:00

189 lines
6.8 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, Deck card events, and SystemTag
assign/unassign events (which drive ``vector-index`` (re)indexing of files).
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"
# System-tag assign/unassign. A single event class covers both directions; the
# payload's ``eventType`` distinguishes them. Webhook-deliverable on NC 32+
# (MapperEvent gained ``getWebhookSerializable()`` in 32.0.0).
_SYSTEMTAG_EVENT_MAPPER = "OCP\\SystemTag\\MapperEvent"
_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)
if event_class == _SYSTEMTAG_EVENT_MAPPER:
return _parse_tag_event(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_tag_event(event: dict, user_id: str, time: int) -> DocumentTask | None:
"""Convert a SystemTag ``MapperEvent`` (assign/unassign) into a reconcile task.
The NC 32+ payload (``getWebhookSerializable``) carries only ``objectType``,
``objectId`` (a fileid) and ``tagIds`` — not the tag *name*, the file path,
or whether our ``vector-index`` tag specifically changed. So we can't decide
index-vs-delete here. Emit a file task with ``file_path=None``; the processor
resolves the file's *current* ``vector-index`` membership and indexes or
deletes accordingly (see ``processor._reconcile_tag_event``). Both assign and
unassign collapse to the same reconcile, which also makes "an unrelated tag
changed" a cheap no-op.
"""
object_type = event.get("objectType")
object_id = event.get("objectId")
# Only file tags drive vector sync; NC tags other object types too
# (comments, etc.). ``objectId`` of 0/"" is malformed — skip.
if object_type != "files" or not object_id:
return None
return DocumentTask(
user_id=user_id,
doc_id=str(object_id),
doc_type="file",
# Reconciled in the processor; may be flipped to "delete" if the file is
# no longer a tagged PDF. file_path=None is the "needs reconcile" signal.
operation="index",
modified_at=time,
file_path=None,
)
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,
)