tests/Integration/Database/EloquentHasManyThroughTest.php - 13.x - githubmirror/framework

tests/Integration/Database/EloquentHasManyThroughTest.php
525 строк17 KB
Lucas Michot
[13.x] Enforce stricter assertions (#59749)
17 апр 2026, 16:15
17 апр 2026, 16:1592fecdd
<?php

namespace Illuminate\Tests\Integration\Database\EloquentHasManyThroughTest;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasOneThrough;
use Illuminate\Database\Eloquent\SoftDeletes;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Carbon;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Schema;
use Illuminate\Support\Str;
use Illuminate\Tests\Integration\Database\DatabaseTestCase;

class EloquentHasManyThroughTest extends DatabaseTestCase
{
    protected function afterRefreshingDatabase()
    {
        Schema::create('users', function (Blueprint $table) {
            $table->increments('id');
            $table->string('slug')->nullable();
            $table->integer('team_id')->nullable();
            $table->string('name');
        });

        Schema::create('teams', function (Blueprint $table) {
            $table->increments('id');
            $table->integer('owner_id')->nullable();
            $table->string('owner_slug')->nullable();
        });

        Schema::create('categories', function (Blueprint $table) {
            $table->increments('id');
            $table->integer('parent_id')->nullable();
            $table->softDeletes();
        });

        Schema::create('products', function (Blueprint $table) {
            $table->increments('id');
            $table->integer('category_id');
        });

        Schema::create('articles', function (Blueprint $table) {
            $table->id();
            $table->foreignId('user_id');
            $table->string('title')->unique();
            $table->timestamps();
        });
    }

    public function testBasicCreateAndRetrieve()
    {
        $user = User::create(['name' => Str::random()]);

        $team1 = Team::create(['owner_id' => $user->id]);
        $team2 = Team::create(['owner_id' => $user->id]);

        $mate1 = User::create(['name' => 'John', 'team_id' => $team1->id]);
        $mate2 = User::create(['name' => 'Jack', 'team_id' => $team2->id, 'slug' => null]);

        User::create(['name' => Str::random()]);

        $this->assertEquals([$mate1->id, $mate2->id], $user->teamMates->pluck('id')->toArray());
        $this->assertEquals([$mate1->id, $mate2->id], $user->teamMatesWithPendingRelation->pluck('id')->toArray());
        $this->assertEquals([$user->id], User::has('teamMates')->pluck('id')->toArray());
        $this->assertEquals([$user->id], User::has('teamMatesWithPendingRelation')->pluck('id')->toArray());

        $result = $user->teamMates()->first();
        $this->assertEquals(
            $mate1->refresh()->getAttributes() + ['laravel_through_key' => '1'],
            $result->getAttributes()
        );

        $result = $user->teamMatesWithPendingRelation()->first();
        $this->assertEquals(
            $mate1->refresh()->getAttributes() + ['laravel_through_key' => '1'],
            $result->getAttributes()
        );

        $result = $user->teamMates()->firstWhere('name', 'Jack');
        $this->assertEquals(
            $mate2->refresh()->getAttributes() + ['laravel_through_key' => '1'],
            $result->getAttributes()
        );

        $result = $user->teamMatesWithPendingRelation()->firstWhere('name', 'Jack');
        $this->assertEquals(
            $mate2->refresh()->getAttributes() + ['laravel_through_key' => '1'],
            $result->getAttributes()
        );
    }

    public function testGlobalScopeColumns()
    {
        $user = User::create(['name' => Str::random()]);

        $team1 = Team::create(['owner_id' => $user->id]);

        User::create(['name' => Str::random(), 'team_id' => $team1->id]);

        $teamMates = $user->teamMatesWithGlobalScope;
        $this->assertEquals(['id' => 2, 'laravel_through_key' => 1], $teamMates[0]->getAttributes());

        $teamMates = $user->teamMatesWithGlobalScopeWithPendingRelation;
        $this->assertEquals(['id' => 2, 'laravel_through_key' => 1], $teamMates[0]->getAttributes());
    }

    public function testHasSelf()
    {
        $user = User::create(['name' => Str::random()]);

        $team = Team::create(['owner_id' => $user->id]);

        User::create(['name' => Str::random(), 'team_id' => $team->id]);

        $users = User::has('teamMates')->get();
        $this->assertCount(1, $users);

        $users = User::has('teamMatesWithPendingRelation')->get();
        $this->assertCount(1, $users);
    }

    public function testHasSelfCustomOwnerKey()
    {
        $user = User::create(['slug' => Str::random(), 'name' => Str::random()]);

        $team = Team::create(['owner_slug' => $user->slug]);

        User::create(['name' => Str::random(), 'team_id' => $team->id]);

        $users = User::has('teamMatesBySlug')->get();
        $this->assertCount(1, $users);

        $users = User::has('teamMatesBySlugWithPendingRelationship')->get();
        $this->assertCount(1, $users);
    }

    public function testHasSameParentAndThroughParentTable()
    {
        Category::create();
        Category::create();
        Category::create(['parent_id' => 1]);
        Category::create(['parent_id' => 2])->delete();

        Product::create(['category_id' => 3]);
        Product::create(['category_id' => 4]);

        $categories = Category::has('subProducts')->get();

        $this->assertEquals([1], $categories->pluck('id')->all());
    }

    public function testFirstOrNewOnMissingRecord()
    {
        $taylor = User::create(['name' => 'Taylor', 'slug' => 'taylor']);
        $team = Team::create(['owner_id' => $taylor->id]);

        $user1 = $taylor->teamMates()->firstOrNew(
            ['slug' => 'tony'],
            ['name' => 'Tony', 'team_id' => $team->id],
        );

        $this->assertFalse($user1->exists);
        $this->assertEquals($team->id, $user1->team_id);
        $this->assertSame('tony', $user1->slug);
        $this->assertSame('Tony', $user1->name);
    }

    public function testFirstOrNewWhenRecordExists()
    {
        $taylor = User::create(['name' => 'Taylor', 'slug' => 'taylor']);
        $team = Team::create(['owner_id' => $taylor->id]);
        $existingTony = $team->members()->create(['name' => 'Tony Messias', 'slug' => 'tony']);

        $newTony = $taylor->teamMates()->firstOrNew(
            ['slug' => 'tony'],
            ['name' => 'Tony', 'team_id' => $team->id],
        );

        $this->assertTrue($newTony->exists);
        $this->assertEquals($team->id, $newTony->team_id);
        $this->assertSame('tony', $newTony->slug);
        $this->assertSame('Tony Messias', $newTony->name);

        $this->assertTrue($existingTony->is($newTony));
        $this->assertSame('tony', $existingTony->refresh()->slug);
        $this->assertSame('Tony Messias', $existingTony->name);
    }

    public function testFirstOrCreateWhenModelDoesntExist()
    {
        $owner = User::create(['name' => 'Taylor']);
        Team::create(['owner_id' => $owner->id]);

        $mate = $owner->teamMates()->firstOrCreate(['slug' => 'adam'], ['name' => 'Adam']);

        $this->assertTrue($mate->wasRecentlyCreated);
        $this->assertNull($mate->team_id);
        $this->assertSame('Adam', $mate->name);
        $this->assertSame('adam', $mate->slug);
    }

    public function testFirstOrCreateWhenModelExists()
    {
        $owner = User::create(['name' => 'Taylor']);
        $team = Team::create(['owner_id' => $owner->id]);

        $team->members()->create(['slug' => 'adam', 'name' => 'Adam Wathan']);

        $mate = $owner->teamMates()->firstOrCreate(['slug' => 'adam'], ['name' => 'Adam']);

        $this->assertFalse($mate->wasRecentlyCreated);
        $this->assertNotNull($mate->team_id);
        $this->assertTrue($team->is($mate->team));
        $this->assertSame('Adam Wathan', $mate->name);
        $this->assertSame('adam', $mate->slug);
    }

    public function testFirstOrCreateRegressionIssue()
    {
        $team1 = Team::create();
        $team2 = Team::create();

        $jane = $team2->members()->create(['name' => 'Jane', 'slug' => 'jane']);
        $john = $team1->members()->create(['name' => 'John', 'slug' => 'john']);

        $taylor = User::create(['name' => 'Taylor']);
        $team1->update(['owner_id' => $taylor->id]);

        $newJohn = $taylor->teamMates()->firstOrCreate(
            ['slug' => 'john'],
            ['name' => 'John Doe'],
        );

        $this->assertFalse($newJohn->wasRecentlyCreated);
        $this->assertTrue($john->is($newJohn));
        $this->assertSame('john', $newJohn->refresh()->slug);
        $this->assertSame('John', $newJohn->name);

        $this->assertSame('john', $john->refresh()->slug);
        $this->assertSame('John', $john->name);
        $this->assertSame('jane', $jane->refresh()->slug);
        $this->assertSame('Jane', $jane->name);
    }

    public function testCreateOrFirstWhenRecordDoesntExist()
    {
        $team = Team::create();
        $tony = $team->members()->create(['name' => 'Tony']);

        $article = $team->articles()->createOrFirst(
            ['title' => 'Laravel Forever'],
            ['user_id' => $tony->id],
        );

        $this->assertTrue($article->wasRecentlyCreated);
        $this->assertSame('Laravel Forever', $article->title);
        $this->assertTrue($tony->is($article->user));
    }

    public function testCreateOrFirstWhenRecordExists()
    {
        $team = Team::create();
        $taylor = $team->members()->create(['name' => 'Taylor']);
        $tony = $team->members()->create(['name' => 'Tony']);

        $existingArticle = $taylor->articles()->create([
            'title' => 'Laravel Forever',
        ]);

        $newArticle = $team->articles()->createOrFirst(
            ['title' => 'Laravel Forever'],
            ['user_id' => $tony->id],
        );

        $this->assertFalse($newArticle->wasRecentlyCreated);
        $this->assertSame('Laravel Forever', $newArticle->title);
        $this->assertTrue($taylor->is($newArticle->user));
        $this->assertTrue($existingArticle->is($newArticle));
    }

    public function testCreateOrFirstWhenRecordExistsInTransaction()
    {
        $team = Team::create();
        $taylor = $team->members()->create(['name' => 'Taylor']);
        $tony = $team->members()->create(['name' => 'Tony']);

        $existingArticle = $taylor->articles()->create([
            'title' => 'Laravel Forever',
        ]);

        $newArticle = DB::transaction(fn () => $team->articles()->createOrFirst(
            ['title' => 'Laravel Forever'],
            ['user_id' => $tony->id],
        ));

        $this->assertFalse($newArticle->wasRecentlyCreated);
        $this->assertSame('Laravel Forever', $newArticle->title);
        $this->assertTrue($taylor->is($newArticle->user));
        $this->assertTrue($existingArticle->is($newArticle));
    }

    public function testCreateOrFirstRegressionIssue()
    {
        $team1 = Team::create();

        $taylor = $team1->members()->create(['name' => 'Taylor']);
        $tony = $team1->members()->create(['name' => 'Tony']);

        $existingTonyArticle = $tony->articles()->create(['title' => 'The New createOrFirst Method']);
        $existingTaylorArticle = $taylor->articles()->create(['title' => 'Laravel Forever']);

        $newArticle = $team1->articles()->createOrFirst(
            ['title' => 'Laravel Forever'],
            ['user_id' => $tony->id],
        );

        $this->assertFalse($newArticle->wasRecentlyCreated);
        $this->assertTrue($existingTaylorArticle->is($newArticle));
        $this->assertSame('Laravel Forever', $newArticle->refresh()->title);
        $this->assertTrue($taylor->is($newArticle->user));

        $this->assertSame('Laravel Forever', $existingTaylorArticle->refresh()->title);
        $this->assertSame('The New createOrFirst Method', $existingTonyArticle->refresh()->title);
        $this->assertTrue($tony->is($existingTonyArticle->user));
    }

    public function testUpdateOrCreateAffectingWrongModelsRegression()
    {
        // On Laravel 10.21.0, a bug was introduced that would update the wrong model when using `updateOrCreate()`,
        // because the UPDATE statement would target a model based on the ID from the parent instead of the actual
        // conditions that the `updateOrCreate()` targeted. This test replicates the case that causes this bug.

        $team1 = Team::create();
        $team2 = Team::create();

        // Jane's ID should be the same as the $team1's ID for the bug to occur.
        $jane = User::create(['name' => 'Jane', 'slug' => 'jane-slug', 'team_id' => $team2->id]);
        $john = User::create(['name' => 'John', 'slug' => 'john-slug', 'team_id' => $team1->id]);

        $taylor = User::create(['name' => 'Taylor']);
        $team1->update(['owner_id' => $taylor->id]);

        $this->assertSame(2, $john->id);
        $this->assertSame(1, $jane->id);

        $this->assertSame(2, $john->refresh()->id);
        $this->assertSame(1, $jane->refresh()->id);

        $this->assertSame('john-slug', $john->slug);
        $this->assertSame('jane-slug', $jane->slug);

        $this->assertSame('john-slug', $john->refresh()->slug);
        $this->assertSame('jane-slug', $jane->refresh()->slug);

        // The `updateOrCreate` method would first try to find a matching attached record with a query like:
        // `->where($attributes)->first()`, which should return `John` of ID 1 in our case. However, it'd
        // return the incorrect ID of 2, which caused it to update Jane's record instead of John's.

        $taylor->teamMates()->updateOrCreate([
            'name' => 'John',
        ], [
            'slug' => 'john-doe',
        ]);

        // Expect $john's slug to be updated to john-doe instead of john-slug.
        $this->assertSame('john-doe', $john->fresh()->slug);
        // $jane should not be updated, because it belongs to a different user altogether.
        $this->assertSame('jane-slug', $jane->fresh()->slug);
    }

    public function testCanReplicateModelLoadedThroughHasManyThrough()
    {
        $team = Team::create();
        $user = User::create(['team_id' => $team->id, 'name' => 'John']);
        Article::create(['user_id' => $user->id, 'title' => 'John\'s new has-many-through-article']);

        $article = $team->articles()->first();

        $this->assertInstanceOf(Article::class, $article);

        $newArticle = $article->replicate();
        $newArticle->title .= ' v2';
        $newArticle->save();
    }

    public function testOne(): void
    {
        $team = Team::create();

        $user = User::create(['team_id' => $team->id, 'name' => Str::random()]);

        Article::create(['user_id' => $user->id, 'title' => Str::random(), 'created_at' => Carbon::now()->subDay()]);
        $latestArticle = Article::create(['user_id' => $user->id, 'title' => Str::random(), 'created_at' => Carbon::now()]);

        $this->assertEquals($latestArticle->id, $team->latestArticle->id);
    }
}

class User extends Model
{
    public $table = 'users';
    public $timestamps = false;
    protected $guarded = [];

    public function teamMates()
    {
        return $this->hasManyThrough(self::class, Team::class, 'owner_id', 'team_id');
    }

    public function teamMatesWithPendingRelation()
    {
        return $this->through($this->ownedTeams())
            ->has(fn (Team $team) => $team->members());
    }

    public function teamMatesBySlug()
    {
        return $this->hasManyThrough(self::class, Team::class, 'owner_slug', 'team_id', 'slug');
    }

    public function teamMatesBySlugWithPendingRelationship()
    {
        return $this->through($this->hasMany(Team::class, 'owner_slug', 'slug'))
            ->has(fn ($team) => $team->hasMany(User::class, 'team_id'));
    }

    public function teamMatesWithGlobalScope()
    {
        return $this->hasManyThrough(UserWithGlobalScope::class, Team::class, 'owner_id', 'team_id');
    }

    public function teamMatesWithGlobalScopeWithPendingRelation()
    {
        return $this->through($this->ownedTeams())
            ->has(fn (Team $team) => $team->membersWithGlobalScope());
    }

    public function ownedTeams()
    {
        return $this->hasMany(Team::class, 'owner_id');
    }

    public function team()
    {
        return $this->belongsTo(Team::class);
    }

    public function articles()
    {
        return $this->hasMany(Article::class);
    }
}

class UserWithGlobalScope extends Model
{
    public $table = 'users';
    public $timestamps = false;
    protected $guarded = [];

    public static function boot()
    {
        parent::boot();

        static::addGlobalScope(function ($query) {
            $query->select('users.id');
        });
    }
}

class Team extends Model
{
    public $table = 'teams';
    public $timestamps = false;
    protected $guarded = [];

    public function members()
    {
        return $this->hasMany(User::class, 'team_id');
    }

    public function membersWithGlobalScope()
    {
        return $this->hasMany(UserWithGlobalScope::class, 'team_id');
    }

    public function articles()
    {
        return $this->hasManyThrough(Article::class, User::class);
    }

    public function latestArticle(): HasOneThrough
    {
        return $this->articles()->one()->latest();
    }
}

class Category extends Model
{
    use SoftDeletes;

    public $timestamps = false;
    protected $guarded = [];

    public function subProducts()
    {
        return $this->hasManyThrough(Product::class, self::class, 'parent_id');
    }
}

class Product extends Model
{
    public $timestamps = false;
    protected $guarded = [];
}

class Article extends Model
{
    protected $guarded = [];

    public function user()
    {
        return $this->belongsTo(User::class);
    }
}