feat: add cleanupjob for jobFailed and JobException. Refactr for constants

Author: andrestejerina97

app/Audit/AuditContext.php

@@ -19,6 +19,12 @@
 
 class AuditContext
 {
+
+    public const CONTAINER_KEY = 'audit.context';
+
+
+    public const UI_CONTEXT_CONTAINER_KEY = 'ui.context';
+
     public function __construct(
         public ?int $userId = null,
         public ?string $userEmail = null,

app/Audit/AuditEventListener.php

@@ -98,8 +98,8 @@ private function getAuditStrategy($em): ?IAuditStrategy
     private function buildAuditContext(): AuditContext
     {
         if (app()->runningInConsole()) {
-            if (app()->bound('audit.context')) {
-                $context = app('audit.context');
+            if (app()->bound(AuditContext::CONTAINER_KEY)) {
+                $context = app(AuditContext::CONTAINER_KEY);
                 if ($context instanceof AuditContext) {
                     return $context;
                 }

app/Listeners/CleanupJobAuditContextListener.php

@@ -14,25 +14,43 @@
  * limitations under the License.
  **/
 
+use App\Audit\AuditContext;
 use Illuminate\Queue\Events\JobProcessed;
+use Illuminate\Queue\Events\JobFailed;
+use Illuminate\Queue\Events\JobExceptionOccurred;
 use Illuminate\Support\Facades\Log;
 
 /**
  * Cleans up audit context after job processing to prevent context leakage between jobs
  */
 class CleanupJobAuditContextListener
 {
-    public function handle(JobProcessed $event): void
+    public function handleJobProcessed(JobProcessed $event): void
+    {
+        $this->cleanup(get_class($event->job));
+    }
+
+    public function handleJobFailed(JobFailed $event): void
+    {
+        $this->cleanup(get_class($event->job));
+    }
+
+    public function handleJobExceptionOccurred(JobExceptionOccurred $event): void
+    {
+        $this->cleanup(get_class($event->job));
+    }
+
+    private function cleanup(string $jobClass): void
     {
         if (!config('opentelemetry.enabled', false)) {
             return;
         }
 
         try {
-            if (app()->bound('audit.context')) {
-                app()->forgetInstance('audit.context');
+            if (app()->bound(AuditContext::CONTAINER_KEY)) {
+                app()->forgetInstance(AuditContext::CONTAINER_KEY);
                 Log::debug('CleanupJobAuditContextListener: audit context cleaned after job', [
-                    'job' => get_class($event->job),
+                    'job' => $jobClass,
                 ]);
             }
         } catch (\Exception $e) {

app/Listeners/RestoreJobAuditContextListener.php

@@ -20,7 +20,6 @@
 
 class RestoreJobAuditContextListener
 {
-    private const CONTAINER_BINDING_KEY = 'audit.context';
     private const PAYLOAD_DATA_KEY = 'data';
     private const PAYLOAD_CONTEXT_KEY = 'auditContext';
     private const LOG_CONTEXT_KEY = 'event_name';
@@ -36,7 +35,7 @@ public function handle(JobProcessing $event): void
             $context = $this->extractContextFromPayload($event->job->payload());
 
             if ($context !== null) {
-                app()->instance(self::CONTAINER_BINDING_KEY, $context);
+                app()->instance(AuditContext::CONTAINER_KEY, $context);
             }
         } catch (\Exception $e) {
             Log::warning('Failed to restore audit context from queue job', [

app/Providers/EventServiceProvider.php

@@ -66,7 +66,13 @@ final class EventServiceProvider extends ServiceProvider
             'App\Listeners\RestoreJobAuditContextListener',
         ],
         \Illuminate\Queue\Events\JobProcessed::class => [
-            'App\Listeners\CleanupJobAuditContextListener',
+            'App\Listeners\CleanupJobAuditContextListener@handleJobProcessed',
+        ],
+        \Illuminate\Queue\Events\JobFailed::class => [
+            'App\Listeners\CleanupJobAuditContextListener@handleJobFailed',
+        ],
+        \Illuminate\Queue\Events\JobExceptionOccurred::class => [
+            'App\Listeners\CleanupJobAuditContextListener@handleJobExceptionOccurred',
         ],
         \SocialiteProviders\Manager\SocialiteWasCalled::class => [
             // ... other providers

tests/OpenTelemetry/Listeners/RestoreJobAuditContextListenerTest.php

@@ -27,7 +27,6 @@ class RestoreJobAuditContextListenerTest extends TestCase
 {
     use CreatesApplication;
 
-    private const CONTAINER_BINDING_KEY = 'audit.context';
     private const DEFAULT_QUEUE_NAME = 'default';
 
     private const TEST_USER_ID = 42;
@@ -124,8 +123,8 @@ public function testListenerRestoresContextFromPayload(): void
         $this->listener->handle($event);
 
         // Assert: Context was bound to container
-        $this->assertTrue(App::bound(self::CONTAINER_BINDING_KEY));
-        $restoredContext = App::make(self::CONTAINER_BINDING_KEY);
+        $this->assertTrue(App::bound(AuditContext::CONTAINER_KEY));
+        $restoredContext = App::make(AuditContext::CONTAINER_KEY);
 
         $this->assertInstanceOf(AuditContext::class, $restoredContext);
         $this->assertEquals(self::TEST_USER_ID, $restoredContext->userId);
@@ -144,7 +143,7 @@ public function testListenerDoesNotBindMissingContext(): void
         $this->listener->handle($event);
 
         // Assert: No context binding occurs
-        $this->assertFalse(App::bound(self::CONTAINER_BINDING_KEY));
+        $this->assertFalse(App::bound(AuditContext::CONTAINER_KEY));
     }
 
     public function testListenerSkipsWhenOTLPDisabled(): void
@@ -160,7 +159,7 @@ public function testListenerSkipsWhenOTLPDisabled(): void
         $this->listener->handle($event);
 
         // Assert: No context binding even though context exists
-        $this->assertFalse(App::bound(self::CONTAINER_BINDING_KEY));
+        $this->assertFalse(App::bound(AuditContext::CONTAINER_KEY));
     }
 
     public function testListenerHandlesInvalidSerializedData(): void
@@ -178,7 +177,7 @@ public function testListenerHandlesInvalidSerializedData(): void
         $this->listener->handle($event);
 
         // Assert: Error is handled gracefully, no context bound
-        $this->assertFalse(App::bound(self::CONTAINER_BINDING_KEY));
+        $this->assertFalse(App::bound(AuditContext::CONTAINER_KEY));
     }
 
     public function testListenerHandlesPayloadRetrievalException(): void
@@ -193,6 +192,6 @@ public function testListenerHandlesPayloadRetrievalException(): void
         $event = new JobProcessing(self::DEFAULT_QUEUE_NAME, $mockJob);
         $this->listener->handle($event);
 
-        $this->assertFalse(App::bound(self::CONTAINER_BINDING_KEY));
+        $this->assertFalse(App::bound(AuditContext::CONTAINER_KEY));
     }
 }