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.

CommentFileSizeAuthor
#2 cloudfront_cache_path_invalidate.3.0.7.rector.patch549 bytesproject update bot

Issue fork cloudfront_cache_path_invalidate-3429249

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 cloudfront_cache_path_invalidate.3.0.7.rector.patch549 bytes

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-120835

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

Project Update Bot opened merge request !3

andrew.wang’s picture

andrew.wang commented
Version: 3.0.7 » 3.0.x-dev
Issue summary: View changes
Status: Needs review » Reviewed & tested by the community

Very straightforward patch. Looks good to me.

mparker17’s picture

mparker17
he/him
Primary language English
Location UTC-5
commented

+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.

prashant mishra closed merge request !3

mparker17’s picture

mparker17
he/him
Primary language English
Location UTC-5
commented

@prashant mishra, did you intend to close the merge request without merging?

prashant mishra’s picture

prashant mishra commented
Version: 3.0.x-dev » 4.0.0
Assigned: Unassigned » prashant mishra
Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

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