Automated Drupal 11 compatibility fixes for cloudfront_cache_path_invalidate

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

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

Very straightforward patch. Looks good to me.

+1 to RTBC: I have code-reviewed and manually tested the code in merge request !3, and I'm satisfied with it.

Here is what I did to manually-test !3:

1. Install ddev (I tested on version 1.24.1)
2. Clone the module, issue fork, and branch:
   1. git clone --branch '3.0.x' https://git.drupalcode.org/project/cloudfront_cache_path_invalidate.git && cd cloudfront_cache_path_invalidate - clone the project
   2. git remote add cloudfront_cache_path_invalidate-3429249 https://git.drupalcode.org/issue/cloudfront_cache_path_invalidate-3429249.git && git fetch cloudfront_cache_path_invalidate-3429249 - add a remote for the issue fork
   3. git checkout -b 'project-update-bot-only' --track cloudfront_cache_path_invalidate-3429249/'project-update-bot-only' - switch to the branch for merge request !3
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=cloudfront-cache-path-invalidate
   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://cloudfront-cache-path-invalidate.ddev.site/core/install.php in a browser. Confirm that I saw the Drupal 11.1.0 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; enable the cloudfront_cache_path_invalidate module and all its dependencies.
   2. Go to /admin/people/permissions, grant the Content editor role the following permissions:
      • Cloudfront Cache Path Invalidate -> Use Cloudfront Cache Invalidate Form

      ... click Save permissions

   3. Edit web/sites/default/settings.php, adding (and filling in values for) the following lines for the website that is cached with CloudFront, as directed in README.md:
      

                $settings['aws.distributionid'] = '';
                $settings['aws.region'] = '';
                $settings['s3fs.access_key'] = '';
                $settings['s3fs.secret_key'] = '';
              

5. Test the basic module functions in Drupal 11:
   1. Log out of the administrator account, and log in as test_editor that I created earlier
   2. In another tab, open a page on the website that is cached with CloudFront (I will call this $TEST_PAGE_URL below — I picked a page that doesn't get much traffic). Opened my browser's Developer Tools' Network console. Refreshed $TEST_PAGE_URL until I saw an HTTP Response Header that looks like x-cache: Hit from cloudfront
   3. In another tab, logged into my AWS Cloudfront UI, go to the distribution for the website that is cached with CloudFront, and then go to the Invalidations tab for that distribution. Take note of the most-recent Invalidation's Date.
   4. Back in my Drupal 11 test site, go to /admin/config/services/cloudfront-invalidate-url. I see a Cloudfront Cache Setting form.
   5. In the URL to invalidate Cloudfront cache textarea, enter the path component of $TEST_PAGE_URL, took note of the current date/time, then click Invalidate Cloudfront Cache (e.g.: /node/123 or /path/to/url/alias). I see the status message Cloudfront URL Cache invalidation is in progress.
   6. Switch to the tab with my AWS Cloudfront UI for my Distribution. Refresh the Invalidations tab for that distribution. I see a new Invalidation (i.e.: different from the previous invalidation I noted earlier). The new Invalidation's Date was the date/time that I clicked the Invalidate Cloudfront Cache button in the previous step. The new Invalidation's Object paths matched the path I entered in the previous step. The new Invalidation's Status was Completed.
   7. Switch to the tab where I had $TEST_PAGE_URL open. Opened my browser's Developer Tools' Network console. Refreshed $TEST_PAGE_URL: I now see an HTTP Response Header that looks like x-cache: Miss from cloudfront.
6. Make sure there are no errors being logged:
   1. Log out of the test_editor user created earlier; and log in as the administrator again
   2. Go to /admin/reports/dblog to ensure our setup/testing did not result in any error messages related to this module.