Skip to content

Commit bb7b621

Browse files
codedmonkeycodedmonkey
committed
Create generalized package link entities
1 parent 155d72b commit bb7b621

File tree

8 files changed

+252
-1
lines changed

8 files changed

+252
-1
lines changed

‎migrations/Version20250606221557.php‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace DoctrineMigrations;
6+
7+
use Doctrine\DBAL\Schema\Schema;
8+
use Doctrine\Migrations\AbstractMigration;
9+
10+
final class Version20250606221557 extends AbstractMigration
11+
{
12+
public function getDescription(): string
13+
{
14+
return 'Add generalized package link tables';
15+
}
16+
17+
public function up(Schema $schema): void
18+
{
19+
$this->addSql(<<<'SQL'
20+
CREATE TABLE package_provide_link (linked_package_name VARCHAR(191) NOT NULL, implementation BOOLEAN NOT NULL, package_id INT NOT NULL, PRIMARY KEY(linked_package_name, package_id, implementation))
21+
SQL);
22+
$this->addSql(<<<'SQL'
23+
CREATE INDEX IDX_BB570504F44CABFF ON package_provide_link (package_id)
24+
SQL);
25+
$this->addSql(<<<'SQL'
26+
CREATE TABLE package_require_link (linked_package_name VARCHAR(191) NOT NULL, dev_dependency BOOLEAN NOT NULL, package_id INT NOT NULL, PRIMARY KEY(linked_package_name, package_id, dev_dependency))
27+
SQL);
28+
$this->addSql(<<<'SQL'
29+
CREATE INDEX IDX_D4456EB9F44CABFF ON package_require_link (package_id)
30+
SQL);
31+
$this->addSql(<<<'SQL'
32+
CREATE TABLE package_suggest_link (linked_package_name VARCHAR(191) NOT NULL, package_id INT NOT NULL, PRIMARY KEY(linked_package_name, package_id))
33+
SQL);
34+
$this->addSql(<<<'SQL'
35+
CREATE INDEX IDX_70C2B280F44CABFF ON package_suggest_link (package_id)
36+
SQL);
37+
$this->addSql(<<<'SQL'
38+
ALTER TABLE package_provide_link ADD CONSTRAINT FK_BB570504F44CABFF FOREIGN KEY (package_id) REFERENCES package (id) NOT DEFERRABLE INITIALLY IMMEDIATE
39+
SQL);
40+
$this->addSql(<<<'SQL'
41+
ALTER TABLE package_require_link ADD CONSTRAINT FK_D4456EB9F44CABFF FOREIGN KEY (package_id) REFERENCES package (id) NOT DEFERRABLE INITIALLY IMMEDIATE
42+
SQL);
43+
$this->addSql(<<<'SQL'
44+
ALTER TABLE package_suggest_link ADD CONSTRAINT FK_70C2B280F44CABFF FOREIGN KEY (package_id) REFERENCES package (id) NOT DEFERRABLE INITIALLY IMMEDIATE
45+
SQL);
46+
}
47+
48+
public function down(Schema $schema): void
49+
{
50+
$this->addSql(<<<'SQL'
51+
ALTER TABLE package_provide_link DROP CONSTRAINT FK_BB570504F44CABFF
52+
SQL);
53+
$this->addSql(<<<'SQL'
54+
ALTER TABLE package_require_link DROP CONSTRAINT FK_D4456EB9F44CABFF
55+
SQL);
56+
$this->addSql(<<<'SQL'
57+
ALTER TABLE package_suggest_link DROP CONSTRAINT FK_70C2B280F44CABFF
58+
SQL);
59+
$this->addSql(<<<'SQL'
60+
DROP TABLE package_provide_link
61+
SQL);
62+
$this->addSql(<<<'SQL'
63+
DROP TABLE package_require_link
64+
SQL);
65+
$this->addSql(<<<'SQL'
66+
DROP TABLE package_suggest_link
67+
SQL);
68+
}
69+
}

‎phpstan.dist.neon‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ parameters:
1010
excludePaths:
1111
- tests/bootstrap.php
1212
ignoreErrors:
13+
- '#CodedMonkey\\Dirigent\\Doctrine\\Entity\\AbstractPackageLink given\.#'
14+
- '#^PHPDoc tag @var with type CodedMonkey\\Dirigent\\Doctrine\\Entity\\AbstractPackageLink is not subtype of native type#'
1315
- '#^Property CodedMonkey\\Dirigent\\Doctrine\\Entity\\[a-zA-Z]+\:\:\$id \(int\|null\) is never assigned int so it can be removed from the property type\.$#'
1416
-
1517
message: '#^Call to an undefined method Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition\:\:children\(\)\.$#'

