Add captureCheckIn()

src/State/Hub.php

@@ -5,11 +5,14 @@
 namespace Sentry\State;
 
 use Sentry\Breadcrumb;
+use Sentry\CheckIn;
+use Sentry\CheckInStatus;
 use Sentry\ClientInterface;
 use Sentry\Event;
 use Sentry\EventHint;
 use Sentry\EventId;
 use Sentry\Integration\IntegrationInterface;
+use Sentry\MonitorConfig;
 use Sentry\Severity;
 use Sentry\Tracing\SamplingContext;
 use Sentry\Tracing\Span;
@@ -169,6 +172,26 @@
         return null;
     }
 
+    public function captureCheckIn(string $slug, MonitorConfig $upsertMonitorConfig, CheckInStatus $status, ?CheckIn $previous = null): CheckIn
+    {
+        $options = $this->getClient()->getOptions();
+
+        $event = Event::createCheckIn();
+        $checkIn = new CheckIn(
+            $slug,
+            $status,
+            $previous?$previous->getId():null,
+            $options->getRelease(),
+            $options->getEnvironment(),
+            null,
+            $upsertMonitorConfig
+        );
+        $event->setCheckIn($checkIn);
+        $this->captureEvent($event);
+
+        return $checkIn;
+    }
+
     /**
      * {@inheritdoc}
      */

src/State/HubAdapter.php

@@ -5,11 +5,14 @@
 namespace Sentry\State;
 
 use Sentry\Breadcrumb;
+use Sentry\CheckIn;
+use Sentry\CheckInStatus;
 use Sentry\ClientInterface;
 use Sentry\Event;
 use Sentry\EventHint;
 use Sentry\EventId;
 use Sentry\Integration\IntegrationInterface;
+use Sentry\MonitorConfig;
 use Sentry\SentrySdk;
 use Sentry\Severity;
 use Sentry\Tracing\Span;
@@ -135,6 +138,14 @@ public function captureLastError(?EventHint $hint = null): ?EventId
         return SentrySdk::getCurrentHub()->captureLastError($hint);
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function captureCheckIn(string $slug, MonitorConfig $upsertMonitorConfig, CheckInStatus $status, ?CheckIn $previous = null): CheckIn
+    {
+        return SentrySdk::getCurrentHub()->captureCheckIn($slug, $upsertMonitorConfig, $status, $previous);
+    }
+
     /**
      * {@inheritdoc}
      */

src/State/HubInterface.php

@@ -5,11 +5,14 @@
 namespace Sentry\State;
 
 use Sentry\Breadcrumb;
+use Sentry\CheckIn;
+use Sentry\CheckInStatus;
 use Sentry\ClientInterface;
 use Sentry\Event;
 use Sentry\EventHint;
 use Sentry\EventId;
 use Sentry\Integration\IntegrationInterface;
+use Sentry\MonitorConfig;
 use Sentry\Severity;
 use Sentry\Tracing\SamplingContext;
 use Sentry\Tracing\Span;
@@ -112,6 +115,18 @@
      */
     public function captureLastError(/*?EventHint $hint = null*/): ?EventId;
 
