fix: Make webhook event serialization opt-in with a new interface

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>

5 files changed, 32 insertions, 6 deletions

diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php
index 0fe1314644f..dbd9ebc66ab 100644
--- a/lib/composer/composer/autoload_classmap.php
+++ b/lib/composer/composer/autoload_classmap.php
@@ -281,6 +281,7 @@ return array(
     'OCP\\EventDispatcher\\GenericEvent' => $baseDir . '/lib/public/EventDispatcher/GenericEvent.php',
     'OCP\\EventDispatcher\\IEventDispatcher' => $baseDir . '/lib/public/EventDispatcher/IEventDispatcher.php',
     'OCP\\EventDispatcher\\IEventListener' => $baseDir . '/lib/public/EventDispatcher/IEventListener.php',
+    'OCP\\EventDispatcher\\IWebhookCompatibleEvent' => $baseDir . '/lib/public/EventDispatcher/IWebhookCompatibleEvent.php',
     'OCP\\EventDispatcher\\JsonSerializer' => $baseDir . '/lib/public/EventDispatcher/JsonSerializer.php',
     'OCP\\Exceptions\\AbortedEventException' => $baseDir . '/lib/public/Exceptions/AbortedEventException.php',
     'OCP\\Exceptions\\AppConfigException' => $baseDir . '/lib/public/Exceptions/AppConfigException.php',
diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php
index cf52b9026f1..9f3b289cdfc 100644
--- a/lib/composer/composer/autoload_static.php
+++ b/lib/composer/composer/autoload_static.php
@@ -322,6 +322,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OCP\\EventDispatcher\\GenericEvent' => __DIR__ . '/../../..' . '/lib/public/EventDispatcher/GenericEvent.php',
         'OCP\\EventDispatcher\\IEventDispatcher' => __DIR__ . '/../../..' . '/lib/public/EventDispatcher/IEventDispatcher.php',
         'OCP\\EventDispatcher\\IEventListener' => __DIR__ . '/../../..' . '/lib/public/EventDispatcher/IEventListener.php',
+        'OCP\\EventDispatcher\\IWebhookCompatibleEvent' => __DIR__ . '/../../..' . '/lib/public/EventDispatcher/IWebhookCompatibleEvent.php',
         'OCP\\EventDispatcher\\JsonSerializer' => __DIR__ . '/../../..' . '/lib/public/EventDispatcher/JsonSerializer.php',
         'OCP\\Exceptions\\AbortedEventException' => __DIR__ . '/../../..' . '/lib/public/Exceptions/AbortedEventException.php',
         'OCP\\Exceptions\\AppConfigException' => __DIR__ . '/../../..' . '/lib/public/Exceptions/AppConfigException.php',
diff --git a/lib/public/EventDispatcher/IWebhookCompatibleEvent.php b/lib/public/EventDispatcher/IWebhookCompatibleEvent.php
new file mode 100644
index 00000000000..b13c35c187b
--- /dev/null
+++ b/lib/public/EventDispatcher/IWebhookCompatibleEvent.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCP\EventDispatcher;
+
+/**
+ * Interface for events which can be listened to by webhooks
+ *
+ * @since 30.0.0
+ */
+interface IWebhookCompatibleEvent {
+	/**
+	 * Return data to be serialized and sent to the webhook. Will be serialized using json_encode.
+	 *
+	 * @since 30.0.0
+	 */
+	public function getWebhookSerializable(): array;
+}
diff --git a/lib/public/Files/Events/Node/AbstractNodeEvent.php b/lib/public/Files/Events/Node/AbstractNodeEvent.php
index cc27bdd8cfd..64b0e3a3aa5 100644
--- a/lib/public/Files/Events/Node/AbstractNodeEvent.php
+++ b/lib/public/Files/Events/Node/AbstractNodeEvent.php
@@ -9,13 +9,14 @@ declare(strict_types=1);
 namespace OCP\Files\Events\Node;
 
 use OCP\EventDispatcher\Event;
+use OCP\EventDispatcher\IWebhookCompatibleEvent;
 use OCP\EventDispatcher\JsonSerializer;
 use OCP\Files\Node;
 
 /**
  * @since 20.0.0
  */
-abstract class AbstractNodeEvent extends Event implements \JsonSerializable {
+abstract class AbstractNodeEvent extends Event implements IWebhookCompatibleEvent {
 	/**
 	 * @since 20.0.0
 	 */
@@ -34,9 +35,8 @@ abstract class AbstractNodeEvent extends Event implements \JsonSerializable {
 	/**
 	 * @since 30.0.0
 	 */
-	public function jsonSerialize(): array {
+	public function getWebhookSerializable(): array {
 		return [
-			'class' => static::class,
 			'node' => JsonSerializer::serializeFileInfo($this->node),
 		];
 	}
diff --git a/lib/public/Files/Events/Node/AbstractNodesEvent.php b/lib/public/Files/Events/Node/AbstractNodesEvent.php
index b5fd1b75898..7941a9e596a 100644
--- a/lib/public/Files/Events/Node/AbstractNodesEvent.php
+++ b/lib/public/Files/Events/Node/AbstractNodesEvent.php
@@ -9,13 +9,14 @@ declare(strict_types=1);
 namespace OCP\Files\Events\Node;
 
 use OCP\EventDispatcher\Event;
+use OCP\EventDispatcher\IWebhookCompatibleEvent;
 use OCP\EventDispatcher\JsonSerializer;
 use OCP\Files\Node;
 
 /**
  * @since 20.0.0
  */
-abstract class AbstractNodesEvent extends Event {
+abstract class AbstractNodesEvent extends Event implements IWebhookCompatibleEvent {
 	/**
 	 * @since 20.0.0
 	 */
@@ -42,9 +43,8 @@ abstract class AbstractNodesEvent extends Event {
 	/**
 	 * @since 30.0.0
 	 */
-	public function jsonSerialize(): array {
+	public function getWebhookSerializable(): array {
 		return [
-			'class' => static::class,
 			'source' => JsonSerializer::serializeFileInfo($this->source),
 			'target' => JsonSerializer::serializeFileInfo($this->target),
 		];