‎src/Doctrine/Entity/AbstractPackageLink.php‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<?php
2+
3+
namespace CodedMonkey\Dirigent\Doctrine\Entity;
4+
5+
use Doctrine\ORM\Mapping as ORM;
6+
7+
#[ORM\MappedSuperclass]
8+
abstract class AbstractPackageLink
9+
{
10+
protected Package $package;
11+
12+
#[ORM\Id, ORM\Column(length: 191)]
13+
private string $linkedPackageName;
14+
15+
public function getId(): ?int
16+
{
17+
return $this->id;
18+
}
19+
20+
public function getPackage(): Package
21+
{
22+
return $this->package;
23+
}
24+
25+
public function setPackage(Package $package): void
26+
{
27+
$this->package = $package;
28+
}
29+
30+
public function getLinkedPackageName(): string
31+
{
32+
return $this->linkedPackageName;
33+
}
34+
35+
public function setLinkedPackageName(string $packageName): void
36+
{
37+
$this->linkedPackageName = $packageName;
38+
}
39+
}

‎src/Doctrine/Entity/PackageProvideLink.php‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?php
2+
3+
namespace CodedMonkey\Dirigent\Doctrine\Entity;
4+
5+
use Doctrine\ORM\Mapping as ORM;
6+
7+
#[ORM\Entity]
8+
class PackageProvideLink extends AbstractPackageLink
9+
{
10+
#[ORM\Id, ORM\ManyToOne(targetEntity: Package::class), ORM\JoinColumn(nullable: false)]
11+
protected Package $package;
12+
13+
#[ORM\Id, ORM\Column]
14+
private bool $implementation;
15+
16+
public function isImplementation(): bool
17+
{
18+
return $this->implementation;
19+
}
20+
21+
public function setImplementation(bool $implementation): static
22+
{
23+
$this->implementation = $implementation;
24+
25+
return $this;
26+
}
27+
}

‎src/Doctrine/Entity/PackageRequireLink.php‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?php
2+
3+
namespace CodedMonkey\Dirigent\Doctrine\Entity;
4+
5+
use Doctrine\ORM\Mapping as ORM;
6+
7+
#[ORM\Entity]
8+
class PackageRequireLink extends AbstractPackageLink
9+
{
10+
#[ORM\Id, ORM\ManyToOne(targetEntity: Package::class), ORM\JoinColumn(nullable: false)]
11+
protected Package $package;
12+
13+
#[ORM\Id, ORM\Column]
14+
private bool $devDependency;
15+
16+
public function isDevDependency(): bool
17+
{
18+
return $this->devDependency;
19+
}
20+
21+
public function setDevDependency(bool $devDependency): static
22+
{
23+
$this->devDependency = $devDependency;
24+
25+
return $this;
26+
}
27+
}

‎src/Doctrine/Entity/PackageSuggestLink.php‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?php
2+
3+
namespace CodedMonkey\Dirigent\Doctrine\Entity;
4+
5+
use Doctrine\ORM\Mapping as ORM;
6+
7+
#[ORM\Entity]
8+
class PackageSuggestLink extends AbstractPackageLink
9+
{
10+
#[ORM\Id, ORM\ManyToOne(targetEntity: Package::class), ORM\JoinColumn(nullable: false)]
11+
protected Package $package;
12+
}

‎src/Doctrine/Repository/PackageRepository.php‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ public function save(Package $entity, bool $flush = false): void
4040

