bug #48119 [FrameworkBundle][Lock] Allow to disable lock without defining a resource (MatTheCat)

nicolas-grekas · nicolas-grekas · commit 55486118b448 · 2022-11-05T17:31:46.000+01:00
This PR was merged into the 4.4 branch. Discussion ---------- [FrameworkBundle][Lock] Allow to disable lock without defining a resource | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | N/A | License | MIT | Doc PR | N/A While answering #48115 I noticed a resource is mandatory in lock’s configuration even if it’s disabled because of `requiresAtLeastOneElement`. I replaced it with a validation rule which takes `enabled` into account. Commits ------- 0aad8c8 Allow to disable lock without defining a resource
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -1117,12 +1117,15 @@ private function addLockSection(ArrayNodeDefinition $rootNode)
                         })
                     ->end()
                     ->addDefaultsIfNotSet()
+                    ->validate()
+                        ->ifTrue(static function (array $config) { return $config['enabled'] && !$config['resources']; })
+                        ->thenInvalid('At least one resource must be defined.')
+                    ->end()
                     ->fixXmlConfig('resource')
                     ->children()
                         ->arrayNode('resources')
                             ->normalizeKeys(false)
                             ->useAttributeAsKey('name')
-                            ->requiresAtLeastOneElement()
                             ->defaultValue(['default' => [class_exists(SemaphoreStore::class) && SemaphoreStore::isSupported() ? 'semaphore' : 'flock']])
                             ->beforeNormalization()
                                 ->ifString()->then(function ($v) { return ['default' => $v]; })
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php
@@ -378,6 +378,31 @@ public function testItErrorsWhenDefaultBusDoesNotExist()
         ]);
     }
 
+    public function testLockCanBeDisabled()
+    {
+        $processor = new Processor();
+        $configuration = new Configuration(true);
+
+        $config = $processor->processConfiguration($configuration, [
+            ['lock' => ['enabled' => false]],
+        ]);
+
+        $this->assertFalse($config['lock']['enabled']);
+    }
+
+    public function testEnabledLockNeedsResources()
+    {
+        $processor = new Processor();
+        $configuration = new Configuration(true);
+
+        $this->expectException(InvalidConfigurationException::class);
+        $this->expectExceptionMessage('Invalid configuration for path "framework.lock": At least one resource must be defined.');
+
+        $processor->processConfiguration($configuration, [
+            ['lock' => ['enabled' => true]],
+        ]);
+    }
+
     protected static function getBundleDefaultConfig()
     {
         return [
