[feature] add Factory::delayFlush() (#84)

Author: kbond

docs/index.rst

@@ -865,6 +865,22 @@ Foundry can be used to create factories for entities that you don't have model f
     $entity = create(Post::class, ['field' => 'value']);
     $entities = create_many(Post::class, 5, ['field' => 'value']);
 
+Delay Flush
+~~~~~~~~~~~
+
+When creating/persisting many factories at once, it can be improve performance
+to instantiate them all without saving to the database, then flush them all at
+once. To do this, wrap the operations in a ``Factory::delayFlush()`` callback:
+
+.. code-block:: php
+
+    use Zenstruck\Foundry\Factory;
+
+    Factory::delayFlush(function() {
+        CategoryFactory::createMany(100); // instantiated/persisted but not flushed
+        TagFactory::createMany(200); // instantiated/persisted but not flushed
+    }); // single flush
+
 .. _without-persisting:
 
 Without Persisting

src/Configuration.php

@@ -32,6 +32,9 @@ final class Configuration
     /** @var bool|null */
     private $defaultProxyAutoRefresh;
 
+    /** @var bool */
+    private $flushEnabled = true;
+
     public function __construct()
     {
         $this->stories = new StoryManager([]);
@@ -124,6 +127,24 @@ public function disableDefaultProxyAutoRefresh(): self
         return $this;
     }
 
+    public function isFlushingEnabled(): bool
+    {
+        return $this->flushEnabled;
+    }
+
+    public function delayFlush(callable $callback): void
+    {
+        $this->flushEnabled = false;
+
+        $callback();
+
+        foreach ($this->managerRegistry()->getManagers() as $manager) {
+            $manager->flush();
+        }
+
+        $this->flushEnabled = true;
+    }
+
     /**
      * @param object|string $objectOrClass
      *

src/Factory.php

@@ -255,6 +255,11 @@ final public static function faker(): Faker\Generator
         return self::configuration()->faker();
     }
 
+    final public static function delayFlush(callable $callback): void
+    {
+        self::configuration()->delayFlush($callback);
+    }
+
     /**
      * @internal
      *

src/Proxy.php

@@ -110,7 +110,7 @@ public function isPersisted(): bool
      */
     public function object(): object
     {
-        if (!$this->autoRefresh || !$this->persisted) {
+        if (!$this->autoRefresh || !$this->persisted || !Factory::configuration()->isFlushingEnabled()) {
             return $this->object;
         }
 
@@ -139,7 +139,11 @@ public function object(): object
     public function save(): self
     {
         $this->objectManager()->persist($this->object);
-        $this->objectManager()->flush();
+
+        if (Factory::configuration()->isFlushingEnabled()) {
+            $this->objectManager()->flush();
+        }
+
         $this->persisted = true;
 
         return $this;

tests/Fixtures/Entity/Post.php

@@ -89,11 +89,21 @@ public function getTitle(): ?string
         return $this->title;
     }
 
+    public function setTitle(string $title): void
+    {
+        $this->title = $title;
+    }
+
     public function getBody(): ?string
     {
         return $this->body;
     }
 
+    public function setBody(string $body): void
+    {
+        $this->body = $body;
+    }
+
     public function getShortDescription(): ?string
     {
         return $this->shortDescription;

tests/Functional/FactoryTest.php

@@ -142,4 +142,50 @@ public function can_create_embeddable(): void
         $this->assertNull($object1->getValue());
         $this->assertSame('an address', $object2->getValue());
     }
+
+    public function can_delay_flush(): void
+    {
+        AnonymousFactory::new(Post::class)->assert()->empty();
+        AnonymousFactory::new(Category::class)->assert()->empty();
+
+        AnonymousFactory::delayFlush(function() {
+            AnonymousFactory::new(Post::class)->create([
+                'title' => 'title',
+                'body' => 'body',
+                'category' => AnonymousFactory::new(Category::class, ['name' => 'name']),
+            ]);
+
+            AnonymousFactory::new(Post::class)->assert()->empty();
+            AnonymousFactory::new(Category::class)->assert()->empty();
+        });
+
+        AnonymousFactory::new(Post::class)->assert()->count(1);
+        AnonymousFactory::new(Category::class)->assert()->count(1);
+    }
+
+    /**
+     * @test
+     */
+    public function auto_refresh_is_disabled_during_delay_flush(): void
+    {
+        AnonymousFactory::new(Post::class)->assert()->empty();
+        AnonymousFactory::new(Category::class)->assert()->empty();
+
+        AnonymousFactory::delayFlush(function() {
+            $post = AnonymousFactory::new(Post::class)->create([
+                'title' => 'title',
+                'body' => 'body',
+                'category' => AnonymousFactory::new(Category::class, ['name' => 'name']),
+            ]);
+
+            $post->setTitle('new title');
+            $post->setBody('new body');
+
+            AnonymousFactory::new(Post::class)->assert()->empty();
+            AnonymousFactory::new(Category::class)->assert()->empty();
+        });
+
+        AnonymousFactory::new(Post::class)->assert()->count(1);
+        AnonymousFactory::new(Category::class)->assert()->count(1);
+    }
 }