Capture job attempts in Vapor (#199)

Co-authored-by: Tim MacDonald <[email protected]>

Author: avosalmon

README.md

@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[Laravel Nightwatch](https://nightwatch.laravel.com) is a hosted application monitoring platform design for Laravel. It delivers unparalleled insights into your application's performance, with the intelligence only a system obsessively optimized for Laravel can deliver.
+[Laravel Nightwatch](https://nightwatch.laravel.com) is a hosted application monitoring platform designed for Laravel. It delivers unparalleled insights into your application's performance, with the intelligence only a system obsessively optimized for Laravel can deliver.
 
 This repository contains the official Laravel Nightwatch package, which gathers metrics within your application and transmits them to Nightwatch. To learn more about Laravel Nightwatch and how to use this package, please consult the [official documentation](https://nightwatch.laravel.com/docs).
 

composer.json

@@ -1,7 +1,11 @@
 {
     "name": "laravel/nightwatch",
     "description": "The official Laravel Nightwatch package.",
-    "keywords": ["laravel", "monitoring", "insights"],
+    "keywords": [
+        "laravel",
+        "monitoring",
+        "insights"
+    ],
     "homepage": "https://nightwatch.laravel.com",
     "license": "MIT",
     "support": {
@@ -29,10 +33,12 @@
     },
     "require-dev": {
         "ext-pdo": "*",
+        "aws/aws-sdk-php": "^3.349",
         "guzzlehttp/guzzle": "^7.0",
         "guzzlehttp/psr7": "^2.0",
         "laravel/horizon": "^5.4",
         "laravel/pint": "1.21.0",
+        "laravel/vapor-core": "^2.38.2",
         "livewire/livewire": "^2.0|^3.0",
         "mockery/mockery": "^1.0",
         "mongodb/laravel-mongodb": "^4.0|^5.0",

phpunit.xml.dist

@@ -20,5 +20,6 @@
         <env name="DB_DATABASE" value="tests/database.sqlite" />
         <env name="MAIL_MAILER" value="array" />
         <env name="QUEUE_CONNECTION" value="database" />
+        <env name="SQS_PREFIX" value="https://sqs.us-east-1.amazonaws.com/123456789" />
     </php>
 </phpunit>

src/Compatibility.php

@@ -4,9 +4,9 @@
 
 use Illuminate\Contracts\Events\Dispatcher;
 use Illuminate\Contracts\Foundation\Application;
-use Illuminate\Log\Context\Repository as Context;
 use Illuminate\Queue\Events\JobProcessing;
 use Illuminate\Queue\Queue;
+use Illuminate\Support\Facades\Context;
 use ReflectionProperty;
 use Symfony\Component\Console\Input\ArgvInput;
 
@@ -17,8 +17,6 @@
 
 final class Compatibility
 {
-    public static Application $app;
-
     public static bool $terminatingEventExists = false;
 
     public static bool $cacheDurationCapturable = false;
@@ -44,7 +42,6 @@ final class Compatibility
 
     public static function boot(Application $app): void
     {
-        self::$app = $app;
         $version = $app->version();
 
         /**
@@ -134,10 +131,7 @@ public static function addHiddenContext(string $key, mixed $value): void
             return;
         }
 
-        /** @var Context */
-        $context = self::$app->make(Context::class);
-
-        $context->addHidden($key, $value);
+        Context::addHidden($key, $value);
     }
 
     /**
@@ -150,9 +144,6 @@ public static function getHiddenContext(string $key, mixed $default = null): mix
             return self::$context[$key] ?? value($default);
         }
 
-        /** @var Context */
-        $context = self::$app->make(Context::class);
-
-        return $context->getHidden($key) ?? value($default);
+        return Context::getHidden($key) ?? value($default);
     }
 }

src/Concerns/CapturesState.php

@@ -41,6 +41,7 @@
 use function array_shift;
 use function array_unshift;
 use function debug_backtrace;
+use function env;
 use function memory_reset_peak_usage;
 use function random_int;
 
@@ -481,6 +482,10 @@ public function prepareForNextJob(): void
      */
     public function prepareForJob(Job $job): void
     {
+        if ($this->isVapor()) {
+            $this->prepareForNextJob();
+        }
+
         $this->sample(
             Compatibility::getHiddenContext('nightwatch_should_sample', true) ? 1.0 : 0.0
         );
@@ -611,4 +616,9 @@ public function flush(): void
         $this->executionState->flush();
         $this->ingest->flush();
     }
+
+    private function isVapor(): bool
+    {
+        return env('VAPOR_SSM_PATH') !== null;
+    }
 }

src/Hooks/CommandStartingListener.php

@@ -51,7 +51,7 @@ public function __invoke(CommandStarting $event): void
 
         try {
             match ($event->command) {
-                'queue:work', 'queue:listen', 'horizon:work' => $this->registerJobHooks(),
+                'queue:work', 'queue:listen', 'horizon:work', 'vapor:work' => $this->registerJobHooks($event),
                 'schedule:run', 'schedule:work' => $this->registerScheduledTaskHooks(),
                 default => $this->registerCommandHooks($event),
             };
@@ -60,7 +60,7 @@ public function __invoke(CommandStarting $event): void
         }
     }
 
-    private function registerJobHooks(): void
+    private function registerJobHooks(CommandStarting $event): void
     {
         $this->nightwatch->configureForJobs();
 
@@ -86,6 +86,10 @@ private function registerJobHooks(): void
             JobReleasedAfterException::class,
             JobFailed::class,
         ], (new JobAttemptListener($this->nightwatch))(...));
+
+        if ($event->command === 'vapor:work') {
+            $this->events->listen(CommandFinished::class, (new VaporWorkCommandFinishedListener($this->nightwatch))(...));
+        }
     }
 
     private function registerScheduledTaskHooks(): void

src/Hooks/VaporWorkCommandFinishedListener.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Laravel\Nightwatch\Hooks;
+
+use Illuminate\Console\Events\CommandFinished;
+use Laravel\Nightwatch\Core;
+use Laravel\Nightwatch\State\CommandState;
+
+/**
+ * @internal
+ */
+final class VaporWorkCommandFinishedListener
+{
+    /**
+     * @param  Core<CommandState>  $nightwatch
+     */
+    public function __construct(
+        private Core $nightwatch,
+    ) {
+        //
+    }
+
+    public function __invoke(CommandFinished $event): void
+    {
+        $this->nightwatch->digest();
+    }
+}

src/NightwatchServiceProvider.php

@@ -32,7 +32,6 @@
 use Illuminate\Notifications\Events\NotificationSent;
 use Illuminate\Queue\Events\JobQueued;
 use Illuminate\Queue\Events\JobQueueing;
-use Illuminate\Queue\Queue;
 use Illuminate\Routing\Events\PreparingResponse;
 use Illuminate\Routing\Events\ResponsePrepared;
 use Illuminate\Routing\Events\RouteMatched;

testbench.yaml

@@ -1,6 +1,7 @@
 providers:
   - Laravel\Nightwatch\NightwatchServiceProvider
   - Laravel\Horizon\HorizonServiceProvider
+  - Laravel\Vapor\VaporServiceProvider
   - Livewire\LivewireServiceProvider
 
 workbench: