EZP-31681: Fixed Image Value comparison via FT Comparable contract

eZ/Publish/Core/FieldType/FieldType.php

@@ -6,6 +6,7 @@
  */
 namespace eZ\Publish\Core\FieldType;
 
+use eZ\Publish\SPI\FieldType\Comparable;
 use eZ\Publish\SPI\FieldType\FieldType as FieldTypeInterface;
 use eZ\Publish\Core\Persistence\TransformationProcessor;
 use eZ\Publish\SPI\FieldType\Value as SPIValue;
@@ -30,7 +31,7 @@
  * Field types are primed and pre-configured with the Field Definitions found in
  * Content Types.
  */
-abstract class FieldType implements FieldTypeInterface
+abstract class FieldType implements FieldTypeInterface, Comparable
 {
     /**
      * The setting keys which are available on this field type.
@@ -575,4 +576,9 @@ public function getRelations(SPIValue $fieldValue)
     {
         return [];
     }
+
+    public function valuesEqual(SPIValue $value1, SPIValue $value2): bool
+    {
+        return $this->toHash($value1) === $this->toHash($value2);
+    }
 }

eZ/Publish/Core/FieldType/Image/Type.php

@@ -365,4 +365,14 @@ public function fromPersistenceValue(FieldValue $fieldValue)
 
         return $result;
     }
+
+    public function valuesEqual(SPIValue $value1, SPIValue $value2): bool
+    {
+        $hashValue1 = $this->toHash($value1);
+        $hashValue2 = $this->toHash($value2);
+
+        unset($hashValue1['imageId'], $hashValue2['imageId']);
+
+        return $hashValue1 === $hashValue2;
+    }
 }

eZ/Publish/Core/FieldType/Tests/FieldTypeTest.php

@@ -511,6 +511,11 @@ public function provideInvalidDataForValidate()
         ];
     }
 
+    public function provideInputForValuesEqual(): array
+    {
+        return $this->provideInputForFromHash();
+    }
+
     /**
      * Retrieves a test wide cached version of the field type under test.
      *
@@ -974,5 +979,20 @@ protected function doValidate($fieldDefinitionData, $value)
         return $validationErrors;
     }
 
+    /**
+     * @dataProvider provideInputForValuesEqual
+     */
+    public function testValuesEqual($inputValue1, SPIValue $inputValue2): void
+    {
+        $fieldType = $this->getFieldTypeUnderTest();
+
+        $inputValue1 = $fieldType->fromHash($inputValue1);
+
+        self::assertTrue(
+            $fieldType->valuesEqual($inputValue1, $inputValue2),
+            'valuesEqual() method did not create expected result.'
+        );
+    }
+
     // @todo: More test methods …
 }

eZ/Publish/Core/FieldType/Tests/ImageTest.php

@@ -811,4 +811,39 @@ public function provideInvalidDataForValidate()
             ],
         ];
     }
+
+    /**
+     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException
+     */
+    public function provideInputForValuesEqual(): array
+    {
+        return [
+            [
+                [
+                    'id' => $this->getImageInputPath(),
+                    'fileName' => 'Sindelfingen-Squirrels.jpg',
+                    'fileSize' => 23,
+                    'alternativeText' => 'This is so Sindelfingen!',
+                    'imageId' => '123-12345',
+                    'uri' => 'http://' . $this->getImageInputPath(),
+                    'width' => 123,
+                    'height' => 456,
+                ],
+                new ImageValue(
+                    [
+                        'id' => $this->getImageInputPath(),
+                        'path' => $this->getImageInputPath(),
+                        'fileName' => 'Sindelfingen-Squirrels.jpg',
+                        'fileSize' => 23,
+                        'alternativeText' => 'This is so Sindelfingen!',
+                        'imageId' => '123-12317',
+                        'uri' => 'http://' . $this->getImageInputPath(),
+                        'inputUri' => null,
+                        'width' => 123,
+                        'height' => 456,
+                    ]
+                ),
+            ],
+        ];
+    }
 }

eZ/Publish/Core/Repository/ContentService.php

@@ -18,6 +18,9 @@
 use eZ\Publish\Core\Repository\Values\Content\Content;
 use eZ\Publish\Core\Repository\Values\Content\Location;
 use eZ\Publish\API\Repository\Values\Content\Language;
+use eZ\Publish\SPI\FieldType\Comparable;
+use eZ\Publish\SPI\FieldType\FieldType;
+use eZ\Publish\SPI\FieldType\Value;
 use eZ\Publish\SPI\Persistence\Handler;
 use eZ\Publish\API\Repository\Values\Content\ContentUpdateStruct as APIContentUpdateStruct;
 use eZ\Publish\API\Repository\Values\ContentType\ContentType;
@@ -1723,7 +1726,8 @@ protected function copyTranslationsFromPublishedVersion(APIVersionInfo $versionI
 
             if ($newValue !== null
                 && $field->value !== null
-                && $fieldType->toHash($newValue) === $fieldType->toHash($field->value)) {
+                && $this->fieldValuesAreEqual($fieldType, $newValue, $field->value)
+            ) {
                 continue;
             }
 
@@ -1743,6 +1747,26 @@ protected function copyTranslationsFromPublishedVersion(APIVersionInfo $versionI
         $this->internalUpdateContent($versionInfo, $updateStruct);
     }
 
+    protected function fieldValuesAreEqual(FieldType $fieldType, Value $value1, Value $value2): bool
+    {
+        if ($fieldType instanceof Comparable) {
+            return $fieldType->valuesEqual($value1, $value2);
+        } else {
+            @trigger_error(
+                \sprintf(
+                    'In eZ Platform 2.5 and 3.x %s should implement %s. ' .
+                    'Since the 4.0 major release FieldType\Comparable contract will be a part of %s',
+                    get_class($fieldType),
+                    Comparable::class,
+                    FieldType::class
+                ),
+                E_USER_DEPRECATED
+            );
+
+            return $fieldType->toHash($value1) === $fieldType->toHash($value2);
+        }
+    }
+
     /**
      * Publishes a content version.
      *

eZ/Publish/SPI/FieldType/Comparable.php

@@ -0,0 +1,14 @@
+<?php
+
+/**
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace eZ\Publish\SPI\FieldType;
+
+interface Comparable
+{
+    public function valuesEqual(Value $value1, Value $value2): bool;
+}