[HttpKernel] Create `#[Serialize]` Attribute to serialize Controller Result #49518

Koc · 2023-02-23T22:06:49Z

Q	A
Branch?	6.3
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets	-
License	MIT
Doc PR	TBD

#[Serialize(code: 200, headers: [], serializationContext: [])] Allows automatically serialize Controller Result to format based on Request format.

Usage example 🔨

class Product
{
    public function __construct(public readonly int $id, public readonly string $name)
    {
    }
}

class GetProductController
{
    #[Serialize]
    public function __invoke(): Product
    {
        return new Product(1, 'Asus UX550');
    }
}

class ProductCreated
{
    public function __construct(public readonly int $id)
    {
    }
}

class CreateProductController
{
    #[Serialize(201)]
    public function __invoke(): ProductCreated
    {
        return new ProductCreated(1);
    }
}

# same controller without annotation: repeatable annoying boilerplate which has no sense to write
class CreateProductControllerLegacy
{
    public function __construct(private readonly SerializerInterface $serializer)
    {
    }

    #[OA\Response(response: 201, description: 'Successful response', content: new Model(type: ProductCreated::class))]
    public function __invoke(): JsonResponse
    {
        $data = new ProductCreated(1);
        $serialized = $this->serializer->serialize($data, 'json');

        return JsonResponse::fromJsonString($serialized, JsonResponse::HTTP_CREATED);
    }
}

Todo

add functional tests once [HttpKernel] Create Attributes #[MapRequestPayload] and #[MapQueryString] to map Request input to typed objects #49138 will be merged

src/Symfony/Component/HttpKernel/CHANGELOG.md

94noni · 2023-02-24T12:32:13Z

src/Symfony/Component/HttpKernel/Attribute/Serialize.php

+ * Controller tag to serialize response.
+ */
+#[\Attribute(\Attribute::TARGET_METHOD)]
+class Serialize


indeed, others attribute are prefixed with As when they describe more the config of the class (AsCommand or AsMessageHandler)
here it is like a mapping/transformation, perhaps like your other PR #49138 MapResponse

src/Symfony/Component/HttpKernel/EventListener/SerializeControllerResultListener.php

src/Symfony/Component/HttpKernel/Attribute/Serialize.php

src/Symfony/Component/HttpKernel/EventListener/SerializeControllerResultListener.php

yceruto · 2023-02-27T17:36:02Z

This test is failing https://github.com/symfony/symfony/actions/runs/4272061115/jobs/7436960556#step:7:8239

You probably have to add symfony/serializer as a dev dependency of the http-kernel component.

Koc · 2023-02-27T20:17:39Z

yes, thanx, it was added in #49138. I've not added it here to prevent merge conflicts. Also I want extend functional tests added in mentioned PR with new Attribute

nicolas-grekas · 2023-04-07T06:54:18Z

For what it's worth, I'm personally not convinced we should merge this. The reason is that the resulting behavior is very limited and resorting to explicit code comes very quickly - as soon as one needs more precise control over the resulting response for example. In the end, this saves two/three lines that are legit to have in a controller/similar to me.

Koc · 2023-04-07T08:39:06Z

Exactly, this can save few lines in the Controller and reduce boilerplate. Of course it can't cover all needs for an every project, but same applicable for other stuff provided by Framework. 80/20 rule in action. We have few microservices that uses only #[Serialize] Attribute without any kind of additional control for the Response.

We can go further and build OpenApi documentation based on Controller return type + Attribute existence via NelmioApiDocBundle. It will reduce even more boilerplate code for some projects.

Koc · 2023-04-22T10:49:09Z

Rebased, renamed context to serializationContext for consistency for Map* attributes. Test failures looks unrelated.

@nicolas-grekas please review 🙏

…Result

Koc · 2024-01-29T16:35:08Z

I've rebased PR one more time + fixed tests + actualized changelog.

And as I've already mentioned - this feature needed not only for reducing boilerplate of serialization but also for simplification of the OpenApi spec generation via NelmioApiDocBundle. They already successfully adopted #[MapRequestPayload/MapQueryString]. So, introduction of this attribute can be a good step forward in same direction.

DavidGarciaCat · 2024-02-01T11:33:50Z

src/Symfony/Component/HttpKernel/Attribute/Serialize.php

+ * @author Konstantin Myakshin <[email protected]>
+ */
+#[\Attribute(\Attribute::TARGET_METHOD)]
+final class Serialize


Shouldn't this #[Serialize] attribute allow to pass the groups to be used during the serialization process?

Also, the SerializerInterface and its serialize method allows us to pass the preferred format (JSON, XML, ...) so making it an argument (even with a predefined value) makes sense to me 🤔

==== EDIT ====

By the way: with "passing groups" I meant that they seem to be a relevant setting so maybe it's a good idea to add them with a shortcut (instead of passing them via context), but that's just a secondary matter - the primary concern here is the missing format:

$data = $this->serializer->serialize( data: $output, format: 'json', context: ['groups' => ['Group1', 'Group2']] );

so it could be like this:

#[Serialize(code: 201, format: 'json', headers: [], serializationContext: ['groups' => ['Group1', 'Group2']])]

or even

#[Serialize(code: 201, format: 'json', headers: [], groups: ['Group1', 'Group2'])]

rrajkomar · 2024-11-09T15:39:43Z

src/Symfony/Component/HttpKernel/Attribute/Serialize.php

+ * @author Konstantin Myakshin <[email protected]>
+ */
+#[\Attribute(\Attribute::TARGET_METHOD)]
+final class Serialize


