Failed to update nested property in JSON mapped column

[kant2002]

Bug description

When updating value inside nested JSON entity I reach unexpected error

fail: Microsoft.EntityFrameworkCore.Update[10000]
      An exception occurred in the database while saving changes for context type 'AnalysisDbContext'.
      System.Diagnostics.UnreachableException: The program executed an instruction that was thought to be unreachable.
         at Microsoft.EntityFrameworkCore.Sqlite.Update.Internal.SqliteModificationCommand.ProcessSinglePropertyJsonUpdate(ColumnModificationParameters& parameters)
         at Microsoft.EntityFrameworkCore.Update.ModificationCommand.<GenerateColumnModifications>g__HandleJson|40_8(List`1 columnModifications, <>c__DisplayClass40_0&)
         at Microsoft.EntityFrameworkCore.Update.ModificationCommand.GenerateColumnModifications()
         at Microsoft.EntityFrameworkCore.Update.ModificationCommand.<>c.<get_ColumnModifications>b__33_0(ModificationCommand command)
         at Microsoft.EntityFrameworkCore.Internal.NonCapturingLazyInitializer.EnsureInitialized[TParam,TValue](TValue& target, TParam param, Func`2 valueFactory)
         at Microsoft.EntityFrameworkCore.Update.ModificationCommand.get_ColumnModifications()
         at Microsoft.EntityFrameworkCore.Update.Internal.CommandBatchPreparer.CreateCommandBatches(IEnumerable`1 commandSet, Boolean moreCommandSets, Boolean assertColumnModification, ParameterNameGenerator parameterNameGenerator)+MoveNext()
         at Microsoft.EntityFrameworkCore.Update.Internal.CommandBatchPreparer.BatchCommands(IList`1 entries, IUpdateAdapter updateAdapter)+MoveNext()
         at Microsoft.EntityFrameworkCore.Update.Internal.BatchExecutor.Execute(IEnumerable`1 commandBatches, IRelationalConnection connection)
         at Microsoft.EntityFrameworkCore.Storage.RelationalDatabase.SaveChanges(IList`1 entries)
         at Microsoft.EntityFrameworkCore.ChangeTracking.Internal.StateManager.SaveChanges(IList`1 entriesToSave)
         at Microsoft.EntityFrameworkCore.ChangeTracking.Internal.StateManager.SaveChanges(StateManager stateManager, Boolean acceptAllChangesOnSuccess)
         at Microsoft.EntityFrameworkCore.ChangeTracking.Internal.StateManager.<>c.<SaveChanges>b__114_0(DbContext _, ValueTuple`2 t)
         at Microsoft.EntityFrameworkCore.Storage.NonRetryingExecutionStrategy.Execute[TState,TResult](TState state, Func`3 operation, Func`3 verifySucceeded)
         at Microsoft.EntityFrameworkCore.ChangeTracking.Internal.StateManager.SaveChanges(Boolean acceptAllChangesOnSuccess)
         at Microsoft.EntityFrameworkCore.DbContext.SaveChanges(Boolean acceptAllChangesOnSuccess)
      System.Diagnostics.UnreachableException: The program executed an instruction that was thought to be unreachable.
         at Microsoft.EntityFrameworkCore.Sqlite.Update.Internal.SqliteModificationCommand.ProcessSinglePropertyJsonUpdate(ColumnModificationParameters& parameters)
         at Microsoft.EntityFrameworkCore.Update.ModificationCommand.<GenerateColumnModifications>g__HandleJson|40_8(List`1 columnModifications, <>c__DisplayClass40_0&)
         at Microsoft.EntityFrameworkCore.Update.ModificationCommand.GenerateColumnModifications()
         at Microsoft.EntityFrameworkCore.Update.ModificationCommand.<>c.<get_ColumnModifications>b__33_0(ModificationCommand command)
         at Microsoft.EntityFrameworkCore.Internal.NonCapturingLazyInitializer.EnsureInitialized[TParam,TValue](TValue& target, TParam param, Func`2 valueFactory)
         at Microsoft.EntityFrameworkCore.Update.ModificationCommand.get_ColumnModifications()
         at Microsoft.EntityFrameworkCore.Update.Internal.CommandBatchPreparer.CreateCommandBatches(IEnumerable`1 commandSet, Boolean moreCommandSets, Boolean assertColumnModification, ParameterNameGenerator parameterNameGenerator)+MoveNext()
         at Microsoft.EntityFrameworkCore.Update.Internal.CommandBatchPreparer.BaUnhandled exception. System.Diagnostics.UnreachableException: The program executed an instruction that was thought to be unreachable.
   at Microsoft.EntityFrameworkCore.Sqlite.Update.Internal.SqliteModificationCommand.ProcessSinglePropertyJsonUpdate(ColumnModificationParameters& parameters)
   at Microsoft.EntityFrameworkCore.Update.ModificationCommand.<GenerateColumnModifications>g__HandleJson|40_8(List`1 columnModifications, <>c__DisplayClass40_0&)
   at Microsoft.EntityFrameworkCore.Update.ModificationCommand.GenerateColumnModifications()
   at Microsoft.EntityFrameworkCore.Update.ModificationCommand.<>c.<get_ColumnModifications>b__33_0(ModificationCommand command)
   at Microsoft.EntityFrameworkCore.Internal.NonCapturingLazyInitializer.EnsureInitialized[TParam,TValue](TValue& target, TParam param, Func`2 valueFactory)
   at Microsoft.EntityFrameworkCore.Update.ModificationCommand.get_ColumnModifications()
   at Microsoft.EntityFrameworkCore.Update.Internal.CommandBatchPreparer.CreateCommandBatches(IEnumerable`1 commandSet, Boolean moreCommandSets, Boolean assertColumnModification, ParameterNameGenerator parameterNameGenerator)+MoveNext()
   at Microsoft.EntityFrameworkCore.Update.Internal.CommandBatchPreparer.BatchCommands(IList`1 entries, IUpdateAdapter updateAdapter)+MoveNext()
   at Microsoft.EntityFrameworkCore.Update.Internal.BatchExecutor.Execute(IEnumerable`1 commandBatches, IRelationalConnection connection)
   at Microsoft.EntityFrameworkCore.Storage.RelationalDatabase.SaveChanges(IList`1 entries)
   at Microsoft.EntityFrameworkCore.ChangeTracking.Internal.StateManager.SaveChanges(IList`1 entriesToSave)
   at Microsoft.EntityFrameworkCore.ChangeTracking.Internal.StateManager.SaveChanges(StateManager stateManager, Boolean acceptAllChangesOnSuccess)
   at Microsoft.EntityFrameworkCore.ChangeTracking.Internal.StateManager.<>c.<SaveChanges>b__114_0(DbContext _, ValueTuple`2 t)
   at Microsoft.EntityFrameworkCore.Storage.NonRetryingExecutionStrategy.Execute[TState,TResult](TState state, Func`3 operation, Func`3 verifySucceeded)
   at Microsoft.EntityFrameworkCore.ChangeTracking.Internal.StateManager.SaveChanges(Boolean acceptAllChangesOnSuccess)
   at Microsoft.EntityFrameworkCore.DbContext.SaveChanges(Boolean acceptAllChangesOnSuccess)
   at Microsoft.EntityFrameworkCore.DbContext.SaveChanges()
   at Program.<Main>$(String[] args) in C:\d\scratch\efcorebugjson\Program.cs:line 29
tchCommands(IList`1 entries, IUpdateAdapter updateAdapter)+MoveNext()
         at Microsoft.EntityFrameworkCore.Update.Internal.BatchExecutor.Execute(IEnumerable`1 commandBatches, IRelationalConnection connection)
         at Microsoft.EntityFrameworkCore.Storage.RelationalDatabase.SaveChanges(IList`1 entries)
         at Microsoft.EntityFrameworkCore.ChangeTracking.Internal.StateManager.SaveChanges(IList`1 entriesToSave)
         at Microsoft.EntityFrameworkCore.ChangeTracking.Internal.StateManager.SaveChanges(StateManager stateManager, Boolean acceptAllChangesOnSuccess)
         at Microsoft.EntityFrameworkCore.ChangeTracking.Internal.StateManager.<>c.<SaveChanges>b__114_0(DbContext _, ValueTuple`2 t)
         at Microsoft.EntityFrameworkCore.Storage.NonRetryingExecutionStrategy.Execute[TState,TResult](TState state, Func`3 operation, Func`3 verifySucceeded)
         at Microsoft.EntityFrameworkCore.ChangeTracking.Internal.StateManager.SaveChanges(Boolean acceptAllChangesOnSuccess)
         at Microsoft.EntityFrameworkCore.DbContext.SaveChanges(Boolean acceptAllChangesOnSuccess)

