Cleanup (#136)

DamienHarper · Dec 2, 2022 · 47fe00c · 47fe00c
1 parent 6748f87
commit 47fe00c
Show file tree

Hide file tree

Showing 15 changed files with 50 additions and 265 deletions.
diff --git a/src/Model/Transaction.php b/src/Model/Transaction.php
@@ -129,50 +129,6 @@ public function reset(): void
         $this->dissociated = [];
     }
 
-    /**
-     * TODO: remove for next major release.
-     *
-     * @internal
-     *
-     * @deprecated use one of the insert/update/remove/associate/dissociate methods instead
-     */
-    public function trackAuditEvent(string $type, array $data): void
-    {
-        @trigger_error('This method is deprecated, use one of the Transaction::insert(), Transaction::update(), Transaction::remove(), Transaction::associate(), Transaction::dissociate() methods instead.', E_USER_DEPRECATED);
-
-        switch ($type) {
-            case self::INSERT:
-                \assert(2 === \count($data));
-                $this->insert(...$data);
-
-                break;
-
-            case self::UPDATE:
-                \assert(2 === \count($data));
-                $this->update(...$data);
-
-                break;
-
-            case self::REMOVE:
-                \assert(2 === \count($data));
-                $this->remove(...$data);
-
-                break;
-
-            case self::ASSOCIATE:
-                \assert(3 === \count($data));
-                $this->associate(...$data);
-
-                break;
-
-            case self::DISSOCIATE:
-                \assert(4 === \count($data));
-                $this->dissociate(...$data);
-
-                break;
-        }
-    }
-
     public function insert(object $source, array $changeset): void
     {
         $this->inserted[] = new InsertEventDto($source, $changeset);

diff --git a/src/Model/TransactionInterface.php b/src/Model/TransactionInterface.php
@@ -20,6 +20,4 @@ public function getRemoved(): array;
     public function getAssociated(): array;
 
     public function getDissociated(): array;
-
-    public function trackAuditEvent(string $type, array $data): void;
 }
diff --git a/src/Provider/Doctrine/Auditing/Annotation/Auditable.php b/src/Provider/Doctrine/Auditing/Annotation/Auditable.php
@@ -5,19 +5,7 @@
 namespace DH\Auditor\Provider\Doctrine\Auditing\Annotation;
 
 use Attribute;
-use Doctrine\Common\Annotations\Annotation;
-use Doctrine\Common\Annotations\Annotation\NamedArgumentConstructor;
 
