< Summary

Information
Class: RoleRadar.Domain.Audit.AuditLogEntry
Assembly: RoleRadar.Domain
File(s): /home/runner/work/roleradar/roleradar/src/RoleRadar.Domain/Audit/AuditLogEntry.cs
Line coverage
88%
Covered lines: 133
Uncovered lines: 17
Coverable lines: 150
Total lines: 334
Line coverage: 88.6%
Branch coverage
68%
Covered branches: 59
Total branches: 86
Branch coverage: 68.6%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
get_Id()100%11100%
get_OwnerId()100%11100%
get_Actor()100%11100%
get_Operation()100%11100%
get_EntityType()100%11100%
get_EntityId()100%11100%
get_TargetNoteId()100%11100%
get_NoteRevisionId()100%11100%
get_AppendedText()100%11100%
get_ResultingVersionToken()100%11100%
get_ResolvedDefaultDate()100%11100%
get_OccurredAtUtc()100%11100%
get_BeforeSummary()100%11100%
get_AfterSummary()100%11100%
get_Details()100%11100%
get_RequestCorrelationId()100%11100%
.ctor(...)100%22100%
Create(...)74.24%1396674.46%
CreateForTracking(...)50%111082.75%
CreateForCreate(...)100%11100%
CreateForAppend(...)100%11100%
CreateForReplaceSection(...)100%11100%
CreateForArchive(...)100%11100%
CreateForImportCreate(...)100%11100%
CreateForImportOverwrite(...)100%11100%
Rehydrate(...)33.33%66100%
EnsureUtc(...)50%22100%

File(s)

/home/runner/work/roleradar/roleradar/src/RoleRadar.Domain/Audit/AuditLogEntry.cs

