[Serializer] Improve performance by exposing supports-never/-always #45779

Jeroeny · 2022-03-18T10:30:10Z

Q	A
Branch?	6.3
Bug fix?	no
New feature?	yes
Deprecations?	Likely yes
License	MIT
Doc PR	Not yet initiated

Description

In the Serializer component, there is a CacheableSupportsMethodInterface. It can indicate the fact the normalizer's supports* method result can be cached.
Unfortunately, every normalizer that determines this result using $context cannot have its result cached (because it's based on format+type).

However there is some information with that supports call that often can be cached. Which is when a normalizer never supports a format+type, regardless of context.

For example:

public function supportsNormalization(mixed $data, string $format = null /*, array $context = [] */)
{
    return $data instanceof DateTime && ($context['DB_TYPES') ?? false);
}

This normalizer would not be able to have its result cached. Even though we know that if the $data is not an instance of DateTime, it will never be supported, regardless of $context.

Solution(s)

This pull request proposes to introduce the ability to return always/never supports $format+$type, to increase performance.
By introducing or altering a method to return one of 4 values:

support never
support not
support
support always

There are multiple ways to achieve this.

The one that is done in this PR for now, is to use the existing supportsNormalization method.
It would be changed to allow it to return one of the enum values (e.g. using integers -1 to 2, or bitwise), while still allowing bool return for backwards compatibilty.
This has the advantage of only needing one method for the caching and supports information. And no extra interfaces, so CacheableSupportsMethodInterface can be deprecated.

With this, the example from earlier would become:

public function supportsNormalization(mixed $data, string $format = null /*, array $context = [] */)
{
    if (! $data instanceof DateTime) {
        return SUPPORT_NEVER; // a const, or could use an enum/integer directly
    }

    return ($context['DB_TYPES') ?? false) ? SUPPORT : SUPPORT_NOT;
}

A new method CacheableSupportsInterface::supportsNormalizationCached($data, $format, $context): int. Possibly with a trait that implements the supportsNormalization to prevent duplicate logic (by doing return $this->supportsNormalizationCached(..) >= SUPPORT).

The solutions apply to both normalization and denormalization.

Performance impact example

If there are 10 (de)normalizers, that cannot use CacheableSupportsMethodInterface because of $context, but can return SUPPORT_NEVER like the example above.
The last of the normalizers supports the DateTime type.

Now you normalize a $dateTime 1000 times:

Before: 10.000 calls to supportsNormalization() and iterated over 10.010 $cached normalizers .
After: 1.009 calls to supportsNormalization() and iterated over 1.010 $cached normalizers ($this->normalizerCache[$format][DateTime::class] now only contains the one relevant normalizer).

A decrease in method calls of 89.91%.

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

src/Symfony/Component/Serializer/Serializer.php

carsonbot · 2022-03-19T06:32:23Z

Hey!

I think @mtarld has recently worked with this code. Maybe they can help review this?

Cheers!

Carsonbot

Jeroeny · 2022-04-13T12:29:31Z

Is release 6.1 feature-locked yet, or could this still be considered for it ?

Jeroeny · 2022-04-25T11:45:29Z

@dunglas Github has autosuggested you as reviewer. Do you think that's correct or would there be a better fit that I could contact for a review? Thanks

dunglas

Some nitpicking, otherwise LGTM.

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

src/Symfony/Component/Serializer/Serializer.php

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

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

chalasr · 2022-04-26T23:11:25Z

Can you rebase and add a changelog entry?

chalasr · 2022-04-27T09:19:24Z

Actually I'd prefer to let us more time to review this change as I'm not fond of the proposed API.
Postponing to 6.2 if you don't mind. Thanks

Jeroeny · 2022-04-28T07:15:37Z

@chalasr Alright, do you have any suggestion for the implementation ?

chalasr · 2022-04-28T08:33:11Z

@Jeroeny not yet, we're focus on stabilizing 6.1 right now. But I'm confident giving us some more time will allow us to explore other possibilities, even if we stick to this one in the end.

Jeroeny · 2022-06-12T16:12:03Z

Rebased and targeting 6.2. Added changelog entry (even though it may still change).

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

src/Symfony/Component/Serializer/Serializer.php

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

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

src/Symfony/Component/Serializer/Serializer.php

src/Symfony/Component/Serializer/CHANGELOG.md

src/Symfony/Component/Serializer/Serializer.php

mtarld · 2022-10-12T14:32:34Z

src/Symfony/Component/Serializer/Serializer.php

                return $normalizer;
            }
        }

        return null;
    }

