[Serializer] Added a ConstraintViolationListNormalizer #22150

lyrixx · 2017-03-24T16:22:25Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#11309
License	MIT
Doc PR	-

It seems logical to me that Symfony is able to serialise natively some very common Symfony data structure. (and requested by @nicolas-grekas & @javiereguiluz )

Usage example (from symfony/symfony-demo):

    /**
     * @Route("", name="api_blog_new")
     * @Method("POST")
     * @Security("is_granted('ROLE_ADMIN')")
     */
    public function newAction(Request $request)
    {
        $data = $request->getContent();

        $post = $this->get('serializer')->deserialize($data, Post::class, 'json', ['groups' => ['post_write']]);

        $post->setAuthor($this->getUser());

        $violations = $this->get('validator')->validate($post);

        $post->setSlug($this->get('slugger')->slugify($post->getTitle()));

        if (count($violations) > 0) {
            $repr = $this->get('serializer')->serialize($violations, 'json');

            return JsonResponse::fromJsonString($repr, 400);
        }

        $this->getDoctrine()->getManager()->persist($post);
        $this->getDoctrine()->getManager()->flush();

        $repr = $this->get('serializer')->serialize($post, 'json', ['groups' => ['post_read']]);

        return JsonResponse::fromJsonString($repr);
    }

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

javiereguiluz

👍 it looks like a useful feature to me! Thanks @lyrixx.

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

dunglas · 2017-03-28T13:00:29Z

