Automated Drupal 11 compatibility fixes for backup_migrate

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

These packages were used to generate the fixes:

1. drupal/upgrade_status: 4.1.0
2. mglaman/phpstan-drupal: 1.2.10
3. palantirnet/drupal-rector: 0.20.1

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.2, 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

These packages were used to generate the fixes:

1. drupal/upgrade_status: 4.3.2
2. mglaman/phpstan-drupal: 1.2.11
3. palantirnet/drupal-rector: 0.20.2

The last submitted patch, 3: backup_migrate.5.1.x-dev.rector.patch, failed testing. View results →
- codesniffer_fixes.patch Interdiff of automated coding standards fixes only.

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.3, 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

These packages were used to generate the fixes:

1. drupal/upgrade_status: 4.3.2
2. mglaman/phpstan-drupal: 1.2.11
3. palantirnet/drupal-rector: 0.20.3

The last submitted patch, 6: backup_migrate.5.1.x-dev.rector.patch, failed testing. View results →
- codesniffer_fixes.patch Interdiff of automated coding standards fixes only.

To test Drupal 11, add the following to composer.json repositories

  "repositories": [
    {
      "type": "vcs",
      "url": "https://git.drupalcode.org/issue/backup_migrate-3438158.git"
    },
...
  ],

and then run

composer require drupal/backup_migrate:dev-project-update-bot-only

Installed successfully against 11.0.0 in Drupalpod but marking as "Needs Work" because of all the test failures.

VladimirAus → changed the visibility of the branch 3438158-automated-drupal-11 to hidden.

upgrade status is green.
Only need to fix serious warnings in phpstan

Yea, seems like this module largely ignores dependency injection:

