Addversion annotation/attribute to be set on the property holding the version of the normalized representation (only one property can be set asVersion)
AddVersionConstraint annotation/attribute. That attribute control restriction on normalisation/denormalization depending on the value of the property that holdVersion attribute. Inner properties aresince anduntil. At least one of them has to be set.
EitherVersion.version,VersionConstraint.since andVersionConstraint.until are expressed as semver string, and must be compliant withversion_compare function. A property restricted by a constraint is defined as :notDefined <since|null <=defined <=until|null <notDefined

Behavior and naming are inspired byhttps://jmsyst.com/libs/serializer/master/reference/annotations#since andhttps://jmsyst.com/libs/serializer/master/reference/annotations#until

Logic is as follow:

Normalization
A restricted property by aVersionConstraint is not added to the normalized representation if the constraint is not satisfied
Denormalization
A restricted property by aVersionConstraint is set to null if the constraint is not satisfied or to the value if the constraint is satisfied

Example of usage

class VersionAwareObject{private$foo;/**     * @Version     */publicstring$version;/**     * @VersionConstraint(     *     since="1.1",     *     until="1.5"     * )     */public ?string$name;/**     * @VersionConstraint(     *     since="1.6"     * )     */public ?string$lastName;}

I don't see any Breaking Changes up to now

micoli requested a review fromdunglas as acode owner

July 2, 2023 16:45

carsonbot added Status: Needs Review Feature labels

Jul 2, 2023

carsonbot added this to the6.4 milestone

Jul 2, 2023

Copy link

carsonbot commentedJul 2, 2023

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has acontribution guide which I suggest you to read.

In short:

Always add tests
Keep backward compatibility (seehttps://symfony.com/bc).
Bug fixes must be submitted against the lowest maintained branch where they apply (seehttps://symfony.com/releases)
Features and deprecations must be submitted against the 6.4 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

micoli force-pushed theadd-versionning-to-serializer branch 2 times, most recently fromb49f144 to2781c01Compare

July 2, 2023 17:03

Copy link

antonkomarev commentedJul 2, 2023

How to deal with cases when in the future version the field should become not nullable or it's type should be changed?

Copy link

Contributor

asispts commentedJul 2, 2023

Similar PR#38478

Copy link

Author

micoli commentedJul 2, 2023

Similar PR#38478

I'v only seen#35617, not this one. Hence this PR and mine have the same purpose, I can close mine if it's desired

Copy link

Author

micoli commentedJul 2, 2023

How to deal with cases when in the future version the field should become not nullable or it's type should be changed?

Indeed, to have versioned field, due to the fact it can once be null, then by design those versionConstrained fields should be defined as nullable. I can add a check on that when reading field metadatas

micoli added2 commits

July 2, 2023 20:47

[Serializer] Add version related attributes

11b7b60

[Serializer] Use version constraints attribute on normalize/denormalize

0b35462

micoli force-pushed theadd-versionning-to-serializer branch from2781c01 to0b35462Compare

July 2, 2023 18:47

Copy link

Author

micoli commentedJul 2, 2023

How to deal with cases when in the future version the field should become not nullable or it's type should be changed?

I've added a check to enforce the fact the field should be, by design, either without typehint either with a nullable type.

Regarding the type change of the field, i've no clue how to enforce it. Do you have an idea?

OskarStark changed the title~~Add versionning to serializer~~[Serializer] Add versionning

Jul 3, 2023

OskarStark added the Serializer label

Jul 3, 2023

Copy link

Contributor

94noni commentedJul 3, 2023

hello (just passing by)
is it relevant to add annotation as the PR target v6 withphp v8.1 as minimal requirement?
perhaps only native attribute is enough