Issue #3427564 by phenaproxima, Wim Leers, alexpott, omkar.podey, Berdir,...

Issue #3427564 by phenaproxima, Wim Leers, alexpott, omkar.podey, Berdir, smustgrave, larowlan: Require `langcode: …` only for simple config that contains translatable values

(cherry picked from commit 83a53ba4)

core/config/schema/core.data_types.schema.yml

@@ -207,7 +207,15 @@ config_object:
       requiredKey: false
       type: _core_config_info
     langcode:
+      requiredKey: false
       type: langcode
+  constraints:
+    # The `langcode` key:
+    # - MUST be specified when there are translatable values
+    # - MUST NOT be specified when there are no translatable values.
+    # Translatable values are specified for this config schema type (a subtype of `type: config_object`) if the
+    # `translatable` flag is present and set to `true` for *any* element in that config schema type.
+    LangcodeRequiredIfTranslatableValues: ~
 
 # Mail text with subject and body parts.
 mail:

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

+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\Core\Config\Plugin\Validation\Constraint;
+
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\Core\Validation\Attribute\Constraint;
+use Symfony\Component\Validator\Constraint as SymfonyConstraint;
+
+#[Constraint(
+  id: 'LangcodeRequiredIfTranslatableValues',
+  label: new TranslatableMarkup('Translatable config has langcode', [], ['context' => 'Validation']),
+  type: ['config_object']
+)]
+class LangcodeRequiredIfTranslatableValuesConstraint extends SymfonyConstraint {
+
+  /**
+   * The error message if this config object is missing a `langcode`.
+   *
+   * @var string
+   */
+  public string $missingMessage = "The @name config object must specify a language code, because it contains translatable values.";
+
+  /**
+   * The error message if this config object contains a superfluous `langcode`.
+   *
+   * @var string
+   */
+  public string $superfluousMessage = "The @name config object does not contain any translatable values, so it should not specify a language code.";
+
+}

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

+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\Core\Config\Plugin\Validation\Constraint;
+
+use Drupal\Core\Config\Schema\Mapping;
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\ConstraintValidator;
+use Symfony\Component\Validator\Exception\LogicException;
+
+/**
+ * Validates the LangcodeRequiredIfTranslatableValues constraint.
+ */
+final class LangcodeRequiredIfTranslatableValuesConstraintValidator extends ConstraintValidator {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function validate(mixed $value, Constraint $constraint) {
+    assert($constraint instanceof LangcodeRequiredIfTranslatableValuesConstraint);
+
+    $mapping = $this->context->getObject();
+    assert($mapping instanceof Mapping);
+    if ($mapping !== $this->context->getRoot()) {
+      throw new LogicException('The LangcodeRequiredIfTranslatableValues constraint can only operate on the root object being validated.');
+    }
+
+    assert(in_array('langcode', $mapping->getValidKeys(), TRUE));
+
+    $is_translatable = $mapping->hasTranslatableElements();
+
+    if ($is_translatable && !array_key_exists('langcode', $value)) {
+      $this->context->buildViolation($constraint->missingMessage)
+        ->setParameter('@name', $mapping->getName())
+        ->addViolation();
+      return;
+    }
+    if (!$is_translatable && array_key_exists('langcode', $value)) {
+      // @todo Convert this deprecation to an actual validation error in
+      //   https://www.drupal.org/project/drupal/issues/3440238.
+      // phpcs:ignore
+      @trigger_error(str_replace('@name', $mapping->getName(), $constraint->superfluousMessage), E_USER_DEPRECATED);
+    }
+  }
+
+}

core/lib/Drupal/Core/Config/Schema/ArrayElement.php

@@ -14,6 +14,25 @@ abstract class ArrayElement extends Element implements \IteratorAggregate, Typed
    */
   protected $elements;
 
