Feature like query tags but when calling SaveChanges

Open
#14,078 3 comments 15 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
csharp
Domain
database

Research direction

Start by tracing the existing TagWith behavior and the SaveChanges update-command path in EF Core, then compare the SQL generated for tagged queries with SQL generated during SaveChanges against SQL Server. Define the supported tagging behavior and verify it with focused coverage for update commands.

Written by the indexing model from the issue text.

Description

area-save-changes customer-reported

I just setup a basic extension method that adds the calling file's path & line number as a tag to the given query:

public static class IQueryableTagExtensions
{
    public static IQueryable<T> TagWithFileInfo<T>(this IQueryable<T> source, [CallerFilePath] string fromFile = null, [CallerLineNumber] int onLine = 0, string comment = null)
    {
        var tagMessage = fromFile + "@" + onLine + (string.IsNullOrEmpty(comment) ? "" : " - " + comment);

        return source.TagWith(tagMessage);
    }
}

This works fine when querying for data, but I'd also like it to be part of the queries that execute when calling db.SaveChanges(). Is this possible currently? Adding query tags to updates is just as important, if not more important with this one, than adding them to selects.

The inspiration for this came from Stack Overflow who prepends this info to every query that runs through Dapper https://gist.github.com/NickCraver/c6f371bf8df37e05c4f09fd3c02ef6a2

What I really like about this is when using MiniProfiler this info becomes available making debugging easier. Then taken a step further it's included in Sentry's breadcrumbs that are part of logged exceptions, and it's also passed into App Insights. Both of those scenarios make production issues easier to track down.

Further technical details

EF Core version: 2.2.0
Database Provider: Microsoft.EntityFrameworkCore.SqlServer
Operating system: Win10
IDE: Visual Studio 2017 15.9.3

Dominant language
C#
Stars
14.8k
Forks
3.4k
Avg merge
2d 5h
Merged PRs (30d)
134

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from dotnet/efcore

All issues in dotnet/efcore

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.