Dynamic Entity Reference normalization support

I'm surprised that A) this broke, B) nobody reported that all this time, especially since DER author @jibran has been quite active! Will look at this tomorrow.

Thank you so much for the patch, that's super helpful! 👍 🙏

I'm surprised that A) this broke, B) nobody reported that all this time

haha, there is DynamicEntityReferenceItemNormalizer in DER and I thought that would be enough but it only supports hal.

I'm happy to fix it in DER which we can as per #2926507-39: Discourage @FieldType-level normalizers, encourage @DataType-level normalizers, to strengthen the API-First ecosystem. @Wim Leers, do you think it's worth waiting for core to fix #2926507? And as an interim fix, we can update JSON:API? Personally, I'd like to see Drupal\Core\Entity\Plugin\DataType\EntityReference normalizer implemented first so that DER can extend that.

We discussed this during yesterday's API-First Initiative meeting.

I indeed forgot that DER never worked in JSON:API.

If we want DER to work in JSON:API, it will need to provide a @DataType-level normalizer. To let it coexist with its current @FieldType-level normalizer (\Drupal\dynamic_entity_reference\Normalizer\DynamicEntityReferenceItemNormalizer), it could restrict that @DataType-level normalizer to just the api_json format for now.

Then in the future, once the @FieldType-level normalizer becomes obsolete even in core, i.e. after core's @FieldType-level entity reference normalizer (\Drupal\hal\Normalizer\EntityReferenceItemNormalizer, which is HAL-only, because DER only supports HAL today) has been removed/deprecated in favor of a @DataType-level normalizer, that restriction to api_json could be lifted.

Personally, I'd like to see Drupal\Core\Entity\Plugin\DataType\EntityReference normalizer implemented first so that DER can extend that.

That's reasonable. But there's no issue yet to do that (I could create that), but more importantly there are lots of high priorities. I'm not sure it'd happen before 8.7, although I'd gladly help to make that happen of course. So if you choose to wait for that, it could end up taking a while.

Note that this would also help solve #2844946: Add DynamicEntityReferenceItemNormalizer for serialization module.

Just marked #3027430: Dynamic Entity Reference normalization support as a duplicate of this. People are asking about this.

Thanks for pointing this out @wim.

I understand that its just a normaliser that isn't picking this up and serialising correctly, I still think the modules implementation for discerning these fields might be too greedy given the error I was receiving. For reference the error is:

"detail": "`field_ref_dynamic` is not a valid relationship field name. Possible values: field_ref_dynamic."

When including a DER field the output says that you should be able to use the field. All you would need to do to replicate this is:

- Define a field that extends DataReferenceTargetDefinition
- Don't add target_type in the field

This triggers the following flow:

- getRelatableResourceTypesByField will return your field but it will be an empty array
- resolveInternalIncludePath checks to see if the key returned is empty

I think it's just a case that getRelatableResourceTypesByField should do more checking and resolveInternalIncludePath should maybe rely on the getRelatableResourceTypesByField to check for the field. If my field doesn't have the right configuration it shouldn't show that I can request it.

Aha! That makes a a ton of sense. Reopening #3029090: #3029090-4: Dynamic Entity Reference: support discovering relatable resource types.

I also referenced the wrong issue in #7 😅🤘

This issue is about DER support minus the infrastructure support (that is covered by #3029090: Dynamic Entity Reference: support discovering relatable resource types).

Hello,

Is there a version for Drupal Core of the patch?

I want to test if with this patch there will be a "related" link on DER relationship.

It should be easy to apply this patch using patch -p1 < patchfile from the core/modules/jsonapi directory.

Patch in #16 works for me, what's the way forward here?

See #8. This is postponed on #3029090-12: Dynamic Entity Reference: support discovering relatable resource types.

I re-rolled #16 against 8.7.7 as i'm using this patch and needed to upgrade core. Hopefully it's of use to someone else.

#3029090: Dynamic Entity Reference: support discovering relatable resource types is itself postponed, so bumping.

Rerolled on 8.8.x

Previous patch throw an Error if the request try to include a non-existent relationship because there's no actual value to try to guess of which type it is.
Protecting this so that the "right" HTTP 400 response can be returned.

@garphy Thanks for your patch! I found one small bug in it around checking for an empty $target_type in IncludeResolver. The $target_typeneeds to be reset after each iteration if the field is dynamic. I'm including a patch.

Here's an updated patch based on @garphy's work to allow multiple resource types to be discovered from a DER field for possible includes in a jsonapi request.

#3057545: ResourceTypeRepository wrongly assumes that all entity reference fields have the setting "target_type" landed!

is this still relevant for

Machine name: jsonapi
Version: 10.4.8

???