+  /**
+   * Determines if there is a translatable value.
+   *
+   * @return bool
+   *   Returns true if a translatable element is found.
+   */
+  public function hasTranslatableElements(): bool {
+    foreach ($this as $element) {
+      // Early return if found.
+      if ($element->getDataDefinition()['translatable'] === TRUE) {
+        return TRUE;
+      }
+      if ($element instanceof ArrayElement && $element->hasTranslatableElements()) {
+        return TRUE;
+      }
+    }
+    return FALSE;
+  }
+
   /**
    * Gets valid configuration data keys.
    *

core/lib/Drupal/Core/Config/Schema/SchemaCheckTrait.php

@@ -93,13 +93,6 @@ trait SchemaCheckTrait {
    *   valid.
    */
   public function checkConfigSchema(TypedConfigManagerInterface $typed_config, $config_name, $config_data, bool $validate_constraints = FALSE) {
-    // We'd like to verify that the top-level type is either config_base,
-    // config_entity, or a derivative. The only thing we can really test though
-    // is that the schema supports having langcode in it. So add 'langcode' to
-    // the data if it doesn't already exist.
-    if (!isset($config_data['langcode'])) {
-      $config_data['langcode'] = 'en';
-    }
     $this->configName = $config_name;
     if (!$typed_config->hasConfigSchema($config_name)) {
       return FALSE;

core/modules/config/tests/config_schema_test/config/install/config_schema_test.ignore.yml

+langcode: en
 label: 'Label string'
 irrelevant: 123
 indescribable:

core/modules/config/tests/config_schema_test/config/install/config_schema_test.some_schema.some_module.section_one.subsection.yml

+langcode: en
 test_id: 'Test id'
 test_description: 'Test description'

core/modules/config/tests/config_schema_test/config/install/config_schema_test.some_schema.some_module.section_two.subsection.yml

+langcode: en
 test_id: 'Test id'
 test_description: 'Test description'

core/modules/config/tests/config_test/config/install/config_test.no_status.default.yml

+langcode: en
 id: default
 label: Default

core/modules/config/tests/config_test/config/install/config_test.validation.yml

@@ -6,5 +6,4 @@ giraffe:
   hum1: hum1
   hum2: hum2
 uuid: '7C30C50E-641A-4E34-A7F1-46BCFB9BE5A3'
-langcode: en
 string__not_blank: 'this is a label'

core/modules/config/tests/config_test/config_test.module

@@ -38,7 +38,7 @@ function config_test_entity_type_alter(array &$entity_types) {
   $config_test_no_status->set('id', 'config_test_no_status');
   $config_test_no_status->set('entity_keys', $keys);
   $config_test_no_status->set('config_prefix', 'no_status');
-  $config_test_no_status->set('mergedConfigExport', ['id' => 'id', 'label' => 'label', 'uuid' => 'uuid']);
+  $config_test_no_status->set('mergedConfigExport', ['id' => 'id', 'label' => 'label', 'uuid' => 'uuid', 'langcode' => 'langcode']);
   if (\Drupal::service('state')->get('config_test.lookup_keys', FALSE)) {
     $entity_types['config_test']->set('lookup_keys', ['uuid', 'style']);
   }

core/modules/dblog/config/install/dblog.settings.yml

-langcode: en
 row_limit: 1000

core/modules/dblog/dblog.post_update.php

@@ -5,18 +5,6 @@
  * Post update functions for the Database Logging module.
  */
 
-/**
- * Ensures the `dblog.settings` config has a langcode.
- */
-function dblog_post_update_add_langcode_to_settings(): void {
-  $config = \Drupal::configFactory()->getEditable('dblog.settings');
-  if ($config->get('langcode')) {
-    return;
-  }
-  $config->set('langcode', \Drupal::languageManager()->getDefaultLanguage()->getId())
-    ->save();
-}
-
 /**
  * Implements hook_removed_post_updates().
  */

core/modules/dblog/tests/src/Functional/UpdatePathTest.php

@@ -24,18 +24,6 @@ protected function setDatabaseDumpFiles() {
     ];
   }
 
-  /**
-   * Tests that updating adds a langcode to the dblog.settings config.
-   */
-  public function testAddLangcodeToSettings(): void {
-    $this->assertEmpty($this->config('dblog.settings')->get('langcode'));
-    $this->runUpdates();
-    $default_langcode = $this->container->get('language_manager')
-      ->getDefaultLanguage()
-      ->getId();
-    $this->assertSame($default_langcode, $this->config('dblog.settings')->get('langcode'));
-  }
-
   /**
    * Tests that, after update 10101, the 'wid' column can be a 64-bit integer.
    */

core/modules/jsonapi/config/install/jsonapi.settings.yml

-langcode: en
 read_only: true
 maintenance_header_retry_seconds:
   min: 5

core/modules/layout_builder/tests/src/Functional/LayoutBuilderTest.php

@@ -703,6 +703,10 @@ public function testSimpleConfigBasedLayout() {
     // Prepare an object with a pre-existing section.
     $this->container->get('config.factory')->getEditable('layout_builder_test.test_simple_config.existing')
       ->set('sections', [(new Section('layout_twocol'))->toArray()])
+      // `layout_builder_test.test_simple_config.existing.sections.0.layout_settings.label`
+      // contains a translatable label, so a `langcode` is required.
+      // @see \Drupal\Core\Config\Plugin\Validation\Constraint\LangcodeRequiredIfTranslatableValuesConstraint
+      ->set('langcode', 'en')
       ->save();
 
     // The pre-existing section is found.

core/modules/locale/src/LocaleConfigManager.php

@@ -668,8 +668,12 @@ public function updateDefaultConfigLangcodes() {
         // Should only update if still exists in active configuration. If locale
         // module is enabled later, then some configuration may not exist anymore.
         if (!$config->isNew()) {
+          $typed_config = $this->typedConfigManager->createFromNameAndData($config->getName(), $config->getRawData());
           $langcode = $config->get('langcode');
-          if (empty($langcode) || $langcode == 'en') {
+          // Only set a `langcode` if this config actually contains translatable
+          // data.
+          // @see \Drupal\Core\Config\Plugin\Validation\Constraint\LangcodeRequiredIfTranslatableValuesConstraint
+          if (!empty($this->getTranslatableData($typed_config)) && (empty($langcode) || $langcode == 'en')) {
             $config->set('langcode', $default_langcode)->save();
           }
         }

core/modules/locale/tests/modules/locale_test/config/install/locale_test.no_translation.yml

+langcode: en
 test: Test

core/modules/locale/tests/modules/locale_test/config/install/locale_test.translation.yml

+langcode: en
 test: English test

core/modules/locale/tests/modules/locale_test/config/install/locale_test.translation_multiple.yml

+langcode: en
 test: English test
 test_multiple:
   string: 'A string'