#LineLine coverage
 1using RoleRadar.Domain.Common;
 2
 3namespace RoleRadar.Domain.Audit;
 4
 5public sealed class AuditLogEntry
 6{
 18347    public Guid Id { get; }
 8
 18349    public string OwnerId { get; }
 10
 185411    public string Actor { get; }
 12
 193013    public string Operation { get; }
 14
 187215    public string EntityType { get; }
 16
 285217    public Guid EntityId { get; }
 18
 98819    public Guid TargetNoteId { get; }
 20
 101821    public Guid? NoteRevisionId { get; }
 22
 105223    public string? AppendedText { get; }
 24
 183425    public Guid ResultingVersionToken { get; }
 26
 179827    public string? ResolvedDefaultDate { get; }
 28
 183429    public DateTime OccurredAtUtc { get; }
 30
 107431    public AuditContentSummary? BeforeSummary { get; }
 32
 198233    public AuditContentSummary? AfterSummary { get; }
 34
 166435    public AuditDetails? Details { get; }
 36
 37    /// <summary>The request, tool call or CLI run that wrote this entry (feature 013). Absent on older entries.</summar
 135638    public string? RequestCorrelationId { get; }
 39
 553240    private AuditLogEntry(
 553241        Guid id,
 553242        string ownerId,
 553243        string actor,
 553244        string operation,
 553245        string entityType,
 553246        Guid entityId,
 553247        Guid targetNoteId,
 553248        Guid? noteRevisionId,
 553249        string? appendedText,
 553250        Guid resultingVersionToken,
 553251        string? resolvedDefaultDate,
 553252        DateTime occurredAtUtc,
 553253        AuditContentSummary? beforeSummary,
 553254        AuditContentSummary? afterSummary,
 553255        AuditDetails? details,
 553256        string? requestCorrelationId)
 57    {
 553258        Id = id;
 553259        OwnerId = ownerId;
 553260        Actor = actor;
 553261        Operation = operation;
 553262        EntityType = entityType;
 553263        EntityId = entityId;
 553264        TargetNoteId = targetNoteId;
 553265        NoteRevisionId = noteRevisionId;
 553266        AppendedText = appendedText;
 553267        ResultingVersionToken = resultingVersionToken;
 553268        ResolvedDefaultDate = resolvedDefaultDate;
 553269        OccurredAtUtc = EnsureUtc(occurredAtUtc);
 553270        BeforeSummary = beforeSummary;
 553271        AfterSummary = afterSummary;
 553272        Details = details;
 553273        RequestCorrelationId = string.IsNullOrWhiteSpace(requestCorrelationId) ? null : requestCorrelationId;
 553274    }
 75
 76    public static AuditLogEntry Create(
 77        string ownerId,
 78        string actor,
 79        string operation,
 80        Guid targetNoteId,
 81        Guid? noteRevisionId,
 82        string? appendedText,
 83        Guid resultingVersionToken,
 84        string? resolvedDefaultDate,
 85        DateTime occurredAtUtc,
 86        AuditContentSummary? beforeSummary,
 87        AuditContentSummary afterSummary,
 88        string? requestCorrelationId = null)
 89    {
 107090        var validOwner = new OwnerId(ownerId).Value;
 107091        if (string.IsNullOrWhiteSpace(actor))
 92        {
 093            throw new ArgumentException("Actor identity is required.", nameof(actor));
 94        }
 95
 107096        if (!AuditOperation.IsValid(operation))
 97        {
 098            throw new ArgumentException($"Invalid audit operation '{operation}'.", nameof(operation));
 99        }
 100
 1070101        if (targetNoteId == Guid.Empty)
 102        {
 0103            throw new ArgumentException("Target note identifier cannot be empty.", nameof(targetNoteId));
 104        }
 105
 1070106        if (resultingVersionToken == Guid.Empty)
 107        {
 0108            throw new ArgumentException("Resulting version token cannot be empty.", nameof(resultingVersionToken));
 109        }
 110
 1070111        ArgumentNullException.ThrowIfNull(afterSummary);
 112
 1070113        var isDestructiveOperation = operation is AuditOperation.NoteReplaceSection or AuditOperation.ImportOverwrite;
 1070114        if (isDestructiveOperation && (noteRevisionId is null || noteRevisionId == Guid.Empty))
 115        {
 0116            throw new ArgumentException($"Operation '{operation}' requires a non-empty NoteRevisionId.", nameof(noteRevi
 117        }
 118
 1070119        if (!isDestructiveOperation && noteRevisionId is not null)
 120        {
 0121            throw new ArgumentException($"Operation '{operation}' must not specify a NoteRevisionId.", nameof(noteRevisi
 122        }
 123
 1070124        var isAppendOperation = operation is AuditOperation.NoteAppend or AuditOperation.ContactAdd or AuditOperation.Co
 1070125        if (isAppendOperation && string.IsNullOrEmpty(appendedText))
 126        {
 0127            throw new ArgumentException($"Operation '{operation}' requires non-empty AppendedText.", nameof(appendedText
 128        }
 129
 1070130        if (!isAppendOperation && appendedText is not null)
 131        {
 0132            throw new ArgumentException($"Operation '{operation}' must not specify AppendedText.", nameof(appendedText))
 133        }
 134
 1070135        var isImportOperation = operation is AuditOperation.ImportCreate or AuditOperation.ImportOverwrite;
 1070136        if (isImportOperation && string.IsNullOrWhiteSpace(resolvedDefaultDate))
 137        {
 0138            throw new ArgumentException($"Operation '{operation}' requires ResolvedDefaultDate.", nameof(resolvedDefault
 139        }
 140
 1070141        if (!isImportOperation && resolvedDefaultDate is not null)
 142        {
 0143            throw new ArgumentException($"Operation '{operation}' must not specify ResolvedDefaultDate.", nameof(resolve
 144        }
 145
 1070146        var isCreateOperation = operation is AuditOperation.NoteCreate or AuditOperation.ImportCreate or AuditOperation.
 1070147        if (isCreateOperation && beforeSummary is not null)
 148        {
 0149            throw new ArgumentException($"Operation '{operation}' must have null BeforeSummary.", nameof(beforeSummary))
 150        }
 151
 1070152        if (!isCreateOperation && beforeSummary is null)
 153        {
 0154            throw new ArgumentException($"Operation '{operation}' requires BeforeSummary.", nameof(beforeSummary));
 155        }
 156
 1070157        return new AuditLogEntry(
 1070158            id: Guid.CreateVersion7(),
 1070159            ownerId: validOwner,
 1070160            actor: actor.Trim(),
 1070161            operation: operation,
 1070162            entityType: "note",
 1070163            entityId: targetNoteId,
 1070164            targetNoteId: targetNoteId,
 1070165            noteRevisionId: noteRevisionId,
 1070166            appendedText: appendedText,
 1070167            resultingVersionToken: resultingVersionToken,
 1070168            resolvedDefaultDate: resolvedDefaultDate?.Trim(),
 1070169            occurredAtUtc: EnsureUtc(occurredAtUtc),
 1070170            beforeSummary: beforeSummary,
 1070171            afterSummary: afterSummary,
 1070172            details: null,
 1070173            requestCorrelationId: requestCorrelationId);
 174    }
 175
 176    public static AuditLogEntry CreateForTracking(
 177        string ownerId,
 178        string actor,
 179        string operation,
 180        string entityType,
 181        Guid entityId,
 182        Guid resultingVersionToken,
 183        DateTime occurredAtUtc,
 184        AuditDetails details,
 185        string? requestCorrelationId = null)
 186    {
 4364187        var validOwner = new OwnerId(ownerId).Value;
 4364188        if (string.IsNullOrWhiteSpace(actor))
 189        {
 0190            throw new ArgumentException("Actor identity is required.", nameof(actor));
 191        }
 192
 4364193        if (!AuditOperation.IsValid(operation))
 194        {
 0195            throw new ArgumentException($"Invalid audit operation '{operation}'.", nameof(operation));
 196        }
 197
 4364198        if (string.IsNullOrWhiteSpace(entityType))
 199        {
 0200            throw new ArgumentException("EntityType is required.", nameof(entityType));
 201        }
 202
 4364203        if (entityId == Guid.Empty)
 204        {
 0205            throw new ArgumentException("Entity identifier cannot be empty.", nameof(entityId));
 206        }
 207
 4364208        if (resultingVersionToken == Guid.Empty)
 209        {
 0210            throw new ArgumentException("Resulting version token cannot be empty.", nameof(resultingVersionToken));
 211        }
 212
 4364213        ArgumentNullException.ThrowIfNull(details);
 214
 4364215        return new AuditLogEntry(
 4364216            id: Guid.CreateVersion7(),
 4364217            ownerId: validOwner,
 4364218            actor: actor.Trim(),
 4364219            operation: operation,
 4364220            entityType: entityType.Trim().ToLowerInvariant(),
 4364221            entityId: entityId,
 4364222            targetNoteId: Guid.Empty,
 4364223            noteRevisionId: null,
 4364224            appendedText: null,
 4364225            resultingVersionToken: resultingVersionToken,
 4364226            resolvedDefaultDate: null,
 4364227            occurredAtUtc: EnsureUtc(occurredAtUtc),
 4364228            beforeSummary: null,
 4364229            afterSummary: null,
 4364230            details: details,
 4364231            requestCorrelationId: requestCorrelationId);
 232    }
 233
 234    public static AuditLogEntry CreateForCreate(
 235        string ownerId,
 236        string actor,
 237        Guid targetNoteId,
 238        Guid resultingVersionToken,
 239        DateTime occurredAtUtc,
 240        AuditContentSummary afterSummary) =>
 128241        Create(ownerId, actor, AuditOperation.NoteCreate, targetNoteId, null, null, resultingVersionToken, null, occurre
 242
 243    public static AuditLogEntry CreateForAppend(
 244        string ownerId,
 245        string actor,
 246        Guid targetNoteId,
 247        string appendedText,
 248        Guid resultingVersionToken,
 249        DateTime occurredAtUtc,
 250        AuditContentSummary beforeSummary,
 251        AuditContentSummary afterSummary) =>
 62252        Create(ownerId, actor, AuditOperation.NoteAppend, targetNoteId, null, appendedText, resultingVersionToken, null,
 253
 254    public static AuditLogEntry CreateForReplaceSection(
 255        string ownerId,
 256        string actor,
 257        Guid targetNoteId,
 258        Guid noteRevisionId,
 259        Guid resultingVersionToken,
 260        DateTime occurredAtUtc,
 261        AuditContentSummary beforeSummary,
 262        AuditContentSummary afterSummary) =>
 14263        Create(ownerId, actor, AuditOperation.NoteReplaceSection, targetNoteId, noteRevisionId, null, resultingVersionTo
 264
 265    public static AuditLogEntry CreateForArchive(
 266        string ownerId,
 267        string actor,
 268        Guid targetNoteId,
 269        Guid resultingVersionToken,
 270        DateTime occurredAtUtc,
 271        AuditContentSummary beforeSummary,
 272        AuditContentSummary afterSummary) =>
 10273        Create(ownerId, actor, AuditOperation.NoteArchive, targetNoteId, null, null, resultingVersionToken, null, occurr
 274
 275    public static AuditLogEntry CreateForImportCreate(
 276        string ownerId,
 277        string actor,
 278        Guid targetNoteId,
 279        Guid resultingVersionToken,
 280        string resolvedDefaultDate,
 281        DateTime occurredAtUtc,
 282        AuditContentSummary afterSummary) =>
 846283        Create(ownerId, actor, AuditOperation.ImportCreate, targetNoteId, null, null, resultingVersionToken, resolvedDef
 284
 285    public static AuditLogEntry CreateForImportOverwrite(
 286        string ownerId,
 287        string actor,
 288        Guid targetNoteId,
 289        Guid noteRevisionId,
 290        Guid resultingVersionToken,
 291        string resolvedDefaultDate,
 292        DateTime occurredAtUtc,
 293        AuditContentSummary beforeSummary,
 294        AuditContentSummary afterSummary) =>
 8295        Create(ownerId, actor, AuditOperation.ImportOverwrite, targetNoteId, noteRevisionId, null, resultingVersionToken
 296
 297    public static AuditLogEntry Rehydrate(
 298        Guid id,
 299        string ownerId,
 300        string actor,
 301        string operation,
 302        Guid targetNoteId,
 303        Guid? noteRevisionId,
 304        string? appendedText,
 305        Guid resultingVersionToken,
 306        string? resolvedDefaultDate,
 307        DateTime occurredAtUtc,
 308        AuditContentSummary? beforeSummary,
 309        AuditContentSummary? afterSummary,
 310        string? entityType = null,
 311        Guid? entityId = null,
 312        AuditDetails? details = null,
 313        string? requestCorrelationId = null) =>
 98314        new(
 98315            id,
 98316            ownerId,
 98317            actor,
 98318            operation,
 98319            entityType ?? "note",
 98320            entityId ?? (targetNoteId != Guid.Empty ? targetNoteId : id),
 98321            targetNoteId,
 98322            noteRevisionId,
 98323            appendedText,
 98324            resultingVersionToken,
 98325            resolvedDefaultDate,
 98326            occurredAtUtc,
 98327            beforeSummary,
 98328            afterSummary,
 98329            details,
 98330            requestCorrelationId);
 331
 332    private static DateTime EnsureUtc(DateTime value) =>
 10966333        value.Kind == DateTimeKind.Utc ? value : DateTime.SpecifyKind(value, DateTimeKind.Utc);
 334}

Methods/Properties

get_Id()
get_OwnerId()
get_Actor()
get_Operation()
get_EntityType()
get_EntityId()
get_TargetNoteId()
get_NoteRevisionId()
get_AppendedText()
get_ResultingVersionToken()
get_ResolvedDefaultDate()
get_OccurredAtUtc()
get_BeforeSummary()
get_AfterSummary()
get_Details()
get_RequestCorrelationId()
.ctor(System.Guid,System.String,System.String,System.String,System.String,System.Guid,System.Guid,System.Nullable`1<System.Guid>,System.String,System.Guid,System.String,System.DateTime,RoleRadar.Domain.Audit.AuditContentSummary,RoleRadar.Domain.Audit.AuditContentSummary,RoleRadar.Domain.Audit.AuditDetails,System.String)
Create(System.String,System.String,System.String,System.Guid,System.Nullable`1<System.Guid>,System.String,System.Guid,System.String,System.DateTime,RoleRadar.Domain.Audit.AuditContentSummary,RoleRadar.Domain.Audit.AuditContentSummary,System.String)
CreateForTracking(System.String,System.String,System.String,System.String,System.Guid,System.Guid,System.DateTime,RoleRadar.Domain.Audit.AuditDetails,System.String)
CreateForCreate(System.String,System.String,System.Guid,System.Guid,System.DateTime,RoleRadar.Domain.Audit.AuditContentSummary)
CreateForAppend(System.String,System.String,System.Guid,System.String,System.Guid,System.DateTime,RoleRadar.Domain.Audit.AuditContentSummary,RoleRadar.Domain.Audit.AuditContentSummary)
CreateForReplaceSection(System.String,System.String,System.Guid,System.Guid,System.Guid,System.DateTime,RoleRadar.Domain.Audit.AuditContentSummary,RoleRadar.Domain.Audit.AuditContentSummary)
CreateForArchive(System.String,System.String,System.Guid,System.Guid,System.DateTime,RoleRadar.Domain.Audit.AuditContentSummary,RoleRadar.Domain.Audit.AuditContentSummary)
CreateForImportCreate(System.String,System.String,System.Guid,System.Guid,System.String,System.DateTime,RoleRadar.Domain.Audit.AuditContentSummary)
CreateForImportOverwrite(System.String,System.String,System.Guid,System.Guid,System.Guid,System.String,System.DateTime,RoleRadar.Domain.Audit.AuditContentSummary,RoleRadar.Domain.Audit.AuditContentSummary)
Rehydrate(System.Guid,System.String,System.String,System.String,System.Guid,System.Nullable`1<System.Guid>,System.String,System.Guid,System.String,System.DateTime,RoleRadar.Domain.Audit.AuditContentSummary,RoleRadar.Domain.Audit.AuditContentSummary,System.String,System.Nullable`1<System.Guid>,RoleRadar.Domain.Audit.AuditDetails,System.String)
EnsureUtc(System.DateTime)