Contrib.social

Add validation constraints to language.entity.*

Open on Drupal.org →
Created on 28 June 2024, 2 months ago
Updated 17 July 2024, about 2 months ago

Problem/Motivation

Language entity is not yet fully validatable:

.vendor/bin/drush config:inspect --filter-keys=language.entity.en --detail --list-constraints
➜  🤖 Analyzing…

 Legend for Data: 
  ✅❓  → Correct primitive type, detailed validation impossible.
  ✅✅  → Correct primitive type, passed all validation constraints.
 ----------------------------------------------- --------- ------------- ------ --------------------------------------------------------------------------------------------- 
  Key                                             Status    Validatable   Data   Validation constraints                                                                       
 ----------------------------------------------- --------- ------------- ------ --------------------------------------------------------------------------------------------- 
  language.entity.en                              Correct   83%           ✅❓   ValidKeys: '<infer>'                                                                         
   language.entity.en:                            Correct   Validatable   ✅✅   ValidKeys: '<infer>'                                                                         
   language.entity.en:_core                       Correct   Validatable   ✅✅   ValidKeys:                                                                                   
                                                                                   - default_config_hash                                                                      
   language.entity.en:_core.default_config_hash   Correct   Validatable   ✅✅   NotNull: {  }                                                                                
                                                                                 Regex: '/^[a-zA-Z0-9\-_]+$/'                                                                 
                                                                                 Length: 43                                                                                   
                                                                                 ↣ PrimitiveType: {  }                                                                        
   language.entity.en:dependencies                Correct   Validatable   ✅✅   ValidKeys: '<infer>'                                                                         
   language.entity.en:direction                   Correct   NOT           ✅❓   ⚠️  @todo Add validation constraints to config entity type: language.entity.*                
   language.entity.en:id                          Correct   NOT           ✅❓   ⚠️  @todo Add validation constraints to config entity type: language.entity.*                
   language.entity.en:label                       Correct   Validatable   ✅✅   Regex:                                                                                       
                                                                                   pattern: '/([^\PC])/u'                                                                     
                                                                                   match: false                                                                               
                                                                                   message: 'Labels are not allowed to span multiple lines or contain control characters.'    
                                                                                 NotBlank: {  }                                                                               
                                                                                 ↣ PrimitiveType: {  }                                                                        
   language.entity.en:langcode                    Correct   Validatable   ✅✅   NotNull: {  }                                                                                
                                                                                 Choice:                                                                                      
                                                                                   callback: 'Drupal\Core\TypedData\Plugin\DataType\LanguageReference::getAllValidLangcodes'  
                                                                                 ↣ PrimitiveType: {  }                                                                        
   language.entity.en:locked                      Correct   Validatable   ✅✅   ↣ PrimitiveType: {  }                                                                        
   language.entity.en:status                      Correct   Validatable   ✅✅   ↣ PrimitiveType: {  }                                                                        
   language.entity.en:uuid                        Correct   Validatable   ✅✅   Uuid: {  }                                                                                   
                                                                                 ↣ PrimitiveType: {  }                                                                        
   language.entity.en:weight                      Correct   Validatable   ✅✅   Range:                                                                                       
                                                                                   min: -2147483648                                                                           
                                                                                   max: 2147483647                                                                            
                                                                                 FullyValidatable: null                                                                       
                                                                                 ↣ PrimitiveType: {  }                                                                        
 ----------------------------------------------- --------- ------------- ------ ---------------------------------------------------------------------------------------------

Steps to reproduce

  1. Get a local git clone of Drupal core 11.x.
  2. composer require drupal/config_inspector — or manually install https://www.drupal.org/project/config_inspector/releases/2.1.5 → or newer (which supports Drupal 11!)
  3. composer require drush/drush
  4. Install language module./vendor/bin/drush en language -y
  5. vendor/bin/drush config:inspect --filter-keys=language.entity.en --detail --list-constraints

Proposed resolution

Add validation constraints to missing properties.

This requires looking at the existing code and admin UI (if any) to understand which values could be considered valid. Eventually this needs to be reviewed by the relevant subsystem maintainer.

For examples, search *.schema.yml files for the string constraints: 😊

Reach out to @borisson_ or @wimleers in the #recipes.

Remaining tasks

MR

User interface changes

None.

API changes

None.

Data model changes

More validation 🚀

Release notes snippet

None.

📌 Task
Status

Fixed

Version

11.0 🔥

Component
Language system  →

Last updated 1 day ago

  • Maintained by
  • 🇩🇪Germany @sun
Created by

🇮🇳India narendraR Jaipur, India

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024