Refactor the code that matches loaded package data to the ones installed to fix incompat between composer 1/2.

Make it much more sane and cleaner at the same time.

Author: pinkeen

docs/testing.md

@@ -44,9 +44,12 @@ _String that will be appended to every invocation of composer command._
 > **Warning!** Arguments passed through env vars must must be space-delimited
 > and each argument cannot contain space characters even if they are escaped.
 
-
 #### `COMPOSER_SANDBOX_TEST_DEBUG` - Enable extra debugging features
 
 If enabled sandbox directories of failed tests are preserved and composer
 command output is flushed for every test.
-   
+
+#### `COMPOSER_SANDBOX_DISABLE_CLEANUP` - Preserve sandbox temp dirs
+
+Do not remove the directory after running a test.
+  

src/PackageApplicationRepository.php

@@ -6,6 +6,10 @@
 use Composer\Package\AliasPackage;
 use Composer\Package\PackageInterface;
 use Composer\Repository\RepositoryInterface;
+use Composer\Package\Dumper\ArrayDumper;
+use Composer\Package\Loader\ArrayLoader;
+use Composer\Json\JsonFile;
+use Composer\Semver\Semver;
 use Psr\Log\LoggerInterface;
 
 class PackageApplicationRepository
@@ -30,6 +34,16 @@ class PackageApplicationRepository
      */
     private $logger;
 
+    /**
+     * @var ArrayDumper
+     */
+    private $packageDumper;
+
+    /**
+     * @var ArrayLoader
+     */
+    private $packageLoader;
+
     /**
      * @param RepositoryInterface $installedRepository
      * @param InstallationManager $installationManager
@@ -46,6 +60,9 @@ public function __construct(
         $this->installationManager = $installationManager;
         $this->pathResolver = $pathResolver;
         $this->logger = $logger;
+
+        $this->packageDumper = new ArrayDumper();
+        $this->packageLoader = new ArrayLoader();
     }
 
     /**
@@ -81,7 +98,7 @@ public function getPackageApplication(PackageInterface $targetPackage)
         }
 
         if (!is_readable($dataFile)) {
-            throw new \RuntimeException('Cannot read applied patches data file "%s"', $dataFile);
+            throw new \RuntimeException('Cannot Loaded applied patches data file "%s"', $dataFile);
         }
 
         $data = json_decode(file_get_contents($dataFile), true);
@@ -126,46 +143,104 @@ private function encodeData(array $data)
      * @param array $data
      * @return PackagePatchApplication
      */
