[Serializer] Rename CacheableSupportsMethodInterface to VaryingSupportInterface #27210

teohhanhui · 2018-05-09T12:50:28Z

Q	A
Branch?	4.1
Bug fix?	no
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	N/A
License	MIT
Doc PR	N/A

Follow up from #27105.

teohhanhui · 2018-05-09T12:51:47Z

/cc @dunglas

Bug label was a mistake.

teohhanhui · 2018-05-09T13:14:27Z

Travis CI build errored due to network issues...

nicolas-grekas · 2018-05-09T17:50:33Z

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

@@ -150,9 +150,9 @@ public function setIgnoredAttributes(array $ignoredAttributes)
    /**
     * {@inheritdoc}
     */
-    public function hasCacheableSupportsMethod(): bool
+    public function isSupportsVaryByData(): bool


I'm not english-native, but I feel like this should be either "doesSupportsVaryByDataInterface" or "isSupportsVaryingByDataInterface". The context should also be taken into account, so that this could be "doesSupportsVaryByDataOrContextInterface".

All in all, I'm not sure the new name is better. But I'll let others decide since I'm biased, by being the author of the original proposal.

supportsMethodVaries, hasVaryingSupportsMethod? But I'm not really convinced either.

I'll improve it. 😄

teohhanhui · 2018-05-11T12:46:56Z

Search for "varying support" on some English corpus (actually the plural is corpora):

https://corpus.byu.edu/coca/
https://corpus.byu.edu/glowbe/

They don't support direct links.

teohhanhui · 2018-05-11T12:54:31Z

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

@@ -12,15 +12,16 @@
 namespace Symfony\Component\Serializer\Normalizer;


I've removed any mention about caching, because that is an implementation detail of what the serializer does with classes implementing this interface. I think it's better to have a pure abstraction here.

If necessary, we could document it in the Serializer class. WDYT @nicolas-grekas @dunglas?

dunglas · 2018-05-11T13:08:23Z

I like this one (VaryingSupportInterface) 👍

teohhanhui · 2018-05-11T13:09:01Z

Current proposed method name:
isVaryingSupportByData

Interpretation:
Is this normalizer and/or denormalizer varying its support by the data provided?

Alternative proposed method name:
isSupportVariedByData

Interpretation:
Is this normalizer and/or denormalizer's support varied by the data provided?

Yes, "varied by" fares very well in the above mentioned corpus (corpora). But I'm concerned that it might be misinterpreted as:
Does this normalizer and/or denormalizer support (some kind of?) varied (thing?) by data???

Which might cause some confusion...

dunglas · 2018-05-11T13:09:21Z

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

@@ -150,9 +150,9 @@ public function setIgnoredAttributes(array $ignoredAttributes)
    /**
     * {@inheritdoc}
     */
-    public function hasCacheableSupportsMethod(): bool
+    public function isVaryingSupportByData(): bool


I propose: isVaryingSupport (it can also vary depending of the context).

I'd prefer that we make it explicit in the method name.

teohhanhui · 2018-05-11T13:17:21Z

Okay, it seems like "varied on" is the right phrase.

Source: the above mentioned corpus / corpora.

…tInterface

teohhanhui · 2018-05-14T18:54:40Z

/ping @dunglas @nicolas-grekas @ogizanagi

ogizanagi · 2018-05-14T19:15:00Z

None of us are native-english speakers, so I think we should ask someone who is.
At least "varied by" sounds really weird to me, "varied on" probably is better (so 👍 ).

EDIT: actually, isSupportVaryingOn* looks more correct to me.

weaverryan · 2018-05-14T19:37:34Z

I actually prefer the old name :).

But, if we're going to change it, from an English perspective:

A) VaryingSupportsInterface with an "s". I saw the reason for removing the "s" earlier. But, we're talking about whether or not the supports() method can be cached/varies. I think NOT having the "s" complicates things

B) doesSupportsVary() or doesSupportsVaryOnDataOrContext (but the second is long). I know that we like using is as a prefix, but it just doesn't sound right here.

Sorry to muck things up further :)

ogizanagi · 2018-05-14T19:54:50Z

👍 doesSupportsVary for me. Thanks @weaverryan

dunglas · 2018-05-14T19:55:30Z

Keeping the old name for me (doesSupportsVary is my second choice)

fabpot · 2018-05-14T20:03:48Z

Naming is really hard :) I'm not a big fan of the current name (and don't have any great idea for better names), but I think that the current naming is still better than the alternatives.

teohhanhui · 2018-05-14T20:10:54Z

@weaverryan

But, we're talking about whether or not the supports() method can be cached/varies.

I should explain the rationale in depth. What I'm doing here is to use "support" as a noun, i.e. the concept of whether the normalizer supports normalizing / denormalizing a certain something. The previous interface name was bad for 2 major reasons:

It clearly says "cacheable" when in fact, that might or might not be the case.
It directly refers to the "supports method" which makes it a confusing abstraction.

By changing it to an interface which says how this support may vary, we borrow the same concept from the HTTP Vary header.

