From 076ff60692f1930569469866f9f83775a883806f Mon Sep 17 00:00:00 2001
From: Sergei Morozov <morozov@tut.by>
Date: Fri, 25 Jun 2021 18:55:12 -0700
Subject: [PATCH] [GH-4681] Remove TableGenerator

---
 UPGRADE.md                              |   4 +
 psalm.xml.dist                          |   5 -
 src/Id/TableGenerator.php               | 165 ------------------------
 src/Id/TableGeneratorSchemaVisitor.php  |  63 ---------
 tests/Functional/TableGeneratorTest.php |  62 ---------
 5 files changed, 4 insertions(+), 295 deletions(-)
 delete mode 100644 src/Id/TableGenerator.php
 delete mode 100644 src/Id/TableGeneratorSchemaVisitor.php
 delete mode 100644 tests/Functional/TableGeneratorTest.php

diff --git a/UPGRADE.md b/UPGRADE.md
index 4b2ccf255e2..895f991b362 100644
--- a/UPGRADE.md
+++ b/UPGRADE.md
@@ -8,6 +8,10 @@ awareness about deprecated code.
 
 # Upgrade to 4.0
 
+## Removed `TableGenerator` component
+
+The `TableGenerator` component has been removed.
+
 ## Removed support for `Connection::lastInsertId($name)`
 
 The `Connection::lastInsertId()` method no longer accepts a sequence name.
diff --git a/psalm.xml.dist b/psalm.xml.dist
index aab71dfcc10..925faa20b5d 100644
--- a/psalm.xml.dist
+++ b/psalm.xml.dist
@@ -46,11 +46,6 @@
                     is no longer supported.
                 -->
                 <file name="src/Tools/Console/ConsoleRunner.php"/>
-                <!--
-                    This suppression should be removed in 4.0.0.
-                -->
-                <referencedClass name="Doctrine\DBAL\Id\TableGenerator"/>
-                <referencedClass name="Doctrine\DBAL\Id\TableGeneratorSchemaVisitor"/>
             </errorLevel>
         </DeprecatedClass>
         <DeprecatedMethod>
