From 128e92a60dc27c95766d767d3d18c7bf66309a8c Mon Sep 17 00:00:00 2001
From: Brett McBride <brett@deakin.edu.au>
Date: Fri, 14 Jun 2024 21:35:14 +1000
Subject: [PATCH] event logger spec compliance update event logger to conform
 to spec 1.34.0, specifically: - implement ForceFlush, which delegates to the
 LoggerProvider

---
 src/SDK/Logs/EventLoggerProvider.php          |  7 ++++--
 src/SDK/Logs/EventLoggerProviderFactory.php   |  4 +---
 src/SDK/Logs/EventLoggerProviderInterface.php | 12 ++++++++++
 src/SDK/Logs/NoopEventLoggerProvider.php      | 22 +++++++++++++++++++
 .../Logs/EventLoggerProviderFactoryTest.php   |  4 ++--
 .../Unit/SDK/Logs/EventLoggerProviderTest.php |  2 +-
 tests/Unit/SDK/Logs/EventLoggerTest.php       |  2 +-
 7 files changed, 44 insertions(+), 9 deletions(-)
 create mode 100644 src/SDK/Logs/EventLoggerProviderInterface.php
 create mode 100644 src/SDK/Logs/NoopEventLoggerProvider.php

diff --git a/src/SDK/Logs/EventLoggerProvider.php b/src/SDK/Logs/EventLoggerProvider.php
index 53233a53c..2b5441b01 100644
--- a/src/SDK/Logs/EventLoggerProvider.php
+++ b/src/SDK/Logs/EventLoggerProvider.php
@@ -6,8 +6,6 @@
 
 use OpenTelemetry\API\Common\Time\Clock;
 use OpenTelemetry\API\Logs\EventLoggerInterface;
-use OpenTelemetry\API\Logs\EventLoggerProviderInterface;
-use OpenTelemetry\API\Logs\LoggerProviderInterface;
 
 class EventLoggerProvider implements EventLoggerProviderInterface
 {
@@ -22,4 +20,9 @@ public function getEventLogger(string $name, ?string $version = null, ?string $s
             Clock::getDefault(),
         );
     }
+
+    public function forceFlush(): bool
+    {
+        return $this->loggerProvider->forceFlush();
+    }
 }
diff --git a/src/SDK/Logs/EventLoggerProviderFactory.php b/src/SDK/Logs/EventLoggerProviderFactory.php
index 89d8cd814..889e382ef 100644
--- a/src/SDK/Logs/EventLoggerProviderFactory.php
+++ b/src/SDK/Logs/EventLoggerProviderFactory.php
@@ -4,13 +4,11 @@
 
 namespace OpenTelemetry\SDK\Logs;
 
-use OpenTelemetry\API\Logs\EventLoggerProviderInterface;
-use OpenTelemetry\API\Logs\NoopEventLoggerProvider;
 use OpenTelemetry\SDK\Sdk;
 
 class EventLoggerProviderFactory
 {
-    public function create(\OpenTelemetry\API\Logs\LoggerProviderInterface $loggerProvider): EventLoggerProviderInterface
+    public function create(LoggerProviderInterface $loggerProvider): EventLoggerProviderInterface
     {
         if (Sdk::isDisabled()) {
             return NoopEventLoggerProvider::getInstance();
diff --git a/src/SDK/Logs/EventLoggerProviderInterface.php b/src/SDK/Logs/EventLoggerProviderInterface.php
new file mode 100644
index 000000000..d3b137384
--- /dev/null
+++ b/src/SDK/Logs/EventLoggerProviderInterface.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Logs;
+
+use OpenTelemetry\API\Logs as API;
+
+interface EventLoggerProviderInterface extends API\EventLoggerProviderInterface
+{
+    public function forceFlush(): bool;
+}
diff --git a/src/SDK/Logs/NoopEventLoggerProvider.php b/src/SDK/Logs/NoopEventLoggerProvider.php
new file mode 100644
index 000000000..3875f570f
--- /dev/null
+++ b/src/SDK/Logs/NoopEventLoggerProvider.php
@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Logs;
+
+use OpenTelemetry\API\Logs as API;
+
+class NoopEventLoggerProvider extends API\NoopEventLoggerProvider implements EventLoggerProviderInterface
+{
+    public static function getInstance(): self
+    {
+        static $instance;
+
+        return $instance ??= new self();
+    }
+
+    public function forceFlush(): bool
+    {
+        return true;
+    }
+}
diff --git a/tests/Unit/SDK/Logs/EventLoggerProviderFactoryTest.php b/tests/Unit/SDK/Logs/EventLoggerProviderFactoryTest.php
index 321a13481..50930a366 100644
--- a/tests/Unit/SDK/Logs/EventLoggerProviderFactoryTest.php
+++ b/tests/Unit/SDK/Logs/EventLoggerProviderFactoryTest.php
@@ -4,11 +4,11 @@
 
 namespace OpenTelemetry\Tests\Unit\SDK\Logs;
 
-use OpenTelemetry\API\Logs\LoggerProviderInterface;
-use OpenTelemetry\API\Logs\NoopEventLoggerProvider;
 use OpenTelemetry\SDK\Common\Configuration\Variables;
 use OpenTelemetry\SDK\Logs\EventLoggerProvider;
 use OpenTelemetry\SDK\Logs\EventLoggerProviderFactory;
+use OpenTelemetry\SDK\Logs\LoggerProviderInterface;
+use OpenTelemetry\SDK\Logs\NoopEventLoggerProvider;
 use OpenTelemetry\Tests\TestState;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\DataProvider;
diff --git a/tests/Unit/SDK/Logs/EventLoggerProviderTest.php b/tests/Unit/SDK/Logs/EventLoggerProviderTest.php
index 03c51793b..35234fa7f 100644
--- a/tests/Unit/SDK/Logs/EventLoggerProviderTest.php
+++ b/tests/Unit/SDK/Logs/EventLoggerProviderTest.php
@@ -5,8 +5,8 @@
 namespace Unit\SDK\Logs;
 
 use OpenTelemetry\API\Logs\LoggerInterface;
-use OpenTelemetry\API\Logs\LoggerProviderInterface;
 use OpenTelemetry\SDK\Logs\EventLoggerProvider;
+use OpenTelemetry\SDK\Logs\LoggerProviderInterface;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\TestCase;
 
diff --git a/tests/Unit/SDK/Logs/EventLoggerTest.php b/tests/Unit/SDK/Logs/EventLoggerTest.php
index fffe91f04..d7f65f5cc 100644
--- a/tests/Unit/SDK/Logs/EventLoggerTest.php
+++ b/tests/Unit/SDK/Logs/EventLoggerTest.php
@@ -7,12 +7,12 @@
 use OpenTelemetry\API\Common\Time\Clock;
 use OpenTelemetry\API\Common\Time\TestClock;
 use OpenTelemetry\API\Logs\LoggerInterface;
-use OpenTelemetry\API\Logs\LoggerProviderInterface;
 use OpenTelemetry\API\Logs\LogRecord;
 use OpenTelemetry\API\Logs\Severity;
 use OpenTelemetry\Context\Context;
 use OpenTelemetry\SDK\Logs\EventLogger;
 use OpenTelemetry\SDK\Logs\EventLoggerProvider;
+use OpenTelemetry\SDK\Logs\LoggerProviderInterface;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;