Problem/Motivation

Drupal Core has a similar inspection for entity definitions that is reported on the 'Status report':

image of error

I would suggest to

Proposed resolution

Add an entry to the Status report page reporting configuration errors similar entry for configuration entity schema errors in line with the Entity definitions mismatches reported by Drupal core.

Remaining tasks

  1. Write a patch
  2. Review
  3. Commit

User interface changes

The Status report page reports configuration errors similar entry for configuration entity schema errors in line with the Entity definitions mismatches reported by Drupal core.

API changes

None.

Data model changes

None.

CommentFileSizeAuthor
#5 interdiff-3-5.txt898 bytesidebr
#5 config_inspector-show_error_on_status_report-3009151-5.patch2.07 KBidebr
#3 config_inspector-show_error_on_status_report-3009151-3.patch2.12 KBidebr
#3 config-schema-errors-status-report.png68.01 KBidebr

Comments

idebr created an issue. See original summary.

gábor hojtsy’s picture

gábor hojtsy
he/him
Primary language Hungarian
Location Hungary
commented

Great idea. Can you work out a patch? Thanks!

idebr’s picture

idebr commented
Issue summary: View changes
Status: Active » Needs review
StatusFileSize
new config-schema-errors-status-report.png68.01 KB
new config_inspector-show_error_on_status_report-3009151-3.patch2.12 KB

Attached patch adds an entry to the Status report page reporting configuration errors similar entry for configuration schema errors in line with the Entity definitions mismatches reported by Drupal core.

Screenshot after applying patch:

gábor hojtsy’s picture

gábor hojtsy
he/him
Primary language Hungarian
Location Hungary
commented
Status: Needs review » Needs work

Yay, thanks, looks good. Just two minor improvements:

  1. +++ b/config_inspector.install
@@ -0,0 +1,54 @@
+        '#title' => t('The following configuration has schema errors:'),

    'Errors found' would be enough since the summary value already explains what this is about. Looking at the screenshot I would just avoid having this title altogether, it does not add anything. 

  2. +++ b/config_inspector.install
@@ -0,0 +1,54 @@
+      'value' => t('All configuration inspected without errors.'),

    'No configuration structure errors found' or something along those lines would be more accurate. "Inspector" in the module name relates to the actual UIs that let you "zoom into" the config data and figure out schema definition issues rather than guessing. So that the config was "inspected" would not be accurate to say.

idebr’s picture

idebr commented
Status: Needs work » Needs review
StatusFileSize
new config_inspector-show_error_on_status_report-3009151-5.patch2.07 KB
new interdiff-3-5.txt898 bytes

#4.1 Perhaps I took a bit too much inspiration from the 'mismatches entity definitions' error. I agree the item list title does not add any useful information, so I removed this from the patch

#4.2 I updated the requirement values so they match each other's wording:

  • Ok: "The site's configuration matches the associated schema."
  • Error: "The site's configuration does not match the associated schema."

I don't have a strong opinion on the interface text, so feel free to change this if you feel like it.

  • Gábor Hojtsy committed 3430c9b on 8.x-1.x 
    Issue #3009151 by idebr: Show configuration schema errors on the status...
gábor hojtsy’s picture

gábor hojtsy
he/him
Primary language Hungarian
Location Hungary
commented
Status: Needs review » Fixed

Yay, thanks! I think consistent text is indeed better.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.