Automated Drupal 10 compatibility fixes

Created on 15 June 2022, over 2 years ago
Updated 29 February 2024, 9 months ago

Problem/Motivation

Hello project maintainers,

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

To read more about this effort by the Drupal Association, please read: The project update bot is being refreshed to support Drupal 10 readiness of contributed projects ā†’

Patches will periodically be added to this issue that remove Drupal 10 deprecated API uses. To stop further patches 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 "ProjectUpdateBotD10" tag from the issue to stop the bot from posting updates.

The patches 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 patches 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 "ProjectUpdateBotD10" tag is left on this issue, new patches 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 patches 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 patches. The bot will still post new patches then if there is a change in the new generated patch compared to the patch that the bot posted last. Those changes are then up to humans to integrate.

  2. Leave open but stop new automated patches.

    If you want to use this issue as a starting point to remove deprecated API uses but then don't want new automated patches, remove the "ProjectUpdateBotD10" tag from the issue and use it like any other issue (the status does not matter then). If you want to receive automated patches again, add back the "ProjectUpdateBotD10" 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 patches will be posted here.

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

    If you are using another issue(s) to work on Drupal 10 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.

Providing feedback

If there are problems with one of the patches 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

Active

Version

1.0

Component

Code

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

Merge Requests

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • Note that it looks like Domain will be supporting D10 only in version 2 šŸ“Œ Automated Drupal 10 compatibility fixes Needs review , so the "drupal/domain": "^1.0" version constraint in this modules composer.json will need to be bumped to go to D10.

  • This is an automated patch generated by Drupal Rector. Please see the issue summary for more details.

    It is important that any automated tests available are run with this patch and that you manually test this patch.

    Drupal 10 Compatibility

    According to the Upgrade Status module ā†’ , even with this patch, this module is not yet compatible with Drupal 10.

    Currently Drupal Rector, version 0.15.1, cannot fix all Drupal 10 compatibility problems.

    Therefore this patch does not update the info.yml file for Drupal 10 compatibility.

    Leaving this issue open, even after committing the current patch, will allow the Project Update Bot ā†’ to post additional Drupal 10 compatibility fixes as they become available in Drupal Rector.

    Debug info

    Bot run #12554

    This patch was created using these packages:

    1. mglaman/phpstan-drupal: 1.1.35
    2. palantirnet/drupal-rector: 0.15.1
    • webflo ā†’ committed 3dc44933 on 8.x-1.x
      Issue #3287038 by Project Update Bot: Automated Drupal 10 compatibility...
  • šŸ‡ŗšŸ‡øUnited States JosephAllenM

    Will these changes along with the drupal/domain version requirement in composer.json be made into a beta or stable release soon? I'm attempting to update drupal/domain to a D10 compatible version (2.0.0-beta1), but this project's composer.json as of 8.x-1.4 has a requirement of "drupal/domain": "^1.0" which is preventing my update:

    Your requirements could not be resolved to an installable set of packages.
    
      Problem 1
        - Root composer.json requires drupal/domain ^2.0@beta, found drupal/domain[2.0.0-beta1] but these were not loaded, likely because it conflicts with another require.
      Problem 2
        - drupal/domain_path_redirect is locked to version 1.4.0 and an update of this package was not requested.
        - drupal/domain_path_redirect 1.4.0 requires drupal/domain ^1.0 -> found drupal/domain[1.0.0-beta1, ..., 1.0.0-beta8] but it conflicts with your root composer.json require (^2.0@beta).
    
    
    Installation failed, reverting ./composer.json and ./composer.lock to their original content.
    
  • Upgrade status is showing a couple more issues outstanding against latest 8.x-1.x-dev (#bd3dc55737c817bb3bfe6f12810bc293e1837e73). The warnings in the test class are not specifically D10 related and can be done later. Created an MR for the entity query changes to add access checks, which are done the same way in the Redirect module.

    Domain Path Redirect
    Scanned on Thu, 10/26/2023 - 22:41.
    
    9 warnings found.
    
    web/modules/contrib/domain_path_redirect/src/DomainPathRedirectRepository.php:
    ā”Œā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”¬ā”€ā”€ā”€ā”€ā”€ā”€ā”¬ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”
    ā”‚  STATUS  ā”‚ LINE ā”‚                           MESSAGE                            ā”‚
    ā”œā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”¼ā”€ā”€ā”€ā”€ā”€ā”€ā”¼ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”¤
    ā”‚ Check    ā”‚ 161  ā”‚ Relying on entity queries to check access by default is      ā”‚
    ā”‚ manually ā”‚      ā”‚ deprecated in drupal:9.2.0 and an error will be thrown from  ā”‚
    ā”‚          ā”‚      ā”‚ drupal:10.0.0. Call                                          ā”‚
    ā”‚          ā”‚      ā”‚ \Drupal\Core\Entity\Query\QueryInterface::accessCheck() with ā”‚
    ā”‚          ā”‚      ā”‚ TRUE or FALSE to specify whether access should be checked.   ā”‚
    ā”‚          ā”‚      ā”‚                                                              ā”‚
    ā”‚ Check    ā”‚ 178  ā”‚ Relying on entity queries to check access by default is      ā”‚
    ā”‚ manually ā”‚      ā”‚ deprecated in drupal:9.2.0 and an error will be thrown from  ā”‚
    ā”‚          ā”‚      ā”‚ drupal:10.0.0. Call                                          ā”‚
    ā”‚          ā”‚      ā”‚ \Drupal\Core\Entity\Query\QueryInterface::accessCheck() with ā”‚
    ā”‚          ā”‚      ā”‚ TRUE or FALSE to specify whether access should be checked.   ā”‚
    ā”‚          ā”‚      ā”‚                                                              ā”‚
    ā””ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”“ā”€ā”€ā”€ā”€ā”€ā”€ā”“ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”˜
    
    web/modules/contrib/domain_path_redirect/tests/src/Unit/DomainPathRedirectReques
    tSubscriberTest.php:
    ā”Œā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”¬ā”€ā”€ā”€ā”€ā”€ā”€ā”¬ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”
    ā”‚  STATUS  ā”‚ LINE ā”‚                     MESSAGE                      ā”‚
    ā”œā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”¼ā”€ā”€ā”€ā”€ā”€ā”€ā”¼ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”¤
    ā”‚ Check    ā”‚ 170  ā”‚ Call to deprecated method returnValue() of class ā”‚
    ā”‚ manually ā”‚      ā”‚ PHPUnit\Framework\TestCase: Use                  ā”‚
    ā”‚          ā”‚      ā”‚ $double->willReturn() instead of    ā”‚
    ā”‚          ā”‚      ā”‚ $double->will($this->returnValue()) ā”‚
    ā”‚          ā”‚      ā”‚                                                  ā”‚
    ā”‚ Check    ā”‚ 173  ā”‚ Call to deprecated method returnValue() of class ā”‚
    ā”‚ manually ā”‚      ā”‚ PHPUnit\Framework\TestCase: Use                  ā”‚
    ā”‚          ā”‚      ā”‚ $double->willReturn() instead of    ā”‚
    ā”‚          ā”‚      ā”‚ $double->will($this->returnValue()) ā”‚
    ā”‚          ā”‚      ā”‚                                                  ā”‚
    ā”‚ Check    ā”‚ 211  ā”‚ Call to deprecated method returnValue() of class ā”‚
    ā”‚ manually ā”‚      ā”‚ PHPUnit\Framework\TestCase: Use                  ā”‚
    ā”‚          ā”‚      ā”‚ $double->willReturn() instead of    ā”‚
    ā”‚          ā”‚      ā”‚ $double->will($this->returnValue()) ā”‚
    ā”‚          ā”‚      ā”‚                                                  ā”‚
    ā”‚ Check    ā”‚ 219  ā”‚ Call to deprecated method returnValue() of class ā”‚
    ā”‚ manually ā”‚      ā”‚ PHPUnit\Framework\TestCase: Use                  ā”‚
    ā”‚          ā”‚      ā”‚ $double->willReturn() instead of    ā”‚
    ā”‚          ā”‚      ā”‚ $double->will($this->returnValue()) ā”‚
    ā”‚          ā”‚      ā”‚                                                  ā”‚
    ā”‚ Check    ā”‚ 267  ā”‚ Call to deprecated method returnValue() of class ā”‚
    ā”‚ manually ā”‚      ā”‚ PHPUnit\Framework\TestCase: Use                  ā”‚
    ā”‚          ā”‚      ā”‚ $double->willReturn() instead of    ā”‚
    ā”‚          ā”‚      ā”‚ $double->will($this->returnValue()) ā”‚
    ā”‚          ā”‚      ā”‚                                                  ā”‚
    ā”‚ Check    ā”‚ 288  ā”‚ Call to deprecated method returnValue() of class ā”‚
    ā”‚ manually ā”‚      ā”‚ PHPUnit\Framework\TestCase: Use                  ā”‚
    ā”‚          ā”‚      ā”‚ $double->willReturn() instead of    ā”‚
    ā”‚          ā”‚      ā”‚ $double->will($this->returnValue()) ā”‚
    ā”‚          ā”‚      ā”‚                                                  ā”‚
    ā”‚ Check    ā”‚ 339  ā”‚ Call to deprecated method returnValue() of class ā”‚
    ā”‚ manually ā”‚      ā”‚ PHPUnit\Framework\TestCase: Use                  ā”‚
    ā”‚          ā”‚      ā”‚ $double->willReturn() instead of    ā”‚
    ā”‚          ā”‚      ā”‚ $double->will($this->returnValue()) ā”‚
    ā”‚          ā”‚      ā”‚                                                  ā”‚
    ā””ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”“ā”€ā”€ā”€ā”€ā”€ā”€ā”“ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”˜
    
  • First commit to issue fork.
  • Merge request !1updated domain version ā†’ (Merged) created by Unnamed author
  • Merge request !2removed json file ā†’ (Merged) created by Unnamed author
  • Status changed to Needs work 9 months ago
  • šŸ‡ŖšŸ‡øSpain rodrigoaguilera Barcelona

    The MR fixes the access checks but the test deprecations from the comment above still need to be fixed

  • First commit to issue fork.
  • šŸ‡²šŸ‡½Mexico GafgarionMorua Puerto Vallarta

    Replaced deprecated PHPUnit returnValue() method with the willReturn() method in the module's tests.

  • Status changed to Needs review 9 months ago
  • šŸ‡²šŸ‡½Mexico GafgarionMorua Puerto Vallarta
  • Status changed to Needs work 9 months ago
  • Got a deprecation notice running the test, so it probably makes sense to fix that here as well.

  • Status changed to Needs review 9 months ago
  • šŸ‡²šŸ‡½Mexico GafgarionMorua Puerto Vallarta
  • Tests pass now without deprecation notice. I think this can go to RTBC, but I have commits in the MR, so probably best for someone else to mark it RTBC.

  • Status changed to RTBC 9 months ago
  • šŸ‡®šŸ‡³India shalini_jha

    I have tested the MR and Patch , and module is compatible with d10. +RTBC

    • webflo ā†’ committed 3431f871 on 8.x-1.x
      Issue #3287038 by sarwan_verma, Project Update Bot, godotislate,...
  • Status changed to Active 9 months ago
  • šŸ‡©šŸ‡ŖGermany webflo

    Thanks to all! Fixed it back to Active.

Production build 0.71.5 2024