Skip to content

feat: optional flarum/audit integration #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
imorland merged 5 commits into from
Jul 8, 2026
Merged

feat: optional flarum/audit integration #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a17b103
feat: optional flarum/audit integration
imorland Jul 8, 2026
5d4e756
test: fix audit test seeding/ordering
imorland Jul 8, 2026
0cf6766
test: use 2.x API payloads and order-independent assertions
imorland Jul 8, 2026
25381f1
test: don't assert absence of core username_changed log
imorland Jul 8, 2026
b682bab
chore: track flarum/audit 2.x-dev
imorland Jul 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
}
},
"require-dev": {
"flarum/audit": "2.x-dev",
"flarum/nicknames": "^2.0.0",
"flarum/phpstan": "^2.0.0",
"flarum/testing": "^2.0.0"
Expand Down
8 changes: 8 additions & 0 deletions extend.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
use Flarum\Extend;
use Flarum\User\User;
use FoF\UserRequest\Api\Resource\UsernameRequestResource;
use FoF\UserRequest\Audit\UsernameRequestIntegration;

return [
(new Extend\Frontend('forum'))
Expand Down Expand Up @@ -64,4 +65,11 @@

(new Extend\View())
->namespace('fof-username-request', __DIR__.'/resources/views'),

(new Extend\Conditional())
->whenExtensionEnabled('flarum-audit', fn () => [
(new \Flarum\Audit\Extend\Audit())
->group('fof-username-request')
->using(new UsernameRequestIntegration()),
]),
];
14 changes: 14 additions & 0 deletions resources/locale/en.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,3 +102,17 @@ fof-username-request:
subject:
approved: "{display_name} approved your username change to {requested_username}"
rejected: "{display_name} rejected your username change to {requested_username}"

# Labels for the audit log entries this extension produces, rendered by the (optional)
# flarum/audit browser. Defined under the flarum-audit namespace so the audit frontend
# resolves them, but shipped here so they travel with the extension that owns the actions.
flarum-audit:
lib:
browser:
user:
nickname_requested: Requested new nickname {new_nickname} for user {username}
nickname_request_approved: Approved {username}'s nickname change from {old_nickname} to {new_nickname}
nickname_request_rejected: Rejected {username}'s nickname change
username_requested: Requested new username {new_username} for user {username}
username_request_approved: Approved {username}'s username change from {old_username} to {new_username}
username_request_rejected: Rejected {username}'s username change
107 changes: 107 additions & 0 deletions src/Audit/UsernameRequestIntegration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
<?php

/*
* This file is part of fof/username-request.
*
* Copyright (c) FriendsOfFlarum.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace FoF\UserRequest\Audit;

use Flarum\Audit\AuditLogger;
use Flarum\User\User;
use FoF\UserRequest\UsernameRequest;
use Illuminate\Contracts\Container\Container;
use Illuminate\Contracts\Events\Dispatcher;

/**
* fof/username-request integration for the optional flarum/audit extension.
*
* Stateful: captures the old username/nickname on user update and reacts to the request
* lifecycle. Wired through the audit extender's `using()` escape hatch.
*/
class UsernameRequestIntegration
{
/**
* @var string[]
*/
public static $actions = [
'user.nickname_requested',
'user.nickname_request_approved',
'user.nickname_request_rejected',
'user.username_requested',
'user.username_request_approved',
'user.username_request_rejected',
];

protected ?string $oldNickname = null;
protected ?string $oldUsername = null;

public function __invoke(Container $container): void
{
// Listen on the events dispatcher rather than the static Model::event(Closure) API, so the
// listeners aren't bound to the model classes' static dispatcher.
$events = $container->make(Dispatcher::class);

$events->listen('eloquent.updated: '.User::class, [$this, 'userUpdated']);
$events->listen('eloquent.saved: '.UsernameRequest::class, [$this, 'requestSaved']);
}

public function userUpdated(User $user): void
{
$this->oldNickname = $user->getOriginal('nickname');
$this->oldUsername = $user->getOriginal('username');
}

public function requestSaved(UsernameRequest $request): void
{
switch ($request->status) {
case 'Sent':
if ($request->for_nickname) {
AuditLogger::log('user.nickname_requested', [
'user_id' => $request->user_id,
'new_nickname' => $request->requested_username ?: null,
]);
} else {
AuditLogger::log('user.username_requested', [
'user_id' => $request->user_id,
'new_username' => $request->requested_username,
]);
}
break;
case 'Approved':
if ($request->for_nickname) {
AuditLogger::log('user.nickname_request_approved', [
'user_id' => $request->user_id,
'old_nickname' => $this->oldNickname ?: null,
'new_nickname' => $request->requested_username ?: null,
]);
} else {
AuditLogger::log('user.username_request_approved', [
'user_id' => $request->user_id,
'old_username' => $this->oldUsername,
'new_username' => $request->requested_username,
]);
}
break;
case 'Rejected':
if ($request->for_nickname) {
AuditLogger::log('user.nickname_request_rejected', [
'user_id' => $request->user_id,
'new_nickname' => $request->requested_username ?: null,
'reason' => $request->reason,
]);
} else {
AuditLogger::log('user.username_request_rejected', [
'user_id' => $request->user_id,
'new_username' => $request->requested_username,
'reason' => $request->reason,
]);
}
break;
}
}
}
229 changes: 229 additions & 0 deletions tests/integration/AuditTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,229 @@
<?php

/*
* This file is part of fof/username-request.
*
* Copyright (c) FriendsOfFlarum.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace FoF\UserRequest\Tests\integration;

use Flarum\Audit\AuditLog;
use Flarum\Audit\AuditLogger;
use Flarum\Testing\integration\RetrievesAuthorizedUsers;
use Flarum\Testing\integration\TestCase;
use Flarum\User\User;
use PHPUnit\Framework\Attributes\Test;

class AuditTest extends TestCase
{
use RetrievesAuthorizedUsers;

protected function setUp(): void
{
parent::setUp();

// Lifecycle events fired outside the test transaction shouldn't create stray entries.
AuditLogger::$testMode = true;

$this->extension('flarum-audit', 'fof-username-request', 'flarum-nicknames');

$this->prepareDatabase([
'audit_log' => [],
User::class => [
[
'id' => 3,
'username' => 'user3',
'email' => 'user3@example.com',
],
],
'username_requests' => [
['id' => 1, 'user_id' => 3, 'requested_username' => 'user33', 'status' => 'Sent', 'created_at' => '2021-01-01 00:00:00'],
['id' => 2, 'user_id' => 3, 'requested_username' => 'user33', 'status' => 'Sent', 'for_nickname' => true, 'created_at' => '2021-01-01 00:00:00'],
],
]);
}

#[Test]
public function createUsername()
{
$response = $this->send($this->request('POST', '/api/username-requests', [
'authenticatedAs' => 1,
'json' => [
'data' => [
'type' => 'username-requests',
'attributes' => [
'requestedUsername' => 'admin2',
'forNickname' => false,
],
],
'meta' => [
'password' => 'password',
],
],
]));

$this->assertEquals(201, $response->getStatusCode(), $response->getBody()->getContents());

$log = AuditLog::query()->where('action', 'user.username_requested')->first();
$this->assertNotNull($log);
$this->assertEquals(1, $log->actor_id);
$this->assertEquals([
'user_id' => 1,
'new_username' => 'admin2',
], $log->payload);
$this->assertEquals('127.0.0.1', $log->ip_address);
}

#[Test]
public function createNickname()
{
$response = $this->send($this->request('POST', '/api/username-requests', [
'authenticatedAs' => 1,
'json' => [
'data' => [
'type' => 'username-requests',
'attributes' => [
'requestedUsername' => 'admin2',
'forNickname' => true,
],
],
'meta' => [
'password' => 'password',
],
],
]));

$this->assertEquals(201, $response->getStatusCode(), $response->getBody()->getContents());

$log = AuditLog::query()->where('action', 'user.nickname_requested')->first();
$this->assertNotNull($log);
$this->assertEquals(1, $log->actor_id);
$this->assertEquals([
'user_id' => 1,
'new_nickname' => 'admin2',
], $log->payload);
$this->assertEquals('127.0.0.1', $log->ip_address);
}

#[Test]
public function approveUsername()
{
$response = $this->send($this->request('PATCH', '/api/username-requests/1', [
'authenticatedAs' => 1,
'json' => [
'data' => [
'type' => 'username-requests',
'id' => '1',
'attributes' => [
'status' => 'Approved',
],
],
],
]));

$this->assertEquals(200, $response->getStatusCode(), $response->getBody()->getContents());

$log = AuditLog::query()->where('action', 'user.username_request_approved')->first();
$this->assertNotNull($log);
$this->assertEquals(1, $log->actor_id);
$this->assertEquals([
'user_id' => 3,
'old_username' => 'user3',
'new_username' => 'user33',
], $log->payload);
$this->assertEquals('127.0.0.1', $log->ip_address);
}

#[Test]
public function approveNickname()
{
$response = $this->send($this->request('PATCH', '/api/username-requests/2', [
'authenticatedAs' => 1,
'json' => [
'data' => [
'type' => 'username-requests',
'id' => '2',
'attributes' => [
'status' => 'Approved',
],
],
],
]));

$this->assertEquals(200, $response->getStatusCode(), $response->getBody()->getContents());

$log = AuditLog::query()->where('action', 'user.nickname_request_approved')->first();
$this->assertNotNull($log);
$this->assertEquals(1, $log->actor_id);
$this->assertEquals([
'user_id' => 3,
'old_nickname' => null,
'new_nickname' => 'user33',
], $log->payload);
$this->assertEquals('127.0.0.1', $log->ip_address);
}

#[Test]
public function rejectUsername()
{
$response = $this->send($this->request('PATCH', '/api/username-requests/1', [
'authenticatedAs' => 1,
'json' => [
'data' => [
'type' => 'username-requests',
'id' => '1',
'attributes' => [
'status' => 'Rejected',
'reason' => 'because',
],
],
],
]));

$this->assertEquals(200, $response->getStatusCode(), $response->getBody()->getContents());

$log = AuditLog::query()->where('action', 'user.username_request_rejected')->first();
$this->assertNotNull($log);
$this->assertEquals(1, $log->actor_id);
$this->assertEquals([
'user_id' => 3,
'new_username' => 'user33',
'reason' => 'because',
], $log->payload);
$this->assertEquals('127.0.0.1', $log->ip_address);
}

#[Test]
public function rejectNickname()
{
$response = $this->send($this->request('PATCH', '/api/username-requests/2', [
'authenticatedAs' => 1,
'json' => [
'data' => [
'type' => 'username-requests',
'id' => '2',
'attributes' => [
'status' => 'Rejected',
'reason' => 'because',
],
],
],
]));

$this->assertEquals(200, $response->getStatusCode(), $response->getBody()->getContents());

$log = AuditLog::query()->where('action', 'user.nickname_request_rejected')->first();
$this->assertNotNull($log);
$this->assertEquals(1, $log->actor_id);
$this->assertEquals([
'user_id' => 3,
'new_nickname' => 'user33',
'reason' => 'because',
], $log->payload);
$this->assertEquals('127.0.0.1', $log->ip_address);
}
}
Loading