-
-
Notifications
You must be signed in to change notification settings - Fork 479
Log entry display #1608
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.
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
Open
IgorBenko
wants to merge
2
commits into
main
Choose a base branch
from
log-entry-display-factory
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Log entry display #1608
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| <?php declare(strict_types=1); | ||
|
|
||
| /* | ||
| * This file is part of Packagist. | ||
| * | ||
| * (c) Jordi Boggiano <j.boggiano@seld.be> | ||
| * Nils Adermann <naderman@naderman.de> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace App\Audit\Display; | ||
|
|
||
| use App\Audit\AuditRecordType; | ||
|
|
||
| abstract readonly class AbstractAuditLogDisplay implements AuditLogDisplayInterface | ||
| { | ||
| public function __construct( | ||
| public \DateTimeImmutable $datetime, | ||
| public ActorDisplay $actor, | ||
| ) { | ||
| } | ||
|
|
||
| abstract public function getType(): AuditRecordType; | ||
|
|
||
| public function getDateTime(): \DateTimeImmutable | ||
| { | ||
| return $this->datetime; | ||
| } | ||
|
|
||
| public function getActor(): ActorDisplay | ||
| { | ||
| return $this->actor; | ||
| } | ||
|
|
||
| public function getTypeTranslationKey(): string | ||
| { | ||
| return 'audit_log.type.' . $this->getType()->value; | ||
| } | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| <?php declare(strict_types=1); | ||
|
|
||
| /* | ||
| * This file is part of Packagist. | ||
| * | ||
| * (c) Jordi Boggiano <j.boggiano@seld.be> | ||
| * Nils Adermann <naderman@naderman.de> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace App\Audit\Display; | ||
|
|
||
| readonly class ActorDisplay | ||
| { | ||
| public function __construct( | ||
| public ?int $id, | ||
| public string $username, | ||
| ) { | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| <?php declare(strict_types=1); | ||
|
|
||
| /* | ||
| * This file is part of Packagist. | ||
| * | ||
| * (c) Jordi Boggiano <j.boggiano@seld.be> | ||
| * Nils Adermann <naderman@naderman.de> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace App\Audit\Display; | ||
|
|
||
| use App\Audit\AuditRecordType; | ||
| use App\Entity\AuditRecord; | ||
|
|
||
| class AuditLogDisplayFactory | ||
| { | ||
| /** | ||
| * @param iterable<AuditRecord> $auditRecords | ||
| * @return array<AuditLogDisplayInterface> | ||
| */ | ||
| public function build(iterable $auditRecords): array | ||
| { | ||
| $displays = []; | ||
| foreach ($auditRecords as $record) { | ||
| $displays[] = $this->buildSingle($record); | ||
| } | ||
|
|
||
| return $displays; | ||
| } | ||
|
|
||
| public function buildSingle(AuditRecord $record): AuditLogDisplayInterface | ||
| { | ||
| return match ($record->type) { | ||
| AuditRecordType::PackageCreated => new PackageCreatedDisplay( | ||
| $record->datetime, | ||
| $record->attributes['name'], | ||
| $record->attributes['repository'], | ||
| $this->buildActor($record->attributes['actor']), | ||
| ), | ||
| AuditRecordType::PackageDeleted => new PackageDeletedDisplay( | ||
| $record->datetime, | ||
| $record->attributes['name'], | ||
| $record->attributes['repository'], | ||
| $this->buildActor($record->attributes['actor']), | ||
| ), | ||
| AuditRecordType::CanonicalUrlChanged => new CanonicalUrlChangedDisplay( | ||
| $record->datetime, | ||
| $record->attributes['name'], | ||
| $record->attributes['repository_from'], | ||
| $record->attributes['repository_to'], | ||
| $this->buildActor($record->attributes['actor']), | ||
| ), | ||
| AuditRecordType::VersionDeleted => new VersionDeletedDisplay( | ||
| $record->datetime, | ||
| $record->attributes['name'], | ||
| $record->attributes['version'], | ||
| $this->buildActor($record->attributes['actor']), | ||
| ), | ||
| AuditRecordType::VersionReferenceChanged => new VersionReferenceChangedDisplay( | ||
| $record->datetime, | ||
| $record->attributes['name'], | ||
| $record->attributes['version'], | ||
| $record->attributes['source_from'] ?? null, | ||
| $record->attributes['source_to'] ?? null, | ||
| $record->attributes['dist_from'] ?? null, | ||
| $record->attributes['dist_to'] ?? null, | ||
| $this->buildActor($record->attributes['actor'] ?? null), | ||
| ), | ||
| default => throw new \LogicException(sprintf('Unsupported audit record type: %s', $record->type->value)), | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * @param array{id: int, username: string}|string|null $actor | ||
| */ | ||
| private function buildActor(array|string|null $actor): ActorDisplay | ||
| { | ||
| if ($actor === null) { | ||
| return new ActorDisplay(null, 'unknown'); | ||
| } | ||
|
|
||
| if (is_string($actor)) { | ||
| return new ActorDisplay(null, $actor); | ||
| } | ||
|
|
||
| return new ActorDisplay($actor['id'], $actor['username']); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| <?php declare(strict_types=1); | ||
|
|
||
| /* | ||
| * This file is part of Packagist. | ||
| * | ||
| * (c) Jordi Boggiano <j.boggiano@seld.be> | ||
| * Nils Adermann <naderman@naderman.de> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace App\Audit\Display; | ||
|
|
||
| use App\Audit\AuditRecordType; | ||
|
|
||
| interface AuditLogDisplayInterface | ||
| { | ||
| public function getType(): AuditRecordType; | ||
|
|
||
| public function getDateTime(): \DateTimeImmutable; | ||
|
|
||
| public function getActor(): ActorDisplay; | ||
|
|
||
| public function getTypeTranslationKey(): string; | ||
|
|
||
| public function getTemplateName(): string; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| <?php declare(strict_types=1); | ||
|
|
||
| /* | ||
| * This file is part of Packagist. | ||
| * | ||
| * (c) Jordi Boggiano <j.boggiano@seld.be> | ||
| * Nils Adermann <naderman@naderman.de> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace App\Audit\Display; | ||
|
|
||
| use App\Audit\AuditRecordType; | ||
|
|
||
| readonly class CanonicalUrlChangedDisplay extends AbstractAuditLogDisplay | ||
| { | ||
| public function __construct( | ||
| \DateTimeImmutable $datetime, | ||
| public string $packageName, | ||
| public string $repositoryFrom, | ||
| public string $repositoryTo, | ||
| ActorDisplay $actor, | ||
| ) { | ||
| parent::__construct($datetime, $actor); | ||
| } | ||
|
|
||
| public function getType(): AuditRecordType | ||
| { | ||
| return AuditRecordType::CanonicalUrlChanged; | ||
| } | ||
|
|
||
| public function getTemplateName(): string | ||
| { | ||
| return 'audit_log/display/canonical_url_changed.html.twig'; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| <?php declare(strict_types=1); | ||
|
|
||
| /* | ||
| * This file is part of Packagist. | ||
| * | ||
| * (c) Jordi Boggiano <j.boggiano@seld.be> | ||
| * Nils Adermann <naderman@naderman.de> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace App\Audit\Display; | ||
|
|
||
| use App\Audit\AuditRecordType; | ||
|
|
||
| readonly class PackageCreatedDisplay extends AbstractAuditLogDisplay | ||
| { | ||
| public function __construct( | ||
| \DateTimeImmutable $datetime, | ||
| public string $packageName, | ||
| public string $repository, | ||
| ActorDisplay $actor, | ||
| ) { | ||
| parent::__construct($datetime, $actor); | ||
| } | ||
|
|
||
| public function getType(): AuditRecordType | ||
| { | ||
| return AuditRecordType::PackageCreated; | ||
| } | ||
|
|
||
| public function getTemplateName(): string | ||
| { | ||
| return 'audit_log/display/package_created.html.twig'; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| <?php declare(strict_types=1); | ||
|
|
||
| /* | ||
| * This file is part of Packagist. | ||
| * | ||
| * (c) Jordi Boggiano <j.boggiano@seld.be> | ||
| * Nils Adermann <naderman@naderman.de> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace App\Audit\Display; | ||
|
|
||
| use App\Audit\AuditRecordType; | ||
|
|
||
| readonly class PackageDeletedDisplay extends AbstractAuditLogDisplay | ||
| { | ||
| public function __construct( | ||
| \DateTimeImmutable $datetime, | ||
| public string $packageName, | ||
| public string $repository, | ||
| ActorDisplay $actor, | ||
| ) { | ||
| parent::__construct($datetime, $actor); | ||
| } | ||
|
|
||
| public function getType(): AuditRecordType | ||
| { | ||
| return AuditRecordType::PackageDeleted; | ||
| } | ||
|
|
||
| public function getTemplateName(): string | ||
| { | ||
| return 'audit_log/display/package_deleted.html.twig'; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| <?php declare(strict_types=1); | ||
|
|
||
| /* | ||
| * This file is part of Packagist. | ||
| * | ||
| * (c) Jordi Boggiano <j.boggiano@seld.be> | ||
| * Nils Adermann <naderman@naderman.de> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace App\Audit\Display; | ||
|
|
||
| use App\Audit\AuditRecordType; | ||
|
|
||
| readonly class VersionDeletedDisplay extends AbstractAuditLogDisplay | ||
| { | ||
| public function __construct( | ||
| \DateTimeImmutable $datetime, | ||
| public string $packageName, | ||
| public string $version, | ||
| ActorDisplay $actor, | ||
| ) { | ||
| parent::__construct($datetime, $actor); | ||
| } | ||
|
|
||
| public function getType(): AuditRecordType | ||
| { | ||
| return AuditRecordType::VersionDeleted; | ||
| } | ||
|
|
||
| public function getTemplateName(): string | ||
| { | ||
| return 'audit_log/display/version_deleted.html.twig'; | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
instead of returning a translation key, I suggest returning a
TranslatableInterface(probably using theTranslatableMessageimplementation available in core in each case).The benefits are:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think placeholders aren't really needed here as the types are just fixed strings, and translation key extraction is also kinda useless for this app where we don't really use translations much so we don't have hundreds of keys that are easy to lose track of.. Is there really a point then in changing this?