Add preconfigutred Cron Services

src/DependencyInjection/SentryExtension.php

@@ -20,6 +20,8 @@
 use Sentry\SentryBundle\EventListener\TracingRequestListener;
 use Sentry\SentryBundle\EventListener\TracingSubRequestListener;
 use Sentry\SentryBundle\Integration\IntegrationConfigurator;
+use Sentry\SentryBundle\Monitor\MonitorFactory;
+use Sentry\SentryBundle\Monitor\MonitorFactoryInterface;
 use Sentry\SentryBundle\SentryBundle;
 use Sentry\SentryBundle\Tracing\Doctrine\DBAL\ConnectionConfigurator;
 use Sentry\SentryBundle\Tracing\Doctrine\DBAL\TracingDriverMiddleware;
@@ -41,25 +43,17 @@
 
 final class SentryExtension extends ConfigurableExtension
 {
-    /**
-     * {@inheritdoc}
-     */
     public function getXsdValidationBasePath(): string
     {
         return __DIR__ . '/../Resources/config/schema';
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getNamespace(): string
     {
         return 'https://sentry.io/schema/dic/sentry-symfony';
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @param array<array-key, mixed> $mergedConfig
      */
     protected function loadInternal(array $mergedConfig, ContainerBuilder $container): void
@@ -154,6 +148,23 @@ private function registerConfiguration(ContainerBuilder $container, array $confi
             ->setDefinition('sentry.client', new Definition(Client::class))
             ->setPublic(false)
             ->setFactory([$clientBuilderDefinition, 'getClient']);
+
+        // Setup Monitors.
+        $environment = '';
+        if (\is_array($options) && isset($options['environment'])) {
+            $environment = $options['environment'];
+        }
+
+        $release = null;
+        if (\is_array($options) && isset($options['release'])) {
+            $release = $options['release'];
+        }
+
+        $container
+            ->register(MonitorFactoryInterface::class, MonitorFactory::class)
+            ->setPublic(true)
+            ->setArguments([$environment, $release])
+        ;
     }
 
     /**

src/Monitor/Monitor.php

@@ -0,0 +1,104 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Monitor;
+
+use Sentry\CheckIn;
+use Sentry\CheckInStatus;
+use Sentry\Event;
+use Sentry\MonitorConfig;
+use Sentry\State\HubInterface;
+
+class Monitor implements MonitorInterface
+{
+    /**
+     * @var HubInterface
+     */
+    private $hub;
+
+    /**
+     * @var MonitorConfig
+     */
+    private $monitorConfig;
+    /**
+     * @var string
+     */
+    private $environment;
+    /**
+     * @var string
+     */
+    private $slug;
+    /**
+     * @var string|null
+     */
+    private $release;
+
+    public function __construct(
+        HubInterface $hub,
+        MonitorConfig $monitorConfig,
+        string $slug,
+        string $environment,
+        string $release = null
+    ) {
+        $this->monitorConfig = $monitorConfig;
+        $this->environment = $environment;
+        $this->slug = $slug;
+        $this->hub = $hub;
+        $this->release = $release;
+    }
+
+    public function inProgress(CheckIn $previous = null): CheckIn
+    {
+        $event = Event::createCheckIn();
+        $checkIn = new CheckIn(
+            $this->slug,
+            CheckInStatus::inProgress(),
+            $previous ? $previous->getId() : null,
+            $this->release,
+            $this->environment,
+            null,
+            $this->monitorConfig
+        );
+        $event->setCheckIn($checkIn);
+        $this->hub->captureEvent($event);
+
+        return $checkIn;
+    }
+
+    public function error(CheckIn $previous = null): CheckIn
+    {
+        $event = Event::createCheckIn();
+        $checkIn = new CheckIn(
+            $this->slug,
+            CheckInStatus::error(),
+            $previous ? $previous->getId() : null,
+            $this->release,
+            $this->environment,
+            null,
+            $this->monitorConfig
+        );
+        $event->setCheckIn($checkIn);
+        $this->hub->captureEvent($event);
+
+        return $checkIn;
+    }
+
+    public function ok(CheckIn $previous = null): CheckIn
+    {
+        $event = Event::createCheckIn();
+        $checkIn = new CheckIn(
+            $this->slug,
+            CheckInStatus::ok(),
+            $previous ? $previous->getId() : null,
+            $this->release,
+            $this->environment,
+            null,
+            $this->monitorConfig
+        );
+        $event->setCheckIn($checkIn);
+        $this->hub->captureEvent($event);
+
+        return $checkIn;
+    }
+}

src/Monitor/MonitorFactory.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Monitor;
+
+use Sentry\MonitorConfig;
+use Sentry\SentrySdk;
+
+class MonitorFactory implements MonitorFactoryInterface
+{
+    /**
+     * @var string
+     */
+    private $environment;
+    /**
+     * @var string|null
+     */
+    private $release;
+
+    /**
+     * @param string $environment the configured environment
+     */
+    public function __construct(string $environment, string $release = null)
+    {
+        $this->environment = $environment;
+        $this->release = $release;
+    }
+
+    public function getMonitor(string $slug, MonitorConfig $monitorConfig): MonitorInterface
+    {
+        $hub = SentrySdk::getCurrentHub();
+
+        return new Monitor($hub, $monitorConfig, $slug, $this->environment, $this->release);
+    }
+}

src/Monitor/MonitorFactoryInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Monitor;
+
+use Sentry\MonitorConfig;
+
+interface MonitorFactoryInterface
+{
+    /**
+     * @param MonitorConfig $monitorConfig the monitor configuration
+     *
+     * @return MonitorInterface the monitor
+     */
+    public function getMonitor(string $slug, MonitorConfig $monitorConfig): MonitorInterface;
+}

src/Monitor/MonitorInterface.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Monitor;
+
+use Sentry\CheckIn;
+
+interface MonitorInterface
+{
+    public function inProgress(CheckIn $previous = null): CheckIn;
+
+    public function error(CheckIn $previous = null): CheckIn;
+
+    public function ok(CheckIn $previous = null): CheckIn;
+}

tests/Cron/CronJobFactoryTest.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\Cron;
+
+use PHPUnit\Framework\TestCase;
+use Sentry\MonitorConfig;
+use Sentry\MonitorSchedule;
+use Sentry\MonitorScheduleUnit;
+use Sentry\SentryBundle\Monitor\MonitorFactory;
+use Sentry\SentryBundle\Monitor\MonitorInterface;
+
+class CronJobFactoryTest extends TestCase
+{
+    public function testCronJob(): void
+    {
+        // Setup test
+        $factory = new MonitorFactory('test', 'test-release');
+        $monitorConfig = new MonitorConfig(
+            MonitorSchedule::crontab('*/5 * * * *'),
+            5,
+            30,
+            'UTC'
+        );
+        $cronJob = $factory->getMonitor('test-cronjob', $monitorConfig);
+        $this->assertInstanceOf(MonitorInterface::class, $cronJob);
+
+        // Create a CheckIn
+        $checkIn = $cronJob->inProgress();
+        $this->assertEquals('test', $checkIn->getEnvironment());
+        $this->assertEquals('test-release', $checkIn->getRelease());
+        $this->assertEquals('test-cronjob', $checkIn->getMonitorSlug());
+    }
+
+    public function testInterval(): void
+    {
+        // Setup test
+        $factory = new MonitorFactory('test', 'test-release');
+        $monitorConfig = new MonitorConfig(
+            MonitorSchedule::interval(
+                30,
+                MonitorScheduleUnit::minute()
+            ),
+            5,
+            30,
+            'UTC'
+        );
+        $interval = $factory->getMonitor('test-interval', $monitorConfig);
+        $this->assertInstanceOf(MonitorInterface::class, $interval);
+
+        // Create a CheckIn
+        $checkIn = $interval->inProgress();
+        $this->assertEquals('test', $checkIn->getEnvironment());
+        $this->assertEquals('test-release', $checkIn->getRelease());
+        $this->assertEquals('test-interval', $checkIn->getMonitorSlug());
+    }
+}