Define a different timezone for scheduled tasks

README.md

@@ -113,6 +113,12 @@ Execute scheduled commands.
 
 **Run a specific scheduled command :** php bin/console synolia:scheduler-run --id=5
 
+Is it possible to choose the timezone of the command execution by setting the `SYNOLIA_SCHEDULER_PLUGIN_TIMEZONE` environment variable, example: 
+
+```
+SYNOLIA_SCHEDULER_PLUGIN_TIMEZONE=Europe/Paris
+```
+
 ### synolia:scheduler:purge-history
 
 Purge scheduled command history greater than {X} days old.

UPGRADE.md

@@ -6,3 +6,14 @@
 * `logFile` field must be renamed to `logFilePrefix` and must not end with the file extension
 
 Also, for old existing schedules in your database, please remove the log file extension in column `logFilePrefix`.
+
+## from 3.8 to 3.9
+
+* The constructors of `Synolia\SyliusSchedulerCommandPlugin\Checker\EveryMinuteIsDueChecker` and `Synolia\SyliusSchedulerCommandPlugin\Checker\SoftLimitThresholdIsDueChecker` has been modified, a new argument has been added :
+
+   ```php
+    public function __construct(
+        // ...
+        private ?DateTimeProviderInterface $dateTimeProvider = null,
+    )
+    ```

src/Checker/EveryMinuteIsDueChecker.php

@@ -5,6 +5,7 @@
 namespace Synolia\SyliusSchedulerCommandPlugin\Checker;
 
 use Cron\CronExpression;
+use Sylius\Calendar\Provider\DateTimeProviderInterface;
 use Symfony\Component\DependencyInjection\Attribute\AutoconfigureTag;
 use Synolia\SyliusSchedulerCommandPlugin\Components\Exceptions\Checker\IsNotDueException;
 use Synolia\SyliusSchedulerCommandPlugin\Entity\CommandInterface;
@@ -17,6 +18,20 @@ class EveryMinuteIsDueChecker implements IsDueCheckerInterface
 {
     private const PRIORITY = 0;
 
+    public function __construct(
+        private readonly ?DateTimeProviderInterface $dateTimeProvider = null,
+    ) {
+        if (!$dateTimeProvider instanceof DateTimeProviderInterface) {
+            trigger_deprecation(
+                'synolia/sylius-scheduler-command-plugin',
+                '3.9',
+                'Not passing a service that implements "%s" as a 1st argument of "%s" constructor is deprecated and will be prohibited in 4.0.',
+                DateTimeProviderInterface::class,
+                self::class,
+            );
+        }
+    }
+
     public static function getDefaultPriority(): int
     {
         return self::PRIORITY;
@@ -28,7 +43,7 @@ public static function getDefaultPriority(): int
     public function isDue(CommandInterface $command, ?\DateTimeInterface $dateTime = null): bool
     {
         if (!$dateTime instanceof \DateTimeInterface) {
-            $dateTime = new \DateTime();
+            $dateTime = $this->dateTimeProvider?->now() ?? new \DateTime();
         }
 
         $cron = new CronExpression($command->getCronExpression());

src/Checker/SoftLimitThresholdIsDueChecker.php

@@ -5,6 +5,7 @@
 namespace Synolia\SyliusSchedulerCommandPlugin\Checker;
 
 use Cron\CronExpression;
+use Sylius\Calendar\Provider\DateTimeProviderInterface;
 use Symfony\Component\DependencyInjection\Attribute\AutoconfigureTag;
 use Synolia\SyliusSchedulerCommandPlugin\Components\Exceptions\Checker\IsNotDueException;
 use Synolia\SyliusSchedulerCommandPlugin\Entity\CommandInterface;
@@ -22,11 +23,21 @@ public static function getDefaultPriority(): int
 
     public function __construct(
         private readonly ScheduledCommandRepositoryInterface $scheduledCommandRepository,
+        private readonly ?DateTimeProviderInterface $dateTimeProvider = null,
         /**
          * Threshold in minutes
          */
         private readonly int $threshold = 5,
     ) {
+        if (!$dateTimeProvider instanceof DateTimeProviderInterface) {
+            trigger_deprecation(
+                'synolia/sylius-scheduler-command-plugin',
+                '3.9',
+                'Not passing a service that implements "%s" as a 1st argument of "%s" constructor is deprecated and will be prohibited in 4.0.',
+                DateTimeProviderInterface::class,
+                self::class,
+            );
+        }
     }
 
     /**
@@ -35,7 +46,7 @@ public function __construct(
     public function isDue(CommandInterface $command, ?\DateTimeInterface $dateTime = null): bool
     {
         if (!$dateTime instanceof \DateTimeInterface) {
-            $dateTime = new \DateTime();
+            $dateTime = $this->dateTimeProvider?->now() ?? new \DateTime();
         }
 
         $cron = new CronExpression($command->getCronExpression());

src/Provider/CalendarWithTimezone.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Synolia\SyliusSchedulerCommandPlugin\Provider;
+
+use DateTimeImmutable;
+use DateTimeZone;
+use Exception;
+use Sylius\Calendar\Provider\DateTimeProviderInterface;
+use Symfony\Component\DependencyInjection\Attribute\AsAlias;
+use Symfony\Component\DependencyInjection\Attribute\Autowire;
+
+#[AsAlias(DateTimeProviderInterface::class)]
+final class CalendarWithTimezone implements DateTimeProviderInterface
+{
+    public function __construct(
+        #[Autowire(param: 'env(SYNOLIA_SCHEDULER_PLUGIN_TIMEZONE)')]
+        private ?string $timezone = null,
+    ) {
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function now(): \DateTimeInterface
+    {
+        $timezone = $this->timezone ?? date_default_timezone_get();
+
+        return new DateTimeImmutable(timezone: new DateTimeZone($timezone));
+    }
+}

src/Resources/config/services.yaml

@@ -3,6 +3,7 @@ parameters:
     env(SYNOLIA_SCHEDULER_PLUGIN_KEEP_ALIVE): true
     env(SYNOLIA_SCHEDULER_PLUGIN_LOGS_DIR): '%kernel.logs_dir%'
     env(SYNOLIA_SCHEDULER_PLUGIN_TIMEFORMAT_24H): false
+    env(SYNOLIA_SCHEDULER_PLUGIN_TIMEZONE): ~
 
 services:
     _defaults:

tests/PHPUnit/Checker/EveryMinuteIsDueCheckerTest.php

@@ -10,6 +10,14 @@
 
 class EveryMinuteIsDueCheckerTest extends AbstractIsDueTestCase
 {
+    private EveryMinuteIsDueChecker $everyMinuteIsDueChecker;
+
+    public function setUp(): void
+    {
+        parent::setUp();
+        $this->everyMinuteIsDueChecker = static::getContainer()->get(EveryMinuteIsDueChecker::class);
+    }
+
     /**
      * @dataProvider isDueUsingCronExpressionDataProvider
      */
@@ -18,13 +26,12 @@ public function testIsDue(
         \DateTimeInterface $currentDateTime,
         bool $expectedResult,
     ): void {
-        $checker = new EveryMinuteIsDueChecker();
         $command = $this->setupCommand($cronExpression);
 
         if ($expectedResult === false) {
             $this->expectException(IsNotDueException::class);
         }
 
-        $this->assertEquals($expectedResult, $checker->isDue($command, $currentDateTime));
+        $this->assertEquals($expectedResult, $this->everyMinuteIsDueChecker->isDue($command, $currentDateTime));
     }
 }