Add RemoveOldAuditCronJob to clean up outdated audit trails

- Introduced `RemoveOldAuditCronJob` class implementing `CronJobInterface` to delete old audit trails based on configured retention period.
- Added `deleteBefore` method to `AuditTrailRepository` to handle removal of records older than the specified date.
- Created `RemoveOldAuditCronJobTest` to ensure correct functionality for job execution and canRun logic.
- Updated DI configuration to include the `delete_after` parameter for audit trail retention settings.

src/Bundle/ChillMainBundle/Audit/RemoveOldAuditCronJob.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\MainBundle\Audit;
+
+use Chill\MainBundle\Cron\CronJobInterface;
+use Chill\MainBundle\Entity\CronJobExecution;
+use Chill\MainBundle\Repository\AuditTrailRepository;
+use Symfony\Component\Clock\ClockInterface;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
+
+final readonly class RemoveOldAuditCronJob implements CronJobInterface
+{
+    private \DateInterval $deleteBefore;
+
+    private const KEY = 'remove-old-audit-cron-job';
+
+    public function __construct(
+        ParameterBagInterface $bag,
+        private AuditTrailRepository $auditTrailRepository,
+        private ClockInterface $clock,
+    ) {
+        $config = $bag->get('chill_main.audit_trail');
+        if (is_array($config) && is_string($intervalString = $config['delete_after'] ?? null)) {
+            $this->deleteBefore = new \DateInterval($intervalString);
+        }
+    }
+
+    public function canRun(?CronJobExecution $cronJobExecution): bool
+    {
+        if (null === $cronJobExecution) {
+            return true;
+        }
+
+        return $this->clock->now() >= $cronJobExecution->getLastStart()->add(new \DateInterval('PT23H58M'));
+    }
+
+    public function getKey(): string
+    {
+        return self::KEY;
+    }
+
+    public function run(array $lastExecutionData): ?array
+    {
+        $deleteBefore = $this->clock->now()->sub($this->deleteBefore);
+        $this->auditTrailRepository->deleteBefore($deleteBefore);
+
+        return ['delete-before' => $deleteBefore->format(\DateTimeImmutable::ISO8601_EXPANDED)];
+    }
+}

src/Bundle/ChillMainBundle/DependencyInjection/ChillMainExtension.php

@@ -211,6 +211,8 @@ class ChillMainExtension extends Extension implements
             $config['top_banner'] ?? []
         );
 
+        $container->setParameter('chill_main.audit_trail', $config['audit_trail']);
+
         $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../config'));
         $loader->load('services.yaml');
         $loader->load('services/doctrine.yaml');

src/Bundle/ChillMainBundle/DependencyInjection/Configuration.php

@@ -325,6 +325,12 @@ class Configuration implements ConfigurationInterface
             ->end()
             ->end();
 
+        $rootNode->children()
+            ->arrayNode('audit_trail')->addDefaultsIfNotSet()->children()
+            ->scalarNode('delete_after')->cannotBeEmpty()->defaultValue('P6M')->info('The duration (a valid interval) before deleting the audit trail. Will be run by a cronjob.')->end()
+            ->end()
+            ->end();
+
         return $treeBuilder;
     }
 }

src/Bundle/ChillMainBundle/Repository/AuditTrailRepository.php

@@ -85,6 +85,15 @@ class AuditTrailRepository extends ServiceEntityRepository
             ->getQuery()->getSingleScalarResult();
     }
 
+    public function deleteBefore(\DateTimeImmutable $date): void
+    {
+        $this->createQueryBuilder('audit')
+            ->delete()
+            ->where('audit.occurredAt < :date')
+            ->setParameter('date', $date, Types::DATETIMETZ_IMMUTABLE)
+            ->getQuery()->execute();
+    }
+
     /**
      * @param array{subjects?: list<Subject>, from_date?: \DateTimeImmutable, to_date?: \DateTimeImmutable, by_users?: list<User>} $criteria
      */

src/Bundle/ChillMainBundle/Tests/Audit/RemoveOldAuditCronJobTest.php

@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\MainBundle\Tests\Audit;
+
+use Chill\MainBundle\Entity\CronJobExecution;
+use Chill\MainBundle\Audit\RemoveOldAuditCronJob;
+use Chill\MainBundle\Repository\AuditTrailRepository;
+use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Symfony\Component\Clock\MockClock;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
+
+/**
+ * @internal
+ *
+ * @coversNothing
+ */
+class RemoveOldAuditCronJobTest extends TestCase
+{
+    use ProphecyTrait;
+
+    public function testCanRun(): void
+    {
+        $now = new \DateTimeImmutable('2024-01-01 12:00:00');
+        $clock = new MockClock($now);
+        $bag = new ParameterBag(['chill_main.audit_trail' => ['delete_after' => 'P1Y']]);
+        $repository = $this->prophesize(AuditTrailRepository::class);
+
+        $job = new RemoveOldAuditCronJob($bag, $repository->reveal(), $clock);
+
+        // with null value (must return true)
+        self::assertTrue($job->canRun(null));
+
+        // with a last execution 23h ago (must return false)
+        $execution23h = new CronJobExecution('key');
+        $execution23h->setLastStart($now->sub(new \DateInterval('PT23H')));
+        self::assertFalse($job->canRun($execution23h), 'Should return false when last execution was 23h ago');
+
+        // with a last execution 25h ago (must return true)
+        $execution25h = new CronJobExecution('key');
+        $execution25h->setLastStart($now->sub(new \DateInterval('PT25H')));
+        self::assertTrue($job->canRun($execution25h), 'Should return true when last execution was 25h ago');
+    }
+
+    public function testRun(): void
+    {
+        $now = new \DateTimeImmutable('2024-01-01 12:00:00');
+        $clock = new MockClock($now);
+        $bag = new ParameterBag(['chill_main.audit_trail' => ['delete_after' => 'P1M']]);
+        $repository = $this->prophesize(AuditTrailRepository::class);
+
+        $expectedDeleteBefore = $now->sub(new \DateInterval('P1M'));
+
+        // add a spy and check that the deleteBefore method is triggered
+        $repository->deleteBefore($expectedDeleteBefore)->shouldBeCalled();
+
+        $job = new RemoveOldAuditCronJob($bag, $repository->reveal(), $clock);
+        $result = $job->run([]);
+
+        self::assertArrayHasKey('delete-before', $result);
+        self::assertEquals($expectedDeleteBefore->format(\DateTimeImmutable::ISO8601_EXPANDED), $result['delete-before']);
+    }
+}