ping oh dear when scheduled task has started

config/schedule-monitor.php

@@ -63,5 +63,10 @@
          * longer than the time configured here.
          */
         'retry_job_for_minutes' => 10,
+
+        /*
+         * Sends a starting ping
+         */
+        'should_send_starting_ping' => env('OH_DEAR_SEND_STARTING_PING', false),
     ],
 ];

src/Models/MonitoredScheduledTask.php

@@ -92,6 +92,10 @@ public function markAsStarting(ScheduledTaskStarting $event): self
             'last_started_at' => now(),
         ]);
 
+        if (config('schedule-monitor.oh_dear.should_send_starting_ping') === true) {
+            $this->pingOhDear($logItem);
+        }
+
         return $this;
     }
 
@@ -176,6 +180,7 @@ public function pingOhDear(MonitoredScheduledTaskLogItem $logItem): self
         }
 
         if (! in_array($logItem->type, [
+            $this->getMonitoredScheduleTaskLogItemModel()::TYPE_STARTING,
             $this->getMonitoredScheduleTaskLogItemModel()::TYPE_FAILED,
             $this->getMonitoredScheduleTaskLogItemModel()::TYPE_FINISHED,
         ], true)) {

src/Support/OhDearPayload/OhDearPayloadFactory.php

@@ -6,12 +6,14 @@
 use Spatie\ScheduleMonitor\Support\OhDearPayload\Payloads\FailedPayload;
 use Spatie\ScheduleMonitor\Support\OhDearPayload\Payloads\FinishedPayload;
 use Spatie\ScheduleMonitor\Support\OhDearPayload\Payloads\Payload;
+use Spatie\ScheduleMonitor\Support\OhDearPayload\Payloads\StartingPayload;
 
 class OhDearPayloadFactory
 {
     public static function createForLogItem(MonitoredScheduledTaskLogItem $logItem): ?Payload
     {
         $payloadClasses = [
+            StartingPayload::class,
             FailedPayload::class,
             FinishedPayload::class,
         ];

src/Support/OhDearPayload/Payloads/FinishedPayload.php

@@ -20,7 +20,7 @@ public function url()
     public function data(): array
     {
         return Arr::only($this->logItem->meta ?? [], [
-            'runtime',
+            ...(config('schedule-monitor.oh_dear.should_send_starting_ping') ? [] : ['runtime']),
             'exit_code',
             'memory',
         ]);

src/Support/OhDearPayload/Payloads/StartingPayload.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Spatie\ScheduleMonitor\Support\OhDearPayload\Payloads;
+
+use Spatie\ScheduleMonitor\Models\MonitoredScheduledTaskLogItem;
+
+class StartingPayload extends Payload
+{
+    public static function canHandle(MonitoredScheduledTaskLogItem $logItem): bool
+    {
+        return $logItem->type === MonitoredScheduledTaskLogItem::TYPE_STARTING;
+    }
+
+    public function url()
+    {
+        return "{$this->baseUrl()}/starting";
+    }
+
+    public function data(): array
+    {
+        return [];
+    }
+}

tests/ScheduledTaskSubscriber/PingFinishedToOhDearTest.php

@@ -44,3 +44,23 @@
         return true;
     });
 });
+
+it('will not transmit runtime to ohdear when sending starting ping is enabled', function () {
+    config()->set('schedule-monitor.oh_dear.should_send_starting_ping', true);
+
+    dispatch(new PingOhDearJob($this->monitoredScheduledTaskLogItem));
+
+    Http::assertSent(function (Request $request) {
+        $this->assertEquals(
+            $request->url(),
+            $this->monitoredScheduledTaskLogItem->monitoredScheduledTask->ping_url . '/finished'
+        );
+
+        expect($request->data())->toEqual([
+            'exit_code' => 123,
+            'memory' => 12345,
+        ]);
+
+        return true;
+    });
+});

tests/ScheduledTaskSubscriber/PingStartingToOhDearTest.php

