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.

CommentFileSizeAuthor
#13 config_devel-drupal10-3296836-13.patch13.4 KBntsekov
#10 Drush import config.png43.01 KBameymudras
#10 Defining a config in info file.png11.73 KBameymudras
#10 Config form.png249.43 KBameymudras
#6 Screenshot 2022-09-06 at 3.56.06 PM.png494.55 KBdeepalij
#6 Warning.png135.7 KBdeepalij
#6 Upgrade status warning.png102.36 KBdeepalij
#4 config_devel_3296836-4_1.8.patch12.87 KBambient.impact
#3 config_devel.1.x-dev.rector.patch11.01 KBproject update bot
#3 interdiff-last-bot.6658402.txt936 bytesproject update bot
#2 config_devel.1.x-dev.rector.patch10.24 KBproject update bot

Issue fork config_devel-3296836

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

Project Update Bot created an issue. See original summary.

project update bot’s picture

project update bot commented
Status: Active » Needs review
StatusFileSize
new config_devel.1.x-dev.rector.patch10.24 KB

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.13.0, cannot fix all Drupal 10 compatibility problems.

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 #139

This patch was created using these packages:

  1. mglaman/phpstan-drupal: 1.1.24
  2. palantirnet/drupal-rector: 0.13.0
project update bot’s picture

project update bot commented
StatusFileSize
new interdiff-last-bot.6658402.txt936 bytes
new config_devel.1.x-dev.rector.patch11.01 KB

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.13.1, cannot fix all Drupal 10 compatibility problems.

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 #145

This patch was created using these packages:

  1. mglaman/phpstan-drupal: 1.1.25
  2. palantirnet/drupal-rector: 0.13.1
ambient.impact’s picture

ambient.impact
they/them
Primary language English
Location Toronto
commented
Issue summary: View changes
StatusFileSize
new config_devel_3296836-4_1.8.patch12.87 KB

Since we need this to pass our tests with deprecation notices enabled in Config Enforce Devel (#3306487: Add automated tests), here's a patch that (hopefully) applies to the 1.8 release, as the previous patches fail due to changes in dev since that release. Don't use this patch if you're on 8.x-1.x-dev, just provided for our use and for anyone else who wants to patch the stable release cleanly. This only differs from #3 in ConfigImporterExporterTest.

deepalij’s picture

deepalij commented
Assigned: Unassigned » deepalij
deepalij’s picture

deepalij commented
Assigned: deepalij » Unassigned
Status: Needs review » Needs work
StatusFileSize
new Upgrade status warning.png102.36 KB
new Warning.png135.7 KB
new Screenshot 2022-09-06 at 3.56.06 PM.png494.55 KB

Applied patch #3 and scanned with the help of the Upgrade status module.
Showing not compatible with D10 with warning
Upgrade status:
status

Warning
Warning

Tried patch #4. But the patch failed to apply.
Refer the attached screenshot

alex.skrypnyk made their first commit to this issue’s fork.

alex.skrypnyk opened merge request !7

project update bot’s picture

project update bot commented
Issue summary: View changes
ameymudras’s picture

ameymudras commented
Issue summary: View changes
Status: Needs work » Reviewed & tested by the community
StatusFileSize
new Config form.png249.43 KB
new Defining a config in info file.png11.73 KB
new Drush import config.png43.01 KB

Tested MR 7 on Drupal 10.0.x and php 8.1

- Was able to install the module without any issue
- Config form saves as expected and the auto import / export works without issue
- Used Drush to export the config and it works as expected
- No issues identified with with upgrade status
- Did a code review and no issues identified
- No warnings / errors identified in Database log too

Moving this to RTBC

hemangi.gokhale’s picture

hemangi.gokhale
she/her/hers
Primary language English
Location Portland, 🇺🇸
commented
Assigned: Unassigned » hemangi.gokhale
Status: Reviewed & tested by the community » Needs work

Mr provided at #8, that got applied resolved all issues except below one:

FILE: web/modules/contrib/config_devel/drush/config_devel.drush.inc

STATUS         LINE                           MESSAGE                           
--------------------------------------------------------------------------------
Check manually 143  Call to deprecated function drush_log().                    
--------------------------------------------------------------------------------

This needs work.

hemangi.gokhale’s picture

hemangi.gokhale
she/her/hers
Primary language English
Location Portland, 🇺🇸
commented
Assigned: hemangi.gokhale » Unassigned
Status: Needs work » Needs review

The above Issue is resolved and needs review.

ntsekov’s picture

ntsekov commented
StatusFileSize
new config_devel-drupal10-3296836-13.patch13.4 KB

I am attaching the patch from the created MR above until it is ready to be merged.

sardara’s picture

sardara commented
Status: Needs review » Reviewed & tested by the community

The last patch/MR works looks good. Tested locally a configuration export and worked as expected.

andras_szilagyi’s picture

andras_szilagyi commented

Tests went well, drupal rector did not add anithing else to the changes.
(would have been nice if the MR would have testing enabled)

mxr576’s picture

mxr576
Primary language Hungarian
Location Hungary
commented
Status: Reviewed & tested by the community » Needs work 
-  $config_path = drupal_get_path($type, $extension) . "/$directory";
+  $config_path = \Drupal::service('extension.path.resolver')->getPath($type, $extension) . "/$directory";

The extension.path.resolver only exists since 9.3.0 so flagging that this module is still Drupal 8 compatible is incorrect and most probably unnecessary as well. Without having automated tests that covers highest and lowest boundaries it is close to impossible to tell if boundaries are valid.

-core_version_requirement: '^8 || ^9'
+core_version_requirement: ^8 || ^9 || ^10
andras_szilagyi’s picture

andras_szilagyi commented
Status: Needs work » Needs review

That's a good point @mxr576, that's why I dropped everything below 9.3 in this latest commit. Maintainers can decide then if it goes into a new major

chewie’s picture

chewie commented
Status: Needs review » Reviewed & tested by the community

I've checked the changes for D10. Everything looks good to me.

joachim made their first commit to this issue’s fork.

joachim’s picture

joachim commented
Status: Reviewed & tested by the community » Active

Merged.

Thanks everyone!

Setting this back to active for future patches from the bot.