fix: improve error message

Author: kenjis

src/Models/UserIdentityModel.php

@@ -12,6 +12,7 @@
 use CodeIgniter\Shield\Entities\AccessToken;
 use CodeIgniter\Shield\Entities\User;
 use CodeIgniter\Shield\Entities\UserIdentity;
+use CodeIgniter\Shield\Exceptions\LogicException;
 use Faker\Generator;
 
 class UserIdentityModel extends Model
@@ -59,7 +60,7 @@ public function create($data): void
      */
     public function createEmailIdentity(User $user, array $credentials): void
     {
-        assert($user->id !== null, '"$user->id" must not be null.');
+        $this->checkUserId($user);
 
         /** @var Passwords $passwords */
         $passwords = service('passwords');
@@ -74,6 +75,15 @@ public function createEmailIdentity(User $user, array $credentials): void
         $this->checkQueryReturn($return);
     }
 
+    private function checkUserId(User $user): void
+    {
+        if ($user->id === null) {
+            throw new LogicException(
+                '"$user->id" is null. You should not use the incomplete User object.'
+            );
+        }
+    }
+
     /**
      * Create an identity with 6 digits code for auth action
      *
@@ -87,7 +97,7 @@ public function createCodeIdentity(
         array $data,
         callable $codeGenerator
     ): string {
-        assert($user->id !== null, '"$user->id" must not be null.');
+        $this->checkUserId($user);
 
         helper('text');
 
@@ -122,7 +132,7 @@ public function createCodeIdentity(
      */
     public function generateAccessToken(User $user, string $name, array $scopes = ['*']): AccessToken
     {
-        assert($user->id !== null, '"$user->id" must not be null.');
+        $this->checkUserId($user);
 
         helper('text');
 
@@ -157,7 +167,7 @@ public function getAccessTokenByRawToken(string $rawToken): ?AccessToken
 
     public function getAccessToken(User $user, string $rawToken): ?AccessToken
     {
-        assert($user->id !== null, '"$user->id" must not be null.');
+        $this->checkUserId($user);
 
         return $this->where('user_id', $user->id)
             ->where('type', AccessTokens::ID_TYPE_ACCESS_TOKEN)
@@ -173,7 +183,7 @@ public function getAccessToken(User $user, string $rawToken): ?AccessToken
      */
     public function getAccessTokenById($id, User $user): ?AccessToken
     {
-        assert($user->id !== null, '"$user->id" must not be null.');
+        $this->checkUserId($user);
 
         return $this->where('user_id', $user->id)
             ->where('type', AccessTokens::ID_TYPE_ACCESS_TOKEN)
@@ -187,7 +197,7 @@ public function getAccessTokenById($id, User $user): ?AccessToken
      */
     public function getAllAccessTokens(User $user): array
     {
-        assert($user->id !== null, '"$user->id" must not be null.');
+        $this->checkUserId($user);
 
         return $this
             ->where('user_id', $user->id)
@@ -218,7 +228,7 @@ public function getIdentityBySecret(string $type, ?string $secret): ?UserIdentit
      */
     public function getIdentities(User $user): array
     {
-        assert($user->id !== null, '"$user->id" must not be null.');
+        $this->checkUserId($user);
 
         return $this->where('user_id', $user->id)->orderBy($this->primaryKey)->findAll();
     }
@@ -238,7 +248,7 @@ public function getIdentitiesByUserIds(array $userIds): array
      */
     public function getIdentityByType(User $user, string $type): ?UserIdentity
     {
-        assert($user->id !== null, '"$user->id" must not be null.');
+        $this->checkUserId($user);
 
         return $this->where('user_id', $user->id)
             ->where('type', $type)
@@ -255,7 +265,7 @@ public function getIdentityByType(User $user, string $type): ?UserIdentity
      */
     public function getIdentitiesByTypes(User $user, array $types): array
     {
-        assert($user->id !== null, '"$user->id" must not be null.');
+        $this->checkUserId($user);
 
         if ($types === []) {
             return [];
@@ -281,7 +291,7 @@ public function touchIdentity(UserIdentity $identity): void
 
     public function deleteIdentitiesByType(User $user, string $type): void
     {
-        assert($user->id !== null, '"$user->id" must not be null.');
+        $this->checkUserId($user);
 
         $return = $this->where('user_id', $user->id)
             ->where('type', $type)
@@ -295,7 +305,7 @@ public function deleteIdentitiesByType(User $user, string $type): void
      */
     public function revokeAccessToken(User $user, string $rawToken): void
     {
-        assert($user->id !== null, '"$user->id" must not be null.');
+        $this->checkUserId($user);
 
         $return = $this->where('user_id', $user->id)
             ->where('type', AccessTokens::ID_TYPE_ACCESS_TOKEN)
@@ -310,7 +320,7 @@ public function revokeAccessToken(User $user, string $rawToken): void
      */
     public function revokeAllAccessTokens(User $user): void
     {
-        assert($user->id !== null, '"$user->id" must not be null.');
+        $this->checkUserId($user);
 
         $return = $this->where('user_id', $user->id)
             ->where('type', AccessTokens::ID_TYPE_ACCESS_TOKEN)