Automated Drupal 10 compatibility fixes [#3299434]

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:

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

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.

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.

Comment	File	Size	Author
#22	interdiff-4-22.txt	1.34 KB	danflanagan8
#22	3299434-22.patch	6.55 KB	danflanagan8
#21	Screen Shot 2023-02-07 at 8.55.06 AM.png	92.65 KB	danflanagan8
#19	mrdiff.diff	7.07 KB	danflanagan8
#4	drupal-10-compitibility-3299434-4.patch	5.95 KB	jaydev bhatt
#3	viewfield.3.x-dev.rector.patch	5.21 KB	project update bot
#3	interdiff-last-bot.6664529.txt	640 bytes	project update bot
#2	viewfield.3.x-dev.rector.patch	4.79 KB	project update bot

Issue fork viewfield-3299434

Show commands

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

Add & fetch this issue fork’s repository

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

Add & fetch this issue fork’s repository

1 hidden branch

3299434-automated-drupal-10

changes, plain diff MR !4

Check out this branch for the first time

Check out existing branch, if you already have it locally

About issue forks

Comments

Comment #1

23 July 2022 at 18:45

Project Update Bot created an issue. See original summary.

Comment #2

project update bot commented 23 July 2022 at 18:45

Status:

Active

» Needs review

Status	File	Size
new	viewfield.3.x-dev.rector.patch	4.79 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:

mglaman/phpstan-drupal: 1.1.24
palantirnet/drupal-rector: 0.13.0

Comment #3

project update bot commented 22 August 2022 at 21:32

Status	File	Size
new	interdiff-last-bot.6664529.txt	640 bytes
new	viewfield.3.x-dev.rector.patch	5.21 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:

mglaman/phpstan-drupal: 1.1.25
palantirnet/drupal-rector: 0.13.1

Comment #4

jaydev bhatt commented 25 August 2022 at 07:14

Issue summary:

View changes

Status	File	Size
new	drupal-10-compitibility-3299434-4.patch	5.95 KB

Review / Tested the patch.
run through the upgrade_status module and gave couple of changes that were missing adding those.
combining it with the latest patch #3.

Keeping this to NW.
RTBC+1

Comment #5

jaydev bhatt commented 25 August 2022 at 07:28

1 file was hidden/shown/deleted

Status	File	Size
hidden	drupal-10-compitibility-3299434-4.patch	5.95 KB

no need for the patch all the files patches are included here.

Comment #6

danflanagan8

English

St. Louis, US

commented 26 August 2022 at 17:00

I don't really understand the comment in #5, but the patch in #4 would be easier to review with an interdiff.

+++ b/viewfield.libraries.yml
@@ -7,4 +7,4 @@ viewfield:
-    - core/jquery.once
\ No newline at end of file
+    - core/once

We can't just replace core/jquery.once with core/once. We also have to update the js that calls once. The process is described here: https://www.drupal.org/node/3158256

core/once was added in D9.2.x, so that should be taken into account when updating core_version_requirement.

I don't know what the status should be for this issue so I'll just leave it as is. It might be easiest to just commit the patch from #3 and make a separate issue to handle the jquery.once stuff.

Comment #7

kristen pol

she/her

English

Santa Cruz, CA, USA

commented 27 August 2022 at 18:02

Issue tags:

+Drupal 10 porting day

Tagging for porting day.

Comment #8

kristen pol

she/her

English

Santa Cruz, CA, USA

commented 28 September 2022 at 03:27

Fyi, people have been fixing jquery once in the bot issue for other projects. As for core_version_requirement, some projects are putting a minimum of 9.2 or 9.3 for these types of reasons.

Comment #9

project update bot commented 18 October 2022 at 15:40

Issue summary:

View changes

Updating bot issue summary.See #3313904: Update project bot templates for RTBC status support and human interaction tips

Comment #10

kristen pol

she/her

English

Santa Cruz, CA, USA

commented 18 November 2022 at 05:36

Issue summary:	View changes
Status:	Needs review	» Needs work

Working during porting day.

Moving back to needs work per #6 and #8.

Comment #11

23 December 2022 at 21:29

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

Comment #12

23 December 2022 at 21:44

AaronBauman opened merge request !4

Comment #13

aaronbauman

he/him

commented 23 December 2022 at 21:44

Status:

Needs work

» Needs review

Comment #14

aaronbauman

he/him

commented 23 December 2022 at 21:46

Opened MR 4 with updates to once javascript.

Here's the interdiff between 3 and 4:

only in patch2:
unchanged:
--- a/viewfield.info.yml
+++ b/viewfield.info.yml
@@ -2,7 +2,7 @@ name: Viewfield
 type: module
 description: 'Defines an entity reference field type to display a view.'
 package: Field types
-core_version_requirement: ^8 || ^9
+core_version_requirement: ^8 || ^9 || ^10
 dependencies:
   - drupal:views
   - drupal:field
only in patch2:
unchanged:
--- a/viewfield.libraries.yml
+++ b/viewfield.libraries.yml
@@ -7,4 +7,4 @@ viewfield:
     - core/drupal
     - core/drupalSettings
     - core/drupal.progress
-    - core/jquery.once
\ No newline at end of file
+    - core/once

And you can see the latest interdiff on the MR, as i committed the patch separately from a couple more changes.

Comment #15

hemangi.gokhale

she/her/hers

English

Portland, 🇺🇸

commented 18 January 2023 at 11:47

Status:

Needs review

» Reviewed & tested by the community

#12 works for me. Marking it as RTBC.

Comment #16

loopy1492 commented 3 February 2023 at 16:01

Works for me with zero errors in 9.5.3 and php 8.1. Thanks so much for the work on this one.

Comment #17

realityloop commented 7 February 2023 at 03:55

Another RTBC.. Can we please get #12 committed asap this is blocking Drupal 10 upgrade because using it via Composer Patches fails on version constraints because patching occurs after Composer calculates dependencies and installs packages

Comment #18

danflanagan8

English

St. Louis, US

commented 7 February 2023 at 15:13

Status:

Reviewed & tested by the community

» Needs review

Setting to NW to trigger tests. I just got added as a maintainer here and I'm going to try to get this committed ASAP.

Comment #19

danflanagan8

English

St. Louis, US

commented 7 February 2023 at 15:20

Status	File	Size
new	mrdiff.diff	7.07 KB

Tests did not trigger on the MR. MRs drive me nuts...

Here's a patch version of the MR that I'll run tests against.

Comment #20

7 February 2023 at 15:27

Status:

Needs review

» Needs work

The last submitted patch, 19: mrdiff.diff, failed testing. View results
- codesniffer_fixes.patch Interdiff of automated coding standards fixes only.

Comment #21

danflanagan8

English

St. Louis, US

commented 7 February 2023 at 16:08

Status	File	Size
new	Screen Shot 2023-02-07 at 8.55.06 AM.png	92.65 KB

There's something not quite right with the jquery/once updates. The tests fail with the same thing I'm seeing in my console.

It seems like core/once doesn't want to handle Drupal.ajax.instances, which is an array.

From what I can tell, though, core/once only works on DOM elements. See https://git.drupalcode.org/project/once/-/blob/1.0.x/src/once.js#L106

I don't think there's any way (or reason) to use core/once here. I'm going to just back it out completely.

Comment #22

danflanagan8

English

St. Louis, US

commented 7 February 2023 at 16:23

Status:

Needs work

» Needs review

Status	File	Size
new	3299434-22.patch	6.55 KB
new	interdiff-4-22.txt	1.34 KB

Here's an approach that gets rid of the call to once which simply won't work with Drupal.ajax.instances as described in #21.

Comment #23

7 February 2023 at 16:44

danflanagan8 committed 57f583aa on 8.x-3.x

Issue #3299434 by danflanagan8, AaronBauman, Jaydev Bhatt, Kristen Pol,...

Comment #24

danflanagan8

English

St. Louis, US

commented 7 February 2023 at 16:46

Status:

Needs review

» Fixed

The patch in #22 passed tests on D9.5. Tests on D10 won't run because the patch itself is updating core_version_requirement. I'll trigger a test against D10.1 manually.