From 60e7c5bc15627f04fd1e96da1c43763e6c3b63c7 Mon Sep 17 00:00:00 2001 From: Martijn Laarman Date: Wed, 7 Aug 2019 14:21:01 +0200 Subject: [PATCH] make sure types that implement DebuggerDisplay override ToString since these are likely to get logged --- src/Nest/CommonAbstractions/Infer/Field/Field.cs | 2 ++ src/Nest/CommonAbstractions/Infer/Fields/Fields.cs | 2 ++ src/Nest/CommonAbstractions/Infer/Id/Id.cs | 2 +- src/Nest/CommonAbstractions/Infer/Id/Ids.cs | 2 ++ src/Nest/CommonAbstractions/Infer/IndexName/IndexName.cs | 2 +- src/Nest/CommonAbstractions/Infer/Indices/Indices.cs | 2 ++ .../CommonAbstractions/Infer/JoinFieldRouting/Routing.cs | 2 ++ src/Nest/CommonAbstractions/Infer/Name/Name.cs | 2 ++ src/Nest/CommonAbstractions/Infer/Name/Names.cs | 2 ++ src/Nest/CommonAbstractions/Infer/NodeId/NodeIds.cs | 2 ++ .../CommonAbstractions/Infer/PropertyName/PropertyName.cs | 2 ++ .../CommonAbstractions/Infer/RelationName/RelationName.cs | 6 +----- src/Nest/Mapping/Types/PropertyBase.cs | 2 ++ 13 files changed, 23 insertions(+), 7 deletions(-) diff --git a/src/Nest/CommonAbstractions/Infer/Field/Field.cs b/src/Nest/CommonAbstractions/Infer/Field/Field.cs index c6cec4e25d5..632a3202d99 100644 --- a/src/Nest/CommonAbstractions/Infer/Field/Field.cs +++ b/src/Nest/CommonAbstractions/Infer/Field/Field.cs @@ -78,6 +78,8 @@ public Field(PropertyInfo property, double? boost = null, string format = null) + $"{(!string.IsNullOrEmpty(Format) ? " format: " + Format : string.Empty)}" + $"{(_type == null ? string.Empty : " typeof: " + _type.Name)}"; + public override string ToString() => DebugDisplay; + private string PropertyDebug => Property == null ? null : $"PropertyInfo: {Property.Name}"; public bool Equals(Field other) => _type != null diff --git a/src/Nest/CommonAbstractions/Infer/Fields/Fields.cs b/src/Nest/CommonAbstractions/Infer/Fields/Fields.cs index 23eb963b4ff..eed3d82f20e 100644 --- a/src/Nest/CommonAbstractions/Infer/Fields/Fields.cs +++ b/src/Nest/CommonAbstractions/Infer/Fields/Fields.cs @@ -22,6 +22,8 @@ public class Fields : IUrlParameter, IEnumerable, IEquatable private string DebugDisplay => $"Count: {ListOfFields.Count} [" + string.Join(",", ListOfFields.Select((t, i) => $"({i + 1}: {t?.DebugDisplay ?? "NULL"})")) + "]"; + + public override string ToString() => DebugDisplay; IEnumerator IEnumerable.GetEnumerator() => GetEnumerator(); diff --git a/src/Nest/CommonAbstractions/Infer/Id/Id.cs b/src/Nest/CommonAbstractions/Infer/Id/Id.cs index ab2c1cb292f..11e31da5cf2 100644 --- a/src/Nest/CommonAbstractions/Infer/Id/Id.cs +++ b/src/Nest/CommonAbstractions/Infer/Id/Id.cs @@ -68,7 +68,7 @@ string IUrlParameter.GetString(IConnectionConfigurationValues settings) public static Id From(T document) where T : class => new Id(document); - public override string ToString() => StringOrLongValue; + public override string ToString() => DebugDisplay; public override bool Equals(object obj) { diff --git a/src/Nest/CommonAbstractions/Infer/Id/Ids.cs b/src/Nest/CommonAbstractions/Infer/Id/Ids.cs index f593439a250..eb144300247 100644 --- a/src/Nest/CommonAbstractions/Infer/Id/Ids.cs +++ b/src/Nest/CommonAbstractions/Infer/Id/Ids.cs @@ -21,6 +21,8 @@ public Ids(string value) private string DebugDisplay => ((IUrlParameter)this).GetString(null); + public override string ToString() => DebugDisplay; + public bool Equals(Ids other) { if (other == null) return false; diff --git a/src/Nest/CommonAbstractions/Infer/IndexName/IndexName.cs b/src/Nest/CommonAbstractions/Infer/IndexName/IndexName.cs index 9d52e034ea6..7a53ef2729e 100644 --- a/src/Nest/CommonAbstractions/Infer/IndexName/IndexName.cs +++ b/src/Nest/CommonAbstractions/Infer/IndexName/IndexName.cs @@ -35,7 +35,7 @@ private IndexName(string index, Type type, string cluster = null) public Type Type { get; } internal string DebugDisplay => Type == null ? Name : $"{nameof(IndexName)} for typeof: {Type?.Name}"; - + private static int TypeHashCode { get; } = typeof(IndexName).GetHashCode(); bool IEquatable.Equals(IndexName other) => EqualsMarker(other); diff --git a/src/Nest/CommonAbstractions/Infer/Indices/Indices.cs b/src/Nest/CommonAbstractions/Infer/Indices/Indices.cs index f5c1fda42d5..85e4a52826c 100644 --- a/src/Nest/CommonAbstractions/Infer/Indices/Indices.cs +++ b/src/Nest/CommonAbstractions/Infer/Indices/Indices.cs @@ -28,6 +28,8 @@ internal Indices(IEnumerable indices) : base(new ManyIndices(indices) types => $"Count: {types.Indices.Count} [" + string.Join(",", types.Indices.Select((t, i) => $"({i + 1}: {t.DebugDisplay})")) + "]" ); + public override string ToString() => DebugDisplay; + string IUrlParameter.GetString(IConnectionConfigurationValues settings) => Match( all => "_all", many => diff --git a/src/Nest/CommonAbstractions/Infer/JoinFieldRouting/Routing.cs b/src/Nest/CommonAbstractions/Infer/JoinFieldRouting/Routing.cs index 359e128b317..9176272b80f 100644 --- a/src/Nest/CommonAbstractions/Infer/JoinFieldRouting/Routing.cs +++ b/src/Nest/CommonAbstractions/Infer/JoinFieldRouting/Routing.cs @@ -47,6 +47,8 @@ public Routing(object document) private string DebugDisplay => StringOrLongValue ?? "Routing from instance typeof: " + Document?.GetType().Name; + public override string ToString() => DebugDisplay; + private static int TypeHashCode { get; } = typeof(Routing).GetHashCode(); public bool Equals(Routing other) diff --git a/src/Nest/CommonAbstractions/Infer/Name/Name.cs b/src/Nest/CommonAbstractions/Infer/Name/Name.cs index 40c95a62171..76f41029bb5 100644 --- a/src/Nest/CommonAbstractions/Infer/Name/Name.cs +++ b/src/Nest/CommonAbstractions/Infer/Name/Name.cs @@ -13,6 +13,8 @@ public class Name : IEquatable, IUrlParameter private string DebugDisplay => Value; + public override string ToString() => DebugDisplay; + private static int TypeHashCode { get; } = typeof(Name).GetHashCode(); public bool Equals(Name other) => EqualsString(other?.Value); diff --git a/src/Nest/CommonAbstractions/Infer/Name/Names.cs b/src/Nest/CommonAbstractions/Infer/Name/Names.cs index 293d74d0f32..689dfe966c2 100644 --- a/src/Nest/CommonAbstractions/Infer/Name/Names.cs +++ b/src/Nest/CommonAbstractions/Infer/Name/Names.cs @@ -22,6 +22,8 @@ public Names(IEnumerable names) private string DebugDisplay => ((IUrlParameter)this).GetString(null); + public override string ToString() => DebugDisplay; + public bool Equals(Names other) => EqualsAllIds(Value, other.Value); string IUrlParameter.GetString(IConnectionConfigurationValues settings) => diff --git a/src/Nest/CommonAbstractions/Infer/NodeId/NodeIds.cs b/src/Nest/CommonAbstractions/Infer/NodeId/NodeIds.cs index 86e0e217ebb..6840b685880 100644 --- a/src/Nest/CommonAbstractions/Infer/NodeId/NodeIds.cs +++ b/src/Nest/CommonAbstractions/Infer/NodeId/NodeIds.cs @@ -20,6 +20,8 @@ public NodeIds(IEnumerable nodeIds) private string DebugDisplay => ((IUrlParameter)this).GetString(null); + public override string ToString() => DebugDisplay; + public bool Equals(NodeIds other) => EqualsAllIds(Value, other.Value); string IUrlParameter.GetString(IConnectionConfigurationValues settings) => string.Join(",", Value); diff --git a/src/Nest/CommonAbstractions/Infer/PropertyName/PropertyName.cs b/src/Nest/CommonAbstractions/Infer/PropertyName/PropertyName.cs index 073712b969a..5b849fcf933 100644 --- a/src/Nest/CommonAbstractions/Infer/PropertyName/PropertyName.cs +++ b/src/Nest/CommonAbstractions/Infer/PropertyName/PropertyName.cs @@ -44,6 +44,8 @@ public PropertyName(PropertyInfo property) internal string DebugDisplay => $"{Expression?.ToString() ?? PropertyDebug ?? Name}{(_type == null ? "" : " typeof: " + _type.Name)}"; + public override string ToString() => DebugDisplay; + private string PropertyDebug => Property == null ? null : $"PropertyInfo: {Property.Name}"; private static int TypeHashCode { get; } = typeof(PropertyName).GetHashCode(); diff --git a/src/Nest/CommonAbstractions/Infer/RelationName/RelationName.cs b/src/Nest/CommonAbstractions/Infer/RelationName/RelationName.cs index 8152ed4efa8..0fc7e8a9bd9 100644 --- a/src/Nest/CommonAbstractions/Infer/RelationName/RelationName.cs +++ b/src/Nest/CommonAbstractions/Infer/RelationName/RelationName.cs @@ -72,11 +72,7 @@ public bool EqualsMarker(RelationName other) private bool EqualsString(string other) => !other.IsNullOrEmpty() && other == Name; - public override string ToString() - { - if (!Name.IsNullOrEmpty()) return Name; + public override string ToString() => DebugDisplay; - return Type != null ? Type.Name : string.Empty; - } } } diff --git a/src/Nest/Mapping/Types/PropertyBase.cs b/src/Nest/Mapping/Types/PropertyBase.cs index 970d797e29a..59d9ffeefec 100644 --- a/src/Nest/Mapping/Types/PropertyBase.cs +++ b/src/Nest/Mapping/Types/PropertyBase.cs @@ -57,6 +57,8 @@ public abstract class PropertyBase : IProperty, IPropertyWithClrOrigin public PropertyName Name { get; set; } protected string DebugDisplay => $"Type: {((IProperty)this).Type ?? ""}, Name: {Name.DebugDisplay} "; + + public override string ToString() => DebugDisplay; /// /// Override for the property type, used for custom mappings