From 46d63f74d195be32f01fb00eceb33b5c0b6fc53c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Tamarelle?= <jerome@tamarelle.net>
Date: Wed, 18 Sep 2024 09:32:15 +0200
Subject: [PATCH] Add traits to implement Command and SDAM subscriber methods

---
 src/Monitoring/CommandEvents.php | 24 ++++++++++++++
 src/Monitoring/SDAMEvents.php    | 54 ++++++++++++++++++++++++++++++++
 tests/MonitoringTest.php         | 42 +++++++++++++++++++++++++
 3 files changed, 120 insertions(+)
 create mode 100644 src/Monitoring/CommandEvents.php
 create mode 100644 src/Monitoring/SDAMEvents.php
 create mode 100644 tests/MonitoringTest.php

diff --git a/src/Monitoring/CommandEvents.php b/src/Monitoring/CommandEvents.php
new file mode 100644
index 000000000..965f45269
--- /dev/null
+++ b/src/Monitoring/CommandEvents.php
@@ -0,0 +1,24 @@
+<?php
+
+namespace MongoDB\Monitoring;
+
+use MongoDB\Driver\Monitoring\CommandFailedEvent;
+use MongoDB\Driver\Monitoring\CommandStartedEvent;
+use MongoDB\Driver\Monitoring\CommandSubscriber;
+use MongoDB\Driver\Monitoring\CommandSucceededEvent;
+
+/** @see CommandSubscriber */
+trait CommandEvents
+{
+    public function commandFailed(CommandFailedEvent $event): void
+    {
+    }
+
+    public function commandStarted(CommandStartedEvent $event): void
+    {
+    }
+
+    public function commandSucceeded(CommandSucceededEvent $event): void
+    {
+    }
+}
diff --git a/src/Monitoring/SDAMEvents.php b/src/Monitoring/SDAMEvents.php
new file mode 100644
index 000000000..1f3f8747e
--- /dev/null
+++ b/src/Monitoring/SDAMEvents.php
@@ -0,0 +1,54 @@
+<?php
+
+namespace MongoDB\Monitoring;
+
+use MongoDB\Driver\Monitoring\SDAMSubscriber;
+use MongoDB\Driver\Monitoring\ServerChangedEvent;
+use MongoDB\Driver\Monitoring\ServerClosedEvent;
+use MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent;
+use MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent;
+use MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent;
+use MongoDB\Driver\Monitoring\ServerOpeningEvent;
+use MongoDB\Driver\Monitoring\TopologyChangedEvent;
+use MongoDB\Driver\Monitoring\TopologyClosedEvent;
+use MongoDB\Driver\Monitoring\TopologyOpeningEvent;
+
+/** @see SDAMSubscriber */
+trait SDAMEvents
+{
+    public function serverChanged(ServerChangedEvent $event): void
+    {
+    }
+
+    public function serverClosed(ServerClosedEvent $event): void
+    {
+    }
+
+    public function serverHeartbeatFailed(ServerHeartbeatFailedEvent $event): void
+    {
+    }
+
+    public function serverHeartbeatStarted(ServerHeartbeatStartedEvent $event): void
+    {
+    }
+
+    public function serverHeartbeatSucceeded(ServerHeartbeatSucceededEvent $event): void
+    {
+    }
+
+    public function serverOpening(ServerOpeningEvent $event): void
+    {
+    }
+
+    public function topologyChanged(TopologyChangedEvent $event): void
+    {
+    }
+
+    public function topologyClosed(TopologyClosedEvent $event): void
+    {
+    }
+
+    public function topologyOpening(TopologyOpeningEvent $event): void
+    {
+    }
+}
diff --git a/tests/MonitoringTest.php b/tests/MonitoringTest.php
new file mode 100644
index 000000000..e43467b1d
--- /dev/null
+++ b/tests/MonitoringTest.php
@@ -0,0 +1,42 @@
+<?php
+
+namespace MongoDB\Tests;
+
+use MongoDB\Driver\Monitoring\CommandSubscriber;
+use MongoDB\Driver\Monitoring\SDAMSubscriber;
+use MongoDB\Driver\Monitoring\Subscriber;
+use MongoDB\Monitoring\CommandEvents;
+use MongoDB\Monitoring\SDAMEvents;
+
+use function MongoDB\Driver\Monitoring\addSubscriber;
+use function MongoDB\Driver\Monitoring\removeSubscriber;
+
+class MonitoringTest extends TestCase
+{
+    /**
+     * @doesNotPerformAssertions
+     *
+     * @dataProvider provideSubscribers
+     */
+    public function testSubscriber(Subscriber $subscriber): void
+    {
+        // Fatal error if the trait does not implement all methods required by the interface
+        addSubscriber($subscriber);
+        removeSubscriber($subscriber);
+    }
+
+    public static function provideSubscribers(): iterable
+    {
+        yield 'Command' => [
+            new class implements CommandSubscriber {
+                use CommandEvents;
+            },
+        ];
+
+        yield 'SDAM' => [
+            new class implements SDAMSubscriber {
+                use SDAMEvents;
+            },
+        ];
+    }
+}