diff --git a/src/Id/TableGenerator.php b/src/Id/TableGenerator.php
deleted file mode 100644
index f35ed018f05..00000000000
--- a/src/Id/TableGenerator.php
+++ /dev/null
@@ -1,165 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Doctrine\DBAL\Id;
-
-use Doctrine\DBAL\Connection;
-use Doctrine\DBAL\Driver;
-use Doctrine\DBAL\DriverManager;
-use Doctrine\DBAL\Exception;
-use Doctrine\DBAL\LockMode;
-use Doctrine\Deprecations\Deprecation;
-use Throwable;
-
-use function array_change_key_case;
-use function assert;
-use function is_int;
-use function sprintf;
-
-use const CASE_LOWER;
-
-/**
- * Table ID Generator for those poor languages that are missing sequences.
- *
- * WARNING: The Table Id Generator clones a second independent database
- * connection to work correctly. This means using the generator requests that
- * generate IDs will have two open database connections. This is necessary to
- * be safe from transaction failures in the main connection. Make sure to only
- * ever use one TableGenerator otherwise you end up with many connections.
- *
- * TableID Generator does not work with SQLite.
- *
- * The TableGenerator does not take care of creating the SQL Table itself. You
- * should look at the `TableGeneratorSchemaVisitor` to do this for you.
- * Otherwise the schema for a table looks like:
- *
- * CREATE sequences (
- *   sequence_name VARCHAR(255) NOT NULL,
- *   sequence_value INT NOT NULL DEFAULT 1,
- *   sequence_increment_by INT NOT NULL DEFAULT 1,
- *   PRIMARY KEY (sequence_name)
- * );
- *
- * Technically this generator works as follows:
- *
- * 1. Use a robust transaction serialization level.
- * 2. Open transaction
- * 3. Acquire a read lock on the table row (SELECT .. FOR UPDATE)
- * 4. Increment current value by one and write back to database
- * 5. Commit transaction
- *
- * If you are using a sequence_increment_by value that is larger than one the
- * ID Generator will keep incrementing values until it hits the incrementation
- * gap before issuing another query.
- *
- * If no row is present for a given sequence a new one will be created with the
- * default values 'value' = 1 and 'increment_by' = 1
- *
- * @deprecated
- */
-class TableGenerator
-{
-    /** @var Connection */
-    private $conn;
-
-    /** @var string */
-    private $generatorTableName;
-
-    /** @var array<string, array<string, int>> */
-    private $sequences = [];
-
-    /**
-     * @throws Exception
-     */
-    public function __construct(Connection $conn, string $generatorTableName = 'sequences')
-    {
-        Deprecation::trigger(
-            'doctrine/dbal',
-            'https://github.com/doctrine/dbal/pull/4681',
-            'The TableGenerator class is is deprecated.',
-        );
-
-        if ($conn->getDriver() instanceof Driver\PDO\SQLite\Driver) {
-            throw new Exception('Cannot use TableGenerator with SQLite.');
-        }
-
-        $this->conn = DriverManager::getConnection(
-            $conn->getParams(),
-            $conn->getConfiguration(),
-            $conn->getEventManager()
-        );
-
-        $this->generatorTableName = $generatorTableName;
-    }
-
-    /**
-     * Generates the next unused value for the given sequence name.
-     *
-     * @throws Exception
-     */
-    public function nextValue(string $sequence): int
-    {
-        if (isset($this->sequences[$sequence])) {
-            $value = $this->sequences[$sequence]['value'];
-            $this->sequences[$sequence]['value']++;
-            if ($this->sequences[$sequence]['value'] >= $this->sequences[$sequence]['max']) {
-                unset($this->sequences[$sequence]);
-            }
-
-            return $value;
-        }
-
-        $this->conn->beginTransaction();
-
-        try {
-            $platform = $this->conn->getDatabasePlatform();
-            $sql      = 'SELECT sequence_value, sequence_increment_by'
-                . ' FROM ' . $platform->appendLockHint($this->generatorTableName, LockMode::PESSIMISTIC_WRITE)
-                . ' WHERE sequence_name = ? ' . $platform->getWriteLockSQL();
-            $row      = $this->conn->fetchAssociative($sql, [$sequence]);
-
-            if ($row !== false) {
-                $row = array_change_key_case($row, CASE_LOWER);
-
-                $value = $row['sequence_value'];
-                $value++;
-
-                assert(is_int($value));
-
-                if ($row['sequence_increment_by'] > 1) {
-                    $this->sequences[$sequence] = [
-                        'value' => $value,
-                        'max' => $row['sequence_value'] + $row['sequence_increment_by'],
-                    ];
-                }
-
-                $sql  = 'UPDATE ' . $this->generatorTableName . ' ' .
-                       'SET sequence_value = sequence_value + sequence_increment_by ' .
-                       'WHERE sequence_name = ? AND sequence_value = ?';
-                $rows = $this->conn->executeStatement($sql, [$sequence, $row['sequence_value']]);
-
-                if ($rows !== 1) {
-                    throw new Exception('Race condition detected while updating sequence. Aborting generation.');
-                }
-            } else {
-                $this->conn->insert(
-                    $this->generatorTableName,
-                    ['sequence_name' => $sequence, 'sequence_value' => 1, 'sequence_increment_by' => 1]
-                );
-                $value = 1;
-            }
-
-            $this->conn->commit();
-        } catch (Throwable $e) {
-            $this->conn->rollBack();
-
-            throw new Exception(sprintf(
-                'Error occurred while generating ID with TableGenerator, aborted generation with error: %s',
-                $e->getMessage()
-            ), 0, $e);
-        }
-
-        return $value;
-    }
-}
diff --git a/src/Id/TableGeneratorSchemaVisitor.php b/src/Id/TableGeneratorSchemaVisitor.php
deleted file mode 100644
index 99a6547ac61..00000000000
--- a/src/Id/TableGeneratorSchemaVisitor.php
+++ /dev/null
@@ -1,63 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Doctrine\DBAL\Id;
-
-use Doctrine\DBAL\Schema\Column;
-use Doctrine\DBAL\Schema\ForeignKeyConstraint;
-use Doctrine\DBAL\Schema\Index;
-use Doctrine\DBAL\Schema\Schema;
-use Doctrine\DBAL\Schema\Sequence;
-use Doctrine\DBAL\Schema\Table;
-use Doctrine\DBAL\Schema\Visitor\Visitor;
-use Doctrine\Deprecations\Deprecation;
-
-/**
- * @deprecated
- */
-final class TableGeneratorSchemaVisitor implements Visitor
-{
-    /** @var string */
-    private $generatorTableName;
-
-    public function __construct(string $generatorTableName = 'sequences')
-    {
-        Deprecation::trigger(
-            'doctrine/dbal',
-            'https://github.com/doctrine/dbal/pull/4681',
-            'The TableGeneratorSchemaVisitor class is is deprecated.',
-        );
-
-        $this->generatorTableName = $generatorTableName;
-    }
-
-    public function acceptSchema(Schema $schema): void
-    {
-        $table = $schema->createTable($this->generatorTableName);
-
-        $table->addColumn('sequence_name', 'string', ['length' => 255]);
-        $table->addColumn('sequence_value', 'integer', ['default' => 1]);
-        $table->addColumn('sequence_increment_by', 'integer', ['default' => 1]);
-    }
-
-    public function acceptTable(Table $table): void
-    {
-    }
-
-    public function acceptColumn(Table $table, Column $column): void
-    {
-    }
-
-    public function acceptForeignKey(Table $localTable, ForeignKeyConstraint $fkConstraint): void
-    {
-    }
-
-    public function acceptIndex(Table $table, Index $index): void
-    {
-    }
-
-    public function acceptSequence(Sequence $sequence): void
-    {
-    }
-}
diff --git a/tests/Functional/TableGeneratorTest.php b/tests/Functional/TableGeneratorTest.php
deleted file mode 100644
index 773f7397a48..00000000000
--- a/tests/Functional/TableGeneratorTest.php
+++ /dev/null
@@ -1,62 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Doctrine\DBAL\Tests\Functional;
-
-use Doctrine\DBAL\Id\TableGenerator;
-use Doctrine\DBAL\Id\TableGeneratorSchemaVisitor;
-use Doctrine\DBAL\Schema\Schema;
-use Doctrine\DBAL\Tests\FunctionalTestCase;
-use Throwable;
-
-class TableGeneratorTest extends FunctionalTestCase
-{
-    /** @var TableGenerator */
-    private $generator;
-
-    protected function setUp(): void
-    {
-        parent::setUp();
-
-        $platform = $this->connection->getDatabasePlatform();
-        if ($platform->getName() === 'sqlite') {
-            self::markTestSkipped('TableGenerator does not work with SQLite');
-        }
-
-        try {
-            $schema  = new Schema();
-            $visitor = new TableGeneratorSchemaVisitor();
-            $schema->visit($visitor);
-
-            foreach ($schema->toSql($platform) as $sql) {
-                $this->connection->executeStatement($sql);
-            }
-        } catch (Throwable $e) {
-        }
-
-        $this->generator = new TableGenerator($this->connection);
-    }
-
-    public function testNextVal(): void
-    {
-        $id1 = $this->generator->nextValue('tbl1');
-        $id2 = $this->generator->nextValue('tbl1');
-        $id3 = $this->generator->nextValue('tbl2');
-
-        self::assertGreaterThan(0, $id1, 'First id has to be larger than 0');
-        self::assertEquals($id1 + 1, $id2, 'Second id is one larger than first one.');
-        self::assertEquals($id1, $id3, 'First ids from different tables are equal.');
-    }
-
-    public function testNextValNotAffectedByOuterTransactions(): void
-    {
-        $this->connection->beginTransaction();
-        $id1 = $this->generator->nextValue('tbl1');
-        $this->connection->rollBack();
-        $id2 = $this->generator->nextValue('tbl1');
-
-        self::assertGreaterThan(0, $id1, 'First id has to be larger than 0');
-        self::assertEquals($id1 + 1, $id2, 'Second id is one larger than first one.');
-    }
-}