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
144 lines
5.0 KiB
PHP
144 lines
5.0 KiB
PHP
<?php
|
|
|
|
use App\Filament\Resources\BulkOperationRunResource;
|
|
use App\Jobs\GenerateDriftFindingsJob;
|
|
use App\Models\BulkOperationRun;
|
|
use App\Models\InventorySyncRun;
|
|
use App\Notifications\RunStatusChangedNotification;
|
|
use App\Services\BulkOperationService;
|
|
use App\Services\Drift\DriftFindingGenerator;
|
|
use Mockery\MockInterface;
|
|
|
|
test('drift generation job sends completion notification with view link', function () {
|
|
[$user, $tenant] = createUserWithTenant(role: 'manager');
|
|
|
|
$scopeKey = hash('sha256', 'scope-job-notification-success');
|
|
|
|
$baseline = InventorySyncRun::factory()->for($tenant)->create([
|
|
'selection_hash' => $scopeKey,
|
|
'status' => InventorySyncRun::STATUS_SUCCESS,
|
|
'finished_at' => now()->subDays(2),
|
|
]);
|
|
|
|
$current = InventorySyncRun::factory()->for($tenant)->create([
|
|
'selection_hash' => $scopeKey,
|
|
'status' => InventorySyncRun::STATUS_SUCCESS,
|
|
'finished_at' => now()->subDay(),
|
|
]);
|
|
|
|
$run = BulkOperationRun::factory()->create([
|
|
'tenant_id' => $tenant->getKey(),
|
|
'user_id' => $user->getKey(),
|
|
'resource' => 'drift',
|
|
'action' => 'generate',
|
|
'status' => 'pending',
|
|
'total_items' => 1,
|
|
'processed_items' => 0,
|
|
'succeeded' => 0,
|
|
'failed' => 0,
|
|
'skipped' => 0,
|
|
'failures' => [],
|
|
]);
|
|
|
|
$this->mock(DriftFindingGenerator::class, function (MockInterface $mock) {
|
|
$mock->shouldReceive('generate')->once()->andReturn(0);
|
|
});
|
|
|
|
$job = new GenerateDriftFindingsJob(
|
|
tenantId: (int) $tenant->getKey(),
|
|
userId: (int) $user->getKey(),
|
|
baselineRunId: (int) $baseline->getKey(),
|
|
currentRunId: (int) $current->getKey(),
|
|
scopeKey: $scopeKey,
|
|
bulkOperationRunId: (int) $run->getKey(),
|
|
);
|
|
|
|
$job->handle(app(DriftFindingGenerator::class), app(BulkOperationService::class));
|
|
|
|
expect($run->refresh()->status)->toBe('completed');
|
|
|
|
$this->assertDatabaseHas('notifications', [
|
|
'notifiable_id' => $user->getKey(),
|
|
'notifiable_type' => $user->getMorphClass(),
|
|
'type' => RunStatusChangedNotification::class,
|
|
]);
|
|
|
|
$notification = $user->notifications()->latest('id')->first();
|
|
expect($notification)->not->toBeNull();
|
|
expect($notification->data['actions'][0]['url'] ?? null)
|
|
->toBe(BulkOperationRunResource::getUrl('view', ['record' => $run->getKey()], tenant: $tenant));
|
|
});
|
|
|
|
test('drift generation job sends failure notification with view link', function () {
|
|
[$user, $tenant] = createUserWithTenant(role: 'manager');
|
|
|
|
$scopeKey = hash('sha256', 'scope-job-notification-failure');
|
|
|
|
$baseline = InventorySyncRun::factory()->for($tenant)->create([
|
|
'selection_hash' => $scopeKey,
|
|
'status' => InventorySyncRun::STATUS_SUCCESS,
|
|
'finished_at' => now()->subDays(2),
|
|
]);
|
|
|
|
$current = InventorySyncRun::factory()->for($tenant)->create([
|
|
'selection_hash' => $scopeKey,
|
|
'status' => InventorySyncRun::STATUS_SUCCESS,
|
|
'finished_at' => now()->subDay(),
|
|
]);
|
|
|
|
$run = BulkOperationRun::factory()->create([
|
|
'tenant_id' => $tenant->getKey(),
|
|
'user_id' => $user->getKey(),
|
|
'resource' => 'drift',
|
|
'action' => 'generate',
|
|
'status' => 'pending',
|
|
'total_items' => 1,
|
|
'processed_items' => 0,
|
|
'succeeded' => 0,
|
|
'failed' => 0,
|
|
'skipped' => 0,
|
|
'failures' => [],
|
|
]);
|
|
|
|
$this->mock(DriftFindingGenerator::class, function (MockInterface $mock) {
|
|
$mock->shouldReceive('generate')->once()->andThrow(new RuntimeException('boom'));
|
|
});
|
|
|
|
$job = new GenerateDriftFindingsJob(
|
|
tenantId: (int) $tenant->getKey(),
|
|
userId: (int) $user->getKey(),
|
|
baselineRunId: (int) $baseline->getKey(),
|
|
currentRunId: (int) $current->getKey(),
|
|
scopeKey: $scopeKey,
|
|
bulkOperationRunId: (int) $run->getKey(),
|
|
);
|
|
|
|
try {
|
|
$job->handle(app(DriftFindingGenerator::class), app(BulkOperationService::class));
|
|
} catch (RuntimeException) {
|
|
// Expected.
|
|
}
|
|
|
|
$run->refresh();
|
|
|
|
expect($run->status)->toBe('failed')
|
|
->and($run->processed_items)->toBe(1)
|
|
->and($run->failed)->toBe(1)
|
|
->and($run->failures)->toBeArray()
|
|
->and($run->failures)->toHaveCount(1)
|
|
->and($run->failures[0]['item_id'] ?? null)->toBe($scopeKey)
|
|
->and($run->failures[0]['reason_code'] ?? null)->toBe('unknown')
|
|
->and($run->failures[0]['reason'] ?? null)->toBe('boom');
|
|
|
|
$this->assertDatabaseHas('notifications', [
|
|
'notifiable_id' => $user->getKey(),
|
|
'notifiable_type' => $user->getMorphClass(),
|
|
'type' => RunStatusChangedNotification::class,
|
|
]);
|
|
|
|
$notification = $user->notifications()->latest('id')->first();
|
|
expect($notification)->not->toBeNull();
|
|
expect($notification->data['actions'][0]['url'] ?? null)
|
|
->toBe(BulkOperationRunResource::getUrl('view', ['record' => $run->getKey()], tenant: $tenant));
|
|
});
|