Store new version's metadata

Author: stevenrombauts

src/Audit/Display/AuditLogDisplayFactory.php

@@ -57,8 +57,8 @@ public function buildSingle(AuditRecord $record): AuditLogDisplayInterface
                 $record->datetime,
                 $record->attributes['name'],
                 $record->attributes['version'],
-                $record->attributes['source'] ?? null,
-                $record->attributes['dist'] ?? null,
+                $record->attributes['metadata']['source']['reference'] ?? null,
+                $record->attributes['metadata']['dist']['reference']  ?? null,
                 $this->buildActor($record->attributes['actor']),
             ),
             AuditRecordType::VersionDeleted => new VersionDeletedDisplay(

src/Entity/AuditRecord.php

@@ -17,6 +17,9 @@
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Component\Uid\Ulid;
 
+/**
+ * @phpstan-import-type VersionArray from Version
+ */
 #[ORM\Entity(repositoryClass: AuditRecordRepository::class)]
 #[ORM\Table(name: 'audit_log')]
 #[ORM\Index(name: 'type_idx', columns: ['type'])]
@@ -80,11 +83,14 @@ public static function packageTransferred(Package $package, ?User $actor, array
         return new self(AuditRecordType::PackageTransferred, ['name' => $package->getName(), 'actor' => self::getUserData($actor, 'admin'), 'previous_maintainers' => $previous, 'current_maintainers' => $current], $actor?->getId(), $package->getVendor(), $package->getId());
     }
 
-    public static function versionCreated(Version $version, ?User $actor): self
+    /**
+     * @param VersionArray $metadata
+     */
+    public static function versionCreated(Version $version, array $metadata, ?User $actor): self
     {
         $package = $version->getPackage();
 
-        return new self(AuditRecordType::VersionCreated, ['name' => $package->getName(), 'version' => $version->getVersion(), 'actor' => self::getUserData($actor, 'automation'), 'source' => $version->getSource()['reference'] ?? null, 'dist' => $version->getDist()['reference'] ?? null], $actor?->getId(), $package->getVendor(), $package->getId());
+        return new self(AuditRecordType::VersionCreated, ['name' => $package->getName(), 'version' => $version->getVersion(), 'actor' => self::getUserData($actor, 'automation'), 'metadata' => $metadata], $actor?->getId(), $package->getVendor(), $package->getId());
     }
 
     public static function versionDeleted(Version $version, ?User $actor): self

src/EventListener/VersionListener.php

@@ -45,7 +45,8 @@ public function __construct(
      */
     public function postPersist(Version $version, LifecycleEventArgs $event): void
     {
-        $record = AuditRecord::versionCreated($version, $this->getUser());
+        $data = $version->toV2Array([]);
+        $record = AuditRecord::versionCreated($version, $data, $this->getUser());
         $this->getEM()->getRepository(AuditRecord::class)->insert($record);
     }
 

tests/Audit/VersionAuditRecordTest.php

@@ -15,6 +15,7 @@
 use App\Audit\AuditRecordType;
 use App\Entity\AuditRecord;
 use App\Entity\Package;
+use App\Entity\RequireLink;
 use App\Entity\Version;
 use Doctrine\DBAL\Connection;
 use Doctrine\Persistence\ManagerRegistry;
@@ -50,15 +51,14 @@ public function testVersionCreationGetsRecorded(): void
         ]);
 
         self::assertNotNull($log, 'No audit record created for new version');
-        self::assertSame('automation', $log->attributes['actor']);
         self::assertSame('composer', $log->vendor);
-        self::assertEqualsCanonicalizing([
-            'name' => 'composer/composer',
-            'actor' => 'automation',
-            'version' => '1.0.0',
-            'source' => 'source-ref',
-            'dist' => 'dist-ref',
-        ], $log->attributes);
+        $attributes = $log->attributes;
+        self::assertSame('composer/composer', $attributes['name']);
+        self::assertSame('automation', $attributes['actor']);
+        self::assertSame('1.0.0', $attributes['version']);
+        self::assertSame('dist-ref', $attributes['metadata']['dist']['reference']);
+        self::assertSame('source-ref', $attributes['metadata']['source']['reference']);
+        self::assertSame('^1.5.0', $attributes['metadata']['require']['composer/ca-bundle']);
     }
 
     public function testVersionChangesGetRecorded(): void
@@ -103,7 +103,7 @@ public function testVersionChangesGetRecorded(): void
         $logs = $container->get(Connection::class)->fetchAllAssociative('SELECT * FROM audit_log ORDER BY id DESC');
         self::assertCount(3, $logs);
 
-        $em->remove($version);
+        $em->getRepository(Version::class)->remove($version);
         $em->flush();
 
         $logs = $container->get(Connection::class)->fetchAllAssociative('SELECT * FROM audit_log ORDER BY id DESC');
@@ -117,6 +117,7 @@ private function createPackageAndVersion(): Version
         $em = $container->get(ManagerRegistry::class)->getManager();
 
         $package = new Package();
+        $package->setName('composer/composer');
         $package->setRepository('https://github.com/composer/composer');
 
         $version = new Version();
@@ -130,6 +131,13 @@ private function createPackageAndVersion(): Version
         $version->setDist(['reference' => 'dist-ref', 'type' => 'zip', 'url' => 'https://example.org/dist.zip']);
         $version->setSource(['reference' => 'source-ref', 'type' => 'git', 'url' => 'https://example.org/dist.git']);
 
+        $link = new RequireLink();
+        $link->setVersion($version);
+        $link->setPackageVersion('^1.5.0');
+        $link->setPackageName('composer/ca-bundle');
+        $version->addRequireLink($link);
+
+        $em->persist($link);
         $em->persist($package);
         $em->persist($version);
         $em->flush();