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
#20 interdiff-16-20.txt777 bytesbbrala
#20 3288137-20.patch17.82 KBbbrala
#17 3288137-16.patch16.97 KBLal_
#15 interdiff12-14.txt801 bytesLal_
#15 3288137-14.patch16.75 KBLal_
#13 interdiff9-12.txt2.24 KBLal_
#12 interdiff9-12.patch2.24 KBLal_
#12 3288137-12.patch16.75 KBLal_
#11 jsonapi_extras.3.x-dev.rector.patch6.6 KBProject Update Bot
#11 interdiff-last-bot.6663252.txt1.31 KBProject Update Bot
#9 interdiff.txt1.05 KBLal_
#9 3288137-8.patch17.06 KBLal_
#7 interdiff.txt1.77 KBLal_
#7 3288137-7.patch16.24 KBLal_
#5 interdiff.txt1.13 KBLal_
#5 3288137-5.patch14.35 KBLal_
#4 interdiff.txt7.72 KBLal_
#4 3288137-4.patch13.56 KBLal_
#3 jsonapi_extras.3.x-dev.rector.patch5.68 KBProject Update Bot
#3 interdiff-last-bot.6643684.txt797 bytesProject Update Bot
#2 jsonapi_extras.3.x-dev.rector.patch5.2 KBProject Update Bot
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Project Update Bot created an issue. See original summary.

Project Update Bot’s picture

Project Update Bot CreditAttribution: Project Update Bot commented
Status: Active » Needs review
FileSize
jsonapi_extras.3.x-dev.rector.patch5.2 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.12.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 #127

This patch was created using these packages:

  1. mglaman/phpstan-drupal: 1.1.9
  2. palantirnet/drupal-rector: 0.12.0
Project Update Bot’s picture

Project Update Bot CreditAttribution: Project Update Bot commented
FileSize
interdiff-last-bot.6643684.txt797 bytes
jsonapi_extras.3.x-dev.rector.patch5.68 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
Lal_’s picture

Lal_
He\Him
CreditAttribution: Lal_ as a volunteer and at QED42 commented
Issue summary: View changes
FileSize
3288137-4.patch13.56 KB
interdiff.txt7.72 KB
Lal_’s picture

Lal_
He\Him
CreditAttribution: Lal_ as a volunteer and at QED42 commented
FileSize
3288137-5.patch14.35 KB
interdiff.txt1.13 KB
Lal_’s picture

Lal_
He\Him
CreditAttribution: Lal_ as a volunteer and at QED42 commented 
Drupal\Tests\jsonapi_extras\Functional\JsonApiExtrasFunctionalTest::testDisabledResourcesShowInAdminList
Exception: Deprecated function: htmlspecialchars(): Passing null to parameter #1 ($string) of type string is deprecated

Fix is blocked on https://www.drupal.org/project/drupal/issues/3255637

Lal_’s picture

Lal_
He\Him
CreditAttribution: Lal_ as a volunteer and at QED42 commented
FileSize
3288137-7.patch16.24 KB
interdiff.txt1.77 KB

https://www.drupal.org/project/drupal/issues/3254250

Lal_’s picture

Lal_
He\Him
CreditAttribution: Lal_ as a volunteer and at QED42 commented
Related issues: +#3255637: Deprecate NULL values in Html::escape(), ::decodeEntities(), and FormattableMarkup::placeholderFormat() to make it easier to upgrade to PHP 8, +#3254250: [Symfony 6] Retrieving a non-string value from "Symfony\Component\HttpFoundation\InputBag::get()" is deprecated
Lal_’s picture

Lal_
He\Him
CreditAttribution: Lal_ as a volunteer and at QED42 commented
FileSize
3288137-8.patch17.06 KB
interdiff.txt1.05 KB

The remaining failures will pass once we merge https://www.drupal.org/project/drupal/issues/3255637

mglaman’s picture

mglaman
Primary language English
Location WI, USA
CreditAttribution: mglaman at Acquia commented
Status: Needs review » Needs work 
  1. +++ b/composer.json
@@ -23,5 +23,10 @@
+    },
+    "extra": {
+        "drupal-lenient": {
+            "allowed-list": ["drupal/jsonapi_extras"]
+        }
     }

    remove: this doesn't belong in modules 

  2. +++ b/js/jsonapi_extras.admin.js
@@ -12,7 +12,7 @@
-      var $input = $('input.jsonapi-resources-filter-text', context).once('jsonapi-resources-filter-text');
+      var $input = once('jsonapi-resources-filter-text', 'input.jsonapi-resources-filter-text', context);

    This used to be a jQuery object but is not. Wrap with $() 

  3. +++ b/js/jsonapi_extras.expandable_rows_table.js
