DBAL v4, Middleware, Driver, Platform, and SchemaManager implementation

[GwendolenLynch]

From DBAL 3.2 the events systems is (mostly?) deprecated in favour of middleware, and custom schema manager + factory combination.

The main purpose of this PR is to migrate as much as possible to this:

• Jsor\Doctrine\PostGIS\Driver\Driver that extends AbstractPostgreSQLDriver
• Jsor\Doctrine\PostGIS\Driver\Middleware that wraps the lower level Driver inside the PostGIS Driver
• Jsor\Doctrine\PostGIS\Driver\PostGISPlatform wraps Doctrine\DBAL\Platforms\PostgreSQLPlatform and is instantiated by the PostGIS Driver
• Jsor\Doctrine\PostGIS\Schema\SchemaManager now extends Doctrine\DBAL\Schema\PostgreSQLSchemaManager and handles schema management
• Jsor\Doctrine\PostGIS\Schema\SchemaManagerFactory is an implementation of Doctrine\DBAL\Schema\SchemaManagerFactory
  • Creates the SchemaManager instance inside Connection
• Functionality from Jsor\Doctrine\PostGIS\Event\DBALSchemaEventSubscriber moved to PostGISPlatform

Additionally:

• Updated docs
• Added @covers on most tests to get a better view of coverage
• Updated tests and all pass
• Updated psalm.xml and it passes

Bonus: It is now possible to extend Jsor\Doctrine\PostGIS\Types\GeographyType or Jsor\Doctrine\PostGIS\Types\GeometryType and not have the schema tool throw a tantrum. See PostGISPlatformTest

Feedback welcome, and I'm happy to add/adjust/drop relevant things.

Edit: Fixes #63

[thePanz]

Is this file in the wrong folder?
Would be cool to have this new type added too

[GwendolenLynch]

No, it is meant to be a fixture with respect to this PR.

Agreed it might be a nice feature, but beyond scope of this PR 😺

[thePanz]

fun fact: we started using it in our own project too, but altered to be a geometry rather than a geography:

ST_GeomFromGeoJSON(%s)::geometry

[jsor]

Exactly one of the reasons i only provide very basic types. Even those are probably only starting points for your own application specific types 😉

[thePanz]

yeah, exactly (with the added fun of having Doctrine not discovering the class if you use hypens - as type name 🤦 )

we got an "auto WSG84 converter" type, but that's a different story :-)

[thePanz]

@jsor we have been using this fork with no issues for a while now, any progress/help-needed here?

[GwendolenLynch]

This latest update should take care of the remaining deprecations to support DBAL v4 (and silence PHPUnit).

Tests are passing locally.

[thePanz]

This throws an exception when the 'srid' option is not defined (example: the column is not one from PosGis)

I would add something like this before the check:

            if( ! $columnDiff->getNewColumn()->hasPlatformOption('srid')) {
                continue;
            }

[thePanz]

The error is thrown when running bin/console doctrine:schema:validate -v

[GwendolenLynch]

Thanks so much for the testing! Fix pushed.

[thePanz]

Thank you for the PR! 👍

Unfortunately DBAL v4 is not (yet) compatible with Symfony, thus my tests will be limited to v3 only from now on

[wesnick]

👍 This branch works for me, I was able to upgrade an existing symfony project to DBAL 4, ORM 3. Thanks!

[mjanser]

This check doesn't seem to work in our case.

$columnDiff->getNewColumn() has the srid platform option, but $columnDiff->getOldColumn() doesn't have it.
This makes it fail with the error Warning: Undefined array key "srid".

I don't know why $columnDiff->getOldColumn() doesn't have the srid platform option at this point, though.

[GwendolenLynch]

I've updated the logic, does that fix it for you?

[mjanser]

I just tested the new logic. It doesn't throw any error any more.
But it always detects a change, which wants to update the SRID. I guess, that's because srid is not there in $columnDiff->getOldColumn(). There's probably another issue, that this doesn't get populated.