nicolas-grekas · 2018-05-14T20:18:11Z

HTTP vary is a list of what it varies-by. Here it's a boolean. The what is thus abstract.
I think we should close now: I'm pretty sure we're growing frustration on your side because you might feel we don't get your point. I do, I promise, and I'm confident enough others get your point also, and still expressed a preference for the status quo, which is a good enough sign to move forward and not spend more time here IMHO.

teohhanhui · 2018-05-14T20:19:53Z

I'll do one last attempt.

variesSupportOnDataAndContext
canVarySupportByDataAndContext (I think this is the least confusing)
doesSupportVaryByDataAndContext

teohhanhui · 2018-05-14T21:14:13Z

I've thought of a different way that involves more than a naming change. I need to try and see if it'll actually work, but if it does I'm confident that it'll be accepted. Stay tuned!

teohhanhui · 2018-05-16T14:34:28Z

Never mind. I tried to implement my idea, but it doesn't work:

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Symfony\Component\Serializer\Normalizer;

/**
 * Defines the interface for checking normalization / denormalization support,
 * where the result of the check may be safely cached.
 *
 * @author Kévin Dunglas <[email protected]>
 */
interface CacheableSupportInterface
{
    /**
     * Checks whether the specified type and format is supported for
     * normalization and denormalization.
     * 
     * If the return value is null, it means that support could not be
     * determined based on these criteria alone. Support will have to be
     * checked using the {@see NormalizableInterface::supportsNormalization} /
     * {@see DenormalizableInterface::supportsDenormalization} methods.
     */
    public function supports(string $type, ?string $format = null): ?bool;
}

carsonbot added Status: Needs Review Serializer Bug labels May 9, 2018

dunglas removed the Bug label May 9, 2018

dunglas requested a review from nicolas-grekas May 9, 2018 12:53

nicolas-grekas reviewed May 9, 2018

View reviewed changes

nicolas-grekas added this to the 4.1 milestone May 9, 2018

teohhanhui force-pushed the rename/serializer-supports-cacheable branch from 72de9df to 2fb8ce9 Compare May 11, 2018 10:02

teohhanhui changed the title ~~[Serializer] Rename CacheableSupportsMethodInterface to SupportsVaryInterface~~ [Serializer] Rename CacheableSupportsMethodInterface to VaryingSupportInterface May 11, 2018

teohhanhui force-pushed the rename/serializer-supports-cacheable branch from 2fb8ce9 to da5038b Compare May 11, 2018 12:48

teohhanhui commented May 11, 2018

View reviewed changes

dunglas reviewed May 11, 2018

View reviewed changes

[Serializer] Rename CacheableSupportsMethodInterface to VaryingSuppor…

5a1f084

…tInterface

teohhanhui force-pushed the rename/serializer-supports-cacheable branch from da5038b to 5a1f084 Compare May 11, 2018 13:22

teohhanhui closed this May 14, 2018

teohhanhui deleted the rename/serializer-supports-cacheable branch May 16, 2018 14:34

		@@ -12,15 +12,16 @@
		namespace Symfony\Component\Serializer\Normalizer;

Uh oh!

[Serializer] Rename CacheableSupportsMethodInterface to VaryingSupportInterface #27210

[Serializer] Rename CacheableSupportsMethodInterface to VaryingSupportInterface #27210

Uh oh!

Conversation

teohhanhui commented May 9, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

teohhanhui commented May 9, 2018

Uh oh!

teohhanhui commented May 9, 2018

Uh oh!

nicolas-grekas May 9, 2018 • 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!

ogizanagi May 9, 2018

Choose a reason for hiding this comment

Uh oh!

teohhanhui May 11, 2018

Choose a reason for hiding this comment

Uh oh!

teohhanhui commented May 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

teohhanhui May 11, 2018 • 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!

dunglas commented May 11, 2018

Uh oh!

teohhanhui commented May 11, 2018

Uh oh!

dunglas May 11, 2018

Choose a reason for hiding this comment

Uh oh!

teohhanhui May 11, 2018

Choose a reason for hiding this comment

Uh oh!

teohhanhui commented May 11, 2018

Uh oh!

teohhanhui commented May 14, 2018

Uh oh!

ogizanagi commented May 14, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

weaverryan commented May 14, 2018

Uh oh!

ogizanagi commented May 14, 2018

Uh oh!

dunglas commented May 14, 2018

Uh oh!

fabpot commented May 14, 2018

Uh oh!

teohhanhui commented May 14, 2018

Uh oh!

nicolas-grekas commented May 14, 2018

Uh oh!

teohhanhui commented May 14, 2018

Uh oh!

teohhanhui commented May 14, 2018

Uh oh!

teohhanhui commented May 16, 2018

Uh oh!

Uh oh!

teohhanhui commented May 9, 2018 •

edited

Loading

nicolas-grekas May 9, 2018 •

edited

Loading

teohhanhui commented May 11, 2018 •

edited

Loading

teohhanhui May 11, 2018 •

edited

Loading

ogizanagi commented May 14, 2018 •

edited

Loading