Merge branch '7.0' into 7.1

* 7.0: [Serializer] Fix merge [VarExporter] add `#[Ignore]` to proxy-related methods to prevent them from being serialized
symfony · Mar 19, 2024 · a9133af · a9133af
2 parents fb28944 + a57c20b
commit a9133af
Show file tree

Hide file tree

Showing 8 changed files with 73 additions and 24 deletions.
diff --git a/...Component/Serializer/Tests/Fixtures/SamePropertyAsMethodWithMethodSerializedNameDummy.php b/...Component/Serializer/Tests/Fixtures/SamePropertyAsMethodWithMethodSerializedNameDummy.php
@@ -28,33 +28,25 @@ public function __construct($freeTrial, $hasSubscribe, $getReady, $isActive)
         $this->isActive = $isActive;
     }
 
-    /**
-     * @SerializedName("free_trial_method")
-     */
+    #[SerializedName('free_trial_method')]
     public function getFreeTrial()
     {
         return $this->freeTrial;
     }
 
-    /**
-     * @SerializedName("has_subscribe_method")
-     */
+    #[SerializedName('has_subscribe_method')]
     public function hasSubscribe()
     {
         return $this->hasSubscribe;
     }
 
-    /**
-     * @SerializedName("get_ready_method")
-     */
+    #[SerializedName('get_ready_method')]
     public function getReady()
     {
         return $this->getReady;
     }
 
