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:

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

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

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

  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.

Issue fork handlebars-3610218

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:

Comments

project update bot created an issue. See original summary.

project update bot’s picture

Status: Active » Needs review
StatusFileSize
new11.35 KB
new6.53 KB

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 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.yml file 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

Bot run #12-884047

These packages were used to generate the fixes:

  1. drupal/upgrade_status: 5.0.0-alpha3
  2. mglaman/phpstan-drupal: 2.0.15
  3. palantirnet/drupal-rector: 1.1.1

marcelovani’s picture

marcelovani’s picture

>MR !6 >
finishes this. The bot was right that its own changes did not make the module
compatible, but the reason was not in its report.

What was actually in the way

FileSystem::saveData() takes a FileExists enum now,
not an int, and HandlebarsService passed a bare 1:

TypeError: Drupal\Core\File\FileSystem::saveData(): Argument #3 ($fileExists)
must be of type Drupal\Core\File\FileExists, int given,
called in src/Service/HandlebarsService.php on line 277

Nothing static picks that up. It is a TypeError at the moment a
template is compiled, which is the module's whole job, so it only appears if
you exercise the module rather than just install it. That sets the floor at
10.3, where the enum was added, so core_version_requirement is
now ^10.3 || ^11 || ^12.

What was noise

The attached Upgrade Status report lists

You have requested a non-existent service
    "Drupal\handlebars\Hook\HandlebarsHooks"</code
  >
  five times. The service resolves fine on a real site — that scan ran against a
  container that had not been rebuilt after the services.yml change. Nothing to
  fix.
</p>

<h3>Cleaning up after Rector</h3>

<p>
  The generated code came out in PSR-12 rather than the Drupal standard: four
  space indents, braces on the next line, <code>@file

docblocks moved
inside the classes and use statements placed above them, across
four files. Baseline on 8.x-1.x is 13 phpcs errors, the bot's branch was 94,
this branch is back to 13. HandlebarsHooks also takes its three
services through the constructor now instead of calling \Drupal::
six times, which is the point of moving hooks into a class — phpstan goes from
9 errors to the 3 that predate this.

Verified

Installs, hooks fire, templates compile and libraries attach, on 10.6.15,
11.4.5 and 12.0-dev.

Two other things

The module had no .gitlab-ci.yml at all, so one is added. It
shows a backlog that has never been visible before — 77 stylelint errors in
the two example modules' CSS, and cspell and eslint tripping over the vendored
library in dist/ and js/. None of that is new and
all of it is non-blocking, but it probably wants ignore files and a project
dictionary in its own issue.

handlebars_admin_menu declares ^12 but cannot be
installed there yet, because restui and rest_menu_items have no Drupal 12
release. Tracked in
#3619589 >. Merge requests are open on both ( href="https://www.drupal.org/project/restui/issues/3602536"
>restui #3602536 >,
>rest_menu_items #3602521 >), tested and passing on 12. The main module and
handlebars_commerce are unaffected.

  • marcelovani committed 9f3b7e7f on 8.x-1.x
    Issue #3610218 by marcelovani: Finish the Drupal 12 port the bot could...
marcelovani’s picture

Status: Needs review » Fixed

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

Status: Fixed » Closed (fixed)

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