Improve sub-minute task capture (#265)

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

Author: avosalmon

composer.json

@@ -30,7 +30,8 @@
         "psr/log": "^1.0|^2.0|^3.0",
         "ramsey/uuid": "^4.0",
         "symfony/console": "^6.0|^7.0",
-        "symfony/http-foundation": "^6.0|^7.0"
+        "symfony/http-foundation": "^6.0|^7.0",
+        "symfony/polyfill-php84": "^1.29"
     },
     "require-dev": {
         "ext-pcntl": "*",

src/Concerns/CapturesState.php

@@ -55,8 +55,6 @@ trait CapturesState
 
     private bool $paused = false;
 
-    private bool $waitingForJob = false;
-
     /**
      * @var WeakMap<Route, bool>
      */
@@ -75,7 +73,7 @@ public function sample(float $rate = 1.0): void
 
         $this->sampling = $sample;
 
-        $this->ingest->shouldDigest($sample);
+        $this->ingest->shouldDigestWhenBufferIsFull($sample);
 
         Compatibility::addSamplingToContext($sample);
     }
@@ -173,7 +171,9 @@ public function report(Throwable $e, ?bool $handled = null): void
 
         try {
             if ($e instanceof FatalError) {
-                $this->ingest->writeNow($this->sensor->fatalError($e));
+                if ($this->sampling) {
+                    $this->ingest->writeNow($this->sensor->fatalError($e));
+                }
             } else {
                 $this->ingest->write($this->sensor->exception($e, $handled));
             }
@@ -458,9 +458,9 @@ public function attachMiddlewareToRoute(Route $route): void
     /**
      * @internal
      */
-    public function waitForJob(): void
+    public function waitForExecution(): void
     {
-        $this->waitingForJob = true;
+        $this->dontSample();
     }
 
     /**
@@ -469,7 +469,7 @@ public function waitForJob(): void
     public function configureForJobs(): void
     {
         $this->executionState->source = 'job';
-        $this->waitingForJob = true;
+        $this->waitForExecution();
     }
 
     /**
@@ -496,7 +496,6 @@ public function prepareForJob(Job $job): void
             Compatibility::getSamplingFromContext(default: true) ? 1.0 : 0.0
         );
 
-        $this->waitingForJob = false;
         $this->executionState->timestamp = $this->clock->microtime();
         $this->executionState->setId($this->uuid->make());
         $this->executionState->executionPreview = Str::tinyText($job->resolveName());
@@ -558,6 +557,7 @@ public function command(InputInterface $input, int $status): void
     public function configureForScheduledTasks(): void
     {
         $this->executionState->source = 'schedule';
+        $this->waitForExecution();
     }
 
     /**
@@ -579,6 +579,7 @@ public function prepareForNextScheduledTask(): void
         $this->executionState->trace = $trace;
         $this->executionState->setId($trace);
         $this->executionState->timestamp = $this->clock->microtime();
+        $this->sample();
     }
 
     /**

src/Contracts/Ingest.php

@@ -2,6 +2,8 @@
 
 namespace Laravel\Nightwatch\Contracts;
 
+use Deprecated;
+
 /**
  * @internal
  */
@@ -19,7 +21,10 @@ public function writeNow(array $record): void;
 
     public function ping(): void;
 
-    public function shouldDigest(bool $bool): void;
+    #[Deprecated('Use shouldDigestWhenBufferIsFull instead')]
+    public function shouldDigest(bool $bool = true): void;
+
+    public function shouldDigestWhenBufferIsFull(bool $bool = true): void;
 
     public function digest(): void;
 

src/Core.php

@@ -78,14 +78,14 @@ public function guzzleMiddleware(): callable
      *
      * @return $this
      */
-    public function digest(): self
+    public function finishExecution(): self
     {
-        if ($this->waitingForJob) {
-            return $this;
-        }
-
         try {
-            $this->ingest->digest();
+            if ($this->sampling) {
+                $this->ingest->digest();
+            } else {
+                $this->ingest->flush();
+            }
         } catch (Throwable $e) {
             Nightwatch::unrecoverableExceptionOccurred($e);
         }

src/Hooks/CommandLifecycleIsLongerThanHandler.php

@@ -37,6 +37,6 @@ public function __invoke(Carbon $startedAt, InputInterface $input, int $status):
             $this->nightwatch->report($e, handled: true);
         }
 
-        $this->nightwatch->digest();
+        $this->nightwatch->finishExecution();
     }
 }