-    private function createPackagePatchApplication(PackageInterface $targetPackage, array $data)
+    private function createPackagePatchApplication($targetPackage, array $data)
     {
-        return new PackagePatchApplication($targetPackage,
-            array_map([$this, 'createPatchApplication'], $data['patches'])
-        );
+        return new PackagePatchApplication($targetPackage, array_map(
+            function($patchData) use ($targetPackage) {
+                return $this->createPatchApplication($targetPackage, $patchData);
+            }, 
+            $data['patches']
+        ));
+    }
+
+    /**
+     * @param PackageInterface|null $loadedPackage
+     * @param string $versionConstraint
+     * @return PackageInterface|null
+     */
+    private function matchLoadedPackageToInstalled($loadedPackage, $versionConstraint = null)
+    {
+        if ($package = $this->installedRepository->findPackage($loadedPackage->getName(), $loadedPackage->getVersion())) {
+            return $package;
+        }
+        
+        if ($loadedPackage->getPrettyVersion() 
+            && $package = $this->installedRepository->findPackage($loadedPackage->getName(), $loadedPackage->getPrettyVersion())) {
+            return $package;
+        }
+
+        if ($loadedPackage->getFullPrettyVersion()
+            && $package = $this->installedRepository->findPackage($loadedPackage->getName(), $loadedPackage->getFullPrettyVersion())) {
+            return $package;
+        }
+
+        if ($versionConstraint && $package = $this->installedRepository->findPackage($loadedPackage->getName(), $versionConstraint)) {
+            return $package;
+        }
+
+        return null;
+    }
+
+    /**
+     * @param PackageInterface $targetPackageInstalled
+     * @param PackageInterface $targetPackageLoaded
+     * @param Patch $patchLoaded
+     * @return PackageInterface|null
+     */
+    private function matchTargetLoadedPackageToInstalled($targetPackageInstalled, $targetPackageLoaded, $patchLoaded)
+    {
+        if ($targetPackageInstalled->getName() === $targetPackageLoaded->getName()) {
+            if ($targetPackageInstalled->getVersion() === $targetPackageLoaded->getVersion()) {
+                return $targetPackageInstalled;
+            }
+
+            if ($targetPackageInstalled->getPrettyVersion() === $targetPackageLoaded->getPrettyVersion()) {
+                return $targetPackageInstalled;
+            }
+
+            if ($patchLoaded->getVersionConstraint() && Semver::satisfies($targetPackageInstalled->getVersion(), $patchLoaded->getVersionConstraint())) {
+                return $targetPackageInstalled;
+            }
+
+            $this->logger->warning(sprintf(
+                'Could not find find installed package (%s) matching version (%s) loaded loaded from applied patch.' .
+                'Name and location checks out, but it might indicate a potential problem. Continuing...',
+                $targetPackageInstalled->getPrettyName(),
+                $targetPackageLoaded->getPrettyName()
+            ));
+        }
+
+        return $this->matchLoadedPackageToInstalled($targetPackageLoaded, $patchLoaded->getVersionConstraint());
     }
 
     /**
+     * @param PackageInterface $targetPackage
      * @param array $data
      * @return PatchApplication
      */