The original implementation (https://github.com/api-platform/core/blob/master/src/Hydra/Serializer/ConstraintViolationListNormalizer.php) was following the Hydra W3C draft.

WDYT about keeping Hydra support in Symfony?

dunglas · 2017-03-28T13:03:10Z

Another alternative is to implement RFC7807 (supported by API Platform and Zend Apigility): https://github.com/api-platform/core/blob/master/src/Problem/Serializer/ConstraintViolationListNormalizer.php

javiereguiluz · 2017-03-28T13:16:33Z

RFC7807 looks like the ideal solution to create something standard ... but its status is still: "PROPOSED STANDARD". Can we guess the chances of being changed a lot in the future or even rejected?

lyrixx · 2017-03-29T12:52:06Z

I implemented RFC7807 (supported by API Platform and Zend Apigility)

fabpot · 2017-03-29T13:45:38Z

Can you add a note about the fact that it implements RFC7807 in the phpdocs?

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

lyrixx · 2017-04-03T14:13:49Z

Comment addressed. PR updated.

Note: I also renamed propertyPath to property_path`.

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

dunglas · 2017-04-03T14:18:55Z

Note: I also renamed propertyPath to property_path

Why this change? AFAIK, camel case is preferred (for instance, it's what Google and Schema.org use).

lyrixx · 2017-04-03T14:20:26Z

Ah ok. I will revert it so. Usually I prefer Snake Case in my array / API...

lyrixx · 2017-04-03T14:22:56Z

Reverted. The PR is now ready.

lyrixx · 2017-10-05T16:56:10Z

The status code can be passed through the context (it can be optional).

But it's not mandatory, and it's boring if you need to pass 4XX each time ... :/

lyrixx · 2018-02-16T14:22:35Z

I have rebased the PR ; it's not ready

lyrixx · 2018-03-14T14:06:03Z

Ping

fabpot · 2018-03-22T07:43:22Z

@lyrixx "it's not ready" -> I suppose you meant "it's now ready", right?

fabpot · 2018-03-22T07:47:55Z

src/Symfony/Component/Serializer/CHANGELOG.md

+   of objects that needs data insertion in constructor
+ * added an optional `default_constructor_arguments` option of context to specify a default data in
+   case the object is not initializable by its constructor because of data missing
+ * added optional `bool $escapeFormulas = false` argument to `CsvEncoder::__construct`


Looks like you haven't added anything here.

fabpot · 2018-03-22T07:48:08Z

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

+use Symfony\Component\Validator\ConstraintViolationListInterface;
+
+/**
+ * A normalizer that normalize a ConstraintViolationListInterface instance.


fabpot · 2018-03-22T07:48:53Z

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

+/**
+ * A normalizer that normalize a ConstraintViolationListInterface instance.
+ *
+ * This Normalizer implements RFC7807 {@link https://tools.ietf.org/html/rfc7807}.


If we're not fully compliant, it should be added here.

lyrixx · 2018-03-22T09:37:20Z

@lyrixx "it's not ready" -> I suppose you meant "it's now ready", right?

Oups, You are right.

I have addressed your comment. It should be OK now

fabpot

minor comment

fabpot · 2018-03-22T09:44:23Z

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

+/**
+ * A normalizer that normalizes a ConstraintViolationListInterface instance.
+ *
+ * This Normalizer implements partially RFC7807 {@link https://tools.ietf.org/html/rfc7807}.


I would say implements RFC7807 partially.

But can we be a bit more precise? Can we list what we do not support or how we diverge from the RFC? I think that would help our users.

Actually I re-read the RFC and came up to the same conclusion as @teohhanhui's comment.

We are allowed to omit the type property.

That's why I removed the "partially" because the normalizer do implement the RFC.

fabpot · 2018-03-23T07:59:25Z

Thank you @lyrixx.

@nicolas-grekas

… (lyrixx) This PR was merged into the 4.1-dev branch. Discussion ---------- [Serializer] Added a ConstraintViolationListNormalizer | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #11309 | License | MIT | Doc PR | - --- It seems logical to me that Symfony is able to serialise natively some very common Symfony data structure. (and requested by @nicolas-grekas & @javiereguiluz ) Usage example (from symfony/symfony-demo): ```php /** * @route("", name="api_blog_new") * @method("POST") * @Security("is_granted('ROLE_ADMIN')") */ public function newAction(Request $request) { $data = $request->getContent(); $post = $this->get('serializer')->deserialize($data, Post::class, 'json', ['groups' => ['post_write']]); $post->setAuthor($this->getUser()); $violations = $this->get('validator')->validate($post); $post->setSlug($this->get('slugger')->slugify($post->getTitle())); if (count($violations) > 0) { $repr = $this->get('serializer')->serialize($violations, 'json'); return JsonResponse::fromJsonString($repr, 400); } $this->getDoctrine()->getManager()->persist($post); $this->getDoctrine()->getManager()->flush(); $repr = $this->get('serializer')->serialize($post, 'json', ['groups' => ['post_read']]); return JsonResponse::fromJsonString($repr); } ``` Commits ------- 2a35d09 [Serializer] Added a ConstraintViolationListNormalizer

teohhanhui · 2018-05-16T15:40:54Z

src/Symfony/Component/Serializer/Tests/Normalizer/ConstraintViolationListNormalizerTest.php

+        ));
+
+        $expected = array(
+            'title' => 'An error occurred',


RFC 7807 is unambiguous on this point:

3.1. Members of a Problem Details Object

A problem details object can have the following members:

"type" (string) - ... When
this member is not present, its value is assumed to be
"about:blank".

4.2. Predefined Problem Types

This specification reserves the use of one URI as a problem type:

The "about:blank" URI [RFC6694], when used as a problem type,
indicates that the problem has no additional semantics beyond that of
the HTTP status code.

When "about:blank" is used, the title SHOULD be the same as the
recommended HTTP status phrase for that code (e.g., "Not Found" for
404, and so on), although it MAY be localized to suit client
preferences (expressed with the Accept-Language request header).

Please note that according to how the "type" member is defined
(Section 3.1), the "about:blank" URI is the default value for that
member. Consequently, any problem details object not carrying an
explicit "type" member implicitly uses this URI.

Perhaps:

{ "type": "/validation-error", "title": "Validation failed", ... }

@teohhanhui

…izer's RFC7807 compliance (dunglas) This PR was squashed before being merged into the 4.1 branch (closes #27292). Discussion ---------- [Serializer] Fix and improve constraintViolationListNormalizer's RFC7807 compliance | Q | A | ------------- | --- | Branch? | 4.1 | Bug fix? | yes | New feature? | no  | BC breaks? | no  | Deprecations? | yes| Tests pass? | yes  | Fixed tickets | #22150 (comment) | License | MIT | Doc PR | todo This PR fixes and improves [RFC 7807](https://tools.ietf.org/html/rfc7807#section-3.2) compliance of `ConstraintViolationListNormalizer` (introduced in 4.1): * As recommended, use a specific namespace for Symfony validation error (`http://symfony.com/doc/current/validation.html`, because it already exists and gives information about the error. * Allow to set all properties defined in the RFC using the serialization context * Remove the `detail` key if no detail is provided (according to the spec) * Change the Symfony specific extension to use the same terminology than the RFC itself (type and title) * Use the proper `urn:uuid` scheme (RFC 4122) for the UUID code (more standard, and improve hypermedia capabilities). ping @teohhanhui Commits ------- 3c789c6 [Serializer] Fix and improve constraintViolationListNormalizer's RFC7807 compliance

carsonbot added Status: Needs Review Serializer Feature labels Mar 24, 2017

lyrixx force-pushed the serializer-ConstraintViolationListNormalizer branch from 7fa114c to 1bea195 Compare March 24, 2017 16:23

theofidry reviewed Mar 24, 2017

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php Outdated Show resolved Hide resolved

javiereguiluz approved these changes Mar 24, 2017

View reviewed changes

src/Symfony/Component/Serializer/Normalizer/ConstraintViolationListNormalizer.php Outdated Show resolved Hide resolved

lyrixx force-pushed the serializer-ConstraintViolationListNormalizer branch from 1bea195 to 72d93ae Compare March 24, 2017 16:32

ro0NL reviewed Mar 24, 2017

View reviewed changes

src/Symfony/Component/Serializer/Normalizer/ConstraintViolationListNormalizer.php Outdated Show resolved Hide resolved

lyrixx force-pushed the serializer-ConstraintViolationListNormalizer branch 2 times, most recently from 93d6d61 to 9543d83 Compare March 27, 2017 13:04

nicolas-grekas added this to the 3.3 milestone Mar 28, 2017

dunglas requested changes Mar 28, 2017

View reviewed changes

src/Symfony/Component/Serializer/Normalizer/ConstraintViolationListNormalizer.php Show resolved Hide resolved

lyrixx force-pushed the serializer-ConstraintViolationListNormalizer branch 4 times, most recently from 3d9be72 to 13aabb3 Compare March 29, 2017 12:51

stof requested changes Mar 30, 2017

View reviewed changes

src/Symfony/Component/Serializer/Normalizer/ConstraintViolationListNormalizer.php Show resolved Hide resolved

lyrixx force-pushed the serializer-ConstraintViolationListNormalizer branch from 13aabb3 to 6024134 Compare April 3, 2017 14:13

ro0NL reviewed Apr 3, 2017

View reviewed changes

src/Symfony/Component/Serializer/Normalizer/ConstraintViolationListNormalizer.php Outdated Show resolved Hide resolved

lyrixx force-pushed the serializer-ConstraintViolationListNormalizer branch from 6024134 to 4d59983 Compare April 3, 2017 14:22

dunglas approved these changes Apr 3, 2017

View reviewed changes

nicolas-grekas modified the milestones: 3.4, 4.1 Oct 8, 2017

lyrixx force-pushed the serializer-ConstraintViolationListNormalizer branch from b82f7a6 to 82f6e0d Compare February 16, 2018 14:22

lyrixx force-pushed the serializer-ConstraintViolationListNormalizer branch from 82f6e0d to 3bcbc5a Compare February 16, 2018 15:11

fabpot requested changes Mar 22, 2018

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Mar 22, 2018

lyrixx force-pushed the serializer-ConstraintViolationListNormalizer branch from 3bcbc5a to 971ddb5 Compare March 22, 2018 09:35

fabpot approved these changes Mar 22, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Work labels Mar 22, 2018

[Serializer] Added a ConstraintViolationListNormalizer

2a35d09

lyrixx force-pushed the serializer-ConstraintViolationListNormalizer branch from 971ddb5 to 2a35d09 Compare March 22, 2018 09:58

fabpot merged commit 2a35d09 into symfony:master Mar 23, 2018

javiereguiluz mentioned this pull request Mar 23, 2018

[Serializer] Added a ConstraintViolationListNormalizer symfony/symfony-docs#9480

Closed

lyrixx deleted the serializer-ConstraintViolationListNormalizer branch May 3, 2018 08:38

fabpot mentioned this pull request May 7, 2018

Release v4.1.0-BETA1 #27181

Merged

teohhanhui reviewed May 16, 2018

View reviewed changes

dunglas mentioned this pull request May 17, 2018

[Serializer] Fix and improve constraintViolationListNormalizer's RFC7807 compliance #27292

Merged

teohhanhui mentioned this pull request May 18, 2018

Why not add Constraint code to violations response data api-platform/core#1956

Closed

lyrixx mentioned this pull request Jul 3, 2018

[Validator] Document each constraint code symfony/symfony-docs#10001

Closed

dunglas mentioned this pull request Sep 24, 2019

[Serializer] Add FlattenExceptionNormalizer / Fix messenger used with the serializer component #33650

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Serializer] Added a ConstraintViolationListNormalizer #22150