@@ -12,7 +12,7 @@
-      var $advanced_opts_links = $('.toggle-expanded', context).once('toggle-expanded');
+      var $advanced_opts_links = once('toggle-expanded', '.toggle-expanded', context);

    This used to be a jQuery object but is not. Wrap with $() 

  4. +++ b/jsonapi_extras.info.yml
@@ -2,7 +2,7 @@ name: JSON:API Extras
+core_version_requirement: '^8 || ^9 || ^10'

+++ b/modules/jsonapi_defaults/jsonapi_defaults.info.yml
@@ -2,7 +2,7 @@ name: JSON API Defaults
-core_version_requirement: '^8 || ^9'
+core_version_requirement: '^8 || ^9 || ^10'

    Must be 9.2 for jquery.once -> once

Project Update Bot’s picture

Project Update Bot CreditAttribution: Project Update Bot commented
Status: Needs work » Needs review
FileSize
interdiff-last-bot.6663252.txt1.31 KB
jsonapi_extras.3.x-dev.rector.patch6.6 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
Lal_’s picture

Lal_
He\Him
CreditAttribution: Lal_ as a volunteer and at QED42 commented
FileSize
3288137-12.patch16.75 KB
interdiff9-12.patch2.24 KB
Lal_’s picture

Lal_
He\Him
CreditAttribution: Lal_ as a volunteer and at QED42 commented
FileSize
interdiff9-12.txt2.24 KB

oops wrong extension ignore interdiff9-12.patch... uploading the txt file

The last submitted patch, 12: 3288137-12.patch, failed testing. View results

Lal_’s picture

Lal_
He\Him
CreditAttribution: Lal_ as a volunteer and at QED42 commented
FileSize
3288137-14.patch16.75 KB
interdiff12-14.txt801 bytes
mglaman’s picture

mglaman
Primary language English
Location WI, USA
CreditAttribution: mglaman at Acquia commented

DrupalCI needs a modification to be made to composer.json for it to read the local vcs over composer facade for metadata. This is a major quirk. I guess we'll need to make a small adjustment to the description and not have it committed.

Lal_’s picture

Lal_
He\Him
CreditAttribution: Lal_ as a volunteer and at QED42 commented
FileSize
3288137-16.patch16.97 KB

Triggering a diff in composer for DrupalCI to point in correctly

bbrala’s picture

bbrala
Location Netherlands
CreditAttribution: bbrala as a volunteer and at SWIS commented
Assigned: Unassigned » bbrala
Issue tags: +Drupal 10 porting day
bbrala’s picture

bbrala
Location Netherlands
CreditAttribution: bbrala as a volunteer and at SWIS commented

Since this will drop Drupal 8 support. Created a follow-up to remove Drupal 8 code in #3306184: [Follow-up] Remove Drupal 8 code paths.

bbrala’s picture

bbrala
Location Netherlands
CreditAttribution: bbrala as a volunteer and at SWIS commented
FileSize
3288137-20.patch17.82 KB
interdiff-16-20.txt777 bytes

First patch, still got some testing to do.

bbrala’s picture

bbrala
Location Netherlands
CreditAttribution: bbrala as a volunteer and at SWIS commented

Ok, i've also testes a few field enhancers, did overrides, saved forms, renamed a field, renamed a recource. All works as expected! Now hopefully tests come out green

bbrala’s picture

bbrala
Location Netherlands
CreditAttribution: bbrala as a volunteer and at SWIS commented
Status: Needs review » Active

Add credits for mglaman for the review.

Tests are green so i will commit this.

I'd like to keep this issue open so new patches are still posted though.

bbrala’s picture

bbrala
Location Netherlands
CreditAttribution: bbrala as a volunteer and at SWIS commented

Commiting without composer.json changes.

  • bbrala committed c76b1db on 8.x-3.x 
    Issue #3288137 by Lal_, Project Update Bot, bbrala, mglaman: Automated...
bbrala’s picture

bbrala
Location Netherlands
CreditAttribution: bbrala as a volunteer and at SWIS commented
Assigned: bbrala » Unassigned
Kristen Pol’s picture

Kristen Pol
she/her
Primary language English
Location Santa Cruz, CA, USA
CreditAttribution: Kristen Pol at Itty Bitty Byte for Salsa Digital commented

Thanks for merging the patch!

Please note to other community members, the fix has been committed so you do not need to test anything here since the maintainer did not request any additional testing.

This issue is being left open (as "Active") for the bot to be able to add additional patches.

Project Update Bot’s picture

Project Update Bot CreditAttribution: Project Update Bot commented
Issue summary: View changes

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

simohell’s picture

simohell CreditAttribution: simohell commented
Issue summary: View changes

This should probably be closed now?