Capture scheduled task sub-minute frequency (#302)

Author: jessarcher

src/Compatibility.php

@@ -37,6 +37,8 @@ final class Compatibility
 
     public static bool $queuedJobDurationCapturable = false;
 
+    public static bool $subMinuteScheduledTasksSupported = false;
+
     /**
      * @var array{
      *   nightwatch_should_sample?: bool|null,
@@ -97,6 +99,13 @@ public static function boot(Application $app): void
         self::$queuedJobDurationCapturable =
             version_compare($version, '10.42.0', '>=');
 
+        /**
+         * @see https://github.com/laravel/framework/pull/47279
+         * @see https://github.com/laravel/framework/releases/tag/v10.15.0
+         */
+        self::$subMinuteScheduledTasksSupported =
+            version_compare($version, '10.15.0', '>=');
+
         /**
          * @see https://github.com/laravel/framework/commit/6da5093aa672d26d0357b35
          * @see https://github.com/laravel/framework/releases/tag/v11.5.0

src/Sensors/ScheduledTaskSensor.php

@@ -11,6 +11,7 @@
 use Illuminate\Console\Scheduling\CallbackEvent;
 use Illuminate\Console\Scheduling\Event as SchedulingEvent;
 use Laravel\Nightwatch\Clock;
+use Laravel\Nightwatch\Compatibility;
 use Laravel\Nightwatch\Concerns\RecordsContext;
 use Laravel\Nightwatch\State\CommandState;
 use Laravel\Nightwatch\Types\Str;
@@ -49,19 +50,23 @@ public function __invoke(ScheduledTaskFinished|ScheduledTaskSkipped|ScheduledTas
         $now = $this->clock->microtime();
         $name = $this->normalizeTaskName($event->task);
         $timezone = $event->task->timezone instanceof DateTimeZone ? $event->task->timezone->getName() : $event->task->timezone;
+        $repeatSeconds = Compatibility::$subMinuteScheduledTasksSupported && $event->task->repeatSeconds !== null ? $event->task->repeatSeconds : 0;
 
         return [
             'v' => 1,
             't' => 'scheduled-task',
             'timestamp' => $this->commandState->timestamp,
             'deploy' => $this->commandState->deploy,
             'server' => $this->commandState->server,
-            '_group' => hash('xxh128', "{$name},{$event->task->expression},{$timezone}"),
+            '_group' => $repeatSeconds > 0
+                ? hash('xxh128', "{$name},{$event->task->expression},{$timezone},{$repeatSeconds}")
+                : hash('xxh128', "{$name},{$event->task->expression},{$timezone}"),
             'trace_id' => $this->commandState->trace,
             // --- //
             'name' => $name,
             'cron' => $event->task->expression,
             'timezone' => $timezone,
+            'repeat_seconds' => $repeatSeconds,
             'without_overlapping' => $event->task->withoutOverlapping,
             'on_one_server' => $event->task->onOneServer,
             'run_in_background' => $event->task->runInBackground,

tests/Feature/Sensors/ScheduledTaskSensorTest.php

@@ -67,6 +67,7 @@ public function test_it_ingests_processed_tasks(): void
                 'name' => $name,
                 'cron' => '* * * * *',
                 'timezone' => 'UTC',
+                'repeat_seconds' => 0,
                 'without_overlapping' => false,
                 'on_one_server' => false,
                 'run_in_background' => false,
@@ -116,6 +117,7 @@ public function test_it_ingests_skipped_tasks(): void
                 'name' => $name,
                 'cron' => '* * * * *',
                 'timezone' => 'UTC',
+                'repeat_seconds' => 0,
                 'without_overlapping' => false,
                 'on_one_server' => false,
                 'run_in_background' => false,
@@ -167,6 +169,7 @@ public function test_it_ingests_failed_tasks(): void
                 'name' => $name,
                 'cron' => '* * * * *',
                 'timezone' => 'UTC',
+                'repeat_seconds' => 0,
                 'without_overlapping' => false,
                 'on_one_server' => false,
                 'run_in_background' => false,
@@ -217,6 +220,7 @@ public function test_it_ingests_tasks_run_in_background(): void
                 'name' => 'php artisan app:fly tokyo',
                 'cron' => '* * * * *',
                 'timezone' => 'UTC',
+                'repeat_seconds' => 0,
                 'without_overlapping' => false,
                 'on_one_server' => false,
                 'run_in_background' => true,
@@ -248,6 +252,7 @@ public function test_it_ingests_subminute_tasks(): void
         $line = __LINE__ + 1;
         $task = $this->app[Schedule::class]->call(fn () => $this->travelTo(now()->addMicroseconds(30_000_000)))->everyThirtySeconds();
         $name = "Closure at: tests/Feature/Sensors/ScheduledTaskSensorTest.php:{$line}";
+        $repeatSeconds = Compatibility::$subMinuteScheduledTasksSupported ? 30 : 0;
 
         Artisan::call('schedule:run');
 
@@ -260,11 +265,12 @@ public function test_it_ingests_subminute_tasks(): void
                 'timestamp' => 946688523.456789,
                 'deploy' => 'v1.2.3',
                 'server' => 'scheduler-01',
-                '_group' => hash('xxh128', "{$name},{$task->expression},{$task->timezone}"),
+                '_group' => hash('xxh128', "{$name},{$task->expression},{$task->timezone},{$repeatSeconds}"),
                 'trace_id' => '00000000-0000-0000-0000-000000000000',
                 'name' => $name,
                 'cron' => '* * * * *',
                 'timezone' => 'UTC',
+                'repeat_seconds' => Compatibility::$subMinuteScheduledTasksSupported ? 30 : 0,
                 'without_overlapping' => false,
                 'on_one_server' => false,
                 'run_in_background' => false,
@@ -296,11 +302,12 @@ public function test_it_ingests_subminute_tasks(): void
                 'timestamp' => 946688553.456789,
                 'deploy' => 'v1.2.3',
                 'server' => 'scheduler-01',
-                '_group' => hash('xxh128', "{$name},{$task->expression},{$task->timezone}"),
+                '_group' => hash('xxh128', "{$name},{$task->expression},{$task->timezone},{$repeatSeconds}"),
                 'trace_id' => '00000000-0000-0000-0000-000000000000',
                 'name' => $name,
                 'cron' => '* * * * *',
                 'timezone' => 'UTC',
+                'repeat_seconds' => $repeatSeconds,
                 'without_overlapping' => false,
                 'on_one_server' => false,
                 'run_in_background' => false,