Summary This PR introduces Unified Operations Runs + Monitoring Hub (053). Goal: Standardize how long-running operations are tracked and monitored using the existing tenant-scoped run record (BulkOperationRun) as the canonical “operation run”, and surface it in a single Monitoring → Operations hub (view-only, tenant-scoped, role-aware). Phase 1 adoption scope (per spec): • Drift generation (drift.generate) • Backup Set “Add Policies” (backup_set.add_policies) Note: This PR does not convert every run type yet (e.g. GroupSyncRuns / InventorySyncRuns remain separate for now). This is intentionally incremental. ⸻ What changed Monitoring / Operations hub • Moved/organized run monitoring under Monitoring → Operations • Added: • status buckets (queued / running / succeeded / partially succeeded / failed) • filters (run type, status bucket, time range) • run detail “Related” links (e.g. Drift findings, Backup Set context) • All hub pages are DB-only and view-only (no rerun/cancel/delete actions) Canonical run semantics • Added canonical helpers on BulkOperationRun: • runType() (resource.action) • statusBucket() derived from status + counts (testable semantics) Drift integration (Phase 1) • Drift generation start behavior now: • creates/reuses a BulkOperationRun with drift context payload (scope_key + baseline/current run ids) • dispatches generation job • emits DB notifications including “View run” link • On generation failure: stores sanitized failure entries + sends failure notification Permissions / tenant isolation • Monitoring run list/view is tenant-scoped and returns 403 for cross-tenant access • Readonly can view runs but cannot start drift generation ⸻ Tests Added/updated Pest coverage: • BulkOperationRunStatusBucketTest.php • DriftGenerationDispatchTest.php • GenerateDriftFindingsJobNotificationTest.php • RunAuthorizationTenantIsolationTest.php Validation run locally: • ./vendor/bin/pint --dirty • targeted tests from feature quickstart / drift monitoring tests ⸻ Manual QA 1. Go to Monitoring → Operations • verify filters (run type / status / time range) • verify run detail shows counts + sanitized failures + “Related” links 2. Open Drift Landing • with >=2 successful inventory runs for scope: should queue drift generation + show notification with “View run” • as readonly: should not start generation 3. Run detail • drift.generate runs show “Drift findings” related link • failure entries are sanitized (no secrets/tokens/raw payload dumps) ⸻ Notes / Ops • Queue workers must be restarted after deploy so they load the new code: • php artisan queue:restart (or Sail equivalent) • This PR standardizes monitoring for Phase 1 producers only; follow-ups will migrate additional run types into the unified pattern. ⸻ Spec / Docs • SpecKit artifacts added under specs/053-unify-runs-monitoring/ • Checklists are complete: • requirements checklist PASS • writing checklist PASS Co-authored-by: Ahmed Darrazi <ahmeddarrazi@adsmac.local> Reviewed-on: #60
105 lines
2.4 KiB
PHP
105 lines
2.4 KiB
PHP
<?php
|
|
|
|
namespace App\Models;
|
|
|
|
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
|
use Illuminate\Database\Eloquent\Model;
|
|
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
|
|
|
class BulkOperationRun extends Model
|
|
{
|
|
use HasFactory;
|
|
|
|
protected $fillable = [
|
|
'tenant_id',
|
|
'user_id',
|
|
'resource',
|
|
'action',
|
|
'idempotency_key',
|
|
'status',
|
|
'total_items',
|
|
'processed_items',
|
|
'succeeded',
|
|
'failed',
|
|
'skipped',
|
|
'item_ids',
|
|
'failures',
|
|
'audit_log_id',
|
|
];
|
|
|
|
protected $casts = [
|
|
'item_ids' => 'array',
|
|
'failures' => 'array',
|
|
'processed_items' => 'integer',
|
|
'total_items' => 'integer',
|
|
'succeeded' => 'integer',
|
|
'failed' => 'integer',
|
|
'skipped' => 'integer',
|
|
];
|
|
|
|
public function tenant(): BelongsTo
|
|
{
|
|
return $this->belongsTo(Tenant::class);
|
|
}
|
|
|
|
public function user(): BelongsTo
|
|
{
|
|
return $this->belongsTo(User::class);
|
|
}
|
|
|
|
public function auditLog(): BelongsTo
|
|
{
|
|
return $this->belongsTo(AuditLog::class);
|
|
}
|
|
|
|
public function runType(): string
|
|
{
|
|
return "{$this->resource}.{$this->action}";
|
|
}
|
|
|
|
public function statusBucket(): string
|
|
{
|
|
$status = $this->status;
|
|
|
|
if ($status === 'pending') {
|
|
return 'queued';
|
|
}
|
|
|
|
if ($status === 'running') {
|
|
return 'running';
|
|
}
|
|
|
|
$succeededCount = (int) ($this->succeeded ?? 0);
|
|
$failedCount = (int) ($this->failed ?? 0);
|
|
$failureEntries = $this->failures ?? [];
|
|
$hasNonSkippedFailure = false;
|
|
|
|
foreach ($failureEntries as $entry) {
|
|
if (! is_array($entry)) {
|
|
continue;
|
|
}
|
|
|
|
if (($entry['type'] ?? 'failed') !== 'skipped') {
|
|
$hasNonSkippedFailure = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
$hasFailures = $failedCount > 0 || $hasNonSkippedFailure;
|
|
|
|
if ($succeededCount > 0 && $hasFailures) {
|
|
return 'partially succeeded';
|
|
}
|
|
|
|
if ($succeededCount === 0 && $hasFailures) {
|
|
return 'failed';
|
|
}
|
|
|
|
return match ($status) {
|
|
'completed', 'completed_with_errors' => 'succeeded',
|
|
'failed', 'aborted' => 'failed',
|
|
default => 'failed',
|
|
};
|
|
}
|
|
}
|