4141
public function remove(Package $entity, bool $flush = false): void
4242
{
43+
$this->deletePackageLinks($entity->getId());
44+
4345
$this->getEntityManager()->remove($entity);
4446

4547
if ($flush) {
@@ -82,4 +84,56 @@ public function getAllPackageIds(): array
8284

8385
return $connection->fetchAllAssociative('SELECT id FROM package ORDER BY id');
8486
}
87+
88+
public function updatePackageLinks(int $packageId, int $versionId): void
89+
{
90+
$connection = $this->getEntityManager()->getConnection();
91+
$connection->beginTransaction();
92+
93+
try {
94+
$this->deletePackageLinks($packageId);
95+
96+
$connection->executeStatement(
97+
'INSERT INTO package_require_link (linked_package_name, dev_dependency, package_id) SELECT linked_package_name, FALSE, :id FROM version_require_link WHERE version_id = :version',
98+
['id' => $packageId, 'version' => $versionId],
99+
);
100+
$connection->executeStatement(
101+
'INSERT INTO package_require_link (linked_package_name, dev_dependency, package_id) SELECT linked_package_name, TRUE, :id FROM version_dev_require_link WHERE version_id = :version',
102+
['id' => $packageId, 'version' => $versionId],
103+
);
104+
$connection->executeStatement(
105+
'INSERT INTO package_suggest_link (linked_package_name, package_id) SELECT linked_package_name, :id FROM version_suggest_link WHERE version_id = :version',
106+
['id' => $packageId, 'version' => $versionId],
107+
);
108+
$connection->executeStatement(<<<'SQL'
109+
INSERT INTO package_provide_link (linked_package_name, implementation, package_id)
110+
SELECT linked_package_name, FALSE, :id
111+
FROM version_provide_link
112+
WHERE version_id = :version AND linked_package_name NOT LIKE '%-implementation'
113+
SQL,
114+
['id' => $packageId, 'version' => $versionId],
115+
);
116+
$connection->executeStatement(<<<'SQL'
117+
INSERT INTO package_provide_link (linked_package_name, implementation, package_id)
118+
SELECT SUBSTRING(linked_package_name, 1, LENGTH(linked_package_name) - 15), TRUE, :id
119+
FROM version_provide_link
120+
WHERE version_id = :version AND linked_package_name LIKE '%-implementation'
121+
SQL,
122+
['id' => $packageId, 'version' => $versionId],
123+
);
124+
} catch (\Throwable $exception) {
125+
$connection->rollBack();
126+
throw $exception;
127+
}
128+
129+
$connection->commit();
130+
}
131+
132+
public function deletePackageLinks(int $packageId): void
133+
{
134+
$connection = $this->getEntityManager()->getConnection();
135+
$connection->executeStatement('DELETE FROM package_provide_link WHERE package_id = :id', ['id' => $packageId]);
136+
$connection->executeStatement('DELETE FROM package_require_link WHERE package_id = :id', ['id' => $packageId]);
137+
$connection->executeStatement('DELETE FROM package_suggest_link WHERE package_id = :id', ['id' => $packageId]);
138+
}
85139
}

‎src/Package/PackageMetadataResolver.php‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,9 @@ private function resolveVcsRepository(Package $package): void
162162
private function updatePackage(Package $package, array $composerPackages, ?VcsDriverInterface $driver = null): void
163163
{
164164
$existingVersions = $this->versionRepository->getVersionMetadataForUpdate($package);
165+
$processedVersions = [];
166+
/** @var ?string $primaryVersionName Version name to use as package link source */
167+
$primaryVersionName = null;
165168

166169
foreach ($composerPackages as $composerPackage) {
167170
if ($composerPackage instanceof AliasPackage) {
@@ -175,10 +178,28 @@ private function updatePackage(Package $package, array $composerPackages, ?VcsDr
175178
}
176179

177180
$this->updateVersion($package, $version, $composerPackage, $driver);
181+
$versionName = $version->getNormalizedVersion();
178182

179-
unset($existingVersions[$version->getNormalizedVersion()]);
183+
// Use the first version which should be the highest stable version by default
184+
if (null === $primaryVersionName) {
185+
$primaryVersionName = $versionName;
186+
}
187+
// If default branch is present however we prefer that as the canonical package link source
188+
if ($version->isDefaultBranch()) {
189+
$primaryVersionName = $versionName;
190+
}
191+
192+
$processedVersions[$versionName] = $version;
193+
unset($existingVersions[$versionName]);
194+
}
195+
196+
if ($primaryVersionName) {
197+
$primaryVersion = $processedVersions[$primaryVersionName];
198+
199+
$this->packageRepository->updatePackageLinks($package->getId(), $primaryVersion->getId());
180200
}
181201

202+
// Remove outdated versions
182203
foreach ($existingVersions as $version) {
183204
$versionEntity = $this->versionRepository->find($version['id']);
184205

0 commit comments

Comments
 (0)