------ ---------------------------------------------------------------------- 
  Line   src/Controller/BackupController.php                                   
 ------ ---------------------------------------------------------------------- 
  28     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  115    \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  116    \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  133    \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  134    \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
 ------ ---------------------------------------------------------------------- 
 ------ ----------------------------------------------------------------------- 
  Line   src/Controller/ScheduleListBuilder.php                                 
 ------ ----------------------------------------------------------------------- 
  44     \Drupal calls should be avoided in classes, use dependency injection   
         instead                                                                
  46     \Drupal calls should be avoided in classes, use dependency injection   
         instead                                                                
  47     \Drupal calls should be avoided in classes, use dependency injection   
         instead                                                                
  55     \Drupal calls should be avoided in classes, use dependency injection   
         instead                                                                
  57     \Drupal calls should be avoided in classes, use dependency injection   
         instead                                                                
  73     \Drupal calls should be avoided in classes, use dependency injection   
         instead                                                                
  85     Parameter $form_state of method                                        
         Drupal\backup_migrate\Controller\ScheduleListBuilder::submitForm()     
         has invalid type Drupal\backup_migrate\Controller\FormStateInterface.  
  86     Call to an undefined static method                                     
         Drupal\Core\Config\Entity\ConfigEntityListBuilder::submitForm().       
  88     \Drupal calls should be avoided in classes, use dependency injection   
         instead                                                                
 ------ ----------------------------------------------------------------------- 
 ------ ---------------------------------------------------------------------- 
  Line   src/Core/Destination/DirectoryDestination.php                         
 ------ ---------------------------------------------------------------------- 
  241    \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  246    \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
 ------ ---------------------------------------------------------------------- 
 ------ ---------------------------------------------------------------------- 
  Line   src/Core/Filter/CompressionFilter.php                                 
 ------ ---------------------------------------------------------------------- 
  204    \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  257    \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  305    \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  307    \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  312    \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  328    Method                                                                
         Drupal\backup_migrate\Core\Filter\CompressionFilter::zipDecode()      
         should return bool but return statement is missing.                   
  330    \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
 ------ ---------------------------------------------------------------------- 
 ------ ---------------------------------------------------------------------- 
  Line   src/Core/Filter/FileNamer.php                                         
 ------ ---------------------------------------------------------------------- 
  24     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  98     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  99     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
 ------ ---------------------------------------------------------------------- 
 ------ ---------------------------------------------------------------------- 
  Line   src/Core/Filter/Notify.php                                            
 ------ ---------------------------------------------------------------------- 
  45     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  58     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  102    \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  114    \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  139    \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
 ------ ---------------------------------------------------------------------- 
 ------ ---------------------------------------------------------------------- 
  Line   src/Core/Service/Mailer.php                                           
 ------ ---------------------------------------------------------------------- 
  30     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  31     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
 ------ ---------------------------------------------------------------------- 
 ------ ---------------------------------------------------------------------- 
  Line   src/Core/Source/MySQLiSource.php                                      
 ------ ---------------------------------------------------------------------- 
  48     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
 ------ ---------------------------------------------------------------------- 
 ------ -------------------------------------------------------------------------------------- 
  Line   src/Drupal/Config/DrupalConfigHelper.php                                              
 ------ -------------------------------------------------------------------------------------- 
  284    Method                                                                                
         Drupal\backup_migrate\Drupal\Config\DrupalConfigHelper::getSettingsProfileSelector()  
         should return array but return statement is missing.                                  
 ------ -------------------------------------------------------------------------------------- 
 ------ ------------------------------------------------------------------------------------ 
  Line   src/Drupal/Destination/DrupalBrowserUploadDestination.php                           
 ------ ------------------------------------------------------------------------------------ 
  21     \Drupal calls should be avoided in classes, use dependency injection                
         instead                                                                             
  23     Method                                                                              
         Drupal\backup_migrate\Drupal\Destination\DrupalBrowserUploadDestination::getFile()  
         should return Drupal\backup_migrate\Core\File\BackupFileInterface but               
         return statement is missing.                                                        
  56     \Drupal calls should be avoided in classes, use dependency injection                
         instead                                                                             
 ------ ------------------------------------------------------------------------------------ 
 ------ ---------------------------------------------------------------------- 
  Line   src/Drupal/Destination/DrupalDirectoryDestination.php                 
 ------ ---------------------------------------------------------------------- 
  35     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  62     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  72     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
 ------ ---------------------------------------------------------------------- 
 ------ ---------------------------------------------------------------------------------------------- 
  Line   src/Drupal/EntityPlugins/WrapperPluginBase.php                                                
 ------ ---------------------------------------------------------------------------------------------- 
  32     Method                                                                                        
         Drupal\backup_migrate\Drupal\EntityPlugins\WrapperPluginBase::getObject()                     
         should return                                                                                 
         Drupal\backup_migrate\Drupal\EntityPlugins\Drupal\backup_migrate\Core\Plugin\PluginInterface  
         but return statement is missing.                                                              
 ------ ---------------------------------------------------------------------------------------------- 
 ------ ---------------------------------------------------------------------- 
  Line   src/Drupal/Environment/DrupalSetMessageLogger.php                     
 ------ ---------------------------------------------------------------------- 
  43     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
 ------ ---------------------------------------------------------------------- 
 ------ ----------------------------------------------------------------------- 
  Line   src/Drupal/Filter/DrupalEncrypt.php                                    
 ------ ----------------------------------------------------------------------- 
  48     \Drupal calls should be avoided in classes, use dependency injection   
         instead                                                                
  74     \Drupal calls should be avoided in classes, use dependency injection   
         instead                                                                
  75     \Drupal calls should be avoided in classes, use dependency injection   
         instead                                                                
  78     Call to static method encryptFileWithPassword() on an unknown class    
         Defuse\Crypto\File.                                                    
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  79     \Drupal calls should be avoided in classes, use dependency injection   
         instead                                                                
  83     Caught class Drupal\backup_migrate\Drupal\Filter\Exception not found.  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  92     \Drupal calls should be avoided in classes, use dependency injection   
         instead                                                                
  93     \Drupal calls should be avoided in classes, use dependency injection   
         instead                                                                
  96     Call to static method decryptFileWithPassword() on an unknown class    
         Defuse\Crypto\File.                                                    
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  100    Caught class Drupal\backup_migrate\Drupal\Filter\Exception not found.  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
 ------ ----------------------------------------------------------------------- 
 ------ ---------------------------------------------------------------------- 
  Line   src/Drupal/Filter/DrupalUtils.php                                     
 ------ ---------------------------------------------------------------------- 
  75     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  76     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  87     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
 ------ ---------------------------------------------------------------------- 
 ------ ---------------------------------------------------------------------- 
  Line   src/Drupal/Source/DrupalSiteArchiveSource.php                         
 ------ ---------------------------------------------------------------------- 
  91     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
 ------ ---------------------------------------------------------------------- 
 ------ ---------------------------------------------------------------------- 
  Line   src/Entity/WrapperEntityBase.php                                      
 ------ ---------------------------------------------------------------------- 
  47     Method Drupal\backup_migrate\Entity\WrapperEntityBase::getObject()    
         should return Drupal\backup_migrate\Entity\SourcePluginInterface but  
         return statement is missing.                                          
 ------ ---------------------------------------------------------------------- 
 ------ ---------------------------------------------------------------------- 
  Line   src/Form/BackupMigrateAdvancedBackupForm.php                          
 ------ ---------------------------------------------------------------------- 
  45     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  48     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  75     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  96     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
 ------ ---------------------------------------------------------------------- 
 ------ ---------------------------------------------------------------------- 
  Line   src/Form/EntityDeleteForm.php                                         
 ------ ---------------------------------------------------------------------- 
  43     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
 ------ ---------------------------------------------------------------------- 
 ------ ---------------------------------------------------------------------- 
  Line   src/Form/ScheduleDeleteForm.php                                       
 ------ ---------------------------------------------------------------------- 
  41     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
 ------ ---------------------------------------------------------------------- 
 ------ ---------------------------------------------------------------------- 
  Line   src/Form/ScheduleForm.php                                             
 ------ ---------------------------------------------------------------------- 
  134    \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  140    \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  144    Method Drupal\backup_migrate\Form\ScheduleForm::save() should return  
         int but return statement is missing.                                  
 ------ ---------------------------------------------------------------------- 
 ------ ---------------------------------------------------------------------- 
  Line   src/Form/SettingsProfileDeleteForm.php                                
 ------ ---------------------------------------------------------------------- 
  41     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
 ------ ---------------------------------------------------------------------- 
 ------ ---------------------------------------------------------------------- 
  Line   src/Form/SettingsProfileForm.php                                      
 ------ ---------------------------------------------------------------------- 
  63     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  69     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  73     Method Drupal\backup_migrate\Form\SettingsProfileForm::save() should  
         return int but return statement is missing.                           
 ------ ---------------------------------------------------------------------- 
 ------ ---------------------------------------------------------------------- 
  Line   src/Form/WrapperEntityForm.php                                        
 ------ ---------------------------------------------------------------------- 
  86     Method Drupal\backup_migrate\Form\WrapperEntityForm::save() should    
         return int but return statement is missing.                           
  88     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
  95     \Drupal calls should be avoided in classes, use dependency injection  
         instead                                                               
 ------ ---------------------------------------------------------------------- 
 [ERROR] Found 74 errors                                                        

