Composer.php

<?php

namespace Castor\Remote;

use Castor\PathHelper;
use Castor\Remote\Exception\ComposerError;
use Psr\Log\LoggerInterface;
use Symfony\Component\Process\Process;

class Composer
{
    public const VENDOR_DIR = '/.castor/vendor/';
    public const PATH_CASTOR_REQUIREMENTS = self::VENDOR_DIR . 'castor-requirements.json';

    public function __construct(
        private readonly LoggerInterface $logger,
    ) {
    }

    /**
     * @return array<string, mixed>
     */
    public function getConfiguration(): array
    {
        return $this->readJsonFile(PathHelper::getRoot() . self::VENDOR_DIR . 'composer.json');
    }

    /**
     * @param array<string, mixed> $configuration
     */
    public function setConfiguration(array $configuration): void
    {
        $this->logger->debug('Updating Composer configuration.', [
            'configuration' => $configuration,
        ]);

        $dir = PathHelper::getRoot() . self::VENDOR_DIR;

        if (!is_dir($dir)) {
            mkdir($dir, recursive: true);
        }

        file_put_contents($dir . '.gitignore', "*\n");

        $this->writeJsonFile($dir . 'composer.json', $configuration);
    }

    public function require(string $package, string $version): void
    {
        $requirements = $this->readJsonFile(PathHelper::getRoot() . self::PATH_CASTOR_REQUIREMENTS);

        if (isset($requirements[$package]) && $requirements[$package] === $version) {
            $this->logger->debug('The package is already required, no need to run Composer.', [
                'package' => $package,
                'version' => $version,
            ]);

            return;
        }

        if (isset($requirements[$package]) && $version !== $requirements[$package]) {
            $this->logger->debug('The package is already required but in another version, let\'s empty requirements cache to force Composer re-installation of every package.', [
                'package' => $package,
                'version' => $version,
            ]);
            $requirements = [];
        }

        $this->run('require', $package . ':' . $version);

        $requirements[$package] = $version;

        $this->writeJsonFile(PathHelper::getRoot() . self::PATH_CASTOR_REQUIREMENTS, $requirements);
    }

    private function run(string ...$args): void
    {
        $this->logger->debug('Running Composer command.', [
            'args' => implode(' ', $args),
        ]);

        $dir = PathHelper::getRoot() . self::VENDOR_DIR;

        $process = new Process(['composer', ...$args, '--working-dir', $dir]);
        $process->setEnv([
            'COMPOSER_VENDOR_DIR' => $dir,
        ]);
        $process->run();

        if (!$process->isSuccessful()) {
            throw new ComposerError('The Composer process failed: ' . $process->getErrorOutput());
        }

        $this->logger->debug('Composer command was successful.', [
            'args' => implode(' ', $args),
            'output' => $process->getOutput(),
        ]);
    }

    /**
     * @return array<string, mixed>
     */
    private function readJsonFile(string $path): array
    {
        if (!file_exists($path)) {
            return [];
        }

        $json = file_get_contents($path);

        if (!$json) {
            return [];
        }

        return json_decode($json, true, flags: \JSON_THROW_ON_ERROR);
    }

    /**
     * @param array<string, mixed> $json
     */
    private function writeJsonFile(string $path, array $json): void
    {
        file_put_contents($path, json_encode($json, \JSON_PRETTY_PRINT | \JSON_THROW_ON_ERROR));
    }
}