[GwendolenLynch]

I've poked and prodded, but I can't reproduce. I hit something like this when I was first composing the PR … but now 😟

Do you have the time to generate a test case? I'll happily dig in from there!

[tasselchof]

@GwendolenLynch in the documentation you write:

Additionally, to also use the library with the Doctrine ORM, register the ORMSchemaEventListener event subscriber.

use Jsor\Doctrine\PostGIS\Event\ORMSchemaEventListener;

$entityManager->getEventManager()->addEventSubscriber(new ORMSchemaEventSubscriber());

In the example you register ORMSchemaEventSubscriber, if someone just copies it it will fail.

[tasselchof]

Also, I am getting this when I am adding ORM subscriber:

PHP Fatal error:  Uncaught Roave\PsrContainerDoctrine\Exception\DomainException: Invalid event subscriber "Jsor\Doctrine\PostGIS\Event\ORMSchemaEventListener" given, must be a dependency name, class name or an instance implementing Doctrine\Common\EventSubscriber in /../vendor/roave/psr-container-doctrine/src/Exception/DomainException.php:36

[GwendolenLynch]

Thanks for your feedback, @tasselchof. I'm going to try to add some more tests to cover this.

What versions of doctrine/orm, doctrine/dbal, and doctrine/common are you using?

[tasselchof]

Thanks for your feedback, @tasselchof. I'm going to try to add some more tests to cover this.

What versions of doctrine/orm, doctrine/dbal, and doctrine/common are you using?

I've made a pull request to your branch with those fixes: GwendolenLynch#1. You can merge it to fix those and if I will find anything else - I will do another pull request. It's just one test if you wish to add it.

[app]$ composer show doctrine/*
doctrine/annotations   2.0.1  Docblock Annotations Parser
doctrine/collections   2.2.2  PHP Doctrine Collections library that adds additional functionality on top of PHP arrays.
doctrine/common        3.4.4  PHP Doctrine Common project is a library that provides additional functionality that other Doctrine projects depend on such as better reflection sup...
doctrine/data-fixtures 1.7.0  Data Fixtures for all Doctrine Object Managers
doctrine/dbal          4.0.1  Powerful PHP database abstraction layer (DBAL) with many features for database schema introspection and management.
doctrine/deprecations  1.1.3  A small layer on top of trigger_error(E_USER_DEPRECATED) or PSR-3 logging with options to disable all deprecations or selectively for packages.
doctrine/event-manager 2.0.0  The Doctrine Event Manager is a simple PHP event system that was built to be used with the various Doctrine projects.
doctrine/inflector     2.0.10 PHP Doctrine Inflector is a small library that can perform string manipulations with regard to upper/lowercase and singular/plural forms of words.
doctrine/instantiator  2.0.0  A small, lightweight utility to instantiate objects in PHP without invoking their constructors
doctrine/lexer         3.0.1  PHP Doctrine Lexer parser library that can be used in Top-Down, Recursive Descent Parsers.
doctrine/migrations    3.7.4  PHP Doctrine Migrations project offer additional functionality on top of the database abstraction layer (DBAL) for versioning your database schema a...
doctrine/orm           3.1.2  Object-Relational-Mapper for PHP
doctrine/persistence   3.3.2  The Doctrine Persistence project is a set of shared interfaces and functionality that the different Doctrine object mappers share.

[scripness]

Hey guys! Are there any plans on merging this or should we rollback to DBAL v3?

[maxhelias]

A CHANGELOG.md or UPGRADE.md would be welcome to list the new classes and especially the BC of deleted or renamed class.

[maxhelias]

I think we should add a conflict like : "doctrine/orm": "<2.18" for Doctrine\ORM\Query\TokenType

[GErpeldinger]

Hello everyone, any news on this MR ? Are the changelog is the only thing missing for merging it ?