Add index to metadata link entities

codedmonkey · codedmonkey · commit 2c50946ea9d0 · 2026-02-19T14:48:54.000+01:00
Signed-off-by: Tim Goudriaan &lt;tim@codedmonkey.com&gt;
diff --git a/migrations/Version20260120114538.php b/migrations/Version20260120114538.php
@@ -94,6 +94,7 @@ private function createMetadataTables(): void
                 id INT GENERATED BY DEFAULT AS IDENTITY NOT NULL,
                 linked_package_name VARCHAR(191) NOT NULL,
                 linked_version_constraint TEXT NOT NULL,
+                index INT NOT NULL,
                 metadata_id INT NOT NULL,
                 PRIMARY KEY (id)
             )
@@ -106,6 +107,7 @@ private function createMetadataTables(): void
                 id INT GENERATED BY DEFAULT AS IDENTITY NOT NULL,
                 linked_package_name VARCHAR(191) NOT NULL,
                 linked_version_constraint TEXT NOT NULL,
+                index INT NOT NULL,
                 metadata_id INT NOT NULL,
                 PRIMARY KEY (id)
             )
@@ -118,6 +120,7 @@ private function createMetadataTables(): void
                 id INT GENERATED BY DEFAULT AS IDENTITY NOT NULL,
                 linked_package_name VARCHAR(191) NOT NULL,
                 linked_version_constraint TEXT NOT NULL,
+                index INT NOT NULL,
                 metadata_id INT NOT NULL,
                 PRIMARY KEY (id)
             )
@@ -130,6 +133,7 @@ private function createMetadataTables(): void
                 id INT GENERATED BY DEFAULT AS IDENTITY NOT NULL,
                 linked_package_name VARCHAR(191) NOT NULL,
                 linked_version_constraint TEXT NOT NULL,
+                index INT NOT NULL,
                 metadata_id INT NOT NULL,
                 PRIMARY KEY (id)
             )
@@ -142,6 +146,7 @@ private function createMetadataTables(): void
                 id INT GENERATED BY DEFAULT AS IDENTITY NOT NULL,
                 linked_package_name VARCHAR(191) NOT NULL,
                 linked_version_constraint TEXT NOT NULL,
+                index INT NOT NULL,
                 metadata_id INT NOT NULL,
                 PRIMARY KEY (id)
             )
@@ -154,6 +159,7 @@ private function createMetadataTables(): void
                 id INT GENERATED BY DEFAULT AS IDENTITY NOT NULL,
                 linked_package_name VARCHAR(191) NOT NULL,
                 linked_version_constraint TEXT NOT NULL,
+                index INT NOT NULL,
                 metadata_id INT NOT NULL,
                 PRIMARY KEY (id)
             )
@@ -292,8 +298,12 @@ private function fillMetadataTables(): void
 
         foreach ($linkTables as $linkTable) {
             $this->addSql(<<<SQL
-                INSERT INTO metadata_{$linkTable}_link (metadata_id, linked_package_name, linked_version_constraint)
-                SELECT metadata.id, link.linked_package_name, link.linked_version_constraint
+                INSERT INTO metadata_{$linkTable}_link (metadata_id, linked_package_name, linked_version_constraint, index)
+                SELECT
+                    metadata.id,
+                    link.linked_package_name,
+                    link.linked_version_constraint,
+                    ROW_NUMBER() OVER (PARTITION BY metadata.id) - 1
                 FROM version_{$linkTable}_link link
                 INNER JOIN metadata metadata ON link.version_id = metadata.version_id
             SQL);
@@ -757,6 +767,7 @@ private function fillVersionTables(): void
                     WHERE version_link.version_id = metadata.version_id
                     AND version_link.linked_package_name = metadata_link.linked_package_name
                 )
+                ORDER BY metadata_link.index
             SQL);
         }
     }
diff --git a/phpstan.dist.neon b/phpstan.dist.neon
@@ -11,8 +11,6 @@ parameters:
         - tests/bootstrap.php
     ignoreErrors:
         - '#^Call to an undefined method Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition\:\:children\(\)\.$#'
