Bugfix | Don't try to set null values when merging metadata

[stloyd]

Q	A
Bug fix?	yes
New feature?	no
BC breaks?	no
Deprecations?	no
Tickets	fixes #...
License	MIT

Fatal error:

TypeError: Argument 1 passed to ApiPlatform\Core\Metadata\Resource\ResourceMetadata::withDescription() must be of the type string, null given, called in /var/www/vendor/api-platform/core/src/Metadata/Resource/Factory/AnnotationResourceMetadataFactory.php on line 120

This was cause when trying to merge two metadata, parent & child ones. By default ApiPlatform\Core\Annotation\ApiResource (as well as parent here: ApiPlatform\Core\Metadata\Resource\ResourceMetadata) has some of fields marked as default = null, when merging right now it's not validated that child has value set, thus due too type-hint it fails with null values.

Dumps (parent + child):

^ ApiPlatform\Core\Metadata\Resource\ResourceMetadata^ {#9948
  -shortName: "Administrator"
  -description: null
  -iri: null
  -itemOperations: array:3 [
    "get" => []
    "put" => array:1 [
      "denormalization_context" => array:1 [
        "groups" => "admin_user:update"
      ]
    ]
    "delete" => []
  ]
  -collectionOperations: array:2 [
    "get" => []
    "post" => array:1 [
      "validation_groups" => array:2 [
        0 => "sylius"
        1 => "sylius_user_create"
      ]
    ]
  ]
  -subresourceOperations: null
  -graphql: null
  -attributes: array:4 [
    "route_prefix" => "admin"
    "normalization_context" => array:1 [
      "groups" => array:1 [
        0 => "admin_user:read"
      ]
    ]
    "denormalization_context" => array:1 [
      "groups" => array:1 [
        0 => "admin_user:create"
      ]
    ]
    "validation_groups" => "sylius"
  ]
}

ApiPlatform\Core\Annotation\ApiResource^ {#9922
  +collectionOperations: array:2 [
    0 => "get"
    "post" => array:2 [
      "security" => "is_granted('ROLE_ADMIN')"
      "security_message" => "Only admins can add doctors."
    ]
  ]
  +description: null
  +graphql: null
  +iri: null
  +itemOperations: array:2 [
    0 => "get"
    "patch" => array:1 [
      "security" => "is_granted('ROLE_ADMIN') or object == user"
    ]
  ]
  +shortName: null
  +subresourceOperations: null
  -cacheHeaders: null
  -denormalizationContext: null
  -deprecationReason: null
  -elasticsearch: null
  -fetchPartial: null
  -forceEager: null
  -formats: null
  -filters: null
  -hydraContext: null
  -input: null
  -maximumItemsPerPage: null
  -mercure: null
  -messenger: null
  -normalizationContext: null
  -openapiContext: null
  -order: null
  -output: null
  -paginationClientEnabled: null
  -paginationClientItemsPerPage: null
  -paginationClientPartial: null
  -paginationViaCursor: null
  -paginationEnabled: null
  -paginationFetchJoinCollection: null
  -paginationItemsPerPage: null
  -paginationMaximumItemsPerPage: null
  -paginationPartial: null
  -routePrefix: null
  -security: null
  -securityMessage: null
  -securityPostDenormalize: null
  -securityPostDenormalizeMessage: null
  -sunset: null
  -swaggerContext: null
  -validationGroups: null
  +attributes: array:3 [
    "route_prefix" => "%app.security.api_route%"
    "normalization_context" => array:1 [
      "groups" => array:1 [
        0 => "user:read"
      ]
    ]
    "denormalization_context" => array:1 [
      "groups" => array:1 [
        0 => "user:write"
      ]
    ]
  ]
}

[alanpoulain]

Could you try to add a non regression unit test?

[alanpoulain]

I think I see the issue, but could you give a little more context?
When does the problem occur exactly?

[stloyd]

Sylius has defined resources for i.e. admin user/shop user etc.
https://github.com/Sylius/Sylius/blob/1.8/src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/AdminUser.xml

But when you have own entities extending those base ones (which is 100% valid) and you add own @ApiResource it's not able to correctly "match" them (due too null issue reported here), nor it's not merging those definitions et all (which could be both bug and/or new feature).

[dunglas]

LGTM

[alanpoulain]

Thanks @stloyd.