Automated Drupal 11 compatibility fixes for metatag

This is an automated patch generated using Upgrade Status and Drupal Rector. Please see the issue summary for more details. A merge request (MR) is also openend and updated.

It is important that any automated tests available are run and that you manually test the changes.

Drupal 11 Compatibility

According to the Upgrade Status module → , even with these changes, this module is not yet compatible with Drupal 11.

Currently Drupal Rector, version 0.20.1, cannot fix all Drupal 11 compatibility problems.

Therefore, these changes did not update the info.yml file for Drupal 11 compatibility.

The compatibility issues that Upgrade Status found after the Drupal Rector fixes were applied are attached to help you resolve them manually.

Leaving this issue open, even after committing the current patch or merging the MR, will allow the Project Update Bot → to post additional Drupal 11 compatibility fixes as they become available in Drupal Rector.

Debug information

These packages were used to generate the fixes:

1. drupal/upgrade_status: 4.1.0
2. mglaman/phpstan-drupal: 1.2.10
3. palantirnet/drupal-rector: 0.20.1

This is an automated patch generated using Upgrade Status and Drupal Rector. Please see the issue summary for more details. A merge request (MR) is also openend and updated.

It is important that any automated tests available are run and that you manually test the changes.

Drupal 11 Compatibility

According to the Upgrade Status module → , even with these changes, this module is not yet compatible with Drupal 11.

Currently Drupal Rector, version 0.20.3, cannot fix all Drupal 11 compatibility problems.

Therefore, these changes did not update the info.yml file for Drupal 11 compatibility.

The compatibility issues that Upgrade Status found after the Drupal Rector fixes were applied are attached to help you resolve them manually.

Leaving this issue open, even after committing the current patch or merging the MR, will allow the Project Update Bot → to post additional Drupal 11 compatibility fixes as they become available in Drupal Rector.

Debug information

These packages were used to generate the fixes:

1. drupal/upgrade_status: 4.3.2
2. mglaman/phpstan-drupal: 1.2.11
3. palantirnet/drupal-rector: 0.20.3

DamienMcKenna → changed the visibility of the branch project-update-bot-only to hidden.

These two changes:

diff --git a/src/Normalizer/MetatagHalNormalizer.php b/src/Normalizer/MetatagHalNormalizer.php
index d3b71be1df48a34a17ef6f8b6ccbdfad8b49dad6..88377837a52b37fd2407838433b39c4afa9392b2 100644
--- a/src/Normalizer/MetatagHalNormalizer.php
+++ b/src/Normalizer/MetatagHalNormalizer.php
@@ -19,7 +19,7 @@ class MetatagHalNormalizer extends MetatagNormalizer {
   /**
    * {@inheritdoc}
    */
-  public function normalize($field_item, $format = NULL, array $context = []) {
+  public function normalize($field_item, $format = NULL, array $context = []): array|string|int|float|bool|\ArrayObject|NULL  {
     $normalized = parent::normalize($field_item, $format, $context);
 
     // Mock the field array similar to the other fields.

and

diff --git a/src/Normalizer/MetatagNormalizer.php b/src/Normalizer/MetatagNormalizer.php
index 7c48caf4ec8ea6471fef54801f6d6226ad86a089..c16ec299db75686ce4d3a3d190e002a4732e34a2 100644
--- a/src/Normalizer/MetatagNormalizer.php
+++ b/src/Normalizer/MetatagNormalizer.php
@@ -21,7 +22,7 @@ class MetatagNormalizer extends NormalizerBase {
   /**
    * {@inheritdoc}
    */
-  public function normalize($field_item, $format = NULL, array $context = []) {
+  public function normalize($field_item, $format = NULL, array $context = []): array|string|int|float|bool|\ArrayObject|NULL  {
     // @see metatag_get_tags_from_route()
     $entity = $field_item->getEntity();
 

As I understand it, these two changes will make the module incompatible with PHP 7, and break compatibility with Drupal 9. I'm not willing to make those changes.

We might have to add some workarounds to allow the rest of the module work with Drupal 11, but this one part may be required to only work with Drupal 9. It's like this on D10 anyway, so I don't think we need to fuss too much about it.

@DamienMcKenna If we provide minimum support of php 8.1 and Drupal 9.5 then these changes work as these changes are required for D11 and symfony 7.

The normalizer was deprecated in 8.x-1.x and removed in 2.0.x, so sites shouldn't be using it anymore anyway. I say we leave the two files as-is because they're used so little.

Also remember that 8.x-1.x is already past its EOL, which was to have been December 31st last year only I forgot, so supporting everything in the newer core releases is not necessary.

I updated the v1 EOL to January 5th, 2025, the same day as D7's EOL, until then it is on minimal support, i.e. primarily bug fixes only. As such, I am focused more on retaining compatibility with D9 and PHP 7 with the v1 branch than I am making sure it works 100% on D11.

Let's add a gitlab-ci template to the 8.x-1.x branch first, then we can focus on the D11 issues here: 📌 Add gitlab CI template file to 8.x-1.x Needs work

Postponing this until the gitlab issues are resolved: 📌 Add gitlab CI template file to 8.x-1.x Needs work