Fix schema foreign ID support for tables with non-standard primary key (#53442)

* Add test for constrained foreign keys

* Add failing test

* Set the referenced column name based on the model key name

* Use the referenced column name if available

* formatting

---------

Co-authored-by: Taylor Otwell <[email protected]>

Author: willrowe

src/Illuminate/Database/Schema/Blueprint.php

@@ -1039,16 +1039,22 @@ public function foreignIdFor($model, $column = null)
         $column = $column ?: $model->getForeignKey();
 
         if ($model->getKeyType() === 'int' && $model->getIncrementing()) {
-            return $this->foreignId($column)->table($model->getTable());
+            return $this->foreignId($column)
+                ->table($model->getTable())
+                ->referencesModelColumn($model->getKeyName());
         }
 
         $modelTraits = class_uses_recursive($model);
 
         if (in_array(HasUlids::class, $modelTraits, true)) {
-            return $this->foreignUlid($column, 26)->table($model->getTable());
+            return $this->foreignUlid($column, 26)
+                ->table($model->getTable())
+                ->referencesModelColumn($model->getKeyName());
         }
 
-        return $this->foreignUuid($column)->table($model->getTable());
+        return $this->foreignUuid($column)
+            ->table($model->getTable())
+            ->referencesModelColumn($model->getKeyName());
     }
 
     /**

src/Illuminate/Database/Schema/ForeignIdColumnDefinition.php

@@ -35,9 +35,10 @@ public function __construct(Blueprint $blueprint, $attributes = [])
      * @param  string|null  $indexName
      * @return \Illuminate\Database\Schema\ForeignKeyDefinition
      */
-    public function constrained($table = null, $column = 'id', $indexName = null)
+    public function constrained($table = null, $column = null, $indexName = null)
     {
         $table ??= $this->table;
+        $column ??= $this->referencesModelColumn ?? 'id';
 
         return $this->references($column, $indexName)->on($table ?? Str::of($this->name)->beforeLast('_'.$column)->plural());
     }

tests/Database/DatabaseSchemaBlueprintTest.php

@@ -10,6 +10,7 @@
 use Illuminate\Database\Schema\Grammars\PostgresGrammar;
 use Illuminate\Database\Schema\Grammars\SQLiteGrammar;
 use Illuminate\Database\Schema\Grammars\SqlServerGrammar;
+use Illuminate\Tests\Database\Fixtures\Models\User;
 use Mockery as m;
 use PHPUnit\Framework\TestCase;
 
@@ -444,6 +445,38 @@ public function testGenerateRelationshipColumnWithUlidModel()
         ], $blueprint->toSql($connection, new MySqlGrammar()));
     }
 
+    public function testGenerateRelationshipConstrainedColumn()
+    {
+        $base = new Blueprint('posts', function ($table) {
+            $table->foreignIdFor('Illuminate\Foundation\Auth\User')->constrained();
+        });
+
+        $connection = m::mock(Connection::class);
+
+        $blueprint = clone $base;
+
+        $this->assertEquals([
+            'alter table `posts` add `user_id` bigint unsigned not null',
+            'alter table `posts` add constraint `posts_user_id_foreign` foreign key (`user_id`) references `users` (`id`)',
+        ], $blueprint->toSql($connection, new MySqlGrammar));
+    }
+
+    public function testGenerateRelationshipForModelWithNonStandardPrimaryKeyName()
+    {
+        $base = new Blueprint('posts', function ($table) {
+            $table->foreignIdFor(User::class)->constrained();
+        });
+
+        $connection = m::mock(Connection::class);
+
+        $blueprint = clone $base;
+
+        $this->assertEquals([
+            'alter table `posts` add `user_internal_id` bigint unsigned not null',
+            'alter table `posts` add constraint `posts_user_internal_id_foreign` foreign key (`user_internal_id`) references `users` (`internal_id`)',
+        ], $blueprint->toSql($connection, new MySqlGrammar));
+    }
+
     public function testDropRelationshipColumnWithIncrementalModel()
     {
         $base = new Blueprint('posts', function ($table) {

tests/Database/Fixtures/Models/User.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Illuminate\Tests\Database\Fixtures\Models;
+
+use Illuminate\Foundation\Auth\User as FoundationUser;
+
+class User extends FoundationUser
+{
+    protected $primaryKey = 'internal_id';
+}