Automated Drupal 11 compatibility fixes for plugin

Created on 24 March 2024, 9 months ago
Updated 3 September 2024, 4 months ago

Problem/Motivation

Hello project maintainers,

This is an automated issue to help make this module compatible with Drupal 11.

Changes will periodically be added to this issue that remove deprecated API uses. To stop further changes from being posted, change the status to anything other than Active, Needs review, Needs work or Reviewed and tested by the community. Alternatively, you can remove the "ProjectUpdateBotD11" tag from the issue to stop the bot from posting updates.

The changes will be posted by the Project Update Bot β†’ official user account. This account will not receive any issue credit contributions for itself or any company.

Proposed resolution

You have a few options for how to use this issue:

  1. Accept automated changes until this issue is closed

    If this issue is left open (status of Active, Needs review, Needs work or Reviewed and tested by the community) and the "ProjectUpdateBotD11" tag is left on this issue, new changes will be posted periodically if new deprecation fixes are needed.

    As the Drupal Rector project improves and is able to fix more deprecated API uses, the changes posted here will cover more of the deprecated API uses in the module.

    Patches and/or merge requests posted by others are ignored by the bot, and general human interactions in the issue do not stop the bot from posting updates, so feel free to use this issue to refine bot changes. The bot will still post new changes then if there is a change in the new generated patch compared to the changes that the bot posted last. Those changes are then up to humans to integrate.

  2. Leave open but stop new automated changes.

    If you want to use this issue as a starting point to remove deprecated API uses but then don't want new automated changes, remove the "ProjectUpdateBotD11" tag from the issue and use it like any other issue (the status does not matter then). If you want to receive automated changes again, add back the "ProjectUpdateBotD11" tag.

  3. Close it and don't use it

    If the maintainers of this project don't find this issue useful, they can close this issue (any status besides Active, Needs review, Needs work and Reviewed and tested by the community) and no more automated changes will be posted here.

    If the issue is reopened, then new automated changes will be posted.

    If you are using another issue(s) to work on Drupal 11 compatibility it would be very useful to other contributors to add those issues as "Related issues" when closing this issue.

Remaining tasks

Using the patches

  1. Apply the latest patch in the comments by Project Update Bot β†’ or human contributors that made it better.
  2. Thoroughly test the patch. These patches are automatically generated so they haven't been tested manually or automatically.
  3. Provide feedback about how the testing went. If you can improve the patch, post an updated patch here.

Using the merge request

  1. Review the merge request and test it.
  2. Thoroughly test the changes. These changes are automatically generated so they haven't been tested manually or automatically.
  3. Provide feedback about how the testing went. If you can improve the merge request, create a new branch and merge request and work from there.

Warning: The 'project-update-bot-only' branch will always be overwritten. Do not work in that branch!

Providing feedback

If there are problems with one of the changes posted by the Project Update Bot β†’ , such as it does not correctly replace a deprecation, you can file an issue in the Drupal Rector issue queue β†’ . For other issues with the bot, for instance if the issue summary created by the bot is unclear, use the Project analysis issue queue β†’ .

πŸ“Œ Task
Status

RTBC

Version

2.0

Component