Your code

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.EntityFrameworkCore;

var builder = Host.CreateApplicationBuilder(args);
builder.Services.AddDbContext<AnalysisDbContext>((services, options) =>
    options.UseSqlite("Data Source=test.db"));
var app = builder.Build();
var db = app.Services.GetRequiredService<AnalysisDbContext>();
db.Database.EnsureDeleted();
db.Database.EnsureCreated();
var record = new TheEntity
{
    Data = new JsonData
    {
        NestedData = new NestedClass
        {
            BrokenValue = true,
        },
    }
};
db.AnalysisJobs.Add(record);
Console.WriteLine(@record.Data.NestedData.ToString());
db.SaveChanges();
@record = db.AnalysisJobs.First();
var d = @record.Data;
Console.WriteLine(d.ToString());
d.NestedData.BrokenValue = null;
db.SaveChanges();

public class AnalysisDbContext(DbContextOptions<AnalysisDbContext> options) : DbContext(options)
{
    public DbSet<TheEntity> AnalysisJobs { get; set; } = null!;

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.Entity<TheEntity>().OwnsOne(
            author => author.Data, ownedNavigationBuilder =>
            {
                ownedNavigationBuilder.ToJson();
                ownedNavigationBuilder.OwnsOne(contactDetails => contactDetails.NestedData);

                //ownedNavigationBuilder.OwnsOne(contactDetails => contactDetails.HiddenSignals);
            });
    }

}

