Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding warning when inexact version constraints are used. #88

Closed
wants to merge 4 commits into from
Closed

Adding warning when inexact version constraints are used. #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c6bbf5b
Adding warning when inexact version constraints are used.
grasmash Dec 6, 2016
6baa0e9
Fixing version constraint check.
grasmash Dec 6, 2016
d6a9013
Removing duplicate warnings.
grasmash Dec 6, 2016
3d538c1
Displaying warning only when inexact-constraint-warning is true.
grasmash Dec 6, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,18 @@ Composer [blocks](https://getcomposer.org/doc/06-config.md#secure-http) you from

However, it's always advised to setup HTTPS to prevent MITM code injection.

## Version constraints

Typically, Composer best practices dictate that exact versions (e.g., 8.1.1) be avoided. However, using an inexact version constraint (e.g., ^8.1) can cause patching failures when the upstream package is updated. You may optionally display a warning regarding the use of inexact version constraints by using the following configuration in composer.json:

```
"extra": {
"inexact-constraint-warning": true
}
```

This will be displayed during `composer update`.

## Error handling

If a patch cannot be applied (hunk failed, different line endings, etc.) a message will be shown and the patch will be skipped.
Expand Down
32 changes: 32 additions & 0 deletions src/Patches.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,14 @@
use Composer\EventDispatcher\EventSubscriberInterface;
use Composer\IO\IOInterface;
use Composer\Package\AliasPackage;
use Composer\Package\Package;
use Composer\Package\PackageInterface;
use Composer\Plugin\PluginInterface;
use Composer\Installer\PackageEvents;
use Composer\Script\Event;
use Composer\Script\ScriptEvents;
use Composer\Installer\PackageEvent;
use Composer\Semver\Constraint\MultiConstraint;
use Composer\Util\ProcessExecutor;
use Composer\Util\RemoteFilesystem;
use Symfony\Component\Process\Process;
Expand Down Expand Up @@ -272,6 +274,11 @@ public function postInstall(PackageEvent $event) {
}
$this->io->write(' - Applying patches for <info>' . $package_name . '</info>');

$extra = $this->composer->getPackage()->getExtra();
if (!empty($extra['inexact-constraint-warning'])) {
$this->displayConstraintWarning($package);
}

// Get the install path from the package object.
$manager = $event->getComposer()->getInstallationManager();
$install_path = $manager->getInstaller($package->getType())->getInstallPath($package);
Expand All @@ -287,6 +294,7 @@ public function postInstall(PackageEvent $event) {

foreach ($this->patches[$package_name] as $description => $url) {
$this->io->write(' <info>' . $url . '</info> (<comment>' . $description. '</comment>)');

try {
$this->eventDispatcher->dispatch(NULL, new PatchEvent(PatchEvents::PRE_PATCH_APPLY, $package, $url, $description));
$this->getAndApplyPatch($downloader, $install_path, $url);
Expand All @@ -306,6 +314,30 @@ public function postInstall(PackageEvent $event) {
$this->writePatchReport($this->patches[$package_name], $install_path);
}

/**
* Displays a warning if the package's version constraint is inexact.
*
* @param Composer\Package $package
* The package for which to display the warning.
*/
protected function displayConstraintWarning($package) {
// Gather all packages defined in root composer.json into a single array for version constraint access.
$root_requires = $this->composer->getPackage()->getRequires();
$root_dev_requires = $this->composer->getPackage()->getDevRequires();
$root_packages = array_merge($root_requires, $root_dev_requires);
$package_name = $package->getName();

if (!empty($root_packages[$package_name])) {
// If ^, ~, or * operators are being used, or this is a dev version without a hash specified, display warning.
/** @var MultiConstraint $link */
$link = $root_packages[$package_name]->getConstraint();
$version_constraint = $link->getPrettyString();
if (preg_match('/[\^~*]|(-dev)|(dev-)/', $version_constraint) && !strstr($version_constraint, '#')) {
$this->io->write(" <comment>$package_name has inexact version constraint. This may cause a patch failure now or in the future when the package is changed.</comment>");
}
}
}

/**
* Get a Package object from an OperationInterface object.
*
Expand Down