Issue #3433816 by Berdir, jurgenhaas: Automated Drupal 11 compatibility fixes for paragraphs

.gitlab-ci.yml

@@ -49,10 +49,25 @@ include:
 # Docs at https://git.drupalcode.org/project/gitlab_templates/-/blob/1.0.x/includes/include.drupalci.variables.yml
 ################
 variables:
+  KUBERNETES_CPU_REQUEST: "5"
+  _CONCURRENCY_THREADS: 20
   _PHPUNIT_CONCURRENT: '1'
   OPT_IN_TEST_PREVIOUS_MINOR: 1
-  OPT_IN_TEST_NEXT_MINOR: 1
-  OPT_IN_TEST_MAX_PHP: 1
+
+# Previous minor defaults to the last security release, currently 10.2.2.
+# Override that to 10.2.7 to avoid MigrateSourceTestBase::providerSource()
+# related errors.
+composer (previous minor):
+  variables:
+    DRUPAL_CORE: 10.2.7
+
+composer (next major):
+  variables:
+    _LENIENT_ALLOW_LIST: "inline_entity_form"
+
+phpunit (next major):
+  before_script:
+    - 'sed -i "s/core_version_requirement.*/core_version_requirement: \^11/" web/modules/contrib/**/*.info.yml'
 
 ###################################################################################
 #

modules/paragraphs_demo/paragraphs_demo.info.yml

 description: 'Provides multilingual demo Paragraphs types.'
-core_version_requirement: ^9.3 || ^10
+core_version_requirement: ^10.2 || ^11
 dependencies:
   - paragraphs:paragraphs
   - drupal:field

modules/paragraphs_library/paragraphs_library.info.yml

 name: Paragraphs Library
 type: module
 description: 'Provides a library for reusing paragraphs.'
-core_version_requirement: ^9.3 || ^10
+core_version_requirement: ^10.2 || ^11
 package: Paragraphs
 configure: paragraphs_library_item.settings
 dependencies:

modules/paragraphs_library/tests/src/Functional/ParagraphsLibraryTest.php