-        - '#CodedMonkey\\Dirigent\\Doctrine\\Entity\\AbstractMetadataLink given\.#'
-        - '#^PHPDoc tag @var with type CodedMonkey\\Dirigent\\Doctrine\\Entity\\AbstractMetadataLink is not subtype of native type#'
         - '#^Property CodedMonkey\\Dirigent\\Doctrine\\Entity\\[a-zA-Z]+\:\:\$id \(int\|null\) is never assigned int so it can be removed from the property type\.$#'
         -
             message: '#^Class CodedMonkey\\Dirigent\\Doctrine\\Entity\\TrackedEntity has an uninitialized readonly property \$createdAt\. Assign it in the constructor\.$#'
diff --git a/src/Doctrine/Entity/AbstractMetadataLink.php b/src/Doctrine/Entity/AbstractMetadataLink.php
@@ -21,11 +21,25 @@ abstract class AbstractMetadataLink
     #[ORM\Column(type: Types::TEXT)]
     private string $linkedVersionConstraint;
 
-    public function __construct(Metadata $metadata)
-    {
+    #[ORM\Column]
+    private int $index;
+
+    public function __construct(
+        Metadata $metadata,
+        string $linkedPackageName,
+        string $linkedVersionConstraint,
+        int $index,
+    ) {
         $this->metadata = $metadata;
+        $this->linkedPackageName = $linkedPackageName;
+        $this->linkedVersionConstraint = $linkedVersionConstraint;
+        $this->index = $index;
+
+        $this->addToCollection();
     }
 
+    abstract protected function addToCollection(): void;
+
     public function getId(): ?int
     {
         return $this->id;
@@ -41,18 +55,13 @@ public function getLinkedPackageName(): string
         return $this->linkedPackageName;
     }
 
-    public function setLinkedPackageName(string $packageName): void
-    {
-        $this->linkedPackageName = $packageName;
-    }
-
     public function getLinkedVersionConstraint(): string
     {
         return $this->linkedVersionConstraint;
     }
 
-    public function setLinkedVersionConstraint(string $packageVersion): void
+    public function getIndex(): int
     {
-        $this->linkedVersionConstraint = $packageVersion;
+        return $this->index;
     }
 }
diff --git a/src/Doctrine/Entity/Metadata.php b/src/Doctrine/Entity/Metadata.php
@@ -100,36 +100,42 @@ class Metadata extends TrackedEntity implements \Stringable
      * @var Collection<int, MetadataRequireLink>
      */
     #[ORM\OneToMany(targetEntity: MetadataRequireLink::class, mappedBy: 'metadata', cascade: ['persist', 'detach', 'remove'])]
+    #[ORM\OrderBy(['index' => 'ASC'])]
     private Collection $require;
 
     /**
      * @var Collection<int, MetadataDevRequireLink>
      */
     #[ORM\OneToMany(targetEntity: MetadataDevRequireLink::class, mappedBy: 'metadata', cascade: ['persist', 'detach', 'remove'])]
+    #[ORM\OrderBy(['index' => 'ASC'])]
     private Collection $devRequire;
 
     /**
      * @var Collection<int, MetadataConflictLink>
      */
     #[ORM\OneToMany(targetEntity: MetadataConflictLink::class, mappedBy: 'metadata', cascade: ['persist', 'detach', 'remove'])]
+    #[ORM\OrderBy(['index' => 'ASC'])]
     private Collection $conflict;
 
     /**
      * @var Collection<int, MetadataProvideLink>
      */
     #[ORM\OneToMany(targetEntity: MetadataProvideLink::class, mappedBy: 'metadata', cascade: ['persist', 'detach', 'remove'])]
+    #[ORM\OrderBy(['index' => 'ASC'])]
     private Collection $provide;
 
     /**
      * @var Collection<int, MetadataReplaceLink>
      */
     #[ORM\OneToMany(targetEntity: MetadataReplaceLink::class, mappedBy: 'metadata', cascade: ['persist', 'detach', 'remove'])]
+    #[ORM\OrderBy(['index' => 'ASC'])]
     private Collection $replace;
 
     /**
      * @var Collection<int, MetadataSuggestLink>
      */
     #[ORM\OneToMany(targetEntity: MetadataSuggestLink::class, mappedBy: 'metadata', cascade: ['persist', 'detach', 'remove'])]
