Merge pull request #49 from itk-dev/feature/detection_result_cleanup

Feature/detection result cleanup

Author: turegjorup

.env

@@ -60,3 +60,6 @@ OIDC_CLI_LOGIN_ROUTE=OIDC_CLI_LOGIN_ROUTE_TEST
 VAULT_URL=https://vault.itkdev.dk
 VAULT_ROLE_ID="CHANGE_ME_IN_LOCAL_ENV"
 VAULT_SECRET_ID="CHANGE_ME_IN_LOCAL_ENV"
+
+# The number of old results for each server/result-type combination
+APP_KEEP_RESULTS=5

CHANGELOG.md

@@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Upgrade to: Symfony 7.2, Doctrine ORM 3.x / DBAL 4.x, Api-platform 4.0, PhpUnit 11 with dependencies
 - Switch to PHPStan
+- Added cleanup for detection results
+- Refactor rootDir normalization to ensure values are always normalized, fix type errors, 
+- Fix various values not being set
 
 ## [1.7.0] - 2024-10-14
 

config/services.yaml

@@ -27,14 +27,13 @@ services:
         App\Handler\DetectionResultHandlerInterface:
             tags: [ app.handler.detection_result_handler ]
 
-    App\MessageHandler\ProcessDetectionResultHandler:
-        arguments:
-            $resultHandlers: !tagged_iterator app.handler.detection_result_handler
-
     App\EventListener\RemovedRelationsListener:
         tags:
             -
                 name: 'doctrine.event_listener'
                 event: 'postFlush'
 
-
+    App\MessageHandler\ProcessDetectionResultHandler:
+        arguments:
+            $resultHandlers: !tagged_iterator app.handler.detection_result_handler
+            $keepResults: '%env(int:APP_KEEP_RESULTS)%'

migrations/Version20250123132456.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 Version20250123132456 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 server ADD last_contact_at DATETIME NULL');
+    }
+
+    public function down(Schema $schema): void
+    {
+        // this down() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE server DROP last_contact_at');
+    }
+}

migrations/Version20250205115916.php

@@ -0,0 +1,32 @@
+<?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 Version20250205115916 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 package ADD suggests VARCHAR(255) DEFAULT NULL');
+        $this->addSql('UPDATE detection_result SET root_dir = REPLACE(root_dir, \'/public\', \'\') WHERE root_dir LIKE \'%/public\'');
+    }
+
+    public function down(Schema $schema): void
+    {
+        // this down() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE package DROP suggests');
+    }
+}

src/Command/ReplayDetectionResultsCommand.php

@@ -117,7 +117,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         $count = $this->entityManager->getRepository(DetectionResult::class)->count($criteria);
 
-        $this->entityManager->getConnection()->getConfiguration()->setSQLLogger(null);
+        $this->entityManager->getConnection()->getConfiguration()->setMiddlewares([new \Doctrine\DBAL\Logging\Middleware(new \Psr\Log\NullLogger())]);
         $iterable = $queryBuilder->getQuery()->toIterable();
 
         $limit = intval($input->getOption('limit'));

src/Controller/Admin/ServerCrudController.php

@@ -23,6 +23,7 @@
 use EasyCorp\Bundle\EasyAdminBundle\Field\AssociationField;
 use EasyCorp\Bundle\EasyAdminBundle\Field\BooleanField;
 use EasyCorp\Bundle\EasyAdminBundle\Field\ChoiceField;
+use EasyCorp\Bundle\EasyAdminBundle\Field\DateTimeField;
 use EasyCorp\Bundle\EasyAdminBundle\Field\FormField;
 use EasyCorp\Bundle\EasyAdminBundle\Field\TextareaField;
 use EasyCorp\Bundle\EasyAdminBundle\Field\TextField;
@@ -91,6 +92,7 @@ public function configureFields(string $pageName): iterable
         yield TextField::new('serviceDeskTicket')->setColumns(12)->hideOnIndex();
         yield TextareaField::new('note')->hideOnIndex()->setColumns(6);
         yield TextareaField::new('usedFor')->hideOnIndex()->setColumns(6);
+        yield DateTimeField::new('lastContactAt');
     }
 
     #[\Override]

src/Controller/Admin/SiteCrudController.php

@@ -4,6 +4,7 @@
 
 namespace App\Controller\Admin;
 
+use App\Admin\Field\AdvisoryCountField;
 use App\Admin\Field\ConfigFilePathField;
 use App\Admin\Field\DomainField;
 use App\Admin\Field\RootDirField;
@@ -58,6 +59,7 @@ public function configureActions(Actions $actions): Actions
     public function configureFields(string $pageName): iterable
     {
         yield DomainField::new('primaryDomain')->setColumns(12);
+        yield AdvisoryCountField::new('advisoryCount')->setLabel('Adv.');
         yield AssociationField::new('domains')->hideOnIndex();
         yield SiteTypeField::new('type')->setLabel('Stack');
         yield ConfigFilePathField::new('configFilePath')->setColumns(12)->hideOnIndex();

src/Entity/AbstractBaseEntity.php

@@ -11,7 +11,7 @@
 
 #[ORM\MappedSuperclass]
 #[ORM\HasLifecycleCallbacks]
-abstract class AbstractBaseEntity
+abstract class AbstractBaseEntity implements \Stringable
 {
     #[ApiProperty(identifier: true)]
     #[ORM\Id]

src/Entity/AbstractHandlerResult.php

@@ -4,7 +4,6 @@
 
 namespace App\Entity;
 
-use App\Utils\RootDirNormalizer;
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Component\Serializer\Annotation\Groups;
 use Symfony\Component\Serializer\Annotation\SerializedName;
@@ -32,7 +31,7 @@ public function getRootDir(): string
 
     public function setRootDir(string $rootDir): self
     {
-        $this->rootDir = RootDirNormalizer::normalize($rootDir);
+        $this->rootDir = $rootDir;
 
         return $this;
     }