Automated Drupal 11 compatibility fixes for field_protect

Created on 17 March 2024, about 1 year 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

Active

Version

1.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
  • This is an automated patch generated using Upgrade Status and Drupal Rector. Please see the issue summary for more details. A merge request 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, will allow the Project Update Bot to post additional Drupal 11 compatibility fixes as they become available in Drupal Rector.

    Debug info

    Bot run #11-121090

    This patch was created using these packages:

    1. drupal/upgrade_status: 4.1.0
    2. mglaman/phpstan-drupal: 1.2.7
    3. palantirnet/drupal-rector: 0.20.1
  • Status changed to Needs review about 1 year ago
  • Status changed to RTBC 4 months ago
  • 🇩🇪Germany geek-merlin Freiburg, Germany

    Trivially rtbc.

  • 🇨🇦Canada mparker17 UTC-4

    +1 to RTBC.

    I have code-reviewed and manually tested the code in merge request !11, and I'm satisfied with it.

    Here's what I did to manually-test !11:

    1. Install ddev (I tested on version 1.24.1)
    2. Clone the module, issue fork, and branch:
      1. git clone --branch '1.x' https://git.drupalcode.org/project/field_protect.git && cd field_protect - clone the project
      2. git remote add field_protect-3430524 https://git.drupalcode.org/issue/field_protect-3430524.git && git fetch field_protect-3430524 - add a remote for the issue fork
      3. git checkout -b 'project-update-bot-only' --track field_protect-3430524/'project-update-bot-only' - switch to the branch for merge request !11
    3. Set up a test site for the module with the ddev/ddev-drupal-contrib plugin:
      1. ddev config --project-type=drupal --docroot=web --php-version=8.3 --corepack-enable --project-name=field-protect - create a ddev project for testing the module
      2. ddev add-on get ddev/ddev-drupal-contrib && ddev start && ddev poser && ddev symlink-project - run the setup steps for the ddev/ddev-drupal-contrib addon
      3. Go to https://field-protect.ddev.site/core/install.php in a browser. Confirm that I saw the Drupal 11.0.9 installer. Install the site with the "Standard" install profile.
      4. Go to /admin/people/create and create a user with the Content editor role. I gave mine the username test_editor.
    4. Set up the module for testing:
      1. Go to /admin/modules and install field_protect and its dependencies
      2. Go to /admin/people/permissions, grant the Content editor role the following permissions:
        • Field Protect -> Remember field unlock

        ... click Save permissions.

      3. Go to /admin/structure/types/manage/page/form-display. Click the gear in to the Title row. Check Field Protect: Protect from accidental changes.. In Field Protect: Message, enter Changing the title may result in the URL alias changing!, then click Update. You see the warning message You have unsaved changes.. Click Save. You see the status message Your settings have been saved. The Title row now shows Field protected against accidental changes 🔒 and, indented, Changing the title may result in the URL alias changing!.
    5. Test the module's basic functionality:
      1. Log out of the administrator account and log in as the test_editor user you created earlier.
      2. Go to /node/add/page. Set Title = Lorem and Body = Ipsum. Click Save. You see the status message Basic page Lorem has been created.
      3. Click Edit in the primary tabs. You see an Edit Basic page Lorem form. The Title field is greyed out with a Unlock field link.
      4. Click the Unlock field link. You see a modal that looks like:

        Please confirm before you continue

        This field is locked

        You can edit this field, but you need to understand the implications. This field is protected with the following message:

        Changing the title may result in the URL alias changing!

        Are you sure you want to proceed?

        ... you see Cancel and Unlock buttons.

      5. Click the Cancel button in the modal. The modal disappears, and the field remains locked.
      6. Click the Unlock field link. You see the same modal from earlier.
      7. Click the Unlock button in the modal. The title field is now editable again. Set Title = Dolor. Click Save. You see the status message Basic page Dolor has been updated.
  • 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-392907

    These packages were used to generate the fixes:

    1. drupal/upgrade_status: 4.3.6
    2. mglaman/phpstan-drupal: 1.3.2
    3. palantirnet/drupal-rector: 0.20.3
  • 🇨🇦Canada andrew.wang

    #2 and #6 are identical - moving back to RTBC.

Production build 0.71.5 2024