chore(processor): [DatadogProcessor] new

Author: ericHao22

src/Processors/DatadogProcessor.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace Onramplab\LaravelLogEnhancement\Processors;
+
+use Monolog\LogRecord;
+use Monolog\Processor\ProcessorInterface;
+
+/**
+ * Inject the trace ID and span ID to connect the log entry with the APM trace
+ */
+class DatadogProcessor implements ProcessorInterface
+{
+    /**
+     * @inheritDoc
+     */
+    public function __invoke(LogRecord $record): LogRecord
+    {
+        // can get function after install Datadog php extension
+        if (!$this->isContextExisted()) {
+            return $record;
+        }
+
+        $context = $this->getContext();
+        $record->extra['dd'] = [
+            'trace_id' => $context['trace_id'],
+            'span_id' => $context['span_id'],
+        ];
+
+        return $record;
+    }
+
+    public function isContextExisted(): bool
+    {
+        return !function_exists('\DDTrace\current_context');
+    }
+
+    /**
+     * @return array{trace_id: string, span_id: string, version: string, env: string}
+     */
+    public function getContext(): array
+    {
+        return \DDTrace\current_context();
+    }
+}

tests/TestCase.php

@@ -7,16 +7,11 @@
 
 class TestCase extends BaseTestCase
 {
-    public function setup() : void
+    protected function setUp() : void
     {
         parent::setUp();
-        $this->withoutExceptionHandling();
-        // $this->artisan('migrate', ['--database' => 'testing']);
-
-        // $this->loadMigrationsFrom(__DIR__ . '/../src/database/migrations');
-        // $this->loadLaravelMigrations(['--database' => 'testing']);
 
-        // $this->withFactories(__DIR__.'/../src/database/factories');
+        $this->withoutExceptionHandling();
     }
 
     protected function getEnvironmentSetUp($app)

tests/Unit/Processors/DatadogProcessorTest.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace Onramplab\LaravelLogEnhancement\Tests\Unit\Processors;
+
+use Illuminate\Foundation\Testing\WithFaker;
+use Mockery;
+use Mockery\MockInterface;
+use Monolog\Level;
+use Monolog\LogRecord;
+use Onramplab\LaravelLogEnhancement\Processors\DatadogProcessor;
+use Onramplab\LaravelLogEnhancement\Tests\TestCase;
+
+class DatadogProcessorTest extends TestCase
+{
+    use WithFaker;
+
+    private MockInterface $processor;
+
+    private LogRecord $record;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->processor = Mockery::mock(DatadogProcessor::class)->makePartial();
+        $this->record = new LogRecord(
+            datetime: now()->toDateTimeImmutable(),
+            channel: 'fake-channel',
+            level: Level::Debug,
+            message: 'fake message',
+            context: [],
+            extra: [],
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function processor_should_inject_extra_data_when_context_is_existed(): void
+    {
+        $context = [
+            'trace_id' => $this->faker->uuid(),
+            'span_id' => $this->faker->uuid(),
+        ];
+
+        $this->processor
+            ->shouldReceive('isContextExisted')
+            ->once()
+            ->andReturn(true);
+
+        $this->processor
+            ->shouldReceive('getContext')
+            ->once()
+            ->andReturn($context);
+
+        $record = ($this->processor)($this->record);
+
+        $this->assertSame($context['trace_id'], $record->extra['dd']['trace_id']);
+        $this->assertSame($context['span_id'], $record->extra['dd']['span_id']);
+    }
+
+    /**
+     * @test
+     */
+    public function processor_should_not_inject_extra_data_when_context_is_not_existed(): void
+    {
+        $this->processor
+            ->shouldReceive('isContextExisted')
+            ->once()
+            ->andReturn(false);
+
+        $record = ($this->processor)($this->record);
+
+        $this->assertArrayNotHasKey('dd', $record->extra);
+    }
+}