Add validation constraints to contact.form.*

Created on 8 May 2024, 2 months ago
Updated 3 July 2024, 9 days ago

Problem/Motivation

Contact form entity is not yet fully validatable:

.vendor/bin/drush config:inspect --filter-keys=contact.form.feedback --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                                                                       
 -------------------------------------------------- --------- ------------- ------ --------------------------------------------------------------------------------------------- 
  contact.form.feedback                              Correct   87%           โœ…โ“   ValidKeys: '<infer>'                                                                         
   contact.form.feedback:                            Correct   Validatable   โœ…โœ…   ValidKeys: '<infer>'                                                                         
   contact.form.feedback:_core                       Correct   Validatable   โœ…โœ…   ValidKeys:                                                                                   
                                                                                      - default_config_hash                                                                      
   contact.form.feedback:_core.default_config_hash   Correct   Validatable   โœ…โœ…   NotNull: {  }                                                                                
                                                                                    Regex: '/^[a-zA-Z0-9\-_]+$/'                                                                 
                                                                                    Length: 43                                                                                   
                                                                                    โ†ฃ PrimitiveType: {  }                                                                        
   contact.form.feedback:dependencies                Correct   Validatable   โœ…โœ…   ValidKeys: '<infer>'                                                                         
   contact.form.feedback:id                          Correct   Validatable   โœ…โœ…   Length:                                                                                      
                                                                                      max: 32                                                                                    
                                                                                    โ†ฃ PrimitiveType: {  }                                                                        
                                                                                    โ†ฃ Regex:                                                                                     
                                                                                      pattern: '/^[a-z0-9_]+$/'                                                                  
                                                                                      message: 'The %value machine name is not valid.'                                           
   contact.form.feedback:label                       Correct   Validatable   โœ…โœ…   Regex:                                                                                       
                                                                                      pattern: '/([^\PC])/u'                                                                     
                                                                                      match: false                                                                               
                                                                                      message: 'Labels are not allowed to span multiple lines or contain control characters.'    
                                                                                    NotBlank: {  }                                                                               
                                                                                    โ†ฃ PrimitiveType: {  }                                                                        
   contact.form.feedback:langcode                    Correct   Validatable   โœ…โœ…   NotNull: {  }                                                                                
                                                                                    Choice:                                                                                      
                                                                                      callback: 'Drupal\Core\TypedData\Plugin\DataType\LanguageReference::getAllValidLangcodes'  
                                                                                    โ†ฃ PrimitiveType: {  }                                                                        
   contact.form.feedback:message                     Correct   Validatable   โœ…โœ…   Regex:                                                                                       
                                                                                      pattern: '/([^\PC\x09\x0a\x0d])/u'                                                         
                                                                                      match: false                                                                               
                                                                                      message: 'Text is not allowed to contain control characters, only visible characters.'     
                                                                                    โ†ฃ PrimitiveType: {  }                                                                        
   contact.form.feedback:recipients                  Correct   NOT           โœ…โ“   โš ๏ธ  @todo Add validation constraints to config entity type: contact.form.*                   
   contact.form.feedback:recipients.0                Correct   Validatable   โœ…โœ…   Email:                                                                                       
                                                                                      message: '%value is not a valid email address.'                                            
                                                                                    โ†ฃ PrimitiveType: {  }                                                                        
   contact.form.feedback:redirect                    Correct   NOT           โœ…โ“   โš ๏ธ  @todo Add validation constraints to config entity type: contact.form.*                   
   contact.form.feedback:reply                       Correct   Validatable   โœ…โœ…   Regex:                                                                                       
                                                                                      pattern: '/([^\PC\x09\x0a\x0d])/u'                                                         
                                                                                      match: false                                                                               
                                                                                      message: 'Text is not allowed to contain control characters, only visible characters.'     
                                                                                    โ†ฃ PrimitiveType: {  }                                                                        
   contact.form.feedback:status                      Correct   Validatable   โœ…โœ…   โ†ฃ PrimitiveType: {  }                                                                        
   contact.form.feedback:uuid                        Correct   Validatable   โœ…โœ…   Uuid: {  }                                                                                   
                                                                                    โ†ฃ PrimitiveType: {  }                                                                        
   contact.form.feedback: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. vendor/bin/drush config:inspect --filter-keys=contact.form.feedback --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

MR

User interface changes

None.

API changes

None.

Data model changes

More validation ๐Ÿš€

Release notes snippet

None.

๐Ÿ“Œ Task
Status

Needs review

Version

11.0 ๐Ÿ”ฅ

Component
Contactย  โ†’

