Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add SaveChanges interceptor #21857

Merged
merged 1 commit into from
Jul 30, 2020
Merged

Add SaveChanges interceptor #21857

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion src/EFCore.Relational/Infrastructure/EntityFrameworkRelationalServicesBuilder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,6 @@ public static readonly IDictionary<Type, ServiceCharacteristics> RelationalServi
{ typeof(IRelationalDatabaseCreator), new ServiceCharacteristics(ServiceLifetime.Scoped) },
{ typeof(IHistoryRepository), new ServiceCharacteristics(ServiceLifetime.Scoped) },
{ typeof(INamedConnectionStringResolver), new ServiceCharacteristics(ServiceLifetime.Scoped) },
{ typeof(IInterceptorAggregator), new ServiceCharacteristics(ServiceLifetime.Scoped, multipleRegistrations: true) },
{ typeof(IInterceptor), new ServiceCharacteristics(ServiceLifetime.Scoped, multipleRegistrations: true) },
{ typeof(IRelationalTypeMappingSourcePlugin), new ServiceCharacteristics(ServiceLifetime.Singleton, multipleRegistrations: true) },
{ typeof(IMethodCallTranslatorPlugin), new ServiceCharacteristics(ServiceLifetime.Singleton, multipleRegistrations: true) },
Expand Down
28 changes: 16 additions & 12 deletions src/EFCore/DbContext.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -486,17 +486,17 @@ public virtual int SaveChanges(bool acceptAllChangesOnSuccess)
{
CheckDisposed();

DbContextDependencies.UpdateLogger.SaveChangesStarting(this);
var interceptionResult = DbContextDependencies.UpdateLogger.SaveChangesStarting(this);

TryDetectChanges();

try
{
var entitiesSaved = DbContextDependencies.StateManager.SaveChanges(acceptAllChangesOnSuccess);
var entitiesSaved = interceptionResult.HasResult
? interceptionResult.Result
: DbContextDependencies.StateManager.SaveChanges(acceptAllChangesOnSuccess);

DbContextDependencies.UpdateLogger.SaveChangesCompleted(this, entitiesSaved);

return entitiesSaved;
return DbContextDependencies.UpdateLogger.SaveChangesCompleted(this, entitiesSaved);
}
catch (DbUpdateConcurrencyException exception)
{
Expand Down Expand Up @@ -595,18 +595,22 @@ public virtual async Task<int> SaveChangesAsync(
{
CheckDisposed();

DbContextDependencies.UpdateLogger.SaveChangesStarting(this);
var interceptionResult = await DbContextDependencies.UpdateLogger
.SaveChangesStartingAsync(this, cancellationToken).ConfigureAwait(false);

TryDetectChanges();

try
{
var entitiesSaved = await DbContextDependencies.StateManager.SaveChangesAsync(acceptAllChangesOnSuccess, cancellationToken)
var entitiesSaved = interceptionResult.HasResult
? interceptionResult.Result
: await DbContextDependencies.StateManager
.SaveChangesAsync(acceptAllChangesOnSuccess, cancellationToken)
.ConfigureAwait(false);

return await DbContextDependencies.UpdateLogger
.SaveChangesCompletedAsync(this, entitiesSaved, cancellationToken)
.ConfigureAwait(false);

DbContextDependencies.UpdateLogger.SaveChangesCompleted(this, entitiesSaved);

return entitiesSaved;
}
catch (DbUpdateConcurrencyException exception)
{
Expand All @@ -616,7 +620,7 @@ public virtual async Task<int> SaveChangesAsync(
}
catch (Exception exception)
{
DbContextDependencies.UpdateLogger.SaveChangesFailed(this, exception);
await DbContextDependencies.UpdateLogger.SaveChangesFailedAsync(this, exception, cancellationToken).ConfigureAwait(false);

throw;
}
Expand Down
182 changes: 164 additions & 18 deletions src/EFCore/Diagnostics/CoreLoggerExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
using System.Linq;
using System.Linq.Expressions;
using System.Reflection;
using System.Threading;
using System.Threading.Tasks;
using JetBrains.Annotations;
using Microsoft.EntityFrameworkCore.ChangeTracking;
using Microsoft.EntityFrameworkCore.ChangeTracking.Internal;
Expand Down Expand Up @@ -55,18 +57,64 @@ public static void SaveChangesFailed(
exception);
}

if (diagnostics.NeedsEventData(definition, out var diagnosticSourceEnabled, out var simpleLogEnabled))
if (diagnostics.NeedsEventData<ISaveChangesInterceptor>(definition,
out var interceptor, out var diagnosticSourceEnabled, out var simpleLogEnabled))
{
var eventData = new DbContextErrorEventData(
definition,
SaveChangesFailed,
context,
var eventData = CreateDbContextErrorEventData(context, exception, definition);

diagnostics.DispatchEventData(definition, eventData, diagnosticSourceEnabled, simpleLogEnabled);

if (interceptor != null)
{
interceptor.SaveChangesFailed(eventData);
}
}
}

/// <summary>
/// Logs for the <see cref="CoreEventId.SaveChangesFailed" /> event.
/// </summary>
/// <param name="diagnostics"> The diagnostics logger to use. </param>
/// <param name="context"> The context in use. </param>
/// <param name="exception"> The exception that caused this event. </param>
/// <param name="cancellationToken"> The cancellation token. </param>
/// <returns> A <see cref="ValueTask"/> for the async result. </returns>
public static ValueTask SaveChangesFailedAsync(
[NotNull] this IDiagnosticsLogger<DbLoggerCategory.Update> diagnostics,
[NotNull] DbContext context,
[NotNull] Exception exception,
CancellationToken cancellationToken = default)
{
var definition = CoreResources.LogExceptionDuringSaveChanges(diagnostics);

if (diagnostics.ShouldLog(definition))
{
definition.Log(
diagnostics,
context.GetType(), Environment.NewLine, exception,
exception);
}

if (diagnostics.NeedsEventData<ISaveChangesInterceptor>(definition,
out var interceptor, out var diagnosticSourceEnabled, out var simpleLogEnabled))
{
var eventData = CreateDbContextErrorEventData(context, exception, definition);

diagnostics.DispatchEventData(definition, eventData, diagnosticSourceEnabled, simpleLogEnabled);

if (interceptor != null)
{
return interceptor.SaveChangesFailedAsync(eventData, cancellationToken);
}
}

return new ValueTask();
}

private static DbContextErrorEventData CreateDbContextErrorEventData(
DbContext context, Exception exception, EventDefinition<Type, string, Exception> definition)
=> new DbContextErrorEventData(definition, SaveChangesFailed, context, exception);

private static string SaveChangesFailed(EventDefinitionBase definition, EventData payload)
{
var d = (EventDefinition<Type, string, Exception>)definition;
Expand Down Expand Up @@ -2967,7 +3015,8 @@ private static string CascadeDeleteOrphanSensitive(EventDefinitionBase definitio
/// </summary>
/// <param name="diagnostics"> The diagnostics logger to use. </param>
/// <param name="context"> The context being used. </param>
public static void SaveChangesStarting(
/// <returns> The, possibly intercepted, result. </returns>
public static InterceptionResult<int> SaveChangesStarting(
[NotNull] this IDiagnosticsLogger<DbLoggerCategory.Update> diagnostics,
[NotNull] DbContext context)
{
Expand All @@ -2978,17 +3027,63 @@ public static void SaveChangesStarting(
definition.Log(diagnostics,context.GetType().ShortDisplayName());
}

if (diagnostics.NeedsEventData(definition, out var diagnosticSourceEnabled, out var simpleLogEnabled))
if (diagnostics.NeedsEventData<ISaveChangesInterceptor>(definition,
out var interceptor, out var diagnosticSourceEnabled, out var simpleLogEnabled))
{
var eventData = new DbContextEventData(
definition,
SaveChangesStarting,
context);
var eventData = CreateSaveChangesStartingEventData(context, definition);

diagnostics.DispatchEventData(definition, eventData, diagnosticSourceEnabled, simpleLogEnabled);

if (interceptor != null)
{
return interceptor.SavingChanges(eventData, default);
}
}

return default;
}

/// <summary>
/// Logs for the <see cref="CoreEventId.SaveChangesStarting" /> event.
/// </summary>
/// <param name="diagnostics"> The diagnostics logger to use. </param>
/// <param name="context"> The context being used. </param>
/// <param name="cancellationToken"> The cancellation token. </param>
/// <returns> The, possibly intercepted, result. </returns>
public static ValueTask<InterceptionResult<int>> SaveChangesStartingAsync(
[NotNull] this IDiagnosticsLogger<DbLoggerCategory.Update> diagnostics,
[NotNull] DbContext context,
CancellationToken cancellationToken = default)
{
var definition = CoreResources.LogSaveChangesStarting(diagnostics);

if (diagnostics.ShouldLog(definition))
{
definition.Log(diagnostics,context.GetType().ShortDisplayName());
}

if (diagnostics.NeedsEventData<ISaveChangesInterceptor>(definition,
out var interceptor, out var diagnosticSourceEnabled, out var simpleLogEnabled))
{
var eventData = CreateSaveChangesStartingEventData(context, definition);

diagnostics.DispatchEventData(definition, eventData, diagnosticSourceEnabled, simpleLogEnabled);

if (interceptor != null)
{
return interceptor.SavingChangesAsync(eventData, default, cancellationToken);
}
}

return default;
}

private static DbContextEventData CreateSaveChangesStartingEventData(DbContext context, EventDefinition<string> definition)
=> new DbContextEventData(
definition,
SaveChangesStarting,
context);

private static string SaveChangesStarting(EventDefinitionBase definition, EventData payload)
{
var d = (EventDefinition<string>)definition;
Expand All @@ -3002,29 +3097,80 @@ private static string SaveChangesStarting(EventDefinitionBase definition, EventD
/// <param name="diagnostics"> The diagnostics logger to use. </param>
/// <param name="context"> The context being used. </param>
/// <param name="entitiesSavedCount"> The number of entities saved. </param>
public static void SaveChangesCompleted(
/// <returns> The, possibly intercepted, result. </returns>
public static int SaveChangesCompleted(
[NotNull] this IDiagnosticsLogger<DbLoggerCategory.Update> diagnostics,
[NotNull] DbContext context,
int entitiesSavedCount)
{
var definition = CoreResources.LogSaveChangesCompleted(diagnostics);

if (diagnostics.ShouldLog(definition))
{
definition.Log(diagnostics,context.GetType().ShortDisplayName(), entitiesSavedCount);
}

if (diagnostics.NeedsEventData(definition, out var diagnosticSourceEnabled, out var simpleLogEnabled))
if (diagnostics.NeedsEventData<ISaveChangesInterceptor>(definition,
out var interceptor, out var diagnosticSourceEnabled, out var simpleLogEnabled))
{
var eventData = new SaveChangesCompletedEventData(
definition,
SaveChangesCompleted,
context,
entitiesSavedCount);
var eventData = CreateSaveChangesCompletedEventData(context, entitiesSavedCount, definition);

diagnostics.DispatchEventData(definition, eventData, diagnosticSourceEnabled, simpleLogEnabled);

if (interceptor != null)
{
return interceptor.SavedChanges(eventData, entitiesSavedCount);
}
}

return entitiesSavedCount;
}

/// <summary>
/// Logs for the <see cref="CoreEventId.SaveChangesCompleted" /> event.
/// </summary>
/// <param name="diagnostics"> The diagnostics logger to use. </param>
/// <param name="context"> The context being used. </param>
/// <param name="entitiesSavedCount"> The number of entities saved. </param>
/// <param name="cancellationToken"> The cancellation token. </param>
/// <returns> The, possibly intercepted, result. </returns>
public static ValueTask<int> SaveChangesCompletedAsync(
[NotNull] this IDiagnosticsLogger<DbLoggerCategory.Update> diagnostics,
[NotNull] DbContext context,
int entitiesSavedCount,
CancellationToken cancellationToken = default)
{
var definition = CoreResources.LogSaveChangesCompleted(diagnostics);

if (diagnostics.ShouldLog(definition))
{
definition.Log(diagnostics,context.GetType().ShortDisplayName(), entitiesSavedCount);
}

if (diagnostics.NeedsEventData<ISaveChangesInterceptor>(definition,
out var interceptor, out var diagnosticSourceEnabled, out var simpleLogEnabled))
{
var eventData = CreateSaveChangesCompletedEventData(context, entitiesSavedCount, definition);

diagnostics.DispatchEventData(definition, eventData, diagnosticSourceEnabled, simpleLogEnabled);

if (interceptor != null)
{
return interceptor.SavedChangesAsync(eventData, entitiesSavedCount, cancellationToken);
}
}

return new ValueTask<int>(entitiesSavedCount);
}

private static SaveChangesCompletedEventData CreateSaveChangesCompletedEventData(
DbContext context, int entitiesSavedCount, EventDefinition<string, int> definition)
=> new SaveChangesCompletedEventData(
definition,
SaveChangesCompleted,
context,
entitiesSavedCount);

private static string SaveChangesCompleted(EventDefinitionBase definition, EventData payload)
{
var d = (EventDefinition<string, int>)definition;
Expand Down
Loading