Merge pull request #7910 from cbcoutinho/feat/webhook-compatible-events

feat(events): make card, ACL and board events webhook-compatible

Author: grnd-alt

lib/Event/AAclEvent.php

@@ -12,8 +12,9 @@
 
 use OCA\Deck\Db\Acl;
 use OCP\EventDispatcher\Event;
+use OCP\EventDispatcher\IWebhookCompatibleEvent;
 
-abstract class AAclEvent extends Event {
+abstract class AAclEvent extends Event implements IWebhookCompatibleEvent {
 	private $acl;
 
 	public function __construct(Acl $acl) {
@@ -29,4 +30,10 @@ public function getAcl(): Acl {
 	public function getBoardId(): int {
 		return $this->acl->getBoardId();
 	}
+
+	public function getWebhookSerializable(): array {
+		return [
+			'acl' => $this->acl->jsonSerialize(),
+		];
+	}
 }

lib/Event/ACardEvent.php

@@ -12,8 +12,9 @@
 
 use OCA\Deck\Db\Card;
 use OCP\EventDispatcher\Event;
+use OCP\EventDispatcher\IWebhookCompatibleEvent;
 
-abstract class ACardEvent extends Event {
+abstract class ACardEvent extends Event implements IWebhookCompatibleEvent {
 	private $card;
 
 	public function __construct(Card $card) {
@@ -25,4 +26,10 @@ public function __construct(Card $card) {
 	public function getCard(): Card {
 		return $this->card;
 	}
+
+	public function getWebhookSerializable(): array {
+		return [
+			'card' => $this->card->jsonSerialize(),
+		];
+	}
 }

lib/Event/BoardUpdatedEvent.php

@@ -11,8 +11,9 @@
 namespace OCA\Deck\Event;
 
 use OCP\EventDispatcher\Event;
+use OCP\EventDispatcher\IWebhookCompatibleEvent;
 
-class BoardUpdatedEvent extends Event {
+class BoardUpdatedEvent extends Event implements IWebhookCompatibleEvent {
 	private $boardId;
 
 	public function __construct(int $boardId) {
@@ -24,4 +25,10 @@ public function __construct(int $boardId) {
 	public function getBoardId(): int {
 		return $this->boardId;
 	}
+
+	public function getWebhookSerializable(): array {
+		return [
+			'boardId' => $this->boardId,
+		];
+	}
 }

tests/unit/Event/WebhookCompatibleEventsTest.php

@@ -0,0 +1,57 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+declare(strict_types=1);
+
+namespace OCA\Deck\Event;
+
+use OCA\Deck\Db\Acl;
+use OCA\Deck\Db\Card;
+use OCP\EventDispatcher\IWebhookCompatibleEvent;
+use Test\TestCase;
+
+class WebhookCompatibleEventsTest extends TestCase {
+	public function testCardEventIsWebhookCompatible(): void {
+		$card = new Card();
+		$card->setId(42);
+		$card->setTitle('Test card');
+		$card->setStackId(1);
+
+		$event = new CardCreatedEvent($card);
+
+		$this->assertInstanceOf(IWebhookCompatibleEvent::class, $event);
+		$payload = $event->getWebhookSerializable();
+		$this->assertArrayHasKey('card', $payload);
+		$this->assertSame(42, $payload['card']['id']);
+		$this->assertSame('Test card', $payload['card']['title']);
+	}
+
+	public function testAclEventIsWebhookCompatible(): void {
+		$acl = new Acl();
+		$acl->setId(7);
+		$acl->setBoardId(3);
+		$acl->setType(Acl::PERMISSION_TYPE_USER);
+		$acl->setParticipant('alice');
+		$acl->setPermissionEdit(true);
+
+		$event = new AclCreatedEvent($acl);
+
+		$this->assertInstanceOf(IWebhookCompatibleEvent::class, $event);
+		$payload = $event->getWebhookSerializable();
+		$this->assertArrayHasKey('acl', $payload);
+		$this->assertSame(7, $payload['acl']['id']);
+		$this->assertSame(3, $payload['acl']['boardId']);
+		$this->assertArrayNotHasKey('token', $payload['acl'], 'token must be stripped from serialized ACL');
+	}
+
+	public function testBoardUpdatedEventIsWebhookCompatible(): void {
+		$event = new BoardUpdatedEvent(99);
+
+		$this->assertInstanceOf(IWebhookCompatibleEvent::class, $event);
+		$this->assertSame(['boardId' => 99], $event->getWebhookSerializable());
+	}
+}