From b30d1dd39cbd8a8e2efd98a1918e6795cab437d1 Mon Sep 17 00:00:00 2001 From: Ryan Weaver Date: Wed, 28 Jan 2015 20:10:22 -0500 Subject: [PATCH 1/3] Only getting the target platform when it's *actually* needed to avoid errors initialize() is called sometimes, even when the following code doesn't need the targetPlatform property. Specifically, in AbstractClassMetadataFactory::getAllMetadata(). But as of DBAL 2.5.0, calling Connection::getDatabasePlatform() will make a connection to the database, which means that sometimes it may fail (e.g. you haven't configured your database yet). As a result, calling a method like AbstractClassMetadataFactory::getAllMetadata() - which does not need the targetPlatform - will fail, because determining the targetPlatform requires a connection, which fails. This avoids that - we only get the targetPlatform *when* we need it, which are cases where we're doing things that do indeed need a connection. --- .../ORM/Mapping/ClassMetadataFactory.php | 30 ++++++++++++------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/lib/Doctrine/ORM/Mapping/ClassMetadataFactory.php b/lib/Doctrine/ORM/Mapping/ClassMetadataFactory.php index 089780775..020f9962c 100644 --- a/lib/Doctrine/ORM/Mapping/ClassMetadataFactory.php +++ b/lib/Doctrine/ORM/Mapping/ClassMetadataFactory.php @@ -96,7 +96,6 @@ class ClassMetadataFactory extends AbstractClassMetadataFactory protected function initialize() { $this->driver = $this->em->getConfiguration()->getMetadataDriverImpl(); - $this->targetPlatform = $this->em->getConnection()->getDatabasePlatform(); $this->evm = $this->em->getEventManager(); $this->initialized = true; } @@ -613,9 +612,9 @@ class ClassMetadataFactory extends AbstractClassMetadataFactory { $idGenType = $class->generatorType; if ($idGenType == ClassMetadata::GENERATOR_TYPE_AUTO) { - if ($this->targetPlatform->prefersSequences()) { + if ($this->getTargetPlatform()->prefersSequences()) { $class->setIdGeneratorType(ClassMetadata::GENERATOR_TYPE_SEQUENCE); - } else if ($this->targetPlatform->prefersIdentityColumns()) { + } else if ($this->getTargetPlatform()->prefersIdentityColumns()) { $class->setIdGeneratorType(ClassMetadata::GENERATOR_TYPE_IDENTITY); } else { $class->setIdGeneratorType(ClassMetadata::GENERATOR_TYPE_TABLE); @@ -629,13 +628,13 @@ class ClassMetadataFactory extends AbstractClassMetadataFactory $fieldName = $class->identifier ? $class->getSingleIdentifierFieldName() : null; // Platforms that do not have native IDENTITY support need a sequence to emulate this behaviour. - if ($this->targetPlatform->usesSequenceEmulatedIdentityColumns()) { + if ($this->getTargetPlatform()->usesSequenceEmulatedIdentityColumns()) { $columnName = $class->getSingleIdentifierColumnName(); $quoted = isset($class->fieldMappings[$fieldName]['quoted']) || isset($class->table['quoted']); - $sequencePrefix = $class->getSequencePrefix($this->targetPlatform); - $sequenceName = $this->targetPlatform->getIdentitySequenceName($sequencePrefix, $columnName); + $sequencePrefix = $class->getSequencePrefix($this->getTargetPlatform()); + $sequenceName = $this->getTargetPlatform()->getIdentitySequenceName($sequencePrefix, $columnName); $definition = array( - 'sequenceName' => $this->targetPlatform->fixSchemaElementName($sequenceName) + 'sequenceName' => $this->getTargetPlatform()->fixSchemaElementName($sequenceName) ); if ($quoted) { @@ -646,7 +645,7 @@ class ClassMetadataFactory extends AbstractClassMetadataFactory ->em ->getConfiguration() ->getQuoteStrategy() - ->getSequenceName($definition, $class, $this->targetPlatform); + ->getSequenceName($definition, $class, $this->getTargetPlatform()); } $generator = ($fieldName && $class->fieldMappings[$fieldName]['type'] === 'bigint') @@ -663,11 +662,11 @@ class ClassMetadataFactory extends AbstractClassMetadataFactory if ( ! $definition) { $fieldName = $class->getSingleIdentifierFieldName(); - $sequenceName = $class->getSequenceName($this->targetPlatform); + $sequenceName = $class->getSequenceName($this->getTargetPlatform()); $quoted = isset($class->fieldMappings[$fieldName]['quoted']) || isset($class->table['quoted']); $definition = array( - 'sequenceName' => $this->targetPlatform->fixSchemaElementName($sequenceName), + 'sequenceName' => $this->getTargetPlatform()->fixSchemaElementName($sequenceName), 'allocationSize' => 1, 'initialValue' => 1, ); @@ -680,7 +679,7 @@ class ClassMetadataFactory extends AbstractClassMetadataFactory } $sequenceGenerator = new \Doctrine\ORM\Id\SequenceGenerator( - $this->em->getConfiguration()->getQuoteStrategy()->getSequenceName($definition, $class, $this->targetPlatform), + $this->em->getConfiguration()->getQuoteStrategy()->getSequenceName($definition, $class, $this->getTargetPlatform()), $definition['allocationSize'] ); $class->setIdGenerator($sequenceGenerator); @@ -753,4 +752,13 @@ class ClassMetadataFactory extends AbstractClassMetadataFactory { return isset($class->isMappedSuperclass) && $class->isMappedSuperclass === false; } + + private function getTargetPlatform() + { + if ($this->targetPlatform === null) { + $this->targetPlatform = $this->em->getConnection()->getDatabasePlatform(); + } + + return $this->targetPlatform; + } } From 75bb3a0de3a44c42c2ccdedf02e667d4ac75417d Mon Sep 17 00:00:00 2001 From: Ryan Weaver Date: Wed, 4 Feb 2015 13:49:51 -0500 Subject: [PATCH 2/3] Small code change thanks to the comments and adding a test --- .../ORM/Mapping/ClassMetadataFactory.php | 2 +- .../ORM/Mapping/ClassMetadataFactoryTest.php | 29 +++++++++++++++++-- 2 files changed, 27 insertions(+), 4 deletions(-) diff --git a/lib/Doctrine/ORM/Mapping/ClassMetadataFactory.php b/lib/Doctrine/ORM/Mapping/ClassMetadataFactory.php index 020f9962c..3970b3a39 100644 --- a/lib/Doctrine/ORM/Mapping/ClassMetadataFactory.php +++ b/lib/Doctrine/ORM/Mapping/ClassMetadataFactory.php @@ -755,7 +755,7 @@ class ClassMetadataFactory extends AbstractClassMetadataFactory private function getTargetPlatform() { - if ($this->targetPlatform === null) { + if (!$this->targetPlatform) { $this->targetPlatform = $this->em->getConnection()->getDatabasePlatform(); } diff --git a/tests/Doctrine/Tests/ORM/Mapping/ClassMetadataFactoryTest.php b/tests/Doctrine/Tests/ORM/Mapping/ClassMetadataFactoryTest.php index cd17871ee..855ff818e 100644 --- a/tests/Doctrine/Tests/ORM/Mapping/ClassMetadataFactoryTest.php +++ b/tests/Doctrine/Tests/ORM/Mapping/ClassMetadataFactoryTest.php @@ -194,15 +194,38 @@ class ClassMetadataFactoryTest extends \Doctrine\Tests\OrmTestCase $rootMetadata = $cmf->getMetadataFor('Doctrine\Tests\Models\JoinedInheritanceType\RootClass'); } - protected function _createEntityManager($metadataDriver) + public function testGetAllMetadataWorksWithBadConnection() + { + // DDC-3551 + $conn = $this->getMockBuilder('Doctrine\DBAL\Connection') + ->disableOriginalConstructor() + ->getMock(); + $mockDriver = new MetadataDriverMock(); + $em = $this->_createEntityManager($mockDriver, $conn); + + $conn->expects($this->any()) + ->method('getDatabasePlatform') + ->will($this->throwException(new \Exception('Exception thrown in test when calling getDatabasePlatform'))); + + $cmf = new ClassMetadataFactory(); + $cmf->setEntityManager($em); + + // getting all the metadata should work, even if get DatabasePlatform blows up + $metadata = $cmf->getAllMetadata(); + // this will just be an empty array - there was no error + $this->assertEquals(array(), $metadata); + } + + protected function _createEntityManager($metadataDriver, $conn = null) { $driverMock = new DriverMock(); $config = new \Doctrine\ORM\Configuration(); $config->setProxyDir(__DIR__ . '/../../Proxies'); $config->setProxyNamespace('Doctrine\Tests\Proxies'); $eventManager = new EventManager(); - $conn = new ConnectionMock(array(), $driverMock, $config, $eventManager); - $mockDriver = new MetadataDriverMock(); + if (!$conn) { + $conn = new ConnectionMock(array(), $driverMock, $config, $eventManager); + } $config->setMetadataDriverImpl($metadataDriver); return EntityManagerMock::create($conn, $config, $eventManager); From 0e0863379071f7dae7147eef3427a788868d04ff Mon Sep 17 00:00:00 2001 From: Ryan Weaver Date: Wed, 4 Feb 2015 13:51:02 -0500 Subject: [PATCH 3/3] Adding docblock --- lib/Doctrine/ORM/Mapping/ClassMetadataFactory.php | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/Doctrine/ORM/Mapping/ClassMetadataFactory.php b/lib/Doctrine/ORM/Mapping/ClassMetadataFactory.php index 3970b3a39..0596e9746 100644 --- a/lib/Doctrine/ORM/Mapping/ClassMetadataFactory.php +++ b/lib/Doctrine/ORM/Mapping/ClassMetadataFactory.php @@ -753,6 +753,9 @@ class ClassMetadataFactory extends AbstractClassMetadataFactory return isset($class->isMappedSuperclass) && $class->isMappedSuperclass === false; } + /** + * @return Platforms\AbstractPlatform + */ private function getTargetPlatform() { if (!$this->targetPlatform) {