Support ignore telescope command (#533)

publish/telescope.php

@@ -47,4 +47,7 @@
     'ignore_paths' => [
         // 'nova-api*',
     ],
+    'ignore_commands' => [
+        // 'demo:command',
+    ],
 ];

src/Listener/CommandListener.php

@@ -14,6 +14,7 @@
 use FriendsOfHyperf\Telescope\IncomingEntry;
 use FriendsOfHyperf\Telescope\Telescope;
 use FriendsOfHyperf\Telescope\TelescopeConfig;
+use FriendsOfHyperf\Telescope\TelescopeContext;
 use Hyperf\Command\Event\AfterExecute;
 use Hyperf\Event\Contract\ListenerInterface;
 
@@ -44,13 +45,19 @@ public function process(object $event): void
         }
 
         $command = $event->getCommand();
+
+        if (in_array($command->getName(), $this->telescopeConfig->getIgnoreCommands())) {
+            return;
+        }
+
         $arguments = (fn () => $this->input->getArguments())->call($command);
         $options = (fn () => $this->input->getOptions())->call($command);
-        $name = $command->getName();
         $exitCode = (fn () => $this->exitCode)->call($command);
 
+        TelescopeContext::getOrSetBatch((string) TelescopeContext::getBatchId());
+
         Telescope::recordCommand(IncomingEntry::make([
-            'command' => $name,
+            'command' => $command->getName(),
             'exit_code' => $exitCode,
             'arguments' => $arguments,
             'options' => $options,

src/Listener/RequestHandledListener.php

@@ -68,14 +68,7 @@ public function requestReceived(RequestReceived|RpcRequestReceived $event)
         $request = $event->request;
         $batchId = $request->getHeaderLine('batch-id') ?: $this->getRpcBatchId();
 
-        if ($batchId) {
-            $subBatchId = Str::orderedUuid()->toString();
-            TelescopeContext::setSubBatchId($subBatchId);
-        } else {
-            $batchId = Str::orderedUuid()->toString();
-        }
-
-        TelescopeContext::setBatchId($batchId);
+        TelescopeContext::getOrSetBatch($batchId);
     }
 
     public function requestHandled(RequestTerminated|RpcRequestTerminated $event)

src/Middleware/TelescopeMiddleware.php

@@ -48,14 +48,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
             $batchId = $this->getRpcBatchId();
         }
 
-        if ($batchId) {
-            $subBatchId = Str::orderedUuid()->toString();
-            TelescopeContext::setSubBatchId($subBatchId);
-        } else {
-            $batchId = Str::orderedUuid()->toString();
-        }
-
-        TelescopeContext::setBatchId($batchId);
+        TelescopeContext::getOrSetBatch($batchId);
 
         $response = $handler->handle($request);
         $response = $response->withHeader('batch-id', $batchId);

src/TelescopeConfig.php

@@ -166,4 +166,9 @@ public function isPathIgnored(ServerRequestInterface|string $path): bool
 
         return Str::is($this->getIgnorePaths(), rawurldecode(trim($path, '/')));
     }
+
+    public function getIgnoreCommands(): array
+    {
+        return $this->get('ignore_commands', []);
+    }
 }

src/TelescopeContext.php

@@ -13,6 +13,7 @@
 
 use Hyperf\Context\Context;
 use Hyperf\Contract\PackerInterface;
+use Hyperf\Stringable\Str;
 
 use function Hyperf\Coroutine\defer;
 
@@ -133,4 +134,16 @@ public static function getGrpcResponsePayload(): ?array
     {
         return Context::get(self::GRPC_RESPONSE_PAYLOAD) ?: null;
     }
+
+    public static function getOrSetBatch(string $batchId): void
+    {
+        if ($batchId) {
+            $subBatchId = Str::orderedUuid()->toString();
+            self::setSubBatchId($subBatchId);
+        } else {
+            $batchId = Str::orderedUuid()->toString();
+        }
+
+        self::setBatchId($batchId);
+    }
 }