Automated Drupal 10 compatibility fixes

Created on 16 June 2022, over 2 years ago
Updated 15 March 2023, almost 2 years 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.

  • πŸ‡ΊπŸ‡ΈUnited States justcaldwell Austin, Texas

    I installed 1.0.x-dev on Drupal 10 and applied the bot patch from #2. A drush en micronode failed with:

    PHP Fatal error: Declaration of Drupal\micronode\Routing\MicronodeRouteSubscriber::getSubscribedEvents() must be compatible with Drupal\Core\Routing\RouteSubscriberBase::getSubscribedEvents(): array in /var/www/docroot/modules/contrib/micronode/src/Routing/MicronodeRouteSubscriber.php on line 79

    Looks like MicronodeRouteSubscriber::getSubscribedEvents() needs a return type for starters.

  • @justcaldwell opened merge request.
  • πŸ‡ΊπŸ‡ΈUnited States justcaldwell Austin, Texas

    Okay, finally set up testing in my D10 env. After updating the core_version_requirement to ^9 || ^10 for the views test module, I'm still getting:

    There was 1 error:
    
    1) Drupal\Tests\micronode\Functional\MicronodeFunctionalTest::testMicroContentAddPages
    Behat\Mink\Exception\ElementTextException: The text "Add Micro-content" was not found in the text of the element matching css "h1".

    Sure enough, when I replicate the test manually, I get Access Denied when I visit /node/add-microcontent:

    On a Drupal 9 install, I get the expected result:

  • πŸ‡ΊπŸ‡ΈUnited States justcaldwell Austin, Texas

    Ah, the culprit is _node_add_access access check deprecated in favor of _entity_create_access/_entity_create_any_access β†’ .

    Updating the route to '_entity_create_any_access' => 'node', does the trick. That'll require bumping the minimum for Drupal 9 to 9.3.

  • Status changed to Needs review almost 2 years ago
  • πŸ‡ΊπŸ‡ΈUnited States justcaldwell Austin, Texas

    Tests are green, and everything looks good in my manual testing in both D9 and D10. Please review. Thanks!

  • Status changed to Needs work almost 2 years ago
  • πŸ‡ΊπŸ‡ΈUnited States danflanagan8 St. Louis, US

    Looking good, @justcaldwell

    The deprecation you addressed in #7 was a good find. The bot didn't even find it!

    I'm still seeing this notice when I run the tests locally

    2x: The Drupal\Tests\micronode\Functional\MicronodeFunctionalTest::$modules property must be declared protected. See https://www.drupal.org/node/2909426
        2x in DrupalListener::startTest from Drupal\Tests\Listeners
    

    I think we should fix that.

    And if we're making that change, I think we should bring the type hinting style into line with what I see everywhere is core. There should be a single space between the colon and the hint. For example,

    public function setUp(): void {

  • πŸ‡ΊπŸ‡ΈUnited States justcaldwell Austin, Texas

    Thanks for the review @danflanagan8!

    I made those changes, but the test added in πŸ› micronode_get_node_types caches result incorrectly Fixed is failing on D10. Runs fine for me locally. The rebase seems to have worked just fin. Scratching my head over here.

  • πŸ‡ΊπŸ‡ΈUnited States danflanagan8 St. Louis, US

    Hi @justcaldwell

    I wrote that failing test so I'm in a good position to know how to fix it! :)

    The failure is:

    1) Drupal\Tests\micronode\Functional\MicronodeFunctionalTest::testMicroContentAddPages
    Failed asserting that two arrays are identical.
    --- Expected
    +++ Actual
    @@ @@
     Array &0 (
    -    0 => 'one'
    -    1 => 'three'
    -    2 => 'two'
    +    0 => 'two'
    +    1 => 'one'
    +    2 => 'three'
     )
    

    Looks like I was too lazy when I wrote that assertion. Or more confident than I should have been.

    We should be able to change the assertSame() to use the looser assertion assertEqualsCanonicalizing. This method considers two arrays to be equal as long as they have all the same elements, regardless of order. We don't care about the order, so assertEqualsCanonicalizing will not change the spirit of the test.

  • Status changed to Needs review almost 2 years ago
  • πŸ‡ΊπŸ‡ΈUnited States danflanagan8 St. Louis, US

    I made the change I suggested in #11 and triggered tests. Let's see if they pass!

  • πŸ‡ΊπŸ‡ΈUnited States justcaldwell Austin, Texas

    All 🟒 πŸ™Œ. Thanks, Dan!

  • Status changed to RTBC almost 2 years ago
  • πŸ‡ΊπŸ‡ΈUnited States danflanagan8 St. Louis, US

    Sweet! If this were core I shouldn't RTBC, but all I did was fix a test I should have written better in a recent issue. All the D10 work here was done by @justcaldwell and looks very nice. I'll be bold and flip the switch.

    Cheers!

  • First commit to issue fork.
  • Status changed to Fixed almost 2 years ago
  • πŸ‡ͺπŸ‡ΈSpain marcoscano Barcelona, Spain

    Thank you all for contributing!
    Code looks good to me, committed and tagged 1.1.0 β†’ for this. Also adjusted automated testing to default to D10 now. \o/
    Thanks again!

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

Production build 0.71.5 2024