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.

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:

Comments

Project Update Bot created an issue. See original summary.

project update bot’s picture

Status: Active » Needs review
StatusFileSize
new968 bytes
new7.29 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 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-177898

These packages were used to generate the fixes:

  1. drupal/upgrade_status: 4.3.1
  2. mglaman/phpstan-drupal: 1.2.11
  3. palantirnet/drupal-rector: 0.20.1

deepakkm made their first commit to this issue’s fork.

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

adamps’s picture

Issue summary: View changes
Status: Needs review » Needs work

Thanks, I made some comments

deepakkm’s picture

Status: Needs work » Needs review

Thanks for reviewing!!
Done with required changes, let me know if we can merge and do a D11 release.

deepakkm’s picture

Status: Needs review » Needs work

I think the tests are failing after the changes , will look into this and fix the pipeline.

rodrigoaguilera made their first commit to this issue’s fork.

rodrigoaguilera’s picture

Status: Needs work » Needs review

Fixed the small copy/paste mistakes.

It can be improved by using the deprecation helper but so far it looks good to me to release a D11 compatible version.

vensires’s picture

Thank you everyone for your work! The changes seem working so it's good to be RTBC by me. The only unresolved thread is regarding the .gitlab-ci.yml variables.

I just want to add some really kind and gentle pressure on this in order to say that websites using this module (32500+ currently) will not be able to upgrade to Drupal 11 without a stable version containing these changes. Drupal Lenient composer plugin won't solve the problem since we still have the dependency issue coming from the "symfony/mailer": "^5.3 || ^6.0" requirement and Lenient only fixes "drupal/core" requirements.

A possible workaround I have found is to change my composer.json's repositories property to the following, while also adding the diff from the MR as patch of course:

"repositories": [
    {
        "type": "package",
        "package": {
            "version": "1.4.1",
            "name": "drupal/symfony_mailer",
            "description": "Symfony Mailer",
            "type": "drupal-module",
            "license": "GPL-2.0-or-later",
            "dist": {
                "url": "https://ftp.drupal.org/files/projects/symfony_mailer-1.4.1.zip",
                "type": "zip"
            },
            "source": {
                "url": "https://git.drupalcode.org/project/symfony_mailer.git",
                "type": "git",
                "reference": "1.4.1"
            },
            "require": {
                "html2text/html2text": "^4.0.1",
                "symfony/mailer": "^5.3 || ^6.0 || ^7.1@beta",
                "tijsverkoyen/css-to-inline-styles": "^2.2"
            },
            "extra": {
                "drush": {
                    "services": {
                        "drush.services.yml": "^11"
                    }
                }
            }
        }
    },
    {
        "type": "composer",
        "url": "https://packages.drupal.org/8"
    }
],
adamps’s picture

Status: Needs review » Needs work

I feel that the key is to limit the range of supported core versions. We should not need to call version_compare! Instead we can remove the old code and increase the minimum core version.

  1. Using the Random class makes D11 work but breaks D9.
  2. The change from renderPlain() to renderInIsolation() makes D12 work, but breaks D10.2.

So core_version_requirement should be 10.3 || ^11. I'll bump the minor version to 1.5, and anyone still on D10.2 will stay on 1.4. Easy😃.

deepakkm’s picture

Status: Needs work » Needs review

Done with all the feedback changes, hence moving into review.

adamps’s picture

Great thanks it looks good just one thread is unresolved still

benstallings’s picture

Status: Needs review » Reviewed & tested by the community

I was able to install & enable this in Drupal 11. Great work!

adamps’s picture

Status: Reviewed & tested by the community » Needs work

Yes thanks but please see #15.

I see a potential problem with the "Broaden test coverage" part. It seems to me that in future the tests are likely to break when code is added to 11.x-dev e.g. new deprecations. Or CORE_PHP_MAX will eventually jump to a new version which we don't necessarily yet support. Also it just slows down every test run.

What's the downside if we remove these lines? Well someone could accidentally write code that uses something that has been removed from 11.x, and we wouldn't notice. But then anyway it was likely deprecated in 10.3? To me this feels much less of a problem than the above.

chandu7929 made their first commit to this issue’s fork.

chandu7929’s picture

Status: Needs work » Needs review

Hello AdamPS, I have updated MR with the requested changes and also created a separate issue for broaden test coverage. Hence requesting review.

ankitv18’s picture

renderPlain is deprecated in D10.2 so I would suggest to keep minimum support of ^10.2 in info.yml and I'm not seeing any other deprecation fixes other then renderPlain.
What are your thoughts?

adamps’s picture

Status: Needs review » Fixed

Great thanks

I believe the minimum support is because renderInIsolation was only added in 10.3

Status: Fixed » Closed (fixed)

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