feat: Cron Monitor upsert (#1511)

Co-authored-by: Alex Bouma <alex@bouma.me>

src/CheckIn.php

@@ -38,6 +38,11 @@ final class CheckIn
      */
     private $duration;
 
+    /**
+     * @var \Sentry\MonitorConfig|null The monitor configuration
+     */
+    private $monitorConfig;
+
     /**
      * @param int|float|null $duration The duration of the check-in in seconds
      */
@@ -47,7 +52,8 @@ public function __construct(
         string $id = null,
         ?string $release = null,
         ?string $environment = null,
-        $duration = null
+        $duration = null,
+        ?MonitorConfig $monitorConfig = null
     ) {
         $this->setMonitorSlug($monitorSlug);
         $this->setStatus($status);
@@ -56,6 +62,7 @@ public function __construct(
         $this->setRelease($release ?? '');
         $this->setEnvironment($environment ?? Event::DEFAULT_ENVIRONMENT);
         $this->setDuration($duration);
+        $this->setMonitorConfig($monitorConfig);
     }
 
     public function getId(): string
@@ -123,4 +130,14 @@ public function setDuration($duration): void
     {
         $this->duration = $duration;
     }
+
+    public function getMonitorConfig(): ?MonitorConfig
+    {
+        return $this->monitorConfig;
+    }
+
+    public function setMonitorConfig(?MonitorConfig $monitorConfig): void
+    {
+        $this->monitorConfig = $monitorConfig;
+    }
 }

src/MonitorConfig.php

@@ -0,0 +1,101 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry;
+
+final class MonitorConfig
+{
+    /**
+     * @var MonitorSchedule The schedule of the monitor
+     */
+    private $schedule;
+
+    /**
+     * @var int|null The check-in margin in seconds
+     */
+    private $checkinMargin;
+
+    /**
+     * @var int|null The maximum runtime in seconds
+     */
+    private $maxRuntime;
+
+    /**
+     * @var string|null The timezone
+     */
+    private $timezone;
+
+    public function __construct(
+        MonitorSchedule $schedule,
+        ?int $checkinMargin = null,
+        ?int $maxRuntime = null,
+        ?string $timezone = null
+    ) {
+        $this->schedule = $schedule;
+        $this->checkinMargin = $checkinMargin;
+        $this->maxRuntime = $maxRuntime;
+        $this->timezone = $timezone;
+    }
+
+    public function getSchedule(): MonitorSchedule
+    {
+        return $this->schedule;
+    }
+
+    public function setSchedule(MonitorSchedule $schedule): self
+    {
+        $this->schedule = $schedule;
+
+        return $this;
+    }
+
+    public function getCheckinMargin(): ?int
+    {
+        return $this->checkinMargin;
+    }
+
+    public function setCheckinMargin(?int $checkinMargin): self
+    {
+        $this->checkinMargin = $checkinMargin;
+
+        return $this;
+    }
+
+    public function getMaxRuntime(): ?int
+    {
+        return $this->maxRuntime;
+    }
+
+    public function setMaxRuntime(?int $maxRuntime): self
+    {
+        $this->maxRuntime = $maxRuntime;
+
+        return $this;
+    }
+
+    public function getTimezone(): ?string
+    {
+        return $this->timezone;
+    }
+
+    public function setTimezone(?string $timezone): self
+    {
+        $this->timezone = $timezone;
+
+        return $this;
+    }
+
+    /**
+     * @return array<string, mixed>
+     */
+    public function toArray(): array
+    {
+        return [
+            'schedule' => $this->schedule->toArray(),
+            'checkin_margin' => $this->checkinMargin,
+            'max_runtime' => $this->maxRuntime,
+            'timezone' => $this->timezone,
+        ];
+    }
+}

src/MonitorSchedule.php

@@ -0,0 +1,106 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry;
+
+final class MonitorSchedule
+{
+    /**
+     * @var string The type of the schedule
+     */
+    private $type;
+
+    /**
+     * @var string|int The value of the schedule
+     */
+    private $value;
+
+    /**
+     * @var MonitorScheduleUnit|null The unit of the schedule
+     */
+    private $unit;
+
+    public const TYPE_CRONTAB = 'crontab';
+
+    public const TYPE_INTERVAL = 'interval';
+
+    /**
+     * @param string                   $type  The type of the schedule
+     * @param string|int               $value The value of the schedule
+     * @param MonitorScheduleUnit|null $unit  The unit of the schedule
+     */
+    public function __construct(
+        string $type,
+        $value,
+        ?MonitorScheduleUnit $unit = null
+    ) {
+        $this->type = $type;
+        $this->value = $value;
+        $this->unit = $unit;
+    }
+
+    public static function crontab(string $value): self
+    {
+        return new self(self::TYPE_CRONTAB, $value);
+    }
+
+    public static function interval(int $value, MonitorScheduleUnit $unit): self
+    {
+        return new self(self::TYPE_INTERVAL, $value, $unit);
+    }
+
+    public function getType(): string
+    {
+        return $this->type;
+    }
+
+    public function setType(string $type): self
+    {
+        $this->type = $type;
+
+        return $this;
+    }
+
+    /**
+     * @return string|int
+     */
+    public function getValue()
+    {
+        return $this->value;
+    }
+
+    /**
+     * @param string|int $value
+     */
+    public function setValue($value): self
+    {
+        $this->value = $value;
+
+        return $this;
+    }
+
+    public function getUnit(): ?MonitorScheduleUnit
+    {
+        return $this->unit;
+    }
+
+    public function setUnit(?MonitorScheduleUnit $unit): self
+    {
+        $this->unit = $unit;
+
+        return $this;
+    }
+
+    /**
+     * @return array<string, string|int>
+     */
+    public function toArray(): array
+    {
+        return [
+            'type' => $this->type,
+            'value' => $this->value,
+            'unit' => (string) $this->unit,
+        ];
+    }
+}

src/MonitorScheduleUnit.php

@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry;
+
+final class MonitorScheduleUnit implements \Stringable
+{
+    /**
+     * @var string The value of the enum instance
+     */
+    private $value;
+
+    /**
+     * @var array<string, self> A list of cached enum instances
+     */
+    private static $instances = [];
+
+    private function __construct(string $value)
+    {
+        $this->value = $value;
+    }
+
+    public static function minute(): self
+    {
+        return self::getInstance('minute');
+    }
+
+    public static function hour(): self
+    {
+        return self::getInstance('hour');
+    }
+
+    public static function day(): self
+    {
+        return self::getInstance('day');
+    }
+
+    public static function week(): self
+    {
+        return self::getInstance('week');
+    }
+
+    public static function month(): self
+    {
+        return self::getInstance('month');
+    }
+
+    public static function year(): self
+    {
+        return self::getInstance('year');
+    }
+
+    public function __toString(): string
+    {
+        return $this->value;
+    }
+
+    private static function getInstance(string $value): self
+    {
+        if (!isset(self::$instances[$value])) {
+            self::$instances[$value] = new self($value);
+        }
+
+        return self::$instances[$value];
+    }
+}

src/Serializer/PayloadSerializer.php

@@ -86,6 +86,10 @@ private function serializeAsCheckInEvent(Event $event): string
                 'environment' => $checkIn->getEnvironment(),
             ];
 
+            if (null !== $checkIn->getMonitorConfig()) {
+                $result['monitor_config'] = $checkIn->getMonitorConfig()->toArray();
+            }
+
             if (!empty($event->getContexts()['trace'])) {
                 $result['contexts']['trace'] = $event->getContexts()['trace'];
             }

tests/CheckInTest.php

@@ -7,6 +7,8 @@
 use PHPUnit\Framework\TestCase;
 use Sentry\CheckIn;
 use Sentry\CheckInStatus;
+use Sentry\MonitorConfig;
+use Sentry\MonitorSchedule;
 use Sentry\Util\SentryUid;
 
 final class CheckInTest extends TestCase
@@ -54,6 +56,7 @@ public function gettersAndSettersDataProvider(): array
             ['getRelease', 'setRelease', '1.0.0'],
             ['getEnvironment', 'setEnvironment', 'dev'],
             ['getDuration', 'setDuration', 10],
+            ['getMonitorConfig', 'setMonitorConfig', new MonitorConfig(MonitorSchedule::crontab('* * * * *'))],
         ];
     }
 }