Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 1 commit into
base: 5.x
Choose a base branch
from

Conversation

rande
Copy link
Member

@rande rande commented May 15, 2024

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;

Sorry, something went wrong.

@VincentLanglet
Copy link
Member

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 rande force-pushed the revert_bc_issue_with_roles branch 4 times, most recently from 6f8282e to cec9f6a Compare May 15, 2024 17:10
…the Mapping is loaded
@rande rande force-pushed the revert_bc_issue_with_roles branch from cec9f6a to 85202a9 Compare May 15, 2024 17:12
@rande
Copy link
Member Author

rande commented May 15, 2024

@VincentLanglet hopefully this is good to go!

Comment on lines +49 to +52
/**
* @psalm-suppress InvalidPropertyAssignmentValue
*/
$metadata->fieldMappings['roles']['type'] = 'array';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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 ...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@VincentLanglet
Copy link
Member

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
Copy link
Contributor

Hanmac commented Jun 13, 2024

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
Copy link
Contributor

Hanmac commented Aug 15, 2024

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

And do we need an update Script for existing data?

@VincentLanglet
Copy link
Member

@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
Copy link
Contributor

Hanmac commented Aug 16, 2024

@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
Copy link
Member

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants