Merge pull request #652 from asgrim/587-install-from-lock

587: add `pie install --from-lock`

Author: asgrim

.github/workflows/continuous-integration.yml

@@ -160,6 +160,7 @@ jobs:
           - '8.2'
           - '8.3'
           - '8.4'
+          - '8.5'
     steps:
       - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 #v6.0.3
         with:

docs/usage.md

@@ -459,6 +459,25 @@ pie install \
 > The `--allow-non-interactive-project-install` will no longer work. You must
 > provide package selections from PIE 1.5 onwards.
 
+## Install extensions from pie.lock
+
+If you have an existing `pie.json` and `pie.lock` for a given PHP install,
+place these files in the directory indicated by the `pie show -v` path for
+`Using pie.json`, e.g.:
+
+```bash
+$ php8.2 /usr/local/bin/pie show -v
+🥧 PHP Installer for Extensions (PIE) 1.5.0, from The PHP Foundation
+You are running PHP 8.2.31
+Target PHP installation: 8.2.31 nts, on Linux/OSX/etc x86_64 (from /usr/bin/php8.2)
+Using pie.json: /home/blah/.config/pie/php8.2_7cfa96d5dfc1df10afeb65851159197b/pie.json
+...
+```
+
+Move your `pie.json` and `pie.lock` into this path, then you can run
+`pie install --from-lock` which will install the locked extension dependencies
+specified in that `pie.lock`.
+
 ## Comparison with PECL
 
 Since PIE is a replacement for PECL, here is a comparison of the commands that

features/install-extensions.feature

@@ -14,3 +14,9 @@ Feature: Extensions can be installed with PIE
   Example: Multiple extensions can be installed at once
     When I run a command to install multiple extensions
     Then the extensions should have been installed and enabled
+
+  # pie install --from-lock
+  Example: I can install exact versions contained in the lockfile
+    Given I have a lock file
+    When I run a command to install from the lockfile
+    Then the extensions should have been updated to the lock

phpunit.xml.dist

@@ -9,6 +9,7 @@
          beStrictAboutOutputDuringTests="true"
          displayDetailsOnSkippedTests="true"
          displayDetailsOnTestsThatTriggerWarnings="true"
+         displayDetailsOnPhpunitDeprecations="true"
          failOnRisky="true"
          failOnWarning="true">
     <php>

src/Command/CommandHelper.php

@@ -395,7 +395,7 @@ static function (RequestedPackageAndVersion $requestedNameAndVersion) use ($depe
     }
 
     /**
-     * @param non-empty-list<Package> $packages
+     * @param list<Package> $packages
      *
      * @throws ConfigureOptionCollision if two of the requested packages declare a configure option with the same name.
      */
@@ -429,7 +429,7 @@ public static function bindConfigureOptionsFromPackage(Command $command, array $
     }
 
     /**
-     * @param non-empty-list<Package> $packages
+     * @param list<Package> $packages
      *
      * @return array<string, list<non-empty-string>> Keyed by package name
      */

src/Command/InstallCommand.php

@@ -5,6 +5,7 @@
 namespace Php\Pie\Command;
 
 use Composer\IO\IOInterface;
+use InvalidArgumentException;
 use Php\Pie\ComposerIntegration\ComposerIntegrationHandler;
 use Php\Pie\ComposerIntegration\ComposerRunFailed;
 use Php\Pie\ComposerIntegration\PieComposerFactory;
@@ -24,6 +25,7 @@
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Throwable;
 
