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
186 lines
6.2 KiB
PHP
186 lines
6.2 KiB
PHP
<?php
|
|
|
|
use App\Models\BackupItem;
|
|
use App\Models\BackupSet;
|
|
use App\Models\Policy;
|
|
use App\Models\Tenant;
|
|
use App\Models\User;
|
|
use App\Services\Graph\GraphClientInterface;
|
|
use App\Services\Graph\GraphResponse;
|
|
use App\Services\Intune\RestoreService;
|
|
use Illuminate\Foundation\Testing\RefreshDatabase;
|
|
|
|
uses(RefreshDatabase::class);
|
|
|
|
class GroupPolicyRestoreGraphClient implements GraphClientInterface
|
|
{
|
|
/**
|
|
* @var array<int, array{policy_type:string,policy_id:string,payload:array}>
|
|
*/
|
|
public array $applyPolicyCalls = [];
|
|
|
|
/**
|
|
* @var array<int, array{method:string,path:string,payload:array|null}>
|
|
*/
|
|
public array $requestCalls = [];
|
|
|
|
/**
|
|
* @param array<int, GraphResponse> $requestResponses
|
|
*/
|
|
public function __construct(
|
|
private readonly GraphResponse $applyPolicyResponse,
|
|
private array $requestResponses = [],
|
|
) {}
|
|
|
|
public function listPolicies(string $policyType, array $options = []): GraphResponse
|
|
{
|
|
return new GraphResponse(true, []);
|
|
}
|
|
|
|
public function getPolicy(string $policyType, string $policyId, array $options = []): GraphResponse
|
|
{
|
|
return new GraphResponse(true, ['payload' => []]);
|
|
}
|
|
|
|
public function getOrganization(array $options = []): GraphResponse
|
|
{
|
|
return new GraphResponse(true, []);
|
|
}
|
|
|
|
public function applyPolicy(string $policyType, string $policyId, array $payload, array $options = []): GraphResponse
|
|
{
|
|
$this->applyPolicyCalls[] = [
|
|
'policy_type' => $policyType,
|
|
'policy_id' => $policyId,
|
|
'payload' => $payload,
|
|
];
|
|
|
|
return $this->applyPolicyResponse;
|
|
}
|
|
|
|
public function getServicePrincipalPermissions(array $options = []): GraphResponse
|
|
{
|
|
return new GraphResponse(true, []);
|
|
}
|
|
|
|
public function request(string $method, string $path, array $options = []): GraphResponse
|
|
{
|
|
$this->requestCalls[] = [
|
|
'method' => strtoupper($method),
|
|
'path' => $path,
|
|
'payload' => $options['json'] ?? null,
|
|
];
|
|
|
|
$response = array_shift($this->requestResponses);
|
|
|
|
return $response ?? new GraphResponse(true, []);
|
|
}
|
|
}
|
|
|
|
test('restore applies administrative template definition values', function () {
|
|
$policyResponse = new GraphResponse(true, [], 200, [], [], ['request_id' => 'req-policy', 'client_request_id' => 'client-policy']);
|
|
|
|
$listExisting = new GraphResponse(true, [
|
|
'value' => [
|
|
['id' => 'existing-dv-1'],
|
|
],
|
|
]);
|
|
|
|
$deleteExisting = new GraphResponse(true, []);
|
|
$createDefinitionValue = new GraphResponse(true, []);
|
|
|
|
$client = new GroupPolicyRestoreGraphClient($policyResponse, [
|
|
$listExisting,
|
|
$deleteExisting,
|
|
$createDefinitionValue,
|
|
]);
|
|
|
|
app()->instance(GraphClientInterface::class, $client);
|
|
|
|
$tenant = Tenant::create([
|
|
'tenant_id' => 'tenant-gpo-restore',
|
|
'name' => 'Tenant One',
|
|
'metadata' => [],
|
|
]);
|
|
|
|
$policy = Policy::create([
|
|
'tenant_id' => $tenant->id,
|
|
'external_id' => 'gpo-1',
|
|
'policy_type' => 'groupPolicyConfiguration',
|
|
'display_name' => 'Admin Templates Alpha',
|
|
'platform' => 'windows',
|
|
]);
|
|
|
|
$backupSet = BackupSet::create([
|
|
'tenant_id' => $tenant->id,
|
|
'name' => 'Backup',
|
|
'status' => 'completed',
|
|
'item_count' => 1,
|
|
]);
|
|
|
|
$payload = [
|
|
'id' => 'gpo-1',
|
|
'displayName' => 'Admin Templates Alpha',
|
|
'@odata.type' => '#microsoft.graph.groupPolicyConfiguration',
|
|
'definitionValues' => [
|
|
[
|
|
'enabled' => true,
|
|
'definition@odata.bind' => 'https://graph.microsoft.com/beta/deviceManagement/groupPolicyDefinitions(\'def-1\')',
|
|
'#Definition_Id' => 'def-1',
|
|
'#Definition_displayName' => 'Block legacy auth',
|
|
'presentationValues' => [
|
|
[
|
|
'presentation@odata.bind' => 'https://graph.microsoft.com/beta/deviceManagement/groupPolicyDefinitions(\'def-1\')/presentations(\'pres-1\')',
|
|
'#Presentation_Label' => 'State',
|
|
'#Presentation_Id' => 'pres-1',
|
|
'value' => 'enabled',
|
|
],
|
|
],
|
|
],
|
|
],
|
|
];
|
|
|
|
$backupItem = BackupItem::create([
|
|
'tenant_id' => $tenant->id,
|
|
'backup_set_id' => $backupSet->id,
|
|
'policy_id' => $policy->id,
|
|
'policy_identifier' => $policy->external_id,
|
|
'policy_type' => $policy->policy_type,
|
|
'platform' => $policy->platform,
|
|
'payload' => $payload,
|
|
]);
|
|
|
|
$user = User::factory()->create();
|
|
$this->actingAs($user);
|
|
|
|
$service = app(RestoreService::class);
|
|
$run = $service->execute(
|
|
tenant: $tenant,
|
|
backupSet: $backupSet,
|
|
selectedItemIds: [$backupItem->id],
|
|
dryRun: false,
|
|
actorEmail: $user->email,
|
|
actorName: $user->name,
|
|
)->refresh();
|
|
|
|
expect($run->status)->toBe('completed');
|
|
$result = $run->results['items'][$backupItem->id] ?? null;
|
|
expect($result)->not->toBeNull();
|
|
expect($result['status'] ?? null)->toBe('applied');
|
|
expect($result['definition_value_summary']['success'] ?? null)->toBe(1);
|
|
|
|
expect($client->applyPolicyCalls)->toHaveCount(1);
|
|
expect($client->applyPolicyCalls[0]['policy_type'])->toBe('groupPolicyConfiguration');
|
|
|
|
expect($client->requestCalls)->toHaveCount(3);
|
|
expect($client->requestCalls[0]['method'])->toBe('GET');
|
|
expect($client->requestCalls[0]['path'])->toContain('/deviceManagement/groupPolicyConfigurations/gpo-1/definitionValues');
|
|
expect($client->requestCalls[1]['method'])->toBe('DELETE');
|
|
expect($client->requestCalls[1]['path'])->toContain('/deviceManagement/groupPolicyConfigurations/gpo-1/definitionValues/existing-dv-1');
|
|
expect($client->requestCalls[2]['method'])->toBe('POST');
|
|
expect($client->requestCalls[2]['path'])->toContain('/deviceManagement/groupPolicyConfigurations/gpo-1/definitionValues');
|
|
expect($client->requestCalls[2]['payload'])->toBeArray();
|
|
expect($client->requestCalls[2]['payload'])->toHaveKey('definition@odata.bind');
|
|
expect($client->requestCalls[2]['payload'])->not->toHaveKey('#Definition_displayName');
|
|
});
|