Merge pull request #11035 from kbond/feat/lazy-first

Make `PersistentCollection::first()` "extra" lazy
doctrine · Oct 21, 2024 · 0f11a97 · 0f11a97
2 parents 74155c8 + c9253ef
commit 0f11a97
Show file tree

Hide file tree

Showing 3 changed files with 72 additions and 0 deletions.
diff --git a/docs/en/tutorials/extra-lazy-associations.rst b/docs/en/tutorials/extra-lazy-associations.rst
@@ -17,6 +17,7 @@ can be called without triggering a full load of the collection:
 -  ``Collection#contains($entity)``
 -  ``Collection#containsKey($key)``
 -  ``Collection#count()``
+-  ``Collection#first()``
 -  ``Collection#get($key)``
 -  ``Collection#slice($offset, $length = null)``
 

diff --git a/src/PersistentCollection.php b/src/PersistentCollection.php
@@ -504,6 +504,20 @@ public function __wakeup(): void
         $this->em = null;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function first()
+    {
+        if (! $this->initialized && ! $this->isDirty && $this->getMapping()['fetch'] === ClassMetadata::FETCH_EXTRA_LAZY) {
+            $persister = $this->getUnitOfWork()->getCollectionPersister($this->getMapping());
+
+            return array_values($persister->slice($this, 0, 1))[0] ?? false;
+        }
+
+        return parent::first();
+    }
+
     /**
      * Extracts a slice of $length elements starting at position $offset from the Collection.
      *

diff --git a/tests/Tests/ORM/Functional/ExtraLazyCollectionTest.php b/tests/Tests/ORM/Functional/ExtraLazyCollectionTest.php
@@ -179,6 +179,63 @@ public function testCountOneToManyJoinedInheritance(): void
         self::assertCount(2, $otherClass->childClasses);
     }
 
+    #[Group('non-cacheable')]
+    public function testFirstWhenInitialized(): void
+    {
+        $user = $this->_em->find(CmsUser::class, $this->userId);
+        $this->getQueryLog()->reset()->enable();
+        $user->groups->toArray();
+
+        self::assertTrue($user->groups->isInitialized());
+        self::assertInstanceOf(CmsGroup::class, $user->groups->first());
+        $this->assertQueryCount(1, 'Should only execute one query to initialize collection, no extra query for first().');
+    }
+
+    public function testFirstOnEmptyCollectionWhenInitialized(): void
+    {
+        foreach ($this->_em->getRepository(CmsGroup::class)->findAll() as $group) {
+            $this->_em->remove($group);
+        }
+
+        $this->_em->flush();
+
+        $user = $this->_em->find(CmsUser::class, $this->userId);
+        $this->getQueryLog()->reset()->enable();
+        $user->groups->toArray();
+
+        self::assertTrue($user->groups->isInitialized());
+        self::assertFalse($user->groups->first());
+        $this->assertQueryCount(1, 'Should only execute one query to initialize collection, no extra query for first().');
+    }
+
+    public function testFirstWhenNotInitialized(): void
+    {
+        $user = $this->_em->find(CmsUser::class, $this->userId);
+        $this->getQueryLog()->reset()->enable();
+
+        self::assertFalse($user->groups->isInitialized());
+        self::assertInstanceOf(CmsGroup::class, $user->groups->first());
+        self::assertFalse($user->groups->isInitialized());
+        $this->assertQueryCount(1, 'Should only execute one query for first().');
+    }
+
+    public function testFirstOnEmptyCollectionWhenNotInitialized(): void
+    {
+        foreach ($this->_em->getRepository(CmsGroup::class)->findAll() as $group) {
+            $this->_em->remove($group);
+        }
+
+        $this->_em->flush();
+
+        $user = $this->_em->find(CmsUser::class, $this->userId);
+        $this->getQueryLog()->reset()->enable();
+
+        self::assertFalse($user->groups->isInitialized());
+        self::assertFalse($user->groups->first());
+        self::assertFalse($user->groups->isInitialized());
+        $this->assertQueryCount(1, 'Should only execute one query for first().');
+    }
+
     #[Group('DDC-546')]
     public function testFullSlice(): void
     {