ignore originalEmail attribute and fix test cases | 3.x

src/Api/Management/Controller/DeveloperController.php

@@ -7,7 +7,7 @@
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *      https://www.apache.org/licenses/LICENSE-2.0
+ * https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -111,11 +111,30 @@ public function update(EntityInterface $entity): void
         $uri = $this->getEntityEndpointUri($developer_entity->originalEmail());
         $response = $this->getClient()->put(
             $uri,
-            $this->getEntitySerializer()->serialize($developer_entity, 'json')
+            $this->getEntitySerializer()->serialize($developer_entity, 'json', ['ignored_attributes' => ['originalEmail']])
         );
         $this->getEntitySerializer()->setPropertiesFromResponse($response, $developer_entity);
     }
 
+    /**
+     * Ensure 'originalEmail' is not included when creating developers.
+     *
+     * {@inheritdoc}
+     */
+    protected function buildEntityCreatePayload(EntityInterface $entity, array $context = []): string
+    {
+        if ($entity instanceof Developer) {
+            $ignored = $context['ignored_attributes'] ?? [];
+            $ignored[] = 'originalEmail';
+            $context['ignored_attributes'] = array_values(array_unique($ignored));
+        }
+
+        // The original implementation (from trait) simply delegates to the
+        // entity serializer. Mirror that behavior here while applying our
+        // adjusted context.
+        return $this->getEntitySerializer()->serialize($entity, 'json', $context);
+    }
+
     /**
      * {@inheritdoc}
      */

tests/Api/Management/Controller/DeveloperControllerTest.php

@@ -7,7 +7,7 @@
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *      https://www.apache.org/licenses/LICENSE-2.0
+ * https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -36,7 +36,9 @@
 use Apigee\Edge\Tests\Test\Controller\MockClientAwareTrait;
 use Apigee\Edge\Tests\Test\TestClientFactory;
 use Apigee\Edge\Tests\Test\Utility\MarkOnlineTestSkippedAwareTrait;
+use Composer\InstalledVersions;
 use GuzzleHttp\Psr7\Response;
+use stdClass;
 
 /**
  * Class DeveloperControllerTest.
@@ -180,4 +182,57 @@ protected static function entityCreateOperationTestController(): EntityCreateOpe
     {
         return new EntityCreateOperationControllerTester(static::entityController());
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function alterArraysBeforeCompareSentAndReceivedPayloadsInCreate(array &$sentEntityAsArray, array $responseEntityAsArray): void
+    {
+        // Get the version string (e.g., "6.4.12")
+        $version = InstalledVersions::getVersion('symfony/serializer');
+        if (version_compare($version, '6.4.33', '>=')) {
+            // The originalEmail property is not returned by the API on creation.
+            unset($sentEntityAsArray['originalEmail']);
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function alterObjectsBeforeCompareResponseAndCreatedEntity(stdClass &$responseObject, EntityInterface $created): void
+    {
+        $version = InstalledVersions::getVersion('symfony/serializer');
+        if (version_compare($version, '6.4.33', '>=')) {
+            // The originalEmail property is not returned by the API on creation.
+            if ($created instanceof Developer) {
+                $responseObject->originalEmail = $created->originalEmail();
+            }
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function alterArraysBeforeCompareSentAndReceivedPayloadsInUpdate(array &$sentEntityAsArray, array $responseEntityAsArray): void
+    {
+        $version = InstalledVersions::getVersion('symfony/serializer');
+        if (version_compare($version, '6.4.33', '>=')) {
+            // The originalEmail property is not returned by the API on update.
+            unset($sentEntityAsArray['originalEmail']);
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function alterObjectsBeforeCompareResponseAndUpdateEntity(stdClass &$responseObject, EntityInterface $updated): void
+    {
+        $version = InstalledVersions::getVersion('symfony/serializer');
+        if (version_compare($version, '6.4.33', '>=')) {
+            // The originalEmail property is not returned by the API on update.
+            if ($updated instanceof Developer) {
+                $responseObject->originalEmail = $updated->originalEmail();
+            }
+        }
+    }
 }