[Serializer] Added a ConstraintViolationListNormalizer #22150

lyrixx commented Mar 24, 2017 •

edited by javiereguiluz

Loading

javiereguiluz left a comment

dunglas commented Mar 28, 2017

dunglas commented Mar 28, 2017

javiereguiluz commented Mar 28, 2017

lyrixx commented Mar 29, 2017

fabpot commented Mar 29, 2017

lyrixx commented Apr 3, 2017

dunglas commented Apr 3, 2017

lyrixx commented Apr 3, 2017

lyrixx commented Apr 3, 2017

lyrixx commented Oct 5, 2017

lyrixx commented Feb 16, 2018 •

edited

Loading

lyrixx commented Mar 14, 2018

fabpot commented Mar 22, 2018

fabpot Mar 22, 2018

fabpot Mar 22, 2018

fabpot Mar 22, 2018

lyrixx commented Mar 22, 2018

fabpot left a comment

fabpot Mar 22, 2018

lyrixx Mar 22, 2018

fabpot commented Mar 23, 2018

teohhanhui May 16, 2018

[Serializer] Added a ConstraintViolationListNormalizer #22150

[Serializer] Added a ConstraintViolationListNormalizer #22150

Conversation

lyrixx commented Mar 24, 2017 • edited by javiereguiluz Loading

