feat(validation): centralize validation patterns for names and descriptions

- Introduced `ValidationPatterns` class to standardize validation rules and messages for name and description fields across the application.
- Updated various components and models to utilize the new validation patterns, ensuring consistent sanitization and validation logic.
- Replaced the `HasSafeNameAttribute` trait with `HasSafeStringAttribute` to enhance attribute handling and maintain consistency in name sanitization.
- Enhanced the `CleanupNames` command to align with the new validation rules, allowing for a broader range of valid characters in names.
This commit is contained in:
Andras Bacsai
2025-08-19 12:14:48 +02:00
parent 0bb9ee4327
commit 38c0641734
30 changed files with 238 additions and 132 deletions

View File

@@ -5,7 +5,7 @@ namespace App\Models;
use App\Enums\ApplicationDeploymentStatus;
use App\Services\ConfigurationGenerator;
use App\Traits\HasConfiguration;
use App\Traits\HasSafeNameAttribute;
use App\Traits\HasSafeStringAttribute;
use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Relations\HasMany;
@@ -110,7 +110,7 @@ use Visus\Cuid2\Cuid2;
class Application extends BaseModel
{
use HasConfiguration, HasFactory, HasSafeNameAttribute, SoftDeletes;
use HasConfiguration, HasFactory, HasSafeStringAttribute, SoftDeletes;
private static $parserVersion = '5';

View File

@@ -2,8 +2,7 @@
namespace App\Models;
use App\Traits\HasSafeNameAttribute;
use Illuminate\Database\Eloquent\Casts\Attribute;
use App\Traits\HasSafeStringAttribute;
use OpenApi\Attributes as OA;
#[OA\Schema(
@@ -20,7 +19,7 @@ use OpenApi\Attributes as OA;
)]
class Environment extends BaseModel
{
use HasSafeNameAttribute;
use HasSafeStringAttribute;
protected $guarded = [];
@@ -122,10 +121,8 @@ class Environment extends BaseModel
return $this->hasMany(Service::class);
}
protected function name(): Attribute
protected function customizeName($value)
{
return Attribute::make(
set: fn (string $value) => str($value)->lower()->trim()->replace('/', '-')->toString(),
);
return str($value)->lower()->trim()->replace('/', '-')->toString();
}
}

View File

@@ -24,11 +24,9 @@ class LocalPersistentVolume extends Model
return $this->morphTo('resource');
}
protected function name(): Attribute
protected function customizeName($value)
{
return Attribute::make(
set: fn (string $value) => str($value)->trim()->value,
);
return str($value)->trim()->value;
}
protected function mountPath(): Attribute

View File

