Automated Drupal 11 compatibility fixes for entity_usage

Created on 17 March 2024, 9 months ago
Updated 7 August 2024, 5 months ago

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 β†’ .

πŸ“Œ Task
Status

Fixed

Version

2.0

Component

Code

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

Merge Requests

Comments & Activities

  • Issue created by @project update bot
  • Open on Drupal.org β†’
    Core: 10.2.x + Environment: PHP 8.1 & MySQL 8
    last update 9 months ago
    Waiting for branch to pass
  • This is an automated patch generated using Upgrade Status and Drupal Rector. Please see the issue summary for more details. A merge request 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.

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

    Debug info

    Bot run #11-121090

    This patch was created using these packages:

    1. drupal/upgrade_status: 4.1.0
    2. mglaman/phpstan-drupal: 1.2.7
    3. palantirnet/drupal-rector: 0.20.1
  • Open on Drupal.org β†’
    Core: 10.2.x + Environment: PHP 8.1 & MySQL 8
    last update 9 months ago
    Waiting for branch to pass
  • Open on Drupal.org β†’
    Core: 10.2.x + Environment: PHP 8.1 & MySQL 8
    last update 9 months ago
    Waiting for branch to pass
  • This comment was forced and has ignored the check if a change was already posted. This is only done when we want to update the issue without waiting for changes to happen.

    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-137198

    These packages were used to generate the fixes:

    1. drupal/upgrade_status: 4.1.0
    2. mglaman/phpstan-drupal: 1.2.10
    3. palantirnet/drupal-rector: 0.20.1
  • Open on Drupal.org β†’
    Core: 10.2.x + Environment: PHP 8.1 & MySQL 8
    last update 9 months ago
    Waiting for branch to pass
  • Pipeline finished with Failed
    9 months ago
    Total: 436s
    #137604
  • πŸ‡­πŸ‡ΊHungary Balu Ertl Budapest πŸ‡ͺπŸ‡Ί

    Balu Ertl β†’ made their first commit to this issue’s fork.

  • Pipeline finished with Failed
    6 months ago
    Total: 457s
    #199903
  • πŸ‡­πŸ‡ΊHungary Balu Ertl Budapest πŸ‡ͺπŸ‡Ί

    Balu Ertl β†’ changed the visibility of the branch project-update-bot-only to hidden.

  • πŸ‡­πŸ‡ΊHungary Balu Ertl Budapest πŸ‡ͺπŸ‡Ί

    Based on the answers on this Slack thread, I have the conclusion that it's not strictly necessary to rely on the DeprecationHelper::backwardsCompatibleCall() utility. I assume the module maintainers probably still plan to continue supporting D9, in which this deprecation handling solution was not present yet and thus would have no effect anyway.

    Although the change record β†’ about the deprecation of watchdog_exception() suggests using \Drupal\Core\Utility\Error::logException() but for me, it still seems to be just another wrapper around the \Drupal\Core\Logger\LoggerChannel::log().

    Therefore I simplified exception logging with a more informative solution I peeked from core's \Drupal\Core\EventSubscriber\DefaultExceptionHtmlSubscriber::makeSubrequest(). As both methods are marked as static, thus we cannot rely on the central dependency injection to obtain a logger channel service.

  • Pipeline finished with Failed
    6 months ago
    Total: 426s
    #199927
  • Pipeline finished with Canceled
    6 months ago
    Total: 139s
    #199947
  • Pipeline finished with Canceled
    6 months ago
    Total: 172s
    #199949
  • Pipeline finished with Failed
    6 months ago
    Total: 455s
    #199952
  • πŸ‡­πŸ‡ΊHungary Balu Ertl Budapest πŸ‡ͺπŸ‡Ί

    Ready for review.

  • Pipeline finished with Failed
    6 months ago
    Total: 492s
    #199962
  • Pipeline finished with Failed
    6 months ago
    Total: 425s
    #199979
  • First commit to issue fork.
  • Pipeline finished with Failed
    5 months ago
    Total: 225s
    #229617
  • Pipeline finished with Canceled
    5 months ago
    Total: 73s
    #229622
  • Pipeline finished with Failed
    5 months ago
    Total: 213s
    #229623
  • Pipeline finished with Failed
    5 months ago
    #229630
  • Pipeline finished with Failed
    5 months ago
    #229631
  • Pipeline finished with Failed
    5 months ago
    Total: 237s
    #229634
  • Pipeline finished with Failed
    5 months ago
    Total: 407s
    #229644
  • Pipeline finished with Running
    5 months ago
    #229667
  • Pipeline finished with Failed
    5 months ago
    #231541
  • Pipeline finished with Failed
    5 months ago
    #231547
  • Pipeline finished with Failed
    5 months ago
    #231548
  • Pipeline finished with Failed
    5 months ago
    Total: 241s
    #231550
  • Pipeline finished with Failed
    5 months ago
    Total: 204s
    #231554
  • Pipeline finished with Failed
    5 months ago
    Total: 501s
    #232075
  • Pipeline finished with Success
    5 months ago
    Total: 239s
    #232445
  • πŸ‡¨πŸ‡­Switzerland berdir Switzerland

    Did quite a bit of work on this. Tests are all green now on all enabled core versions.

    * Opt-in for next minor and major, previous minor and concurrent testing (speeds up phpunit job from 5min to 2min). Personally, I recommend removing next minor/major testing from CI, because it's unlikely that merge requests will break future versions (unlike previous minor (and major, once D11 is out), instead, what I do is set up a "next" weekly schedule with both of those enable, because if things break here it's because core changes.
    * Workaround for mysql errors around triggers with DER, should be fixed in gitlab templates soon as well.
    * workarounds for testing on next major with various test dependencies that aren't compatible yet
    * Various test fixes, mostly those tests already failed at least since 10.3 too
    * Removed image_upload test config, it's disabled anyway but caused weird schema errors.
    * reduced previous changes around entity storage and also logging. really no need to have an exception *and* an assert() and a @var docblock. Seems fair to have an assert, but a revisionable entity type must have a revisionable storage or it would not work at all.

  • First commit to issue fork.
  • πŸ‡ͺπŸ‡ΈSpain marcoscano Barcelona, Spain

    Thank you for working on this! πŸ™
    I agree on the testing strategy you mentioned. Just removed the next minor/major and added the scheduled pipeline to be run weekly (thanks for the suggestion).
    However, this run now failed, with error:

    There was 1 failure:
        
        1) Drupal\Tests\entity_usage\Functional\Update\UpdateTest::testUpdate8206
        Failed to run installer database tasks: Database drupal not found. The
        server reports the following message when attempting to create the
        database: SQLSTATE[HY000]: General error: 1007 Can't create database
        'drupal'; database exists., Failed to CREATE a test table on your database
        server with the command CREATE TABLE {drupal_install_test} (id int NOT NULL
        PRIMARY KEY). The server reports the following message: SQLSTATE[3D000]:
        Invalid catalog name: 1046 No database selected: CREATE TABLE
        "test56035940drupal_install_test" (id int NOT NULL PRIMARY KEY); Array
        (
        )
        .Are you sure the configured username has the necessary permissions to
        create tables in the database?
        
        /builds/project/entity_usage/web/core/tests/Drupal/FunctionalTests/Update/UpdatePathTestBase.php:226
        /builds/project/entity_usage/web/core/tests/Drupal/FunctionalTests/Update/UpdatePathTestBase.php:141
        /builds/project/entity_usage/web/core/tests/Drupal/FunctionalTests/Update/UpdatePathTestBase.php:113
        /builds/project/entity_usage/web/core/tests/Drupal/Tests/BrowserTestBase.php:367
        /builds/project/entity_usage/web/core/tests/Drupal/FunctionalTests/Update/UpdatePathTestBase.php:92
        /builds/project/entity_usage/tests/src/Functional/Update/UpdateTest.php:41
        /builds/project/entity_usage/vendor/phpunit/phpunit/src/Framework/TestResult.php:729
        
        FAILURES!
        Tests: 1, Assertions: 1, Failures: 1.
    ---- Drupal\Tests\entity_usage\Functional\EntityUsageLayoutBuilderTest ----
    

    Does this ring any bell for you? Has anything changed in CI between yesterday and today? :) πŸ€”

  • Pipeline finished with Skipped
    5 months ago
    #233189
  • Status changed to Fixed 5 months ago
  • πŸ‡ͺπŸ‡ΈSpain marcoscano Barcelona, Spain

    OK, all green, I'm merging this.
    Thanks again for working on this!

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

Production build 0.71.5 2024