Problem/Motivation

Hello project maintainers,

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

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 "ProjectUpdateBotD12" 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 "ProjectUpdateBotD12" 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 "ProjectUpdateBotD12" 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 "ProjectUpdateBotD12" 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 12 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
#2 provider_map.1.0.x-dev.rector.patch1.58 KBproject update bot

Issue fork provider_map-3628217

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 provider_map.1.0.x-dev.rector.patch1.58 KB

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 12 Compatibility

According to the Upgrade Status module these changes make this module compatible with Drupal 12! 🎉
Therefore these changes update the info.yml file for Drupal 12 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 12 compatibility fixes as they become available in Drupal Rector.

Debug information

Bot run #12-978641

These packages were used to generate the fixes:

  1. drupal/upgrade_status: 5.0.0-alpha3
  2. mglaman/phpstan-drupal: 2.2.1
  3. palantirnet/drupal-rector: 1.1.3

  • aftrix committed 84185ae1 on 1.0.x 
    Declare Drupal 12 compatibility.

Applies the Project Update Bot patch...
aftrix’s picture

aftrix commented
Issue summary: View changes

Thanks, this is useful. Committed to 1.0.x as 84185ae.

I committed the change by hand rather than merging the bot branch, because the security advisory coverage application in #3618064: [1.0.x] Provider Map asks that only the applicant's commits land on the branch while it is open. The content is identical to the patch.

The issue summary asks that the changes be tested rather than taken on trust, so here is what I did.

On Drupal 11.4

No regression, which is what I expected from a metadata only change. The full suite passes, along with PHP_CodeSniffer, PHPStan, ESLint, Stylelint and CSpell, and the GitLab CI pipeline is green on 84185ae.

Tests: 52, Assertions: 494

On Drupal 12.0.0-beta1

I was not able to run the suite against 12.0.0-beta1 locally. Two things got in the way, and both seem worth recording for anyone else testing a module against 12 at this stage:

  • Drupal 12 requires PHP 8.5, so my usual local container was too old for it. I used a php:8.5 image instead.
  • The Composer package for 12.0.0-beta1 does not ship core/tests, so there is no core/tests/bootstrap.php for PHPUnit to load. A git checkout of core would be needed for a real test run.

What I did instead was check the module's API surface against a 12.0.0-beta1 install. All 48 core classes the module imports exist in 12.0.0-beta1, and so do the attributes it relies on: Hook, LegacyHook, ConfigEntityType, ContentEntityType and Block.

The one place I expected trouble was entity originals. EntityBase::$original is gone in 12.0.0-beta1 and getOriginal() has replaced it:

$ grep -c 'public $original' web/core/lib/Drupal/Core/Entity/EntityBase.php
0
$ grep -n 'public function getOriginal' web/core/lib/Drupal/Core/Entity/EntityBase.php
704:  public function getOriginal(): ?static {

ProviderMap::loadOriginal() already calls getOriginal() where it exists and only falls back to the property on older core, so that path holds up on 12.

One thing I deliberately left alone: composer.json still declares "php": ">=8.1". That is the module's own floor, and drupal/core enforces its own requirement, so a site installing on 12 will be held to PHP 8.5 regardless. Tightening it here would only shut out Drupal 10 and 11 users on older PHP for no gain.

Leaving this open with the tag in place so the bot can keep posting fixes while 12 is in beta.