javiereguiluz left a comment

Choose a reason for hiding this comment

dunglas commented Mar 28, 2017

dunglas commented Mar 28, 2017

javiereguiluz commented Mar 28, 2017

lyrixx commented Mar 29, 2017

fabpot commented Mar 29, 2017

lyrixx commented Apr 3, 2017

dunglas commented Apr 3, 2017

lyrixx commented Apr 3, 2017

lyrixx commented Apr 3, 2017

lyrixx commented Oct 5, 2017

lyrixx commented Feb 16, 2018 • edited Loading

lyrixx commented Mar 14, 2018

fabpot commented Mar 22, 2018

fabpot Mar 22, 2018

Choose a reason for hiding this comment

fabpot Mar 22, 2018

Choose a reason for hiding this comment

fabpot Mar 22, 2018

Choose a reason for hiding this comment

lyrixx commented Mar 22, 2018

fabpot left a comment

Choose a reason for hiding this comment

fabpot Mar 22, 2018

Choose a reason for hiding this comment

lyrixx Mar 22, 2018

Choose a reason for hiding this comment

fabpot commented Mar 23, 2018

teohhanhui May 16, 2018

Choose a reason for hiding this comment

lyrixx commented Mar 24, 2017 •

edited by javiereguiluz

Loading

lyrixx commented Feb 16, 2018 •

edited

Loading