Bug: data.meta ignored in relationships

[BurningDog]

Detailed description

A JSON:API resource linkage in a relationship object may also include a meta member, but json-api-client doesn't check for this, which is a bug.

Specifically, I'm integrating with a Drupal 9.1.0 JSON:API in which I've enabled the Drupal consumer_image_styles module in order to add image style information to an image field in a content entity. The relevant part in the relationships API response looks like this:

"field_header_image": {
  "data": {
    "type": "file--file",
    "id": "bb7912a9-81ed-4c58-8e11-37d4d619e8a5",
    "meta": {
      "alt": "",
      "title": "",
      "width": 1920,
      "height": 1280,
      "imageDerivatives": {
        "links": {
          "header": {
            "href": "https://example.com/sites/default/files/styles/header/public/header/2021-01/about-us-header.jpeg?h=e5aec6c8&itok=qXnhaDF4",
            "meta": {
              "rel": [
                "drupal://jsonapi/extensions/consumer_image_styles/links/relation-types/#derivative"
              ]
            }
          },
          "header_600x431_": {
            "href": "https://example.com/sites/default/files/styles/header_600x431_/public/header/2021-01/about-us-header.jpeg?h=e5aec6c8&itok=qEH6iDvL",
            "meta": {
              "rel": [
                "drupal://jsonapi/extensions/consumer_image_styles/links/relation-types/#derivative"
              ]
            }
          }
        }
      }
    }
  }

Note that meta is a property of data.

The place in the code which should check for this is in the ItemParser's parseRelationshipData().

Instead, the return should be changed to:

        $item = $this->getItemInstance($data->type)->setId($data->id);
        if (property_exists($data, 'meta')) {
            $item->setMeta($this->metaParser->parse($data->meta));
        }
        return $item;

Context

This helps me integrate with a Drupal JSON:API so that I can get various resized images.

My environment

• PHP 7.4
• Mac OS 10.14.6 running Valet

[BurningDog]

This is so we can check we're getting specific information back, and not accidentally returning the other Meta object.

[JaZo]

Thanks, you are absolutely right! I've also added the meta to plural relations in Item::getRelationships and updated the test.

[JaZo]

Released in 1.3.3!

[BurningDog]

Thanks for the quick turn-around!