Problem/Motivation
Hello project maintainers,
This is an automated issue to help make this module compatible with Drupal 12.
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 "ProjectUpdateBotD12" 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:
- 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 "ProjectUpdateBotD12" 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.
- 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 "ProjectUpdateBotD12" 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 "ProjectUpdateBotD12" tag.
- 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 12 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
- Apply the latest patch in the comments by Project Update Bot or human contributors that made it better.
- Thoroughly test the patch. These patches are automatically generated so they haven't been tested manually or automatically.
- Provide feedback about how the testing went. If you can improve the patch, post an updated patch here.
Using the merge request
- Review the merge request and test it.
- Thoroughly test the changes. These changes are automatically generated so they haven't been tested manually or automatically.
- 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.
Issue fork admin_toolbar-3594696
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:
Comments
Comment #2
project update bot commentedThis 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 12 Compatibility
According to the Upgrade Status module, even with these changes, this module is not yet compatible with Drupal 12.
Currently Drupal Rector, version dev-main, cannot fix all Drupal 12 compatibility problems.
Therefore, these changes did not update the
info.ymlfile for Drupal 12 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 12 compatibility fixes as they become available in Drupal Rector.
Debug information
These packages were used to generate the fixes:
Comment #4
project update bot commentedThis 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 12 Compatibility
According to the Upgrade Status module, even with these changes, this module is not yet compatible with Drupal 12.
Currently Drupal Rector, version 1.0.0-beta1, cannot fix all Drupal 12 compatibility problems.
Therefore, these changes did not update the
info.ymlfile for Drupal 12 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 12 compatibility fixes as they become available in Drupal Rector.
Debug information
These packages were used to generate the fixes:
Comment #5
project update bot commentedThis 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 12 Compatibility
According to the Upgrade Status module, even with these changes, this module is not yet compatible with Drupal 12.
Currently Drupal Rector, version 1.0.0-beta7, cannot fix all Drupal 12 compatibility problems.
Therefore, these changes did not update the
info.ymlfile for Drupal 12 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 12 compatibility fixes as they become available in Drupal Rector.
Debug information
These packages were used to generate the fixes:
Comment #6
project update bot commentedThis 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 12 Compatibility
According to the Upgrade Status module, even with these changes, this module is not yet compatible with Drupal 12.
Currently Drupal Rector, version 1.1.0, cannot fix all Drupal 12 compatibility problems.
Therefore, these changes did not update the
info.ymlfile for Drupal 12 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 12 compatibility fixes as they become available in Drupal Rector.
Debug information
These packages were used to generate the fixes:
Comment #7
dydave commentedThis is going to go in the 4.x branch to be created soon, which will support drupal core 11.5+ and 12.
See: #3565206-8: [Meta] Roadplan for Admin Toolbar 3.6.x and 4.x
We will come back to this issue later, when the 4.x branch is created and we start the D12 compatibility work.
Comment #8
project update bot commentedThis 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 12 Compatibility
According to the Upgrade Status module, even with these changes, this module is not yet compatible with Drupal 12.
Currently Drupal Rector, version 1.1.1, cannot fix all Drupal 12 compatibility problems.
Therefore, these changes did not update the
info.ymlfile for Drupal 12 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 12 compatibility fixes as they become available in Drupal Rector.
Debug information
These packages were used to generate the fixes:
Comment #11
abdelkarim essatti commentedWe tested the automated changes from run 12-884047 (comment #8) on a
multi-tenant Drupal 11.4.5 site and they work. Applied on top of 3.x:
- The site bootstraps and rebuilds caches without errors.
- hook_toolbar still returns the Admin Toolbar items, and the four new
hook classes resolve correctly as autowired services.
- No functional regressions found in Admin Toolbar or Admin Toolbar Extra
Tools (the two submodules we run).
Two things the bot's output needs before it can be committed, both fixed in
the merge request linked above (comments only, no functional change):
1. In admin_toolbar_links_access_filter.install, an empty "@file" doc block is
inserted above the existing one, producing a duplicate and a PHPCS error
("Missing short description in doc comment"). This looks like a Drupal
Rector problem rather than something specific to this module, so it will
probably reappear on the next run.
2. The comments moved into the new hook classes keep their original
indentation, so they end up misaligned inside the method bodies (most
visibly in AdminToolbarSearchHooks::toolbar(), where comments inside the
render arrays are indented by 14 spaces) and 23 of them exceed the
80-character limit.
With those two fixed, "phpcs --standard=Drupal" is clean on the whole module.
Two further notes:
- The merge request applies to 3.x, but not to the 3.6.3 release: four hunks
conflict and two test files it touches do not exist in the tag. Anyone
patching a pinned stable release will need to rebase it.
- The PHPStan job goes red: the module's own phpstan.neon (level 6) reports 29
errors on the bot's branch. Two causes, both a direct consequence of moving
the hooks into classes:
1. The three ignoreErrors entries match "Function admin_toolbar_*()" in
*.install and *.module. The hooks are now methods in .php files, so the
suppressions no longer apply and the "no return type specified" /
"no parameter type specified" errors surface again. Those are the errors
the config comment says are deliberately ignored for hook implementations.
2. "\Drupal calls should be avoided in classes" now fires 15 times. The rule
could not fire while the code lived in procedural functions.
Neither is caused by the coding-standards commit in this merge request: the
error count is identical with and without it (we checked both commits).
Fixing it is a maintainer decision, so we did not touch it here. Either the
ignoreErrors patterns get extended to the new hook classes, or the services
get injected into their constructors properly. We are happy to do the
dependency injection work for 4.x if that is the direction you want.
- PHPStan also flags
AdminToolbarToolsHooks::formProjectBrowserSettingsAlter(&$form) as an invalid
form-alter signature (expected &$form, FormStateInterface $form_state[,
$form_id]). Pre-existing in the procedural version and harmless at runtime,
but it only becomes visible once the hook is a class method.
@dydave: understood from #7 that this is going to 4.x. We have also prepared
the info.yml side of that (dependency on toolbar:toolbar and ^12 in
core_version_requirement) for our own use, and we are happy to contribute it
once the 4.x branch exists. Just let us know.
Comment #12
project update bot commentedThis 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 12 Compatibility
According to the Upgrade Status module, even with these changes, this module is not yet compatible with Drupal 12.
Currently Drupal Rector, version 1.1.3, cannot fix all Drupal 12 compatibility problems.
Therefore, these changes did not update the
info.ymlfile for Drupal 12 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 12 compatibility fixes as they become available in Drupal Rector.
Debug information
These packages were used to generate the fixes:
Comment #13
dydave commentedWe will come back to this issue once the Toolbar module has a D12 compatible release.... very soon....
The D12 version of admin toolbar will sit in the 4.x branch and support
^11.5 || ^12, like the contrib toolbar module 2.x.