-/**
- * @Annotation
- *
- * @NamedArgumentConstructor
- *
- * @Target("CLASS")
- * @Attributes({
- *     @Attribute("enabled", required=false, type="bool"),
- * })
- */
 #[Attribute(Attribute::TARGET_CLASS)]
 final class Auditable
 {

diff --git a/src/Provider/Doctrine/Auditing/Annotation/Ignore.php b/src/Provider/Doctrine/Auditing/Annotation/Ignore.php
@@ -5,13 +5,7 @@
 namespace DH\Auditor\Provider\Doctrine\Auditing\Annotation;
 
 use Attribute;
-use Doctrine\Common\Annotations\Annotation;
 
-/**
- * @Annotation
- *
- * @Target("PROPERTY")
- */
 #[Attribute(Attribute::TARGET_PROPERTY)]
 final class Ignore
 {

diff --git a/src/Provider/Doctrine/Auditing/Annotation/Security.php b/src/Provider/Doctrine/Auditing/Annotation/Security.php
@@ -5,20 +5,8 @@
 namespace DH\Auditor\Provider\Doctrine\Auditing\Annotation;
 
 use Attribute;
-use Doctrine\Common\Annotations\Annotation;
-use Doctrine\Common\Annotations\Annotation\NamedArgumentConstructor;
-use Doctrine\Common\Annotations\Annotation\Required;
+use Symfony\Contracts\Service\Attribute\Required;
 
-/**
- * @Annotation
- *
- * @NamedArgumentConstructor
- *
- * @Target("CLASS")
- * @Attributes({
- *     @Attribute("view", required=true, type="array<string>"),
- * })
- */
 #[Attribute(Attribute::TARGET_CLASS)]
 final class Security
 {
@@ -28,8 +16,9 @@ final class Security
     public const VIEW_SCOPE = 'view';
 
     /**
-     * @Required
+     * @var array<string>
      */
+    #[Required]
     public array $view;
 
     public function __construct(array $view)

diff --git a/src/Provider/Doctrine/Auditing/Event/DoctrineSubscriber.php b/src/Provider/Doctrine/Auditing/Event/DoctrineSubscriber.php
@@ -4,23 +4,18 @@
 
 namespace DH\Auditor\Provider\Doctrine\Auditing\Event;
 
-use DH\Auditor\Provider\Doctrine\Auditing\Logger\Logger;
-use DH\Auditor\Provider\Doctrine\Auditing\Logger\LoggerChain;
 use DH\Auditor\Provider\Doctrine\Auditing\Logger\Middleware\DHDriver;
 use DH\Auditor\Provider\Doctrine\Auditing\Transaction\TransactionManager;
 use DH\Auditor\Provider\Doctrine\Model\Transaction;
 use DH\Auditor\Provider\Doctrine\Persistence\Helper\DoctrineHelper;
 use Doctrine\Common\EventSubscriber;
-use Doctrine\DBAL\Logging\SQLLogger;
 use Doctrine\ORM\Event\OnFlushEventArgs;
 use Doctrine\ORM\Events;
 
 class DoctrineSubscriber implements EventSubscriber
 {
     private TransactionManager $transactionManager;
 
-    private ?SQLLogger $loggerBackup = null;
-
     public function __construct(TransactionManager $transactionManager)
     {
         $this->transactionManager = $transactionManager;
@@ -45,32 +40,7 @@ public function onFlush(OnFlushEventArgs $args): void
                 $this->transactionManager->process($transaction);
                 $transaction->reset();
             });
-
-            return;
-        }
-
-        trigger_deprecation('damienharper/auditor', '2.2', 'SQLLogger is deprecated. Use DHMiddleware instead');
-        // extend the SQL logger
-        $this->loggerBackup = $entityManager->getConnection()->getConfiguration()->getSQLLogger();
-        $auditLogger = new Logger(function () use ($entityManager, $transaction): void {
-            // flushes pending data
-            $entityManager->getConnection()->getConfiguration()->setSQLLogger($this->loggerBackup);
-            $this->transactionManager->process($transaction);
-            $transaction->reset();
-        });
-
-        // Initialize a new LoggerChain with the new AuditLogger + the existing SQLLoggers.
-        $loggerChain = new LoggerChain();
-        if ($this->loggerBackup instanceof LoggerChain) {
-            foreach ($this->loggerBackup->getLoggers() as $logger) {
-                $loggerChain->addLogger($logger);
-            }
-        } elseif ($this->loggerBackup instanceof SQLLogger) {
-            $loggerChain->addLogger($this->loggerBackup);
         }
-
-        $loggerChain->addLogger($auditLogger);
-        $entityManager->getConnection()->getConfiguration()->setSQLLogger($loggerChain);
     }
 
     /**

diff --git a/src/Provider/Doctrine/Auditing/Logger/Logger.php b/src/Provider/Doctrine/Auditing/Logger/Logger.php
diff --git a/src/Provider/Doctrine/Auditing/Logger/LoggerChain.php b/src/Provider/Doctrine/Auditing/Logger/LoggerChain.php
diff --git a/src/Provider/Doctrine/Auditing/Transaction/TransactionHydrator.php b/src/Provider/Doctrine/Auditing/Transaction/TransactionHydrator.php
@@ -86,29 +86,27 @@ private function hydrateWithScheduledCollectionUpdates(Transaction $transaction,
             if (null !== $owner && $this->provider->isAudited($owner)) {
                 $mapping = $collection->getMapping();
 
-                if (null === $mapping) {
-                    continue;
-                }
-
-                /** @var object $entity */
-                foreach ($collection->getInsertDiff() as $entity) {
-                    if ($this->provider->isAudited($entity)) {
-                        $transaction->associate(
-                            $owner,
-                            $entity,
-                            $mapping,
-                        );
+                if (null !== $mapping) {
+                    /** @var object $entity */
+                    foreach ($collection->getInsertDiff() as $entity) {
+                        if ($this->provider->isAudited($entity)) {
+                            $transaction->associate(
+                                $owner,
+                                $entity,
+                                $mapping,
+                            );
+                        }
                     }
-                }
 
-                /** @var object $entity */
-                foreach ($collection->getDeleteDiff() as $entity) {
-                    if ($this->provider->isAudited($entity) && $collection->getOwner()) {
-                        $transaction->dissociate(
-                            $owner,
-                            $entity,
-                            $mapping,
-                        );
+                    /** @var object $entity */
+                    foreach ($collection->getDeleteDiff() as $entity) {
+                        if ($this->provider->isAudited($entity) && $collection->getOwner()) {
+                            $transaction->dissociate(
+                                $owner,
+                                $entity,
+                                $mapping,
+                            );
+                        }
                     }
                 }
             }
@@ -126,18 +124,16 @@ private function hydrateWithScheduledCollectionDeletions(Transaction $transactio
             if (null !== $owner && $this->provider->isAudited($owner)) {
                 $mapping = $collection->getMapping();
 
-                if (null === $mapping) {
-                    continue;
-                }
-
-                /** @var object $entity */
-                foreach ($collection->toArray() as $entity) {
-                    if ($this->provider->isAudited($entity)) {
-                        $transaction->dissociate(
-                            $owner,
-                            $entity,
-                            $mapping,
-                        );
+                if (null !== $mapping) {
+                    /** @var object $entity */
+                    foreach ($collection->toArray() as $entity) {
+                        if ($this->provider->isAudited($entity)) {
+                            $transaction->dissociate(
+                                $owner,
+                                $entity,
+                                $mapping,
+                            );
+                        }
                     }
                 }
             }

diff --git a/src/Provider/Doctrine/DoctrineProvider.php b/src/Provider/Doctrine/DoctrineProvider.php
@@ -175,11 +175,6 @@ public function isAudited(object|string $entity): bool
 
         $entityOptions = $configuration->getEntities()[$class];
 
-        if (null === $entityOptions) {
-            // no option defined => $entity is audited
-            return true;
-        }
-
         if (isset($entityOptions['enabled'])) {
             return (bool) $entityOptions['enabled'];
         }
@@ -208,11 +203,6 @@ public function isAuditedField(object|string $entity, string $field): bool
         $class = DoctrineHelper::getRealClassName($entity);
         $entityOptions = $this->configuration->getEntities()[$class];
 
-        if (null === $entityOptions) {
-            // no option defined => $field is audited
-            return true;
-        }
-
         // are columns excluded and is field part of them?
         // yes => $field is not audited
         return !(isset($entityOptions['ignored_columns'])

diff --git a/src/Provider/Doctrine/Persistence/Event/TableSchemaSubscriber.php b/src/Provider/Doctrine/Persistence/Event/TableSchemaSubscriber.php
@@ -28,7 +28,7 @@ public function loadClassMetadata(LoadClassMetadataEventArgs $eventArgs): void
 
             \assert($storageService instanceof StorageService);
             $platform = $storageService->getEntityManager()->getConnection()->getDatabasePlatform();
-            if (!$platform->supportsSchemas()) {
+            if (null !== $platform && !$platform->supportsSchemas()) {
                 $classMetadata->setPrimaryTable([
                     'name' => $schemaManager->resolveTableName($classMetadata->getTableName(), $classMetadata->getSchemaName() ?? '', $platform),
                     'schema' => '',