Making conflict smarter: choose an older recipe to apply

Author: weaverryan

src/Downloader.php

@@ -279,6 +279,16 @@ public function getRecipes(array $operations): array
         return $data;
     }
 
+    /**
+     * Used to "hide" a recipe version so that the next most-recent will be returned.
+     *
+     * This is used when resolving "conflicts".
+     */
+    public function removeRecipeFromIndex(string $packageName, string $version)
+    {
+        unset($this->index[$packageName][$version]);
+    }
+
     /**
      * Fetches and decodes JSON HTTP response bodies.
      */

src/Flex.php

@@ -15,6 +15,7 @@
 use Composer\Composer;
 use Composer\Console\Application;
 use Composer\DependencyResolver\Operation\InstallOperation;
+use Composer\DependencyResolver\Operation\OperationInterface;
 use Composer\DependencyResolver\Operation\UninstallOperation;
 use Composer\DependencyResolver\Operation\UpdateOperation;
 use Composer\DependencyResolver\Pool;
@@ -725,16 +726,21 @@ public function fetchRecipes(array $operations, bool $reset): array
             $name = $package->getName();
             $job = method_exists($operation, 'getOperationType') ? $operation->getOperationType() : $operation->getJobType();
 
-            if (!empty($manifests[$name]['manifest']['conflict']) && !$operation instanceof UninstallOperation) {
-                $lockedRepository = $this->composer->getLocker()->getLockedRepository();
+            while ($this->doesRecipeConflict($manifests[$name] ?? [], $operation)) {
+                $this->downloader->removeRecipeFromIndex($name, $manifests[$name]['version']);
+                $newData = $this->downloader->getRecipes([$operation]);
+                $newManifests = $newData['manifests'] ?? [];
 
-                foreach ($manifests[$name]['manifest']['conflict'] as $conflictingPackage => $constraint) {
-                    if ($lockedRepository->findPackage($conflictingPackage, $constraint)) {
-                        $this->io->writeError(sprintf('  - Skipping recipe for %s: it conflicts with %s %s.', $name, $conflictingPackage, $constraint), true, IOInterface::VERBOSE);
+                if (!isset($newManifests[$name])) {
+                    // no older recipe found
+                    $this->io->writeError(sprintf('  - Skipping recipe for %s: all versions of the recipe conflict with your package versions.', $name), true, IOInterface::VERBOSE);
 
-                        continue 2;
-                    }
+                    continue 2;
                 }
+
+                // push the "old" recipe into the $manifests
+                $manifests[$name] = $newManifests[$name];
+                $locks[$name] = $newData['locks'][$name];
             }
 
             if ($operation instanceof InstallOperation && isset($locks[$name])) {
@@ -991,4 +997,21 @@ public static function getSubscribedEvents(): array
 
         return $events;
     }
+
+    private function doesRecipeConflict(array $recipeData, OperationInterface $operation): bool
+    {
+        if (empty($recipeData['manifest']['conflict']) || $operation instanceof UninstallOperation) {
+            return false;
+        }
+
+        $lockedRepository = $this->composer->getLocker()->getLockedRepository();
+
+        foreach ($recipeData['manifest']['conflict'] as $conflictingPackage => $constraint) {
+            if ($lockedRepository->findPackage($conflictingPackage, $constraint)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
 }

tests/FlexTest.php

@@ -22,6 +22,7 @@
 use Composer\Package\Package;
 use Composer\Package\RootPackageInterface;
 use Composer\Plugin\PluginInterface;
+use Composer\Repository\RepositoryInterface;
 use Composer\Repository\RepositoryManager;
 use Composer\Repository\WritableRepositoryInterface;
 use Composer\Script\Event;
@@ -213,6 +214,96 @@ public function testFetchRecipesOrder()
         ], array_keys($recipes));
     }
 
+    public function testFetchRecipesWithConflicts()
+    {
+        $originalRecipes = [
+            'locks' => [
+                'doctrine/annotations' => [
+                    'version' => '1.13',
+                    'recipe' => [
+                        'version' => '1.0',
+                    ],
+                ],
+                'doctrine/doctrine-bundle' => [
+                    'version' => '2.5',
+                    'recipe' => [
+                        'version' => '2.4',
+                    ],
+                ],
+            ],
+            'manifests' => [
+                'doctrine/annotations' => [
+                    'version' => '1.0',
+                    'manifest' => [],
+                ],
+                'doctrine/doctrine-bundle' => [
+                    'version' => '2.4',
+                    'manifest' => [
+                        'conflict' => [
+                            'symfony/framework-bundle' => '<5.3',
+                        ],
+                    ],
+                ],
+            ],
+        ];
+        $oldRecipes = [
+            'locks' => [
+                'doctrine/doctrine-bundle' => [
+                    // 2.5 is still being installed, but 2.3 recipe used
+                    'version' => '2.5',
+                    'recipe' => [
+                        'version' => '2.3',
+                    ],
+                ],
+            ],
+            'manifests' => [
+                'doctrine/doctrine-bundle' => [
+                    'version' => '2.3',
+                    'manifest' => [],
+                ],
+            ],
+        ];
+
+        $io = new BufferIO('', OutputInterface::VERBOSITY_VERBOSE);
+        $rootPackage = $this->mockRootPackage(['symfony' => ['allow-contrib' => true]]);
+
+        $downloader = $this->getMockBuilder(Downloader::class)->disableOriginalConstructor()->getMock();
+        $downloader->expects($this->exactly(2))
+            ->method('getRecipes')
+            ->willReturnOnConsecutiveCalls($originalRecipes, $oldRecipes);
+        $downloader->expects($this->any())->method('isEnabled')->willReturn(true);
+        $downloader->expects($this->once())->method('removeRecipeFromIndex')->with('doctrine/doctrine-bundle', '2.4');
+
+        $locker = $this->getMockBuilder(Locker::class)->disableOriginalConstructor()->getMock();
+        $lockedRepository = $this->getMockBuilder(RepositoryInterface::class)->disableOriginalConstructor()->getMock();
+        // make the conflicted package show up
+        $locker->expects($this->any())
+            ->method('getLockedRepository')
+            ->willReturn($lockedRepository);
+        $lockedRepository->expects($this->once())
+            ->method('findPackage')
+            ->with('symfony/framework-bundle', '<5.3')
+            ->willReturn(new Package('symfony/framework-bundle', '5.2.0', '5.2.0'));
+        $composer = $this->mockComposer($locker, $rootPackage);
+        $configurator = $this->mockConfigurator();
+        $lock = $this->mockLock();
+        $flex = $this->mockFlexCustom($io, $composer, $configurator, $downloader, $lock);
+
+        $operations = [];
+        foreach ($originalRecipes['manifests'] as $name => $recipeData) {
+            $package = new Package($name, $recipeData['version'], $recipeData['version']);
+
+            $operations[] = new InstallOperation($package);
+        }
+        $recipes = $flex->fetchRecipes($operations, true);
+
+        $this->assertSame([
+            'doctrine/annotations',
+            'doctrine/doctrine-bundle',
+        ], array_keys($recipes));
+        $this->assertSame('2.3', $recipes['doctrine/doctrine-bundle']->getVersion());
+    }
+
     public static function getTestPackages(): array
     {
         return [
@@ -358,14 +449,8 @@ private function mockManager(): RepositoryManager
         return $manager;
     }
 
-    private function mockFlex(BufferIO $io, RootPackageInterface $package, Recipe $recipe = null, array $recipes = [], array $lockerData = []): Flex
+    private function mockFlexCustom(BufferIO $io, Composer $composer, Configurator $configurator, Downloader $downloader, Lock $lock): Flex
     {
-        $composer = $this->mockComposer($this->mockLocker($lockerData), $package);
-
-        $configurator = $this->mockConfigurator($recipe);
-        $downloader = $this->mockDownloader($recipes);
-        $lock = $this->mockLock();
-
         return \Closure::bind(function () use ($composer, $io, $configurator, $downloader, $lock) {
             $flex = new Flex();
             $flex->composer = $composer;
@@ -381,4 +466,15 @@ private function mockFlex(BufferIO $io, RootPackageInterface $package, Recipe $r
             return $flex;
         }, null, Flex::class)->__invoke();
     }
+
+    private function mockFlex(BufferIO $io, RootPackageInterface $package, Recipe $recipe = null, array $recipes = [], array $lockerData = []): Flex
+    {
+        $composer = $this->mockComposer($this->mockLocker($lockerData), $package);
+
+        $configurator = $this->mockConfigurator($recipe);
+        $downloader = $this->mockDownloader($recipes);
+        $lock = $this->mockLock();
+
+        return $this->mockFlexCustom($io, $composer, $configurator, $downloader, $lock);
+    }
 }