Encourage the use of "league/flysystem-sftp-v3" instead of "league/flysystem-sftp"

Author: maxhelias

composer.json

@@ -21,8 +21,9 @@
     },
     "require": {
         "php": ">=7.2",
-        "league/flysystem": "^2.0|^3.0",
+        "league/flysystem": "^2.1|^3.0",
         "symfony/config": "^4.2|^5.0|^6.0",
+        "symfony/deprecation-contracts": "^2.1|^3",
         "symfony/http-kernel": "^4.2|^5.0|^6.0",
         "symfony/dependency-injection": "^4.2|^5.0|^6.0",
         "symfony/options-resolver": "^4.2|^5.0|^6.0"
@@ -33,7 +34,7 @@
         "league/flysystem-ftp": "^2.0|^3.0",
         "league/flysystem-google-cloud-storage": "^2.0|^3.0",
         "league/flysystem-memory": "^2.0|^3.0",
-        "league/flysystem-sftp": "^2.0|^3.0",
+        "league/flysystem-sftp-v3": "^2.0|^3.0",
         "symfony/dotenv": "^4.2|^5.0|^6.0",
         "symfony/framework-bundle": "^4.2|^5.0|^6.0",
         "symfony/phpunit-bridge": "^5.2",

docs/3-interacting-with-ftp-and-sftp-servers.md

@@ -39,7 +39,7 @@ flysystem:
 ### Installation
 
 ```
-composer require league/flysystem-sftp
+composer require league/flysystem-sftp-v3
 ```
 
 ### Usage

src/Adapter/Builder/SftpAdapterDefinitionBuilder.php

@@ -11,8 +11,10 @@
 
 namespace League\FlysystemBundle\Adapter\Builder;
 
-use League\Flysystem\PhpseclibV2\SftpAdapter;
-use League\Flysystem\PhpseclibV2\SftpConnectionProvider;
+use League\Flysystem\PhpseclibV2\SftpAdapter as SftpAdapterLegacy;
+use League\Flysystem\PhpseclibV2\SftpConnectionProvider as SftpConnectionProviderLegacy;
+use League\Flysystem\PhpseclibV3\SftpAdapter;
+use League\Flysystem\PhpseclibV3\SftpConnectionProvider;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
@@ -30,8 +32,19 @@ public function getName(): string
 
     protected function getRequiredPackages(): array
     {
+        $adapterFqcn = SftpAdapter::class;
+        $packageRequire = 'league/flysystem-sftp-v3';
+
+        // Prevent BC
+        if (class_exists(SftpAdapterLegacy::class)) {
+            trigger_deprecation('league/flysystem-bundle', '2.2', '"league/flysystem-sftp" is deprecated, use "league/flysystem-sftp-v3" instead.');
+
+            $adapterFqcn = SftpAdapterLegacy::class;
+            $packageRequire = 'league/flysystem-sftp';
+        }
+
         return [
-            SftpAdapter::class => 'league/flysystem-sftp',
+            $adapterFqcn => $packageRequire,
         ];
     }
 
@@ -70,10 +83,18 @@ protected function configureOptions(OptionsResolver $resolver)
 
     protected function configureDefinition(Definition $definition, array $options)
     {
-        $definition->setClass(SftpAdapter::class);
+        // Prevent BC
+        $adapterFqcn = SftpAdapter::class;
+        $connectionFqcn = SftpConnectionProvider::class;
+        if (class_exists(SftpAdapterLegacy::class)) {
+            $adapterFqcn = SftpAdapterLegacy::class;
+            $connectionFqcn = SftpConnectionProviderLegacy::class;
+        }
+
+        $definition->setClass($adapterFqcn);
         $definition->setArgument(0,
-            (new Definition(SftpConnectionProvider::class))
-                ->setFactory([SftpConnectionProvider::class, 'fromArray'])
+            (new Definition($connectionFqcn))
+                ->setFactory([$connectionFqcn, 'fromArray'])
                 ->addArgument($options)
                 ->setShared(false)
         );

tests/Adapter/Builder/SftpAdapterDefinitionBuilderTest.php

@@ -11,7 +11,7 @@
 
 namespace Tests\League\FlysystemBundle\Adapter\Builder;
 
-use League\Flysystem\PhpseclibV2\SftpAdapter;
+use League\Flysystem\PhpseclibV3\SftpAdapter;
 use League\FlysystemBundle\Adapter\Builder\SftpAdapterDefinitionBuilder;
 use PHPUnit\Framework\TestCase;