Undefined array key "resource_class" in SerializerContextBuilder without even using API Platform

[emodric]

API Platform version(s) affected: 4.2.8

Description

When using custom value resolvers from Symfony, and when my request has a data POST variable, API Platform's PayloadArgumentResolver kicks in and tries to resolve if the request is an API Platform request.

This ultimately fails with a warning Warning: Undefined array key "resource_class" in ApiPlatform\Serializer\SerializerContextBuilder, preventing our custom request from working.

How to reproduce

Implement a custom value resolver in Symfony and have a post request with a data POST variable.

Possible Solution

Lower the priority of PayloadArgumentResolver in controller.argument_value_resolver to e.g. 255 so it does not interfere with the default priority of value resolvers.

[soyuka]

Could you show a stack trace? Why is this serializer context builder called if not in api platform context?

[emodric]

Can't right now as I am not near my computer, but if you take a look at PayloadArgumentResolver, it should be pretty obvious what is happening.

Basicaly, having a POST variable named data is enough to trigger the SerializerContextBuilder.

[emodric]

@soyuka Here's the stack trace.

Stack trace

"file": "vendor/api-platform/serializer/SerializerContextBuilder.php",
"line": 55,
"trace": [
    {
        "namespace": "",
        "short_class": "",
        "class": "",
        "type": "",
        "function": "",
        "file": "vendor/api-platform/serializer/SerializerContextBuilder.php",
        "line": 55,
        "args": []
    },
    {
        "namespace": "ApiPlatform\\Serializer",
        "short_class": "SerializerContextBuilder",
        "class": "ApiPlatform\\Serializer\\SerializerContextBuilder",
        "type": "->",
        "function": "createFromRequest",
        "file": "vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Serializer/ContextBuilder/AbstractInputContextBuilder.php",
        "line": 31,
        "args": []
    },
    {
        "namespace": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder",
        "short_class": "AbstractInputContextBuilder",
        "class": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder\\AbstractInputContextBuilder",
        "type": "->",
        "function": "createFromRequest",
        "file": "vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Serializer/ContextBuilder/AbstractInputContextBuilder.php",
        "line": 31,
        "args": []
    },
    {
        "namespace": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder",
        "short_class": "AbstractInputContextBuilder",
        "class": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder\\AbstractInputContextBuilder",
        "type": "->",
        "function": "createFromRequest",
        "file": "vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Serializer/ContextBuilder/ChannelContextBuilder.php",
        "line": 32,
        "args": []
    },
    {
        "namespace": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder",
        "short_class": "ChannelContextBuilder",
        "class": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder\\ChannelContextBuilder",
        "type": "->",
        "function": "createFromRequest",
        "file": "vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Serializer/ContextBuilder/AbstractInputContextBuilder.php",
        "line": 31,
        "args": []
    },
    {
        "namespace": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder",
        "short_class": "AbstractInputContextBuilder",
        "class": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder\\AbstractInputContextBuilder",
        "type": "->",
        "function": "createFromRequest",
        "file": "vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Serializer/ContextBuilder/LocaleContextBuilder.php",
        "line": 32,
        "args": []
    },
    {
        "namespace": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder",
        "short_class": "LocaleContextBuilder",
        "class": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder\\LocaleContextBuilder",
        "type": "->",
        "function": "createFromRequest",
        "file": "vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Serializer/ContextBuilder/HttpRequestMethodTypeContextBuilder.php",
        "line": 28,
        "args": []
    },
    {
        "namespace": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder",
        "short_class": "HttpRequestMethodTypeContextBuilder",
        "class": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder\\HttpRequestMethodTypeContextBuilder",
        "type": "->",
        "function": "createFromRequest",
        "file": "vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Serializer/ContextBuilder/AbstractInputContextBuilder.php",
        "line": 31,
        "args": []
    },
    {
        "namespace": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder",
        "short_class": "AbstractInputContextBuilder",
        "class": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder\\AbstractInputContextBuilder",
        "type": "->",
        "function": "createFromRequest",
        "file": "vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Serializer/ContextBuilder/AbstractInputContextBuilder.php",
        "line": 31,
        "args": []
    },
    {
        "namespace": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder",
        "short_class": "AbstractInputContextBuilder",
        "class": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder\\AbstractInputContextBuilder",
        "type": "->",
        "function": "createFromRequest",
        "file": "vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Serializer/ContextBuilder/AbstractInputContextBuilder.php",
        "line": 31,
        "args": []
    },
    {
        "namespace": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder",
        "short_class": "AbstractInputContextBuilder",
        "class": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder\\AbstractInputContextBuilder",
        "type": "->",
        "function": "createFromRequest",
        "file": "vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Serializer/ContextBuilder/AbstractInputContextBuilder.php",
        "line": 31,
        "args": []
    },
    {
        "namespace": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder",
        "short_class": "AbstractInputContextBuilder",
        "class": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder\\AbstractInputContextBuilder",
        "type": "->",
        "function": "createFromRequest",
        "file": "vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Serializer/ContextBuilder/AbstractInputContextBuilder.php",
        "line": 31,
        "args": []
    },
    {
        "namespace": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder",
        "short_class": "AbstractInputContextBuilder",
        "class": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder\\AbstractInputContextBuilder",
        "type": "->",
        "function": "createFromRequest",
        "file": "vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Serializer/ContextBuilder/AbstractInputContextBuilder.php",
        "line": 31,
        "args": []
    },
    {
        "namespace": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder",
        "short_class": "AbstractInputContextBuilder",
        "class": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder\\AbstractInputContextBuilder",
        "type": "->",
        "function": "createFromRequest",
        "file": "vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Serializer/ContextBuilder/AbstractInputContextBuilder.php",
        "line": 31,
        "args": []
    },
    {
        "namespace": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder",
        "short_class": "AbstractInputContextBuilder",
        "class": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder\\AbstractInputContextBuilder",
        "type": "->",
        "function": "createFromRequest",
        "file": "vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Serializer/ContextBuilder/AbstractInputContextBuilder.php",
        "line": 31,
        "args": []
    },
    {
        "namespace": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder",
        "short_class": "AbstractInputContextBuilder",
        "class": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder\\AbstractInputContextBuilder",
        "type": "->",
        "function": "createFromRequest",
        "file": "vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Serializer/ContextBuilder/AbstractInputContextBuilder.php",
        "line": 31,
        "args": []
    },
    {
        "namespace": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder",
        "short_class": "AbstractInputContextBuilder",
        "class": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder\\AbstractInputContextBuilder",
        "type": "->",
        "function": "createFromRequest",
        "file": "vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Serializer/ContextBuilder/AbstractInputContextBuilder.php",
        "line": 31,
        "args": []
    },
    {
        "namespace": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder",
        "short_class": "AbstractInputContextBuilder",
        "class": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder\\AbstractInputContextBuilder",
        "type": "->",
        "function": "createFromRequest",
        "file": "vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Serializer/ContextBuilder/AbstractInputContextBuilder.php",
        "line": 31,
        "args": []
    },
    {
        "namespace": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder",
        "short_class": "AbstractInputContextBuilder",
        "class": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder\\AbstractInputContextBuilder",
        "type": "->",
        "function": "createFromRequest",
        "file": "vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Serializer/ContextBuilder/PaymentRequestActionAwareContextBuilder.php",
        "line": 39,
        "args": []
    },
    {
        "namespace": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder",
        "short_class": "PaymentRequestActionAwareContextBuilder",
        "class": "Sylius\\Bundle\\ApiBundle\\Serializer\\ContextBuilder\\PaymentRequestActionAwareContextBuilder",
        "type": "->",
        "function": "createFromRequest",
        "file": "vendor/api-platform/serializer/SerializerFilterContextBuilder.php",
        "line": 44,
        "args": []
    },
    {
        "namespace": "ApiPlatform\\Serializer",
        "short_class": "SerializerFilterContextBuilder",
        "class": "ApiPlatform\\Serializer\\SerializerFilterContextBuilder",
        "type": "->",
        "function": "createFromRequest",
        "file": "vendor/api-platform/openapi/Serializer/SerializerContextBuilder.php",
        "line": 30,
        "args": []
    },
    {
        "namespace": "ApiPlatform\\OpenApi\\Serializer",
        "short_class": "SerializerContextBuilder",
        "class": "ApiPlatform\\OpenApi\\Serializer\\SerializerContextBuilder",
        "type": "->",
        "function": "createFromRequest",
        "file": "vendor/api-platform/symfony/Bundle/ArgumentResolver/PayloadArgumentResolver.php",
        "line": 78,
        "args": []
    },
    {
        "namespace": "ApiPlatform\\Symfony\\Bundle\\ArgumentResolver",
        "short_class": "PayloadArgumentResolver",
        "class": "ApiPlatform\\Symfony\\Bundle\\ArgumentResolver\\PayloadArgumentResolver",
        "type": "->",
        "function": "getExpectedInputClass",
        "file": "vendor/api-platform/symfony/Bundle/ArgumentResolver/PayloadArgumentResolver.php",
        "line": 51,
        "args": []
    },
    {
        "namespace": "ApiPlatform\\Symfony\\Bundle\\ArgumentResolver",
        "short_class": "PayloadArgumentResolver",
        "class": "ApiPlatform\\Symfony\\Bundle\\ArgumentResolver\\PayloadArgumentResolver",
        "type": "->",
        "function": "supports",
        "file": "vendor/api-platform/symfony/Bundle/ArgumentResolver/PayloadArgumentResolver.php",
        "line": 63,
        "args": []
    },
    {
        "namespace": "ApiPlatform\\Symfony\\Bundle\\ArgumentResolver",
        "short_class": "PayloadArgumentResolver",
        "class": "ApiPlatform\\Symfony\\Bundle\\ArgumentResolver\\PayloadArgumentResolver",
        "type": "->",
        "function": "resolve",
        "file": "vendor/symfony/http-kernel/Controller/ArgumentResolver/TraceableValueResolver.php",
        "line": 37,
        "args": []
    },
    {
        "namespace": "Symfony\\Component\\HttpKernel\\Controller\\ArgumentResolver",
        "short_class": "TraceableValueResolver",
        "class": "Symfony\\Component\\HttpKernel\\Controller\\ArgumentResolver\\TraceableValueResolver",
        "type": "->",
        "function": "resolve",
        "file": "vendor/symfony/http-kernel/Controller/ArgumentResolver.php",
        "line": 91,
        "args": []
    },
    {
        "namespace": "Symfony\\Component\\HttpKernel\\Controller",
        "short_class": "ArgumentResolver",
        "class": "Symfony\\Component\\HttpKernel\\Controller\\ArgumentResolver",
        "type": "->",
        "function": "getArguments",
        "file": "vendor/symfony/http-kernel/Controller/TraceableArgumentResolver.php",
        "line": 33,
        "args": []
    },
    {
        "namespace": "Symfony\\Component\\HttpKernel\\Controller",
        "short_class": "TraceableArgumentResolver",
        "class": "Symfony\\Component\\HttpKernel\\Controller\\TraceableArgumentResolver",
        "type": "->",
        "function": "getArguments",
        "file": "vendor/symfony/http-kernel/HttpKernel.php",
        "line": 175,
        "args": []
    },
    {
        "namespace": "Symfony\\Component\\HttpKernel",
        "short_class": "HttpKernel",
        "class": "Symfony\\Component\\HttpKernel\\HttpKernel",
        "type": "->",
        "function": "handleRaw",
        "file": "vendor/symfony/http-kernel/HttpKernel.php",
        "line": 76,
        "args": []
    },
    {
        "namespace": "Symfony\\Component\\HttpKernel",
        "short_class": "HttpKernel",
        "class": "Symfony\\Component\\HttpKernel\\HttpKernel",
        "type": "->",
        "function": "handle",
        "file": "vendor/symfony/http-kernel/Kernel.php",
        "line": 182,
        "args": []
    },
    {
        "namespace": "Symfony\\Component\\HttpKernel",
        "short_class": "Kernel",
        "class": "Symfony\\Component\\HttpKernel\\Kernel",
        "type": "->",
        "function": "handle",
        "file": "vendor/symfony/runtime/Runner/Symfony/HttpKernelRunner.php",
        "line": 35,
        "args": []
    },
    {
        "namespace": "Symfony\\Component\\Runtime\\Runner\\Symfony",
        "short_class": "HttpKernelRunner",
        "class": "Symfony\\Component\\Runtime\\Runner\\Symfony\\HttpKernelRunner",
        "type": "->",
        "function": "run",
        "file": "vendor/autoload_runtime.php",
        "line": 32,
        "args": []
    },
    {
        "namespace": "",
        "short_class": "",
        "class": "",
        "type": "",
        "function": "require_once",
        "file": "public/index.php",
        "line": 5,
        "args": [
            [
                "string",
                "vendor/autoload_runtime.php"
            ]
        ]
    }
]

[soyuka]

It looks like sylius is using our SerializerContextBuilder although its not in the context of an api platform operation, I suggest to open an issue on sylius repositories.

[emodric]

True, but this still boils down to API Platform taking over random request based solely on existence of data POST variable in PayloadArgumentResolver. PayloadArgumentResolver here is ran first, and then Sylius overides the SerializerContextBuilder

That's why my original suggestion was to lower the priority of the PayloadArgumentResolver value resolver in DI tag, to give chance for 1st party value resolvers (which will probably have a priority of 0) to work.

[soyuka]

Oh I see indeed there's no reason for it to call that code...

[soyuka]

thanks for the report

[emodric]

Thanks @soyuka !

[emodric]

@soyuka Additional question:

Can this fix be backported to 4.1 too? Issue happens there too.