Implements the 074 verification checklist framework. Highlights: - Versioned verification report contract stored in operation_runs.context.verification_report (DB-only viewer). - Strict sanitizer/redaction (evidence pointers only; no tokens/headers/payloads) + schema validation. - Centralized BADGE-001 semantics for check status, severity, and overall report outcome. - Deterministic start (dedupe while active) via shared StartVerification service; capability-first authorization (non-member 404, member missing capability 403). - Completion audit event (verification.completed) with redacted metadata. - Integrations: OperationRun detail viewer, onboarding wizard verification step, provider connection start surfaces. Tests: - vendor/bin/sail artisan test --compact tests/Feature/Verification tests/Unit/Badges/VerificationBadgesTest.php - vendor/bin/sail bin pint --dirty Co-authored-by: Ahmed Darrazi <ahmeddarrazi@MacBookPro.fritz.box> Reviewed-on: #89
231 lines
8.3 KiB
PHP
231 lines
8.3 KiB
PHP
<?php
|
|
|
|
namespace App\Jobs;
|
|
|
|
use App\Jobs\Middleware\TrackOperationRun;
|
|
use App\Models\OperationRun;
|
|
use App\Models\ProviderConnection;
|
|
use App\Models\Tenant;
|
|
use App\Models\User;
|
|
use App\Services\Audit\WorkspaceAuditLogger;
|
|
use App\Services\OperationRunService;
|
|
use App\Services\Providers\Contracts\HealthResult;
|
|
use App\Services\Providers\MicrosoftProviderHealthCheck;
|
|
use App\Support\Audit\AuditActionId;
|
|
use App\Support\OperationRunOutcome;
|
|
use App\Support\OperationRunStatus;
|
|
use App\Support\Verification\VerificationReportWriter;
|
|
use Illuminate\Bus\Queueable;
|
|
use Illuminate\Contracts\Queue\ShouldQueue;
|
|
use Illuminate\Foundation\Bus\Dispatchable;
|
|
use Illuminate\Queue\InteractsWithQueue;
|
|
use Illuminate\Queue\SerializesModels;
|
|
use Illuminate\Support\Arr;
|
|
use RuntimeException;
|
|
|
|
class ProviderConnectionHealthCheckJob implements ShouldQueue
|
|
{
|
|
use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
|
|
|
|
public ?OperationRun $operationRun = null;
|
|
|
|
public function __construct(
|
|
public int $tenantId,
|
|
public int $userId,
|
|
public int $providerConnectionId,
|
|
?OperationRun $operationRun = null,
|
|
) {
|
|
$this->operationRun = $operationRun;
|
|
}
|
|
|
|
/**
|
|
* @return array<int, object>
|
|
*/
|
|
public function middleware(): array
|
|
{
|
|
return [new TrackOperationRun];
|
|
}
|
|
|
|
public function handle(
|
|
MicrosoftProviderHealthCheck $healthCheck,
|
|
OperationRunService $runs,
|
|
): void {
|
|
$tenant = Tenant::query()->find($this->tenantId);
|
|
if (! $tenant instanceof Tenant) {
|
|
throw new RuntimeException('Tenant not found.');
|
|
}
|
|
|
|
$user = User::query()->find($this->userId);
|
|
if (! $user instanceof User) {
|
|
throw new RuntimeException('User not found.');
|
|
}
|
|
|
|
$connection = ProviderConnection::query()
|
|
->where('tenant_id', $tenant->getKey())
|
|
->find($this->providerConnectionId);
|
|
|
|
if (! $connection instanceof ProviderConnection) {
|
|
throw new RuntimeException('ProviderConnection not found.');
|
|
}
|
|
|
|
$result = $healthCheck->check($connection);
|
|
|
|
$this->applyHealthResult($connection, $result);
|
|
|
|
if (! $this->operationRun instanceof OperationRun) {
|
|
return;
|
|
}
|
|
|
|
$entraTenantName = $this->resolveEntraTenantName($connection, $result);
|
|
|
|
if ($entraTenantName !== null) {
|
|
$metadata = is_array($connection->metadata) ? $connection->metadata : [];
|
|
$metadata['entra_tenant_name'] = $entraTenantName;
|
|
$connection->update(['metadata' => $metadata]);
|
|
}
|
|
|
|
$this->updateRunTargetScope($this->operationRun, $connection, $entraTenantName);
|
|
|
|
$report = VerificationReportWriter::write(
|
|
run: $this->operationRun,
|
|
checks: [
|
|
[
|
|
'key' => 'provider.connection.check',
|
|
'title' => 'Provider connection check',
|
|
'status' => $result->healthy ? 'pass' : 'fail',
|
|
'severity' => $result->healthy ? 'info' : 'critical',
|
|
'blocking' => ! $result->healthy,
|
|
'reason_code' => $result->healthy ? 'ok' : ($result->reasonCode ?? 'unknown_error'),
|
|
'message' => $result->healthy ? 'Connection is healthy.' : ($result->message ?? 'Health check failed.'),
|
|
'evidence' => array_values(array_filter([
|
|
[
|
|
'kind' => 'provider_connection_id',
|
|
'value' => (int) $connection->getKey(),
|
|
],
|
|
[
|
|
'kind' => 'entra_tenant_id',
|
|
'value' => (string) $connection->entra_tenant_id,
|
|
],
|
|
is_numeric($result->meta['http_status'] ?? null) ? [
|
|
'kind' => 'http_status',
|
|
'value' => (int) $result->meta['http_status'],
|
|
] : null,
|
|
is_string($result->meta['organization_id'] ?? null) ? [
|
|
'kind' => 'organization_id',
|
|
'value' => (string) $result->meta['organization_id'],
|
|
] : null,
|
|
])),
|
|
'next_steps' => $result->healthy
|
|
? []
|
|
: [[
|
|
'label' => 'Review provider connection',
|
|
'url' => \App\Filament\Resources\ProviderConnectionResource::getUrl('edit', [
|
|
'record' => (int) $connection->getKey(),
|
|
], tenant: $tenant),
|
|
]],
|
|
],
|
|
],
|
|
identity: [
|
|
'provider_connection_id' => (int) $connection->getKey(),
|
|
'entra_tenant_id' => (string) $connection->entra_tenant_id,
|
|
],
|
|
);
|
|
|
|
if ($result->healthy) {
|
|
$run = $runs->updateRun(
|
|
$this->operationRun,
|
|
status: OperationRunStatus::Completed->value,
|
|
outcome: OperationRunOutcome::Succeeded->value,
|
|
);
|
|
|
|
$this->logVerificationCompletion($tenant, $user, $run, $report);
|
|
|
|
return;
|
|
}
|
|
|
|
$run = $runs->updateRun(
|
|
$this->operationRun,
|
|
status: OperationRunStatus::Completed->value,
|
|
outcome: OperationRunOutcome::Failed->value,
|
|
failures: [[
|
|
'code' => 'provider.connection.check.failed',
|
|
'reason_code' => $result->reasonCode ?? 'unknown_error',
|
|
'message' => $result->message ?? 'Health check failed.',
|
|
]],
|
|
);
|
|
|
|
$this->logVerificationCompletion($tenant, $user, $run, $report);
|
|
}
|
|
|
|
private function resolveEntraTenantName(ProviderConnection $connection, HealthResult $result): ?string
|
|
{
|
|
$existing = Arr::get(is_array($connection->metadata) ? $connection->metadata : [], 'entra_tenant_name');
|
|
|
|
if (is_string($existing) && trim($existing) !== '') {
|
|
return trim($existing);
|
|
}
|
|
|
|
$candidate = $result->meta['organization_display_name'] ?? null;
|
|
|
|
return is_string($candidate) && trim($candidate) !== '' ? trim($candidate) : null;
|
|
}
|
|
|
|
private function updateRunTargetScope(OperationRun $run, ProviderConnection $connection, ?string $entraTenantName): void
|
|
{
|
|
$context = is_array($run->context) ? $run->context : [];
|
|
$targetScope = $context['target_scope'] ?? [];
|
|
$targetScope = is_array($targetScope) ? $targetScope : [];
|
|
|
|
$targetScope['entra_tenant_id'] = $connection->entra_tenant_id;
|
|
|
|
if (is_string($entraTenantName) && $entraTenantName !== '') {
|
|
$targetScope['entra_tenant_name'] = $entraTenantName;
|
|
}
|
|
|
|
$context['target_scope'] = $targetScope;
|
|
|
|
$run->update(['context' => $context]);
|
|
}
|
|
|
|
private function applyHealthResult(ProviderConnection $connection, HealthResult $result): void
|
|
{
|
|
$connection->update([
|
|
'status' => $result->status,
|
|
'health_status' => $result->healthStatus,
|
|
'last_health_check_at' => now(),
|
|
'last_error_reason_code' => $result->healthy ? null : $result->reasonCode,
|
|
'last_error_message' => $result->healthy ? null : $result->message,
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* @param array<string, mixed> $report
|
|
*/
|
|
private function logVerificationCompletion(Tenant $tenant, User $actor, OperationRun $run, array $report): void
|
|
{
|
|
$workspace = $tenant->workspace;
|
|
|
|
if (! $workspace) {
|
|
return;
|
|
}
|
|
|
|
$counts = $report['summary']['counts'] ?? [];
|
|
$counts = is_array($counts) ? $counts : [];
|
|
|
|
app(WorkspaceAuditLogger::class)->log(
|
|
workspace: $workspace,
|
|
action: AuditActionId::VerificationCompleted->value,
|
|
context: [
|
|
'metadata' => [
|
|
'operation_run_id' => (int) $run->getKey(),
|
|
'counts' => $counts,
|
|
],
|
|
],
|
|
actor: $actor,
|
|
status: $run->outcome === OperationRunOutcome::Succeeded->value ? 'success' : 'failed',
|
|
resourceType: 'operation_run',
|
|
resourceId: (string) $run->getKey(),
|
|
);
|
|
}
|
|
}
|