Unable to retrieve the good alias for PHP_CodeSniffer package by API

[llaville]

Hello @theseer

Perharps you can help me to confirm or not that the Phive API calls are on right sequence !

Hope it will be enough ? Tell me if you need more info !

Current Context

As author of package https://github.com/llaville/captainhook-bin-plugin (a CaptainHook Plugin), before to release officially the first version on Composer, I wanted to add support for PHIVE too !

Actually if a Composer package is not installed the action is skipped by my plugin (auto-detection).
I wanted to have the same feature with PHIVE.

I've tried many solutions, and found a possible good one, but I'm not sure (if I used the good API calls): Could you check the sequence please ?

Source Code is provide at end of report.

Expected behaviour

Package is auto-detected (see my solution at end of this report with source code provided), respect version constraint, and command ./tools/phpcs is run !

Note

PHP_CodeSniffer is well detected and run as expected (I've put a var_dump not well indented that raise the error)

Current behaviour

Without my "patch", the Package is not detected as installed (even if it's TRUE : see phive status), and action is skipped (my plugin goal).

Caution

PHP_CodeSniffer is not detected because the first alias retrieved by \PharIo\Phive\SourcesList::getAliasForComposerAlias is phpcbf (and not phpcs)
See https://github.com/phar-io/phive/blob/0.16.0/src/shared/sources/SourcesList.php#L66 only the first alias as provided

PHIVE installation

I've locally installed the PHP_CodeSniffer as follow :

phive install --target ./tools phpcs@^4.0

The local .phive/phars.xml file contents is :

<?xml version="1.0" encoding="UTF-8"?>
<phive xmlns="https://phar.io/phive">
  <phar name="phpcs" version="^4.0" installed="4.0.1" location="././tools/phpcs" copy="false"/>
</phive>

Important

Here the alias (phpcs) is the one that expected !

Confirmed by phive status command :

Phive 0.16.0 - Copyright (C) 2015-2026 by Arne Blankerts, Sebastian Heuer and Contributors
PHARs configured in project:

Alias/URL    Version Constraint    Installed    Location                                                       Key Ids

phpcs        ^4.0                  4.0.1        /shared/backups/bartlett/captainhook-bin-plugin/tools/phpcs    97B02DD8E5071466

Source Code

Now, after a long introduction (sorry, but I want to be clear as much as possible), the code (PHIVE API calls , I used to auto-detect that the tool is correctly installed).

As for Composer Condition the key to check is the package identifier. For example : squizlabs/php_codesniffer for PHPCS

Tip

My Solution to by-pass the not found alias name candidate :

      if (in_array('phpcbf', $aliases, true)) {
           // "squizlabs/php_codesniffer" is the only Composer package that provide two aliases (for current Phive v0.16)
           // but only the first one is retrieved by \PharIo\Phive\SourcesList::getAliasForComposerAlias
           // @see https://github.com/phar-io/phive/blob/0.16.0/src/shared/sources/SourcesList.php#L66
           $aliases[] = 'phpcs';
       }

Source Code

<?php

declare(strict_types=1);


namespace Bartlett\CaptainHookBinPlugin\Condition;

use CaptainHook\App\Console\IO;
use CaptainHook\App\Hook\Condition;
use Composer\InstalledVersions;
use Composer\Semver\Semver;
use PharIo\Phive\Cli\Request;
use PharIo\Phive\ComposerAlias;
use PharIo\Phive\EnvironmentLocator;
use PharIo\Phive\Factory;
use PharIo\Phive\LocalPhiveXmlConfig;
use PharIo\Phive\PhiveXmlConfigFileLocator;
use PharIo\Phive\StatusCommandConfig;
use PharIo\Phive\XmlFile;
use PharIo\Version\VersionConstraintParser;
use SebastianFeldmann\Git\Repository;
use Throwable;
use function in_array;
use const PHP_OS;

class PharInstalled implements Condition
{
    public function __construct(private string $packageName, private string $constraint = '*')
    {
    }

    public function isTrue(IO $io, Repository $repository): bool
    {
        $isPhiveAvailable = InstalledVersions::isInstalled('phar-io/phive');

        if (!$isPhiveAvailable) {
            $io->write(
                '  <fg=cyan>Applied: PHIVE is not installed</>',
                true,
                IO::VERBOSE,
            );
            return false;
        }

        $request = new Request([]);

        $factory = new Factory($request);

        // \PharIo\Phive\Factory::getEnvironment
        $environment = (new EnvironmentLocator())->getEnvironment(PHP_OS);

        // \PharIo\Phive\Factory::getConfig
        $config = $factory->getConfig();

        // \PharIo\Phive\Factory::getOutput
        $output = $factory->getOutput();

        // \PharIo\Phive\Factory::getPhiveXmlConfigFileLocator
        $xmlConfigFileLocator = new PhiveXmlConfigFileLocator(
            $environment,
            $config,
            $output
        );

        $xmlConfig = new LocalPhiveXmlConfig(
            new XmlFile(
                $xmlConfigFileLocator->getFile(),
                'https://phar.io/phive',
                'phive'
            ),
            new VersionConstraintParser(),
            $environment
        );

        $pharRegistry = $factory->getPharRegistry();

        $statusCommandConfig = new StatusCommandConfig(
            $request->getOptions(),
            $xmlConfig,
            $pharRegistry
        );

        // \PharIo\Phive\Factory::getSourcesList
        $sourcesList = $factory->getRemoteSourcesListFileLoader()->load();

        $isApplied = false;
        $aliases = [];

        try {
            $aliases[] = $sourcesList->getAliasForComposerAlias(new ComposerAlias($this->packageName));

            if (in_array('phpcbf', $aliases, true)) {
                // "squizlabs/php_codesniffer" is the only Composer package that provide two aliases (for current Phive v0.16)
                // but only the first one is retrieved by \PharIo\Phive\SourcesList::getAliasForComposerAlias
                // @see https://github.com/phar-io/phive/blob/0.16.0/src/shared/sources/SourcesList.php#L66
                //$aliases[] = 'phpcs';
            }

            foreach ($statusCommandConfig->getPhars() as $phar) {
                if (!in_array($phar->getName(), $aliases, true)) {
                    continue;
                }
                if (!$phar->isInstalled()) {
                    continue;
                }
                $versionInstalled = $phar->getInstalledVersion();
           \var_dump($versionInstalled->getOriginalString(), $phar->getVersionConstraint()->asString());
                $isApplied = Semver::satisfies($versionInstalled->getOriginalString(), $phar->getVersionConstraint()->asString());
                if ($isApplied) {
                    break;
                }
            }
        } catch (Throwable $exception) {
        }

        $io->write(
            sprintf(
                '  <fg=cyan>Applied: Package %s</> %s (with constraint "%s")',
                $isApplied ? 'installed' : 'not installed',
                $this->packageName,
                $this->constraint
            ),
            true,
            IO::VERBOSE,
        );

        return $isApplied;
    }
}

[llaville]

PHP_CodeSniffer is the only one (currently) that have more than 1 alias.

Confirmed by yq command :

yq -oy '.[] | .phar[].+@composer' ~/.phive/repositories.xml | sort | uniq -c

      1 aeliot/php-cs-fixer-baseline
      1 aeliot/todo-registrar
      1 bmitch/churn-php
      1 brianium/paratest
      1 buggregator/trap
      1 captainhook/captainhook
      1 cecil/cecil
      1 code-lts/doctum
      1 composer/composer
      1 composer-unused/composer-unused
      1 dbrekelmans/browser-driver-installer
      1 dephpend/dephpend
      1 deployer/deployer
      1 deptrac/deptrac
      1 dzentota/regression
      1 eliashaeussler/cache-warmup
      1 ergebnis/composer-normalize
      1 esi/phpunit-coverage-check
      1 flavioheleno/watchr
      1 flow-php/flow
      1 friendsofphp/php-cs-fixer
      1 humbug/box
      1 humbug/php-scoper
      1 infection/infection
      1 j13k/yaml-lint
      1 jpuck/carbon-console
      1 ktomk/pipelines
      1 maglnet/composer-require-checker
      1 mwender/sshman
      1 n98/magerun
      1 n98/magerun2
      1 ngabor84/clapi
      1 ngabor84/ecc
      1 nielsdeblaauw/php-doc-check
      1 pdepend/pdepend
      1 phan/phan
      1 phing/phing
      1 phparkitect/phparkitect
      1 phpbench/phpbench
      1 phpbu/phpbu
      1 php-coveralls/php-coveralls
      1 phpdocumentor/phpdocumentor
      1 phploc/phploc
      1 phpmd/phpmd
      1 phpro/grumphp
      1 phpstan/phpstan
      1 phpunit/phpcov
      1 phpunit/phpunit
      1 phuml/phuml
      1 rtckit/eqivo
      1 sebastian/phpcpd
      1 shopwarelabs/sw-cli-tools
      1 shopware/psh
      2 squizlabs/php_codesniffer
      1 theseer/autoload
      1 theseer/phpdox
      1 vimeo/psalm
      1 vincentlanglet/twig-cs-fixer
      1 wp-cli/wp-cli
      1 wsdltophp/packagegenerator

[theseer]

Interesting problem - and I'm not sure we can fix it given the mapping logic from composer alias to phar within PHIVE makes the assumption that it's a 1:1 pair.

That behavior can be confirmed by calling phive install squizlabs/php_codesniffer, which will only ever install phpcs.
The installation instructions for phpcs and phpcbf when using PHIVE thus also explicitly use the phive alias.

The composer alias handling was intended as a convenience feature in case no phive alias exists. I'm not sure if it would be expected behavior for PHIVE to install two phars when the composer alias in theory resolves to two?

[llaville]

So, I consider that my solution is a good compromise, isn't it ?

[theseer]

I'm not sure if I like the fact you had to hardcode it, but i right now can't come up with a better solution either :)

[llaville]

@theseer FYI : I've pushed today a llaville/captainhook-bin-plugin@aefa09f commit that support officially PHIVE on my plugin.

I'll let choose if you want to keep this report opened or not.