Chris CoutinhoandClaude Opus 4.7
c1368b9a7f
Addresses round-3 review feedback on PR #747: - webhook_receiver: wrap send_stream.send() in anyio.fail_after(1.0) and return 503 with reason="queue full" if the queue is saturated. Avoids pinning the handler until NC's outbound timeout fires; the 503 retry contract is the same as the existing "sync not running" branch. - webhook_receiver: revise the compare_digest comment to match what the function actually guarantees — it avoids the per-character short-circuit of `==` but is not fully constant-time across length differences. - _get_webhook_uri: read WEBHOOK_INTERNAL_URL and NEXTCLOUD_MCP_SERVER_URL via dynaconf so operators using settings.toml (rather than env vars) aren't silently routed into the docker/localhost fallback. Adds webhook_internal_url to Settings/_DEFAULTS/_field_map; nextcloud_mcp_server_url already existed. Docker-detection markers stay on os.getenv since they're container-runtime signals, not user-facing config. - webhook_routes: sweep remaining f-string logger calls to lazy %s formatting per CLAUDE.md. - client/webhooks: modernise full file's type hints to dict / list / | None per CLAUDE.md. Tests: - New test_returns_503_when_queue_is_full exercises the timeout branch with a saturated buffer and a shortened deadline. - test_webhook_uri tests now patch get_settings (matching the auth-pair tests in the same file) instead of monkeypatching env vars directly. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
120 lines
4.1 KiB
Python
120 lines
4.1 KiB
Python
"""Client for Nextcloud Webhook Listeners API operations."""
|
|
|
|
from typing import Any
|
|
|
|
from nextcloud_mcp_server.client.base import BaseNextcloudClient
|
|
|
|
|
|
class WebhooksClient(BaseNextcloudClient):
|
|
"""Client for Nextcloud webhook_listeners app API operations."""
|
|
|
|
app_name = "webhooks"
|
|
|
|
def _get_webhook_headers(
|
|
self, additional_headers: dict[str, str] | None = None
|
|
) -> dict[str, str]:
|
|
"""Get standard headers required for Webhook Listeners API calls."""
|
|
headers = {"OCS-APIRequest": "true", "Accept": "application/json"}
|
|
if additional_headers:
|
|
headers.update(additional_headers)
|
|
return headers
|
|
|
|
async def list_webhooks(self) -> list[dict[str, Any]]:
|
|
"""List all registered webhooks for the current user.
|
|
|
|
Returns:
|
|
List of webhook registrations with id, uri, event, filters, etc.
|
|
"""
|
|
headers = self._get_webhook_headers()
|
|
response = await self._make_request(
|
|
"GET",
|
|
"/ocs/v2.php/apps/webhook_listeners/api/v1/webhooks",
|
|
headers=headers,
|
|
)
|
|
data = response.json()["ocs"]["data"]
|
|
return data if isinstance(data, list) else []
|
|
|
|
async def create_webhook(
|
|
self,
|
|
event: str,
|
|
uri: str,
|
|
http_method: str = "POST",
|
|
auth_method: str = "none",
|
|
headers: dict[str, str] | None = None,
|
|
auth_data: dict[str, str] | None = None,
|
|
event_filter: dict[str, Any] | None = None,
|
|
) -> dict[str, Any]:
|
|
"""Register a new webhook for the specified event.
|
|
|
|
Args:
|
|
event: Fully qualified event class name (e.g., "OCP\\Files\\Events\\Node\\NodeCreatedEvent")
|
|
uri: Webhook endpoint URL to receive event notifications
|
|
http_method: HTTP method for webhook delivery (default: "POST")
|
|
auth_method: Authentication method. Nextcloud's webhook_listeners
|
|
app accepts only ``"none"`` or ``"header"``.
|
|
headers: Optional static request headers attached to every
|
|
delivery (stored in clear text on the NC side).
|
|
auth_data: When ``auth_method="header"``, a dict of headers
|
|
holding the auth credentials. Stored encrypted at-rest in
|
|
Nextcloud's database and merged into the delivery request
|
|
at send time. Required when ``auth_method="header"``.
|
|
event_filter: JSON object specifying event filters (e.g., {"user.uid": "bob"})
|
|
|
|
Returns:
|
|
Webhook registration details including webhook ID
|
|
"""
|
|
data: dict[str, Any] = {
|
|
"httpMethod": http_method,
|
|
"uri": uri,
|
|
"event": event,
|
|
"authMethod": auth_method,
|
|
}
|
|
|
|
if headers:
|
|
data["headers"] = headers
|
|
|
|
if auth_data:
|
|
data["authData"] = auth_data
|
|
|
|
if event_filter:
|
|
data["eventFilter"] = event_filter
|
|
|
|
request_headers = self._get_webhook_headers()
|
|
response = await self._make_request(
|
|
"POST",
|
|
"/ocs/v2.php/apps/webhook_listeners/api/v1/webhooks",
|
|
json=data,
|
|
headers=request_headers,
|
|
)
|
|
return response.json()["ocs"]["data"]
|
|
|
|
async def delete_webhook(self, webhook_id: int) -> None:
|
|
"""Delete a webhook registration.
|
|
|
|
Args:
|
|
webhook_id: ID of the webhook to delete
|
|
"""
|
|
headers = self._get_webhook_headers()
|
|
await self._make_request(
|
|
"DELETE",
|
|
f"/ocs/v2.php/apps/webhook_listeners/api/v1/webhooks/{webhook_id}",
|
|
headers=headers,
|
|
)
|
|
|
|
async def get_webhook(self, webhook_id: int) -> dict[str, Any]:
|
|
"""Get details of a specific webhook registration.
|
|
|
|
Args:
|
|
webhook_id: ID of the webhook to retrieve
|
|
|
|
Returns:
|
|
Webhook registration details
|
|
"""
|
|
headers = self._get_webhook_headers()
|
|
response = await self._make_request(
|
|
"GET",
|
|
f"/ocs/v2.php/apps/webhook_listeners/api/v1/webhooks/{webhook_id}",
|
|
headers=headers,
|
|
)
|
|
return response.json()["ocs"]["data"]
|