Code

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @project update bot
  • Open on Drupal.org β†’
    Core: 10.2.1 + Environment: PHP 8.1 & MySQL 5.7
    last update 9 months ago
    Waiting for branch to pass
  • 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

    Bot run #11-127659

    These packages were used to generate the fixes:

    1. drupal/upgrade_status: 4.1.0
    2. mglaman/phpstan-drupal: 1.2.9
    3. palantirnet/drupal-rector: 0.20.1
  • Status changed to Needs review 9 months ago
  • Open on Drupal.org β†’
    Core: 10.2.1 + Environment: PHP 8.1 & MySQL 5.7
    last update 9 months ago
    Waiting for branch to pass
  • Open on Drupal.org β†’
    Core: 10.2.1 + Environment: PHP 8.1 & MySQL 5.7
    48:50
    48:50
    Queueing
  • 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

    Bot run #11-199781

    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
  • Open on Drupal.org β†’
    Core: 10.2.1 + Environment: PHP 8.1 & MySQL 5.7
    48:36
    48:36
    Queueing
  • Pipeline finished with Failed
    6 months ago
    Total: 146s
    #201565
  • πŸ‡ΊπŸ‡ΈUnited States jrglasgow Idaho
  • πŸ‡ΊπŸ‡ΈUnited States jrglasgow Idaho

    I took a look with the Upgrade Status module and there are 28 problems

    • 25 issues with functionality provided by this module which was marked "Deprecated as of Plugin 8.x-2.0*. Scheduled for removal before 8.x-3.0". There was no documentation about replacement functionality hat I saw, and work on 3.0.x is not even begun as far as I can tell.
    • "Call to deprecated function assert_options()." which is "This function has been DEPRECATED as of PHP 8.3.0. Relying on this function is highly discouraged." but not yet scheduled fr removal in a specific PHP version
    • "Call to deprecated method getName() of interface Drupal\Core\Extension\ModuleHandlerInterface. Deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use Drupal::service('extension.list.module')->getName($module) instead." which doesn't need to be removed yet and its removal would removed backwards compatibility.

    I have updated composer.json and plugin.info.yml in this fork.

  • Pipeline finished with Failed
    5 months ago
    Total: 146s
    #237589
  • Pipeline finished with Failed
    5 months ago
    Total: 170s
    #237592
  • First commit to issue fork.
  • Pipeline finished with Failed
    4 months ago
    Total: 151s
    #272702
  • πŸ‡ΊπŸ‡ΈUnited States scott_earnest

    Seeing error running phpunit test on file:
    - tests/src/Unit/Plugin/Plugin/PluginSelector/AdvancedPluginSelectorBaseTest.php

    https://git.drupalcode.org/issue/plugin-3433935/-/jobs/2636647

        Drupal\Tests\plugin\Unit\Plugin\Plugin\PluginSelector\AdvancedPluginSelectorBaseTest::testbuildMultipleAvailablePlugins
        PHPUnit\Framework\MockObject\MethodCannotBeConfiguredException: Trying to
        configure method "buildPluginForm" which cannot be configured because it
        does not exist, has not been specified, is final, or is static
    

    https://www.drupal.org/project/drupal/issues/3130606 β†’
    "setMethods()" is deprecated, and should be using "onlyMethods()"

  • Pipeline finished with Failed
    4 months ago
    Total: 159s
    #272710
  • πŸ‡ΊπŸ‡ΈUnited States scott_earnest

    Testing this file throws errors, but they exist on the current version:
    - tests/src/Unit/PluginType/PluginTypeManagerTest.php

    The following classes are undefined, and not pulled in through the project composer.json file:

    use org\bovigo\vfs\vfsStream;
    use org\bovigo\vfs\vfsStreamDirectory;
    use org\bovigo\vfs\vfsStreamWrapper;
    

    ... so taking no action here as it pertains to D11 upgrade.

  • Pipeline finished with Failed
    4 months ago
    #272699
  • Pipeline finished with Failed
    4 months ago
    #272727
  • πŸ‡ΊπŸ‡ΈUnited States scott_earnest

    Testing this also throws errors - I think this is because the interface to add a field has been changed by Drupal (around 10.3?) to where a content admin must select the field type first, then move on to the next screen.
    - tests/src/Functional/PluginSelectorTest.php

    Again, these deprecations exist in the current version so does not seem to be something that is introduced by this patch.

  • Status changed to RTBC 4 months ago
  • πŸ‡ΊπŸ‡ΈUnited States scott_earnest

    Tested on:
    - Drupal 11.0.1
    - PHP 8.3.10
    - MySQL 8.0.19

    Verified:
    - Plugin configuration can be viewed (/admin/structure/plugin)
    - Plugin details can be viewed (/admin/structure/plugin/block for example)
    - Plugin reference field can be added to an entity
    - Plugin reference field can be viewed

    Automated tests needed updates (committed on the issue fork).
    These tests will fail, but this is not new on this patch (issues exist in current version):
    - tests/src/Unit/Plugin/Plugin/PluginSelector/AdvancedPluginSelectorBaseTest.php
    - tests/src/Functional/PluginSelectorTest.php

    RTBC +1

  • Pipeline finished with Failed
    4 months ago
    Total: 157s
    #272781
Production build 0.71.5 2024