+    private function supportsNormalizationWrapper(NormalizerInterface $normalizer, mixed $data, ?string $format, array $context): CacheableSupport


Maybe we can find a more meaningful name for that private method?
Or at least add a comment telling that is a BC layer?

Added a comment. The name could be better indeed, but haven't thought of anything better yet, am open to suggestions.

mtarld · 2022-10-12T14:34:34Z

src/Symfony/Component/Serializer/Tests/SerializerTest.php

+        $this->assertFalse($serializer->supportsNormalization(new \StdClass(), 'json', ['TEST_CONTEXT' => true]));
+        $this->assertFalse($serializer->supportsNormalization(new \StdClass(), 'json', ['TEST_CONTEXT' => true]));
+        $this->assertFalse($serializer->supportsNormalization(new \StdClass(), 'json', ['TEST_CONTEXT' => true]));
+    }


Maybe we can test the SupportNever as well?

This is testing that, by calling supports.. multiple times and ensuring supportsNormalization is only called 3 times instead of 5.

$normalizer ->expects($this->exactly(3)) ->method('supportsNormalization')

Unless you'd say something more explicit could be added?

…ate supports-never, -always

nicolas-grekas · 2023-02-08T10:55:51Z

Thanks for giving this a try. I think the approach in #49291 might provide better results.

nicolas-grekas · 2023-02-11T09:29:50Z

Closing in favor #49291, thanks again.

…better performance (tucksaun, nicolas-grekas) This PR was merged into the 6.3 branch. Discussion ---------- [Serializer] Add methods `getSupportedTypes` to allow better performance | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | no | New feature? | yes | Deprecations? | yes (new method in the interfaces, one interface deprecated) | License | MIT | Doc PR | to be written The PRs allows normalizers or denormalizers to expose their supported types and the associated cacheability to the Serializer. With this info, even if the `supports*` call is not cacheable, the Serializer can skip a ton of method calls to `supports*` improving performance substaintially in some cases: ![Screenshot 2023-02-02 at 15 46 49](https://user-images.githubusercontent.com/870118/217378926-03aa77e8-d80e-4bdd-b5dc-acc3602b70b3.png) <details> <summary>I found this design while working on a customer project performance (a big app built around API Platform): we reached the point where the slowest part of main application endpoint was `Symfony\Component\Serializer\Serializer::getNormalizer`.</summary> After some digging, we found out we were experiencing the conjunction of two phenomenons: - the application is quite complex and returns deep nested and repeating structures, exposing the underlying bottleneck; - and a lot of custom non-cacheable normalizers. Because most of the normalizers are not cacheable, the Serializer has to call every normalizer over and over again leading `getNormalizer` to account for 20% of the total wall time: ![Screenshot 2023-02-07 at 16 56 02](https://user-images.githubusercontent.com/870118/217375680-e7d33db2-fd6a-4ef0-b8d0-34d0eac8cf09.png) We first tried to improve cacheability based on context without much success, then an approach similar to #45779 with some success but still feeling this could be faster. We then thought that even if the `supportsNormalization` could not be cached (because of the context), maybe we could avoid the calls at the origin by letting the `Normalizers` expose the types they support and came to this PR with pretty good results. </details> The perfornance improvement was only measured by adapting Symfony's normalizers as well as the project ones, proper third party normalizers updates should improve performance even more. This should effectively replaces the `CacheableSupportsMethodInterface` as the cacheability can now be returned by `getSupportedTypes`. Commits ------- e5af24a [Serializer] Add wildcard support to getSupportedTypes() 400685a [Serializer] Add methods `getSupportedTypes` to allow better performance

Jeroeny requested a review from dunglas as a code owner March 18, 2022 10:30

carsonbot added Status: Needs Review Feature Serializer labels Mar 18, 2022

carsonbot added this to the 6.1 milestone Mar 18, 2022

Jeroeny commented Mar 18, 2022

View reviewed changes

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

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

dunglas requested changes Apr 25, 2022

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Apr 25, 2022

Jeroeny commented Apr 26, 2022

View reviewed changes

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

Jeroeny requested a review from dunglas April 26, 2022 12:10

carsonbot added Status: Needs Review and removed Status: Needs Work labels Apr 26, 2022

chalasr modified the milestones: 6.1, 6.2 Apr 27, 2022

Jeroeny force-pushed the serializer branch from 1c11ba0 to 315d69e Compare June 12, 2022 16:08

chalasr self-requested a review June 12, 2022 16:25

mtarld reviewed Oct 7, 2022

View reviewed changes

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

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

Jeroeny force-pushed the serializer branch from 3219561 to d9cb0aa Compare October 12, 2022 11:28

mtarld requested changes Oct 12, 2022

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Oct 12, 2022

Jeroeny force-pushed the serializer branch from d9cb0aa to 698eb25 Compare October 13, 2022 07:57

Jeroeny requested review from mtarld and removed request for dunglas and chalasr October 13, 2022 08:03

carsonbot added Status: Needs Review and removed Status: Needs Work labels Oct 13, 2022

Jeroeny requested review from dunglas and removed request for mtarld October 13, 2022 08:04

Jeroeny force-pushed the serializer branch from 698eb25 to c66985e Compare October 13, 2022 08:59

nicolas-grekas modified the milestones: 6.2, 6.3 Nov 5, 2022

Jeroeny force-pushed the serializer branch 2 times, most recently from 694b252 to 0fb7743 Compare November 30, 2022 12:43

Jeroeny requested review from mtarld and removed request for dunglas November 30, 2022 12:44

introduce int values as return of supports(de)Normalization, to indic…

ab78c9c

…ate supports-never, -always

Jeroeny force-pushed the serializer branch from 0fb7743 to ab78c9c Compare November 30, 2022 12:49

Jeroeny mentioned this pull request Feb 7, 2023

[Serializer] Improve normalization performance? #49196

Closed

tucksaun mentioned this pull request Feb 7, 2023

[Serializer] Add methods getSupportedTypes to allow better performance #49291

Merged

nicolas-grekas closed this Feb 11, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Serializer] Improve performance by exposing supports-never/-always #45779

