TenantAtlas/apps/platform/app/Services/Audit/WorkspaceAuditLogger.php

<?php

declare(strict_types=1);

namespace App\Services\Audit;

use App\Models\OperationRun;
use App\Models\PlatformUser;
use App\Models\SupportRequest;
use App\Models\Tenant;
use App\Models\User;
use App\Models\Workspace;
use App\Support\Audit\AuditActionId;
use App\Support\Audit\AuditActorSnapshot;
use App\Support\Audit\AuditActorType;
use App\Support\Audit\AuditTargetSnapshot;
use Carbon\CarbonImmutable;
use InvalidArgumentException;

class WorkspaceAuditLogger
{
    public function __construct(
        private readonly AuditRecorder $auditRecorder,
    ) {}

    public function log(
        Workspace $workspace,
        string|AuditActionId $action,
        array $context = [],
        User|PlatformUser|null $actor = null,
        string $status = 'success',
        ?string $resourceType = null,
        ?string $resourceId = null,
        ?int $actorId = null,
        ?string $actorEmail = null,
        ?string $actorName = null,
        ?AuditActorType $actorType = null,
        ?string $targetLabel = null,
        ?string $summary = null,
        ?int $operationRunId = null,
        ?Tenant $tenant = null,
    ): \App\Models\AuditLog {
        $resolvedActor = match (true) {
            $actor instanceof User => AuditActorSnapshot::human($actor),
            $actor instanceof PlatformUser => AuditActorSnapshot::platform($actor),
            default => AuditActorSnapshot::fromLegacy(
                type: $actorType ?? AuditActorType::infer($action instanceof AuditActionId ? $action->value : $action, $actorId, $actorEmail, $actorName, $context),
                id: $actorId,
                email: $actorEmail,
                label: $actorName,
            ),
        };

        return $this->auditRecorder->record(
            action: $action,
            context: $context,
            workspace: $workspace,
            tenant: $tenant,
            actor: $resolvedActor,
            target: new AuditTargetSnapshot(
                type: $resourceType,
                id: $resourceId,
                label: $targetLabel,
            ),
            outcome: $status,
            recordedAt: CarbonImmutable::now(),
            summary: $summary,
            operationRunId: $operationRunId,
        );
    }

    /**
     * @param  array<string, mixed>  $context
     */
    public function logTenantLifecycleAction(
        Tenant $tenant,
        string|AuditActionId $action,
        array $context = [],
        User|PlatformUser|null $actor = null,
        string $status = 'success',
        ?string $summary = null,
    ): \App\Models\AuditLog {
        return $this->log(
            workspace: $tenant->workspace,
            action: $action,
            context: $context,
            actor: $actor,
            status: $status,
            resourceType: 'tenant',
            resourceId: (string) $tenant->getKey(),
            targetLabel: $tenant->name,
            summary: $summary,
            tenant: $tenant,
        );
    }

    /**
     * @param  array<string, mixed>  $bundle
     */
    public function logSupportDiagnosticsOpened(
        Tenant $tenant,
        string $contextType,
        array $bundle,
        User|PlatformUser|null $actor = null,
        ?OperationRun $operationRun = null,
    ): \App\Models\AuditLog {
        $sectionCount = is_array($bundle['sections'] ?? null) ? count($bundle['sections']) : 0;
        $referenceCount = collect($bundle['sections'] ?? [])
            ->sum(static fn (mixed $section): int => is_array($section) && is_array($section['references'] ?? null)
                ? count($section['references'])
                : 0);

        return $this->log(
            workspace: $tenant->workspace,
            action: AuditActionId::SupportDiagnosticsOpened,
            context: [
                'context_type' => $contextType,
                'redaction_mode' => 'default_redacted',
                'section_count' => $sectionCount,
                'reference_count' => $referenceCount,
                'primary_context_id' => $operationRun instanceof OperationRun
                    ? (string) $operationRun->getKey()
                    : (string) $tenant->getKey(),
            ],
            actor: $actor,
            status: 'success',
            resourceType: 'support_diagnostic_bundle',
            resourceId: $operationRun instanceof OperationRun
                ? 'operation_run:'.$operationRun->getKey()
                : 'tenant:'.$tenant->getKey(),
            targetLabel: $operationRun instanceof OperationRun
                ? 'Support diagnostics for operation #'.$operationRun->getKey()
                : 'Support diagnostics for '.$tenant->name,
            summary: $operationRun instanceof OperationRun
                ? 'Support diagnostics opened for operation #'.$operationRun->getKey()
                : 'Support diagnostics opened for '.$tenant->name,
            operationRunId: $operationRun instanceof OperationRun ? (int) $operationRun->getKey() : null,
            tenant: $tenant,
        );
    }

    public function logSupportRequestCreated(
        SupportRequest $supportRequest,
        User|PlatformUser|null $actor = null,
    ): \App\Models\AuditLog {
        $supportRequest->loadMissing(['tenant.workspace']);

        $tenant = $supportRequest->tenant;

        if (! $tenant instanceof Tenant) {
            throw new InvalidArgumentException('Support requests must belong to a tenant.');
        }

        return $this->log(
            workspace: $tenant->workspace,
            action: AuditActionId::SupportRequestCreated,
            context: [
                'internal_reference' => $supportRequest->internal_reference,
                'primary_context_type' => $supportRequest->primary_context_type,
                'primary_context_id' => $supportRequest->primary_context_type === SupportRequest::PRIMARY_CONTEXT_OPERATION_RUN
                    ? (string) $supportRequest->operation_run_id
                    : (string) $tenant->getKey(),
                'attachment_mode' => $supportRequest->attachment_mode,
                'redaction_mode' => (string) data_get($supportRequest->context_envelope, 'redaction_mode', 'default_redacted'),
            ],
            actor: $actor,
            status: 'success',
            resourceType: 'support_request',
            resourceId: (string) $supportRequest->getKey(),
            targetLabel: $supportRequest->internal_reference,
            summary: 'Support request created for '.$supportRequest->internal_reference,
            operationRunId: $supportRequest->operation_run_id !== null ? (int) $supportRequest->operation_run_id : null,
            tenant: $tenant,
        );
    }
}