Hi,
I think this is a great idea and would be very useful for anyone developing webservice so thank you.
However wouldn't it be more logical for consistency to name the attribute in the same manner as the others ?
Something like MapResponsePayload seems more intuitive IMHO.

this attributes can be renamed soon, see #58709

carsonbot added Status: Needs Review Feature labels Feb 23, 2023

carsonbot added this to the 6.3 milestone Feb 23, 2023

Koc commented Feb 23, 2023

View reviewed changes

src/Symfony/Component/HttpKernel/CHANGELOG.md Outdated Show resolved Hide resolved

Koc changed the title ~~Create #[SerializedResponse] Attribute to serialize Controller Result~~ [HttpKernel] Create #[SerializedResponse] Attribute to serialize Controller Result Feb 23, 2023

Koc force-pushed the feature/serialized-response branch from 8e54594 to 9e16d8c Compare February 23, 2023 22:36

This comment was marked as outdated.

Sign in to view

Koc force-pushed the feature/serialized-response branch from a30ee49 to 06087b9 Compare February 24, 2023 11:41

Koc changed the title ~~[HttpKernel] Create #[SerializedResponse] Attribute to serialize Controller Result~~ [HttpKernel] Create #[Serialized] Attribute to serialize Controller Result Feb 24, 2023

Koc changed the title ~~[HttpKernel] Create #[Serialized] Attribute to serialize Controller Result~~ [HttpKernel] Create #[Serialize] Attribute to serialize Controller Result Feb 24, 2023

94noni reviewed Feb 24, 2023

View reviewed changes

src/Symfony/Component/HttpKernel/EventListener/SerializeControllerResultListener.php Outdated Show resolved Hide resolved

94noni reviewed Feb 24, 2023

View reviewed changes

src/Symfony/Component/HttpKernel/EventListener/SerializeControllerResultListener.php Show resolved Hide resolved

stof reviewed Feb 24, 2023

View reviewed changes

Koc force-pushed the feature/serialized-response branch 2 times, most recently from 9eea8e6 to 9d1fb32 Compare February 25, 2023 22:13

Koc force-pushed the feature/serialized-response branch from 9d1fb32 to 3213f4b Compare March 6, 2023 22:16

Koc requested a review from dunglas as a code owner March 6, 2023 22:16

Koc force-pushed the feature/serialized-response branch 2 times, most recently from fbc4eae to ca0b60d Compare March 6, 2023 22:30

soyuka mentioned this pull request Mar 17, 2023

feat: declare ApiResource inside a symfony controller api-platform/core#5463

Closed

This comment was marked as outdated.

Sign in to view

ro0NL mentioned this pull request Mar 21, 2023

[RFC] AbstractController::noContent(): Response #49751

Closed

soyuka mentioned this pull request Mar 28, 2023

Reflection on API design with symfony #49842

Closed

Koc force-pushed the feature/serialized-response branch 2 times, most recently from 9845ae5 to f350273 Compare April 6, 2023 22:22

Koc force-pushed the feature/serialized-response branch 4 times, most recently from 8ee1da3 to 9058a4b Compare April 21, 2023 07:38

Koc force-pushed the feature/serialized-response branch from 9058a4b to ad86cea Compare April 22, 2023 10:40

nicolas-grekas modified the milestones: 6.3, 6.4 May 23, 2023

nicolas-grekas modified the milestones: 6.4, 7.1 Nov 15, 2023

Koc force-pushed the feature/serialized-response branch from ad86cea to 3c9a9b6 Compare January 29, 2024 16:15

[HttpKernel] Create #[Serialize] Attribute to serialize Controller …

490a4ad

…Result

Koc force-pushed the feature/serialized-response branch from 3c9a9b6 to 490a4ad Compare January 29, 2024 16:23

DjordyKoert mentioned this pull request Feb 1, 2024

[Symfony 7.1] support for Serialize attribute nelmio/NelmioApiDocBundle#2210

Open

DavidGarciaCat reviewed Feb 1, 2024

View reviewed changes

xabbuh modified the milestones: 7.1, 7.2 May 15, 2024

rrajkomar reviewed Nov 9, 2024

View reviewed changes

fabpot modified the milestones: 7.2, 7.3 Nov 20, 2024

fabpot modified the milestones: 7.3, 7.4 May 26, 2025

Uh oh!

[HttpKernel] Create #[Serialize] Attribute to serialize Controller Result #49518

Are you sure you want to change the base?

[HttpKernel] Create #[Serialize] Attribute to serialize Controller Result #49518

Uh oh!

Conversation

Koc commented Feb 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Usage example 🔨

Todo

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

94noni Feb 24, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yceruto commented Feb 27, 2023

Uh oh!

Koc commented Feb 27, 2023

Uh oh!

This comment was marked as outdated.

Uh oh!

nicolas-grekas commented Apr 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Koc commented Apr 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Koc commented Apr 22, 2023

Uh oh!

Koc commented Jan 29, 2024

Uh oh!

DavidGarciaCat Feb 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rrajkomar Nov 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Koc Nov 10, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

[HttpKernel] Create `#[Serialize]` Attribute to serialize Controller Result #49518

[HttpKernel] Create `#[Serialize]` Attribute to serialize Controller Result #49518

Koc commented Feb 23, 2023 •

edited

Loading

nicolas-grekas commented Apr 7, 2023 •

edited

Loading

Koc commented Apr 7, 2023 •

edited

Loading

DavidGarciaCat Feb 1, 2024 •

edited

Loading

rrajkomar Nov 9, 2024 •

edited

Loading