Automated Drupal 10 compatibility fixes

Created on 18 July 2022, almost 2 years ago
Updated 19 October 2023, 8 months ago

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 โ†’

Periodically patches will be added to this issue that remove Drupal 10 deprecated API uses. To stop further patches from being posted simply close this issue (any status besides Active, Needs review or Needs work) or remove the "ProjectUpdateBotD10" tag from the issue.

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 or Needs work) 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.

  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 don't want new automated patches simply leave this issue open but remove the "ProjectUpdateBotD10" tag from the issue.

    You can use Drupal Rector yourself to make these patches.

    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 or Needs work) 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 may be useful to other contributors to add those issues as "Related issues" when closing this issue.

Remaining tasks

Using the patches

  1. Apply the patch in the comment by Project Update Bot โ†’ .
  2. Thoroughly test the patch. These patches are automatically generated so they haven't been tested manually or automatically.

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 Infrastructure project issue queue โ†’ using the component โ€œBot: Drupal Rectorโ€.

๐Ÿ“Œ Task
Status

Fixed

Version

1.0

Component

Code

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

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • ๐Ÿ‡บ๐Ÿ‡ฆUkraine Taran2L Lviv
  • Status changed to RTBC about 1 year ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia AbhinavK

    Patch #4 works for me without any error in local with Drupal 9 (9.5.7) and Drupal 10 (10.0.3) and php 8.1.

    Attaching images.

  • First commit to issue fork.
  • @yahyaalhamad opened merge request.
  • ๐Ÿ‡ฏ๐Ÿ‡ดJordan YahyaAlHamad Jordan

    I created a new merge request.

  • ๐Ÿ‡บ๐Ÿ‡ฆUkraine Taran2L Lviv

    hi @YahyaAlHamad, what is the reasoning of creating the MR when there is an already working patch available?

  • ๐Ÿ‡ณ๐Ÿ‡ฑNetherlands Maurice M.

    I think the composer.lock file does not look at patches. If you try to update to Drupal 10 with this patch then you get composer errors because it expects D8 or D9 in the requirements.

    It would be nice if this can be merged in a version we can require with composer.

  • ๐Ÿ‡บ๐Ÿ‡ฆUkraine Taran2L Lviv

    @Maurice M., you are right, and there is https://github.com/mglaman/composer-drupal-lenient as a workaround solution (instead of using a forked repo that might go away any day)

  • ๐Ÿ‡ณ๐Ÿ‡ฑNetherlands Maurice M.

    Ah good to know there is a workaround for forked repo's. Thanks for the info.

    Is there a way to use your unmerged commit with composer, with something like: composer require drupal/file_download:dev-1.x#30f53853?

    We need a developer of this module to merge your commit, I'm afraid that could take a while.

  • ๐Ÿ‡บ๐Ÿ‡ฆUkraine Taran2L Lviv

    Well, there are two options:

    1. Use the fork with patch already committed via custom repository setup, described here https://www.mediacurrent.com/blog/how-fix-catch-22-problem-drupal-9-fixe...
    2. Use normal project from drupal.org + mglaman/composer-drupal-lenient + patch from this issue

  • ๐Ÿ‡ฏ๐Ÿ‡ดJordan YahyaAlHamad Jordan

    @Taran2L Forked repos from issues might go away? So it is not recommended to use them?

  • ๐Ÿ‡บ๐Ÿ‡ฆUkraine Taran2L Lviv

    Seems are they are not being deleted (at least for now), see this thread in Drupal Slack: https://drupal.slack.com/archives/C51GNJG91/p1683628973141679

    drummThey mostly arenโ€™t really using much resources (except for a regression in GitLab at the moment https://gitlab.com/gitlab-org/gitlab/-/issues/408746). We may need to set up automated deletion in the future, something like delete forks for closed issues or with merged MRs after some number of weeks

  • ๐Ÿ‡ฌ๐Ÿ‡งUnited Kingdom Dippers

    The patch in #5 does not apply for me against v1.5. There are two failures on the info.yml files. The patch to file_download_counter.info.yml fails because there is no '#' at the start of the version: VERSION line which there is in the repo. The second failure on file_download.info.yml seems to be caused by the patch changing the last line of the info file and presumably there is some difference in either the EOL or EOF markers that mean it fails to apply. Have not found a workaround for this yet.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia manojapare

    For projects using composer workflow, this patch should work.

  • Status changed to Needs review about 1 year ago
  • Status changed to RTBC about 1 year ago
  • ๐Ÿ‡บ๐Ÿ‡ฆUkraine Taran2L Lviv

    Patch in #17 is the same as #4, except a tiny info.yml change, setting back to RTBC

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Senthil Kannayram V Bengaluru

    Hi Everyone , Can you please update when this MR can be merged.

  • Status changed to Needs review about 1 year ago
  • 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.15.1, cannot fix all Drupal 10 compatibility problems.

    Therefore 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 #12554

    This patch was created using these packages:

    1. mglaman/phpstan-drupal: 1.1.35
    2. palantirnet/drupal-rector: 0.15.1
  • First commit to issue fork.
  • Status changed to RTBC 12 months ago
  • ๐Ÿ‡บ๐Ÿ‡ฆUkraine snap_x

    +1 to RTBC. Works fine for me in Drupal 10. Also updated the MR according to the latest Drupal Rector's changes.

  • First commit to issue fork.
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia rushiraval

    I have applied patch from MR!1. It working fine.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia ajeet_kumar gurugaon

    fixed phpcs issue

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia ajeet_kumar gurugaon

    Fixed drupal coder issue

  • Status changed to Needs work 10 months ago
  • ๐Ÿ‡ซ๐Ÿ‡ฎFinland HeikkiY Oulu

    There are some issues with the patches.

    The patch from #26 seems to be missing the core_version_requirement line from the .info.files both in file_download.info.yml and modules/file_download_counter/file_download_counter.info.yml. This gives an error with Upgrade status.

    It also gives another error:
    Call to deprecated method mimeHeaderEncode() of class Drupal\Component\Utility\Unicode. Deprecated in drupal:9.2.0 and is removed from drupal:10.0.0. Use \Symfony\Component\Mime\Header\UnstructuredHeader instead.

    I also tested the MR from git.drupalcode.org but that patch does not apply against the latest stable version. The patch from #17 applies fine and seems to be fine in Upgrade status.

  • Status changed to RTBC 10 months ago
  • ๐Ÿ‡ซ๐Ÿ‡ฎFinland HeikkiY Oulu

    Seems like using the 1.x-dev does apply the patch. I am marking this reviewed if the dev version is fine.

  • First commit to issue fork.
  • Status changed to Needs review 8 months ago
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States hyperlinked San Jose, CA

    There was still another issue after patch #26 from @ajeet_kumar. Thie issue was described by HeikkiY in #28. The file FileDownloadDownloadController.php was using a depricated Unicode library to read Mime headers. The native Drupal File::getMimeType works just fine.

    I've combined the numerous patches into a commit and added my fix to the mimeHeaderEncode() bug. I may have inadvertently created some extra branches in this issue fork. If someone is able to delete them, please do so. My commits are made against the main branch of file_download-3297221.

    I'm requesting a review.

  • @hyperlinked opened merge request.
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States hyperlinked San Jose, CA

    Here's one single patch that will combine all of the previously contributed Drupal 10 compatibility patches into one patch file. This patch will apply cleanly against the 8.x-1.x-dev branch (aka the 8.x-1.5 branch).

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States hyperlinked San Jose, CA
  • ๐Ÿ‡ซ๐Ÿ‡ฎFinland HeikkiY Oulu

    @hyperlinked The merge request was last updated 2 months ago. Are you able to commit your changes there for easier reviewing: https://git.drupalcode.org/project/file_download/-/merge_requests/1#a45f...?.

    We are currently using the issue fork in our Drupal 10 testing with the following Composer repository:

    {
                "type": "git",
                "url": "https://git.drupalcode.org/issue/file_download-3297221.git"
    },
    

    If all the relevant changes would be in that fork, it would make testing the patch easier.

  • ๐Ÿ‡บ๐Ÿ‡ฆUkraine Taran2L Lviv

    hi everyone,

    thanks for working on this, but everything has been fixed in #17, and any further work on this is just duplication of efforts

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States hyperlinked San Jose, CA

    @HeikkiY, good idea. Done. Someone please review so we can get this merged and not end up accidentally duplicating more effort.

  • Status changed to Fixed 8 months ago
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States shelane

    I just became a co-maintainer. I have been reviewing these all changes this week and testing in preparation for that. Some of the patches included out of scope changes that will be addressed in another issue.

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

Production build 0.69.0 2024