public class TheEntity
{
    public int Id { get; set; }

    public JsonData? Data { get; set; }
}

public class JsonData
{
    public NestedClass? NestedData { get; set; } = new();
}

public class NestedClass
{
    public bool? BrokenValue { get; set; }
}

Stack traces

Verbose output

EF Core version

10.0.1

Database provider

No response

Target framework

No response

Operating system

No response

IDE

No response

[roji]

Thanks, confirmed SQLite-only bug; not a regression (happens in 8.0 and 9.0 as well).

Cleaned up minimal repro

await using var context = new BlogContext();
await context.Database.EnsureDeletedAsync();
await context.Database.EnsureCreatedAsync();

var entity = new TheEntity
{
    Data = new JsonData
    {
        NestedData = new NestedClass { BrokenValue = true }
    }
};
context.AnalysisJobs.Add(entity);
await context.SaveChangesAsync();
context.ChangeTracker.Clear();

entity = await context.AnalysisJobs.SingleAsync();
Console.WriteLine(entity.Data.ToString());
entity.Data.NestedData.BrokenValue = null;
await context.SaveChangesAsync();

public class BlogContext : DbContext
{
    public DbSet<TheEntity> AnalysisJobs { get; set; } = null!;

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
        => optionsBuilder
            // .UseSqlServer(Environment.GetEnvironmentVariable("Test__SqlServer__DefaultConnection"))
            .UseSqlite("Data Source=test.db")
            .LogTo(Console.WriteLine, LogLevel.Information)
            .EnableSensitiveDataLogging();

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.Entity<TheEntity>().OwnsOne(
            author => author.Data, ownedNavigationBuilder =>
            {
                ownedNavigationBuilder.ToJson();
                ownedNavigationBuilder.OwnsOne(contactDetails => contactDetails.NestedData);
            });
    }
}

public class TheEntity
{
    public int Id { get; set; }

    public JsonData? Data { get; set; }
}

public class JsonData
{
    public NestedClass? NestedData { get; set; } = new();
}

public class NestedClass
{
    public bool? BrokenValue { get; set; }
}

[roji]

It's recommended to try switching to the new complex type JSON support in EF 10 (release notes). I've verified that your code does not fail when using complex types instead of owned types, and we may be deprecating owned JSON support in favor of complex types anyway (see #37290).

To do this, simply replace your OnModelCreating with the following very similar version:

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<TheEntity>().ComplexProperty(
        author => author.Data, ownedNavigationBuilder =>
        {
            ownedNavigationBuilder.ToJson();
            ownedNavigationBuilder.ComplexProperty(contactDetails => contactDetails.NestedData);
        });
}

[kant2002]

Thanks, it's working. I assume that's documentation opportunity, since I'm actively look for JSON columns and let's say, cannot find anywhere except on announcement page which is strange.

[roji]

Yes, we're indeed behind on documentation around this.

@AndriySvyryd putting this in the backlog as it's an owned JSON non-regression.