LockFileChecker.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Composer;
 
use Composer\Semver\Semver;
use Status;
use Wikimedia\Composer\ComposerJson;
use Wikimedia\Composer\ComposerLock;
 
class LockFileChecker {
    private $composerJson;
 
    private $composerLock;
 
    public function __construct( ComposerJson $composerJson, ComposerLock $composerLock ) {
        $this->composerJson = $composerJson;
        $this->composerLock = $composerLock;
    }
 
    public function check(): Status {
        $status = Status::newGood();
        $requiredButOld = [];
        $requiredButMissing = [];
 
        $installed = $this->composerLock->getInstalledDependencies();
        foreach ( $this->composerJson->getRequiredDependencies() as $name => $version ) {
            // Not installed at all.
            if ( !isset( $installed[$name] ) ) {
                $requiredButMissing[] = [
                    'name' => $name,
                    'wantedVersion' => $version
                ];
                continue;
            }
 
            // Installed; need to check it's the right version
            if ( !SemVer::satisfies( $installed[$name]['version'], $version ) ) {
                $requiredButOld[] = [
                    'name' => $name,
                    'wantedVersion' => $version,
                    'suppliedVersion' => $installed[$name]['version']
                ];
            }
 
            // We're happy; loop to the next dependency.
        }
 
        if ( count( $requiredButOld ) === 0 && count( $requiredButMissing ) === 0 ) {
            // We couldn't find any out-of-date or missing dependencies, so assume everything is ok!
            return $status;
        }
 
        foreach ( $requiredButOld as [
            "name" => $name,
            "suppliedVersion" => $suppliedVersion,
            "wantedVersion" => $wantedVersion
        ] ) {
            $status->error( 'composer-deps-outdated', $name, $suppliedVersion, $wantedVersion );
        }
 
        foreach ( $requiredButMissing as [
            "name" => $name,
            "wantedVersion" => $wantedVersion
        ] ) {
            $status->error( 'composer-deps-notinstalled', $name, $wantedVersion );
        }
 
        return $status;
    }
}