[Serializer] Improve performance by exposing supports-never/-always #45779

Jeroeny commented Mar 18, 2022 •

edited

Loading

carsonbot commented Mar 19, 2022

Jeroeny commented Apr 13, 2022

Jeroeny commented Apr 25, 2022

dunglas left a comment

chalasr commented Apr 26, 2022 •

edited

Loading

chalasr commented Apr 27, 2022

Jeroeny commented Apr 28, 2022

chalasr commented Apr 28, 2022

Jeroeny commented Jun 12, 2022

mtarld Oct 12, 2022

Jeroeny Oct 13, 2022

mtarld Oct 12, 2022

Jeroeny Oct 13, 2022

nicolas-grekas commented Feb 8, 2023

nicolas-grekas commented Feb 11, 2023

[Serializer] Improve performance by exposing supports-never/-always #45779

[Serializer] Improve performance by exposing supports-never/-always #45779

Conversation

Jeroeny commented Mar 18, 2022 • edited Loading

carsonbot commented Mar 19, 2022

Jeroeny commented Apr 13, 2022

Jeroeny commented Apr 25, 2022

dunglas left a comment

Choose a reason for hiding this comment

chalasr commented Apr 26, 2022 • edited Loading

chalasr commented Apr 27, 2022

Jeroeny commented Apr 28, 2022

chalasr commented Apr 28, 2022

Jeroeny commented Jun 12, 2022

mtarld Oct 12, 2022

Choose a reason for hiding this comment

Jeroeny Oct 13, 2022

Choose a reason for hiding this comment

mtarld Oct 12, 2022

Choose a reason for hiding this comment

Jeroeny Oct 13, 2022

Choose a reason for hiding this comment

nicolas-grekas commented Feb 8, 2023

nicolas-grekas commented Feb 11, 2023

Jeroeny commented Mar 18, 2022 •

edited

Loading

chalasr commented Apr 26, 2022 •

edited

Loading