feat(cleanup): add command for sanitizing name fields across models

- Introduced `CleanupNames` command to sanitize name fields by removing invalid characters, ensuring only letters, numbers, spaces, dashes, underscores, and dots are retained.
- Implemented options for dry run, model-specific cleaning, database backup, and forced execution.
- Updated `Init` command to call the new `cleanup:names` command.
- Enhanced project and environment validation to enforce name sanitization rules.
- Added `HasSafeNameAttribute` trait to relevant models for consistent name handling.
This commit is contained in:
Andras Bacsai
2025-08-19 11:04:23 +02:00
parent 6727fd958f
commit e958b3761d
28 changed files with 364 additions and 26 deletions

View File

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

View File

@@ -2,6 +2,7 @@
namespace App\Models;
use App\Traits\HasSafeNameAttribute;
use Illuminate\Database\Eloquent\Casts\Attribute;
use OpenApi\Attributes as OA;
@@ -19,6 +20,8 @@ use OpenApi\Attributes as OA;
)]
class Environment extends BaseModel
{
use HasSafeNameAttribute;
protected $guarded = [];
protected static function booted()

View File

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

View File

@@ -2,6 +2,7 @@
namespace App\Models;
use App\Traits\HasSafeNameAttribute;
use OpenApi\Attributes as OA;
use Visus\Cuid2\Cuid2;
@@ -23,6 +24,8 @@ use Visus\Cuid2\Cuid2;
)]
class Project extends BaseModel
{
use HasSafeNameAttribute;
protected $guarded = [];
public static function ownedByCurrentTeam()

View File

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

View File

@@ -2,11 +2,14 @@
namespace App\Models;
use App\Traits\HasSafeNameAttribute;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\HasOne;
class ScheduledTask extends BaseModel
{
use HasSafeNameAttribute;
protected $guarded = [];
public function service()

View File

@@ -13,6 +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 Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Factories\HasFactory;
@@ -164,6 +165,8 @@ class Server extends BaseModel
protected $guarded = [];
use HasSafeNameAttribute;
public function type()
{
return 'server';

View File

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

View File

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

View File

@@ -2,8 +2,12 @@
namespace App\Models;
use App\Traits\HasSafeNameAttribute;
class StandaloneDocker extends BaseModel
{
use HasSafeNameAttribute;
protected $guarded = [];
protected static function boot()

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -2,13 +2,14 @@
namespace App\Models;
use App\Traits\HasSafeNameAttribute;
use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\SoftDeletes;
class StandalonePostgresql extends BaseModel
{
use HasFactory, SoftDeletes;
use HasFactory, HasSafeNameAttribute, SoftDeletes;
protected $guarded = [];
@@ -322,7 +323,7 @@ class StandalonePostgresql extends BaseModel
$parsedCollection = collect($metrics)->map(function ($metric) {
return [
(int) $metric['time'],
(float) ($metric['percent'] ?? 0.0)
(float) ($metric['percent'] ?? 0.0),
];
});

View File

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

View File

@@ -2,10 +2,13 @@
namespace App\Models;
use App\Traits\HasSafeNameAttribute;
use Illuminate\Database\Eloquent\Casts\Attribute;
class Tag extends BaseModel
{
use HasSafeNameAttribute;
protected $guarded = [];
public function name(): Attribute

View File

@@ -8,6 +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 Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Notifications\Notifiable;
@@ -36,7 +37,7 @@ use OpenApi\Attributes as OA;
class Team extends Model implements SendsDiscord, SendsEmail, SendsPushover, SendsSlack
{
use HasNotificationSettings, Notifiable;
use HasNotificationSettings, HasSafeNameAttribute, Notifiable;
protected $guarded = [];