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
117 lines
3.8 KiB
PHP
117 lines
3.8 KiB
PHP
<?php
|
|
|
|
namespace App\Notifications;
|
|
|
|
use App\Filament\Resources\BulkOperationRunResource;
|
|
use App\Filament\Resources\EntraGroupSyncRunResource;
|
|
use App\Filament\Resources\RestoreRunResource;
|
|
use App\Models\Tenant;
|
|
use Filament\Actions\Action;
|
|
use Illuminate\Notifications\Notification;
|
|
|
|
class RunStatusChangedNotification extends Notification
|
|
{
|
|
/**
|
|
* @param array{
|
|
* tenant_id:int,
|
|
* run_type:string,
|
|
* run_id:int,
|
|
* status:string,
|
|
* counts?:array{total?:int, processed?:int, succeeded?:int, failed?:int, skipped?:int}
|
|
* } $metadata
|
|
*/
|
|
public function __construct(public array $metadata) {}
|
|
|
|
/**
|
|
* @return array<int, string>
|
|
*/
|
|
public function via(object $notifiable): array
|
|
{
|
|
return ['database'];
|
|
}
|
|
|
|
/**
|
|
* @return array<string, mixed>
|
|
*/
|
|
public function toDatabase(object $notifiable): array
|
|
{
|
|
$status = (string) ($this->metadata['status'] ?? 'queued');
|
|
$runType = (string) ($this->metadata['run_type'] ?? 'run');
|
|
$tenantId = (int) ($this->metadata['tenant_id'] ?? 0);
|
|
$runId = (int) ($this->metadata['run_id'] ?? 0);
|
|
|
|
$title = match ($status) {
|
|
'queued' => 'Run queued',
|
|
'running' => 'Run started',
|
|
'completed', 'succeeded' => 'Run completed',
|
|
'partial', 'partially succeeded', 'completed_with_errors' => 'Run completed (partial)',
|
|
'failed' => 'Run failed',
|
|
default => 'Run updated',
|
|
};
|
|
|
|
$body = sprintf('A %s run changed status to: %s.', str_replace('_', ' ', $runType), $status);
|
|
|
|
$color = match ($status) {
|
|
'queued', 'running' => 'gray',
|
|
'completed', 'succeeded' => 'success',
|
|
'partial', 'partially succeeded', 'completed_with_errors' => 'warning',
|
|
'failed' => 'danger',
|
|
default => 'gray',
|
|
};
|
|
|
|
$actions = [];
|
|
|
|
if (in_array($runType, ['bulk_operation', 'restore', 'directory_groups'], true) && $tenantId > 0 && $runId > 0) {
|
|
$tenant = Tenant::query()->find($tenantId);
|
|
|
|
if ($tenant) {
|
|
$url = match ($runType) {
|
|
'bulk_operation' => BulkOperationRunResource::getUrl('view', ['record' => $runId], tenant: $tenant),
|
|
'restore' => RestoreRunResource::getUrl('view', ['record' => $runId], tenant: $tenant),
|
|
'directory_groups' => EntraGroupSyncRunResource::getUrl('view', ['record' => $runId], tenant: $tenant),
|
|
default => null,
|
|
};
|
|
|
|
if (! $url) {
|
|
return [
|
|
'format' => 'filament',
|
|
'title' => $title,
|
|
'body' => $body,
|
|
'color' => $color,
|
|
'duration' => 'persistent',
|
|
'actions' => [],
|
|
'icon' => null,
|
|
'iconColor' => null,
|
|
'status' => null,
|
|
'view' => null,
|
|
'viewData' => [
|
|
'metadata' => $this->metadata,
|
|
],
|
|
];
|
|
}
|
|
|
|
$actions[] = Action::make('view_run')
|
|
->label('View run')
|
|
->url($url)
|
|
->toArray();
|
|
}
|
|
}
|
|
|
|
return [
|
|
'format' => 'filament',
|
|
'title' => $title,
|
|
'body' => $body,
|
|
'color' => $color,
|
|
'duration' => 'persistent',
|
|
'actions' => $actions,
|
|
'icon' => null,
|
|
'iconColor' => null,
|
|
'status' => null,
|
|
'view' => null,
|
|
'viewData' => [
|
|
'metadata' => $this->metadata,
|
|
],
|
|
];
|
|
}
|
|
}
|