@@ -33,6 +35,8 @@
 )]
 final class InstallCommand extends Command
 {
+    public const OPTION_FROM_LOCK = 'from-lock';
+
     public function __construct(
         private readonly ContainerInterface $container,
         private readonly DependencyResolver $dependencyResolver,
@@ -51,11 +55,31 @@ public function configure(): void
         parent::configure();
 
         CommandHelper::configureDownloadBuildInstallOptions($this);
+
+        $this->addOption(
+            self::OPTION_FROM_LOCK,
+            null,
+            InputOption::VALUE_NONE,
+            'Install the exact versions specified in the pie.lock file for the target PHP.',
+        );
+    }
+
+    public static function shouldInstallFromLock(InputInterface $input): bool
+    {
+        return $input->hasOption(self::OPTION_FROM_LOCK) && (bool) $input->getOption(self::OPTION_FROM_LOCK);
     }
 
     public function execute(InputInterface $input, OutputInterface $output): int
     {
-        if (! $input->getArgument(CommandHelper::ARG_REQUESTED_PACKAGE_AND_VERSION)) {
+        $installFromLock = self::shouldInstallFromLock($input);
+
+        if ($installFromLock && $input->getArgument(CommandHelper::ARG_REQUESTED_PACKAGE_AND_VERSION)) {
+            $this->io->writeError('<error>The --from-lock option installs all extensions from the lock file and cannot be combined with a specific package argument.</error>');
+
+            return self::INVALID;
+        }
+
+        if (! $installFromLock && ! $input->getArgument(CommandHelper::ARG_REQUESTED_PACKAGE_AND_VERSION)) {
             return ($this->invokeSubCommand)(
                 $this,
                 ['command' => 'install-extensions-for-project'],
@@ -78,6 +102,12 @@ public function execute(InputInterface $input, OutputInterface $output): int
                 $targetPlatform,
                 $this->container,
             );
+        } catch (InvalidArgumentException $noPackagesRequested) {
+            if (! $installFromLock) {
+                throw $noPackagesRequested;
+            }
+
+            $requestedNamesAndVersions = [];
         }
 
         $forceInstallPackageVersion = CommandHelper::determineForceInstallingPackageVersion($input);
@@ -122,15 +152,18 @@ public function execute(InputInterface $input, OutputInterface $output): int
             }
         }
 
+        $resolvedPackages = [];
         try {
-            $resolvedPackages = CommandHelper::resolveRequestedPackages(
-                $this->dependencyResolver,
-                $this->io,
-                $composer,
-                $targetPlatform,
-                $requestedNamesAndVersions,
-                $forceInstallPackageVersion,
-            );
+            if ($requestedNamesAndVersions !== []) {
+                $resolvedPackages = CommandHelper::resolveRequestedPackages(
+                    $this->dependencyResolver,
+                    $this->io,
+                    $composer,
+                    $targetPlatform,
+                    $requestedNamesAndVersions,
+                    $forceInstallPackageVersion,
+                );
+            }
         } catch (UnableToResolveRequirement $unableToResolveRequirement) {
             return CommandHelper::handlePackageNotFound(
                 $unableToResolveRequirement,
@@ -161,6 +194,7 @@ public function execute(InputInterface $input, OutputInterface $output): int
                 PieOperation::Install,
                 $configureOptionsValues,
                 CommandHelper::determineAttemptToSetupIniFile($input),
+                installAllPackages: $installFromLock,
             ),
         );
 
@@ -171,6 +205,7 @@ public function execute(InputInterface $input, OutputInterface $output): int
                 $targetPlatform,
                 $forceInstallPackageVersion,
                 true,
+                installFromLock: $installFromLock,
             );
         } catch (ComposerRunFailed $composerRunFailed) {
             $this->io->writeError('<error>' . $composerRunFailed->getMessage() . '</error>');

src/Command/ShowCommand.php

@@ -6,6 +6,7 @@
 
 use Composer\IO\IOInterface;
 use Composer\IO\NullIO;
+use InvalidArgumentException;
 use Php\Pie\ComposerIntegration\PieComposerFactory;
 use Php\Pie\ComposerIntegration\PieComposerRequest;
 use Php\Pie\DependencyResolver\BundledPhpExtensionRefusal;
@@ -26,6 +27,7 @@
 use Webmozart\Assert\Assert;
 
 use function array_diff;
+use function array_key_exists;
 use function array_map;
 use function array_walk;
 use function count;
@@ -115,7 +117,7 @@ function (string $version, string $phpExtensionName) use ($composer, $rootPackag
                 foreach ($pieMatchesForExtension->packages() as $piePackage) {
                     $packageName        = $piePackage->name();
                     $verificationStatus = $piePackage->verifyPackageStatus($targetPlatform);
-                    $packageRequirement = $rootPackageRequires[$packageName]->getPrettyConstraint();
+                    $packageRequirement = array_key_exists($packageName, $rootPackageRequires) ? $rootPackageRequires[$packageName]->getPrettyConstraint() : null;
 
                     if ($verificationStatus === PackageVerificationStatus::InstalledBinaryMetadataMissing) {
                         continue;
@@ -145,7 +147,7 @@ function (string $version, string $phpExtensionName) use ($composer, $rootPackag
                             new RequestedPackageAndVersion($packageName, '*'),
                             false,
                         );
-                    } catch (UnableToResolveRequirement | BundledPhpExtensionRefusal) {
+                    } catch (UnableToResolveRequirement | BundledPhpExtensionRefusal | InvalidArgumentException) {
                         $latestConstrainedPackage = null;
                         $latestPackage            = null;
                     }
@@ -163,6 +165,10 @@ function (string $version, string $phpExtensionName) use ($composer, $rootPackag
                         $updateNotice .= sprintf(', latest version is %s', $latestPackage->piePackage->version());
                     }
 
+                    if (! array_key_exists($packageName, $rootPackageRequires)) {
+                        $verificationStatus = PackageVerificationStatus::InstalledButDoesNotExistInRequires;
+                    }
+
                     $this->io->write(sprintf(
                         '  <info>%s:%s</info> (from 🥧 <info>%s</info> %s)%s',
                         $phpExtensionName,

src/ComposerIntegration/ComposerIntegrationHandler.php

@@ -19,6 +19,7 @@
 use Psr\Container\ContainerInterface;
 
 use function array_map;
+use function array_values;
 use function assert;
 use function file_exists;
 use function sprintf;
@@ -72,6 +73,7 @@ public function runInstall(
         TargetPlatform $targetPlatform,
         bool $forceInstallPackageVersion,
         bool $runCleanup,
+        bool $installFromLock = false,
     ): void {
         $pieComposerJson        = Platform::getPieJsonFilename($targetPlatform);
         $pieJsonEditor          = PieJsonEditor::fromTargetPlatform($targetPlatform);
@@ -90,7 +92,14 @@ public function runInstall(
         // Refresh the Composer instance so it re-reads the updated pie.json
         $composer = PieComposerFactory::recreatePieComposer($this->container, $composer);
 
-        foreach ($composer->getRepositoryManager()->getLocalRepository()->getPackages() as $localRepoPackage) {
+        $resolvedPackageByName = [];
+        foreach ($resolvedRequestedPackages as $resolvedPackageRequest) {
+            $resolvedPackageByName[$resolvedPackageRequest->piePackage->composerPackage()->getName()] = $resolvedPackageRequest->piePackage;
+        }
+
+        $localRepository = $composer->getRepositoryManager()->getLocalRepository();
+
+        foreach ($localRepository->getPackages() as $localRepoPackage) {
             $extName = ExtensionName::determineFromComposerPackage($localRepoPackage);
 
             if ($localRepoPackage instanceof CompleteAliasPackage) {
@@ -110,6 +119,47 @@ public function runInstall(
             ), verbosity: IOInterface::VERY_VERBOSE);
 
             if ($status->isVerified() && ! $forceInstallPackageVersion) {
+                if ($installFromLock) {
+                    $lockedRepo    = $composer->getLocker()->getLockedRepository();
+                    $lockedPackage = $lockedRepo->findPackage($localRepoPackage->getName(), '*');
+
+                    if ($lockedPackage === null) {
+                        // Not in locked repo; Composer will install it anyway
+                        continue;
+                    }
+
+                    if ($lockedPackage->getVersion() !== $localRepoPackage->getVersion()) {
+                        $this->arrayCollectionIo->write(sprintf(
+                            '%s PIE package %s (%s) is at %s but the lock requires %s, scheduling for reinstall.',
+                            Emoji::WARNING,
+                            $localRepoPackage->getName(),
+                            $extName->name(),
+                            $localRepoPackage->getPrettyVersion(),
+                            $lockedPackage->getPrettyVersion(),
+                        ));
+
+                        // Locked, but the version we installed is different
+                        $localRepository->removePackage($localRepoPackage);
+                        continue;
+                    }
+                } else {
+                    $resolvedPackage = $resolvedPackageByName[$localRepoPackage->getName()] ?? null;
+                    if ($resolvedPackage !== null && $resolvedPackage->composerPackage()->getVersion() !== $localRepoPackage->getVersion()) {
+                        $this->arrayCollectionIo->write(sprintf(
+                            '%s PIE package %s (%s) is at %s but %s was installed, adding to install candidates.',
+                            Emoji::WARNING,
+                            $localRepoPackage->getName(),
+                            $extName->name(),
+                            $localRepoPackage->getPrettyVersion(),
+                            $resolvedPackage->composerPackage()->getPrettyVersion(),
+                        ));
+
+                        // Resolved a different version than what's installed
+                        $localRepository->removePackage($localRepoPackage);
+                        continue;
+                    }
+                }
+
                 $this->arrayCollectionIo->write(sprintf(
                     '%s PIE package %s (%s) is already installed and verified.',
                     Emoji::GREEN_CHECKMARK,
@@ -144,12 +194,16 @@ public function runInstall(
                 $extName->name(),
                 $status->description(),
             ));
-            $composer->getRepositoryManager()->getLocalRepository()->removePackage($localRepoPackage);
+            $localRepository->removePackage($localRepoPackage);
         }
 
+        $extensionNames = $installFromLock
+            ? array_values(array_map(ExtensionName::determineFromComposerPackage(...), $composer->getLocker()->getLockedRepository()->getPackages()))
+            : ResolvedPackageRequest::extensionNames($resolvedRequestedPackages);
+
         $composerInstaller = PieComposerInstaller::createWithPhpBinary(
             $targetPlatform->phpBinaryPath,
-            ResolvedPackageRequest::extensionNames($resolvedRequestedPackages),
+            $extensionNames,
             $this->arrayCollectionIo,
             $composer,
         );
@@ -161,7 +215,7 @@ public function runInstall(
             ->setPlatformRequirementFilter(PlatformRequirementFilterFactory::fromBoolOrList($forceInstallPackageVersion))
             ->setDownloadOnly(false);
 
-        if (file_exists(PieComposerFactory::getLockFile($pieComposerJson))) {
+        if (! $installFromLock && file_exists(PieComposerFactory::getLockFile($pieComposerJson))) {
             $composerInstaller->setUpdate(true);
             $composerInstaller->setUpdateAllowList(ResolvedPackageRequest::requestedPackageNames($resolvedRequestedPackages));
         }

src/ComposerIntegration/PieComposerRequest.php

@@ -32,6 +32,7 @@ public function __construct(
         public readonly PieOperation $operation,
         public readonly array $configureOptions,
         public readonly bool $attemptToSetupIniFile,
+        public readonly bool $installAllPackages = false,
     ) {
         $this->requestedPackageNames = array_map(static fn (RequestedPackageAndVersion $request) => $request->package, $this->requestedPackages);
     }
@@ -62,6 +63,10 @@ public static function noOperation(
 
     public function isFor(string $packageName): bool
     {
+        if ($this->installAllPackages) {
+            return true;
+        }
+
         return in_array($packageName, $this->requestedPackageNames);
     }
 }

src/ComposerIntegration/UninstallProcess.php

@@ -36,7 +36,11 @@ public function __invoke(
         $status = $piePackage->verifyPackageStatus($composerRequest->targetPlatform);
 
         if ($status->isVerified()) {
-            $io->write(sprintf('👋 <info>Removed extension:</info> %s', ($this->uninstall)($targetPlatform, $piePackage)->filePath));
+            $io->write(sprintf(
+                '👋 <info>Removed extension %s:</info> %s',
+                $piePackage->prettyNameAndVersion(),
+                ($this->uninstall)($targetPlatform, $piePackage)->filePath,
+            ));
         } else {
             $io->writeError(sprintf('<warning>Did not remove extension file:</warning> %s', $status->description()));
         }