[13.x] Use unique IDs on client model (#1757)

* [13.x] Use unique ids on client model

* drop support for Laravel 9.x

* wip

Author: hafezdivandari

.github/workflows/tests.yml

@@ -17,12 +17,10 @@ jobs:
       fail-fast: true
       matrix:
         php: [8.1, 8.2, 8.3]
-        laravel: [9, 10, 11]
+        laravel: [10, 11]
         exclude:
           - php: 8.1
             laravel: 11
-          - php: 8.3
-            laravel: 9
 
     name: PHP ${{ matrix.php }} - Laravel ${{ matrix.laravel }}
 

UPGRADE.md

@@ -10,6 +10,12 @@ PR: https://github.com/laravel/passport/pull/1734
 
 PHP 8.1 is now the minimum required version.
 
+### Minimum Laravel Version
+
+PR: https://github.com/laravel/passport/pull/1757
+
+Laravel 10.0 is now the minimum required version.
+
 ### OAuth2 Server
 
 PR: https://github.com/laravel/passport/pull/1734

composer.json

@@ -18,15 +18,15 @@
         "ext-json": "*",
         "ext-openssl": "*",
         "firebase/php-jwt": "^6.4",
-        "illuminate/auth": "^9.21|^10.0|^11.0",
-        "illuminate/console": "^9.21|^10.0|^11.0",
-        "illuminate/container": "^9.21|^10.0|^11.0",
-        "illuminate/contracts": "^9.21|^10.0|^11.0",
-        "illuminate/cookie": "^9.21|^10.0|^11.0",
-        "illuminate/database": "^9.21|^10.0|^11.0",
-        "illuminate/encryption": "^9.21|^10.0|^11.0",
-        "illuminate/http": "^9.21|^10.0|^11.0",
-        "illuminate/support": "^9.21|^10.0|^11.0",
+        "illuminate/auth": "^10.0|^11.0",
+        "illuminate/console": "^10.0|^11.0",
+        "illuminate/container": "^10.0|^11.0",
+        "illuminate/contracts": "^10.0|^11.0",
+        "illuminate/cookie": "^10.0|^11.0",
+        "illuminate/database": "^10.0|^11.0",
+        "illuminate/encryption": "^10.0|^11.0",
+        "illuminate/http": "^10.0|^11.0",
+        "illuminate/support": "^10.0|^11.0",
         "lcobucci/jwt": "^5.0",
         "league/oauth2-server": "^9.0",
         "nyholm/psr7": "^1.5",

database/factories/ClientFactory.php

@@ -28,32 +28,15 @@ public function modelName()
      */
     public function definition()
     {
-        return $this->ensurePrimaryKeyIsSet([
+        return [
             'user_id' => null,
             'name' => $this->faker->company(),
             'secret' => Str::random(40),
             'redirect' => $this->faker->url(),
             'personal_access_client' => false,
             'password_client' => false,
             'revoked' => false,
-        ]);
-    }
-
-    /**
-     * Ensure the primary key is set on the model when using UUIDs.
-     *
-     * @param  array  $data
-     * @return array
-     */
-    protected function ensurePrimaryKeyIsSet(array $data)
-    {
-        if (Passport::clientUuids()) {
-            $keyName = (new ($this->modelName()))->getKeyName();
-
-            $data[$keyName] = (string) Str::orderedUuid();
-        }
-
-        return $data;
+        ];
     }
 
     /**

src/Client.php

@@ -59,19 +59,16 @@ class Client extends Model
     public $plainSecret;
 
     /**
-     * Bootstrap the model and its traits.
+     * Create a new Eloquent model instance.
      *
+     * @param  array  $attributes
      * @return void
      */
-    public static function boot()
+    public function __construct(array $attributes = [])
     {
-        parent::boot();
+        parent::__construct($attributes);
 
-        static::creating(function ($model) {
-            if (Passport::clientUuids()) {
-                $model->{$model->getKeyName()} = $model->{$model->getKeyName()} ?: (string) Str::orderedUuid();
-            }
-        });
+        $this->usesUniqueIds = Passport::clientUuids();
     }
 
     /**
@@ -205,6 +202,26 @@ public function confidential()
         return ! empty($this->secret);
     }
 
+    /**
+     * Get the columns that should receive a unique identifier.
+     *
+     * @return array
+     */
+    public function uniqueIds()
+    {
+        return Passport::clientUuids() ? [$this->getKeyName()] : [];
+    }
+
+    /**
+     * Generate a new key for the model.
+     *
+     * @return string
+     */
+    public function newUniqueId()
+    {
+        return Passport::clientUuids() ? (string) Str::orderedUuid() : null;
+    }
+
     /**
      * Get the auto-incrementing key type.
      *