Passing Options argument to deprecation closure

yceruto · yceruto · commit 2d531b3acd9a · 2018-10-05T12:39:38.000-04:00
diff --git a/src/Symfony/Component/OptionsResolver/OptionsResolver.php b/src/Symfony/Component/OptionsResolver/OptionsResolver.php
@@ -860,8 +860,20 @@ public function offsetGet($option)
         if (isset($this->deprecated[$option])) {
             $deprecationMessage = $this->deprecated[$option];
 
-            if ($deprecationMessage instanceof \Closure && !\is_string($deprecationMessage = $deprecationMessage($value))) {
-                throw new InvalidOptionsException(sprintf('Invalid type for deprecation message, expected string but got "%s", returns an empty string to ignore.', \gettype($deprecationMessage)));
+            if ($deprecationMessage instanceof \Closure) {
+                // If the closure is already being called, we have a cyclic dependency
+                if (isset($this->calling[$option])) {
+                    throw new OptionDefinitionException(sprintf('The options "%s" have a cyclic dependency.', implode('", "', array_keys($this->calling))));
+                }
+
+                $this->calling[$option] = true;
+                try {
+                    if (!\is_string($deprecationMessage = $deprecationMessage($this, $value))) {
+                        throw new InvalidOptionsException(sprintf('Invalid type for deprecation message, expected string but got "%s", returns an empty string to ignore.', \gettype($deprecationMessage)));
+                    }
+                } finally {
+                    unset($this->calling[$option]);
+                }
             }
 
             if ('' !== $deprecationMessage) {
diff --git a/src/Symfony/Component/OptionsResolver/Tests/Debug/OptionsResolverIntrospectorTest.php b/src/Symfony/Component/OptionsResolver/Tests/Debug/OptionsResolverIntrospectorTest.php
@@ -215,7 +215,7 @@ public function testGetClosureDeprecationMessage()
     {
         $resolver = new OptionsResolver();
         $resolver->setDefined('foo');
-        $resolver->setDeprecated('foo', $closure = function ($value) {});
+        $resolver->setDeprecated('foo', $closure = function (Options $options, $value) {});
 
         $debug = new OptionsResolverIntrospector($resolver);
         $this->assertSame($closure, $debug->getDeprecationMessage('foo'));
diff --git a/src/Symfony/Component/OptionsResolver/Tests/OptionsResolverTest.php b/src/Symfony/Component/OptionsResolver/Tests/OptionsResolverTest.php
@@ -492,13 +492,32 @@ public function testLazyDeprecationFailsIfInvalidDeprecationMessageType()
     {
         $this->resolver
             ->setDefault('foo', true)
-            ->setDeprecated('foo', function ($value) {
+            ->setDeprecated('foo', function (Options $options, $value) {
                 return false;
             })
         ;
         $this->resolver->resolve();
     }
 
+    /**
+     * @expectedException \Symfony\Component\OptionsResolver\Exception\OptionDefinitionException
+     * @expectedExceptionMessage The options "foo", "bar" have a cyclic dependency.
+     */
+    public function testFailsIfCyclicDependencyBetweenDeprecation()
+    {
+        $this->resolver
+            ->setDefault('foo', null)
+            ->setDefault('bar', null)
+            ->setDeprecated('foo', function (Options $options, $value) {
+                $options['bar'];
+            })
+            ->setDeprecated('bar', function (Options $options, $value) {
+                $options['foo'];
+            })
+        ;
+        $this->resolver->resolve();
+    }
+
     public function testIsDeprecated()
     {
         $this->resolver
@@ -590,7 +609,7 @@ function (OptionsResolver $resolver) {
                 $resolver
                     ->setDefault('foo', null)
                     ->setAllowedTypes('foo', array('null', 'string', \stdClass::class))
-                    ->setDeprecated('foo', function ($value) {
+                    ->setDeprecated('foo', function (Options $options, $value) {
                         if ($value instanceof \stdClass) {
                             return sprintf('Passing an instance of "%s" to option "foo" is deprecated, pass its FQCN instead.', \stdClass::class);
                         }
@@ -621,14 +640,35 @@ function (OptionsResolver $resolver) {
             function (OptionsResolver $resolver) {
                 $resolver
                     ->setDefault('foo', null)
-                    ->setDeprecated('foo', function ($value) {
+                    ->setDeprecated('foo', function (Options $options, $value) {
                         return '';
                     })
                 ;
             },
             array('foo' => Bar::class),
             null,
         );
+
+        yield 'It deprecates value depending on other option value' => array(
+            function (OptionsResolver $resolver) {
+                $resolver
+                    ->setDefault('widget', null)
+                    ->setDefault('date_format', null)
+                    ->setDeprecated('date_format', function (Options $options, $dateFormat) {
+                        if (null !== $dateFormat && 'single_text' === $options['widget']) {
+                            return 'Using the "date_format" option when the "widget" option is set to "single_text" is deprecated.';
+                        }
+
+                        return '';
+                    })
+                ;
+            },
+            array('widget' => 'single_text', 'date_format' => 2),
+            array(
+                'type' => E_USER_DEPRECATED,
+                'message' => 'Using the "date_format" option when the "widget" option is set to "single_text" is deprecated.',
+            ),
+        );
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -215,7 +215,7 @@ public function testGetClosureDeprecationMessage()`
`215`	`215`	`{`
`216`	`216`	`$resolver = new OptionsResolver();`
`217`	`217`	`$resolver->setDefined('foo');`
`218`		`- $resolver->setDeprecated('foo', $closure = function ($value) {});`
	`218`	`+ $resolver->setDeprecated('foo', $closure = function (Options $options, $value) {});`
`219`	`219`
`220`	`220`	`$debug = new OptionsResolverIntrospector($resolver);`
`221`	`221`	`$this->assertSame($closure, $debug->getDeprecationMessage('foo'));`