As fixing these issues is fairly straight forward, I'd tag this as an "Novice" issue.

Here are some helpful informations regarding dependency injection:

• https://www.drupal.org/docs/drupal-apis/services-and-dependency-injectio... →
• https://medium.com/@ragasirtahk/understanding-and-implementing-dependenc...
• https://www.drupal.org/docs/drupal-apis/services-and-dependency-injectio... →

On another note, fixing THIS many PHPStan issues inside a Drupal compatibility issue could be seen as unrelated.

I'd suggest, we fix the PHPStan issues in 📌 Fix PHPStan and Coding standards issues Needs work , use this issue purely for compatibility issues and skip the PHPStan job for now.

Ok fixed the rest of the serious phpstan issues, the rest (mainly dependency injection issues) should be fixed in 📌 Fix PHPStan and Coding standards issues Needs work in my opinion! 👍

Please review!

@grevil Left some comments ~~ hence moving into NW

Also I'm not sure whether we need to drop D9 here could you please add back and check whether there's any issues we encounter in the D9 or its pipeline?

Commented everything regarding my committed changes. Currently, not the time to put any further time into this (even if it is almost finished).

Alright, resolved all remaining comments, please review!

I can verify that the project-update-bot-only branch installs in Drupal 11 and can be enabled!

However, I notice there are dire warnings that we are not supposed to change this branch because it can be overwritten at any time. So maybe make a new branch? :)

Thanks, @grevil!

@benstallings I think those warnings are only due to the project update bot making automatic changes to the branch and could override the manual changes.

But since Drupal 11 is released, there won't be any new deprecation notices targeting 11.x and therefore no more automatic changes. I merged the modified "project-update-bot-only" branch in all of our maintained module projects and never had any problems doing so.

Would it be possible to support D9 and maybe leaving D12-level deprecations until later? I'd prefer to support D9 if possible. Thank you.

While reviewing this I realized that the change from FileSystemInterface::REPLACE to FileExists::Replace makes the module require 10.3: https://www.drupal.org/node/3426517 → I'm not sure I want to drop 9 and 10.2 entirely yet. Argh.

It could use \Drupal\Core\Utility\DeprecationHelper::backwardsCompatibleCall() and selectively use FileSystemInterface::REPLACE or FileExists::Replace, right?

DeprecationHelper also introduced in D10.1 so it's better if we can stick with FileSystemInterface::REPLACE until the minimum support is D10.3 or later on at the time of the D12 readiness.

cc: @damienmckenna

New changes LGTM, and make the module D9 compatible once again! Thanks, @ankitv18! :)

Committed. Thanks everyone!

Thanks Damien!

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

+1 for an official release. Thanks for working on this!

+1 for an official release. Thank you!