+    /**
+     * Captures a CheckIn to the configured Monitor.
+     *
+     * @param string $slug Identifier of the Monitor
+     * @param MonitorConfig $upsertMonitorConfig Configuration of the Monitor
+     * @param CheckInStatus $status The status of the Monitor
+     * @param CheckIn|null $previos A CheckIn that may have preceded the current CheckIn
+     *
+     * @return CheckIn The created CheckIn
+     */
+    public function captureCheckIn(string $slug, MonitorConfig $upsertMonitorConfig, CheckInStatus $status, ?CheckIn $previous = null): CheckIn;
+
     /**
      * Records a new breadcrumb which will be attached to future events. They
      * will be added to subsequent events to provide more context on user's

tests/State/HubAdapterTest.php

@@ -6,11 +6,16 @@
 
 use PHPUnit\Framework\TestCase;
 use Sentry\Breadcrumb;
+use Sentry\CheckIn;
+use Sentry\CheckInStatus;
 use Sentry\ClientInterface;
 use Sentry\Event;
 use Sentry\EventHint;
 use Sentry\EventId;
 use Sentry\Integration\IntegrationInterface;
+use Sentry\MonitorConfig;
+use Sentry\MonitorSchedule;
+use Sentry\MonitorScheduleUnit;
 use Sentry\SentrySdk;
 use Sentry\Severity;
 use Sentry\State\HubAdapter;
@@ -255,6 +260,60 @@ public static function captureLastErrorDataProvider(): \Generator
         ];
     }
 
+    /**
+     * @dataProvider captureCheckInProvider
+     */
+    public function testCaptureCheckIn(array $expectedFunctionCallArgs)
+    {
+        $checkIn = new CheckIn(
+            $expectedFunctionCallArgs[0],
+            $expectedFunctionCallArgs[2]
+        );
+
+        $hub = $this->createMock(HubInterface::class);
+        $hub->expects($this->once())
+            ->method('captureCheckIn')
+            ->with(...$expectedFunctionCallArgs)
+            ->willReturn($checkIn);
+
+        SentrySdk::setCurrentHub($hub);
+
+        $this->assertSame($checkIn, HubAdapter::getInstance()->captureCheckIn(...$expectedFunctionCallArgs));
+
+    }
+
+    public static function captureCheckInProvider(): \Generator
+    {
+        yield [
+            [
+                'test-crontab',
+                new MonitorConfig(
+                    MonitorSchedule::crontab('*/5 * * * *'),
+                    5,
+                    30,
+                    'UTC'
+                ),
+                CheckInStatus::ok(),
+            ],
+        ];
+
+        yield [
+            [
+                'test-interval',
+                new MonitorConfig(
+                    MonitorSchedule::interval(
+                        5,
+                        MonitorScheduleUnit::minute()
+                    ),
+                    5,
+                    30,
+                    'UTC'
+                ),
+                CheckInStatus::ok(),
+            ],
+        ];
+    }
+
     public function testAddBreadcrumb(): void
     {
         $breadcrumb = new Breadcrumb(Breadcrumb::LEVEL_DEBUG, Breadcrumb::TYPE_ERROR, 'user');

tests/State/HubTest.php

@@ -7,14 +7,22 @@
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Sentry\Breadcrumb;
+use Sentry\CheckIn;
+use Sentry\CheckInStatus;
 use Sentry\ClientInterface;
 use Sentry\Event;
 use Sentry\EventHint;
 use Sentry\EventId;
 use Sentry\Integration\IntegrationInterface;
+use Sentry\MonitorConfig;
+use Sentry\MonitorSchedule;
+use Sentry\MonitorScheduleUnit;
 use Sentry\Options;
+use Sentry\SentrySdk;
 use Sentry\Severity;
 use Sentry\State\Hub;
+use Sentry\State\HubAdapter;
+use Sentry\State\HubInterface;
 use Sentry\State\Scope;
 use Sentry\Tracing\PropagationContext;
 use Sentry\Tracing\SamplingContext;
@@ -390,6 +398,59 @@ public static function captureLastErrorDataProvider(): \Generator
         ];
     }
 
+    /**
+     * @dataProvider captureCheckInProvider
+     */
+    public function testCaptureCheckIn(array $expectedFunctionCallArgs)
+    {
+        $checkIn = new CheckIn(
+            $expectedFunctionCallArgs[0],
+            $expectedFunctionCallArgs[2]
+        );
+
+        $hub = $this->createMock(HubInterface::class);
+        $hub->expects($this->once())
+            ->method('captureCheckIn')
+            ->with(...$expectedFunctionCallArgs)
+            ->willReturn($checkIn);
+
+        SentrySdk::setCurrentHub($hub);
+
+        $this->assertSame($checkIn, HubAdapter::getInstance()->captureCheckIn(...$expectedFunctionCallArgs));
+
+    }
+
+    public static function captureCheckInProvider(): \Generator
+    {
+        yield [
+            [
+                'test-crontab',
+                new MonitorConfig(
+                    MonitorSchedule::crontab('*/5 * * * *'),
+                    5,
+                    30,
+                    'UTC'
+                ),
+                CheckInStatus::ok(),
+            ],
+        ];
+
+        yield [
+            [
+                'test-interval',
+                new MonitorConfig(
+                    MonitorSchedule::interval(
+                        5,
+                        MonitorScheduleUnit::minute()
+                    ),
+                    5,
+                    30,
+                    'UTC'
+                ),
+                CheckInStatus::ok(),
+            ],
+        ];
+    }
     public function testCaptureEvent(): void
     {
         $hub = new Hub();