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

GwendolenLynch · 2023-07-01T17:18:37Z

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 · 2024-01-15T14:33:01Z

tests/fixtures/Types/GeoJsonType.php

+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+
+final class GeoJsonType extends GeographyType


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

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 😺

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

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

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 · 2024-02-20T14:06:49Z

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

GwendolenLynch · 2024-03-07T16:11:20Z

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

Tests are passing locally.

thePanz · 2024-03-08T10:18:51Z

src/Driver/PostGISPlatform.php

        }

        /** @var ColumnDiff $columnDiff */
        foreach ($diff->getModifiedColumns() as $columnDiff) {
-            if ($columnDiff->hasChanged('srid')) {
+            if ($columnDiff->getOldColumn()->getPlatformOption('srid') !== $columnDiff->getNewColumn()->getPlatformOption('srid')) {


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; }

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

Thanks so much for the testing! Fix pushed.

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 · 2024-03-21T12:39:25Z

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

mjanser · 2024-04-22T08:22:04Z

src/Driver/PostGISPlatform.php

+            if(!$columnDiff->getOldColumn()->hasPlatformOption('srid') && !$columnDiff->getNewColumn()->hasPlatformOption('srid')) {
+                continue;
+            }
+            if ($columnDiff->getOldColumn()->getPlatformOption('srid') !== $columnDiff->getNewColumn()->getPlatformOption('srid')) {


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.

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

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.

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 · 2024-04-22T20:30:45Z

@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 · 2024-04-22T20:40:49Z

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 · 2024-04-23T08:32:46Z

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 · 2024-04-23T09:19:14Z

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 · 2024-05-08T12:03:44Z

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 · 2024-05-16T19:44:47Z

composer.json

    },
    "require-dev": {
-        "doctrine/orm": "^2.9",
+        "doctrine/collections": "^2.0 || ^3.0",
+        "doctrine/orm": "^2.19 || ^3.0",


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

GErpeldinger · 2024-07-02T09:02:38Z

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

GwendolenLynch added 7 commits July 1, 2023 17:15

Update DBAL to a minimum of 3.2

c0a309b

DBAL middleware, driver, and extended platform

dba5510

Migrate SchemaManager to extend DBAL's

69f1e8f

Remove DBAL event subscriber & change ORM to listener

95bebb4

Add @Covers to generated Functions

cd6e746

Update existing tests and add new tests cover added classes

69903ed

Update docs

73b7f7a

GwendolenLynch force-pushed the dbal-deprecations branch from 7c34d2b to c82761b Compare July 2, 2023 07:44

thePanz reviewed Jan 15, 2024

View reviewed changes

thePanz mentioned this pull request Feb 12, 2024

#62 Switch to platform options from deprecated custom schema options #64

Merged

Repository owner deleted a comment from vazw Mar 4, 2024

GwendolenLynch force-pushed the dbal-deprecations branch 3 times, most recently from 9866728 to 1b766d0 Compare March 5, 2024 13:56

GwendolenLynch added 4 commits March 7, 2024 17:05

Updates for DBAL v4 deprecations

e795067

Switch functions from Lexer constants to TokenType enum

4ec73b9

Update minimum required versions

7fb9091

Update psalm baseline

07e9d7a

GwendolenLynch force-pushed the dbal-deprecations branch 2 times, most recently from 2bc5745 to 07e9d7a Compare March 7, 2024 16:08

GwendolenLynch changed the title ~~DBAL Middleware, Driver, Platform, and SchemaManager implementation~~ DBAL v4, Middleware, Driver, Platform, and SchemaManager implementation Mar 7, 2024

thePanz reviewed Mar 8, 2024

View reviewed changes

mjanser reviewed Apr 22, 2024

View reviewed changes

Check platform option exists before use

1dea92f

GwendolenLynch force-pushed the dbal-deprecations branch from cd67572 to 1dea92f Compare April 22, 2024 09:23

GwendolenLynch added 2 commits April 23, 2024 12:13

Update docs

c2b86ff

Raise Docker PHP version to 8.2

9a88d1f

maxhelias reviewed May 16, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

GwendolenLynch commented Jul 1, 2023 •

edited

Loading

thePanz Jan 15, 2024

GwendolenLynch Mar 5, 2024

thePanz Mar 5, 2024

jsor Mar 5, 2024

thePanz Mar 5, 2024

thePanz commented Feb 20, 2024

GwendolenLynch commented Mar 7, 2024

thePanz Mar 8, 2024

thePanz Mar 8, 2024

GwendolenLynch Mar 8, 2024

thePanz Mar 8, 2024

wesnick commented Mar 21, 2024

mjanser Apr 22, 2024

GwendolenLynch Apr 22, 2024

mjanser Apr 22, 2024

GwendolenLynch Apr 23, 2024

tasselchof commented Apr 22, 2024

tasselchof commented Apr 22, 2024

GwendolenLynch commented Apr 23, 2024

tasselchof commented Apr 23, 2024

scripness commented May 8, 2024

maxhelias left a comment

maxhelias May 16, 2024

GErpeldinger commented Jul 2, 2024


		use Doctrine\DBAL\Platforms\AbstractPlatform;

		final class GeoJsonType extends GeographyType

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

Are you sure you want to change the base?

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

Conversation

GwendolenLynch commented Jul 1, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thePanz commented Feb 20, 2024

GwendolenLynch commented Mar 7, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wesnick commented Mar 21, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tasselchof commented Apr 22, 2024

tasselchof commented Apr 22, 2024

GwendolenLynch commented Apr 23, 2024

tasselchof commented Apr 23, 2024

scripness commented May 8, 2024

maxhelias left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GErpeldinger commented Jul 2, 2024

GwendolenLynch commented Jul 1, 2023 •

edited

Loading