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
#2 openid_connect.2.x-dev.rector.patch494 bytesproject update bot

Issue fork openid_connect-3288879

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 openid_connect.2.x-dev.rector.patch494 bytes

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

Status: Needs review » Needs work

The last submitted patch, 2: openid_connect.2.x-dev.rector.patch, failed testing. View results
- codesniffer_fixes.patch Interdiff of automated coding standards fixes only.

pfrilling’s picture

pfrilling
Location Minster, OH
commented
Assigned: Unassigned » pfrilling
Issue summary: View changes

pfrilling opened merge request !48

pfrilling’s picture

pfrilling
Location Minster, OH
commented
Status: Needs work » Fixed

D10 support has been updated and merged into the 2.x branch.

Status: Fixed » Closed (fixed)

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

m.stenta’s picture

m.stenta
he/him
Primary language English
commented

I think the changes that were committed in reference to this issue are missing dependency declarations and an update hook. They add the drupal/externalauth module as a requirement in composer.json, but do not add it as a dependency to the openid_connect.info.yml. I think it also needs a hook_update_N() or hook_post_update_NAME() to enable the module on existing installs.

Referring to this commit: https://git.drupalcode.org/project/openid_connect/-/commit/e45f5481cab65...

jcnventura’s picture

jcnventura
Primary language English
commented

The update hook is there already, back when the externalauth module started being used: #3030596: Compatibility with externalauth .

But I do think that you're right that the composer dependency is not needed.

m.stenta’s picture

m.stenta
he/him
Primary language English
commented

@jcnventura My mistake! I think I got confused because there are a number of commits that go back and forth adding/removing `externalauth` to/from `composer.json` and `openid_connect.info.yml`.

But I do think that you're right that the composer dependency is not needed.

No I think that must be included, since it is a dependency of the module. Otherwise, `composer require drupal/openid_connect` will not download `drupal/externalauth`, and the module will be uninstallable.

I see you removed it here yesterday: https://git.drupalcode.org/project/openid_connect/-/commit/e64dd9e871b6e...

I think that change needs to be reverted. Unless you think otherwise? Maybe I'm missing something.

jcnventura’s picture

jcnventura
Primary language English
commented

Try it yourself. Get a fresh drupal install and composer require drupal/openid_connect. You'll see that externalauth is added by composer because of the fact that it is declared as a dependency in .info.yml. The tagged version you'll get is from before the commit that added that line to composer, which honestly is just making two things:

  • Duplicating the information in the .info.yml file
  • Making it impossible to install the module in Drupal 8, for which you need externalauth 8.x-1.x

Also, if you don't want to be bothered, you can see that the tests running 2.x-dev from yesterday do install externalauth 2.x, even without any composer line: https://dispatcher.drupalci.org/job/drupal_contrib/620480/console

m.stenta’s picture

m.stenta
he/him
Primary language English
commented

Ooooh you know... you're right! I forgot... Drupal.org packagist does some automated dependency discovery using the info.yml files in addition to the composer.json. So yes, that should work fine as long as that logic stays in place on Drupal.org. I still prefer to declare it explicitly in composer.json, but that's just a preference. :-)

Thanks for the quick replies @jcnventura - appreciate all your work on this! :-)

jcnventura’s picture

jcnventura
Primary language English
commented
Status: Closed (fixed) » Needs work

This commit introduced a dependency on Drupal 9.3 or newer that should have been added to the .info.yml file. It also introduced a dependency on the drupal:file module that should be declared in that same file.

I've reverted this change now, so that I can replace the beta1 release with a new one that doesn't break Drupal 8 compatibility.

  • jcnventura committed 72a6c34 on 3.x 
    Issue #3288879 by jcnventura: Set minimum core version to 9.3 and drop...
jcnventura’s picture

jcnventura
Primary language English
commented
jcnventura’s picture

jcnventura
Primary language English
commented
Version: 2.x-dev » 3.x-dev
Status: Needs work » Fixed

Drupal 10 support is now part of the new 3.x branch.

project update bot’s picture

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

Status: Fixed » Closed (fixed)

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