Skip to content

Commit 3101c09

Browse files
wouter-toppywouter-toppy
committed
Add extra fields and indices to audit tables, based on configuration DamienHarper#61 
1 parent a40416e commit 3101c09

File tree

8 files changed

+165
-80
lines changed

8 files changed

+165
-80
lines changed

‎src/Model/Transaction.php

-19
Original file line numberDiff line numberDiff line change
@@ -15,29 +15,10 @@
1515
*/
1616
class Transaction implements TransactionInterface
1717
{
18-
/**
19-
* @var string
20-
*/
2118
public const INSERT = 'insert';
22-
23-
/**
24-
* @var string
25-
*/
2619
public const UPDATE = 'update';
27-
28-
/**
29-
* @var string
30-
*/
3120
public const REMOVE = 'remove';
32-
33-
/**
34-
* @var string
35-
*/
3621
public const ASSOCIATE = 'associate';
37-
38-
/**
39-
* @var string
40-
*/
4122
public const DISSOCIATE = 'dissociate';
4223

4324
private ?string $transaction_hash = null;

‎src/Provider/Doctrine/Auditing/Transaction/AuditTrait.php

+23
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
use Doctrine\DBAL\Types\Type;
1111
use Doctrine\ORM\EntityManagerInterface;
1212
use Doctrine\ORM\Mapping\MappingException as ORMMappingException;
13+
use Symfony\Component\PropertyAccess\PropertyAccess;
1314
use Throwable;
1415
use UnitEnum;
1516

@@ -125,6 +126,28 @@ private function value(EntityManagerInterface $entityManager, Type $type, mixed
125126
return $convertedValue;
126127
}
127128

129+
/**
130+
* Returns the extra fields if set.
131+
*/
132+
private function extraFields(object $entity): array
133+
{
134+
$configuration = $this->provider->getConfiguration();
135+
$extraFieldProperties = array_keys($configuration->getExtraFields());
136+
$propertyAccessor = PropertyAccess::createPropertyAccessor();
137+
138+
$extraFields = [];
139+
140+
foreach ($extraFieldProperties as $extraField) {
141+
if (!$propertyAccessor->isReadable($entity, $extraField)) {
142+
continue;
143+
}
144+
145+
$extraFields[$extraField] = $propertyAccessor->getValue($entity, $extraField);
146+
}
147+
148+
return $extraFields;
149+
}
150+
128151
/**
129152
* Computes a usable diff.
130153
*

‎src/Provider/Doctrine/Auditing/Transaction/TransactionProcessor.php

+5
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ private function insert(EntityManagerInterface $entityManager, object $entity, a
5959
'action' => 'insert',
6060
'blame' => $this->blame(),
6161
'diff' => $this->diff($entityManager, $entity, $ch),
62+
'extra_fields' => $this->extraFields($entity),
6263
'table' => $meta->getTableName(),
6364
'schema' => $meta->getSchemaName(),
6465
'id' => $this->id($entityManager, $entity),
@@ -85,6 +86,7 @@ private function update(EntityManagerInterface $entityManager, object $entity, a
8586
'action' => 'update',
8687
'blame' => $this->blame(),
8788
'diff' => $diff,
89+
'extra_fields' => $this->extraFields($entity),
8890
'table' => $meta->getTableName(),
8991
'schema' => $meta->getSchemaName(),
9092
'id' => $this->id($entityManager, $entity),
@@ -104,6 +106,7 @@ private function remove(EntityManagerInterface $entityManager, object $entity, m
104106
'action' => 'remove',
105107
'blame' => $this->blame(),
106108
'diff' => $this->summarize($entityManager, $entity, ['id' => $id]),
109+
'extra_fields' => $this->extraFields($entity),
107110
'table' => $meta->getTableName(),
108111
'schema' => $meta->getSchemaName(),
109112
'id' => $id,
@@ -184,6 +187,7 @@ private function associateOrDissociate(string $type, EntityManagerInterface $ent
184187
'target' => $this->summarize($entityManager, $target, ['field' => $mapping['isOwningSide'] ? $mapping['inversedBy'] : $mapping['mappedBy']]),
185188
'is_owning_side' => $mapping['isOwningSide'],
186189
],
190+
'extra_fields' => $this->extraFields($source),
187191
'table' => $meta->getTableName(),
188192
'schema' => $meta->getSchemaName(),
189193
'id' => $this->id($entityManager, $source),
@@ -221,6 +225,7 @@ private function audit(array $data): void
221225
'discriminator' => $data['discriminator'],
222226
'transaction_hash' => (string) $data['transaction_hash'],
223227
'diffs' => json_encode($diff, JSON_THROW_ON_ERROR),
228+
...$data['extra_fields'] ?? [],
224229
'blame_id' => $data['blame']['user_id'],
225230
'blame_user' => $data['blame']['username'],
226231
'blame_user_fqdn' => $data['blame']['user_fqdn'],

‎src/Provider/Doctrine/Configuration.php

+83-4
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
use DH\Auditor\Provider\ConfigurationInterface;
88
use DH\Auditor\Provider\Doctrine\Persistence\Helper\DoctrineHelper;
9+
use DH\Auditor\Provider\Doctrine\Persistence\Helper\SchemaHelper;
910
use DH\Auditor\Provider\Doctrine\Persistence\Schema\SchemaManager;
1011
use DH\Auditor\Provider\Doctrine\Service\AuditingService;
1112
use Symfony\Component\OptionsResolver\OptionsResolver;
@@ -21,13 +22,14 @@ final class Configuration implements ConfigurationInterface
2122

2223
private string $tableSuffix;
2324

24-
/**
25-
* @var array<string>
26-
*/
27-
private array $ignoredColumns = [];
25+
private array $ignoredColumns;
2826

2927
private ?array $entities = null;
3028

29+
private array $extraFields = [];
30+
31+
private array $extraIndices = [];
32+
3133
private array $storageServices = [];
3234

3335
private array $auditingServices = [];
@@ -60,6 +62,20 @@ public function __construct(array $options)
6062
}
6163
}
6264

