EntityHistoryHelper shouldn't create a PropertyChange for unchanged property

https://github.com/aspnetboilerplate/aspnetboilerplate/blob/7d7d34efd46c2fdf64ad6601bdece1453c08d8b6/src/Abp.ZeroCore.EntityFrameworkCore/EntityHistory/EntityHistoryHelper.cs#L299-L303

Let’s assume that we have not audited entity with a few properties, but only one of them is audited.

Current behavior: modifying other (non-audited properties) will cause EntityHistoryHelper to create a PropertyChange for audited property (even though it is unchanged).

Expected behavior:

propertyChange.NewValue = propertyEntry.GetNewValue()?.ToJsonString().TruncateWithPostfix(EntityPropertyChange.MaxValueLength);
if (!isAuditedProperty || propertyChange.OriginalValue == propertyChange.NewValue)
{
    // No change
    propertyChangesToRemove.Add(propertyChange);
}

Unchanged property shall should be removed from entity history if it’s (1) not audited OR (2) unmodified.

[4nonym0us]

Has inaccurate comparison when dealing with large string/data. (string/data was being truncated before comparison)

In this case I’d suggest comparing hashes of both OriginalValue and NewValue as simply trimming both values is incorrect. Apparently, we need to store these hashes as a part of EntityPropertyChange.

[4nonym0us]

@demirmusa

First of all, there is no need not to trust the description and provided solution as it has already been discussed by 3 people, you could just apply the solution, cover that with unit-test and resolve the issue.

The first code snipped you’ve attached is not an “expected behavior” and If you were to check if issue is still present, you could just take a look at issue creation time (it has been made on 14th of Feb, 2020 while the latest change to EntityHistoryHelper.cs (on dev branch) is dated Feb 7, 2020).

The only difference is logical operator in IF-statement: Actual: if (!isAuditedProperty && propertyChange.OriginalValue == propertyChange.NewValue) Exepcted: if (!isAuditedProperty || propertyChange.OriginalValue == propertyChange.NewValue)

Related test-case should look like this:

        [Fact]
        public void Should_Not_Save_Empty_PropertyChanges()
        {
            // Arrange
            // Forward calls from substitute to implementation
            var entityHistoryStore = Resolve<EntityHistoryStore>();
            _entityHistoryStore.When(x => x.SaveAsync(Arg.Any<EntityChangeSet>()))
                .Do(callback => AsyncHelper.RunSync(() =>
                    entityHistoryStore.SaveAsync(callback.Arg<EntityChangeSet>()))
                );
            _entityHistoryStore.When(x => x.Save(Arg.Any<EntityChangeSet>()))
                .Do(callback => entityHistoryStore.Save(callback.Arg<EntityChangeSet>()));

            // Act
            Foo foo = null;
            WithUnitOfWork(() =>
            {
                foo = new Foo
                {
                    Audited = "s1"
                };
                _fooRepository.InsertAndGetId(foo);
                
            });

            UsingDbContext((context) =>
            {
                context.EntityChanges.Count(e => e.TenantId == 1).ShouldBe(1);
                context.EntityChangeSets.Count(e => e.TenantId == 1).ShouldBe(1);
                context.EntityPropertyChanges.Count(e => e.TenantId == 1).ShouldBe(1);
            });

            WithUnitOfWork(() =>
            {
                foo.NonAudited = "s2";
                _fooRepository.Update(foo);
            });

            // Assert
            UsingDbContext((context) =>
            {
                context.EntityChanges.Count(e => e.TenantId == 1).ShouldBe(1);
                context.EntityChangeSets.Count(e => e.TenantId == 1).ShouldBe(1);
                context.EntityPropertyChanges.Count(e => e.TenantId == 1).ShouldBe(1);
            });
        }

    public class Foo : Entity
    {
        [Audited]
        public string Audited { get; set; }

        public string NonAudited { get; set; }
    }