Add foreign key constraint for the relation between the entity audit tables and the revisions index

Author: phansys

UPGRADE.md

@@ -1,2 +1,13 @@
 UPGRADE 1.x
 ===========
+
+UPGRADE FROM 1.x to 1.x
+=======================
+
+### `SimpleThings\EntityAudit\EventListener\CreateSchemaListener`
+
+"postGenerateSchema" event is not listen anymore. The table responsible for storing
+the revisions index is created on the "postGenerateSchemaTable" event.
+A foreign key constraint was added for the relation between the revisions index and
+the audit tables, disallowing to delete the records in the index if their referenced
+values exist in the audit tables.

src/AuditReader.php

@@ -580,26 +580,26 @@ public function getCurrentRevision($className, $id)
             throw new NotAuditedException($className);
         }
 
-        /** @var ClassMetadataInfo|ClassMetadata $class */
-        $class = $this->em->getClassMetadata($className);
-        $tableName = $this->config->getTableName($class);
+        /** @var ClassMetadataInfo|ClassMetadata $classMetadata */
+        $classMetadata = $this->em->getClassMetadata($className);
+        $tableName = $this->config->getTableName($classMetadata);
 
         if (!\is_array($id)) {
-            $id = [$class->identifier[0] => $id];
+            $id = [$classMetadata->identifier[0] => $id];
         }
 
         $whereSQL = '';
-        foreach ($class->identifier as $idField) {
-            if (isset($class->fieldMappings[$idField])) {
+        foreach ($classMetadata->identifier as $idField) {
+            if (isset($classMetadata->fieldMappings[$idField])) {
                 if ($whereSQL) {
                     $whereSQL .= ' AND ';
                 }
-                $whereSQL .= 'e.'.$class->fieldMappings[$idField]['columnName'].' = ?';
-            } elseif (isset($class->associationMappings[$idField])) {
+                $whereSQL .= 'e.'.$classMetadata->fieldMappings[$idField]['columnName'].' = ?';
+            } elseif (isset($classMetadata->associationMappings[$idField])) {
                 if ($whereSQL) {
                     $whereSQL .= ' AND ';
                 }
-                $whereSQL .= 'e.'.$class->associationMappings[$idField]['joinColumns'][0].' = ?';
+                $whereSQL .= 'e.'.$classMetadata->associationMappings[$idField]['joinColumns'][0].' = ?';
             }
         }
 

src/EventListener/CreateSchemaListener.php

@@ -14,6 +14,8 @@
 namespace SimpleThings\EntityAudit\EventListener;
 
 use Doctrine\Common\EventSubscriber;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping\ClassMetadataInfo;
 use Doctrine\ORM\Tools\Event\GenerateSchemaEventArgs;
@@ -45,7 +47,6 @@ public function getSubscribedEvents()
     {
         return [
             ToolEvents::postGenerateSchemaTable,
-            ToolEvents::postGenerateSchema,
         ];
     }
 
@@ -70,6 +71,9 @@ public function postGenerateSchemaTable(GenerateSchemaTableEventArgs $eventArgs)
         }
 
         $schema = $eventArgs->getSchema();
+
+        $revisionsTable = $this->createRevisionsTable($schema);
+
         $entityTable = $eventArgs->getClassTable();
         $revisionTable = $schema->createTable(
             $this->config->getTablePrefix().$entityTable->getName().$this->config->getTableSuffix()
@@ -92,8 +96,15 @@ public function postGenerateSchemaTable(GenerateSchemaTableEventArgs $eventArgs)
         $revisionTable->setPrimaryKey($pkColumns);
         $revIndexName = $this->config->getRevisionFieldName().'_'.md5($revisionTable->getName()).'_idx';
         $revisionTable->addIndex([$this->config->getRevisionFieldName()], $revIndexName);
+        $revisionForeignKeyName = $this->config->getRevisionFieldName().'_'.md5($revisionTable->getName()).'_fk';
+        $revisionTable->addForeignKeyConstraint($revisionsTable, [$this->config->getRevisionFieldName()], $revisionsTable->getPrimaryKeyColumns(), [], $revisionForeignKeyName);
     }
 
+    /**
+     * NEXT_MAJOR: Remove this method.
+     *
+     * @deprecated since sonata-project/entity-audit-bundle 1.x, will be removed in 2.0.
+     */
     public function postGenerateSchema(GenerateSchemaEventArgs $eventArgs): void
     {
         $schema = $eventArgs->getSchema();
@@ -105,4 +116,23 @@ public function postGenerateSchema(GenerateSchemaEventArgs $eventArgs): void
         $revisionsTable->addColumn('username', Types::STRING)->setNotnull(false);
         $revisionsTable->setPrimaryKey(['id']);
     }
+
+    private function createRevisionsTable(Schema $schema): Table
+    {
+        $revisionsTableName = $this->config->getRevisionTableName();
+
+        if ($schema->hasTable($revisionsTableName)) {
+            return $schema->getTable($revisionsTableName);
+        }
+
+        $revisionsTable = $schema->createTable($revisionsTableName);
+        $revisionsTable->addColumn('id', $this->config->getRevisionIdFieldType(), [
+            'autoincrement' => true,
+        ]);
+        $revisionsTable->addColumn('timestamp', Types::DATETIME_MUTABLE);
+        $revisionsTable->addColumn('username', Types::STRING)->setNotnull(false);
+        $revisionsTable->setPrimaryKey(['id']);
+
+        return $revisionsTable;
+    }
 }

