[Serializer] Add an @Ignore annotation #28744

dunglas · 2018-10-05T17:03:56Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#24071
License	MIT
Doc PR	n/a

Add an @Ignore annotation to configure ignored attributes in a convenient way, as well as the related XML and YAML loaders.

TODO:

Add tests

ro0NL · 2018-10-06T08:03:27Z

src/Symfony/Component/Serializer/Normalizer/AbstractNormalizer.php

@@ -245,6 +245,7 @@ protected function getAllowedAttributes($classOrObject, array $context, $attribu
            $name = $attributeMetadata->getName();

            if (
+                !$attributeMetadata->getIgnore() &&


given https://github.com/symfony/symfony/pull/28744/files#diff-7a86113d1484512f310d58e30eadf67dR56 is there any reason to not use $attributeMetadata->ignore here? That would actually implement the advertised perf benefit no?

edit: i see it's about serialization.. but still?

If we change this, I propose to change this consistently for all attributes in another PR.

src/Symfony/Component/Serializer/Mapping/AttributeMetadata.php

GuilhemN

👍, I only have one concern: I think https://github.com/symfony/symfony/blob/master/src/Symfony/Component/PropertyInfo/Extractor/SerializerExtractor.php should be updated as well.

OskarStark

I love your work on improving this component 💪

Koc · 2018-10-06T20:28:47Z

What about providing @ExclusionPolicy in JMS-serializer manner? There is opened PR #19374 for that.

fbourigault · 2018-10-06T21:39:00Z

The plans to improve the Serializer are in #19374 (comment).

fabpot · 2019-03-20T12:42:32Z

@dunglas Do you plan to finish this PR before 4.3 feature freeze?

dunglas · 2019-03-20T18:57:03Z

Yes I'll try to finish it tomorrow

joelwurtz · 2019-03-26T15:06:46Z

Can this annotation be a PropertyInfo component feature instead ? Which remove the property from the getProperties method if needed ?

So other components / library can profit from this metadata as well ?

fbourigault · 2019-03-27T07:10:47Z

IMHO, the @ignore annotation should be owned by the Serializer component because we may want to exclude the property for the Serializer but to include it for anything else.

And about properties extraction, after trying to finish #28775, I figured that the interface about extracting properties to (un-)serialize must belong to the Serializer component and we could also ship a default implementation built on top of the PropertyInfo component.

Then, we could use decorators, to implement @Ignore, @ExclusionPolicy, @Expose, @Since, @Until, etc... We also be able to move the @Groups into an implementation of this interface.

This would move the logic of getting which properties must be (un-)serialize out of Normalizer and improve a lot the S.O.L.I.D.ity of the Serializer component and help to deprecate the GetSetMethodNormalizer, the PropertyNormalizer, the AbstractObjectNormalizer and the AbstractNormalizer.

@joelwurtz, @dunglas let's talk about this at Symfony Live :)

joelwurtz · 2019-03-27T10:37:35Z

👍 for talking about this at SymfonyLive, as for the annotation, i don't see a problem on having it on Serializer only by using a dedicated PropertyInfo extractor chain ?

A lot of the annotations that you propose can be also useful in the context of the Automapper if this component is wanted, i would prefer having those in the symfony property info component as decorator, so other components can also profit of this.

Also if this gets merged #30704 and there is a direct link between PropertyAccess and ProperyInfo component in the future, those annotation + decorators could be used in many place where we want to restrict property. Like in the Form / Validator / Workflow compoenent, this would allow to restrict some properties to be used when using a property path, and avoid exposing some data.

but let's discuss this at symfony live like you said,

dmaicher

I could try to finalize this one within the EUFOSSA hackathon if I get some feedback 😊

src/Symfony/Component/Serializer/Mapping/Loader/AnnotationLoader.php

src/Symfony/Component/Serializer/Mapping/AttributeMetadata.php

src/Symfony/Component/Serializer/Annotation/Ignore.php

joelwurtz · 2019-04-06T13:16:59Z

Just talk with @dmaicher and i think it would be wise to do/finish #30818 (or at least the basics) first before doing this. WDYT @dunglas ?

raress96 · 2020-01-03T09:05:04Z

Any updates regarding this?

dunglas · 2020-01-15T17:59:14Z

Tests added and comments resolved. This PR should be good to be merged now.
As the refactoring work on the Serializer is stuck for months (#30818), I propose to move forward regarding this PR, we'll be able to refactor this later anyway if needed.

nicolas-grekas

LGTM, just one wording question

nicolas-grekas · 2020-02-02T12:39:36Z

(and fixed deps=low)

src/Symfony/Component/Serializer/Mapping/AttributeMetadata.php

weaverryan

This generally makes sense to me.

dunglas · 2020-03-31T12:02:39Z

This one is ready to be merged.

src/Symfony/Component/PropertyInfo/Extractor/SerializerExtractor.php

chalasr

Misses a CHANGELOG entry

src/Symfony/Component/Serializer/Annotation/Ignore.php

fabpot · 2020-04-24T08:37:09Z

Thank you @dunglas.

vasilvestre · 2020-05-23T23:44:56Z

Doc issue there symfony/symfony-docs#13585 I am actually tring to add the documentation

@ignore

…lentin, vasilvestre) This PR was merged into the master branch. Discussion ---------- [Serializer] Add an @ignore annotation #28744 Complete symfony/symfony#28744 Commits ------- dcd5b4c Update serializer.rst 56be700 Update serializer.rst 6a3b355 [Serializer] Add an @ignore annotation #28744

carsonbot added Status: Needs Review Serializer Feature labels Oct 5, 2018

nicolas-grekas added this to the next milestone Oct 5, 2018

ro0NL reviewed Oct 6, 2018

View reviewed changes

src/Symfony/Component/Serializer/Mapping/AttributeMetadata.php Outdated Show resolved Hide resolved

GuilhemN approved these changes Oct 6, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Oct 6, 2018

OskarStark approved these changes Oct 6, 2018

View reviewed changes

maxhelias approved these changes Jan 4, 2019

View reviewed changes

dmaicher reviewed Apr 6, 2019

View reviewed changes

src/Symfony/Component/Serializer/Mapping/Loader/AnnotationLoader.php Show resolved Hide resolved

src/Symfony/Component/Serializer/Mapping/AttributeMetadata.php Show resolved Hide resolved

src/Symfony/Component/Serializer/Annotation/Ignore.php Show resolved Hide resolved

nicolas-grekas added ⭐️ EUFOSSA Hackathon and removed ⭐️ EUFOSSA Hackathon labels Apr 7, 2019

dunglas force-pushed the ignore-annot branch 2 times, most recently from 90b2874 to 383ea22 Compare January 15, 2020 17:57

nicolas-grekas reviewed Feb 2, 2020

View reviewed changes

nicolas-grekas reviewed Feb 3, 2020

View reviewed changes

src/Symfony/Component/Serializer/Mapping/AttributeMetadata.php Outdated Show resolved Hide resolved

weaverryan reviewed Feb 3, 2020

View reviewed changes

GuilhemN mentioned this pull request Mar 14, 2020

Support for "hasX" methods break on "function hash()" nelmio/NelmioApiDocBundle#1595

Closed

dunglas force-pushed the ignore-annot branch from e9b947c to c0cb6a7 Compare March 29, 2020 20:53

nicolas-grekas reviewed Apr 5, 2020

View reviewed changes

src/Symfony/Component/PropertyInfo/Extractor/SerializerExtractor.php Outdated Show resolved Hide resolved

norkunas reviewed Apr 6, 2020

View reviewed changes

src/Symfony/Component/PropertyInfo/Extractor/SerializerExtractor.php Outdated Show resolved Hide resolved

dunglas force-pushed the ignore-annot branch from 8972bb6 to d94468a Compare April 6, 2020 08:57

chalasr reviewed Apr 14, 2020

View reviewed changes

src/Symfony/Component/Serializer/Annotation/Ignore.php Outdated Show resolved Hide resolved

raress96 mentioned this pull request Apr 15, 2020

[Serializer] Add ignored attributes option #24071

Closed

dunglas force-pushed the ignore-annot branch from d94468a to dedda70 Compare April 21, 2020 10:52

chalasr approved these changes Apr 21, 2020

View reviewed changes

fabpot approved these changes Apr 24, 2020

View reviewed changes

[Serializer] Add an @ignore annotation

8526d7c

fabpot force-pushed the ignore-annot branch from dedda70 to 8526d7c Compare April 24, 2020 08:37

fabpot mentioned this pull request Apr 24, 2020

[Serializer] Add an @Ignore annotation symfony/symfony-docs#13585

Closed

fabpot merged commit 734a006 into symfony:master Apr 24, 2020

nicolas-grekas modified the milestones: next, 5.1 May 4, 2020

fabpot mentioned this pull request May 5, 2020

Release v5.1.0-BETA1 #36713

Merged

vasilvestre mentioned this pull request May 24, 2020

[Serializer] Add an @Ignore annotation #28744 symfony/symfony-docs#13701

Merged

mpiot mentioned this pull request Jul 16, 2020

Add support for the @Ignore annotation api-platform/api-platform#1566

Open

meyerbaptiste mentioned this pull request Dec 17, 2020

Add the @Ignore annotation support api-platform/core#3910

Merged

VincentLanglet mentioned this pull request Oct 28, 2024

[RFC] [Serializer] Introduce param config to drop the BC check in AbstractNormalizer::getAllowedAttributes #58697

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Serializer] Add an @Ignore annotation #28744

[Serializer] Add an @Ignore annotation #28744

dunglas commented Oct 5, 2018 •

edited

Loading

ro0NL Oct 6, 2018 •

edited

Loading

dunglas Jan 15, 2020

GuilhemN left a comment

OskarStark left a comment

Koc commented Oct 6, 2018 •

edited

Loading

fbourigault commented Oct 6, 2018

fabpot commented Mar 20, 2019

dunglas commented Mar 20, 2019

joelwurtz commented Mar 26, 2019

fbourigault commented Mar 27, 2019

joelwurtz commented Mar 27, 2019

dmaicher left a comment

joelwurtz commented Apr 6, 2019

raress96 commented Jan 3, 2020

dunglas commented Jan 15, 2020

nicolas-grekas left a comment

nicolas-grekas commented Feb 2, 2020

weaverryan left a comment

dunglas commented Mar 31, 2020

chalasr left a comment

fabpot commented Apr 24, 2020

vasilvestre commented May 23, 2020

[Serializer] Add an @Ignore annotation #28744

[Serializer] Add an @Ignore annotation #28744

Conversation

dunglas commented Oct 5, 2018 • edited Loading

ro0NL Oct 6, 2018 • edited Loading

Choose a reason for hiding this comment

dunglas Jan 15, 2020

Choose a reason for hiding this comment

GuilhemN left a comment

Choose a reason for hiding this comment

OskarStark left a comment

Choose a reason for hiding this comment

Koc commented Oct 6, 2018 • edited Loading

fbourigault commented Oct 6, 2018

fabpot commented Mar 20, 2019

dunglas commented Mar 20, 2019

joelwurtz commented Mar 26, 2019

fbourigault commented Mar 27, 2019

joelwurtz commented Mar 27, 2019

dmaicher left a comment

Choose a reason for hiding this comment

joelwurtz commented Apr 6, 2019

raress96 commented Jan 3, 2020

dunglas commented Jan 15, 2020

nicolas-grekas left a comment

Choose a reason for hiding this comment

nicolas-grekas commented Feb 2, 2020

weaverryan left a comment

Choose a reason for hiding this comment

dunglas commented Mar 31, 2020

chalasr left a comment

Choose a reason for hiding this comment

fabpot commented Apr 24, 2020

vasilvestre commented May 23, 2020

dunglas commented Oct 5, 2018 •

edited

Loading

ro0NL Oct 6, 2018 •

edited

Loading

Koc commented Oct 6, 2018 •

edited

Loading