-    private function createPatchApplication(array $data)
+    private function createPatchApplication($targetPackage, array $data)
     {
         $patch = Patch::createFromArray($data['patch']);
 
-        $sourcePackage = $this->installedRepository->findPackage(
-            $data['source_package']['name'],
-            $data['source_package']['version']
-        );
+        $sourcePackageLoaded = $this->loadPackageFromArray($data['source_package']);
+        $targetPackageLoaded = $this->loadPackageFromArray($data['target_package']);
 
-        if (!$sourcePackage) {
-            $this->logger->debug(sprintf('Could not find source package %s (%s) for installed patch, it was removed probably',
-                $data['source_package']['name'],
-                $data['source_package']['version']
+        if (!$sourcePackageInstalled = $this->matchLoadedPackageToInstalled($sourcePackageLoaded)) {
+            $this->logger->debug(sprintf(
+                'Could not find source package %s for installed patch, it was removed probably',
+                $sourcePackageLoaded->getPrettyName()
             ));
         }
 
-        $targetPackage = $this->installedRepository->findPackage(
-            $data['target_package']['name'],
-            $data['target_package']['version']
-        );
 
-        if (!$targetPackage) {
-            throw new \RuntimeException(sprintf('Could not find target package %s (%s) for installed patch',
-                $data['target_package']['name'],
-                $data['target_package']['version']
+        if (!$targetPackageInstalled = $this->matchTargetLoadedPackageToInstalled($targetPackage, $targetPackageLoaded, $patch)) {
+            throw new \LogicException(sprintf(
+                'Could not find target package %s for installed patch. This should not happen.',
+                $targetPackageLoaded->getPrettyName()
             ));
         }
 
-        return new PatchApplication($patch, $sourcePackage, $targetPackage, $data['hash']);
+        return new PatchApplication($patch, $sourcePackageInstalled, $targetPackageInstalled, $data['hash']);
     }
 
     /**
@@ -183,6 +258,24 @@ public function transformPackagePatchApplicationToArray(PackagePatchApplication
         ];
     }
 
+    /**
+     * @param PackageInterface $package
+     * @return array
+     */
+    public function dumpPackageToArray($package) 
+    {
+        return $this->packageDumper->dump($package);
+    }
+
+    /**
+     * @param array $packageData
+     * @return PackageInterface
+     */
+    public function loadPackageFromArray($packageData) 
+    {
+        return $this->packageLoader->load($packageData);
+    }
+
     /**
      * @param PatchApplication $application
      * @return array
@@ -191,16 +284,8 @@ public function transformPatchApplicationToArray(PatchApplication $application)
     {
         return [
             'hash' => $application->getHash(),
-            'target_package' => [
-                'name' => $application->getTargetPackage()->getName(),
-                'version' => $application->getTargetPackage()->getVersion(),
-                'ref' => $application->getTargetPackage()->getSourceReference(),
-            ],
-            'source_package' => [
-                'name' => $application->getSourcePackage()->getName(),
-                'version' => $application->getSourcePackage()->getVersion(),
-                'ref' => $application->getSourcePackage()->getSourceReference(),
-            ],
+            'target_package' => $this->dumpPackageToArray($application->getTargetPackage()),
+            'source_package' => $this->dumpPackageToArray($application->getSourcePackage()),
             'patch' => $application->getPatch()->toArray()
         ];
     }

src/PathResolver.php

@@ -8,7 +8,8 @@
 
 class PathResolver
 {
-    const PATCH_APPLICATION_DATA_FILENAME = 'composer.patches_applied.json';
+    const PATCH_APPLICATION_DATA_FILENAME = 'patches-applied.json';
+    const PATCH_APPLICATION_DATA_LEGACY_FILENAME = 'composer.patches_applied.json';
 
     /**
      * @var InstallationManager

tests/fixtures/packages/package-a/composer.json

@@ -1,6 +1,6 @@
 {
     "name": "test/package-a",
     "type": "library",
-    "version": "dev-master",
+    "version": "1.0.0-dev",
     "require": {}
 }

tests/sandbox/ComposerProjectSandbox.php

@@ -145,8 +145,6 @@ private function writeComposerJson()
 
         $config = array_merge($config, $this->config);
 
-        var_dump(($this->config));
-
         file_put_contents($this->getConfigPath(), json_encode($config, JSON_PRETTY_PRINT + JSON_UNESCAPED_SLASHES + JSON_UNESCAPED_UNICODE));
     }
 

tests/sandbox/ComposerSandbox.php

@@ -237,6 +237,10 @@ public function __construct(
             $this->phpBinary = $phpBinary;
         }
 
+        if (getenv('COMPOSER_SANDBOX_DISABLE_CLEANUP')) {
+            $this->disableCleanup();
+        }
+
         if (null === $selfPackageDir) {
             $selfPackageDir = static::getRootProjectDir();
         }
@@ -270,11 +274,6 @@ public function __construct(
      */
     public function disableCleanup()
     {
-        $this->io->write(sprintf(
-            "   ---> Cleanup is disabled, keeping output buffer and root dir: <info>%s</info>", 
-            $this->rootDir
-        ));
-
         $this->cleanupDisabled = true;
     }
 
@@ -561,6 +560,11 @@ public function cleanupProjects()
     public function cleanup()
     {
         if ($this->cleanupDisabled) {
+            $this->io->write(sprintf(
+                "   ---> Ignoring cleanup - keeping output buffer and root dir: <info>%s</info>", 
+                $this->rootDir
+            ));
+
             return;
         }
 

tests/sandbox/ComposerSandboxTestCase.php

@@ -76,13 +76,10 @@ protected function createComposerSandbox()
             ComposerSandbox::enableDebugOutput();
         }
 
-        $sb = new ComposerSandbox(
+        return new ComposerSandbox(
             $this->getComposerSandboxFixturesDir(),
             $this->getComposerSandboxIdentifier()            
         );
-        $sb->disableCleanup();
-
-        return $sb;
     }
 
     /**