65+
if (isset($config['extra_fields']) && !empty($config['extra_fields'])) {
66+
// use field names as array keys for easier lookup
67+
foreach ($config['extra_fields'] as $fieldName => $fieldOptions) {
68+
$this->extraFields[$fieldName] = $fieldOptions;
69+
}
70+
}
71+
72+
if (isset($config['extra_indices']) && !empty($config['extra_indices'])) {
73+
// use index names as array keys for easier lookup
74+
foreach ($config['extra_indices'] as $indexName => $indexOptions) {
75+
$this->extraIndices[$indexName] = $indexOptions;
76+
}
77+
}
78+
6379
$this->storageServices = $config['storage_services'];
6480
$this->auditingServices = $config['auditing_services'];
6581
$this->isViewerEnabled = $config['viewer'];
@@ -191,6 +207,65 @@ public function getEntities(): array
191207
return $this->entities ?? [];
192208
}
193209

210+
public function getExtraFields(): array
211+
{
212+
return $this->extraFields;
213+
}
214+
215+
public function getAllFields(): array
216+
{
217+
return array_merge(
218+
SchemaHelper::getAuditTableColumns(),
219+
$this->extraFields
220+
);
221+
}
222+
223+
/**
224+
* @param array<string, mixed> $extraFields
225+
*/
226+
public function setExtraFields(array $extraFields): self
227+
{
228+
$this->extraFields = $extraFields;
229+
230+
return $this;
231+
}
232+
233+
public function getExtraIndices(): array
234+
{
235+
return $this->extraIndices;
236+
}
237+
238+
public function prepareExtraIndices(string $tablename): array
239+
{
240+
$indices = [];
241+
foreach ($this->extraIndices as $extraIndexField => $extraIndexOptions) {
242+
$indices[$extraIndexField] = [
243+
'type' => $extraIndexOptions['type'] ?? 'index',
244+
'name' => sprintf('%s_%s_idx', $extraIndexOptions['name_prefix'] ?? $extraIndexField, md5($tablename)),
245+
];
246+
}
247+
248+
return $indices;
249+
}
250+
251+
public function getAllIndices(string $tablename): array
252+
{
253+
return array_merge(
254+
SchemaHelper::getAuditTableIndices($tablename),
255+
$this->prepareExtraIndices($tablename)
256+
);
257+
}
258+
259+
/**
260+
* @param array<string, mixed> $extraIndices
261+
*/
262+
public function setExtraIndices(array $extraIndices): self
263+
{
264+
$this->extraIndices = $extraIndices;
265+
266+
return $this;
267+
}
268+
194269
/**
195270
* Enables auditing for a specific entity.
196271
*
@@ -258,6 +333,8 @@ private function configureOptions(OptionsResolver $resolver): void
258333
'table_suffix' => '_audit',
259334
'ignored_columns' => [],
260335
'entities' => [],
336+
'extra_fields' => [],
337+
'extra_indices' => [],
261338
'storage_services' => [],
262339
'auditing_services' => [],
263340
'viewer' => true,
@@ -267,6 +344,8 @@ private function configureOptions(OptionsResolver $resolver): void
267344
->setAllowedTypes('table_suffix', 'string')
268345
->setAllowedTypes('ignored_columns', 'array')
269346
->setAllowedTypes('entities', 'array')
347+
->setAllowedTypes('extra_fields', 'array')
348+
->setAllowedTypes('extra_indices', 'array')
270349
->setAllowedTypes('storage_services', 'array')
271350
->setAllowedTypes('auditing_services', 'array')
272351
->setAllowedTypes('viewer', 'bool')

‎src/Provider/Doctrine/DoctrineProvider.php

+5-19
Original file line numberDiff line numberDiff line change
@@ -29,23 +29,6 @@
2929
*/
3030
final class DoctrineProvider extends AbstractProvider
3131
{
32-
/**
33-
* @var array<string, string>
34-
*/
35-
private const FIELDS = [
36-
'type' => ':type',
37-
'object_id' => ':object_id',
38-
'discriminator' => ':discriminator',
39-
'transaction_hash' => ':transaction_hash',
40-
'diffs' => ':diffs',
41-
'blame_id' => ':blame_id',
42-
'blame_user' => ':blame_user',
43-
'blame_user_fqdn' => ':blame_user_fqdn',
44-
'blame_user_firewall' => ':blame_user_firewall',
45-
'ip' => ':ip',
46-
'created_at' => ':created_at',
47-
];
48-
4932
private TransactionManager $transactionManager;
5033

5134
public function __construct(ConfigurationInterface $configuration)
@@ -126,11 +109,14 @@ public function persist(LifecycleEvent $event): void
126109
$entity = $payload['entity'];
127110
unset($payload['table'], $payload['entity']);
128111

112+
$fields = array_combine(array_keys($payload), array_map(function ($x) {return ":{$x}"; }, array_keys($payload)));
113+
\assert(\is_array($fields)); // helps PHPStan
114+
129115
$query = sprintf(
130116
'INSERT INTO %s (%s) VALUES (%s)',
131117
$auditTable,
132-
implode(', ', array_keys(self::FIELDS)),
133-
implode(', ', array_values(self::FIELDS))
118+
implode(', ', array_keys($fields)),
119+
implode(', ', array_values($fields))
134120
);
135121

136122
/** @var StorageService $storageService */

‎src/Provider/Doctrine/Persistence/Reader/Query.php

+7-32
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
use DateTimeZone;
99
use DH\Auditor\Exception\InvalidArgumentException;
1010
use DH\Auditor\Model\Entry;
11-
use DH\Auditor\Provider\Doctrine\Persistence\Helper\SchemaHelper;
11+
use DH\Auditor\Provider\ConfigurationInterface;
12+
use DH\Auditor\Provider\Doctrine\Configuration;
1213
use DH\Auditor\Provider\Doctrine\Persistence\Reader\Filter\DateRangeFilter;
1314
use DH\Auditor\Provider\Doctrine\Persistence\Reader\Filter\FilterInterface;
1415
use DH\Auditor\Provider\Doctrine\Persistence\Reader\Filter\RangeFilter;
@@ -23,39 +24,12 @@
2324
*/
2425
final class Query
2526
{
26-
/**
27-
* @var string
28-
*/
2927
public const TYPE = 'type';
30-
31-
/**
32-
* @var string
33-
*/
3428
public const CREATED_AT = 'created_at';
35-
36-
/**
37-
* @var string
38-
*/
3929
public const TRANSACTION_HASH = 'transaction_hash';
40-
41-
/**
42-
* @var string
43-
*/
4430
public const OBJECT_ID = 'object_id';
45-
46-
/**
47-
* @var string
48-
*/
4931
public const USER_ID = 'blame_id';
50-
51-
/**
52-
* @var string
53-
*/
5432
public const ID = 'id';
55-
56-
/**
57-
* @var string
58-
*/
5933
public const DISCRIMINATOR = 'discriminator';
6034

6135
private array $filters = [];
@@ -66,16 +40,17 @@ final class Query
6640

6741
private string $table;
6842

43+
private Configuration $configuration;
44+
6945
private int $offset = 0;
7046

7147
private int $limit = 0;
7248

73-
private DateTimeZone $timezone;
74-
75-
public function __construct(string $table, Connection $connection, string $timezone)
49+
public function __construct(string $table, Connection $connection, ConfigurationInterface $configuration, string $timezone)
7650
{
7751
$this->connection = $connection;
7852
$this->table = $table;
53+
$this->configuration = $configuration;
7954
$this->timezone = new DateTimeZone($timezone);
8055

8156
foreach ($this->getSupportedFilters() as $filterType) {
@@ -169,7 +144,7 @@ public function limit(int $limit, int $offset = 0): self
169144

170145
public function getSupportedFilters(): array
171146
{
172-
return array_keys(SchemaHelper::getAuditTableIndices('fake'));
147+
return array_keys($this->configuration->getAllIndices('fake'));
173148
}
174149

175150
public function getFilters(): array

0 commit comments

Comments
 (0)