The go-to PHP IDE with extensive out-of-the-box support for Laravel and its ecosystem.

Controlling Factory Relationship Expansion in Laravel

Published on by

Controlling Factory Relationship Expansion in Laravel image

Laravel factories automatically create related models when relationships are defined, but this behavior can produce unnecessary database records during testing. The dontExpandRelationshipsByDefault() method controls whether factories instantiate parent relationships automatically.

Factories often create a cascade of related models when you only need the primary model for your test. This results in extra database writes that slow test execution and complicate test isolation.

use App\Models\OrderItem;
use Database\Factories\OrderItemFactory;
 
public function test_price_calculation(): void
{
OrderItemFactory::dontExpandRelationshipsByDefault();
 
$item = OrderItem::factory()->make([
'quantity' => 2,
'unit_price' => 15.50,
'order_id' => 999,
]);
 
$this->assertEquals(31.00, $item->calculateTotal());
}

This test validates price calculation logic without creating Order, Product, or Customer records. The factory generates only the OrderItem instance needed for the assertion.

Testing collections with relationship expansion disabled keeps tests focused on the logic being verified:

use App\Models\Subscription;
use Database\Factories\SubscriptionFactory;
 
public function test_active_subscriptions_filter(): void
{
SubscriptionFactory::dontExpandRelationshipsByDefault();
 
$subscriptions = collect([
Subscription::factory()->make(['status' => 'active', 'plan_id' => 1]),
Subscription::factory()->make(['status' => 'cancelled', 'plan_id' => 2]),
Subscription::factory()->make(['status' => 'active', 'plan_id' => 1]),
]);
 
$active = $subscriptions->filter(fn($sub) => $sub->isActive());
 
$this->assertCount(2, $active);
}

The complementary method restores default behavior:

SubscriptionFactory::expandRelationshipsByDefault();

Toggle this setting throughout your test suite as needed. When expansion is disabled, you can still create specific relationships using factory relationship methods where required.

For permission testing where you need specific attribute combinations without the overhead of user and company records:

use App\Models\Permission;
use Database\Factories\PermissionFactory;
 
public function test_permission_scope(): void
{
PermissionFactory::dontExpandRelationshipsByDefault();
 
$permissions = collect([
Permission::factory()->make([
'type' => 'read',
'resource_id' => 100,
'user_id' => 5,
]),
Permission::factory()->make([
'type' => 'write',
'resource_id' => 100,
'user_id' => 5,
]),
Permission::factory()->make([
'type' => 'read',
'resource_id' => 200,
'user_id' => 5,
]),
]);
 
$writePermissions = $permissions->where('type', 'write');
 
$this->assertCount(1, $writePermissions);
}

This approach creates test data that matches your exact needs without generating related records that aren't part of the test scenario. Tests run faster and database state remains predictable across test runs.

Harris Raftopoulos photo

Senior Software Engineer • Staff & Educator @ Laravel News • Co-organizer @ Laravel Greece Meetup

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
Laravel Cloud

Easily create and manage your servers and deploy your Laravel applications in seconds.

Visit Laravel Cloud
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
Get expert guidance in a few days with a Laravel code review logo

Get expert guidance in a few days with a Laravel code review

Expert code review! Get clear, practical feedback from two Laravel devs with 10+ years of experience helping teams build better apps.

Get expert guidance in a few days with a Laravel code review
PhpStorm logo

PhpStorm

The go-to PHP IDE with extensive out-of-the-box support for Laravel and its ecosystem.

PhpStorm
Laravel Cloud logo

Laravel Cloud

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Cloud
Acquaint Softtech logo

Acquaint Softtech

Acquaint Softtech offers AI-ready Laravel developers who onboard in 48 hours at $3000/Month with no lengthy sales process and a 100 percent money-back guarantee.

Acquaint Softtech
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Harpoon: Next generation time tracking and invoicing logo

Harpoon: Next generation time tracking and invoicing

The next generation time-tracking and billing software that helps your agency plan and forecast a profitable future.

Harpoon: Next generation time tracking and invoicing
Lucky Media logo

Lucky Media

Get Lucky Now - the ideal choice for Laravel Development, with over a decade of experience!

Lucky Media
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Multi-tenant Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit

The latest

View all →
Browse and Execute Artisan Commands from an Interactive TUI image

Browse and Execute Artisan Commands from an Interactive TUI

Read article
Laravel Pint Now Replaces Fully Qualified Class Names with Imports image

Laravel Pint Now Replaces Fully Qualified Class Names with Imports

Read article
Inertia v3 Upgrade Prompt and JSON Log Support in Laravel Boost v2.3.0 image

Inertia v3 Upgrade Prompt and JSON Log Support in Laravel Boost v2.3.0

Read article
Laracon AU Returns to Brisbane - Call for Speakers Now Open image

Laracon AU Returns to Brisbane - Call for Speakers Now Open

Read article
Detecting and Fixing Race Conditions in Laravel Applications image

Detecting and Fixing Race Conditions in Laravel Applications

Read article
LaraCopilot: Generate Laravel MVPs From a Single Prompt With AI image

LaraCopilot: Generate Laravel MVPs From a Single Prompt With AI

Read article