Change audit record types to use consistent past-tense pattern (#1598)

Co-authored-by: Jordi Boggiano <[email protected]>

Author: IgorBenko

src/Audit/AuditRecordType.php

@@ -15,27 +15,28 @@
 enum AuditRecordType: string
 {
     // package ownership
-    case AddMaintainer = 'add_maintainer'; // TODO
-    case RemoveMaintainer = 'remove_maintainer'; // TODO
-    case TransferPackage = 'transfer_package'; // TODO
+    case MaintainerAdded = 'maintainer_added'; // TODO
+    case MaintainerRemoved = 'maintainer_removed'; // TODO
+    case PackageTransferred = 'package_transferred'; // TODO
 
     // package management
     case PackageCreated = 'package_created';
     case PackageDeleted = 'package_deleted';
-    case CanonicalUrlChange = 'canonical_url_change';
+    case CanonicalUrlChanged = 'canonical_url_changed';
     case VersionDeleted = 'version_deleted';
-    case VersionReferenceChange = 'version_reference_change';
+
+    case VersionReferenceChanged = 'version_reference_changed';
     case PackageAbandoned = 'package_abandoned'; // TODO
     case PackageUnabandoned = 'package_unabandoned'; // TODO
 
     // user management
     case UserCreated = 'user_created'; // TODO
     case UserDeleted = 'user_deleted'; // TODO
-    case PasswordResetRequest = 'password_reset_request'; // TODO
+    case PasswordResetRequested = 'password_reset_requested'; // TODO
     case PasswordReset = 'password_reset'; // TODO
-    case PasswordChange = 'password_change'; // TODO
-    case EmailChange = 'email_change'; // TODO
-    case UsernameChange = 'username_change'; // TODO
+    case PasswordChanged = 'password_changed'; // TODO
+    case EmailChanged = 'email_changed'; // TODO
+    case UsernameChanged = 'username_changed'; // TODO
     case GitHubLinkedWithUser = 'github_linked_with_user'; // TODO
     case GitHubDisconnectedFromUser = 'github_disconnected_from_user'; // TODO
     case TwoFaActivated = 'two_fa_activated'; // TODO

src/Command/MigrateAuditRecordTypesCommand.php

@@ -0,0 +1,78 @@
+<?php declare(strict_types=1);
+
+/*
+ * This file is part of Packagist.
+ *
+ * (c) Jordi Boggiano <[email protected]>
+ *     Nils Adermann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Command;
+
+use App\Util\DoctrineTrait;
+use Doctrine\Persistence\ManagerRegistry;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class MigrateAuditRecordTypesCommand extends Command
+{
+    use DoctrineTrait;
+
+    private const array TYPE_MAPPING = [
+        'canonical_url_change' => 'canonical_url_changed',
+        'version_reference_change' => 'version_reference_changed',
+    ];
+
+    public function __construct(
+        private readonly ManagerRegistry $doctrine,
+    ) {
+        parent::__construct();
+    }
+
+    protected function configure(): void
+    {
+        $this
+            ->setName('packagist:migrate-audit-record-types')
+            ->setDescription('Migrate audit record type values to new naming convention')
+            ->setDefinition([
+            ])
+        ;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $connection = $this->getEM()->getConnection();
+
+        $totalUpdated = 0;
+
+        foreach (self::TYPE_MAPPING as $oldType => $newType) {
+            $output->writeln("Migrating '$oldType' to '$newType'...");
+
+            try {
+                $updatedRows = $connection->executeStatement(
+                    'UPDATE audit_log SET type = ? WHERE type = ?',
+                    [$newType, $oldType]
+                );
+
+                $totalUpdated += $updatedRows;
+
+                if ($updatedRows === 0) {
+                    $output->writeln("  No records found for type '$oldType'");
+                } else {
+                    $output->writeln("  Updated $updatedRows records");
+                }
+            } catch (\Exception $e) {
+                $output->writeln("<error>Failed to update records for type '$oldType': {$e->getMessage()}</error>");
+                return Command::FAILURE;
+            }
+        }
+
+        $output->writeln("<info>Migration completed successfully. Total records updated: {$totalUpdated}</info>");
+
+        return Command::SUCCESS;
+    }
+}

src/Entity/AuditRecord.php

@@ -62,7 +62,7 @@ public static function packageDeleted(Package $package, ?User $actor): self
 
     public static function canonicalUrlChange(Package $package, ?User $actor, string $oldRepository): self
     {
-        return new self(AuditRecordType::CanonicalUrlChange, ['name' => $package->getName(), 'repository_from' => $oldRepository, 'repository_to' => $package->getRepository(), 'actor' => self::getUserData($actor)], $actor?->getId(), $package->getVendor(), $package->getId());
+        return new self(AuditRecordType::CanonicalUrlChanged, ['name' => $package->getName(), 'repository_from' => $oldRepository, 'repository_to' => $package->getRepository(), 'actor' => self::getUserData($actor)], $actor?->getId(), $package->getVendor(), $package->getId());
     }
 
     public static function versionDeleted(Version $version, ?User $actor): self
@@ -77,7 +77,7 @@ public static function versionReferenceChange(Version $version, ?string $oldSour
         $package = $version->getPackage();
 
         return new self(
-            AuditRecordType::VersionReferenceChange,
+            AuditRecordType::VersionReferenceChanged,
             ['name' => $package->getName(), 'version' => $version->getVersion(), 'source_from' => $oldSourceReference, 'source_to' => $version->getSource()['reference'] ?? null, 'dist_from' => $oldDistReference, 'dist_to' => $version->getDist()['reference'] ?? null],
             vendor: $package->getVendor(),
             packageId: $package->getId()

tests/Audit/PackageAuditRecordTest.php

@@ -56,7 +56,7 @@ public function testPackageChangesGetRecorded(): void
 
         $logs = $container->get(Connection::class)->fetchAllAssociative('SELECT * FROM audit_log ORDER BY id DESC');
         self::assertCount(2, $logs);
-        self::assertSame(AuditRecordType::CanonicalUrlChange->value, $logs[0]['type']);
+        self::assertSame(AuditRecordType::CanonicalUrlChanged->value, $logs[0]['type']);
         self::assertSame('{"name": "composer/composer", "actor": "unknown", "repository_to": "https://github.com/composer/packagist", "repository_from": "https://github.com/composer/composer"}', $logs[0]['attributes']);
 
         $em->remove($package);

tests/Audit/VersionAuditRecordTest.php

@@ -65,7 +65,7 @@ public function testVersionChangesGetRecorded(): void
 
         $logs = $container->get(Connection::class)->fetchAllAssociative('SELECT * FROM audit_log ORDER BY id DESC');
         self::assertCount(2, $logs); // package creation + version reference change
-        self::assertSame(AuditRecordType::VersionReferenceChange->value, $logs[0]['type']);
+        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']);
 
         // verify that unrelated changes do not create new audit logs