Automated Drupal 11 compatibility fixes for seckit

Created on 24 March 2024, 10 months ago
Updated 12 August 2024, 5 months ago

Problem/Motivation

Hello project maintainers,

This is an automated issue to help make this module compatible with Drupal 11.

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 "ProjectUpdateBotD11" 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 "ProjectUpdateBotD11" 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 "ProjectUpdateBotD11" 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 "ProjectUpdateBotD11" 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 11 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 โ†’ .

๐Ÿ“Œ Task
Status

Fixed

Version

2.0

Component

Code

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @project update bot
  • Open in Jenkins โ†’ Open on Drupal.org โ†’
    Core: 10.2.1 + Environment: PHP 8.2 & MySQL 8
    last update 10 months ago
    34 pass
  • 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 11 Compatibility

    According to the Upgrade Status module โ†’ , even with these changes, this module is not yet compatible with Drupal 11.

    Currently Drupal Rector, version 0.20.1, cannot fix all Drupal 11 compatibility problems.

    Therefore these changes did not update the info.yml file for Drupal 11 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 11 compatibility fixes as they become available in Drupal Rector.

    Debug information

    Bot run #11-127659

    These packages were used to generate the fixes:

    1. drupal/upgrade_status: 4.1.0
    2. mglaman/phpstan-drupal: 1.2.9
    3. palantirnet/drupal-rector: 0.20.1
  • Status changed to Needs review 10 months ago
  • Open in Jenkins โ†’ Open on Drupal.org โ†’
    Core: 10.2.1 + Environment: PHP 8.2 & MySQL 8
    last update 10 months ago
    34 pass
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia chandu7929 Pune
  • Status changed to Needs work 8 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia chandu7929 Pune

    Running command ./vendor/bin/drush upgrade_status:analyze seckit I can see following issues:

    ================================================================================
    Security Kit, --
    Scanned on Tue, 05/14/2024 - 11:44
    
    FILE: modules/contrib/seckit/tests/src/Functional/SecKitTestCaseTest.php
    
    STATUS         LINE                           MESSAGE                           
    --------------------------------------------------------------------------------
    Check manually 66   Call to deprecated method getConfig() of interface          
                        GuzzleHttp\ClientInterface: ClientInterface::getConfig will 
                        be removed in guzzlehttp/guzzle:8.0.                        
    --------------------------------------------------------------------------------
    
    FILE: modules/contrib/seckit/seckit.info.yml
    
    STATUS         LINE                           MESSAGE                           
    --------------------------------------------------------------------------------
    Check manually 4    Value of core_version_requirement: ^9.3 || ^10 is not       
                        compatible with the next major version of Drupal core. See  
                        https://drupal.org/node/3070687.                            
    --------------------------------------------------------------------------------
    
  • Open in Jenkins โ†’ Open on Drupal.org โ†’
    Core: 10.2.1 + Environment: PHP 8.2 & MySQL 8
    last update 8 months ago
    34 pass
  • Pipeline finished with Failed
    8 months ago
    Total: 264s
    #174164
  • Open in Jenkins โ†’ Open on Drupal.org โ†’
    Core: 10.2.1 + Environment: PHP 8.2 & MySQL 8
    last update 8 months ago
    34 pass
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia chandu7929 Pune

    chandu7929 โ†’ changed the visibility of the branch project-update-bot-only to hidden.

  • Pipeline finished with Failed
    8 months ago
    #174172
  • Open in Jenkins โ†’ Open on Drupal.org โ†’
    Core: 10.2.1 + Environment: PHP 8.2 & MySQL 8
    last update 8 months ago
    34 pass
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia chandu7929 Pune

    chandu7929 โ†’ changed the visibility of the branch project-update-bot-only to active.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia chandu7929 Pune

    chandu7929 โ†’ changed the visibility of the branch 3434417-automated-drupal-11 to hidden.

  • Pipeline finished with Success
    8 months ago
    Total: 226s
    #174223
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia vishalkhode

    vishalkhode โ†’ changed the visibility of the branch project-update-bot-only to hidden.

  • Merge request !26Fixed Drupal 11 compatibility issues. โ†’ (Merged) created by vishalkhode
  • Open in Jenkins โ†’ Open on Drupal.org โ†’
    Core: 10.2.1 + Environment: PHP 8.2 & MySQL 8
    last update 8 months ago
    34 pass
  • Status changed to Needs review 8 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia vishalkhode

    I've fixed all the deprecated warnings and verified PHPUnit tests are also passing in Drupal 11. Please review MR.

  • Status changed to RTBC 8 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia ankitv18

    After apply the MR!26 there are no more issues when I run upgrade status, please check the screenshot ~~ marking this RTBC

  • ๐Ÿ‡น๐Ÿ‡ทTurkey orkut murat yฤฑlmaz Istanbul

    Any chance for merge?

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia chandu7929 Pune

    @jweowu - Can you please review merge and release this?

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia ankitv18

    This will break below D10.2 due to typedConfigManager.

  • Status changed to Needs work 7 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia ankitv18
  • Open in Jenkins โ†’ Open on Drupal.org โ†’
    Core: 10.2.1 + Environment: PHP 8.2 & MySQL 8
    last update 7 months ago
    2 fail
  • Status changed to Needs review 7 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia ankitv18

    Pushed the change please review the MR now.

  • 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 11 Compatibility

    According to the Upgrade Status module โ†’ these changes make this module compatible with Drupal 11! ๐ŸŽ‰
    Therefore these changes update the info.yml file for Drupal 11 compatibility.

    Leaving this issue open, even after committing the current patch or merging the MR, will allow the Project Update Bot โ†’ to post additional Drupal 11 compatibility fixes as they become available in Drupal Rector.

    Debug information

    Bot run #11-217342

    These packages were used to generate the fixes:

    1. drupal/upgrade_status: 4.3.4
    2. mglaman/phpstan-drupal: 1.2.11
    3. palantirnet/drupal-rector: 0.20.3
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia ankitv18
  • Status changed to RTBC 6 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia vipin.mittal18 Greater Noida

    MR !26 changes are compatible for D11

  • Status changed to Needs work 6 months ago
  • ๐Ÿ‡ฌ๐Ÿ‡งUnited Kingdom mcdruid ๐Ÿ‡ฌ๐Ÿ‡ง๐Ÿ‡ช๐Ÿ‡บ

    MR is currently failing tests AFAICS.

  • Status changed to RTBC 6 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia vipin.mittal18 Greater Noida

    Hello Drew, fixes has already been done at https://git.drupalcode.org/project/seckit/-/merge_requests/27/diffs and @chandan has already merged in this PR. It would be good if we merge GitLab CI too. Thanks!

  • Status changed to Needs work 6 months ago
  • ๐Ÿ‡ฌ๐Ÿ‡งUnited Kingdom mcdruid ๐Ÿ‡ฌ๐Ÿ‡ง๐Ÿ‡ช๐Ÿ‡บ

    Added a gitlab-ci template.

    MR26 is failing most if not all of the tests like this:

    29) Drupal\Tests\seckit\Functional\SecKitTestCaseTest::testEnabledReferrerPolicy
    Behat\Mink\Exception\ElementNotFoundException: Button with id|name|label|value "Save configuration" not found.
    
    /var/www/html/core/tests/Drupal/Tests/WebAssert.php:158
    /var/www/html/core/tests/Drupal/Tests/UiHelperTrait.php:78
    /var/www/html/modules/contrib/seckit/tests/src/Functional/SecKitTestCaseTest.php:630
    

    -----

    To make this easier to review, can we have some comments / references about where things like the "Handling the BC for typedConfigManager." commit comes from?

    Is the solution of removing the constructor completely and calling the parent from the create method a novel solution or is it following a pattern documented elsewhere?

    Does this ensure that the deprecation is solved for D11 but the module still works / passes tests for D10.2/10.3?

    In order to review these commits properly, I'm having to do quite a bit of digging and research.

    It'd be a lot easier if you could give me some clues as to what I'm looking at, and why certain changes are being made. Thanks!

  • First commit to issue fork.
  • Pipeline finished with Success
    6 months ago
    Total: 272s
    #227588
  • Status changed to Needs review 6 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia ankitv18

    @mcdruid Sorry that was miss from my end, By mistake Iโ€™ve reversed the containerisation for respective properties.
    I've executed the pipelines and all jobs are passing now.

    By the way typedConfigManager passed as an argument from D10.2 in configFormBase class and settingsForm.php consists of config.factory and typed.config which is already passed as an argument in https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Form%21Co...

    So as parent class already having those argument so I donโ€™t see any objective of overriding the parent properties and creating the instance with the same properties.

    Suggestion I either go with this changes or support minimum D10.2 then we can add back constructor with both configFactory and typedConfigManager as an argument required by configFormBase class.

  • Pipeline finished with Success
    6 months ago
    Total: 345s
    #227665
  • Pipeline finished with Skipped
    6 months ago
    #228780
  • Status changed to Fixed 6 months ago
  • ๐Ÿ‡ฌ๐Ÿ‡งUnited Kingdom mcdruid ๐Ÿ‡ฌ๐Ÿ‡ง๐Ÿ‡ช๐Ÿ‡บ

    Okay, thanks for the explanations and fixes.

    Here's the CR about the typedConfigManager / ConfigFormBase deprecation:

    https://www.drupal.org/node/3404140 โ†’

    At some point we should update the constraints to remove D9, but perhaps that should be 2.1.x

    Let's get this merged and then we can look at the other test / static checks fixes in ๐Ÿ“Œ Fix validate pipeline Fixed (thanks for working on that too!)

    Thanks everyone that contributed.

  • ๐Ÿ‡ซ๐Ÿ‡ทFrance andypost

    There's follow-up before tagging new release ๐Ÿ“Œ Automated Drupal 11 compatibility fixes for seckit Needs review

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

Production build 0.71.5 2024