+    #[ORM\OrderBy(['index' => 'ASC'])]
     private Collection $suggest;
 
     /**
diff --git a/src/Doctrine/Entity/MetadataConflictLink.php b/src/Doctrine/Entity/MetadataConflictLink.php
@@ -10,4 +10,10 @@ class MetadataConflictLink extends AbstractMetadataLink
     #[ORM\ManyToOne(targetEntity: Metadata::class, inversedBy: 'conflict')]
     #[ORM\JoinColumn(nullable: false)]
     protected Metadata $metadata;
+
+    #[\Override]
+    protected function addToCollection(): void
+    {
+        $this->metadata->getConflict()->add($this);
+    }
 }
diff --git a/src/Doctrine/Entity/MetadataDevRequireLink.php b/src/Doctrine/Entity/MetadataDevRequireLink.php
@@ -10,4 +10,10 @@ class MetadataDevRequireLink extends AbstractMetadataLink
     #[ORM\ManyToOne(targetEntity: Metadata::class, inversedBy: 'devRequire')]
     #[ORM\JoinColumn(nullable: false)]
     protected Metadata $metadata;
+
+    #[\Override]
+    protected function addToCollection(): void
+    {
+        $this->metadata->getDevRequire()->add($this);
+    }
 }
diff --git a/src/Doctrine/Entity/MetadataProvideLink.php b/src/Doctrine/Entity/MetadataProvideLink.php
@@ -11,6 +11,12 @@ class MetadataProvideLink extends AbstractMetadataLink
     #[ORM\JoinColumn(nullable: false)]
     protected Metadata $metadata;
 
+    #[\Override]
+    protected function addToCollection(): void
+    {
+        $this->metadata->getProvide()->add($this);
+    }
+
     public function isImplementation(): bool
     {
         return str_ends_with($this->getLinkedPackageName(), '-implementation');
diff --git a/src/Doctrine/Entity/MetadataReplaceLink.php b/src/Doctrine/Entity/MetadataReplaceLink.php
@@ -10,4 +10,10 @@ class MetadataReplaceLink extends AbstractMetadataLink
     #[ORM\ManyToOne(targetEntity: Metadata::class, inversedBy: 'replace')]
     #[ORM\JoinColumn(nullable: false)]
     protected Metadata $metadata;
+
+    #[\Override]
+    protected function addToCollection(): void
+    {
+        $this->metadata->getReplace()->add($this);
+    }
 }
diff --git a/src/Doctrine/Entity/MetadataRequireLink.php b/src/Doctrine/Entity/MetadataRequireLink.php
@@ -10,4 +10,10 @@ class MetadataRequireLink extends AbstractMetadataLink
     #[ORM\ManyToOne(targetEntity: Metadata::class, inversedBy: 'require')]
     #[ORM\JoinColumn(nullable: false)]
     protected Metadata $metadata;
+
+    #[\Override]
+    protected function addToCollection(): void
+    {
+        $this->metadata->getRequire()->add($this);
+    }
 }
diff --git a/src/Doctrine/Entity/MetadataSuggestLink.php b/src/Doctrine/Entity/MetadataSuggestLink.php
@@ -10,4 +10,10 @@ class MetadataSuggestLink extends AbstractMetadataLink
     #[ORM\ManyToOne(targetEntity: Metadata::class, inversedBy: 'suggest')]
     #[ORM\JoinColumn(nullable: false)]
     protected Metadata $metadata;
+
+    #[\Override]
+    protected function addToCollection(): void
+    {
+        $this->metadata->getSuggest()->add($this);
+    }
 }
diff --git a/src/Package/PackageMetadataResolver.php b/src/Package/PackageMetadataResolver.php
@@ -4,7 +4,6 @@
 
 use cebe\markdown\GithubMarkdown;
 use CodedMonkey\Dirigent\Composer\ComposerClient;
-use CodedMonkey\Dirigent\Doctrine\Entity\AbstractMetadataLink;
 use CodedMonkey\Dirigent\Doctrine\Entity\Metadata;
 use CodedMonkey\Dirigent\Doctrine\Entity\MetadataConflictLink;
 use CodedMonkey\Dirigent\Doctrine\Entity\MetadataDevRequireLink;
@@ -346,24 +345,17 @@ private function createMetadata(Version $version, CompletePackageInterface $data
                 $links[$link->getTarget()] = $constraint;
             }
 
+            $index = 0;
             foreach ($links as $linkPackageName => $linkPackageConstraint) {
-                /** @var AbstractMetadataLink $link */
-                $link = new $linkOptions['entity']($metadata);
-                $link->setLinkedPackageName($linkPackageName);
-                $link->setLinkedVersionConstraint($linkPackageConstraint);
-
-                $metadata->{'get' . ucfirst($linkType)}()->add($link);
+                new $linkOptions['entity']($metadata, $linkPackageName, $linkPackageConstraint, $index++);
             }
         }
 
         // Handle suggests
         if ($suggests = $data->getSuggests()) {
+            $index = 0;
             foreach ($suggests as $linkPackageName => $linkPackageConstraint) {
-                $link = new MetadataSuggestLink($metadata);
-                $link->setLinkedPackageName($linkPackageName);
-                $link->setLinkedVersionConstraint($linkPackageConstraint);
-
-                $metadata->getSuggest()->add($link);
+                new MetadataSuggestLink($metadata, $linkPackageName, $linkPackageConstraint, $index++);
             }
         }
 

Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,6 @@ parameters:`
`11`	`11`	`- tests/bootstrap.php`
`12`	`12`	`ignoreErrors:`
`13`	`13`	`- '#^Call to an undefined method Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition\:\:children\(\)\.$#'`
`14`		`- - '#CodedMonkey\\Dirigent\\Doctrine\\Entity\\AbstractMetadataLink given\.#'`
`15`		`- - '#^PHPDoc tag @var with type CodedMonkey\\Dirigent\\Doctrine\\Entity\\AbstractMetadataLink is not subtype of native type#'`
`16`	`14`	`- '#^Property CodedMonkey\\Dirigent\\Doctrine\\Entity\\[a-zA-Z]+\:\:\$id \(int\\|null\) is never assigned int so it can be removed from the property type\.$#'`
`17`	`15`	`-`
`18`	`16`	`message: '#^Class CodedMonkey\\Dirigent\\Doctrine\\Entity\\TrackedEntity has an uninitialized readonly property \$createdAt\. Assign it in the constructor\.$#'`
Original file line number	Diff line number	Diff line change
`@@ -21,11 +21,25 @@ abstract class AbstractMetadataLink`
`21`	`21`	`#[ORM\Column(type: Types::TEXT)]`
`22`	`22`	`private string $linkedVersionConstraint;`
`23`	`23`
`24`		`- public function __construct(Metadata $metadata)`
`25`		`- {`
	`24`	`+ #[ORM\Column]`
	`25`	`+ private int $index;`
	`26`	`+`
	`27`	`+ public function __construct(`
	`28`	`+ Metadata $metadata,`
	`29`	`+ string $linkedPackageName,`
	`30`	`+ string $linkedVersionConstraint,`
	`31`	`+ int $index,`
	`32`	`+ ) {`
