Add /audit-log route

Author: stevenrombauts

src/Controller/AuditLogController.php

@@ -0,0 +1,41 @@
+<?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\Controller;
+
+use App\Entity\AuditRecordRepository;
+use Pagerfanta\Doctrine\ORM\QueryAdapter;
+use Pagerfanta\Pagerfanta;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
+use Symfony\Component\Security\Http\Attribute\IsGranted;
+
+class AuditLogController extends Controller
+{
+    #[IsGranted('ROLE_USER')]
+    #[Route(path: '/audit-log', name: 'view_audit_logs')]
+    public function viewAuditLogs(Request $req, AuditRecordRepository $auditRecordRepository): Response
+    {
+        $query = $auditRecordRepository->createQueryBuilder('a')
+            ->orderBy('a.id', 'DESC');
+
+        $auditLogs = new Pagerfanta(new QueryAdapter($query, false));
+        $auditLogs->setNormalizeOutOfRangePages(true);
+        $auditLogs->setMaxPerPage(20);
+        $auditLogs->setCurrentPage(max(1, $req->query->getInt('page', 1)));
+
+        return $this->render('audit_log/view_audit_logs.html.twig', [
+            'auditLogs' => $auditLogs,
+        ]);
+    }
+}

templates/audit_log/view_audit_logs.html.twig

@@ -0,0 +1,38 @@
+{% extends "layout.html.twig" %}
+
+{% block title %}
+    Packagist - Audit Logs
+{% endblock %}
+
+{% block content %}
+    <h2 class="title">Audit Logs</h2>
+
+    {% if auditLogs|length %}
+        <table class="table table-striped">
+            <thead>
+                <tr>
+                    <th>Date & Time</th>
+                    <th>Type</th>
+                    <th>Vendor</th>
+                </tr>
+            </thead>
+            <tbody>
+                {% for log in auditLogs %}
+                    <tr>
+                        <td>{{ log.datetime|date('Y-m-d H:i:s') }} UTC</td>
+                        <td data-test="audit-log-type">{{ log.type.value }}</td>
+                        <td>{{ log.vendor ?? '-' }}</td>
+                    </tr>
+                {% endfor %}
+            </tbody>
+        </table>
+
+        {% if auditLogs.haveToPaginate() %}
+            {{ pagerfanta(auditLogs, 'twitter_bootstrap', {'proximity': 2}) }}
+        {% endif %}
+    {% else %}
+        <div class="alert alert-info">
+            <p>No audit logs found.</p>
+        </div>
+    {% endif %}
+{% endblock %}

tests/Controller/AuditLogControllerTest.php

@@ -0,0 +1,44 @@
+<?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\Tests\Controller;
+
+use App\Entity\AuditRecord;
+use App\Tests\IntegrationTestCase;
+
+class AuditLogControllerTest extends IntegrationTestCase
+{
+    public function testViewAuditLogs(): void
+    {
+        $user = self::createUser('testuser', '[email protected]', roles: ['ROLE_ADMIN']);
+        $package = self::createPackage('vendor1/package1', 'https://github.com/vendor1/package1', maintainers: [$user]);
+
+        $this->store($user, $package);
+
+        $auditLog1 = AuditRecord::canonicalUrlChange($package, $user, 'https://github.com/vendor1/package1-new');
+        $auditLog2 = AuditRecord::packageDeleted($package, $user);
+
+        $this->store($auditLog1, $auditLog2);
+
+        $this->client->loginUser($user);
+        $crawler = $this->client->request('GET', '/audit-log');
+        static::assertResponseIsSuccessful();
+
+        $rows = $crawler->filter('[data-test=audit-log-type]');
+        static::assertGreaterThanOrEqual(3, $rows->count(), 'Should have at least 3 audit log entries');
+        static::assertSame([
+            'package_deleted',
+            'canonical_url_change',
+            'package_created',
+        ], $rows->each(fn ($element) => trim($element->text())));
+    }
+}

tests/IntegrationTestCase.php

@@ -111,6 +111,7 @@ protected static function createUser(string $username = 'test', string $email =
         $user->setApiToken($apiToken);
         $user->setSafeApiToken($safeApiToken);
         $user->setGithubId($githubId);
+        $user->setRoles($roles);
 
         return $user;
     }