Fix/shutdown (#21)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: lucas-angeli-gimenes

src/Factory/SDKBuilder.php

@@ -35,7 +35,7 @@ public function build(): void
             ->setMeterProvider($meterProvider)
             ->setLoggerProvider($loggerProvider)
             ->setPropagator(TraceContextPropagator::getInstance())
-            ->setAutoShutdown(true)
+            ->setAutoShutdown(false)
             ->buildAndRegisterGlobal();
     }
 }

src/Listener/OtelShutdownListener.php

@@ -5,6 +5,7 @@
 namespace Hyperf\OpenTelemetry\Listener;
 
 use Hyperf\Contract\StdoutLoggerInterface;
+use Hyperf\Coroutine\Coroutine;
 use Hyperf\Event\Contract\ListenerInterface;
 use Hyperf\Framework\Event\OnWorkerExit;
 use OpenTelemetry\SDK\Metrics\MeterProviderInterface;
@@ -29,16 +30,18 @@ public function listen(): array
 
     public function process(object $event): void
     {
-        try {
-            $this->tracerProvider->shutdown();
-        } catch (Throwable $e) {
-            $this->logger->warning(sprintf('[OTel] tracer shutdown failed: %s', $e->getMessage()));
-        }
+        Coroutine::create(function () {
+            try {
+                $this->tracerProvider->shutdown();
+            } catch (Throwable $e) {
+                $this->logger->warning(sprintf('[OTel] tracer shutdown failed: %s', $e->getMessage()));
+            }
 
-        try {
-            $this->meterProvider->shutdown();
-        } catch (Throwable $e) {
-            $this->logger->warning(sprintf('[OTel] meter shutdown failed: %s', $e->getMessage()));
-        }
+            try {
+                $this->meterProvider->shutdown();
+            } catch (Throwable $e) {
+                $this->logger->warning(sprintf('[OTel] meter shutdown failed: %s', $e->getMessage()));
+            }
+        });
     }
 }

src/Support/Uri.php

@@ -8,7 +8,7 @@ class Uri
 {
     public static function sanitize(string $uri, array $uriMask = []): string
     {
-        $uuid = '/\/(?<=\/)([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12})(?=\/|$)/i';
+        $uuid = '/\/(?<=\/)([0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12})(?=\/|$)/i';
 
         $defaultPatterns = [
             $uuid => '/{uuid}',

src/Transport/SwooleGrpcTransportFactory.php

@@ -37,6 +37,9 @@ public function create(
         if ($compression !== null) {
             $compressionType = is_array($compression) ? ($compression[0] ?? null) : $compression;
         }
+        if ($compressionType === 'none') {
+            $compressionType = null;
+        }
 
         return new SwooleGrpcTransport(
             host: $parsed['host'],

tests/Unit/Listener/OtelShutdownListenerTest.php

@@ -29,28 +29,51 @@ public function testImplementsListenerInterface(): void
         $this->assertInstanceOf(ListenerInterface::class, $listener);
     }
 
-    public function testProcessCallsShutdown(): void
+    public function testListensToOnWorkerExit(): void
+    {
+        $listener = new OtelShutdownListener(
+            $this->createMock(MeterProviderInterface::class),
+            $this->createMock(TracerProviderInterface::class),
+            $this->createMock(StdoutLoggerInterface::class)
+        );
+        $this->assertSame([OnWorkerExit::class], $listener->listen());
+    }
+
+    public function testProcessCallsShutdownInsideCoroutine(): void
     {
         $meterProvider = $this->createMock(MeterProviderInterface::class);
         $tracerProvider = $this->createMock(TracerProviderInterface::class);
         $logger = $this->createMock(StdoutLoggerInterface::class);
 
-        $meterProvider->expects($this->once())->method('shutdown');
         $tracerProvider->expects($this->once())->method('shutdown');
+        $meterProvider->expects($this->once())->method('shutdown');
         $logger->expects($this->never())->method('warning');
 
         $listener = new OtelShutdownListener($meterProvider, $tracerProvider, $logger);
         $listener->process(new OnWorkerExit($this->createMock(Server::class), 0));
     }
 
-    public function testProcessLogsWarningOnException(): void
+    public function testProcessLogsWarningOnTracerException(): void
+    {
+        $meterProvider = $this->createMock(MeterProviderInterface::class);
+        $tracerProvider = $this->createMock(TracerProviderInterface::class);
+        $logger = $this->createMock(StdoutLoggerInterface::class);
+
+        $tracerProvider->method('shutdown')->willThrowException(new RuntimeException('tracer error'));
+        $logger->expects($this->atLeastOnce())->method('warning')->with($this->stringContains('tracer'));
+
+        $listener = new OtelShutdownListener($meterProvider, $tracerProvider, $logger);
+        $listener->process(new OnWorkerExit($this->createMock(Server::class), 0));
+    }
+
+    public function testProcessLogsWarningOnMeterException(): void
     {
         $meterProvider = $this->createMock(MeterProviderInterface::class);
         $tracerProvider = $this->createMock(TracerProviderInterface::class);
         $logger = $this->createMock(StdoutLoggerInterface::class);
 
         $meterProvider->method('shutdown')->willThrowException(new RuntimeException('meter error'));
-        $logger->expects($this->once())->method('warning')->with($this->stringContains('meter error'));
+        $logger->expects($this->atLeastOnce())->method('warning')->with($this->stringContains('meter'));
 
         $listener = new OtelShutdownListener($meterProvider, $tracerProvider, $logger);
         $listener->process(new OnWorkerExit($this->createMock(Server::class), 0));

tests/Unit/Support/UriTest.php

@@ -33,6 +33,13 @@ public function testSanitizeUuid()
         $this->assertStringContainsString('/{uuid}', $result);
     }
 
+    public function testSanitizeUuidV7()
+    {
+        $uri = '/019363e0-7be6-7f00-8a7d-d6fb379a33a1/';
+        $result = Uri::sanitize($uri);
+        $this->assertStringContainsString('/{uuid}', $result);
+    }
+
     public function testSanitizeLicensePlate()
     {
         $uri = '/ABC1A23/';

tests/Unit/Transport/SwooleGrpcTransportFactoryTest.php

@@ -100,4 +100,22 @@ public function testCreateWithGrpcsScheme(): void
 
         $this->assertSame(ContentTypes::PROTOBUF, $transport->contentType());
     }
+
+    public function testCreateWithCompressionNoneTreatedAsNull(): void
+    {
+        $factory = new SwooleGrpcTransportFactory();
+
+        $transport = $factory->create(
+            endpoint: 'http://localhost:4317/opentelemetry.proto.collector.trace.v1.TraceService/Export',
+            contentType: ContentTypes::PROTOBUF,
+            compression: 'none',
+        );
+
+        $this->assertSame(ContentTypes::PROTOBUF, $transport->contentType());
+
+        // Use reflection to verify compression was normalized to null
+        $reflection = new \ReflectionClass($transport);
+        $compressionProp = $reflection->getProperty('compression');
+        $this->assertNull($compressionProp->getValue($transport));
+    }
 }