src/Hooks/CommandStartingListener.php

@@ -65,7 +65,7 @@ private function registerJobHooks(CommandStarting $event): void
         $this->nightwatch->configureForJobs();
 
         /**
-         * @see \Laravel\Nightwatch\Core::digest()
+         * @see \Laravel\Nightwatch\Core::finishExecution()
          * @see \Laravel\Nightwatch\State\CommandState::flush()
          * @see \Laravel\Nightwatch\State\CommandState::$timestamp
          * @see \Laravel\Nightwatch\State\CommandState::$id
@@ -79,7 +79,7 @@ private function registerJobHooks(CommandStarting $event): void
 
         /**
          * @see \Laravel\Nightwatch\Records\JobAttempt
-         * @see \Laravel\Nightwatch\Core::digest()
+         * @see \Laravel\Nightwatch\Core::finishExecution()
          */
         $this->events->listen([
             JobProcessed::class,
@@ -99,7 +99,7 @@ private function registerScheduledTaskHooks(): void
         $this->events->listen(ScheduledTaskStarting::class, (new ScheduledTaskStartingListener($this->nightwatch))(...));
 
         /**
-         * @see \Laravel\Nightwatch\Core::digest()
+         * @see \Laravel\Nightwatch\Core::finishExecution()
          */
         $this->events->listen([
             ScheduledTaskFinished::class,
@@ -126,7 +126,7 @@ private function registerCommandHooks(CommandStarting $event): void
         /**
          * @see \Laravel\Nightwatch\ExecutionStage::End
          * @see \Laravel\Nightwatch\Records\Command
-         * @see \Laravel\Nightwatch\Core::digest()
+         * @see \Laravel\Nightwatch\Core::finishExecution()
          */
         $this->kernel->whenCommandLifecycleIsLongerThan(-1, new CommandLifecycleIsLongerThanHandler($this->nightwatch));
     }

src/Hooks/HttpKernelResolvedHandler.php

@@ -36,7 +36,7 @@ public function __invoke(KernelContract $kernel, Application $app): void
             /**
              * @see \Laravel\Nightwatch\ExecutionStage::End
              * @see \Laravel\Nightwatch\Records\Request
-             * @see \Laravel\Nightwatch\Core::digest()
+             * @see \Laravel\Nightwatch\Core::finishExecution()
              */
             $kernel->whenRequestLifecycleIsLongerThan(-1, new RequestLifecycleIsLongerThanHandler($this->nightwatch));
         } catch (Throwable $e) {

src/Hooks/RequestLifecycleIsLongerThanHandler.php

@@ -44,6 +44,6 @@ public function __invoke(Carbon $startedAt, Request $request, Response $response
             $this->nightwatch->report($e, handled: true);
         }
 
-        $this->nightwatch->digest();
+        $this->nightwatch->finishExecution();
     }
 }

src/Hooks/ScheduledTaskListener.php

@@ -36,13 +36,17 @@ public function __invoke(ScheduledTaskFinished|ScheduledTaskSkipped|ScheduledTas
             return;
         }
 
+        if ($event instanceof ScheduledTaskSkipped) {
+            $this->nightwatch->prepareForNextScheduledTask();
+        }
+
         try {
             $this->nightwatch->scheduledTask($event);
         } catch (Throwable $e) {
             $this->nightwatch->report($e, handled: true);
         }
 
-        $this->nightwatch->digest();
+        $this->nightwatch->finishExecution()->waitForExecution();
     }
 
     private function isFinishedEventForFailedTask(ScheduledTaskFinished|ScheduledTaskSkipped|ScheduledTaskFailed $event): bool

src/Hooks/VaporWorkCommandFinishedListener.php

@@ -22,6 +22,6 @@ public function __construct(
 
     public function __invoke(CommandFinished $event): void
     {
-        $this->nightwatch->digest();
+        $this->nightwatch->finishExecution();
     }
 }