Automated Drupal 10 compatibility fixes

Created on 23 July 2022, over 2 years ago
Updated 13 September 2023, over 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

2.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.

  • 🇦🇹Austria mvonfrie

    The dependency on readmehelp (which is not yet Drupal 10 ready) will be removed by 📌 Remove dependencies on readmehelp and help module Fixed .

  • @mvonfrie opened merge request.
  • 🇦🇹Austria mvonfrie

    Pending tasks:

    PHPstan --level 0 fixes

    Note: Using configuration file /var/www/html/phpstan.neon.
    9/9 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%

    ------ ------------------------------------------------------------------------------------------
    Line src/Tests/XnumberFieldTest.php
    ------ ------------------------------------------------------------------------------------------
    150 Access to an undefined property Drupal\xnumber\Tests\XnumberFieldTest::$url.
    489 Call to an undefined method Drupal\xnumber\Tests\XnumberFieldTest::drupalPostAjaxForm().
    496 Call to an undefined method Drupal\xnumber\Tests\XnumberFieldTest::drupalPostAjaxForm().
    515 Call to an undefined method Drupal\xnumber\Tests\XnumberFieldTest::drupalPostAjaxForm().
    520 Call to an undefined method Drupal\xnumber\Tests\XnumberFieldTest::drupalPostAjaxForm().
    756 Access to an undefined property Drupal\xnumber\Tests\XnumberFieldTest::$url.
    ------ ------------------------------------------------------------------------------------------

    Resolve depending issues

    Update core version requirement

    Increase minimum core version requirement to ^9.3 || ^10 as 9.3 is the first version supporting PHP 8.1, the minimum for Drupal 10.

  • Assigned to mvonfrie
  • Status changed to Needs work almost 2 years ago
  • 🇦🇹Austria mvonfrie

    The Call to an undefined method Drupal\Tests\xnumber\Functional\XnumberFieldTest::drupalPostAjaxForm() occurrences require a major rewrite of the tests, see

    In addition I found used but uninitialized variables in the tests, which also needs to be fixed.

  • 🇪🇪Estonia drugan

    @mvonfrie

    Let's make it compatible with the ^9.5 || ^10 versions.

    You can commit --amend and then push --force into your MR branch.

  • First commit to issue fork.
  • @shivam_tiwari opened merge request.
  • Status changed to Needs review over 1 year ago
  • Status changed to Needs work over 1 year ago
  • 🇪🇪Estonia drugan

    Hi @shivam_tiwari,

    The readmehelp dependency is already fixed on the 2.0.x branch. Additionally, to make the module fully compatible with the core's ^10 version wee need to rewrite the XnumberFieldTest.php. See #17 comment.

    Because we have the Extended number field types so at the very least we need guarantee the Drupal Core functionality for these types.

    For the beginning you can just copy two files below into our Tests folder. Then replace 'integer', 'decimal', 'float' field types in the files for our 'xinteger', 'xdecimal' and 'xfloat'.

    The same with the field widget type: 'number' -> 'xnumber'. After that just create a list of what we've extended in the core's functionality and add specific test methods for that in the files:

    https://git.drupalcode.org/project/drupal/-/blob/10.1.x/core/modules/fie...

    https://git.drupalcode.org/project/drupal/-/blob/10.1.x/core/modules/fie...

  • First commit to issue fork.
  • 🇪🇪Estonia drugan

    The test is failing:

    drugan@my-xnumber-web:/var/www/html$ vendor/bin/phpunit -c web/core/ web/modules/contrib/xnumber/
    PHPUnit 9.6.11 by Sebastian Bergmann and contributors.
    
    Testing /var/www/html/web/modules/contrib/xnumber
    EREEEE                                                              6 / 6 (100%)E
    
    Time: 00:10.036, Memory: 4.00 MB
    
    There were 6 errors:
    
    1) Drupal\Tests\xnumber\Functional\XnumberFieldTest::testNumberIntegerField
    Exception: Drupal\Tests\BrowserTestBase::$defaultTheme is required. See https://www.drupal.org/node/3083055, which includes recommendations on which theme to use.
    
    /var/www/html/web/core/lib/Drupal/Core/Test/FunctionalTestSetupTrait.php:427
    /var/www/html/web/core/tests/Drupal/Tests/BrowserTestBase.php:556
    /var/www/html/web/core/tests/Drupal/Tests/BrowserTestBase.php:367
    /var/www/html/web/modules/contrib/xnumber/tests/src/Functional/XnumberFieldTest.php:29
    /var/www/html/vendor/phpunit/phpunit/src/Framework/TestResult.php:728
    
    2) Drupal\Tests\xnumber\Functional\XnumberFieldTest::testNumberDecimalField
    Exception: Drupal\Tests\BrowserTestBase::$defaultTheme is required. See https://www.drupal.org/node/3083055, which includes recommendations on which theme to use.
    
    /var/www/html/web/core/lib/Drupal/Core/Test/FunctionalTestSetupTrait.php:427
    /var/www/html/web/core/tests/Drupal/Tests/BrowserTestBase.php:556
    /var/www/html/web/core/tests/Drupal/Tests/BrowserTestBase.php:367
    /var/www/html/web/modules/contrib/xnumber/tests/src/Functional/XnumberFieldTest.php:29
    /var/www/html/vendor/phpunit/phpunit/src/Framework/TestResult.php:728
    
    3) Drupal\Tests\xnumber\Functional\XnumberFieldTest::testNumberFloatField
    Exception: Drupal\Tests\BrowserTestBase::$defaultTheme is required. See https://www.drupal.org/node/3083055, which includes recommendations on which theme to use.
    
    /var/www/html/web/core/lib/Drupal/Core/Test/FunctionalTestSetupTrait.php:427
    /var/www/html/web/core/tests/Drupal/Tests/BrowserTestBase.php:556
    /var/www/html/web/core/tests/Drupal/Tests/BrowserTestBase.php:367
    /var/www/html/web/modules/contrib/xnumber/tests/src/Functional/XnumberFieldTest.php:29
    /var/www/html/vendor/phpunit/phpunit/src/Framework/TestResult.php:728
    
    4) Drupal\Tests\xnumber\Functional\XnumberFieldTest::testNumberFormatter
    Exception: Drupal\Tests\BrowserTestBase::$defaultTheme is required. See https://www.drupal.org/node/3083055, which includes recommendations on which theme to use.
    
    /var/www/html/web/core/lib/Drupal/Core/Test/FunctionalTestSetupTrait.php:427
    /var/www/html/web/core/tests/Drupal/Tests/BrowserTestBase.php:556
    /var/www/html/web/core/tests/Drupal/Tests/BrowserTestBase.php:367
    /var/www/html/web/modules/contrib/xnumber/tests/src/Functional/XnumberFieldTest.php:29
    /var/www/html/vendor/phpunit/phpunit/src/Framework/TestResult.php:728
    
    5) Drupal\Tests\xnumber\Functional\XnumberFieldTest::testCreateNumberFloatField
    Exception: Drupal\Tests\BrowserTestBase::$defaultTheme is required. See https://www.drupal.org/node/3083055, which includes recommendations on which theme to use.
    
    /var/www/html/web/core/lib/Drupal/Core/Test/FunctionalTestSetupTrait.php:427
    /var/www/html/web/core/tests/Drupal/Tests/BrowserTestBase.php:556
    /var/www/html/web/core/tests/Drupal/Tests/BrowserTestBase.php:367
    /var/www/html/web/modules/contrib/xnumber/tests/src/Functional/XnumberFieldTest.php:29
    /var/www/html/vendor/phpunit/phpunit/src/Framework/TestResult.php:728
    
    6) Drupal\Tests\xnumber\Functional\XnumberFieldTest::testCreateNumberDecimalField
    Exception: Drupal\Tests\BrowserTestBase::$defaultTheme is required. See https://www.drupal.org/node/3083055, which includes recommendations on which theme to use.
    
    /var/www/html/web/core/lib/Drupal/Core/Test/FunctionalTestSetupTrait.php:427
    /var/www/html/web/core/tests/Drupal/Tests/BrowserTestBase.php:556
    /var/www/html/web/core/tests/Drupal/Tests/BrowserTestBase.php:367
    /var/www/html/web/modules/contrib/xnumber/tests/src/Functional/XnumberFieldTest.php:29
    /var/www/html/vendor/phpunit/phpunit/src/Framework/TestResult.php:728
    
    --
    
    There was 1 risky test:
    
    1) Drupal\Tests\xnumber\Functional\XnumberFieldTest::testNumberIntegerField
    This test did not perform any assertions
    
    /var/www/html/web/core/tests/Drupal/Tests/Listeners/DrupalListener.php:65
    /var/www/html/vendor/phpunit/phpunit/src/Framework/TestResult.php:452
    /var/www/html/vendor/phpunit/phpunit/src/Framework/TestSuite.php:684
    /var/www/html/vendor/phpunit/phpunit/src/Framework/TestSuite.php:684
    /var/www/html/vendor/phpunit/phpunit/src/TextUI/TestRunner.php:651
    /var/www/html/vendor/phpunit/phpunit/src/TextUI/Command.php:144
    /var/www/html/vendor/phpunit/phpunit/src/TextUI/Command.php:97
    
    ERRORS!
    Tests: 6, Assertions: 0, Errors: 6, Risky: 1.
    
    
  • Assigned to drugan
  • 🇪🇪Estonia drugan

    I've ran functional and javascript test on 9.4 and 10.1.2 versions.

    I am not sure if there is any sense to merge these changes into 8.x version of the module? If it's true please someone merge upstream and run both tests on the latest 8.x core version to verify that is working there too.

    I am going to make 2.0.0-beta1 release tomorrow.

  • Status changed to Fixed over 1 year ago
  • 🇪🇪Estonia drugan

    Done.

    Thanks everyone!

  • Status changed to Fixed over 1 year ago
Production build 0.71.5 2024