Issue #3422398 by Wim Leers, phenaproxima: Allow specifying a prefix for...

Issue #3422398 by Wim Leers, phenaproxima: Allow specifying a prefix for ConfigExistsConstraint, to enable using it for references to config entities

(cherry picked from commit 7a286515)

core/lib/Drupal/Core/Config/Plugin/Validation/Constraint/ConfigExistsConstraint.php

@@ -23,4 +23,15 @@ class ConfigExistsConstraint extends Constraint {
    */
   public string $message = "The '@name' config does not exist.";
 
+  /**
+   * Optional prefix, to be specified when this contains a config entity ID.
+   *
+   * Every config entity type can have multiple instances, all with unique IDs
+   * but the same config prefix. When config refers to a config entity,
+   * typically only the ID is stored, not the prefix.
+   *
+   * @var string
+   */
+  public string $prefix = '';
+
 }

core/lib/Drupal/Core/Config/Plugin/Validation/Constraint/ConfigExistsConstraintValidator.php

@@ -43,13 +43,15 @@ public static function create(ContainerInterface $container) {
    * {@inheritdoc}
    */
   public function validate(mixed $name, Constraint $constraint) {
+    assert($constraint instanceof ConfigExistsConstraint);
+
     // This constraint may be used to validate nullable (optional) values.
     if ($name === NULL) {
       return;
     }
 
-    if (!in_array($name, $this->configFactory->listAll(), TRUE)) {
-      $this->context->addViolation($constraint->message, ['@name' => $name]);
+    if (!in_array($constraint->prefix . $name, $this->configFactory->listAll($constraint->prefix), TRUE)) {
+      $this->context->addViolation($constraint->message, ['@name' => $constraint->prefix . $name]);
     }
   }
 

core/tests/Drupal/KernelTests/Core/Config/ConfigExistsConstraintValidatorTest.php

@@ -23,20 +23,23 @@ class ConfigExistsConstraintValidatorTest extends KernelTestBase {
 
   /**
    * Tests the ConfigExists constraint validator.
+   *
+   * @testWith [{}, "system.site", "system.site"]
+   *           [{"prefix": "system."}, "site", "system.site"]
    */
-  public function testValidation(): void {
+  public function testValidation(array $constraint_options, string $value, string $expected_config_name): void {
     // Create a data definition that specifies the value must be a string with
     // the name of an existing piece of config.
     $definition = DataDefinition::create('string')
-      ->addConstraint('ConfigExists');
+      ->addConstraint('ConfigExists', $constraint_options);
 
     /** @var \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data */
     $typed_data = $this->container->get('typed_data_manager');
-    $data = $typed_data->create($definition, 'system.site');
+    $data = $typed_data->create($definition, $value);
 
     $violations = $data->validate();
     $this->assertCount(1, $violations);
-    $this->assertSame("The 'system.site' config does not exist.", (string) $violations->get(0)->getMessage());
+    $this->assertSame("The '$expected_config_name' config does not exist.", (string) $violations->get(0)->getMessage());
 
     $this->installConfig('system');
     $this->assertCount(0, $data->validate());