Contrib.social

Add validation constraints to image.style.*

Open on Drupal.org →
Created on 15 May 2024, about 1 month ago
Updated 11 June 2024, 5 days ago

Problem/Motivation

Image style configuration entity is not yet fully validatable:

vendor/bin/drush config:inspect --filter-keys=image.style.large --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                                                                       
 -------------------------------------------------------------------------------- --------- ------------- ------ --------------------------------------------------------------------------------------------- 
  image.style.large                                                                Correct   83%           ✅❓   ValidKeys: '<infer>'                                                                         
   image.style.large:                                                              Correct   Validatable   ✅✅   ValidKeys: '<infer>'                                                                         
   image.style.large:_core                                                         Correct   Validatable   ✅✅   ValidKeys:                                                                                   
                                                                                                                    - default_config_hash                                                                      
   image.style.large:_core.default_config_hash                                     Correct   Validatable   ✅✅   NotNull: {  }                                                                                
                                                                                                                  Regex: '/^[a-zA-Z0-9\-_]+$/'                                                                 
                                                                                                                  Length: 43                                                                                   
                                                                                                                  ↣ PrimitiveType: {  }                                                                        
   image.style.large:dependencies                                                  Correct   Validatable   ✅✅   ValidKeys: '<infer>'                                                                         
   image.style.large:effects                                                       Correct   NOT           ✅❓   ⚠️  @todo Add validation constraints to config entity type: image.style.*                    
   image.style.large:effects.6e8fe467-84c1-4ef0-a73b-7eccf1cc20e8                  Correct   Validatable   ✅✅   ValidKeys: '<infer>'                                                                         
   image.style.large:effects.6e8fe467-84c1-4ef0-a73b-7eccf1cc20e8.data             Correct   Validatable   ✅✅   ValidKeys: '<infer>'                                                                         
   image.style.large:effects.6e8fe467-84c1-4ef0-a73b-7eccf1cc20e8.data.extension   Correct   NOT           ✅❓   ❌ @todo Add validation constraints to ancestor type: image.effect.image_convert             
   image.style.large:effects.6e8fe467-84c1-4ef0-a73b-7eccf1cc20e8.id               Correct   Validatable   ✅✅   PluginExists:                                                                                
                                                                                                                    manager: plugin.manager.image.effect                                                       
                                                                                                                    interface: Drupal\image\ImageEffectInterface                                               
                                                                                                                  ↣ PrimitiveType: {  }                                                                        
   image.style.large:effects.6e8fe467-84c1-4ef0-a73b-7eccf1cc20e8.uuid             Correct   Validatable   ✅✅   Uuid: {  }                                                                                   
                                                                                                                  ↣ PrimitiveType: {  }                                                                        
   image.style.large:effects.6e8fe467-84c1-4ef0-a73b-7eccf1cc20e8.weight           Correct   Validatable   ✅✅   Range:                                                                                       
                                                                                                                    min: -2147483648                                                                           
                                                                                                                    max: 2147483647                                                                            
                                                                                                                  FullyValidatable: null                                                                       
                                                                                                                  ↣ PrimitiveType: {  }                                                                        
   image.style.large:effects.ddd73aa7-4bd6-4c85-b600-bdf2b1628d1d                  Correct   Validatable   ✅✅   ValidKeys: '<infer>'                                                                         
   image.style.large:effects.ddd73aa7-4bd6-4c85-b600-bdf2b1628d1d.data             Correct   Validatable   ✅✅   ValidKeys: '<infer>'                                                                         
   image.style.large:effects.ddd73aa7-4bd6-4c85-b600-bdf2b1628d1d.data.height      Correct   NOT           ✅❓   ❌ @todo Add validation constraints to ancestor type: image.effect.image_scale               
   image.style.large:effects.ddd73aa7-4bd6-4c85-b600-bdf2b1628d1d.data.upscale     Correct   Validatable   ✅✅   ↣ PrimitiveType: {  }                                                                        
   image.style.large:effects.ddd73aa7-4bd6-4c85-b600-bdf2b1628d1d.data.width       Correct   NOT           ✅❓   ❌ @todo Add validation constraints to ancestor type: image.effect.image_scale               
   image.style.large:effects.ddd73aa7-4bd6-4c85-b600-bdf2b1628d1d.id               Correct   Validatable   ✅✅   PluginExists:                                                                                
                                                                                                                    manager: plugin.manager.image.effect                                                       
                                                                                                                    interface: Drupal\image\ImageEffectInterface                                               
                                                                                                                  ↣ PrimitiveType: {  }                                                                        
   image.style.large:effects.ddd73aa7-4bd6-4c85-b600-bdf2b1628d1d.uuid             Correct   Validatable   ✅✅   Uuid: {  }                                                                                   
                                                                                                                  ↣ PrimitiveType: {  }                                                                        
   image.style.large:effects.ddd73aa7-4bd6-4c85-b600-bdf2b1628d1d.weight           Correct   Validatable   ✅✅   Range:                                                                                       
                                                                                                                    min: -2147483648                                                                           
                                                                                                                    max: 2147483647                                                                            
                                                                                                                  FullyValidatable: null                                                                       
                                                                                                                  ↣ PrimitiveType: {  }                                                                        
   image.style.large:label                                                         Correct   Validatable   ✅✅   Regex:                                                                                       
                                                                                                                    pattern: '/([^\PC])/u'                                                                     
                                                                                                                    match: false                                                                               
                                                                                                                    message: 'Labels are not allowed to span multiple lines or contain control characters.'    
                                                                                                                  NotBlank: {  }                                                                               
                                                                                                                  ↣ PrimitiveType: {  }                                                                        
   image.style.large:langcode                                                      Correct   Validatable   ✅✅   NotNull: {  }                                                                                
                                                                                                                  Choice:                                                                                      
                                                                                                                    callback: 'Drupal\Core\TypedData\Plugin\DataType\LanguageReference::getAllValidLangcodes'  
                                                                                                                  ↣ PrimitiveType: {  }                                                                        
   image.style.large:name                                                          Correct   Validatable   ✅✅   Regex:                                                                                       
                                                                                                                    pattern: '/^[a-z0-9_]+$/'                                                                  
                                                                                                                    message: 'The %value machine name is not valid.'                                           
                                                                                                                  Length:                                                                                      
                                                                                                                    max: 166                                                                                   
                                                                                                                  ↣ PrimitiveType: {  }                                                                        
   image.style.large:status                                                        Correct   Validatable   ✅✅   ↣ PrimitiveType: {  }                                                                        
   image.style.large:uuid                                                          Correct   Validatable   ✅✅   Uuid: {  }                                                                                   
                                                                                                                  ↣ 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. vendor/bin/drush config:inspect --filter-keys=image.style.large --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 #distributions-and-recipes.

Remaining tasks

User interface changes

None.

API changes

None.

Data model changes

More validation 🚀

Release notes snippet

None.

📌 Task
Status

Fixed

Version

11.0 🔥

Component
Image module  →

Last updated 5 days ago

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.69.0 2024