Fix proxying an interface and using a dynamic property on the proxy

nicolas-grekas · nicolas-grekas · commit 0db5a0f3200a · 2020-12-22T16:47:11.000+01:00
diff --git a/src/ProxyManager/ProxyGenerator/AccessInterceptorScopeLocalizer/MethodGenerator/MagicGet.php b/src/ProxyManager/ProxyGenerator/AccessInterceptorScopeLocalizer/MethodGenerator/MagicGet.php
@@ -38,7 +38,8 @@ public function __construct(
                 'name',
                 null,
                 null,
-                'returnValue'
+                'returnValue',
+                $originalClass->isInterface() ? $originalClass->getName() : null
             );
         }
 
diff --git a/src/ProxyManager/ProxyGenerator/AccessInterceptorScopeLocalizer/MethodGenerator/MagicIsset.php b/src/ProxyManager/ProxyGenerator/AccessInterceptorScopeLocalizer/MethodGenerator/MagicIsset.php
@@ -38,7 +38,8 @@ public function __construct(
                 'name',
                 null,
                 null,
-                'returnValue'
+                'returnValue',
+                $originalClass->isInterface() ? $originalClass->getName() : null
             );
         }
 
diff --git a/src/ProxyManager/ProxyGenerator/AccessInterceptorScopeLocalizer/MethodGenerator/MagicSet.php b/src/ProxyManager/ProxyGenerator/AccessInterceptorScopeLocalizer/MethodGenerator/MagicSet.php
@@ -42,7 +42,8 @@ public function __construct(
                 'name',
                 'value',
                 null,
-                'returnValue'
+                'returnValue',
+                $originalClass->isInterface() ? $originalClass->getName() : null
             );
         }
 
diff --git a/src/ProxyManager/ProxyGenerator/AccessInterceptorScopeLocalizer/MethodGenerator/MagicUnset.php b/src/ProxyManager/ProxyGenerator/AccessInterceptorScopeLocalizer/MethodGenerator/MagicUnset.php
@@ -38,7 +38,8 @@ public function __construct(
                 'name',
                 null,
                 null,
-                'returnValue'
+                'returnValue',
+                $originalClass->isInterface() ? $originalClass->getName() : null
             );
         }
 
