Skip to content

Commit

Permalink
Sort packages with the same weight alphabetically to have a completel…
Browse files Browse the repository at this point in the history
…y stable sort not dependent on input order, fixes #10614
  • Loading branch information
Seldaek committed Mar 15, 2022
1 parent d679532 commit f31700b
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 27 deletions.
2 changes: 1 addition & 1 deletion src/Composer/Autoload/AutoloadGenerator.php
Original file line number Diff line number Diff line change
Expand Up @@ -1379,7 +1379,7 @@ function ($item) use ($include) {
/**
* Sorts packages by dependency weight
*
* Packages of equal weight retain the original order
* Packages of equal weight are sorted alphabetically
*
* @param array<int, array{0: PackageInterface, 1: string}> $packageMap
* @return array<int, array{0: PackageInterface, 1: string}>
Expand Down
37 changes: 12 additions & 25 deletions src/Composer/Util/PackageSorter.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class PackageSorter
/**
* Sorts packages by dependency weight
*
* Packages of equal weight retain the original order
* Packages of equal weight are sorted alphabetically
*
* @param PackageInterface[] $packages
* @return PackageInterface[] sorted array
Expand Down Expand Up @@ -67,39 +67,26 @@ public static function sortPackages(array $packages)
return $weight;
};

$weightList = array();
$weightedPackages = array();

foreach ($packages as $index => $package) {
$weight = $computeImportance($package->getName());
$weightList[$index] = $weight;
$name = $package->getName();
$weight = $computeImportance($name);
$weightedPackages[] = array('name' => $name, 'weight' => $weight, 'index' => $index);
}

$stable_sort = function (&$array) {
static $transform, $restore;

$i = 0;

if (!$transform) {
$transform = function (&$v, $k) use (&$i) {
$v = array($v, ++$i, $k, $v);
};

$restore = function (&$v) {
$v = $v[3];
};
usort($weightedPackages, function ($a, $b) {
if ($a['weight'] !== $b['weight']) {
return $a['weight'] - $b['weight'];
}

array_walk($array, $transform);
asort($array);
array_walk($array, $restore);
};

$stable_sort($weightList);
return strnatcasecmp($a['name'], $b['name']);
});

$sortedPackages = array();

foreach (array_keys($weightList) as $index) {
$sortedPackages[] = $packages[$index];
foreach ($weightedPackages as $pkg) {
$sortedPackages[] = $packages[$pkg['index']];
}

return $sortedPackages;
Expand Down
8 changes: 8 additions & 0 deletions tests/Composer/Test/Autoload/AutoloadGeneratorTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -1017,6 +1017,14 @@ public function testFilesAutoloadOrderByDependencies()
$packages[] = $c = new Package('c/lorem', '1.0', '1.0');
$packages[] = $e = new Package('e/e', '1.0', '1.0');

// expected order:
// c requires nothing
// d requires c
// b requires c & d
// e requires c
// z requires c
// (b, e, z ordered alphabetically)

$z->setAutoload(array('files' => array('testA.php')));
$z->setRequires(array('c/lorem' => new Link('z/foo', 'c/lorem', new MatchAllConstraint())));

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ class ComposerStaticInitFilesAutoloadOrder
public static $files = array (
'bfdd693009729d60c830ff8d79129635' => __DIR__ . '/..' . '/c/lorem/testC.php',
'61e6098c8cafe404d6cf19e59fc2b788' => __DIR__ . '/..' . '/d/d/testD.php',
'8bceec6fdc149a1a6acbf7ad3cfed51c' => __DIR__ . '/..' . '/z/foo/testA.php',
'c5466e580c6c2403f225c43b6a21a96f' => __DIR__ . '/..' . '/b/bar/testB.php',
'69dfc37c40a853a7cbac6c9d2367c5f4' => __DIR__ . '/..' . '/e/e/testE.php',
'8bceec6fdc149a1a6acbf7ad3cfed51c' => __DIR__ . '/..' . '/z/foo/testA.php',
'ab280164f4754f5dfdb0721de84d737f' => __DIR__ . '/../..' . '/root2.php',
);

Expand Down
14 changes: 14 additions & 0 deletions tests/Composer/Test/Util/PackageSorterTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,20 @@ public function sortingOrdersDependenciesHigherThanPackageDataProvider()
'foo/bar6',
),
),
'equal weight sorted alphabetically' => array(
array(
$this->createPackage('foo/bar10', array('foo/dep')),
$this->createPackage('foo/bar2', array('foo/dep')),
$this->createPackage('foo/baz', array('foo/dep')),
$this->createPackage('foo/dep', array()),
),
array(
'foo/dep',
'foo/bar2',
'foo/bar10',
'foo/baz',
),
),
);
}

Expand Down

0 comments on commit f31700b

Please sign in to comment.