fix: performs the correction for the RequestContext return

Author: ReinanHS

Makefile

@@ -6,7 +6,7 @@ php:
 	docker exec -it hyperf-sqlcommenter-app bash
 check:
 	tools/php-cs-fixer fix
-	tools/psalm --output-format=console --show-info=true
+	tools/psalm --output-format=console --show-info=true --no-cache
 install:
 	phive install
 	composer install

src/Aspect/SqlCommenterAspect.php

@@ -15,12 +15,13 @@
 
 namespace ReinanHS\SqlCommenterHyperf\Aspect;
 
-use Hyperf\Context\RequestContext;
+use Hyperf\Context\Context;
 use Hyperf\Contract\ConfigInterface;
 use Hyperf\Database\Connection;
 use Hyperf\Di\Aop\AbstractAspect;
 use Hyperf\Di\Aop\ProceedingJoinPoint;
 use Hyperf\HttpServer\Router\Dispatched;
+use Psr\Http\Message\ServerRequestInterface;
 use ReinanHS\SqlCommenterHyperf\Opentelemetry;
 use ReinanHS\SqlCommenterHyperf\SwitchManager;
 use ReinanHS\SqlCommenterHyperf\Utils;
@@ -68,24 +69,30 @@ private function appendSqlComments(string $query, string $dbDriver): string
             $comments['db_driver'] = $dbDriver;
         }
 
-        $request = RequestContext::get();
-        if ($this->switchManager->isEnable('route')) {
-            $comments['route'] = $request->getUri()->getPath();
-        }
+        /**
+         * @psalm-suppress InvalidArgument
+         * @var null|ServerRequestInterface $request
+         */
+        $request = Context::get(ServerRequestInterface::class);
+        if ($request instanceof ServerRequestInterface) {
+            if ($this->switchManager->isEnable('route')) {
+                $comments['route'] = $request->getUri()->getPath();
+            }
 
-        if ($this->switchManager->isEnable('controller') || $this->switchManager->isEnable('action')) {
-            /** @var null|Dispatched $dispatched */
-            $dispatched = $request->getAttribute(Dispatched::class);
+            if ($this->switchManager->isEnable('controller') || $this->switchManager->isEnable('action')) {
+                /** @var null|Dispatched $dispatched */
+                $dispatched = $request->getAttribute(Dispatched::class);
 
-            if ($dispatched && $dispatched->isFound()) {
-                $parts = Utils::extractCallback($dispatched->handler?->callback);
+                if ($dispatched && $dispatched->isFound()) {
+                    $parts = Utils::extractCallback($dispatched->handler?->callback);
 
-                if ($this->switchManager->isEnable('controller')) {
-                    $comments['controller'] = (string) $parts[0];
-                }
+                    if ($this->switchManager->isEnable('controller')) {
+                        $comments['controller'] = (string) $parts[0];
+                    }
 
-                if ($this->switchManager->isEnable('action')) {
-                    $comments['action'] = (string) $parts[1];
+                    if ($this->switchManager->isEnable('action')) {
+                        $comments['action'] = (string) $parts[1];
+                    }
                 }
             }
         }

tests/Aspect/SqlCommenterAspectTest.php

@@ -16,7 +16,7 @@
 namespace ReinanHS\Test\Aspect;
 
 use FastRoute\Dispatcher;
-use Hyperf\Context\RequestContext;
+use Hyperf\Context\Context;
 use Hyperf\Contract\ConfigInterface;
 use Hyperf\Database\Connection;
 use Hyperf\Di\Aop\ProceedingJoinPoint;
@@ -25,6 +25,7 @@
 use Hyperf\HttpServer\Router\Handler;
 use Mockery;
 use PHPUnit\Framework\TestCase;
+use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Message\UriInterface;
 use ReinanHS\SqlCommenterHyperf\Aspect\SqlCommenterAspect;
 use ReinanHS\SqlCommenterHyperf\Opentelemetry;
@@ -76,9 +77,9 @@ public function testProcess(): void
             ->method('getUri')
             ->willReturn($mockedUri);
 
-        $mockedContext = Mockery::mock('alias:' . RequestContext::class);
+        $mockedContext = Mockery::mock('alias:' . Context::class);
         $mockedContext->shouldReceive('get')
-            ->with()
+            ->with(ServerRequestInterface::class)
             ->andReturn($mockedRequest);
 
         $mockedOpentelemetry = Mockery::mock('alias:' . Opentelemetry::class);
@@ -122,4 +123,67 @@ public function testProcess(): void
         $this->assertStringContainsString("traceparent='00-5bd66ef5095369c7b0d1f8f4bd33716a-c532cb4098ac3dd2-01'", $query);
         $this->assertTrue($result);
     }
+
+    public function testProcessNoRequest(): void
+    {
+        $mockedConfig = $this->createMock(ConfigInterface::class);
+        $mockedConfig->expects($this->exactly(2))
+            ->method('get')
+            ->willReturnOnConsecutiveCalls(true, 'TestApp');
+
+        $mockedSwitchManager = $this->createMock(SwitchManager::class);
+        $mockedSwitchManager->expects($this->exactly(4))
+            ->method('isEnable')
+            ->willReturn(true);
+
+        $mockedProceedingJoinPoint = $this->getMockBuilder(ProceedingJoinPoint::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $mockedContext = Mockery::mock('alias:' . Context::class);
+        $mockedContext->shouldReceive('get')
+            ->with(ServerRequestInterface::class)
+            ->andReturn(null);
+
+        $mockedOpentelemetry = Mockery::mock('alias:' . Opentelemetry::class);
+        $mockedOpentelemetry->shouldReceive('getOpentelemetryValues')
+            ->andReturn([
+                'traceparent' => '00-5bd66ef5095369c7b0d1f8f4bd33716a-c532cb4098ac3dd2-01',
+            ]);
+
+        $mockedProceedingJoinPoint->arguments = [
+            'keys' => [
+                'query' => 'SELECT CURRENT_TIMESTAMP()',
+            ],
+        ];
+
+        $mockedConnection = $this->createMock(Connection::class);
+        $mockedConnection->expects($this->once())
+            ->method('getDriverName')
+            ->willReturn('mysql');
+
+        $mockedProceedingJoinPoint->expects($this->once())
+            ->method('getInstance')
+            ->willReturn($mockedConnection);
+
+        $mockedProceedingJoinPoint->expects($this->once())
+            ->method('process')
+            ->willReturn(true);
+
+        $aspect = new SqlCommenterAspect($mockedConfig, $mockedSwitchManager);
+        $result = $aspect->process($mockedProceedingJoinPoint);
+
+        $query = $mockedProceedingJoinPoint->arguments['keys']['query'];
+
+        $this->assertStringContainsString('SELECT CURRENT_TIMESTAMP()', $query);
+        $this->assertStringContainsString("application='TestApp'", $query);
+        $this->assertStringContainsString("framework='hyperf'", $query);
+        $this->assertStringContainsString("application='TestApp'", $query);
+        $this->assertStringContainsString("db_driver='mysql'", $query);
+        $this->assertStringNotContainsString("route='%%2Fv1%%2Fadmin%%2Findex'", $query);
+        $this->assertStringNotContainsString("controller='IndexController'", $query);
+        $this->assertStringNotContainsString("action='index'", $query);
+        $this->assertStringContainsString("traceparent='00-5bd66ef5095369c7b0d1f8f4bd33716a-c532cb4098ac3dd2-01'", $query);
+        $this->assertTrue($result);
+    }
 }