Add support for UUID field to votingapi_result table

Patch Failed to Apply

Rerolled again.

Patch no longer applies and needs to be rerolled.

I need this to make vote_result entities available with jsonapi.

Here is a patch update for last 8.3.x and Drupal 10.

UUID is a requirement to make entities available on JSONAPI. An issue on core deal with a better way to detect an entity has missing UUID #3090253: Detect when UUID is missing and provide better exception/error message when constructing a JSON:API payload but UUID will still be required.

This patch has some problems. For example:

@@ -130,6 +132,11 @@ class VoteResult extends ContentEntityBase implements VoteResultInterface {
       ->setReadOnly(TRUE)
       ->setSetting('unsigned', TRUE);
 
+    $fields[$entity_type->getKey('uuid')] = BaseFieldDefinition::create('uuid')
+      ->setLabel(new TranslatableMarkup('UUID'))
+      ->setDescription(new TranslatableMarkup('The vote result UUID.'))
+      ->setReadOnly(TRUE);
+

This is not right because the parent ContentEntityBase creates the base field for uuid as long as the entity key is set. That code should not be duplicated here. Also see #3153550: Vote entity unnecessarily re-implements features provided by base class for similar problems with the Vote entity.

Both Vote and VoteResult were written early in D8 before a lot of functionality was moved into ContentEntityBase. So now they both need some major work. And it's important to do that work in a way that won't break existing sites. Because of that, this change should be done in the 4.0.x branch only and have update tests so that we can ensure the entity structure isn't being broken for people upgrading from 8.x-3.x.

I agree. Entity should not duplicate base fields but extends and use ContentEntityBase.

However, while #3153550: Vote entity unnecessarily re-implements features provided by base class is not fixed, if someone needs uuid support, the current patch and issue add it. We cannot do better in this issue without big changes in the module

I created a MR for the 4.0.x branch.
This will not be put into the 8.x-3.x branch.

Note that the tests fail (in both the new MR and the old MR) because the new uuid field is not being initialized. This would not happen if VoteResult simply inherited the uuid field from ContentEntityBase.

Like I said, instead of defining our own new base field, we should just add the uuid entity key and call parent::baseFieldDefinitions(); so that ContentEntityBase will define and handle the uuid field.

This fix is needed before we can release 4.0.0.