Last updated 1 day 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

  • Issue created by @narendraR
  • Status changed to Needs work 2 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia narendraR Jaipur, India

    ๐Ÿ˜ฌ Forgot to change status while cloning

  • Merge request !7962constraint added โ†’ (Open) created by narendraR
  • Pipeline finished with Failed
    2 months ago
    Total: 705s
    #167399
  • ๐Ÿ‡ง๐Ÿ‡ชBelgium Wim Leers Ghent ๐Ÿ‡ง๐Ÿ‡ช๐Ÿ‡ช๐Ÿ‡บ

    #2: Hah! :D

    This is a good start, but there's a bunch left to do.

  • First commit to issue fork.
  • Pipeline finished with Failed
    2 months ago
    Total: 518s
    #168155
  • ๐Ÿ‡ซ๐Ÿ‡ทFrance andypost

    I see no reason to allow weight to be nullable

  • Pipeline finished with Failed
    2 months ago
    Total: 544s
    #171419
  • Pipeline finished with Failed
    2 months ago
    Total: 582s
    #171558
  • Pipeline finished with Failed
    2 months ago
    #171677
  • Pipeline finished with Failed
    about 2 months ago
    Total: 603s
    #172161
  • Pipeline finished with Success
    about 2 months ago
    Total: 697s
    #172367
  • Pipeline finished with Failed
    about 2 months ago
    Total: 700s
    #172647
  • Pipeline finished with Canceled
    about 2 months ago
    Total: 8s
    #173028
  • Pipeline finished with Success
    about 2 months ago
    Total: 574s
    #173029
  • Status changed to Needs review about 2 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia narendraR Jaipur, India
  • Status changed to Needs work about 2 months ago
  • ๐Ÿ‡ซ๐Ÿ‡ทFrance andypost

    Left review on MR - we can add proper types with deprecation message as 11.x going beta

  • Pipeline finished with Canceled
    about 2 months ago
    Total: 77s
    #176820
  • Pipeline finished with Success
    about 2 months ago
    Total: 577s
    #176822
  • Pipeline finished with Failed
    about 2 months ago
    Total: 607s
    #176844
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia narendraR Jaipur, India

    I tried to add deprecation message in previous commit, not sure if this is the correct way or not. But due to this change tests started failing. https://git.drupalcode.org/issue/drupal-3445976/-/jobs/1632410#L2068

  • Pipeline finished with Failed
    about 2 months ago
    Total: 652s
    #178386
  • Pipeline finished with Success
    about 2 months ago
    Total: 2539s
    #178955
  • Status changed to Needs review about 2 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia narendraR Jaipur, India
  • Status changed to RTBC about 2 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia srishtiiee

    The MR looks good, I think it just needs a CR for the deprecation. RTBC'd otherwise ๐Ÿ‘๐Ÿผ

  • Status changed to Needs work about 2 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia narendraR Jaipur, India

    Moved to NW for fixing deprecation errors in better way

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia narendraR Jaipur, India

    I attempted to remove the @legacy from the tests, which I added in previous commit, but it seems something was done incorrectly in the MR, resulting in deprecation errors. I would appreciate any assistance.

  • First commit to issue fork.
  • Pipeline finished with Success
    about 1 month ago
    Total: 538s
    #185128
  • Pipeline finished with Failed
    about 1 month ago
    Total: 780s
    #185749
  • Pipeline finished with Success
    about 1 month ago
    Total: 670s
    #185793
  • Status changed to Needs review about 1 month ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia narendraR Jaipur, India
  • Status changed to Needs work about 1 month ago
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States phenaproxima Massachusetts

    I noticed a few more things but this is looking very close to ready. It does still need a change record.

  • Pipeline finished with Canceled
    about 1 month ago
    Total: 139s
    #189487
  • Pipeline finished with Failed
    about 1 month ago
    Total: 613s
    #189488
  • Pipeline finished with Success
    about 1 month ago
    Total: 537s
    #191695
  • Status changed to Needs review about 1 month ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia narendraR Jaipur, India
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States mtift Minnesota, USA

    This one makes sense to me. All of the reply & redirect issues have been addressed per https://www.drupal.org/node/3452650 โ†’ . The deprecation messages and tests make sense. The feedback has been addressed.

    However, I applied the MR on a standard install for 11.x with config inspector and got all green checks, but it shows "1 errors" and I'm not quite sure what that is referring to:

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States phenaproxima Massachusetts

    I know nothing about config inspector, but I assume that it's flagging an error in the data in that config object, not any problem with the validation constraints themselves.

  • Status changed to RTBC 29 days ago
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States smustgrave

    Regarding #18 did you run updb? When I applied the MR, before running updb, I saw the error in configuration inspector.

    On a standard 11.x profile install
    Installed configuration inspector
    Applied the MR
    Ran drush updb

    Reviewing the code thanks @phenaproxima for pointing out scope issue.

    Searched for .feedback.yml files and all appear to be updated.

    Believe this one is good to go.

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States mtift Minnesota, USA

    That was it. Thank you @smustgrave!

    FWIW, this looks good to me, too.

  • Status changed to Needs work 15 days ago
  • ๐Ÿ‡ฌ๐Ÿ‡งUnited Kingdom alexpott ๐Ÿ‡ช๐Ÿ‡บ๐ŸŒ

    This MR no prevents me from removing the message from a contact form. If I installed standard with this MR applied and go to admin/structure/contact/manage/feedback and remove all the text in the message field and press save the empty message field is not saved. If I remove the MR and a tried again I can empty the field and saves as expected.

  • Pipeline finished with Success
    10 days ago
    Total: 519s
    #213816
  • Pipeline finished with Success
    9 days ago
    Total: 629s
    #214632
  • Status changed to Needs review 9 days ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia narendraR Jaipur, India

    Re #22, I updated the code to set values to NULL.
    Reverting changes related to message(message: '') will fail ContactFormValidationTest.

  • Pipeline finished with Success
    9 days ago
    Total: 514s
    #214688
Production build 0.69.0 2024