@@ -297,12 +297,7 @@ class ParagraphsLibraryTest extends ParagraphsTestBase {
     $this->assertSession()->buttonExists('Save configuration');
     // Assert that users can create fields to
     $this->clickLink('Manage fields');
-    if (version_compare(\Drupal::VERSION, '10.1', '>=')) {
-      $this->clickLink('Create a new field');
-    }
-    else {
-      $this->clickLink('Add field');
-    }
+    $this->clickLink('Create a new field');
     $this->assertSession()->statusCodeEquals(200);
     $this->assertSession()->pageTextNotContains('plugin does not exist');
     $this->drupalGet('admin/config/content');

modules/paragraphs_type_permissions/paragraphs_type_permissions.info.yml

 name: Paragraphs Type Permissions
 type: module
 description: 'Allows users to configure permissions for individual Paragraphs types.'
-core_version_requirement: ^9.3 || ^10
+core_version_requirement: ^10.2 || ^11
 package: Paragraphs
 
 dependencies:

paragraphs.info.yml

 name: Paragraphs
 type: module
 description: 'Enables the creation of paragraphs entities.'
-core_version_requirement: ^9.3 || ^10
+core_version_requirement: ^10.2 || ^11
 package: Paragraphs
 configure: entity.paragraphs_type.collection
 

paragraphs.module

@@ -127,18 +127,43 @@ function paragraphs_form_entity_form_display_edit_form_alter(&$form, FormStateIn
 
 /**
  * Implements hook_form_FORM_ID_alter().
+ *
+ * Indicate unsupported multilingual paragraphs field configuration.
  */
-function paragraphs_form_field_storage_config_edit_form_alter(&$form, FormStateInterface $form_state, $form_id) {
-  if ($form_state->getFormObject()->getEntity()->getType() == 'entity_reference') {
+function paragraphs_form_field_config_edit_form_alter(&$form, FormStateInterface $form_state, $form_id) {
+  $field = $form_state->getFormObject()->getEntity();
 
-    if (version_compare(\Drupal::VERSION, '10.2', '>')) {
-      $selector = 'field_storage[subform][settings][target_type]';
-    }
-    else {
-      $selector = 'settings[target_type]';
+  if (\Drupal::hasService('content_translation.manager')) {
+    $bundle_is_translatable = \Drupal::service('content_translation.manager')->isEnabled($field->getTargetEntityTypeId(), $field->getTargetBundle());
+
+    if ($bundle_is_translatable && $field->getType() === 'entity_reference_revisions' && $field->getSetting('target_type') === 'paragraph') {
+      // This is a translatable ERR field pointing to a paragraph.
+      $message_display = 'warning';
+      $message_text = t('Paragraphs fields do not support translation. See the <a href=":documentation">online documentation</a>.', [
+        ':documentation' => Url::fromUri('https://www.drupal.org/node/2735121')
+          ->toString()
+      ]);
+
+      if ($form['translatable']['#default_value'] == TRUE) {
+        $message_display = 'error';
+      }
+
+      $form['paragraphs_message'] = [
+        '#type' => 'container',
+        '#markup' => $message_text,
+        '#attributes' => [
+          'class' => ['messages messages--' . $message_display],
+        ],
+        '#weight' => 0,
+      ];
     }
+  }
+
+  if ($field->getType() == 'entity_reference') {
+    $selector = 'field_storage[subform][settings][target_type]';
+
     // Add a note about paragraphs if selected.
-    $form['settings']['paragraph_warning_wrapper'] = [
+    $form['field_storage']['subform']['settings']['paragraph_warning_wrapper'] = [
       '#type' => 'container',
       '#states' => [
         'visible' => [
@@ -158,58 +183,13 @@ function paragraphs_form_field_storage_config_edit_form_alter(&$form, FormStateI
       ],
     ];
   }
-}
-
-/**
- * Implements hook_form_FORM_ID_alter().
- *
- * Indicate unsupported multilingual paragraphs field configuration.
- */
-function paragraphs_form_field_config_edit_form_alter(&$form, FormStateInterface $form_state, $form_id) {
-  $field = $form_state->getFormObject()->getEntity();
-
-  if (!\Drupal::hasService('content_translation.manager')) {
-    return;
-  }
-
-  $bundle_is_translatable = \Drupal::service('content_translation.manager')
-    ->isEnabled($field->getTargetEntityTypeId(), $field->getTargetBundle());
-
-  if (!$bundle_is_translatable
-    || $field->getType() != 'entity_reference_revisions'
-    || $field->getSetting('target_type') != 'paragraph') {
-    return;
-  }
-
-  // This is a translatable ERR field pointing to a paragraph.
-  $message_display = 'warning';
-  $message_text = t('Paragraphs fields do not support translation. See the <a href=":documentation">online documentation</a>.', [
-    ':documentation' => Url::fromUri('https://www.drupal.org/node/2735121')
-      ->toString()
-  ]);
-
-  if ($form['translatable']['#default_value'] == TRUE) {
-    $message_display = 'error';
-  }
 
-  $form['paragraphs_message'] = array(
-    '#type' => 'container',
-    '#markup' => $message_text,
-    '#attributes' => array(
-      'class' => array('messages messages--' . $message_display),
-    ),
-    '#weight' => 0,
-  );
 }
 
 function paragraphs_field_ui_preconfigured_options_alter(array &$options, $field_type) {
-
-  if (version_compare(\Drupal::VERSION, '10.2', '<')) {
-    return;
-  }
-
-  // Move the preconfigured paragraph option to the generic category so it is available
-  // as a top-level option in the new field type selection UI in Drupal 10.2+.
+  // Move the preconfigured paragraph option to the generic category,
+  // so it is available as a top-level option in the new field type selection
+  // UI in Drupal 10.2+.
   if ($field_type == 'entity_reference_revisions' && !empty($options['paragraph'])) {
     $options['paragraph']['weight'] = -15;
     $options['paragraph']['category'] = FieldTypeCategoryManagerInterface::FALLBACK_CATEGORY;;

src/Form/ParagraphsTypeForm.php

@@ -98,7 +98,7 @@ class ParagraphsTypeForm extends EntityForm {
       '#type' => 'managed_file',
       '#upload_location' => ParagraphsTypeInterface::ICON_UPLOAD_LOCATION,
       '#upload_validators' => [
-        'file_validate_extensions' => ['png jpg svg'],
+        'FileExtension' => ['extensions' => 'png jpg svg'],
       ],
     ];
 

src/Plugin/migrate/field/FieldCollection.php

@@ -25,6 +25,11 @@ class FieldCollection extends FieldPluginBase {
    */
   const FIELD_COLLECTION_PREFIX_LENGTH = 6;
 
+  /**
+   * Recursion counter.
+   */
+  static int $recursionCounter = 0;
+
   /**
    * {@inheritdoc}
    */
@@ -65,6 +70,15 @@ class FieldCollection extends FieldPluginBase {
     ];
     $migration->setProcessOfProperty($field_name, $process);
 
+    // Workaround for recursion on D11+, because getMigrationDependencies()
+    // expands plugins, it will go through the deriver again, which will create
+    // a stub migration again.
+    if (static::$recursionCounter > 0) {
+      return;
+    }
+    static::$recursionCounter++;
+
+
     // Add the respective field collection migration as a dependency.
     $migration_dependency = 'd7_field_collection:' . substr($field_name, static::FIELD_COLLECTION_PREFIX_LENGTH);
     $migration_rev_dependency = 'd7_field_collection_revisions:' . substr($field_name, static::FIELD_COLLECTION_PREFIX_LENGTH);
@@ -76,6 +90,8 @@ class FieldCollection extends FieldPluginBase {
       $dependencies['required'] = array_unique(array_merge(array_values($dependencies['required']), [$migration_rev_dependency]));
       $migration->set('migration_dependencies', $dependencies);
     }
+
+    static::$recursionCounter--;
   }
 
   /**

src/Plugin/migrate/field/Paragraphs.php

@@ -20,6 +20,11 @@ use Drupal\migrate_drupal\Plugin\migrate\field\FieldPluginBase;
  */
 class Paragraphs extends FieldPluginBase {
 
+  /**
+   * Recursion counter.
+   */
+  static int $recursionCounter = 0;
+
   /**
    * {@inheritdoc}
    */
@@ -67,6 +72,15 @@ class Paragraphs extends FieldPluginBase {
     // @todo: This is a great example why we should consider derive paragraph
     // migrations based on parent entity type (and bundle).
     if (!in_array('Paragraphs Content', $migration->getMigrationTags(), TRUE)) {
+
+      // Workaround for recursion on D11+, because getMigrationDependencies()
+      // expands plugins, it will go through the deriver again, which will create
+      // a stub migration again.
+      if (static::$recursionCounter > 0) {
+        return;
+      }
+      static::$recursionCounter++;
+
       $dependencies = $migration->getMigrationDependencies() + ['required' => []];
       $dependencies['required'] = array_unique(array_merge(array_values($dependencies['required']), [
         'd7_paragraphs',
@@ -79,6 +93,8 @@ class Paragraphs extends FieldPluginBase {
         ]));
         $migration->set('migration_dependencies', $dependencies);
       }
+
+      static::$recursionCounter--;
     }
   }
 

tests/src/Functional/Migrate/MigrateUiParagraphsTest.php

@@ -40,7 +40,7 @@ class MigrateUiParagraphsTest extends MigrateUiParagraphsTestBase {
    * @return bool[][]
    *   Classic node migration type.
    */
-  public function providerParagraphsMigrate() {
+  public static function providerParagraphsMigrate() {
     return [
       ['node_migrate_type_classic' => TRUE],
       ['node_migrate_type_classic' => FALSE],

tests/src/Functional/Migrate/MigrateUiParagraphsTestBase.php

@@ -420,6 +420,7 @@ abstract class MigrateUiParagraphsTestBase extends MigrateUpgradeTestBase {
       $form = $drivers[$driver]->getInstallTasks()->getFormOptions($connection_options);
     }
     else {
+      // @phpstan-ignore-next-line
       $drivers = drupal_get_database_types();
       $form = $drivers[$driver]->getFormOptions($connection_options);
     }

tests/src/Functional/ParagraphsUiTest.php

@@ -107,12 +107,7 @@ class ParagraphsUiTest extends ParagraphsTestBase {
     ], 'Save and manage fields');
 
     // Add a new paragraphs field to the content type.
-    if (version_compare(\Drupal::VERSION, '10.1', '>=')) {
-      $this->clickLink('Create a new field');
-    }
-    else {
-      $this->clickLink('Add field');
-    }
+    $this->clickLink('Create a new field');
 
     $this->getSession()->getPage()->fillField('new_storage_type', 'field_ui:entity_reference_revisions:paragraph');
     if ($this->coreVersion('10.3')) {
@@ -122,10 +117,7 @@ class ParagraphsUiTest extends ParagraphsTestBase {
       'label' => 'Paragraph',
       'field_name' => 'paragraph',
     ];
-    $this->submitForm($edit, $this->coreVersion('10.2') ? 'Continue' : 'Save and continue');
-    if (!$this->coreVersion('10.2')) {
-      $this->submitForm([], 'Save field settings');
-    }
+    $this->submitForm($edit, 'Continue');
     $this->submitForm([], 'Save settings');
 
     // Visit the "Manage form display" page of the new content type.

tests/src/Functional/WidgetLegacy/ParagraphsAccessTest.php

@@ -101,20 +101,11 @@ class ParagraphsAccessTest extends ParagraphsTestBase {
     $role->save();
 
     // Set field_images from demo to private file storage.
-    if ($this->coreVersion('10.2')) {
-      $edit = array(
-        'field_storage[subform][settings][uri_scheme]' => 'private',
-      );
-      $this->drupalGet('admin/structure/paragraphs_type/images/fields/paragraph.images.field_images_demo');
-      $this->submitForm($edit, 'Save settings');
-    }
-    else {
-      $edit = array(
-        'settings[uri_scheme]' => 'private',
-      );
-      $this->drupalGet('admin/structure/paragraphs_type/images/fields/paragraph.images.field_images_demo/storage');
-      $this->submitForm($edit, 'Save field settings');
-    }
+    $edit = array(
+      'field_storage[subform][settings][uri_scheme]' => 'private',
+    );
+    $this->drupalGet('admin/structure/paragraphs_type/images/fields/paragraph.images.field_images_demo');
+    $this->submitForm($edit, 'Save settings');
 
     // Set the form display to legacy.
     $form_display = EntityFormDisplay::load('node.paragraphed_content_demo.default')

tests/src/Functional/WidgetLegacy/ParagraphsAdministrationTest.php

@@ -153,10 +153,7 @@ class ParagraphsAdministrationTest extends ParagraphsTestBase {
       'label' => 'Paragraph',
       'field_name' => 'paragraph',
     ];
-    $this->submitForm($edit, $this->coreVersion('10.2') ? 'Continue' : 'Save and continue');
-    if (!$this->coreVersion('10.2')) {
-      $this->submitForm([], 'Save field settings');
-    }
+    $this->submitForm($edit, 'Continue');
 
     $this->assertSession()->linkByHrefExists('admin/structure/paragraphs_type/add');
     $this->clickLink('here');
@@ -441,15 +438,8 @@ class ParagraphsAdministrationTest extends ParagraphsTestBase {
     $this->assertSession()->pageTextNotContains('This entity (paragraph: ) cannot be referenced.');
 
     // Set the fields as not required.
-    if ($this->coreVersion('10.2')) {
-      $this->drupalGet('admin/structure/types/manage/article/fields/node.article.field_paragraphs');
-      $this->submitForm(['required' => FALSE], 'Save');
-    }
-    else {
-      $this->drupalGet('admin/structure/types/manage/article/fields');
-      $this->clickLink('Edit');
-      $this->submitForm(['required' => FALSE], 'Save settings');
-    }
+    $this->drupalGet('admin/structure/types/manage/article/fields/node.article.field_paragraphs');
+    $this->submitForm(['required' => FALSE], 'Save');
 
     // Set the Paragraph field edit mode to 'Closed'.
     $this->drupalGet('admin/structure/types/manage/article/form-display');

tests/src/Functional/WidgetLegacy/ParagraphsConfigTest.php

@@ -125,27 +125,16 @@ class ParagraphsConfigTest extends ParagraphsTestBase {
 
     // Check a not paragraphs translatable field does not display the message.
     $this->drupalGet('admin/structure/types/manage/paragraphed_test/fields/add-field');
-    if ($this->coreVersion('10.2')) {
-      $selected_group = [
-        'new_storage_type' => 'reference',
-      ];
-      $this->submitForm($selected_group, $this->coreVersion('10.3') ? 'Continue' : 'Change field group');
-      $edit = [
-        'group_field_options_wrapper' => 'field_ui:entity_reference:node',
-        'label' => 'new_no_field_paragraphs',
-        'field_name' => 'new_no_field_paragraphs',
-      ];
-      $this->submitForm($edit, 'Continue');
-    }
-    else {
-      $edit = [
-        'new_storage_type' => 'field_ui:entity_reference:node',
-        'label' => 'new_no_paragraphs_field',
-        'field_name' => 'new_no_paragraphs_field',
-      ];
-      $this->submitForm($edit, 'Save and continue');
-      $this->submitForm([], 'Save field settings');
-    }
+    $selected_group = [
+      'new_storage_type' => 'reference',
+    ];
+    $this->submitForm($selected_group, $this->coreVersion('10.3') ? 'Continue' : 'Change field group');
+    $edit = [
+      'group_field_options_wrapper' => 'field_ui:entity_reference:node',
+      'label' => 'new_no_field_paragraphs',
+      'field_name' => 'new_no_field_paragraphs',
+    ];
+    $this->submitForm($edit, 'Continue');
     $this->assertSession()->pageTextNotContains('Paragraphs fields do not support translation.');
     $this->assertSession()->responseNotContains('<div class="messages messages--warning');
   }

tests/src/Functional/WidgetLegacy/ParagraphsInlineEntityFormTest.php

@@ -93,21 +93,11 @@ class ParagraphsInlineEntityFormTest extends ParagraphsTestBase {
     ]);
 
     // Set cardinality explicit to -1.
-    if ($this->coreVersion('10.2')) {
-      $this->drupalGet('admin/structure/types/manage/article/fields/node.article.field_paragraphs');
-      $edit = [
-        'field_storage[subform][cardinality]' => '-1',
-      ];
-      $this->submitForm($edit, 'Save settings');
-    }
-    else {
-      $this->drupalGet('admin/structure/types/manage/article/fields/node.article.field_paragraphs/storage');
-      $edit = [
-        'settings[target_type]' => 'paragraph',
-        'cardinality' => '-1',
-      ];
-      $this->submitForm($edit, 'Save field settings');
-    }
+    $this->drupalGet('admin/structure/types/manage/article/fields/node.article.field_paragraphs');
+    $edit = [
+      'field_storage[subform][cardinality]' => '-1',
+    ];
+    $this->submitForm($edit, 'Save settings');
 
     // Enable IEF simple widget.
     $this->drupalGet('admin/structure/paragraphs_type/simple/form-display');

tests/src/Functional/WidgetStable/ParagraphsAccessTest.php

@@ -103,20 +103,11 @@ class ParagraphsAccessTest extends ParagraphsTestBase {
     $role->save();
 
     // Set field_images from demo to private file storage.
-    if ($this->coreVersion('10.2')) {
-      $edit = array(
-        'field_storage[subform][settings][uri_scheme]' => 'private',
-      );
-      $this->drupalGet('admin/structure/paragraphs_type/images/fields/paragraph.images.field_images_demo');
-      $this->submitForm($edit, 'Save settings');
-    }
-    else {
-      $edit = array(
-        'settings[uri_scheme]' => 'private',
-      );
-      $this->drupalGet('admin/structure/paragraphs_type/images/fields/paragraph.images.field_images_demo/storage');
-      $this->submitForm($edit, 'Save field settings');
-    }
+    $edit = array(
+      'field_storage[subform][settings][uri_scheme]' => 'private',
+    );
+    $this->drupalGet('admin/structure/paragraphs_type/images/fields/paragraph.images.field_images_demo');
+    $this->submitForm($edit, 'Save settings');
 
     // Use the stable widget.
     $form_display = EntityFormDisplay::load('node.paragraphed_content_demo.default')

tests/src/Functional/WidgetStable/ParagraphsAdministrationTest.php

@@ -156,10 +156,7 @@ class ParagraphsAdministrationTest extends ParagraphsTestBase {
       'label' => 'Paragraph',
       'field_name' => 'paragraph',
     ];
-    $this->submitForm($edit, $this->coreVersion('10.2') ? 'Continue' : 'Save and continue');
-    if (!$this->coreVersion('10.2')) {
-      $this->submitForm([], 'Save field settings');
-    }
+    $this->submitForm($edit, 'Continue');
 
     $this->assertSession()->linkByHrefExists('admin/structure/paragraphs_type/add');
     $this->clickLink('here');
@@ -446,15 +443,8 @@ class ParagraphsAdministrationTest extends ParagraphsTestBase {
     $this->assertSession()->pageTextNotContains('This entity (paragraph: ) cannot be referenced.');
 
     // Set the fields as not required.
-    if ($this->coreVersion('10.2')) {
-      $this->drupalGet('admin/structure/types/manage/article/fields/node.article.field_paragraphs');
-      $this->submitForm(['required' => FALSE], 'Save');
-    }
-    else {
-      $this->drupalGet('admin/structure/types/manage/article/fields');
-      $this->clickLink('Edit');
-      $this->submitForm(['required' => FALSE], 'Save settings');
-    }
+    $this->drupalGet('admin/structure/types/manage/article/fields/node.article.field_paragraphs');
+    $this->submitForm(['required' => FALSE], 'Save');
 
     // Set the Paragraph field edit mode to "Closed" and the closed mode to
     // "Summary".

tests/src/Functional/WidgetStable/ParagraphsConfigTest.php

@@ -124,29 +124,17 @@ class ParagraphsConfigTest extends ParagraphsTestBase {
     $this->assertSession()->responseContains('<div class="messages messages--error');
 
     // Check a not paragraphs translatable field does not display the message.
-    if ($this->coreVersion('10.2')) {
-      $this->drupalGet('admin/structure/types/manage/paragraphed_test/fields/add-field');
-      $selected_group = [
-        'new_storage_type' => 'reference',
-      ];
-      $this->submitForm($selected_group, $this->coreVersion('10.3') ? 'Continue' : 'Change field group');
-      $edit = [
-        'group_field_options_wrapper' => 'field_ui:entity_reference:node',
-        'label' => 'new_no_field_paragraphs',
-        'field_name' => 'new_no_field_paragraphs',
-      ];
-      $this->submitForm($edit, 'Continue');
-    }
-    else {
-      $this->drupalGet('admin/structure/types/manage/paragraphed_test/fields/add-field');
-      $edit = [
-        'new_storage_type' => 'field_ui:entity_reference:node',
-        'label' => 'new_no_field_paragraphs',
-        'field_name' => 'new_no_field_paragraphs',
-      ];
-      $this->submitForm($edit, 'Save and continue');
-      $this->submitForm([], 'Save field settings');
-    }
+    $this->drupalGet('admin/structure/types/manage/paragraphed_test/fields/add-field');
+    $selected_group = [
+      'new_storage_type' => 'reference',
+    ];
+    $this->submitForm($selected_group, $this->coreVersion('10.3') ? 'Continue' : 'Change field group');
+    $edit = [
+      'group_field_options_wrapper' => 'field_ui:entity_reference:node',
+      'label' => 'new_no_field_paragraphs',
+      'field_name' => 'new_no_field_paragraphs',
+    ];
+    $this->submitForm($edit, 'Continue');
     $this->assertSession()->pageTextNotContains('Paragraphs fields do not support translation.');
     $this->assertSession()->responseNotContains('<div class="messages messages--warning');
   }