feat: #3589846 Save-time validation enforcement, stamp infrastructure, and cron scanning

Squash of validity stamp foundation work: stamp table, ValidityStampWriter,
save-time enforcement toggle, orphan cleanup, cron queue worker, and
post-update hook for migration.

Author: slucero

.cspell-project-words.txt

@@ -11,7 +11,11 @@ endlink
 expirable
 fieldable
 langcode
+langcodes
+onecol
 patternkit
+presaved
+varchar
 predelete
 prophesize
 revisionable
@@ -50,6 +54,8 @@ rulesets
 styleguides
 subpattern
 subschema
+upsert
+upserts
 wysiwygs
 
 # CSS classes

.cspell.json

@@ -2,6 +2,17 @@
   "version": "0.2",
   "language": "en",
   "words": [],
+  "flagWords": [
+    "blacklist",
+    "blacklists",
+    "blacklisted",
+    "e-mail",
+    "grey",
+    "queuing",
+    "whitelist",
+    "whitelists",
+    "whitelisted"
+  ],
   "dictionaries": ["project-words", "php", "css", "html", "typescript"],
   "dictionaryDefinitions": [
     {

.ddev/commands/web/symlink-project

@@ -1,6 +1,5 @@
 #!/usr/bin/env bash
 
-#ddev-generated
 ## Command provided by https://github.com/ddev/ddev-drupal-contrib
 ## Description: Symlink project files into the configured location (defaults to `web/modules/custom/[PROJECT_NAME]`)
 ## Usage: symlink-project [flags] [args]
@@ -25,3 +24,7 @@ fi
 export DRUPAL_PROJECT_FOLDER=${DDEV_DOCROOT}/${DRUPAL_PROJECTS_PATH}/${DDEV_SITENAME//-/_}
 php symlink_project.php
 rm -f symlink_project.php
+
+# Remove stale .worktrees symlink created by symlink-project to prevent PHPUnit
+# from following it and loading stale class versions from worktrees.
+rm -f "${DRUPAL_PROJECT_FOLDER}/.worktrees"

config/install/patternkit.settings.yml

@@ -8,3 +8,4 @@ patternkit_json_editor_disable_properties_buttons: false
 patternkit_json_editor_disable_edit_json_button: true
 patternkit_json_editor_cache_schemas: false
 entity_cache_tag_invalidation: false
+render_validation_on_save: true

config/schema/patternkit.schema.yml

@@ -31,6 +31,9 @@ patternkit.settings:
     entity_cache_tag_invalidation:
       type: boolean
       label: 'Boolean determining whether Pattern entity cache tags are invalidated during Pattern updates.'
+    render_validation_on_save:
+      type: boolean
+      label: 'Boolean determining whether invalid pattern configuration is blocked at save time.'
     patternkit_json_editor_wysiwyg:
       type: string
       label: 'String selecting the WYSIWYG tool to use in the JSON Editor.'

modules/patternkit_example/lib/patternkit/src/components/media_combined_embed/media_combined_embed.json

@@ -22,6 +22,6 @@
       "$ref": "@patternkit/components/media_video_embed/media_video_embed"
     }
   },
-  "required": ["name"],
+  "required": [],
   "additionalProperties": false
 }

modules/patternkit_example/lib/patternkit/src/components/media_image_embed/media_image_embed.json

@@ -20,6 +20,6 @@
       "format": "image-media"
     }
   },
-  "required": ["name", "image"],
+  "required": ["image"],
   "additionalProperties": false
 }

modules/patternkit_example/lib/patternkit/src/components/media_video_embed/media_video_embed.json

@@ -20,6 +20,6 @@
       "format": "video-media"
     }
   },
-  "required": ["name", "video"],
+  "required": ["video"],
   "additionalProperties": false
 }

modules/patternkit_example/lib/patternkit/src/components/media_wrapper/media_wrapper.json

@@ -29,6 +29,6 @@
       }
     }
   },
-  "required": ["name"],
+  "required": [],
   "additionalProperties": false
 }

patternkit.install

@@ -33,6 +33,86 @@ function patternkit_uninstall(bool $is_syncing): void {
   // Cleanup the update results collection value if it exists.
   \Drupal::keyValue(LayoutUpdateBatchManager::RESULTS_COLLECTION)
     ->deleteAll();
+
+  $schema = \Drupal::database()->schema();
+  if ($schema->tableExists('patternkit_block_validity')) {
+    $schema->dropTable('patternkit_block_validity');
+  }
+}
+
+/**
+ * Implements hook_schema().
+ */
+function patternkit_schema(): array {
+  $schema['patternkit_block_validity'] = [
+    'description' => 'Validity stamps for patternkit_block translations (published content index).',
+    'fields' => [
+      'block_entity_id' => [
+        'type' => 'int',
+        'unsigned' => TRUE,
+        'not null' => TRUE,
+        'description' => 'The patternkit_block entity ID.',
+      ],
+      'langcode' => [
+        'type' => 'varchar_ascii',
+        'length' => 12,
+        'not null' => TRUE,
+        'description' => 'The translation language code.',
+      ],
+      'block_revision_id' => [
+        'type' => 'int',
+        'unsigned' => TRUE,
+        'not null' => TRUE,
+        'description' => 'The block revision ID at validation time.',
+      ],
+      'pattern_revision_id' => [
+        'type' => 'int',
+        'unsigned' => TRUE,
+        'not null' => TRUE,
+        'description' => 'The pattern revision ID used when validating.',
+      ],
+      'is_valid' => [
+        'type' => 'int',
+        'size' => 'tiny',
+        'not null' => TRUE,
+        'default' => 0,
+        'description' => 'Whether content validated successfully.',
+      ],
+      'has_tokens' => [
+        'type' => 'int',
+        'size' => 'tiny',
+        'not null' => TRUE,
+        'default' => 0,
+        'description' => 'Whether token-shaped values were present at stamp time.',
+      ],
+      'validated_at' => [
+        'type' => 'int',
+        'not null' => TRUE,
+        'description' => 'Unix timestamp when validation ran.',
+      ],
+      'stamp_source' => [
+        'type' => 'varchar_ascii',
+        'length' => 32,
+        'not null' => TRUE,
+        'default' => 'save',
+        'description' => 'Origin of the stamp (save, cron_scan, etc.).',
+      ],
+      'component_uuid' => [
+        'type' => 'varchar_ascii',
+        'length' => 128,
+        'not null' => FALSE,
+        'description' => 'Layout Builder SectionComponent UUID when known.',
+      ],
+    ],
+    'primary key' => ['block_entity_id', 'langcode'],
+    'indexes' => [
+      'block_validity_is_valid' => ['is_valid'],
+      'block_validity_pattern_revision' => ['pattern_revision_id'],
+      'block_validity_component_uuid' => ['component_uuid'],
+    ],
+  ];
+
+  return $schema;
 }
 
 /**
@@ -681,3 +761,15 @@ function patternkit_update_10310(): string {
   );
   return t('Restored reusable field storage for the 9.1.x migration window.');
 }
+
+/**
+ * Adds the patternkit_block_validity table for block validity stamps.
+ */
+function patternkit_update_10311(): void {
+  $schema = patternkit_schema();
+  $table = 'patternkit_block_validity';
+  $database = \Drupal::database();
+  if (!$database->schema()->tableExists($table)) {
+    $database->schema()->createTable($table, $schema[$table]);
+  }
+}