Added command to anonymize worklogs after 5 years

CHANGELOG.md

@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+* [PR-279](https://github.com/itk-dev/economics/pull/279)
+  Anonymize worklogs after 5 years.
 * [PR-276](https://github.com/itk-dev/economics/pull/276)
   Changed to use supercronic instead of woodpecker for crontabs.
 * [PR-277](https://github.com/itk-dev/economics/pull/277)

crontab.prod

@@ -3,3 +3,6 @@
 
 # Sync deleted every 15 minutes starting at 10 minutes past the hour
 10,25,40,55 * * * * bin/console app:data-providers:sync-deleted
+
+# Anonymize worklogs after 5 years, every night at 03:00
+* 3 * * * bin/console app:anonymize-worklogs

crontab.stg

@@ -3,3 +3,6 @@
 
 # Sync deleted every hour starting at 10 minutes past the hour
 10 * * * * bin/console app:data-providers:sync-deleted
+
+# Anonymize worklogs after 5 years, every night at 03:00
+* 3 * * * bin/console app:anonymize-worklogs

migrations/Version20260325094458.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoctrineMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20260325094458 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return '';
+    }
+
+    public function up(Schema $schema): void
+    {
+        // this up() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE worklog ADD anonymized_date DATETIME DEFAULT NULL');
+    }
+
+    public function down(Schema $schema): void
+    {
+        // this down() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE worklog DROP anonymized_date');
+    }
+}

src/Command/AnonymizeWorklogsCommand.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace App\Command;
+
+use App\Service\AnonymizeService;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+#[AsCommand(
+    name: 'app:anonymize-worklogs',
+    description: 'Anonymizes worklogs that are older than 5 years.',
+)]
+class AnonymizeWorklogsCommand extends Command
+{
+    public function __construct(
+        private readonly AnonymizeService $anonymizeService,
+    ) {
+        parent::__construct($this->getName());
+    }
+
+    #[\Override]
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $anonymizeBefore = (new \DateTime())->sub(new \DateInterval('P5Y'));
+
+        $this->anonymizeService->anonymizeWorklogs($anonymizeBefore);
+
+        return Command::SUCCESS;
+    }
+}

src/Entity/Trait/AnonymizedTrait.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace App\Entity\Trait;
+
+use Doctrine\DBAL\Types\Types;
+use Doctrine\ORM\Mapping as ORM;
+
+trait AnonymizedTrait
+{
+    #[ORM\Column(type: Types::DATETIME_MUTABLE, nullable: true)]
+    private ?\DateTimeInterface $anonymizedDate = null;
+
+    public function getAnonymizedDate(): ?\DateTimeInterface
+    {
+        return $this->anonymizedDate;
+    }
+
+    public function setAnonymizedDate(?\DateTimeInterface $anonymizedDate): void
+    {
+        $this->anonymizedDate = $anonymizedDate;
+    }
+}

src/Entity/Worklog.php

@@ -2,6 +2,7 @@
 
 namespace App\Entity;
 
+use App\Entity\Trait\AnonymizedTrait;
 use App\Entity\Trait\DataProviderTrait;
 use App\Entity\Trait\SynchronizedEntityTrait;
 use App\Enum\BillableKindsEnum;
@@ -19,6 +20,7 @@ class Worklog extends AbstractBaseEntity
 {
     use DataProviderTrait;
     use SynchronizedEntityTrait;
+    use AnonymizedTrait;
 
     // TODO: Rename to projectTrackerId.
     #[ORM\Column]

src/Repository/WorklogRepository.php

@@ -296,4 +296,20 @@ public function getWorklogsAttachedToInvoiceInDateRange(\DateTimeInterface $peri
             'paginator' => $paginator,
         ];
     }
+
+    public function anonymizeWorklogs(\DateTimeInterface $anonymizeBefore): int
+    {
+        $qb = $this->createQueryBuilder('w');
+
+        $qb->update()
+            ->set('w.description', 'CONCAT(:prefix, w.id)')
+            ->set('w.anonymizedDate', ':now')
+            ->where('w.started < :anonymizeBefore')
+            ->andWhere('w.anonymizedDate IS NULL')
+            ->setParameter('prefix', 'worklog ')
+            ->setParameter('now', new \DateTime())
+            ->setParameter('anonymizeBefore', $anonymizeBefore);
+
+        return $qb->getQuery()->execute();
+    }
 }

src/Service/AnonymizeService.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace App\Service;
+
+use App\Repository\WorklogRepository;
+
+class AnonymizeService
+{
+    public function __construct(private readonly WorklogRepository $worklogRepository)
+    {
+    }
+
+    public function anonymizeWorklogs(\DateTime $anonymizeBefore)
+    {
+        $this->worklogRepository->anonymizeWorklogs($anonymizeBefore);
+    }
+}

src/Service/DataProviderService.php

@@ -238,7 +238,11 @@ public function upsertWorklog(DataProviderWorklogData $upsertWorklogData): void
         }
 
         $worklog->setWorklogId($upsertWorklogData->projectTrackerId);
-        $worklog->setDescription($upsertWorklogData->description);
+
+        if (null === $worklog->getAnonymizedDate()) {
+            $worklog->setDescription($upsertWorklogData->description);
+        }
+
         $worklog->setWorker($upsertWorklogData->username);
         $worklog->setStarted($upsertWorklogData->startedDate);
         $worklog->setProjectTrackerIssueId($upsertWorklogData->projectTrackerIssueId);