@@ -0,0 +1,40 @@
+<?php
+
+use Illuminate\Http\Client\Request;
+use Illuminate\Support\Facades\Http;
+use Spatie\ScheduleMonitor\Jobs\PingOhDearJob;
+use Spatie\ScheduleMonitor\Models\MonitoredScheduledTaskLogItem;
+use Spatie\TestTime\TestTime;
+
+beforeEach(function () {
+    TestTime::freeze('Y-m-d H:i:s', '2020-01-01 00:00:00');
+
+    Http::fake([
+        'ping.ohdear.app/*' => Http::response('ok', 200),
+    ]);
+
+    $this->monitoredScheduledTaskLogItem = MonitoredScheduledTaskLogItem::factory()->create([
+        'type' => MonitoredScheduledTaskLogItem::TYPE_STARTING,
+        'meta' => [],
+    ]);
+});
+
+it('can ping oh dear when a scheduled task has started', function () {
+    dispatch(new PingOhDearJob($this->monitoredScheduledTaskLogItem));
+
+    $this->assertEquals(
+        $this->monitoredScheduledTaskLogItem->monitoredScheduledTask->refresh()->last_pinged_at->format('Y-m-d H:i:s'),
+        now()->format('Y-m-d H:i:s'),
+    );
+
+    Http::assertSent(function (Request $request) {
+        $this->assertEquals(
+            $request->url(),
+            $this->monitoredScheduledTaskLogItem->monitoredScheduledTask->ping_url . '/starting'
+        );
+
+        expect($request->data())->toEqual([]);
+
+        return true;
+    });
+});

tests/ScheduledTaskSubscriber/ScheduledTaskSubscriberTest.php

@@ -26,13 +26,21 @@
 });
 
 it('will fire a job and create a log item when a monitored scheduled task finished', function () {
+    config()->set('schedule-monitor.oh_dear.should_send_starting_ping', true);
+
     $this->artisan(SyncCommand::class)->assertExitCode(0);
     $this->artisan('schedule:run')->assertExitCode(0);
 
     Bus::assertDispatched(function (PingOhDearJob $job) {
         $monitoredScheduledTask = $job->logItem->monitoredScheduledTask;
 
-        return $monitoredScheduledTask->name === 'dummy-task';
+        return $monitoredScheduledTask->name === 'dummy-task' && $job->logItem->type === MonitoredScheduledTaskLogItem::TYPE_STARTING;
+    });
+
+    Bus::assertDispatched(function (PingOhDearJob $job) {
+        $monitoredScheduledTask = $job->logItem->monitoredScheduledTask;
+
+        return $monitoredScheduledTask->name === 'dummy-task' && $job->logItem->type === MonitoredScheduledTaskLogItem::TYPE_FINISHED;
     });
 
     $logTypes = MonitoredScheduledTask::findByName('dummy-task')->logItems->pluck('type')->toArray();
@@ -43,6 +51,18 @@
     ], $logTypes);
 });
 
+it('will not not ping oh dear starting endpoint by default', function () {
+
+    $this->artisan(SyncCommand::class)->assertExitCode(0);
+    $this->artisan('schedule:run')->assertExitCode(0);
+
+    Bus::assertNotDispatched(function (PingOhDearJob $job) {
+        $monitoredScheduledTask = $job->logItem->monitoredScheduledTask;
+
+        return $monitoredScheduledTask->name === 'dummy-task' && $job->logItem->type === MonitoredScheduledTaskLogItem::TYPE_STARTING;
+    });
+});
+
 it('will log skipped scheduled tasks', function () {
     TestKernel::replaceScheduledTasks(function (Schedule $schedule) {
         $schedule
@@ -61,7 +81,7 @@
     ], $logTypes);
 });
 
-it('will log failures of scheduled tasks', function () {
+it('will fire a job and log failures of scheduled tasks', function () {
     TestKernel::replaceScheduledTasks(function (Schedule $schedule) {
         $schedule
             ->call(function () {
@@ -74,6 +94,12 @@
     $this->artisan(SyncCommand::class)->assertExitCode(0);
     $this->artisan('schedule:run')->assertExitCode(0);
 
+    Bus::assertDispatched(function (PingOhDearJob $job) {
+        $monitoredScheduledTask = $job->logItem->monitoredScheduledTask;
+
+        return $monitoredScheduledTask->name === 'failing-task' && $job->logItem->type === MonitoredScheduledTaskLogItem::TYPE_FAILED;
+    });
+
     $logTypes = MonitoredScheduledTask::findByName('failing-task')
         ->logItems
         ->pluck('type')