Deep serialization for content entities to make an exact snapshot of an entity object's structure based on its current state

The Needs Review Queue Bot → tested this issue. It either no longer applies to Drupal core, or fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".

Apart from a re-roll or rebase, this issue may need more work to address feedback in the issue or MR comments. To progress an issue, incorporate this feedback as part of the process of updating the issue. This helps other contributors to know what is outstanding.

Consult the Drupal Contributor Guide → to find step-by-step guides for working with issues.

Added patch against #158 in 10.1 version

Setting as need review for tests to run.

Missing core/tests/Drupal/KernelTests/Core/Entity/ContentEntitySerializationTest.php
in patch #162 which was present in #158.

Hiding patch #162.

Fixed failed commands on #162
Addressed the comment on #164
Attached patch against Drupal 10.1.x

The Needs Review Queue Bot → tested this issue. It fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".

Apart from a re-roll or rebase, this issue may need more work to address feedback in the issue or MR comments. To progress an issue, incorporate this feedback as part of the process of updating the issue. This helps other contributors to know what is outstanding.

Consult the Drupal Contributor Guide → to find step-by-step guides for working with issues.

Verified the patch #167 and tested it on Drupal version 10.1.x. The patch works fine in 10.1.x also and I have added the screenshots for reference.

1. +++ b/core/lib/Drupal/Core/Entity/ContentEntityBase.php
   @@ -184,6 +184,18 @@
   +   * @var bool
   ...
   +  protected $deepSerialization = FALSE;
   

   add type to new property

2. +++ b/core/lib/Drupal/Core/Entity/ContentEntityBase.php
   @@ -525,12 +538,26 @@ public function __sleep() {
   +  public function setDeepSerialization($deep_serialization) {
   
   +++ b/core/lib/Drupal/Core/Entity/FieldableEntityInterface.php
   @@ -236,4 +236,34 @@ public function isValidationRequired();
   +   * @param bool $deep_serialization
   +   *   TRUE if deep serialization should be performed when the entity is being
   +   *   serialized, FALSE otherwise.
   ...
   +  public function setDeepSerialization($deep_serialization);
   
   +++ b/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php
   @@ -13,6 +13,27 @@ class EntityReferenceFieldItemList extends FieldItemList implements EntityRefere
   +  public function getSerializationValue($deep_serialization) {
   
   +++ b/core/lib/Drupal/Core/Field/FieldItemList.php
   @@ -110,6 +110,13 @@ public function setValue($values, $notify = TRUE) {
   +  public function getSerializationValue($deep_serialization) {
   
   +++ b/core/lib/Drupal/Core/Field/FieldItemListInterface.php
   @@ -297,4 +297,19 @@ public function equals(FieldItemListInterface $list_to_compare);
   +  public function getSerializationValue($deep_serialization);
   

   also need to add bool type to function arguments

Review Comments from #171 addressed.

Seems there were some key points being discussed in 141-144 but not a final decision made. Are 141.2 or 141.3 needed or not?

Updated remaining task to include this.