Store dist/source reference of the created version

Author: stevenrombauts

src/Audit/Display/AuditLogDisplayFactory.php

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

src/Audit/Display/VersionCreatedDisplay.php

@@ -20,6 +20,8 @@ public function __construct(
         \DateTimeImmutable $datetime,
         public string $packageName,
         public string $version,
+        public ?string $sourceReference,
+        public ?string $distReference,
         ActorDisplay $actor,
     ) {
         parent::__construct($datetime, $actor);
@@ -34,4 +36,4 @@ public function getTemplateName(): string
     {
         return 'audit_log/display/version_created.html.twig';
     }
-}
+}

src/Entity/AuditRecord.php

@@ -84,7 +84,7 @@ public static function versionCreated(Version $version, ?User $actor): self
     {
         $package = $version->getPackage();
 
-        return new self(AuditRecordType::VersionCreated, ['name' => $package->getName(), 'version' => $version->getVersion(), 'actor' => self::getUserData($actor, 'automation')], $actor?->getId(), $package->getVendor(), $package->getId());
+        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());
     }
 
     public static function versionDeleted(Version $version, ?User $actor): self

templates/audit_log/display/version_created.html.twig

@@ -5,4 +5,10 @@
         {{ display.packageName }}
     {%- endif -%}
 </strong> {{ display.version }}<br>
+{% if display.sourceReference %}
+    Source: {{ display.sourceReference }}<br>
+{% endif %}
+{% if display.distReference %}
+    Dist: {{ display.distReference }}<br>
+{% endif %}
 Created by: {{ display.actor.username }}

tests/Audit/VersionAuditRecordTest.php

@@ -56,6 +56,8 @@ public function testVersionCreationGetsRecorded(): void
             'name' => 'composer/composer',
             'actor' => 'automation',
             'version' => '1.0.0',
+            'source' => 'source-ref',
+            'dist' => 'dist-ref',
         ], $log->attributes);
     }
 
@@ -74,7 +76,7 @@ public function testVersionChangesGetRecorded(): void
         $logs = $container->get(Connection::class)->fetchAllAssociative('SELECT * FROM audit_log ORDER BY id DESC');
         self::assertCount(3, $logs); // package creation + version creation + version reference change
         self::assertSame(AuditRecordType::VersionReferenceChanged->value, $logs[0]['type']);
-        self::assertSame('{"name": "composer/composer", "dist_to": "new-dist-ref", "version": "1.0.0", "dist_from": "old-dist-ref", "source_to": "new-source-ref", "source_from": null}', $logs[0]['attributes']);
+        self::assertSame('{"name": "composer/composer", "dist_to": "new-dist-ref", "version": "1.0.0", "dist_from": "dist-ref", "source_to": "new-source-ref", "source_from": "source-ref"}', $logs[0]['attributes']);
 
         // verify that unrelated changes do not create new audit logs
         $version->setLicense(['MIT']);
@@ -125,7 +127,8 @@ private function createPackageAndVersion(): Version
         $version->setDevelopment(false);
         $version->setLicense([]);
         $version->setAutoload([]);
-        $version->setDist(['reference' => 'old-dist-ref', 'type' => 'zip', 'url' => 'https://example.org/dist.zip']);
+        $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']);
 
         $em->persist($package);
         $em->persist($version);