Summary Kurz: Implementiert Feature 054 — canonical OperationRun-flow, Monitoring UI, dispatch-safety, notifications, dedupe, plus small UX safety clarifications (RBAC group search delegated; Restore group mapping DB-only). What Changed Core service: OperationRun lifecycle, dedupe and dispatch helpers — OperationRunService.php. Model + migration: OperationRun model and migration — OperationRun.php, 2026_01_16_180642_create_operation_runs_table.php. Notifications: queued + terminal DB notifications (initiator-only) — OperationRunQueued.php, OperationRunCompleted.php. Monitoring UI: Filament list/detail + Livewire pieces (DB-only render) — OperationRunResource.php and related pages/views. Start surfaces / Jobs: instrumented start surfaces, job middleware, and job updates to use canonical runs — multiple app/Jobs/* and app/Filament/* updates (see tests for full coverage). RBAC + Restore UX clarifications: RBAC group search is delegated-Graph-based and disabled without delegated token; Restore group mapping remains DB-only (directory cache) and helper text always visible — TenantResource.php, RestoreRunResource.php. Specs / Constitution: updated spec & quickstart and added one-line constitution guideline about Graph usage: spec.md quickstart.md constitution.md Tests & Verification Unit / Feature tests added/updated for run lifecycle, notifications, idempotency, and UI guards: see tests/Feature/* (notably OperationRunServiceTest, MonitoringOperationsTest, OperationRunNotificationTest, and various Filament feature tests). Full test run locally: ./vendor/bin/sail artisan test → 587 passed, 5 skipped. Migrations Adds create_operation_runs_table migration; run php artisan migrate in staging after review. Notes / Rationale Monitoring pages are explicitly DB-only at render time (no Graph calls). Start surfaces enqueue work only and return a “View run” link. Delegated Graph access is used only for explicit user actions (RBAC group search); restore mapping intentionally uses cached DB data only to avoid render-time Graph calls. Dispatch wrapper marks runs failed immediately if background dispatch throws synchronously to avoid misleading “queued” states. Upgrade / Deploy Considerations Run migrations: ./vendor/bin/sail artisan migrate. Background workers should be running to process queued jobs (recommended to monitor queue health during rollout). No secret or token persistence changes. PR checklist Tests updated/added for changed behavior Specs updated: 054-unify-runs-suitewide docs + quickstart Constitution note added (.specify) Pint formatting applied Co-authored-by: Ahmed Darrazi <ahmeddarrazi@adsmac.local> Reviewed-on: #63
179 lines
6.2 KiB
PHP
179 lines
6.2 KiB
PHP
<?php
|
|
|
|
namespace App\Jobs;
|
|
|
|
use App\Jobs\Middleware\TrackOperationRun;
|
|
use App\Models\EntraGroupSyncRun;
|
|
use App\Models\OperationRun;
|
|
use App\Models\Tenant;
|
|
use App\Services\Directory\EntraGroupSyncService;
|
|
use App\Services\Intune\AuditLogger;
|
|
use App\Services\OperationRunService;
|
|
use Carbon\CarbonImmutable;
|
|
use Illuminate\Bus\Queueable;
|
|
use Illuminate\Contracts\Queue\ShouldQueue;
|
|
use Illuminate\Foundation\Bus\Dispatchable;
|
|
use Illuminate\Queue\InteractsWithQueue;
|
|
use Illuminate\Queue\SerializesModels;
|
|
use RuntimeException;
|
|
|
|
class EntraGroupSyncJob implements ShouldQueue
|
|
{
|
|
use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
|
|
|
|
public ?OperationRun $operationRun = null;
|
|
|
|
public function __construct(
|
|
public int $tenantId,
|
|
public string $selectionKey,
|
|
public ?string $slotKey = null,
|
|
public ?int $runId = null,
|
|
?OperationRun $operationRun = null
|
|
) {
|
|
$this->operationRun = $operationRun;
|
|
}
|
|
|
|
public function middleware(): array
|
|
{
|
|
return [new TrackOperationRun];
|
|
}
|
|
|
|
public function handle(EntraGroupSyncService $syncService, AuditLogger $auditLogger): void
|
|
{
|
|
$tenant = Tenant::query()->find($this->tenantId);
|
|
if (! $tenant instanceof Tenant) {
|
|
throw new RuntimeException('Tenant not found.');
|
|
}
|
|
|
|
$run = $this->resolveRun($tenant);
|
|
|
|
if ($run->status !== EntraGroupSyncRun::STATUS_PENDING) {
|
|
// Already ran?
|
|
return;
|
|
}
|
|
|
|
$run->update([
|
|
'status' => EntraGroupSyncRun::STATUS_RUNNING,
|
|
'started_at' => CarbonImmutable::now('UTC'),
|
|
]);
|
|
|
|
$auditLogger->log(
|
|
tenant: $tenant,
|
|
action: 'directory_groups.sync.started',
|
|
context: [
|
|
'selection_key' => $run->selection_key,
|
|
'run_id' => $run->getKey(),
|
|
'slot_key' => $run->slot_key,
|
|
],
|
|
actorId: $run->initiator_user_id,
|
|
status: 'success',
|
|
resourceType: 'entra_group_sync_run',
|
|
resourceId: (string) $run->getKey(),
|
|
);
|
|
|
|
$result = $syncService->sync($tenant, $run);
|
|
|
|
$terminalStatus = EntraGroupSyncRun::STATUS_SUCCEEDED;
|
|
|
|
if ($result['error_code'] !== null) {
|
|
$terminalStatus = EntraGroupSyncRun::STATUS_FAILED;
|
|
} elseif ($result['safety_stop_triggered'] === true) {
|
|
$terminalStatus = EntraGroupSyncRun::STATUS_PARTIAL;
|
|
}
|
|
|
|
$run->update([
|
|
'status' => $terminalStatus,
|
|
'pages_fetched' => $result['pages_fetched'],
|
|
'items_observed_count' => $result['items_observed_count'],
|
|
'items_upserted_count' => $result['items_upserted_count'],
|
|
'error_count' => $result['error_count'],
|
|
'safety_stop_triggered' => $result['safety_stop_triggered'],
|
|
'safety_stop_reason' => $result['safety_stop_reason'],
|
|
'error_code' => $result['error_code'],
|
|
'error_category' => $result['error_category'],
|
|
'error_summary' => $result['error_summary'],
|
|
'finished_at' => CarbonImmutable::now('UTC'),
|
|
]);
|
|
|
|
// Update OperationRun with stats
|
|
if ($this->operationRun) {
|
|
/** @var OperationRunService $opService */
|
|
$opService = app(OperationRunService::class);
|
|
|
|
$opOutcome = match ($terminalStatus) {
|
|
EntraGroupSyncRun::STATUS_SUCCEEDED => 'succeeded',
|
|
EntraGroupSyncRun::STATUS_PARTIAL => 'partially_succeeded',
|
|
EntraGroupSyncRun::STATUS_FAILED => 'failed',
|
|
default => 'failed'
|
|
};
|
|
|
|
$opService->updateRun(
|
|
$this->operationRun,
|
|
'completed',
|
|
$opOutcome,
|
|
[
|
|
'fetched' => $result['items_observed_count'],
|
|
'upserted' => $result['items_upserted_count'],
|
|
'errors' => $result['error_count'],
|
|
],
|
|
$result['error_summary'] ? [['code' => $result['error_code'] ?? 'ERR', 'message' => json_encode($result['error_summary'])]] : []
|
|
);
|
|
}
|
|
|
|
$auditLogger->log(
|
|
tenant: $tenant,
|
|
action: $terminalStatus === EntraGroupSyncRun::STATUS_SUCCEEDED
|
|
? 'directory_groups.sync.succeeded'
|
|
: ($terminalStatus === EntraGroupSyncRun::STATUS_PARTIAL
|
|
? 'directory_groups.sync.partial'
|
|
: 'directory_groups.sync.failed'),
|
|
context: [
|
|
'selection_key' => $run->selection_key,
|
|
'run_id' => $run->getKey(),
|
|
'slot_key' => $run->slot_key,
|
|
'pages_fetched' => $run->pages_fetched,
|
|
'items_observed_count' => $run->items_observed_count,
|
|
'items_upserted_count' => $run->items_upserted_count,
|
|
'error_code' => $run->error_code,
|
|
'error_category' => $run->error_category,
|
|
],
|
|
actorId: $run->initiator_user_id,
|
|
status: $terminalStatus === EntraGroupSyncRun::STATUS_FAILED ? 'failed' : 'success',
|
|
resourceType: 'entra_group_sync_run',
|
|
resourceId: (string) $run->getKey(),
|
|
);
|
|
}
|
|
|
|
private function resolveRun(Tenant $tenant): EntraGroupSyncRun
|
|
{
|
|
if ($this->runId !== null) {
|
|
$run = EntraGroupSyncRun::query()
|
|
->whereKey($this->runId)
|
|
->where('tenant_id', $tenant->getKey())
|
|
->first();
|
|
|
|
if ($run instanceof EntraGroupSyncRun) {
|
|
return $run;
|
|
}
|
|
|
|
throw new RuntimeException('EntraGroupSyncRun not found.');
|
|
}
|
|
|
|
if ($this->slotKey !== null) {
|
|
$run = EntraGroupSyncRun::query()
|
|
->where('tenant_id', $tenant->getKey())
|
|
->where('selection_key', $this->selectionKey)
|
|
->where('slot_key', $this->slotKey)
|
|
->first();
|
|
|
|
if ($run instanceof EntraGroupSyncRun) {
|
|
return $run;
|
|
}
|
|
|
|
throw new RuntimeException('EntraGroupSyncRun not found for slot.');
|
|
}
|
|
|
|
throw new RuntimeException('Job missing runId/slotKey.');
|
|
}
|
|
}
|