diff --git a/src/ProxyManager/ProxyGenerator/AccessInterceptorValueHolder/MethodGenerator/MagicGet.php b/src/ProxyManager/ProxyGenerator/AccessInterceptorValueHolder/MethodGenerator/MagicGet.php
@@ -41,7 +41,8 @@ public function __construct(
             'name',
             'value',
             $valueHolder,
-            'returnValue'
+            'returnValue',
+            $originalClass->isInterface() ? $originalClass->getName() : null
         );
 
         if (! $publicProperties->isEmpty()) {
diff --git a/src/ProxyManager/ProxyGenerator/AccessInterceptorValueHolder/MethodGenerator/MagicIsset.php b/src/ProxyManager/ProxyGenerator/AccessInterceptorValueHolder/MethodGenerator/MagicIsset.php
@@ -41,7 +41,8 @@ public function __construct(
             'name',
             'value',
             $valueHolder,
-            'returnValue'
+            'returnValue',
+            $originalClass->isInterface() ? $originalClass->getName() : null
         );
 
         if (! $publicProperties->isEmpty()) {
diff --git a/src/ProxyManager/ProxyGenerator/AccessInterceptorValueHolder/MethodGenerator/MagicSet.php b/src/ProxyManager/ProxyGenerator/AccessInterceptorValueHolder/MethodGenerator/MagicSet.php
@@ -45,7 +45,8 @@ public function __construct(
             'name',
             'value',
             $valueHolder,
-            'returnValue'
+            'returnValue',
+            $originalClass->isInterface() ? $originalClass->getName() : null
         );
 
         if (! $publicProperties->isEmpty()) {
diff --git a/src/ProxyManager/ProxyGenerator/AccessInterceptorValueHolder/MethodGenerator/MagicUnset.php b/src/ProxyManager/ProxyGenerator/AccessInterceptorValueHolder/MethodGenerator/MagicUnset.php
@@ -41,7 +41,8 @@ public function __construct(
             'name',
             'value',
             $valueHolder,
-            'returnValue'
+            'returnValue',
+            $originalClass->isInterface() ? $originalClass->getName() : null
         );
 
         if (! $publicProperties->isEmpty()) {
diff --git a/src/ProxyManager/ProxyGenerator/LazyLoadingValueHolder/MethodGenerator/MagicGet.php b/src/ProxyManager/ProxyGenerator/LazyLoadingValueHolder/MethodGenerator/MagicGet.php
@@ -55,7 +55,9 @@ public function __construct(
                 PublicScopeSimulator::OPERATION_GET,
                 'name',
                 null,
-                $valueHolderProperty
+                $valueHolderProperty,
+                null,
+                $originalClass->isInterface() ? $originalClass->getName() : null
             )
         );
     }
diff --git a/src/ProxyManager/ProxyGenerator/LazyLoadingValueHolder/MethodGenerator/MagicIsset.php b/src/ProxyManager/ProxyGenerator/LazyLoadingValueHolder/MethodGenerator/MagicIsset.php
@@ -44,7 +44,9 @@ public function __construct(
             PublicScopeSimulator::OPERATION_ISSET,
             'name',
             null,
-            $valueHolderProperty
+            $valueHolderProperty,
+            null,
+            $originalClass->isInterface() ? $originalClass->getName() : null
         );
 
         $this->setBody(
diff --git a/src/ProxyManager/ProxyGenerator/LazyLoadingValueHolder/MethodGenerator/MagicSet.php b/src/ProxyManager/ProxyGenerator/LazyLoadingValueHolder/MethodGenerator/MagicSet.php
@@ -51,7 +51,9 @@ public function __construct(
                 PublicScopeSimulator::OPERATION_SET,
                 'name',
                 'value',
-                $valueHolderProperty
+                $valueHolderProperty,
+                null,
+                $originalClass->isInterface() ? $originalClass->getName() : null
             );
 
         $this->setBody(
diff --git a/src/ProxyManager/ProxyGenerator/LazyLoadingValueHolder/MethodGenerator/MagicUnset.php b/src/ProxyManager/ProxyGenerator/LazyLoadingValueHolder/MethodGenerator/MagicUnset.php
@@ -47,7 +47,9 @@ public function __construct(
                 PublicScopeSimulator::OPERATION_UNSET,
                 'name',
                 null,
-                $valueHolderProperty
+                $valueHolderProperty,
+                null,
+                $originalClass->isInterface() ? $originalClass->getName() : null
             );
 
         $this->setBody(
diff --git a/src/ProxyManager/ProxyGenerator/Util/PublicScopeSimulator.php b/src/ProxyManager/ProxyGenerator/Util/PublicScopeSimulator.php
@@ -8,6 +8,9 @@
 use Laminas\Code\Generator\PropertyGenerator;
 
 use function sprintf;
+use function str_replace;
+use function substr;
+use function var_export;
 
 /**
  * Generates code necessary to simulate a fatal error in case of unauthorized
@@ -33,6 +36,7 @@ class PublicScopeSimulator
      *                                              to read the property. `$this` if none provided
      * @param string|null       $returnPropertyName name of the property to which we want to assign the result of
      *                                              the operation. Return directly if none provided
+     * @param string|null       $interfaceName      name of the proxified interface if any
      *
      * @throws InvalidArgumentException
      */
@@ -41,7 +45,8 @@ public static function getPublicAccessSimulationCode(
         string $nameParameter,
         ?string $valueParameter = null,
         ?PropertyGenerator $valueHolder = null,
-        ?string $returnPropertyName = null
+        ?string $returnPropertyName = null,
+        ?string $interfaceName = null
     ): string {
         $byRef  = self::getByRefReturnValue($operationType);
         $value  = $operationType === self::OPERATION_SET ? ', $value' : '';
@@ -51,6 +56,12 @@ public static function getPublicAccessSimulationCode(
             $target = '$this->' . $valueHolder->getName();
         }
 
+        if ($interfaceName !== null) {
+            return '$targetObject = ' . $target . ';' . "\n\n"
+                . self::getUndefinedPropertyNotice($operationType, $nameParameter, $interfaceName)
+                . self::getOperation($operationType, $nameParameter, $valueParameter);
+        }
+
         return '$realInstanceReflection = new \\ReflectionClass(get_parent_class($this));' . "\n\n"
             . 'if (! $realInstanceReflection->hasProperty($' . $nameParameter . ')) {' . "\n"
             . '    $targetObject = ' . $target . ';' . "\n\n"
@@ -73,23 +84,29 @@ public static function getPublicAccessSimulationCode(
     /**
      * This will generate code that triggers a notice if access is attempted on a non-existing property
      */
-    private static function getUndefinedPropertyNotice(string $operationType, string $nameParameter): string
+    private static function getUndefinedPropertyNotice(string $operationType, string $nameParameter, ?string $interfaceName = null): string
     {
         if ($operationType !== self::OPERATION_GET) {
             return '';
         }
 
-        return '    $backtrace = debug_backtrace(false, 1);' . "\n"
+        $code = '    $backtrace = debug_backtrace(false, 1);' . "\n"
             . '    trigger_error(' . "\n"
             . '        sprintf(' . "\n"
             . '            \'Undefined property: %s::$%s in %s on line %s\',' . "\n"
-            . '            get_parent_class($this),' . "\n"
+            . '            ' . ($interfaceName !== null ? var_export($interfaceName, true) : 'get_parent_class($this)') . ',' . "\n"
             . '            $' . $nameParameter . ',' . "\n"
             . '            $backtrace[0][\'file\'],' . "\n"
             . '            $backtrace[0][\'line\']' . "\n"
             . '        ),' . "\n"
             . '        \E_USER_NOTICE' . "\n"
             . '    );' . "\n";
+
+        if ($interfaceName !== null) {
+            $code = str_replace("\n    ", "\n", substr($code, 4));
+        }
+
+        return $code;
     }
 
     /**
diff --git a/tests/language-feature-scripts/lazy-loading-value-holder-interface-proxy.phpt b/tests/language-feature-scripts/lazy-loading-value-holder-interface-proxy.phpt
@@ -0,0 +1,37 @@
+--TEST--
+Verifies that lazy loading value holder factory can generate proxy for interfaces.
+--FILE--
+<?php
+
+require_once __DIR__ . '/init.php';
+
+interface MyInterface
+{
+    public function do();
+}
+
+class MyClass implements MyInterface
+{
+    public function do()
+    {
+        echo 'Hello';
+    }
+}
+
+$factory = new \ProxyManager\Factory\LazyLoadingValueHolderFactory($configuration);
+
+$proxy = $factory
+    ->createProxy(MyInterface::class, function (& $wrapped, $proxy, $method, array $parameters, & $initializer) {
+        $initializer = null;
+        $wrapped     = new MyClass();
+    });
+
+$proxy->do();
+$proxy->someDynamicProperty = ' World';
+echo $proxy->someDynamicProperty;
+
+?>
+--EXPECTF--
+Hello
+Notice: Undefined property: MyInterface::$someDynamicProperty %s
+ World

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,8 @@ public function __construct(`
`38`	`38`	`'name',`
`39`	`39`	`null,`
`40`	`40`	`null,`
`41`		`- 'returnValue'`
	`41`	`+ 'returnValue',`
	`42`	`+ $originalClass->isInterface() ? $originalClass->getName() : null`
`42`	`43`	`);`
`43`	`44`	`}`
`44`	`45`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,8 @@ public function __construct(`
`42`	`42`	`'name',`
`43`	`43`	`'value',`
`44`	`44`	`null,`
`45`		`- 'returnValue'`
	`45`	`+ 'returnValue',`
	`46`	`+ $originalClass->isInterface() ? $originalClass->getName() : null`
`46`	`47`	`);`
`47`	`48`	`}`
`48`	`49`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,9 @@ public function __construct(`
`55`	`55`	`PublicScopeSimulator::OPERATION_GET,`
`56`	`56`	`'name',`
`57`	`57`	`null,`
`58`		`- $valueHolderProperty`
	`58`	`+ $valueHolderProperty,`
	`59`	`+ null,`
	`60`	`+ $originalClass->isInterface() ? $originalClass->getName() : null`
`59`	`61`	`)`
`60`	`62`	`);`
`61`	`63`	`}`