`26`	`33`	`$this->metadata = $metadata;`
	`34`	`+ $this->linkedPackageName = $linkedPackageName;`
	`35`	`+ $this->linkedVersionConstraint = $linkedVersionConstraint;`
	`36`	`+ $this->index = $index;`
	`37`	`+`
	`38`	`+ $this->addToCollection();`
`27`	`39`	`}`
`28`	`40`
	`41`	`+ abstract protected function addToCollection(): void;`
	`42`	`+`
`29`	`43`	`public function getId(): ?int`
`30`	`44`	`{`
`31`	`45`	`return $this->id;`
`@@ -41,18 +55,13 @@ public function getLinkedPackageName(): string`
`41`	`55`	`return $this->linkedPackageName;`
`42`	`56`	`}`
`43`	`57`
`44`		`- public function setLinkedPackageName(string $packageName): void`
`45`		`- {`
`46`		`- $this->linkedPackageName = $packageName;`
`47`		`- }`
`48`		`-`
`49`	`58`	`public function getLinkedVersionConstraint(): string`
`50`	`59`	`{`
`51`	`60`	`return $this->linkedVersionConstraint;`
`52`	`61`	`}`
`53`	`62`
`54`		`- public function setLinkedVersionConstraint(string $packageVersion): void`
	`63`	`+ public function getIndex(): int`
`55`	`64`	`{`
`56`		`- $this->linkedVersionConstraint = $packageVersion;`
	`65`	`+ return $this->index;`
`57`	`66`	`}`
`58`	`67`	`}`