Automated Drupal 10 compatibility fixes

Created on 16 August 2022, almost 2 years ago
Updated 15 June 2023, about 1 year 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

Fixed

Version

1.0

Component

Code

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

Comments & Activities

Not all content is available!

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

  • 🇨🇦Canada hubert_r2

    How far is this module from being ready for Drupal 10?

    It's one of the last few modules that prevents our project to be upgraded to D10

  • 🇬🇧United Kingdom Eli-T Manchester

    How far is this module from being ready for Drupal 10?

    According to upgrade_status module, there are still 8 issues to be resolved, even with the patch in #3.

    2 of those are trivial setting of the version constraint, and 1 is simple setting of a theme in a test. The others will need more careful consideration.

    CONTRIBUTED PROJECTS
    --------------------------------------------------------------------------------
    JSON:API Cross Bundles 8.x-1.0
    Scanned on Tue, 30/05/2023 - 17:14.
    
    8 warnings found.
    
    modules/contrib/jsonapi_cross_bundles/src/Context/CrossBundleFieldResolver.php:
    ┌──────────┬──────┬──────────────────────────────────────────────────────────────┐
    │  STATUS  │ LINE │                           MESSAGE                            │
    ├──────────┼──────┼──────────────────────────────────────────────────────────────┤
    │ Check    │ 14   │ Class                                                        │
    │ manually │      │ Drupal\jsonapi_cross_bundles\Context\CrossBundleFieldResolve │
    │          │      │ r extends @internal class                                    │
    │          │      │ Drupal\jsonapi\Context\FieldResolver.                        │
    │          │      │                                                              │
    └──────────┴──────┴──────────────────────────────────────────────────────────────┘
    
    modules/contrib/jsonapi_cross_bundles/src/ResourceType/CrossBundlesResourceType.
    php:
    ┌──────────┬──────┬──────────────────────────────────────────────────────────────┐
    │  STATUS  │ LINE │                           MESSAGE                            │
    ├──────────┼──────┼──────────────────────────────────────────────────────────────┤
    │ Check    │ 10   │ Class                                                        │
    │ manually │      │ Drupal\jsonapi_cross_bundles\ResourceType\CrossBundlesResour │
    │          │      │ ceType extends @internal class                               │
    │          │      │ Drupal\jsonapi\ResourceType\ResourceType.                    │
    │          │      │                                                              │
    └──────────┴──────┴──────────────────────────────────────────────────────────────┘
    
    modules/contrib/jsonapi_cross_bundles/src/ResourceType/ResourceTypeRepositoryShi
    m.php:
    ┌──────────┬──────┬──────────────────────────────────────────────────────────────┐
    │  STATUS  │ LINE │                           MESSAGE                            │
    ├──────────┼──────┼──────────────────────────────────────────────────────────────┤
    │ Check    │ 14   │ Class                                                        │
    │ manually │      │ Drupal\jsonapi_cross_bundles\ResourceType\ResourceTypeReposi │
    │          │      │ toryShim extends @internal class                             │
    │          │      │ Drupal\jsonapi\ResourceType\ResourceTypeRepository.          │
    │          │      │                                                              │
    └──────────┴──────┴──────────────────────────────────────────────────────────────┘
    
    modules/contrib/jsonapi_cross_bundles/tests/src/Functional/CrossBundleCollection
    Test.php:
    ┌──────────┬──────┬──────────────────────────────────────────────────────────────┐
    │  STATUS  │ LINE │                           MESSAGE                            │
    ├──────────┼──────┼──────────────────────────────────────────────────────────────┤
    │ Check    │ 22   │ Drupal\Tests\BrowserTestBase::$defaultTheme is required. See │
    │ manually │      │ https://www.drupal.org/node/3083055, which includes          │
    │          │      │ recommendations on which theme to use.                       │
    │          │      │                                                              │
    └──────────┴──────┴──────────────────────────────────────────────────────────────┘
    
    modules/contrib/jsonapi_cross_bundles/tests/src/Unit/Routing/Routing.php:
    ┌──────────┬──────┬──────────────────────────────────────────────────────────┐
    │  STATUS  │ LINE │                         MESSAGE                          │
    ├──────────┼──────┼──────────────────────────────────────────────────────────┤
    │ Check    │ 35   │ Call to deprecated method prophesize() of class          │
    │ manually │      │ Drupal\Tests\jsonapi_cross_bundles\Unit\Routing\Routing: │
    │          │      │ https://github.com/sebastianbergmann/phpunit/issues/4141 │
    │          │      │                                                          │
    │ Check    │ 37   │ Call to deprecated method prophesize() of class          │
    │ manually │      │ Drupal\Tests\jsonapi_cross_bundles\Unit\Routing\Routing: │
    │          │      │ https://github.com/sebastianbergmann/phpunit/issues/4141 │
    │          │      │                                                          │
    └──────────┴──────┴──────────────────────────────────────────────────────────┘
    
    modules/contrib/jsonapi_cross_bundles/jsonapi_cross_bundles.info.yml:
    ┌──────────┬──────┬────────────────────────────────────────────────────────────┐
    │  STATUS  │ LINE │                          MESSAGE                           │
    ├──────────┼──────┼────────────────────────────────────────────────────────────┤
    │ Check    │ 0    │ Value of core_version_requirement: ^8.7.7 || ^9 is not     │
    │ manually │      │ compatible with the next major version of Drupal core. See │
    │          │      │ https://drupal.org/node/3070687.                           │
    │          │      │                                                            │
    └──────────┴──────┴────────────────────────────────────────────────────────────┘
    
    modules/contrib/jsonapi_cross_bundles/tests/modules/jsonapi_cross_bundles_test/j
    sonapi_cross_bundles_test.info.yml:
    ┌──────────┬──────┬───────────────────────────────────────────────────────────┐
    │  STATUS  │ LINE │                          MESSAGE                          │
    ├──────────┼──────┼───────────────────────────────────────────────────────────┤
    │ Check    │ 0    │ Add core_version_requirement: ^9 || ^10 to designate that │
    │ manually │      │ the extension is compatible with Drupal 10. See           │
    │          │      │ https://drupal.org/node/3070687.                          │
    │          │      │                                                           │
    └──────────┴──────┴───────────────────────────────────────────────────────────┘
    
    
    
    
  • Status changed to Needs work about 1 year ago
  • 🇬🇧United Kingdom Eli-T Manchester

    Following this conversation in Slack, it appears that the 3 warnings about extending @internal classes do not need addressing.

    Also whilst prophesize() is deprecated, it is scheduled for removal in phpunit 10; Drupal 10 requires phpunit ^9.5, so this also shouldn't need fixing here.

    So we basically just need to fix the version constraints and the default theme in the test.

  • Status changed to Needs review about 1 year ago
  • 🇬🇧United Kingdom Eli-T Manchester

    New patch adding the steps outlined in [3304053#7]

  • Open in Jenkins → Open on Drupal.org →
    Core: 10.1.x + Environment: PHP 8.1 & MySQL 8
    last update about 1 year ago
    Composer require failure
  • @eli-t opened merge request.
  • 🇬🇧United Kingdom Eli-T Manchester

    Using a Merge Request as automated testing on the patch in #8 failed because the test harness couldn't use composer to build D10 with 8.x-1.x before patching because 8.x-1.x before patching isn't compatible with D10.

    But now I can't see how to trigger the tests on a merge request.

  • 🇺🇸United States mglaman WI, USA

    I just fixed the default testing run, which was no longer supported. I think an empty commit will trigger a job run

  • Open in Jenkins → Open on Drupal.org →
    Core: 9.5.x + Environment: PHP 7.4 & MySQL 5.7
    last update about 1 year ago
    7 pass, 2 fail
  • Open in Jenkins → Open on Drupal.org →
    Core: 10.1.x + Environment: PHP 8.1 & MySQL 8
    last update about 1 year ago
    7 pass, 2 fail
  • Open in Jenkins → Open on Drupal.org →
    Core: 9.5.x + Environment: PHP 7.4 & MySQL 5.7
    last update about 1 year ago
    8 pass
  • Status changed to RTBC about 1 year ago
  • Open in Jenkins → Open on Drupal.org →
    Core: 9.5.x + Environment: PHP 7.4 & MySQL 5.7
    last update about 1 year ago
    Patch Failed to Apply
  • Open in Jenkins → Open on Drupal.org →
    Core: 9.5.x + Environment: PHP 7.4 & MySQL 5.7
    last update about 1 year ago
    Patch Failed to Apply
  • 🇺🇸United States mglaman WI, USA

    Woo!

  • Open in Jenkins → Open on Drupal.org →
    Core: 9.5.x + Environment: PHP 7.4 & MySQL 5.7
    last update about 1 year ago
    8 pass
  • Status changed to Fixed about 1 year ago
  • 🇺🇸United States mglaman WI, USA

    Thanks!

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

Production build 0.69.0 2024