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.

CommentFileSizeAuthor
#4 3433980-drupal-11-compatibility-fixes-4.patch1.76 KBnathanraystone
#2 prevnext.3.0.0.rector.patch389 bytesproject update bot

Issue fork prevnext-3433980

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

Project Update Bot created an issue. See original summary.

project update bot’s picture

project update bot commented
Status: Active » Needs review
StatusFileSize
new prevnext.3.0.0.rector.patch389 bytes

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 these changes make this module compatible with Drupal 11! 🎉
Therefore these changes update the info.yml file for Drupal 11 compatibility.

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

Project Update Bot opened merge request !31

nathanraystone’s picture

nathanraystone commented
Issue summary: View changes
StatusFileSize
new 3433980-drupal-11-compatibility-fixes-4.patch1.76 KB

Adds a few more D11 compatibility updates.

joelpittet’s picture

joelpittet
he/him
Primary language English
Location Vancouver
commented
Version: 3.0.0 » 3.0.x-dev

@nathanraystone would it be possible you could roll those changes into the Merge Request instead of a patch? And do you think that change will make D11 incompatible with previous versions of Drupal? In that case maybe this should be moved to a 4.x

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

albeorte changed the visibility of the branch 3433980-automated-drupal-11 to hidden.

albeorte opened merge request !38

albeorte’s picture

albeorte commented
Status: Needs review » Reviewed & tested by the community

Hi,

I have created a Merge request !38 with the changes integrated in comment #4 by @nathanraystone.

The changes have been tested and work correctly for Drupal 10 and 11 (even in Drupal 9, reviewing the code, as it acts the same way in class inheritance).

So @joelpittet, it is not incompatible with older versions of Drupal.

Prevnext works as expected, please merge and release it compatible with Drupal 11.

Thanks in advance

joelpittet’s picture

joelpittet
he/him
Primary language English
Location Vancouver
commented
Status: Reviewed & tested by the community » Needs work

Thanks @albeorte, I wonder how you tested that, it's a class __construct change that will have a regression
see this issue #3394197: [regression] The new property \Drupal\Core\Form\ConfigFormBase::$typedConfigManager conflicts with some contrib modules

Given this Change Record https://www.drupal.org/node/3404140 we have a few options:

  1. Create a new branch 4.x for Drupal core >=10.2
  2. Set the minor version on 3.1.x to require Drupal core >=10.2

Setting to needs work because the base class constructor is not called any more in that, and so the config manager is not being set.

joelpittet changed the visibility of the branch 3.0.x to hidden.

albeorte’s picture

albeorte commented

Hi @joelpittet,

With the changes included in the merge request I created, originally written by @nathanraystone as a classic patch, the module is fully functional in Drupal 10 and 11 (and even in Drupal 9, based on the code review, since class inheritance behaves the same way there).
The code and its functionality have been reviewed.

Regarding the issue you mentioned and your proposed approach, both alternatives are valid and applicable.
In our specific case, within the PrevNextSettingsForm class, we are only using the $config_factory property from the parent class. Therefore, there are two possible ways to address the change:

Option A:
Remove the explicit injection of the $config_factory dependency from the PrevNextSettingsForm class, as the $this->config() method we use is already provided via inheritance:
FormBase::config()

Option B:
Implement full dependency injection in the PrevNextSettingsForm class, including both $config_factory and $typedConfigManager as explicit class properties.

Both approaches are valid. Personally, I don't mind declaring both properties, as it's a pattern also followed in many other contrib modules.

joelpittet’s picture

joelpittet
he/him
Primary language English
Location Vancouver
commented

Ah I see, the \Drupal\Core\Form\ConfigFormBaseTrait::config() does some jumping through hoops if the config factory is not injected to grab it off the container. It does help if the property is already there, so injecting it seems the way to go from my prospective.

albeorte’s picture

albeorte commented
Status: Needs work » Needs review

The changes with dependency injection have already been included and are ready to be reviewed by the community:

Ready to check!

eduardo morales alberti’s picture

eduardo morales alberti
Primary language Spanish
Location Spain, 🇪🇺
commented
Status: Needs review » Reviewed & tested by the community

Changes seems correct to me

  • albeorte committed 45f7c3fb on 3.0.x 
    Issue #3433980 by nathanraystone: Drupal 11 compatibility fixes
albeorte’s picture

albeorte commented
Status: Reviewed & tested by the community » Fixed

Changes merged into the 3.0.x branch.

Ready to release a new version compatible with Drupal 11.

joelpittet’s picture

joelpittet
he/him
Primary language English
Location Vancouver
commented

Nice 🚀and thanks for exploring that nuance with me @albeorte

Status: Fixed » Closed (fixed)

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

anybody’s picture

anybody
Primary language German
Location Porta Westfalica
commented

@albeorte, could you please tag a new stable release compatible with Drupal 11? Currently only the dev is compatible!