tests/CoreTest.php

@@ -13,6 +13,7 @@
 
 namespace SimpleThings\EntityAudit\Tests;
 
+use Doctrine\DBAL\Exception\DriverException;
 use SimpleThings\EntityAudit\ChangedEntity;
 use SimpleThings\EntityAudit\Exception\NoRevisionFoundException;
 use SimpleThings\EntityAudit\Exception\NotAuditedException;
@@ -412,4 +413,49 @@ public function testUsernameResolvingIsDynamic(): void
 
         $this->assertNotSame($revisions[0]->getUsername(), $revisions[1]->getUsername());
     }
+
+    public function testRevisionForeignKeys(): void
+    {
+        $isSqlitePlatform = 'sqlite' === $this->em->getConnection()->getDatabasePlatform()->getName();
+        $updateForeignKeysConfig = false;
+
+        if ($isSqlitePlatform) {
+            $updateForeignKeysConfig = '0' === $this->em->getConnection()->executeQuery('PRAGMA foreign_keys;')->fetchOne();
+
+            if ($updateForeignKeysConfig) {
+                // Enable the "foreign_keys" pragma.
+                $this->em->getConnection()->executeQuery('PRAGMA foreign_keys = ON;');
+            }
+        }
+
+        $user = new UserAudit('phansys');
+
+        $this->em->persist($user);
+        $this->em->flush();
+
+        $reader = $this->auditManager->createAuditReader($this->em);
+
+        $revisions = $reader->findRevisions(\get_class($user), $user->getId());
+
+        $this->assertCount(1, $revisions);
+
+        $revision = $reader->getCurrentRevision(\get_class($user), $user->getId());
+        $this->assertSame('1', $revision);
+
+        $revisionsTableName = $this->auditManager->getConfiguration()->getRevisionTableName();
+
+        $this->expectException(DriverException::class);
+        $this->expectExceptionMessage('SQLSTATE[23000]: Integrity constraint violation: 19 FOREIGN KEY constraint failed');
+
+        try {
+            $this->em->getConnection()->delete($revisionsTableName, ['id' => $revision]);
+        } catch (DriverException $e) {
+            throw $e;
+        } finally {
+            if ($updateForeignKeysConfig) {
+                // Restore the original value for the "foreign_keys" pragma.
+                $this->em->getConnection()->executeQuery('PRAGMA foreign_keys = OFF;');
+            }
+        }
+    }
 }