@@ -2,7 +2,7 @@
namespace App\Models;
use App\Traits\HasSafeNameAttribute;
use App\Traits\HasSafeStringAttribute;
use DanHarrin\LivewireRateLimiting\WithRateLimiting;
use Illuminate\Support\Facades\Storage;
use Illuminate\Validation\ValidationException;
@@ -28,7 +28,7 @@ use phpseclib3\Crypt\PublicKeyLoader;
)]
class PrivateKey extends BaseModel
{
use HasSafeNameAttribute, WithRateLimiting;
use HasSafeStringAttribute, WithRateLimiting;
protected $fillable = [
'name',

View File

@@ -2,7 +2,7 @@
namespace App\Models;
use App\Traits\HasSafeNameAttribute;
use App\Traits\HasSafeStringAttribute;
use OpenApi\Attributes as OA;
use Visus\Cuid2\Cuid2;
@@ -24,7 +24,7 @@ use Visus\Cuid2\Cuid2;
)]
class Project extends BaseModel
{
use HasSafeNameAttribute;
use HasSafeStringAttribute;
protected $guarded = [];

View File

@@ -2,14 +2,14 @@
namespace App\Models;
use App\Traits\HasSafeNameAttribute;
use App\Traits\HasSafeStringAttribute;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Notifications\Messages\MailMessage;
use Illuminate\Support\Facades\Storage;
class S3Storage extends BaseModel
{
use HasFactory, HasSafeNameAttribute;
use HasFactory, HasSafeStringAttribute;
protected $guarded = [];

View File

@@ -2,13 +2,13 @@
namespace App\Models;
use App\Traits\HasSafeNameAttribute;
use App\Traits\HasSafeStringAttribute;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\HasOne;
class ScheduledTask extends BaseModel
{
use HasSafeNameAttribute;
use HasSafeStringAttribute;
protected $guarded = [];

View File

@@ -13,7 +13,7 @@ use App\Jobs\RegenerateSslCertJob;
use App\Notifications\Server\Reachable;
use App\Notifications\Server\Unreachable;
use App\Services\ConfigurationRepository;
use App\Traits\HasSafeNameAttribute;
use App\Traits\HasSafeStringAttribute;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Factories\HasFactory;
@@ -165,7 +165,7 @@ class Server extends BaseModel
protected $guarded = [];
use HasSafeNameAttribute;
use HasSafeStringAttribute;
public function type()
{

View File

@@ -3,7 +3,7 @@
namespace App\Models;
use App\Enums\ProcessStatus;
use App\Traits\HasSafeNameAttribute;
use App\Traits\HasSafeStringAttribute;
use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Relations\HasMany;
@@ -41,7 +41,7 @@ use Visus\Cuid2\Cuid2;
)]
class Service extends BaseModel
{
use HasFactory, HasSafeNameAttribute, SoftDeletes;
use HasFactory, HasSafeStringAttribute, SoftDeletes;
private static $parserVersion = '5';

View File

@@ -2,14 +2,14 @@
namespace App\Models;
use App\Traits\HasSafeNameAttribute;
use App\Traits\HasSafeStringAttribute;
use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\SoftDeletes;
class StandaloneClickhouse extends BaseModel
{
use HasFactory, HasSafeNameAttribute, SoftDeletes;
use HasFactory, HasSafeStringAttribute, SoftDeletes;
protected $guarded = [];

View File

@@ -2,11 +2,11 @@
namespace App\Models;
use App\Traits\HasSafeNameAttribute;
use App\Traits\HasSafeStringAttribute;
class StandaloneDocker extends BaseModel
{
use HasSafeNameAttribute;
use HasSafeStringAttribute;
protected $guarded = [];

View File

@@ -2,14 +2,14 @@
namespace App\Models;
use App\Traits\HasSafeNameAttribute;
use App\Traits\HasSafeStringAttribute;
use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\SoftDeletes;
class StandaloneDragonfly extends BaseModel
{
use HasFactory, HasSafeNameAttribute, SoftDeletes;
use HasFactory, HasSafeStringAttribute, SoftDeletes;
protected $guarded = [];

View File

@@ -2,14 +2,14 @@
namespace App\Models;
use App\Traits\HasSafeNameAttribute;
use App\Traits\HasSafeStringAttribute;
use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\SoftDeletes;
class StandaloneKeydb extends BaseModel
{
use HasFactory, HasSafeNameAttribute, SoftDeletes;
use HasFactory, HasSafeStringAttribute, SoftDeletes;
protected $guarded = [];

View File

@@ -2,7 +2,7 @@
namespace App\Models;
use App\Traits\HasSafeNameAttribute;
use App\Traits\HasSafeStringAttribute;
use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Relations\MorphTo;
@@ -10,7 +10,7 @@ use Illuminate\Database\Eloquent\SoftDeletes;
class StandaloneMariadb extends BaseModel
{
use HasFactory, HasSafeNameAttribute, SoftDeletes;
use HasFactory, HasSafeStringAttribute, SoftDeletes;
protected $guarded = [];

View File

@@ -2,14 +2,14 @@
namespace App\Models;
use App\Traits\HasSafeNameAttribute;
use App\Traits\HasSafeStringAttribute;
use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\SoftDeletes;
class StandaloneMongodb extends BaseModel
{
use HasFactory, HasSafeNameAttribute, SoftDeletes;
use HasFactory, HasSafeStringAttribute, SoftDeletes;
protected $guarded = [];

View File

@@ -2,14 +2,14 @@
namespace App\Models;
use App\Traits\HasSafeNameAttribute;
use App\Traits\HasSafeStringAttribute;
use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\SoftDeletes;
class StandaloneMysql extends BaseModel
{
use HasFactory, HasSafeNameAttribute, SoftDeletes;
use HasFactory, HasSafeStringAttribute, SoftDeletes;
protected $guarded = [];

View File

@@ -2,14 +2,14 @@
namespace App\Models;
use App\Traits\HasSafeNameAttribute;
use App\Traits\HasSafeStringAttribute;
use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\SoftDeletes;
class StandalonePostgresql extends BaseModel
{
use HasFactory, HasSafeNameAttribute, SoftDeletes;
use HasFactory, HasSafeStringAttribute, SoftDeletes;
protected $guarded = [];

View File

@@ -2,14 +2,14 @@
namespace App\Models;
use App\Traits\HasSafeNameAttribute;
use App\Traits\HasSafeStringAttribute;
use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\SoftDeletes;
class StandaloneRedis extends BaseModel
{
use HasFactory, HasSafeNameAttribute, SoftDeletes;
use HasFactory, HasSafeStringAttribute, SoftDeletes;
protected $guarded = [];

View File

@@ -2,21 +2,17 @@
namespace App\Models;
use App\Traits\HasSafeNameAttribute;
use Illuminate\Database\Eloquent\Casts\Attribute;
use App\Traits\HasSafeStringAttribute;
class Tag extends BaseModel
{
use HasSafeNameAttribute;
use HasSafeStringAttribute;
protected $guarded = [];
public function name(): Attribute
protected function customizeName($value)
{
return Attribute::make(
get: fn ($value) => strtolower($value),
set: fn ($value) => strtolower($value)
);
return strtolower($value);
}
public static function ownedByCurrentTeam()

View File

@@ -8,7 +8,7 @@ use App\Notifications\Channels\SendsEmail;
use App\Notifications\Channels\SendsPushover;
use App\Notifications\Channels\SendsSlack;
use App\Traits\HasNotificationSettings;
use App\Traits\HasSafeNameAttribute;
use App\Traits\HasSafeStringAttribute;
use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Notifications\Notifiable;
@@ -37,7 +37,7 @@ use OpenApi\Attributes as OA;
class Team extends Model implements SendsDiscord, SendsEmail, SendsPushover, SendsSlack
{
use HasNotificationSettings, HasSafeNameAttribute, Notifiable;
use HasNotificationSettings, HasSafeStringAttribute, Notifiable;
protected $guarded = [];