bug symfony#60856 [ObjectMapper] handle non existing property errors (soyuka)

This PR was squashed before being merged into the 7.3 branch.

Discussion
----------

[ObjectMapper] handle non existing property errors

| Q             | A
| ------------- | ---
| Branch?       | 7.3
| Bug fix?      | yes
| New feature?  | no <!-- please update src/**/CHANGELOG.md files -->
| Deprecations? | no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files -->
| Issues        | Fix symfony#60848
| License       | MIT

The property accessor allows to ignore exceptions when a property does not exist. Without the property accessor we now throw a proper exception when the property does not exist (as opposed to the PHP Warning it'd trigger otherwise). I think its better to thrown then to hide the error in that particular case.

This fixes symfony#60848 providing a working solution and a better DX, especially that in PHP the behavior of dynamic properties is to avoid them as much as possible.

Commits
-------

818e7e8 [ObjectMapper] handle non existing property errors

Author: nicolas-grekas

src/Symfony/Component/ObjectMapper/Exception/NoSuchPropertyException.php

@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\ObjectMapper\Exception;
+
+/**
+ * Thrown when a property cannot be found.
+ *
+ * @author Antoine Bluchet <[email protected]>
+ */
+class NoSuchPropertyException extends MappingException
+{
+}

src/Symfony/Component/ObjectMapper/ObjectMapper.php

@@ -14,9 +14,11 @@
 use Psr\Container\ContainerInterface;
 use Symfony\Component\ObjectMapper\Exception\MappingException;
 use Symfony\Component\ObjectMapper\Exception\MappingTransformException;
+use Symfony\Component\ObjectMapper\Exception\NoSuchPropertyException;
 use Symfony\Component\ObjectMapper\Metadata\Mapping;
 use Symfony\Component\ObjectMapper\Metadata\ObjectMapperMetadataFactoryInterface;
 use Symfony\Component\ObjectMapper\Metadata\ReflectionObjectMapperMetadataFactory;
+use Symfony\Component\PropertyAccess\Exception\NoSuchPropertyException as PropertyAccessorNoSuchPropertyException;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
 
 /**
@@ -167,7 +169,19 @@ public function map(object $source, object|string|null $target = null): object
 
     private function getRawValue(object $source, string $propertyName): mixed
     {
-        return $this->propertyAccessor ? $this->propertyAccessor->getValue($source, $propertyName) : $source->{$propertyName};
+        if ($this->propertyAccessor) {
+            try {
+                return $this->propertyAccessor->getValue($source, $propertyName);
+            } catch (PropertyAccessorNoSuchPropertyException $e) {
+                throw new NoSuchPropertyException($e->getMessage(), $e->getCode(), $e);
+            }
+        }
+
+        if (!property_exists($source, $propertyName) && !isset($source->{$propertyName})) {
+            throw new NoSuchPropertyException(sprintf('The property "%s" does not exist on "%s".', $propertyName, get_debug_type($source)));
+        }
+
+        return $source->{$propertyName};
     }
 
     private function getSourceValue(object $source, object $target, mixed $value, \SplObjectStorage $objectMap, ?Mapping $mapping = null): mixed

src/Symfony/Component/ObjectMapper/ObjectMapperInterface.php

@@ -13,6 +13,7 @@
 
 use Symfony\Component\ObjectMapper\Exception\MappingException;
 use Symfony\Component\ObjectMapper\Exception\MappingTransformException;
+use Symfony\Component\ObjectMapper\Exception\NoSuchPropertyException;
 
 /**
  * Object to object mapper.
@@ -33,6 +34,7 @@ interface ObjectMapperInterface
      *
      * @throws MappingException          When the mapping configuration is wrong
      * @throws MappingTransformException When a transformation on an object does not return an object
+     * @throws NoSuchPropertyException   When a property does not exist
      */
     public function map(object $source, object|string|null $target = null): object;
 }

src/Symfony/Component/ObjectMapper/Tests/Fixtures/DefaultValueStdClass/TargetDto.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Symfony\Component\ObjectMapper\Tests\Fixtures\DefaultValueStdClass;
+
+use Symfony\Component\ObjectMapper\Attribute\Map;
+
+class TargetDto
+{
+    public function __construct(
+        public string  $id,
+        #[Map(source: 'optional', if: [self::class, 'isDefined'])]
+        public ?string $optional = null,
+    ) {
+    }
+
+    public static function isDefined($source): bool
+    {
+        return isset($source);
+    }
+}

src/Symfony/Component/ObjectMapper/Tests/ObjectMapperTest.php

@@ -15,6 +15,7 @@
 use Psr\Container\ContainerInterface;
 use Symfony\Component\ObjectMapper\Exception\MappingException;
 use Symfony\Component\ObjectMapper\Exception\MappingTransformException;
+use Symfony\Component\ObjectMapper\Exception\NoSuchPropertyException;
 use Symfony\Component\ObjectMapper\Metadata\Mapping;
 use Symfony\Component\ObjectMapper\Metadata\ObjectMapperMetadataFactoryInterface;
 use Symfony\Component\ObjectMapper\Metadata\ReflectionObjectMapperMetadataFactory;
@@ -28,6 +29,7 @@
 use Symfony\Component\ObjectMapper\Tests\Fixtures\DeeperRecursion\RecursiveDto;
 use Symfony\Component\ObjectMapper\Tests\Fixtures\DeeperRecursion\Relation;
 use Symfony\Component\ObjectMapper\Tests\Fixtures\DeeperRecursion\RelationDto;
+use Symfony\Component\ObjectMapper\Tests\Fixtures\DefaultValueStdClass\TargetDto;
 use Symfony\Component\ObjectMapper\Tests\Fixtures\Flatten\TargetUser;
 use Symfony\Component\ObjectMapper\Tests\Fixtures\Flatten\User;
 use Symfony\Component\ObjectMapper\Tests\Fixtures\Flatten\UserProfile;
@@ -247,8 +249,17 @@ public function testSourceOnly()
         $mapped = $mapper->map($a, SourceOnly::class);
         $this->assertInstanceOf(SourceOnly::class, $mapped);
         $this->assertSame('test', $mapped->mappedName);
+    }
 
+    public function testSourceOnlyWithMagicMethods()
+    {
+        $mapper = new ObjectMapper();
         $a = new class {
+            public function __isset($key): bool
+            {
+                return 'name' === $key;
+            }
+
             public function __get(string $key): string
             {
                 return match ($key) {
@@ -314,4 +325,24 @@ public function testMultipleTargetMapProperty()
         $this->assertEquals('donotmap', $c->foo);
         $this->assertEquals('foo', $c->doesNotExistInTargetB);
     }
+
+    public function testDefaultValueStdClass()
+    {
+        $this->expectException(NoSuchPropertyException::class);
+        $u = new \stdClass();
+        $u->id = 'abc';
+        $mapper = new ObjectMapper();
+        $b = $mapper->map($u, TargetDto::class);
+    }
+
+    public function testDefaultValueStdClassWithPropertyInfo()
+    {
+        $u = new \stdClass();
+        $u->id = 'abc';
+        $mapper = new ObjectMapper(propertyAccessor: PropertyAccess::createPropertyAccessorBuilder()->disableExceptionOnInvalidPropertyPath()->getPropertyAccessor());
+        $b = $mapper->map($u, TargetDto::class);
+        $this->assertInstanceOf(TargetDto::class, $b);
+        $this->assertSame('abc', $b->id);
+        $this->assertNull($b->optional);
+    }
 }