TenantAtlas/app/Support/RunIdempotency.php
ahmido bcf4996a1e feat/049-backup-restore-job-orchestration (#56)
Summary

This PR implements Spec 049 – Backup/Restore Job Orchestration: all critical Backup/Restore execution paths are job-only, idempotent, tenant-scoped, and observable via run records + DB notifications (Phase 1). The UI no longer performs heavy Graph work inside request/Filament actions for these flows.

Why

We want predictable UX and operations at MSP scale:
	•	no timeouts / long-running requests
	•	reproducible run state + per-item results
	•	safe error persistence (no secrets / no token leakage)
	•	strict tenant isolation + auditability for write paths

What changed

Foundational (Runs + Idempotency + Observability)
	•	Added a shared RunIdempotency helper (dedupe while queued/running).
	•	Added a read-only BulkOperationRuns surface (list + view) for status/progress.
	•	Added DB notifications for run status changes (with “View run” link).

US1 – Policy “Capture snapshot” is job-only
	•	Policy detail “Capture snapshot” now:
	•	creates/reuses a run (dedupe key: tenant + policy.capture_snapshot + policy DB id)
	•	dispatches a queued job
	•	returns immediately with notification + link to run detail
	•	Graph capture work moved fully into the job; request path stays Graph-free.

US3 – Restore runs orchestration is job-only + safe
	•	Live restore execution is queued and updates RestoreRun status/progress.
	•	Per-item outcomes are persisted deterministically (per internal DB record).
	•	Audit logging is written for live restore.
	•	Preview/dry-run is enforced as read-only (no writes).

Tenant isolation / authorization (non-negotiable)
	•	Run list/view/start are tenant-scoped and policy-guarded (cross-tenant access => 403, not 404).
	•	Explicit Pest tests cover cross-tenant denial and start authorization.

Tests / Verification
	•	./vendor/bin/pint --dirty
	•	Targeted suite (examples):
	•	policy capture snapshot queued + idempotency tests
	•	restore orchestration + audit logging + preview read-only tests
	•	run authorization / tenant isolation tests

Notes / Scope boundaries
	•	Phase 1 UX = DB notifications + run detail page. A global “progress widget” is tracked as Phase 2 and not required for merge.
	•	Resilience/backoff is tracked in tasks but can be iterated further after merge.

Review focus
	•	Dedupe behavior for queued/running runs (reuse vs create-new)
	•	Tenant scoping & policy gates for all run surfaces
	•	Restore safety: audit event + preview no-writes

Co-authored-by: Ahmed Darrazi <ahmeddarrazi@adsmac.local>
Reviewed-on: #56
2026-01-11 15:59:06 +00:00

96 lines
2.7 KiB
PHP

<?php
namespace App\Support;
use App\Models\BulkOperationRun;
use App\Models\RestoreRun;
use Illuminate\Support\Arr;
final class RunIdempotency
{
/**
* @param array<string, mixed> $context
*/
public static function buildKey(int $tenantId, string $operationType, string|int|null $targetId = null, array $context = []): string
{
$payload = [
'tenant_id' => $tenantId,
'operation_type' => trim($operationType),
'target_id' => $targetId === null ? null : (string) $targetId,
'context' => self::canonicalize($context),
];
return hash('sha256', json_encode($payload, JSON_THROW_ON_ERROR));
}
public static function findActiveBulkOperationRun(int $tenantId, string $idempotencyKey): ?BulkOperationRun
{
return BulkOperationRun::query()
->where('tenant_id', $tenantId)
->where('idempotency_key', $idempotencyKey)
->whereIn('status', ['pending', 'running'])
->latest('id')
->first();
}
public static function findActiveRestoreRun(int $tenantId, string $idempotencyKey): ?RestoreRun
{
return RestoreRun::query()
->where('tenant_id', $tenantId)
->where('idempotency_key', $idempotencyKey)
->whereIn('status', ['queued', 'running'])
->latest('id')
->first();
}
/**
* Deterministic idempotency key for a live restore execution.
*
* @param array<int>|null $selectedItemIds
* @param array<string, string> $groupMapping
*/
public static function restoreExecuteKey(
int $tenantId,
int $backupSetId,
?array $selectedItemIds,
array $groupMapping = [],
): string {
$scopeIds = $selectedItemIds;
if (is_array($scopeIds)) {
$scopeIds = array_values(array_unique(array_map('intval', $scopeIds)));
sort($scopeIds);
}
return self::buildKey(
tenantId: $tenantId,
operationType: 'restore.execute',
targetId: (string) $backupSetId,
context: [
'scope' => $scopeIds,
'group_mapping' => $groupMapping,
],
);
}
/**
* @param array<string, mixed> $value
* @return array<string, mixed>
*/
private static function canonicalize(array $value): array
{
$value = Arr::map($value, function (mixed $item): mixed {
if (is_array($item)) {
/** @var array<string, mixed> $item */
return static::canonicalize($item);
}
return $item;
});
ksort($value);
return $value;
}
}