7fc2bc84de
* Introduce new AuditEntryService - Moved logic related to the IAuditEntryRepository from the AuditService to the new service - Introduced new Async methods - Using ids (for easier transition from the previous Write method) - Using keys - Moved and updated integration tests related to the audit entries to a new test class `AuditEntryServiceTests` - Added unit tests class `AuditEntryServiceTests` and added a few unit tests - Added migration to add columns for `performingUserKey` and `affectedUserKey` and convert existing user ids - Adjusted usages of the old AuditService.Write method to use the new one (mostly notification handlers) * Apply suggestions from code review * Small improvement * Some adjustments following code review. Removed UnknownUserKey and used null instead. * Small adjustments * Better handle audits performed during the migration state * Update TODO comment
40 lines
1.8 KiB
C#
40 lines
1.8 KiB
C#
using Umbraco.Cms.Core.Models;
|
|
using Umbraco.Cms.Core.Services.OperationStatus;
|
|
|
|
namespace Umbraco.Cms.Core.Services;
|
|
|
|
/// <summary>
|
|
/// Represents a service for handling audit entries.
|
|
/// </summary>
|
|
public interface IAuditEntryService : IService
|
|
{
|
|
/// <summary>
|
|
/// Writes an audit entry for an audited event.
|
|
/// </summary>
|
|
/// <param name="performingUserKey">The key of the user triggering the audited event.</param>
|
|
/// <param name="performingDetails">Free-form details about the user triggering the audited event.</param>
|
|
/// <param name="performingIp">The IP address or the request triggering the audited event.</param>
|
|
/// <param name="eventDateUtc">The date and time of the audited event.</param>
|
|
/// <param name="affectedUserKey">The identifier of the user affected by the audited event.</param>
|
|
/// <param name="affectedDetails">Free-form details about the entity affected by the audited event.</param>
|
|
/// <param name="eventType">
|
|
/// The type of the audited event - must contain only alphanumeric chars and hyphens with forward slashes separating
|
|
/// categories.
|
|
/// <example>
|
|
/// The eventType will generally be formatted like: {application}/{entity-type}/{category}/{sub-category}
|
|
/// Example: umbraco/user/sign-in/failed
|
|
/// </example>
|
|
/// </param>
|
|
/// <param name="eventDetails">Free-form details about the audited event.</param>
|
|
/// <returns>The created audit entry.</returns>
|
|
public Task<IAuditEntry> WriteAsync(
|
|
Guid? performingUserKey,
|
|
string performingDetails,
|
|
string performingIp,
|
|
DateTime eventDateUtc,
|
|
Guid? affectedUserKey,
|
|
string? affectedDetails,
|
|
string eventType,
|
|
string eventDetails);
|
|
}
|