Make the code compatible with DBAL 3 and 4 by swithing the type when…

[rande]

Make the code compatible with DBAL 3 and 4 by swithing the type when the Mapping is loaded

I am targeting this branch, because because it introduces a non necessary BC break. For reference: #1677

Changelog

### Removed
- BaseUser3 doctrine definition

### Added
- Mapping listener to make the same entity works with DBAL 2, 3 or 4

To do

• Review PR;

[VincentLanglet]

There is the error

In MappingException.php line 112:
                                                                               
  The column type of attribute 'roles' on class 'Sonata\UserBundle\Tests\App\  
  Entity\User' could not be changed. 

[rande]

@VincentLanglet hopefully this is good to go!

[VincentLanglet]

Is it the right way to change the value ?

The property is documented as READ-ONLY
https://github.com/doctrine/orm/blob/3d9af3187f59930972e7fcb90a1d8059a37b8032/src/Mapping/ClassMetadata.php#L334-L339

[VincentLanglet]

I think

public function setAttributeOverride(string $fieldName, array $overrideMapping): void

should be used instead. (https://github.com/doctrine/orm/blob/3.1.x/src/Mapping/ClassMetadata.php#L1737)

[rande]

@VincentLanglet https://github.com/doctrine/orm/blob/3.1.x/src/Mapping/ClassMetadata.php#L1765-L1767 it is not possible to change the type using this way.

This solution is a hack but to be honest having a second class BaseUser3 just to change the type is not good either. This can end up, with BaseUser4 etc ...

[VincentLanglet]

Any recommendation for such situation @greg0ire ? Is it the best way ?

[VincentLanglet]

The doc need to be updated too, in order to remove reference of BaseUser3 https://github.com/sonata-project/SonataUserBundle/blob/a6169f318ad30a46ced640fad58a686e695e86f0/docs/reference/installation.rst#doctrine-orm-configuration

[Hanmac]

We probably need to find a way to Migrate the User Data?

My current attempt is this Doctrine Migration file:

$result = $this->connection->executeQuery('SELECT id, roles FROM fos_user_user');
foreach ($result->fetchAllAssociative() as $item) {
    $this->connection->update('fos_user_user', [
        'roles' => json_encode(unserialize($item['roles']))
    ], [
        'id' => $item['id']
    ]);
}

$this->addSql('ALTER TABLE fos_user_user CHANGE roles roles JSON NOT NULL');

[Hanmac]

@VincentLanglet @greg0ire how is the status for this MR?

And do we need an update Script for existing data?

[VincentLanglet]

@VincentLanglet @greg0ire how is the status for this MR?

And do we need an update Script for existing data?

See #1685 (comment)

You can do it if you want this to be merged

[Hanmac]

@VincentLanglet the Doc update is one thing, should we try to something like my Update Script in a more automated way?

#1685 (comment)

Or is the Dev alone with this? (i also don't know if my way is the correct one)

[VincentLanglet]

@VincentLanglet the Doc update is one thing, should we try to something like my Update Script in a more automated way?

#1685 (comment)

Or is the Dev alone with this? (i also don't know if my way is the correct one)

We can document some helper/migrations about how to move from DBAL 3 to DBAL 4 but this cannot be included inside the SonataUserBundle code since we cannot be sure

• when the user will update his DBAL version
• if he want to execute some data migration or doing something else.