-    /**
-     * @SerializedName("is_active_method")
-     */
+    #[SerializedName('is_active_method')]
     public function isActive()
     {
         return $this->isActive;

diff --git a/...mponent/Serializer/Tests/Fixtures/SamePropertyAsMethodWithPropertySerializedNameDummy.php b/...mponent/Serializer/Tests/Fixtures/SamePropertyAsMethodWithPropertySerializedNameDummy.php
@@ -15,24 +15,16 @@
 
 class SamePropertyAsMethodWithPropertySerializedNameDummy
 {
-    /**
-     * @SerializedName("free_trial_property")
-     */
+    #[SerializedName('free_trial_property')]
     private $freeTrial;
 
-    /**
-     * @SerializedName("has_subscribe_property")
-     */
+    #[SerializedName('has_subscribe_property')]
     private $hasSubscribe;
 
-    /**
-     * @SerializedName("get_ready_property")
-     */
+    #[SerializedName('get_ready_property')]
     private $getReady;
 
-    /**
-     * @SerializedName("is_active_property")
-     */
+    #[SerializedName('is_active_property')]
     private $isActive;
 
     public function __construct($freeTrial, $hasSubscribe, $getReady, $isActive)

diff --git a/src/Symfony/Component/VarExporter/Internal/LazyObjectTrait.php b/src/Symfony/Component/VarExporter/Internal/LazyObjectTrait.php
@@ -11,12 +11,15 @@
 
 namespace Symfony\Component\VarExporter\Internal;
 
+use Symfony\Component\Serializer\Attribute\Ignore;
+
 if (\PHP_VERSION_ID >= 80300) {
     /**
      * @internal
      */
     trait LazyObjectTrait
     {
+        #[Ignore]
         private readonly LazyObjectState $lazyObjectState;
     }
 } else {
@@ -25,6 +28,7 @@ trait LazyObjectTrait
      */
     trait LazyObjectTrait
     {
+        #[Ignore]
         private LazyObjectState $lazyObjectState;
     }
 }
diff --git a/src/Symfony/Component/VarExporter/LazyGhostTrait.php b/src/Symfony/Component/VarExporter/LazyGhostTrait.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\VarExporter;
 
+use Symfony\Component\Serializer\Attribute\Ignore;
 use Symfony\Component\VarExporter\Internal\Hydrator;
 use Symfony\Component\VarExporter\Internal\LazyObjectRegistry as Registry;
 use Symfony\Component\VarExporter\Internal\LazyObjectState;
@@ -64,6 +65,7 @@ public static function createLazyGhost(\Closure $initializer, ?array $skippedPro
      *
      * @param $partial Whether partially initialized objects should be considered as initialized
      */
+    #[Ignore]
     public function isLazyObjectInitialized(bool $partial = false): bool
     {
         if (!$state = $this->lazyObjectState ?? null) {
@@ -340,6 +342,7 @@ public function __destruct()
         }
     }
 
+    #[Ignore]
     private function setLazyObjectAsInitialized(bool $initialized): void
     {
         if ($state = $this->lazyObjectState ?? null) {

diff --git a/src/Symfony/Component/VarExporter/LazyProxyTrait.php b/src/Symfony/Component/VarExporter/LazyProxyTrait.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\VarExporter;
 
+use Symfony\Component\Serializer\Attribute\Ignore;
 use Symfony\Component\VarExporter\Hydrator as PublicHydrator;
 use Symfony\Component\VarExporter\Internal\Hydrator;
 use Symfony\Component\VarExporter\Internal\LazyObjectRegistry as Registry;
@@ -60,6 +61,7 @@ public static function createLazyProxy(\Closure $initializer, ?object $instance
      *
      * @param $partial Whether partially initialized objects should be considered as initialized
      */
+    #[Ignore]
     public function isLazyObjectInitialized(bool $partial = false): bool
     {
         return !isset($this->lazyObjectState) || isset($this->lazyObjectState->realInstance) || Registry::$noInitializerState === $this->lazyObjectState->initializer;

diff --git a/src/Symfony/Component/VarExporter/Tests/Fixtures/SimpleObject.php b/src/Symfony/Component/VarExporter/Tests/Fixtures/SimpleObject.php
@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\VarExporter\Tests\Fixtures;
+
+class SimpleObject
+{
+    public function getMethod(): string
+    {
+        return 'method';
+    }
+
+    public string $property = 'property';
+}
diff --git a/src/Symfony/Component/VarExporter/Tests/LazyGhostTraitTest.php b/src/Symfony/Component/VarExporter/Tests/LazyGhostTraitTest.php
@@ -12,6 +12,9 @@
 namespace Symfony\Component\VarExporter\Tests;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
+use Symfony\Component\Serializer\Mapping\Loader\AttributeLoader;
+use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
 use Symfony\Component\VarExporter\ProxyHelper;
 use Symfony\Component\VarExporter\Tests\Fixtures\LazyGhost\ChildMagicClass;
 use Symfony\Component\VarExporter\Tests\Fixtures\LazyGhost\ChildStdClass;
@@ -21,6 +24,7 @@
 use Symfony\Component\VarExporter\Tests\Fixtures\LazyGhost\MagicClass;
 use Symfony\Component\VarExporter\Tests\Fixtures\LazyGhost\ReadOnlyClass;
 use Symfony\Component\VarExporter\Tests\Fixtures\LazyGhost\TestClass;
+use Symfony\Component\VarExporter\Tests\Fixtures\SimpleObject;
 
 class LazyGhostTraitTest extends TestCase
 {
@@ -263,6 +267,19 @@ public function testAccessingUninializedPropertyWithLazyGhost()
         $object->property;
     }
 
+    public function testNormalization()
+    {
+        $object = $this->createLazyGhost(SimpleObject::class, function ($instance) {});
+
+        $loader = new AttributeLoader();
+        $metadataFactory = new ClassMetadataFactory($loader);
+        $serializer = new ObjectNormalizer($metadataFactory);
+
+        $output = $serializer->normalize($object);
+
+        $this->assertSame(['property' => 'property', 'method' => 'method'], $output);
+    }
+
     /**
      * @template T
      *

diff --git a/src/Symfony/Component/VarExporter/Tests/LazyProxyTraitTest.php b/src/Symfony/Component/VarExporter/Tests/LazyProxyTraitTest.php
@@ -12,6 +12,9 @@
 namespace Symfony\Component\VarExporter\Tests;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
+use Symfony\Component\Serializer\Mapping\Loader\AttributeLoader;
+use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
 use Symfony\Component\VarExporter\Exception\LogicException;
 use Symfony\Component\VarExporter\LazyProxyTrait;
 use Symfony\Component\VarExporter\ProxyHelper;
@@ -22,6 +25,7 @@
 use Symfony\Component\VarExporter\Tests\Fixtures\LazyProxy\TestOverwritePropClass;
 use Symfony\Component\VarExporter\Tests\Fixtures\LazyProxy\TestUnserializeClass;
 use Symfony\Component\VarExporter\Tests\Fixtures\LazyProxy\TestWakeupClass;
+use Symfony\Component\VarExporter\Tests\Fixtures\SimpleObject;
 
 class LazyProxyTraitTest extends TestCase
 {
@@ -278,6 +282,19 @@ public function __construct()
         $this->assertSame(['foo' => 123], (array) $obj->getDep());
     }
 
+    public function testNormalization()
+    {
+        $object = $this->createLazyProxy(SimpleObject::class, fn () => new SimpleObject());
+
+        $loader = new AttributeLoader();
+        $metadataFactory = new ClassMetadataFactory($loader);
+        $serializer = new ObjectNormalizer($metadataFactory);
+
+        $output = $serializer->normalize($object);
+
+        $this->assertSame(['property' => 'property', 'method' => 'method'], $output);
+    }
+
     /**
      * @template T
      *