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.

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

Tweaks to ValueComparer nullability #24410

Merged
merged 4 commits into from
Aug 20, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
9 changes: 3 additions & 6 deletions src/EFCore.Cosmos/ChangeTracking/Internal/ListComparer.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System;
using System.Collections.Generic;
using Microsoft.EntityFrameworkCore.ChangeTracking;

namespace Microsoft.EntityFrameworkCore.Cosmos.ChangeTracking.Internal
Expand Down Expand Up @@ -75,13 +77,8 @@ private static int GetHashCode(TCollection source, ValueComparer<TElement> eleme
return hash.ToHashCode();
}

private static TCollection? Snapshot(TCollection? source, ValueComparer<TElement> elementComparer, bool readOnly)
private static TCollection Snapshot(TCollection source, ValueComparer<TElement> elementComparer, bool readOnly)
{
if (source is null)
{
return null;
}

if (readOnly)
{
return source;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System;
using System.Collections.Generic;
using Microsoft.EntityFrameworkCore.ChangeTracking;

namespace Microsoft.EntityFrameworkCore.Cosmos.ChangeTracking.Internal
Expand Down Expand Up @@ -87,13 +89,8 @@ private static int GetHashCode(TCollection source, ValueComparer<TElement> eleme
return hash.ToHashCode();
}

private static TCollection? Snapshot(TCollection? source, ValueComparer<TElement> elementComparer, bool readOnly)
private static TCollection Snapshot(TCollection source, ValueComparer<TElement> elementComparer, bool readOnly)
{
if (source is null)
{
return null;
}

if (readOnly)
{
return source;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System;
using System.Diagnostics.CodeAnalysis;
using Microsoft.EntityFrameworkCore.ChangeTracking;

Expand Down Expand Up @@ -87,13 +88,8 @@ private static int GetHashCode(TElement?[] source, ValueComparer<TElement> eleme
}

[return: NotNullIfNotNull("source")]
private static TElement?[]? Snapshot(TElement?[]? source, ValueComparer<TElement> elementComparer)
private static TElement?[] Snapshot(TElement?[] source, ValueComparer<TElement> elementComparer)
{
if (source is null)
{
return null;
}

var snapshot = new TElement?[source.Length];
for (var i = 0; i < source.Length; i++)
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System;
using System.Collections.Generic;
using Microsoft.EntityFrameworkCore.ChangeTracking;

namespace Microsoft.EntityFrameworkCore.Cosmos.ChangeTracking.Internal
Expand Down Expand Up @@ -93,13 +95,8 @@ private static int GetHashCode(TCollection source, ValueComparer<TElement> eleme
return hash.ToHashCode();
}

private static TCollection? Snapshot(TCollection? source, ValueComparer<TElement> elementComparer, bool readOnly)
private static TCollection Snapshot(TCollection source, ValueComparer<TElement> elementComparer, bool readOnly)
{
if (source is null)
{
return null;
}

if (readOnly)
{
return source;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System;
using System.Diagnostics.CodeAnalysis;
using Microsoft.EntityFrameworkCore.ChangeTracking;

Expand Down Expand Up @@ -75,13 +76,8 @@ private static int GetHashCode(TElement[] source, ValueComparer<TElement> elemen
}

[return: NotNullIfNotNull("source")]
private static TElement[]? Snapshot(TElement[]? source, ValueComparer<TElement> elementComparer)
private static TElement[] Snapshot(TElement[] source, ValueComparer<TElement> elementComparer)
{
if (source is null)
{
return null;
}

var snapshot = new TElement[source.Length];
for (var i = 0; i < source.Length; i++)
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System;
using System.Collections.Generic;
using Microsoft.EntityFrameworkCore.ChangeTracking;

namespace Microsoft.EntityFrameworkCore.Cosmos.ChangeTracking.Internal
Expand Down Expand Up @@ -77,13 +79,8 @@ private static int GetHashCode(TCollection source, ValueComparer<TElement> eleme
return hash.ToHashCode();
}

private static TCollection? Snapshot(TCollection? source, ValueComparer<TElement> elementComparer, bool readOnly)
private static TCollection Snapshot(TCollection source, ValueComparer<TElement> elementComparer, bool readOnly)
{
if (source is null)
{
return null;
}

if (readOnly)
{
return source;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ private readonly SqlServerByteArrayTypeMapping _rowversion
comparer: new ValueComparer<byte[]>(
(v1, v2) => StructuralComparisons.StructuralEqualityComparer.Equals(v1, v2),
v => StructuralComparisons.StructuralEqualityComparer.GetHashCode(v),
v => v == null ? null : v.ToArray()),
v => v.ToArray()),
storeTypePostfix: StoreTypePostfix.None);

private readonly IntTypeMapping _int
Expand Down
2 changes: 1 addition & 1 deletion src/EFCore/ChangeTracking/ArrayStructuralComparer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ public ArrayStructuralComparer()
: base(
CreateDefaultEqualsExpression(),
CreateDefaultHashCodeExpression(favorStructuralComparisons: true),
v => v == null ? null : v.ToArray())
v => v.ToArray())
{
}
}
Expand Down
4 changes: 2 additions & 2 deletions src/EFCore/ChangeTracking/GeometryValueComparer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public GeometryValueComparer()
right);
}

private static Expression<Func<TGeometry?, TGeometry?>> GetSnapshotExpression()
private static Expression<Func<TGeometry, TGeometry>> GetSnapshotExpression()
{
var instance = Expression.Parameter(typeof(TGeometry), "instance");

Expand All @@ -69,7 +69,7 @@ public GeometryValueComparer()
body = Expression.Convert(body, typeof(TGeometry));
}

return Expression.Lambda<Func<TGeometry?, TGeometry?>>(body, instance);
return Expression.Lambda<Func<TGeometry, TGeometry>>(body, instance);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public NonNullNullableValueComparer(
: base(
(Expression<Func<T?, T?, bool>>)equalsExpression,
(Expression<Func<T, int>>)hashCodeExpression,
(Expression<Func<T?, T?>>)snapshotExpression)
(Expression<Func<T, T>>)snapshotExpression)
{
}
}
Expand Down
26 changes: 14 additions & 12 deletions src/EFCore/ChangeTracking/ValueComparer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
using System;
using System.Collections;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Linq;
using System.Linq.Expressions;
using System.Reflection;
Expand Down Expand Up @@ -103,6 +104,7 @@ protected ValueComparer(
/// </summary>
/// <param name="instance"> The instance. </param>
/// <returns> The snapshot. </returns>
[return: NotNullIfNotNull("instance")]
public abstract object? Snapshot(object? instance);

/// <summary>
Expand Down Expand Up @@ -193,31 +195,31 @@ public virtual Expression ExtractSnapshotBody(Expression expression)
/// <returns> The <see cref="ValueComparer{T}" />. </returns>
public static ValueComparer CreateDefault(Type type, bool favorStructuralComparisons)
{
var nonNullabletype = type.UnwrapNullableType();
var nonNullableType = type.UnwrapNullableType();

// The equality operator returns false for NaNs, but the Equals methods returns true
if (nonNullabletype == typeof(double))
if (nonNullableType == typeof(double))
{
return new DefaultDoubleValueComparer(favorStructuralComparisons);
}

if (nonNullabletype == typeof(float))
if (nonNullableType == typeof(float))
{
return new DefaultFloatValueComparer(favorStructuralComparisons);
}

if (nonNullabletype == typeof(DateTimeOffset))
if (nonNullableType == typeof(DateTimeOffset))
{
return new DefaultDateTimeOffsetValueComparer(favorStructuralComparisons);
}

var comparerType = nonNullabletype.IsInteger()
|| nonNullabletype == typeof(decimal)
|| nonNullabletype == typeof(bool)
|| nonNullabletype == typeof(string)
|| nonNullabletype == typeof(DateTime)
|| nonNullabletype == typeof(Guid)
|| nonNullabletype == typeof(TimeSpan)
var comparerType = nonNullableType.IsInteger()
|| nonNullableType == typeof(decimal)
|| nonNullableType == typeof(bool)
|| nonNullableType == typeof(string)
|| nonNullableType == typeof(DateTime)
|| nonNullableType == typeof(Guid)
|| nonNullableType == typeof(TimeSpan)
? typeof(DefaultValueComparer<>)
: typeof(ValueComparer<>);

Expand Down Expand Up @@ -250,7 +252,7 @@ public override Expression ExtractSnapshotBody(Expression expression)
public override object? Snapshot(object? instance)
=> instance;

public override T? Snapshot(T? instance)
public override T Snapshot(T instance)
=> instance;
}

Expand Down
20 changes: 10 additions & 10 deletions src/EFCore/ChangeTracking/ValueComparer`.cs
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ public class ValueComparer<T> : ValueComparer, IEqualityComparer<T>
{
private Func<T?, T?, bool>? _equals;
private Func<T, int>? _hashCode;
private Func<T?, T?>? _snapshot;
private Func<T, T>? _snapshot;

/// <summary>
/// Creates a new <see cref="ValueComparer{T}" /> with a default comparison
Expand Down Expand Up @@ -79,7 +79,7 @@ public ValueComparer(
public ValueComparer(
Expression<Func<T?, T?, bool>> equalsExpression,
Expression<Func<T, int>> hashCodeExpression,
Expression<Func<T?, T?>> snapshotExpression)
Expression<Func<T, T>> snapshotExpression)
: base(equalsExpression, hashCodeExpression, snapshotExpression)
{
}
Expand Down Expand Up @@ -158,7 +158,7 @@ public ValueComparer(
/// Creates an expression for creating a snapshot of a value.
/// </summary>
/// <returns> The snapshot expression. </returns>
protected static Expression<Func<T?, T?>> CreateDefaultSnapshotExpression(bool favorStructuralComparisons)
protected static Expression<Func<T, T>> CreateDefaultSnapshotExpression(bool favorStructuralComparisons)
{
if (!favorStructuralComparisons
|| !typeof(T).IsArray)
Expand All @@ -175,7 +175,7 @@ public ValueComparer(
// var destination = new T[length];
// Array.Copy(source, destination, length);
// return destination;
return Expression.Lambda<Func<T?, T?>>(
return Expression.Lambda<Func<T, T>>(
Expression.Block(
new[] { lengthVariable, destinationVariable },
Expression.Assign(
Expand Down Expand Up @@ -254,8 +254,8 @@ public override bool Equals(object? left, object? right)
/// </summary>
/// <param name="instance"> The instance. </param>
/// <returns> The hash code. </returns>
public override int GetHashCode(object? instance)
=> instance == null ? 0 : GetHashCode((T)instance);
public override int GetHashCode(object instance)
=> GetHashCode((T)instance);

/// <summary>
/// Compares the two instances to determine if they are equal.
Expand Down Expand Up @@ -290,7 +290,7 @@ public virtual int GetHashCode(T instance)
/// <param name="instance"> The instance. </param>
/// <returns> The snapshot. </returns>
public override object? Snapshot(object? instance)
=> instance == null ? null : Snapshot((T?)instance);
=> instance == null ? null : Snapshot((T)instance);

/// <summary>
/// <para>
Expand All @@ -305,7 +305,7 @@ public virtual int GetHashCode(T instance)
/// </summary>
/// <param name="instance"> The instance. </param>
/// <returns> The snapshot. </returns>
public virtual T? Snapshot(T? instance)
public virtual T Snapshot(T instance)
=> NonCapturingLazyInitializer.EnsureInitialized(
ref _snapshot, this, static c => c.SnapshotExpression.Compile())(instance);

Expand Down Expand Up @@ -338,7 +338,7 @@ public override Type Type
/// reference.
/// </para>
/// </summary>
public new virtual Expression<Func<T?, T?>> SnapshotExpression
=> (Expression<Func<T?, T?>>)base.SnapshotExpression;
public new virtual Expression<Func<T, T>> SnapshotExpression
=> (Expression<Func<T, T>>)base.SnapshotExpression;
}
}